Enabled ruff ERA ruleset for eradicating commented-out code

Author: tleonhardt

cmd2/rl_utils.py

@@ -101,7 +101,7 @@ def enable_win_vt100(handle: HANDLE) -> bool:
     ############################################################################################################
     # pyreadline3 is incomplete in terms of the Python readline API. Add the missing functions we need.
     ############################################################################################################
-    # readline.remove_history_item()
+    # Add missing `readline.remove_history_item()`
     try:
         getattr(readline, 'remove_history_item')
     except AttributeError:

examples/cmd_as_argument.py

@@ -20,7 +20,7 @@ class CmdLineApp(cmd2.Cmd):
     """Example cmd2 application."""
 
     # Setting this true makes it run a shell command if a cmd2/cmd command doesn't exist
-    # default_to_shell = True
+    # default_to_shell = True  # noqa: ERA001
     MUMBLES = ['like', '...', 'um', 'er', 'hmmm', 'ahh']
     MUMBLE_FIRST = ['so', 'like', 'well']
     MUMBLE_LAST = ['right?']

examples/decorator_example.py

@@ -32,7 +32,7 @@ def __init__(self, ip_addr=None, port=None, transcript_files=None) -> None:
         self._port = port
 
         # Setting this true makes it run a shell command if a cmd2/cmd command doesn't exist
-        # self.default_to_shell = True
+        # self.default_to_shell = True  # noqa: ERA001
 
     speak_parser = cmd2.Cmd2ArgumentParser()
     speak_parser.add_argument('-p', '--piglatin', action='store_true', help='atinLay')

examples/example.py

@@ -18,7 +18,7 @@ class CmdLineApp(cmd2.Cmd):
     """Example cmd2 application."""
 
     # Setting this true makes it run a shell command if a cmd2/cmd command doesn't exist
-    # default_to_shell = True
+    # default_to_shell = True  # noqa: ERA001
     MUMBLES = ['like', '...', 'um', 'er', 'hmmm', 'ahh']
     MUMBLE_FIRST = ['so', 'like', 'well']
     MUMBLE_LAST = ['right?']

examples/hooks.py

@@ -38,7 +38,7 @@ class CmdLineApp(cmd2.Cmd):
     """
 
     # Setting this true makes it run a shell command if a cmd2/cmd command doesn't exist
-    # default_to_shell = True
+    # default_to_shell = True  # noqa: ERA001
     def __init__(self, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
 

examples/migrating.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 """A sample cmd application that shows how to trivially migrate a cmd application to use cmd2."""
 
-# import cmd2 as cmd
+# import cmd2 as cmd  # noqa: ERA001
 import cmd  # Comment this line and uncomment the one above to migrate to cmd2
 import random
 

plugins/ext_test/cmd2_ext_test/cmd2_ext_test.py

@@ -63,7 +63,6 @@ def fixture_teardown(self):
 
         :type self: cmd2.Cmd
         """
-        # assert isinstance(self, cmd2.Cmd) and isinstance(self, ExternalTestMixin)
         for func in self._postloop_hooks:
             func()
         self.postloop()

plugins/ext_test/setup.py

@@ -2,17 +2,11 @@
 
 import setuptools
 
-#
 # get the long description from the README file
 here = os.path.abspath(os.path.dirname(__file__))
 with open(os.path.join(here, 'README.md'), encoding='utf-8') as f:
     long_description = f.read()
 
-# scm_version = {
-#     'root': '../..',
-#     'git_describe_command': "git describe --dirty --tags --long --match plugin-ext-test*",
-# }
-
 PACKAGE_DATA = {
     'cmd2_ext_test': ['py.typed'],
 }

plugins/template/setup.py

@@ -2,15 +2,14 @@
 
 import setuptools
 
-#
 # get the long description from the README file
 here = os.path.abspath(os.path.dirname(__file__))
 with open(os.path.join(here, 'README.md'), encoding='utf-8') as f:
     long_description = f.read()
 
 setuptools.setup(
     name='cmd2-myplugin',
-    # use_scm_version=True,  # use_scm_version doesn't work if setup.py isn't in the repository root
+    # use_scm_version=True,  # use_scm_version doesn't work if setup.py isn't in the repository root  # noqa: ERA001
     version='2.0.0',
     description='A template used to build plugins for cmd2',
     long_description=long_description,

plugins/template/tasks.py

@@ -180,19 +180,19 @@ def wheel(context) -> None:
 
 namespace.add_task(wheel)
 
-#
+
 # these two tasks are commented out so you don't
 # accidentally run them and upload this template to pypi
 #
 
 # @invoke.task(pre=[sdist, wheel])
 # def pypi(context):
 #     """Build and upload a distribution to pypi"""
-#     context.run('twine upload dist/*')
-# namespace.add_task(pypi)
+#     context.run('twine upload dist/*')  # noqa: ERA001
+# namespace.add_task(pypi)  # noqa: ERA001
 
 # @invoke.task(pre=[sdist, wheel])
 # def pypi_test(context):
-#     """Build and upload a distribution to https://test.pypi.org"""
-#     context.run('twine upload --repository-url https://test.pypi.org/legacy/ dist/*')
-# namespace.add_task(pypi_test)
+#     """Build and upload a distribution to https://test.pypi.org"""  # noqa: ERA001
+#     context.run('twine upload --repository-url https://test.pypi.org/legacy/ dist/*')  # noqa: ERA001
+# namespace.add_task(pypi_test)  # noqa: ERA001

pyproject.toml

@@ -173,7 +173,7 @@ select = [
     "DTZ", # flake8-datetimez (warn about datetime calls where no timezone is specified)
     "E",   # pycodestyle errors (warn about major stylistic issues like mixing spaces and tabs)
     # "EM", # flake8-errmsg (warn about exceptions that use string literals that aren't assigned to a variable first)
-    # "ERA",  # eradicate (warn about commented-out code)
+    "ERA", # eradicate (warn about commented-out code)
     "EXE", # flake8-executable (warn about files with a shebang present that aren't executable or vice versa)
     "F",   # Pyflakes (a bunch of common warnings for things like unused imports, imports shadowed by variables, etc)
     "FA",  # flake8-future-annotations (warn if certain from __future__ imports are used but missing)

tests/test_argparse_custom.py

@@ -93,7 +93,7 @@ def test_apcustom_nargs_help_format(cust_app) -> None:
 
 
 def test_apcustom_nargs_range_validation(cust_app) -> None:
-    # nargs = (3,)
+    # nargs = (3,)  # noqa: ERA001
     out, err = run_cmd(cust_app, 'range --arg2 one two')
     assert 'Error: argument --arg2: expected at least 3 arguments' in err[2]
 
@@ -103,7 +103,7 @@ def test_apcustom_nargs_range_validation(cust_app) -> None:
     out, err = run_cmd(cust_app, 'range --arg2 one two three four')
     assert not err
 
-    # nargs = (2,3)
+    # nargs = (2,3)  # noqa: ERA001
     out, err = run_cmd(cust_app, 'range --arg3 one')
     assert 'Error: argument --arg3: expected 2 to 3 arguments' in err[2]
 

tests/test_transcript.py

@@ -72,7 +72,6 @@ def do_speak(self, opts, arg) -> None:
     def do_mumble(self, opts, arg) -> None:
         """Mumbles what you tell me to."""
         repetitions = opts.repeat or 1
-        # arg = arg.split()
         for _ in range(min(repetitions, self.maxrepeats)):
             output = []
             if random.random() < 0.33: