Removed unnecessary use of pass

tleonhardt · tleonhardt · commit 1a4b13c5fd57 · 2025-05-23T22:27:58.000-04:00
diff --git a/cmd2/ansi.py b/cmd2/ansi.py
@@ -211,13 +211,11 @@ def __radd__(self, other: Any) -> str:
 class FgColor(AnsiSequence):
     """Base class for ANSI Sequences which set foreground text color"""
 
-    pass
 
 
 class BgColor(AnsiSequence):
     """Base class for ANSI Sequences which set background text color"""
 
-    pass
 
 
 ####################################################################################
diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py
@@ -2463,7 +2463,6 @@ def preloop(self) -> None:
         to run hooks before the command loop begins. See
         [Hooks](../features/hooks.md) for more information.
         """
-        pass
 
     def postloop(self) -> None:
         """Hook method executed once when the [cmd2.Cmd.cmdloop][] method is about to return.
@@ -2472,7 +2471,6 @@ def postloop(self) -> None:
         to run hooks after the command loop completes. See
         [Hooks](../features/hooks.md) for more information.
         """
-        pass
 
     def parseline(self, line: str) -> tuple[str, str, str]:
         """Parse the line into a command name and a string containing the arguments.
diff --git a/cmd2/command_definition.py b/cmd2/command_definition.py
@@ -136,14 +136,12 @@ def on_registered(self) -> None:
         Subclasses can override this to perform custom steps related to the newly added commands (e.g. setting
         them to a disabled state).
         """
-        pass
 
     def on_unregister(self) -> None:
         """
         Called by ``cmd2.Cmd`` as the first step to unregistering a CommandSet. Subclasses can override this to
         perform any cleanup steps which require their commands being registered in the CLI.
         """
-        pass
 
     def on_unregistered(self) -> None:
         """
diff --git a/cmd2/exceptions.py b/cmd2/exceptions.py
@@ -15,7 +15,6 @@ class SkipPostcommandHooks(Exception):
     hooks, but not bad enough to print the exception to the user.
     """
 
-    pass
 
 
 class Cmd2ArgparseError(SkipPostcommandHooks):
@@ -26,7 +25,6 @@ class Cmd2ArgparseError(SkipPostcommandHooks):
     after parsing fails, just return instead of raising an exception.
     """
 
-    pass
 
 
 class CommandSetRegistrationError(Exception):
@@ -35,7 +33,6 @@ class CommandSetRegistrationError(Exception):
     from a cmd2 application.
     """
 
-    pass
 
 
 class CompletionError(Exception):
@@ -86,22 +83,18 @@ def __init__(self, *args: Any, wrapped_ex: BaseException) -> None:
 class Cmd2ShlexError(Exception):
     """Raised when shlex fails to parse a command line string in StatementParser"""
 
-    pass
 
 
 class EmbeddedConsoleExit(SystemExit):
     """Custom exception class for use with the py command."""
 
-    pass
 
 
 class EmptyStatement(Exception):
     """Custom exception class for handling behavior when the user just presses <Enter>."""
 
-    pass
 
 
 class RedirectionError(Exception):
     """Custom exception class for when redirecting or piping output fails"""
 
-    pass
diff --git a/examples/alias_startup.py b/examples/alias_startup.py
@@ -18,7 +18,6 @@ def __init__(self):
 
     def do_nothing(self, args):
         """This command does nothing and produces no output."""
-        pass
 
 
 if __name__ == '__main__':
diff --git a/examples/async_printing.py b/examples/async_printing.py
@@ -108,7 +108,7 @@ def _get_alerts(self) -> list[str]:
             if rand_num > 2:
                 return []
 
-            for i in range(0, rand_num):
+            for i in range(rand_num):
                 self._alert_count += 1
                 alerts.append(f"Alert {self._alert_count}")
 
diff --git a/examples/default_categories.py b/examples/default_categories.py
@@ -14,7 +14,6 @@
 class MyBaseCommandSet(CommandSet):
     """Defines a default category for all sub-class CommandSets"""
 
-    pass
 
 
 class ChildInheritsParentCategories(MyBaseCommandSet):
diff --git a/plugins/tasks.py b/plugins/tasks.py
@@ -39,7 +39,6 @@
 @invoke.task()
 def pytest(_):
     """Run tests and code coverage using pytest"""
-    pass
 
 
 namespace.add_task(pytest)
@@ -48,7 +47,6 @@ def pytest(_):
 @invoke.task(pre=[ext_test_tasks.pytest_clean])
 def pytest_clean(_):
     """Remove pytest cache and code coverage files and directories"""
-    pass
 
 
 namespace_clean.add_task(pytest_clean, 'pytest')
@@ -57,7 +55,6 @@ def pytest_clean(_):
 @invoke.task(pre=[ext_test_tasks.mypy])
 def mypy(_):
     """Run mypy optional static type checker"""
-    pass
 
 
 namespace.add_task(mypy)
@@ -67,7 +64,6 @@ def mypy(_):
 def mypy_clean(_):
     """Remove mypy cache directory"""
     # pylint: disable=unused-argument
-    pass
 
 
 namespace_clean.add_task(mypy_clean, 'mypy')
@@ -85,7 +81,6 @@ def mypy_clean(_):
 @invoke.task(pre=[ext_test_tasks.build_clean])
 def build_clean(_):
     """Remove the build directory"""
-    pass
 
 
 namespace_clean.add_task(build_clean, 'build')
@@ -94,7 +89,6 @@ def build_clean(_):
 @invoke.task(pre=[ext_test_tasks.dist_clean])
 def dist_clean(_):
     """Remove the dist directory"""
-    pass
 
 
 namespace_clean.add_task(dist_clean, 'dist')
@@ -108,7 +102,6 @@ def dist_clean(_):
 def clean_all(_):
     """Run all clean tasks"""
     # pylint: disable=unused-argument
-    pass
 
 
 namespace_clean.add_task(clean_all, 'all')
@@ -117,7 +110,6 @@ def clean_all(_):
 @invoke.task(pre=[clean_all], post=[ext_test_tasks.sdist])
 def sdist(_):
     """Create a source distribution"""
-    pass
 
 
 namespace.add_task(sdist)
@@ -126,7 +118,6 @@ def sdist(_):
 @invoke.task(pre=[clean_all], post=[ext_test_tasks.wheel])
 def wheel(_):
     """Build a wheel distribution"""
-    pass
 
 
 namespace.add_task(wheel)
diff --git a/plugins/template/tasks.py b/plugins/template/tasks.py
@@ -160,7 +160,6 @@ def bytecode_clean(context):
 def clean_all(context):
     """Run all clean tasks"""
     # pylint: disable=unused-argument
-    pass
 
 
 namespace_clean.add_task(clean_all, 'all')
diff --git a/pyproject.toml b/pyproject.toml
@@ -194,9 +194,9 @@ select = [
     "PD",   # pandas-vet (Pandas specific rules)
     "PERF", # Perflint (warn about performance issues)
     "PGH",  # pygrep-hooks (force specific rule codes when ignoring type or linter issues on a line)
-    # "PIE", # flake8-pie (eliminate unnecessary use of pass, range starting at 0, etc.)
-    "PLC", # Pylint Conventions
-    "PLE", # Pylint Errors
+    "PIE",  # flake8-pie (eliminate unnecessary use of pass, range starting at 0, etc.)
+    "PLC",  # Pylint Conventions
+    "PLE",  # Pylint Errors
     # "PLR", # Pylint Refactoring suggestions
     # "PLW", # Pylint Warnings
     # "PT", # flake8-pytest-style (warnings about unit test best practices)
diff --git a/tasks.py b/tasks.py
@@ -260,7 +260,6 @@ def ruff_clean(context):
 def clean_all(_):
     """Run all clean tasks"""
     # pylint: disable=unused-argument
-    pass
 
 
 namespace_clean.add_task(clean_all, 'all')
diff --git a/tests/test_argparse_completer.py b/tests/test_argparse_completer.py
@@ -130,7 +130,7 @@ def choices_provider(self) -> List[str]:
     def completion_item_method(self) -> List[CompletionItem]:
         """Choices method that returns CompletionItems"""
         items = []
-        for i in range(0, 10):
+        for i in range(10):
             main_str = 'main_str{}'.format(i)
             items.append(CompletionItem(main_str, description='blah blah'))
         return items
@@ -775,7 +775,7 @@ def test_completion_items(ac_app):
 )
 def test_max_completion_items(ac_app, num_aliases, show_description):
     # Create aliases
-    for i in range(0, num_aliases):
+    for i in range(num_aliases):
         run_cmd(ac_app, 'alias create fake_alias{} help'.format(i))
 
     assert len(ac_app.aliases) == num_aliases
@@ -1232,7 +1232,6 @@ def __init__(self):
     @with_argparser(default_completer_parser)
     def do_default_completer(self, args: argparse.Namespace) -> None:
         """Test command"""
-        pass
 
     # Parser that's used to test setting a custom completer at the parser level
     custom_completer_parser = Cmd2ArgumentParser(
@@ -1243,7 +1242,6 @@ def do_default_completer(self, args: argparse.Namespace) -> None:
     @with_argparser(custom_completer_parser)
     def do_custom_completer(self, args: argparse.Namespace) -> None:
         """Test command"""
-        pass
 
     # Test as_subcommand_to decorator with custom completer
     top_parser = Cmd2ArgumentParser(description="Top Command")
diff --git a/tests/test_cmd2.py b/tests/test_cmd2.py
@@ -1186,14 +1186,12 @@ def __init__(self, *args, **kwargs):
 
     def do_squat(self, arg):
         """This docstring help will never be shown because the help_squat method overrides it."""
-        pass
 
     def help_squat(self):
         self.stdout.write('This command does diddly squat...\n')
 
     def do_edit(self, arg):
         """This overrides the edit command and does nothing."""
-        pass
 
     # This command will be in the "undocumented" section of the help menu
     def do_undoc(self, arg):
@@ -1206,14 +1204,12 @@ def do_multiline_docstr(self, arg):
         and there are no
         tabs
         """
-        pass
 
     parser_cmd_parser = cmd2.Cmd2ArgumentParser(description="This is the description.")
 
     @cmd2.with_argparser(parser_cmd_parser)
     def do_parser_cmd(self, args):
         """This is the docstring."""
-        pass
 
 
 @pytest.fixture
@@ -1268,7 +1264,6 @@ def __init__(self, *args, **kwargs):
     @cmd2.with_category('Some Category')
     def do_diddly(self, arg):
         """This command does diddly"""
-        pass
 
     # This command will be in the "Some Category" section of the help menu even though it has no docstring
     @cmd2.with_category("Some Category")
@@ -1277,14 +1272,12 @@ def do_cat_nodoc(self, arg):
 
     def do_squat(self, arg):
         """This docstring help will never be shown because the help_squat method overrides it."""
-        pass
 
     def help_squat(self):
         self.stdout.write('This command does diddly squat...\n')
 
     def do_edit(self, arg):
         """This overrides the edit command and does nothing."""
-        pass
 
     cmd2.categorize((do_squat, do_edit), 'Custom Category')
 
diff --git a/tests/test_completion.py b/tests/test_completion.py
@@ -107,7 +107,6 @@ def complete_test_multiline(self, text, line, begidx, endidx):
 
     def do_test_no_completer(self, args):
         """Completing this should result in completedefault() being called"""
-        pass
 
     def complete_foo_val(self, text, line, begidx, endidx, arg_tokens):
         """Supports unit testing cmd2.Cmd2.complete_set_val to confirm it passes all tokens in the set command"""
diff --git a/tests/test_plugin.py b/tests/test_plugin.py
@@ -49,11 +49,9 @@ def prepost_hook_two(self) -> None:
 
     def prepost_hook_too_many_parameters(self, param) -> None:
         """A preloop or postloop hook with too many parameters"""
-        pass
 
     def prepost_hook_with_wrong_return_annotation(self) -> bool:
         """A preloop or postloop hook with incorrect return type"""
-        pass
 
     ###
     #
@@ -93,23 +91,18 @@ def postparse_hook_exception(self, data: cmd2.plugin.PostparsingData) -> cmd2.pl
 
     def postparse_hook_too_many_parameters(self, data1, data2) -> cmd2.plugin.PostparsingData:
         """A postparsing hook with too many parameters"""
-        pass
 
     def postparse_hook_undeclared_parameter_annotation(self, data) -> cmd2.plugin.PostparsingData:
         """A postparsing hook with an undeclared parameter type"""
-        pass
 
     def postparse_hook_wrong_parameter_annotation(self, data: str) -> cmd2.plugin.PostparsingData:
         """A postparsing hook with the wrong parameter type"""
-        pass
 
     def postparse_hook_undeclared_return_annotation(self, data: cmd2.plugin.PostparsingData):
         """A postparsing hook with an undeclared return type"""
-        pass
 
     def postparse_hook_wrong_return_annotation(self, data: cmd2.plugin.PostparsingData) -> str:
         """A postparsing hook with the wrong return type"""
-        pass
 
     ###
     #
@@ -138,7 +131,6 @@ def precmd_hook_exception(self, data: plugin.PrecommandData) -> plugin.Precomman
 
     def precmd_hook_not_enough_parameters(self) -> plugin.PrecommandData:
         """A precommand hook with no parameters"""
-        pass
 
     def precmd_hook_too_many_parameters(self, one: plugin.PrecommandData, two: str) -> plugin.PrecommandData:
         """A precommand hook with too many parameters"""
@@ -181,7 +173,6 @@ def postcmd_hook_exception(self, data: plugin.PostcommandData) -> plugin.Postcom
 
     def postcmd_hook_not_enough_parameters(self) -> plugin.PostcommandData:
         """A precommand hook with no parameters"""
-        pass
 
     def postcmd_hook_too_many_parameters(self, one: plugin.PostcommandData, two: str) -> plugin.PostcommandData:
         """A precommand hook with too many parameters"""
@@ -247,7 +238,6 @@ def cmdfinalization_hook_passthrough_exception(
 
     def cmdfinalization_hook_not_enough_parameters(self) -> plugin.CommandFinalizationData:
         """A command finalization hook with no parameters."""
-        pass
 
     def cmdfinalization_hook_too_many_parameters(
         self, one: plugin.CommandFinalizationData, two: str
diff --git a/tests/test_transcript.py b/tests/test_transcript.py
@@ -88,7 +88,6 @@ def do_mumble(self, opts, arg):
 
     def do_nothing(self, statement):
         """Do nothing and output nothing"""
-        pass
 
     def do_keyboard_interrupt(self, _):
         raise KeyboardInterrupt('Interrupting this command')
diff --git a/tests_isolated/test_commandset/test_commandset.py b/tests_isolated/test_commandset/test_commandset.py
@@ -1009,7 +1009,6 @@ def __init__(self, *args, **kwargs):
         @cmd2.with_argparser(cut_parser)
         def do_cut(self, ns: argparse.Namespace):
             """Cut something"""
-            pass
 
         banana_parser = cmd2.Cmd2ArgumentParser()
         banana_parser.add_argument('direction', choices=['discs', 'lengthwise'])
