Merge pull request #2597 from jku/lint-fixes

Lukas Pühringer · web-flow · commit c311e2219412 · 2024-05-07T11:06:48.000+02:00
Enable linters
diff --git a/examples/uploader/_localrepo.py b/examples/uploader/_localrepo.py
@@ -62,11 +62,12 @@ def open(self, role: str) -> Metadata:
 
         # if there is a metadata version fetched from remote, use that
         # HACK: access Updater internals
-        if role in self.updater._trusted_set:
+        trusted_set = self.updater._trusted_set  # noqa: SLF001
+        if role in trusted_set:
             # NOTE: The original signature wrapper (Metadata) was verified and
             # discarded upon inclusion in the trusted set. It is safe to use
             # a fresh wrapper. `close` will override existing signatures anyway.
-            return Metadata(copy.deepcopy(self.updater._trusted_set[role]))
+            return Metadata(copy.deepcopy(trusted_set[role]))
 
         # otherwise we're creating metadata from scratch
         md = Metadata(Targets())
diff --git a/pyproject.toml b/pyproject.toml
@@ -83,25 +83,34 @@ line-length=80
 [tool.ruff.lint]
 select = [
     "A",   # flake8-builtins
+    "ANN", # flake8-annotations
+    "ARG", # flake8-unused-arguments
     "B",   # flake8-bugbear
     "BLE", # flake8-blind-except
     "C4",  # flake8-comprehensions
     "D",   # pydocstyle
     "DTZ", # flake8-datetimez
     "E",   # pycodestyle
+    "EXE", # flake8-executable
     "F",   # pyflakes
     "I",   # isort
     "ISC", # flake8-implicit-str-concat
     "N",   # pep8-naming
     "PL",  # pylint
+    "PGH", # pygrep-hooks
+    "PIE", # flake8-pie
+    "PYI", # flake8-pyi
     "RET", # flake8-return
+    "RSE", # flake8-raise
     "RUF", # ruff-specific rules
     "S",   # flake8-bandit
     "SIM", # flake8-simplify
+    "SLF", # flake8-self
     "UP",  # pyupgrade
     "W",   # pycodestyle-warning
 ] 
 ignore = [
+    "ANN101", "ANN102", # nonsense, deprecated in ruff
     "D400", "D415", "D213", "D205", "D202", "D107", "D407", "D413", "D212", "D104", "D406", "D105", "D411", "D401", "D200", "D203",
     "PLR0913", "PLR2004",
     "ISC001", # incompatible with ruff formatter
@@ -111,8 +120,9 @@ ignore = [
 "tests/*" = [
     "D",      # pydocstyle: no docstrings required for tests
     "E501",   # line-too-long: embedded test data in "fmt: off" blocks is ok
-    "S",      # bandit: Not running bandit on tests
     "RUF012", # ruff: mutable-class-default
+    "S",      # bandit: Not running bandit on tests
+    "SLF001"  # private member access is ok in tests
 ]
 "examples/*/*" = [
     "D", # pydocstyle: no docstrings required for examples
@@ -122,6 +132,9 @@ ignore = [
     "S603", # bandit: this flags all uses of subprocess.run as vulnerable
 ]
 
+[tool.ruff.lint.flake8-annotations]
+mypy-init-return = true
+
 # mypy section
 # Read more here: https://mypy.readthedocs.io/en/stable/config_file.html#using-a-pyproject-toml-file
 [tool.mypy]
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/repository_simulator.py b/tests/repository_simulator.py
@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-
 # Copyright 2021, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
@@ -160,7 +158,7 @@ def rotate_keys(self, role: str) -> None:
         """remove all keys for role, then add threshold of new keys"""
         self.root.roles[role].keyids.clear()
         self.signers[role].clear()
-        for _ in range(0, self.root.roles[role].threshold):
+        for _ in range(self.root.roles[role].threshold):
             signer = CryptoSigner.generate_ed25519()
             self.root.add_key(signer.public_key, role)
             self.add_signer(role, signer)
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-
 # Copyright 2020, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 """Unit tests for api/metadata.py"""
@@ -255,7 +253,7 @@ def from_priv_key_uri(
             def public_key(self) -> Key:
                 raise RuntimeError("Not a real signer")
 
-            def sign(self, payload: bytes) -> Signature:
+            def sign(self, _payload: bytes) -> Signature:
                 raise RuntimeError("signing failed")
 
         failing_signer = FailingSigner()
@@ -1118,7 +1116,7 @@ def test_delegations_get_delegated_role(self) -> None:
         for name in ["prefix-", "prefix--1", f"prefix-{2**bit_len:0x}"]:
             with self.assertRaises(ValueError, msg=f"role name '{name}'"):
                 targets.get_delegated_role(name)
-        for i in range(0, 2**bit_len):
+        for i in range(2**bit_len):
             self.assertEqual(
                 targets.get_delegated_role(f"prefix-{i:0x}"), role2
             )
@@ -1175,7 +1173,7 @@ def test_fail_envelope_deserialization(self) -> None:
 
     def test_fail_payload_serialization(self) -> None:
         with self.assertRaises(SerializationError):
-            SimpleEnvelope.from_signed("foo")  # type: ignore
+            SimpleEnvelope.from_signed("foo")  # type: ignore[type-var]
 
     def test_fail_payload_deserialization(self) -> None:
         payloads = [b"[", b'{"_type": "foo"}']
diff --git a/tests/test_examples.py b/tests/test_examples.py
@@ -1,4 +1,3 @@
-#!/usr/bin/env python
 # Copyright 2020, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 """Unit tests for 'examples' scripts."""
diff --git a/tests/test_fetcher_ng.py b/tests/test_fetcher_ng.py
@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-
 # Copyright 2021, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
@@ -107,7 +105,7 @@ def test_http_error(self) -> None:
 
     # Response read timeout error
     @patch.object(requests.Session, "get")
-    def test_response_read_timeout(self, mock_session_get: Any) -> None:
+    def test_response_read_timeout(self, mock_session_get: Mock) -> None:
         mock_response = Mock()
         attr = {
             "iter_content.side_effect": requests.exceptions.ConnectionError(
@@ -127,7 +125,7 @@ def test_response_read_timeout(self, mock_session_get: Any) -> None:
         "get",
         side_effect=requests.exceptions.Timeout("Simulated timeout"),
     )
-    def test_session_get_timeout(self, mock_session_get: Any) -> None:
+    def test_session_get_timeout(self, mock_session_get: Mock) -> None:
         with self.assertRaises(exceptions.SlowRetrievalError):
             self.fetcher.fetch(self.url)
         mock_session_get.assert_called_once()
diff --git a/tests/test_metadata_eq_.py b/tests/test_metadata_eq_.py
@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-
 # Copyright New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
@@ -132,7 +130,7 @@ def test_md_eq_special_signatures_tests(self) -> None:
         self.assertEqual(md, md_2)
 
         # Metadata objects with different signatures types are not equal.
-        md_2.signatures = ""  # type: ignore
+        md_2.signatures = ""  # type: ignore[assignment]
         self.assertNotEqual(md, md_2)
 
     def test_delegations_eq_roles_reversed_order(self) -> None:
diff --git a/tests/test_updater_consistent_snapshot.py b/tests/test_updater_consistent_snapshot.py
@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-
 # Copyright 2021, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
diff --git a/tests/test_updater_delegation_graphs.py b/tests/test_updater_delegation_graphs.py
@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-
 # Copyright 2021, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
diff --git a/tests/test_updater_fetch_target.py b/tests/test_updater_fetch_target.py
@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-
 # Copyright 2021, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
diff --git a/tests/test_updater_key_rotations.py b/tests/test_updater_key_rotations.py
@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-
 # Copyright 2021, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
diff --git a/tests/test_updater_ng.py b/tests/test_updater_ng.py
@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-
 # Copyright 2021, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
@@ -281,7 +279,7 @@ def test_length_hash_mismatch(self) -> None:
 
     def test_updating_root(self) -> None:
         # Bump root version, resign and refresh
-        self._modify_repository_root(lambda root: None, bump_version=True)
+        self._modify_repository_root(lambda _: None, bump_version=True)
         self.updater.refresh()
         self.assertEqual(self.updater._trusted_set.root.version, 2)
 
diff --git a/tests/test_updater_top_level_update.py b/tests/test_updater_top_level_update.py
@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-
 # Copyright 2021, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
diff --git a/tests/test_updater_validation.py b/tests/test_updater_validation.py
@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-
 # Copyright 2022, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
diff --git a/tests/test_utils.py b/tests/test_utils.py
@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-
 # Copyright 2020, TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
diff --git a/tests/utils.py b/tests/utils.py
@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-
 # Copyright 2020, TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 
diff --git a/tuf/__init__.py b/tuf/__init__.py
diff --git a/tuf/api/_payload.py b/tuf/api/_payload.py
@@ -133,7 +133,7 @@ def __init__(
 
         self.unrecognized_fields = unrecognized_fields
 
-    def __eq__(self, other: Any) -> bool:
+    def __eq__(self, other: object) -> bool:
         if not isinstance(other, Signed):
             return False
 
@@ -253,7 +253,7 @@ def __init__(
 
         self.unrecognized_fields = unrecognized_fields
 
-    def __eq__(self, other: Any) -> bool:
+    def __eq__(self, other: object) -> bool:
         if not isinstance(other, Role):
             return False
 
@@ -504,7 +504,7 @@ def __init__(
             raise ValueError("Role names must be the top-level metadata roles")
         self.roles = roles
 
-    def __eq__(self, other: Any) -> bool:
+    def __eq__(self, other: object) -> bool:
         if not isinstance(other, Root):
             return False
 
@@ -795,7 +795,7 @@ def __init__(
 
         self.unrecognized_fields = unrecognized_fields
 
-    def __eq__(self, other: Any) -> bool:
+    def __eq__(self, other: object) -> bool:
         if not isinstance(other, MetaFile):
             return False
 
@@ -912,7 +912,7 @@ def __init__(
         super().__init__(version, spec_version, expires, unrecognized_fields)
         self.snapshot_meta = snapshot_meta or MetaFile(1)
 
-    def __eq__(self, other: Any) -> bool:
+    def __eq__(self, other: object) -> bool:
         if not isinstance(other, Timestamp):
             return False
 
@@ -975,7 +975,7 @@ def __init__(
         super().__init__(version, spec_version, expires, unrecognized_fields)
         self.meta = meta if meta is not None else {"targets.json": MetaFile(1)}
 
-    def __eq__(self, other: Any) -> bool:
+    def __eq__(self, other: object) -> bool:
         if not isinstance(other, Snapshot):
             return False
 
@@ -1066,7 +1066,7 @@ def __init__(
         self.paths = paths
         self.path_hash_prefixes = path_hash_prefixes
 
-    def __eq__(self, other: Any) -> bool:
+    def __eq__(self, other: object) -> bool:
         if not isinstance(other, DelegatedRole):
             return False
 
@@ -1226,7 +1226,7 @@ def __init__(
         # of the last bin contains the number "number_of_bins -1" as a suffix.
         self.suffix_len = len(f"{self.number_of_bins-1:x}")
 
-    def __eq__(self, other: Any) -> bool:
+    def __eq__(self, other: object) -> bool:
         if not isinstance(other, SuccinctRoles):
             return False
 
@@ -1286,7 +1286,7 @@ def get_role_for_target(self, target_filepath: str) -> str:
 
     def get_roles(self) -> Iterator[str]:
         """Yield the names of all different delegated roles one by one."""
-        for i in range(0, self.number_of_bins):
+        for i in range(self.number_of_bins):
             suffix = f"{i:0{self.suffix_len}x}"
             yield f"{self.name_prefix}-{suffix}"
 
@@ -1368,7 +1368,7 @@ def __init__(
 
         self.unrecognized_fields = unrecognized_fields
 
-    def __eq__(self, other: Any) -> bool:
+    def __eq__(self, other: object) -> bool:
         if not isinstance(other, Delegations):
             return False
 
@@ -1491,14 +1491,14 @@ def __init__(
         self.unrecognized_fields = unrecognized_fields
 
     @property
-    def custom(self) -> Any:
+    def custom(self) -> Any:  # noqa: ANN401
         """Get implementation specific data related to the target.
 
         python-tuf does not use or validate this data.
         """
         return self.unrecognized_fields.get("custom")
 
-    def __eq__(self, other: Any) -> bool:
+    def __eq__(self, other: object) -> bool:
         if not isinstance(other, TargetFile):
             return False
 
@@ -1642,7 +1642,7 @@ def __init__(
         self.targets = targets if targets is not None else {}
         self.delegations = delegations
 
-    def __eq__(self, other: Any) -> bool:
+    def __eq__(self, other: object) -> bool:
         if not isinstance(other, Targets):
             return False
 
diff --git a/tuf/api/metadata.py b/tuf/api/metadata.py
@@ -131,7 +131,7 @@ def __init__(
 
         self.unrecognized_fields = unrecognized_fields
 
-    def __eq__(self, other: Any) -> bool:
+    def __eq__(self, other: object) -> bool:
         if not isinstance(other, Metadata):
             return False
 
diff --git a/tuf/ngclient/_internal/trusted_metadata_set.py b/tuf/ngclient/_internal/trusted_metadata_set.py
@@ -240,7 +240,7 @@ def update_timestamp(self, data: bytes) -> Timestamp:
                 )
             # Keep using old timestamp if versions are equal.
             if new_timestamp.version == self.timestamp.version:
-                raise exceptions.EqualVersionNumberError()
+                raise exceptions.EqualVersionNumberError
 
             # Prevent rolling back snapshot version
             snapshot_meta = self.timestamp.snapshot_meta
@@ -490,9 +490,9 @@ def _load_from_simple_envelope(
 
     envelope = SimpleEnvelope[T].from_bytes(data)
 
-    if envelope.payload_type != SimpleEnvelope._DEFAULT_PAYLOAD_TYPE:
+    if envelope.payload_type != SimpleEnvelope._DEFAULT_PAYLOAD_TYPE:  # noqa: SLF001
         raise exceptions.RepositoryError(
-            f"Expected '{SimpleEnvelope._DEFAULT_PAYLOAD_TYPE}', "
+            f"Expected '{SimpleEnvelope._DEFAULT_PAYLOAD_TYPE}', "  # noqa: SLF001
             f"got '{envelope.payload_type}'"
         )
 
diff --git a/verify_release b/verify_release
@@ -19,7 +19,7 @@ from tempfile import TemporaryDirectory
 from typing import Optional
 
 try:
-    import build as _  # type: ignore # noqa: F401
+    import build as _  # type: ignore[import-not-found] # noqa: F401
     import requests
 except ImportError:
     print("Error: verify_release requires modules 'requests' and 'build':")

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-#!/usr/bin/env python`
`2`	`1`	`# Copyright 2020, New York University and the TUF contributors`
`3`	`2`	`# SPDX-License-Identifier: MIT OR Apache-2.0`
`4`	`3`	`"""Unit tests for 'examples' scripts."""`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-#!/usr/bin/env python`
`2`		`-`
`3`	`1`	`# Copyright 2021, New York University and the TUF contributors`
`4`	`2`	`# SPDX-License-Identifier: MIT OR Apache-2.0`
`5`	`3`