diff options
| -rw-r--r-- | bot/exts/utils/utils.py | 65 | ||||
| -rw-r--r-- | tests/bot/exts/utils/test_utils.py | 14 |
2 files changed, 53 insertions, 26 deletions
diff --git a/bot/exts/utils/utils.py b/bot/exts/utils/utils.py index 1bd5c500b..68019b143 100644 --- a/bot/exts/utils/utils.py +++ b/bot/exts/utils/utils.py @@ -16,7 +16,7 @@ from bot.utils import messages, time log = get_logger(__name__) -ZEN_OF_PYTHON = """\ +ZEN_OF_PYTHON = """ Beautiful is better than ugly. Explicit is better than implicit. Simple is better than complex. @@ -36,7 +36,7 @@ Although never is often better than *right* now. If the implementation is hard to explain, it's a bad idea. If the implementation is easy to explain, it may be a good idea. Namespaces are one honking great idea -- let's do more of those! -""" +""".strip() LEADS_AND_COMMUNITY = (Roles.project_leads, Roles.domain_leads, Roles.partners, Roles.python_community) @@ -111,31 +111,54 @@ class Utils(Cog): zen_lines = ZEN_OF_PYTHON.splitlines() # Prioritize checking for an index or slice - match = re.match(r"(-?\d+)(:(-?\d+)?)?", search_value.split(" ")[0]) + match = re.match( + r"(?P<index>-?\d++(?!:))|(?P<start>(?:-\d+)|\d*):(?:(?P<end>(?:-\d+)|\d*)(?::(?P<step>(?:-\d+)|\d*))?)?", + search_value.split(" ")[0], + ) if match: - upper_bound = len(zen_lines) - 1 - lower_bound = -1 * len(zen_lines) - - start_index = int(match.group(1)) - - if not match.group(2): - if not (lower_bound <= start_index <= upper_bound): - raise BadArgument(f"Please provide an index between {lower_bound} and {upper_bound}.") - embed.title += f" (line {start_index % len(zen_lines)}):" - embed.description = zen_lines[start_index] + if match.group("index"): + index = int(match.group("index")) + if not (-19 <= index <= 18): + raise BadArgument("Please provide an index between -19 and 18.") + embed.title += f" (line {index % 19}):" + embed.description = zen_lines[index] await ctx.send(embed=embed) return - end_index= int(match.group(3)) if match.group(3) else len(zen_lines) + start_index = int(match.group("start")) if match.group("start") else None + end_index = int(match.group("end")) if match.group("end") else None + step_size = int(match.group("step")) if match.group("step") else 1 - if not ((lower_bound <= start_index <= upper_bound) and (lower_bound <= end_index <= len(zen_lines))): - raise BadArgument(f"Please provide valid indices between {lower_bound} and {upper_bound}.") - if not (start_index % len(zen_lines) < end_index % (len(zen_lines) + 1)): - raise BadArgument("The start index for the slice must be smaller than the end index.") + if step_size == 0: + raise BadArgument("Step size must not be 0.") - embed.title += f" (lines {start_index%len(zen_lines)}-{(end_index-1)%len(zen_lines)}):" - embed.description = "\n".join(zen_lines[start_index:end_index]) - await ctx.send(embed=embed) + lines = zen_lines[start_index:end_index:step_size] + if not lines: + raise BadArgument("Slice returned 0 lines.") + + if len(lines) == 1: + embed.title += f" (line {zen_lines.index(lines[0])}):" + embed.description = lines[0] + await ctx.send(embed=embed) + elif lines == zen_lines: + embed.title += ", by Tim Peters" + await ctx.send(embed=embed) + elif len(lines) == 19: + embed.title += f" (step size {step_size}):" + embed.description = "\n".join(lines) + await ctx.send(embed=embed) + else: + if step_size != 1: + step_message = f", step size {step_size}" + else: + step_message = "" + first_position = zen_lines.index(lines[0]) + second_position = zen_lines.index(lines[-1]) + if first_position > second_position: + (first_position, second_position) = (second_position, first_position) + embed.title += f" (lines {first_position}-{second_position}{step_message}):" + embed.description = "\n".join(lines) + await ctx.send(embed=embed) return # Try to handle first exact word due difflib.SequenceMatched may use some other similar word instead diff --git a/tests/bot/exts/utils/test_utils.py b/tests/bot/exts/utils/test_utils.py index 5392e3512..9b8ea4ade 100644 --- a/tests/bot/exts/utils/test_utils.py +++ b/tests/bot/exts/utils/test_utils.py @@ -65,11 +65,15 @@ class ZenTests(unittest.IsolatedAsyncioTestCase): """ Tests if the `!zen` command reacts properly to valid slices for indexing as an argument. """ expected_results = { - "0:19": ("The Zen of Python (lines 0-18):", "\n".join(self.zen_list[0:19])), - "0:": ("The Zen of Python (lines 0-18):", "\n".join(self.zen_list[0:])), - "-2:-1": ("The Zen of Python (lines 17-17):", self.zen_list[17]), + "0:19": ("The Zen of Python, by Tim Peters", "\n".join(self.zen_list)), + ":": ("The Zen of Python, by Tim Peters", "\n".join(self.zen_list)), + "::": ("The Zen of Python, by Tim Peters", "\n".join(self.zen_list)), + "1:": ("The Zen of Python (lines 1-18):", "\n".join(self.zen_list[1:])), + "-2:-1": ("The Zen of Python (line 17):", self.zen_list[17]), "0:-1": ("The Zen of Python (lines 0-17):", "\n".join(self.zen_list[0:-1])), - "10:13": ("The Zen of Python (lines 10-12):", "\n".join(self.zen_list[10:13])) + "10:13": ("The Zen of Python (lines 10-12):", "\n".join(self.zen_list[10:13])), + "::-1": ("The Zen of Python (step size -1):", "\n".join(self.zen_list[::-1])), + "10:5:-1": ("The Zen of Python (lines 6-10, step size -1):", "\n".join(self.zen_list[10:5:-1])), } for input_slice, (title, description) in expected_results.items(): @@ -83,7 +87,7 @@ class ZenTests(unittest.IsolatedAsyncioTestCase): async def test_zen_with_invalid_slices(self): """ Tests if the `!zen` command reacts properly to invalid slices for indexing as an argument. """ - slices= ["19:", "10:9", "-1:-2", "0:20", "-100:", "0:-100"] + slices= ["19:18", "10:9", "-1:-2", "0:-100", "::0", "1:2:-1", "-5:-4:-1"] for input_slice in slices: with self.subTest(input_slice = input_slice), self.assertRaises(BadArgument): |