Merge pull request #2558 from NicholasTanz/replaceLintingTools

Replace most linting tools with ruff

Author: Lukas Pühringer

.github/dependabot.yml

@@ -16,12 +16,9 @@ updates:
       # Python dependencies that are only pinned to ensure test reproducibility
       patterns:
         - "bandit"
-        - "black"
         - "coverage"
-        - "isort"
         - "mypy"
-        - "pydocstyle"
-        - "pylint"
+        - "ruff"
         - "tox"
     dependencies:
       # Python (developer) runtime dependencies. Also any new dependencies not

examples/repository/_simplerepo.py

@@ -112,7 +112,9 @@ def _get_verification_result(
         )
 
     def open(self, role: str) -> Metadata:
-        """Return current Metadata for role from 'storage' (or create a new one)"""
+        """Return current Metadata for role from 'storage'
+        (or create a new one)
+        """
 
         if role not in self.role_cache:
             signed_init = _signed_init.get(role, Targets)

examples/uploader/_localrepo.py

@@ -62,7 +62,6 @@ def open(self, role: str) -> Metadata:
 
         # if there is a metadata version fetched from remote, use that
         # HACK: access Updater internals
-        # pylint: disable=protected-access
         if role in self.updater._trusted_set:
             return copy.deepcopy(self.updater._trusted_set[role])
 
@@ -105,7 +104,7 @@ def add_target(self, role: str, targetpath: str) -> bool:
             with self.edit_targets(role) as delegated:
                 delegated.targets[targetpath] = targetfile
 
-        except Exception as e:  # pylint: disable=broad-except
+        except Exception as e:
             print(f"Failed to submit new {role} with added target: {e}")
             return False
 

pyproject.toml

@@ -75,67 +75,25 @@ include = [
 # from `tests` so the root directory must be added to Python's path for editable installations
 dev-mode-dirs = ["."]
 
-# Black section
-# Read more here: https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-via-a-file
-[tool.black]
+# Ruff section
+# Read more here: https://docs.astral.sh/ruff/linter/#rule-selection
+[tool.ruff]
 line-length=80
 
-# Isort section
-# Read more here: https://pycqa.github.io/isort/docs/configuration/config_files.html
-[tool.isort]
-profile="black"
-line_length=80
-known_first_party = ["tuf"]
-
-# Pylint section
-
-# Minimal pylint configuration file for Secure Systems Lab Python Style Guide:
-#     https://github.com/secure-systems-lab/code-style-guidelines
-#
-# Based on Google Python Style Guide pylintrc and pylint defaults:
-#     https://google.github.io/styleguide/pylintrc
-#     http://pylint.pycqa.org/en/latest/technical_reference/features.html
-
-[tool.pylint.message_control]
-# Disable the message, report, category or checker with the given id(s).
-# NOTE: To keep this config as short as possible we only disable checks that
-# are currently in conflict with our code. If new code displeases the linter
-# (for good reasons) consider updating this config file, or disable checks with.
-disable=[
-  "fixme",
-  "too-few-public-methods",
-  "too-many-arguments",
-  "format",
-  "duplicate-code"
-]
-
-[tool.pylint.basic]
-good-names = ["i","j","k","v","e","f","fn","fp","_type","_"]
-# Regexes for allowed names are copied from the Google pylintrc
-# NOTE: Pylint captures regex name groups such as 'snake_case' or 'camel_case'.
-# If there are multiple groups it enfoces the prevalent naming style inside
-# each modules. Names in the exempt capturing group are ignored.
-function-rgx="^(?:(?P<exempt>setUp|tearDown|setUpModule|tearDownModule)|(?P<camel_case>_?[A-Z][a-zA-Z0-9]*)|(?P<snake_case>_?[a-z][a-z0-9_]*))$"
-method-rgx="(?x)^(?:(?P<exempt>_[a-z0-9_]+__|runTest|setUp|tearDown|setUpTestCase|tearDownTestCase|setupSelf|tearDownClass|setUpClass|(test|assert)_*[A-Z0-9][a-zA-Z0-9_]*|next)|(?P<camel_case>_{0,2}[A-Z][a-zA-Z0-9_]*)|(?P<snake_case>_{0,2}[a-z][a-z0-9_]*))$"
-argument-rgx="^[a-z][a-z0-9_]*$"
-attr-rgx="^_{0,2}[a-z][a-z0-9_]*$"
-class-attribute-rgx="^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$"
-class-rgx="^_?[A-Z][a-zA-Z0-9]*$"
-const-rgx="^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$"
-inlinevar-rgx="^[a-z][a-z0-9_]*$"
-module-rgx="^(_?[a-z][a-z0-9_]*|__init__)$"
-no-docstring-rgx="(__.*__|main|test.*|.*test|.*Test)$"
-variable-rgx="^[a-z][a-z0-9_]*$"
-docstring-min-length=10
-
-[tool.pylint.logging]
-logging-format-style="old"
-
-[tool.pylint.miscellaneous]
-notes="TODO"
-
-[tool.pylint.STRING]
-check-quote-consistency="yes"
+[tool.ruff.lint]
+select = [
+    "D",  # pydocstyle
+    "E",  # pycodestyle
+    "F",  # pyflakes
+    "I",  # isort
+    "N",  # pep8-naming
+    "PL", # pylint
+] 
+ignore = ["D400","D415","D213","D205","D202","D107","D407","D413","D212","D104","D406","D105","D411","D401","D200","D203", "PLR0913", "PLR2004"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["D", "E"]
+"examples/*/*" = ["D"] 
 
 # mypy section
 # Read more here: https://mypy.readthedocs.io/en/stable/config_file.html#using-a-pyproject-toml-file
@@ -156,7 +114,3 @@ module = [
   "securesystemslib.*",
 ]
 ignore_missing_imports = "True"
-
-[tool.pydocstyle]
-inherit = false
-ignore = "D400,D415,D213,D205,D202,D107,D407,D413,D212,D104,D406,D105,D411,D401,D200,D203"

requirements/lint.txt

@@ -6,9 +6,6 @@
 # Lint tools
 # (We are not so interested in the specific versions of the tools: the versions
 # are pinned to prevent unexpected linting failures when tools update)
-black==24.2.0
-isort==5.13.2
-pylint==3.0.3
+ruff==0.2.1
 mypy==1.8.0
 bandit==1.7.7
-pydocstyle==6.3.0

tests/repository_simulator.py

@@ -99,7 +99,6 @@ class RepositoryTarget:
 class RepositorySimulator(FetcherInterface):
     """Simulates a repository that can be used for testing."""
 
-    # pylint: disable=too-many-instance-attributes
     def __init__(self) -> None:
         self.md_delegates: Dict[str, Metadata[Targets]] = {}
 

tests/test_api.py

@@ -56,7 +56,6 @@
 logger = logging.getLogger(__name__)
 
 
-# pylint: disable=too-many-public-methods,too-many-statements
 class TestMetadata(unittest.TestCase):
     """Tests for public API of all classes in 'tuf/api/metadata.py'."""
 
@@ -246,7 +245,7 @@ def test_sign_failures(self) -> None:
             os.path.join(self.repo_dir, "metadata", "snapshot.json")
         )
 
-        class FailingSigner(Signer):  # pylint: disable=missing-class-docstring
+        class FailingSigner(Signer):
             @classmethod
             def from_priv_key_uri(
                 cls,
@@ -365,7 +364,6 @@ def test_metadata_verify_delegate(self) -> None:
             role2.verify_delegate("role1", role1)
 
     def test_signed_verify_delegate(self) -> None:
-        # pylint: disable=too-many-locals,too-many-statements
         root_path = os.path.join(self.repo_dir, "metadata", "root.json")
         root_md = Metadata[Root].from_file(root_path)
         root = root_md.signed
@@ -742,7 +740,6 @@ def test_root_add_key_and_revoke_key(self) -> None:
             root.signed.revoke_key(keyid, "nosuchrole")
 
     def test_is_target_in_pathpattern(self) -> None:
-        # pylint: disable=protected-access
         supported_use_cases = [
             ("foo.tgz", "foo.tgz"),
             ("foo.tgz", "*"),

tests/test_examples.py

@@ -53,7 +53,6 @@ def _run_script_and_assert_files(
         CWD."""
         script_path = str(self.repo_examples_dir / script_name)
         with open(script_path, "rb") as f:
-            # pylint: disable=exec-used
             exec(
                 compile(f.read(), script_path, "exec"),
                 {"__file__": script_path},

tests/test_metadata_eq_.py

@@ -89,7 +89,7 @@ def setUpClass(cls) -> None:
 
     @utils.run_sub_tests_with_dataset(classes_attributes_modifications)
     def test_classes_eq_(self, test_case_data: Dict[str, Any]) -> None:
-        obj = self.objects[self.case_name]  # pylint: disable=no-member
+        obj = self.objects[self.case_name]
 
         # Assert that obj is not equal to an object from another type
         self.assertNotEqual(obj, "")

tests/test_metadata_serialization.py

@@ -34,7 +34,6 @@
 logger = logging.getLogger(__name__)
 
 
-# pylint: disable=too-many-public-methods
 class TestSerialization(unittest.TestCase):
     """Test serialization for all classes in 'tuf/api/metadata.py'."""