switch pylint to ruff

Author: RobertBlackhart

.gitignore

@@ -118,6 +118,9 @@ dmypy.json
 
 .DS_Store
 
+# lint
+.ruff_cache/
+
 # api_reference is an auto-generated part of the docs that is based on the source
 # code docstrings, so don't have git track these files
 docs/api_reference

docs/async_commands/index.rst

@@ -1,4 +1,5 @@
 .. _async-commands:
+
 Async Commands
 ==============
 

examples/cake.py

@@ -18,7 +18,6 @@
 CAKES = []
 
 
-# pylint: disable=bad-continuation
 @recline.command(name="cake make")
 def make_cake(
     layers: RangedInt.define(min=2, max=10),

examples/ls

@@ -129,7 +129,6 @@ def render_output(output_items):
         print(row)
 
 
-# pylint: disable=bad-continuation,invalid-name
 @recline.command
 def ls(
     path: Positional = ".",

poetry.lock

@@ -28,7 +28,7 @@ pyreadline3 = {version = "^3.4.1", markers = "sys_platform == 'win32'"}
 
 [tool.poetry.group.dev.dependencies]
 pudb = "^2025.1.5"
-pylint = "^4.0.5"
+ruff = "^0.15.11"
 pytest = "^9.0.2"
 pytest-cov = "^7.1.0"
 sphinx = "^8.1.0"
@@ -40,3 +40,6 @@ importlib-metadata = "^9.0.0"
 requires = ["poetry-core>=2.0.0,<3.0.0"]
 build-backend = "poetry.core.masonry.api"
 
+[tool.ruff]
+exclude = ["recline/vendor"]
+

pyproject.toml

@@ -2,15 +2,12 @@
 Original © NetApp 2024
 """
 
-import os
-import sys
-
 PROGRAM_NAME = None
 PROMPT = '> '
 NEXT_JOB_PID = 1
 JOBS = {}
 
-from recline.commands.cli_command import command  # pylint: disable=wrong-import-position
-from recline.repl.shell import relax  # pylint: disable=wrong-import-position
+from recline.commands.cli_command import command  # noqa: E402
+from recline.repl.shell import relax  # noqa: E402
 
 __all__ = ['PROGRAM_NAME', 'PROMPT', 'command', 'relax']

recline/__init__.py

@@ -5,9 +5,11 @@
 for a parameter. Once the body of the function is invoked, it is guaranteed that
 the validation was done on the parameter to make sure it matched one.
 
-@recline.command(name="cake make")
-def make_cake(flavor: Choices.define(["chocolate", "vanilla", "marble"])) -> None:
-    # We can assume flavor is one of the choices in the body of the function
+.. code-block:: python
+
+    @recline.command(name="cake make")
+    def make_cake(flavor: Choices.define(["chocolate", "vanilla", "marble"])) -> None:
+        # We can assume flavor is one of the choices in the body of the function
 """
 
 from typing import Callable
@@ -44,6 +46,7 @@ def define(
                 the "*", "|", or ".." query characters. If these characters are
                 present, then no validation will be done on the value (and validation
                 is assumed to be done on whatever the command is calling)
+
             data_type: The type of data that represents this argument
         """
 
@@ -57,12 +60,12 @@ def validate(self, arg):
                         )
                 try:
                     return data_type(arg)
-                except Exception:  # pylint: disable=broad-except
+                except Exception:
                     raise ReclineTypeError(f'Unable to convert "{arg}" to type {data_type}')
 
             def choices(self, eager=False):
                 if hasattr(self.__class__, '_cached_choices'):
-                    return self.__class__._cached_choices  # pylint: disable=protected-access
+                    return self.__class__._cached_choices
 
                 # don't call the completer function unless we're sure we want to
                 if not eager and not isinstance(available_choices, list):
@@ -74,7 +77,7 @@ def choices(self, eager=False):
 
                 current_choices = [str(c) for c in current_choices]
                 if cache_choices:
-                    self.__class__._cached_choices = current_choices  # pylint: disable=protected-access
+                    self.__class__._cached_choices = current_choices
                 self.__class__.metavar = f"<{'|'.join(current_choices)}>"
                 return current_choices
 

recline/arg_types/choices.py

@@ -7,9 +7,11 @@
 is a flag. If it is a bool, then the user must provide either "true" or "false"
 explicitly on the command line.
 
-@recline.command
-def ls(l: Flag = None) -> None:
-    # If the user provided "-l" then l will be set to True. Else l will be None
+.. code-block:: python
+
+    @recline.command
+    def ls(l: Flag = None) -> None:
+        # If the user provided "-l" then l will be set to True. Else l will be None
 """
 
 from recline.arg_types.recline_type import ReclineType

recline/arg_types/flag.py

@@ -5,10 +5,12 @@
 user will provide positionally. That is, instead of the user typing
 "-arg_name argvalue", they can just type "argvalue". For example:
 
-@recline.command
-def ls(path: Positional = ".") -> None:
-    # If the user provided "ls my_dir", then path will be set to "my_dir". If the
-    # user just said "ls", then path will be set to ".".
+.. code-block:: python
+
+    @recline.command
+    def ls(path: Positional = ".") -> None:
+        # If the user provided "ls my_dir", then path will be set to "my_dir". If the
+        # user just said "ls", then path will be set to ".".
 """
 
 from recline.arg_types.recline_type import ReclineType