Enabled ruff PLW ruleset for PyLint warnings

Author: tleonhardt

cmd2/argparse_completer.py

@@ -775,5 +775,5 @@ def set_default_ap_completer_type(completer_type: Type[ArgparseCompleter]) -> No
 
     :param completer_type: Type that is a subclass of ArgparseCompleter.
     """
-    global DEFAULT_AP_COMPLETER
+    global DEFAULT_AP_COMPLETER  # noqa: PLW0603
     DEFAULT_AP_COMPLETER = completer_type

cmd2/argparse_custom.py

@@ -1407,5 +1407,5 @@ def set_default_argument_parser_type(parser_type: type[argparse.ArgumentParser])
     Set the default ArgumentParser class for a cmd2 app. This must be called prior to loading cmd2.py if
     you want to override the parser for cmd2's built-in commands. See examples/override_parser.py.
     """
-    global DEFAULT_ARGUMENT_PARSER
+    global DEFAULT_ARGUMENT_PARSER  # noqa: PLW0603
     DEFAULT_ARGUMENT_PARSER = parser_type

cmd2/cmd2.py

@@ -2653,7 +2653,7 @@ def runcmds_plus_hooks(
         """
         for line in cmds:
             if isinstance(line, HistoryItem):
-                line = line.raw
+                line = line.raw  # noqa: PLW2901
 
             if self.echo:
                 self.poutput(f'{self.prompt}{line}')
@@ -4974,7 +4974,7 @@ def _generate_transcript(
                 first = True
                 command = ''
                 if isinstance(history_item, HistoryItem):
-                    history_item = history_item.raw
+                    history_item = history_item.raw  # noqa: PLW2901
                 for line in history_item.splitlines():
                     if first:
                         command += f"{self.prompt}{line}\n"

cmd2/decorators.py

@@ -87,7 +87,7 @@ def _parse_positionals(args: tuple[Any, ...]) -> tuple['cmd2.Cmd', Union[Stateme
 
         if isinstance(arg, (Cmd, CommandSet)) and len(args) > pos + 1:
             if isinstance(arg, CommandSet):
-                arg = arg._cmd
+                arg = arg._cmd  # noqa: PLW2901
             next_arg = args[pos + 1]
             if isinstance(next_arg, (Statement, str)):
                 return arg, args[pos + 1]

cmd2/parsing.py

@@ -660,11 +660,12 @@ def _expand(self, line: str) -> str:
             if line.startswith(shortcut):
                 # If the next character after the shortcut isn't a space, then insert one
                 shortcut_len = len(shortcut)
+                effective_expansion = expansion
                 if len(line) == shortcut_len or line[shortcut_len] != ' ':
-                    expansion += ' '
+                    effective_expansion += ' '
 
                 # Expand the shortcut
-                line = line.replace(shortcut, expansion, 1)
+                line = line.replace(shortcut, effective_expansion, 1)
                 break
         return line
 

cmd2/table_creator.py

@@ -894,7 +894,6 @@ def generate_row_bottom_border(self) -> str:
         if self.column_borders:
             inter_cell += '┼'
         inter_cell += self.padding * '─'
-        inter_cell = inter_cell
 
         post_line = self.padding * '─' + '╢'
 

cmd2/utils.py

@@ -376,12 +376,14 @@ def find_editor() -> Optional[str]:
         else:
             paths = [p for p in env_path.split(os.path.pathsep) if not os.path.islink(p)]
 
-        for editor, path in itertools.product(editors, paths):
-            editor_path = os.path.join(path, editor)
+        for possible_editor, path in itertools.product(editors, paths):
+            editor_path = os.path.join(path, possible_editor)
             if os.path.isfile(editor_path) and os.access(editor_path, os.X_OK):
                 if sys.platform[:3] == 'win':
                     # Remove extension from Windows file names
-                    editor = os.path.splitext(editor)[0]
+                    editor = os.path.splitext(possible_editor)[0]
+                else:
+                    editor = possible_editor
                 break
         else:
             editor = None
@@ -902,7 +904,7 @@ def align_text(
             text_buf.write('\n')
 
         if truncate:
-            line = truncate_line(line, width)
+            line = truncate_line(line, width)  # noqa: PLW2901
 
         line_width = ansi.style_aware_wcswidth(line)
         if line_width == -1:

examples/async_printing.py

@@ -90,8 +90,6 @@ def _get_alerts(self) -> list[str]:
         Reports alerts
         :return: the list of alerts
         """
-        global ALERTS
-
         cur_time = time.monotonic()
         if cur_time < self._next_alert_time:
             return []
@@ -121,8 +119,6 @@ def _generate_alert_str(self) -> str:
         Combines alerts into one string that can be printed to the terminal
         :return: the alert string
         """
-        global ALERTS
-
         alert_str = ''
         alerts = self._get_alerts()
 

pyproject.toml

@@ -198,7 +198,7 @@ select = [
     "PLC",  # Pylint Conventions
     "PLE",  # Pylint Errors
     # "PLR", # Pylint Refactoring suggestions
-    # "PLW", # Pylint Warnings
+    "PLW", # Pylint Warnings
     # "PT", # flake8-pytest-style (warnings about unit test best practices)
     # "PTH",  # flake8-use-pathlib (force use of pathlib instead of os.path)
     "PYI", # flake8-pyi (warnings related to type hint best practices)
@@ -255,7 +255,8 @@ per-file-ignores."cmd2/__init__.py" = [
 ]
 
 per-file-ignores."examples/*.py" = [
-    "INP001", # Module is part of an implicit namespace
+    "INP001",  # Module is part of an implicit namespace
+    "PLW2901", # loop variable overwritten inside loop
 ]
 
 per-file-ignores."examples/override_parser.py" = [
@@ -278,11 +279,19 @@ per-file-ignores."tests/*.py" = [
     "E501", # Line too long
 ]
 
+per-file-ignores."tests/test_argparse.py" = [
+    "PLW2901", # loop variable overwritten inside loop
+]
+
 per-file-ignores."tests/pyscript/*.py" = [
     "F821",   # Undefined name `app`
     "INP001", # Module is part of an implicit namespace
 ]
 
+per-file-ignores."tests_isolated/test_commandset/test_commandset.py" = [
+    "PLW0603", # Using the global statement to update {name} is discouraged
+]
+
 
 [tool.ruff.format]
 # Like Black, use double quotes for strings.