Merge pull request #2795 from pakagronglb/enable-fa-linting

Enable FA (future annotations) linting ruleset

Author: jku

.github/scripts/conformance-client.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 """Conformance client for python-tuf, part of tuf-conformance"""
 
 # Copyright 2024 tuf-conformance contributors

examples/client/client

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 """TUF Client Example"""
 
 # Copyright 2012 - 2017, New York University and the TUF contributors

examples/repository/repo

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # Copyright 2021-2022 python-tuf contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 

examples/uploader/uploader

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # Copyright 2021-2022 python-tuf contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0
 

pyproject.toml

@@ -81,7 +81,6 @@ ignore = [
     # Rulesets we do not use at this moment
     "COM",
     "EM",
-    "FA",
     "FIX",
     "FBT",
     "PERF",

tests/simple_server.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 # Copyright 2012 - 2017, New York University and the TUF contributors
 # SPDX-License-Identifier: MIT OR Apache-2.0

tests/test_updater_fetch_target.py

@@ -5,12 +5,13 @@
 target files storing/loading from cache.
 """
 
+from __future__ import annotations
+
 import os
 import sys
 import tempfile
 import unittest
 from dataclasses import dataclass
-from typing import Optional
 
 from tests import utils
 from tests.repository_simulator import RepositorySimulator
@@ -30,7 +31,7 @@ class TestFetchTarget(unittest.TestCase):
     """Test ngclient downloading and caching target files."""
 
     # set dump_dir to trigger repository state dumps
-    dump_dir: Optional[str] = None
+    dump_dir: str | None = None
 
     def setUp(self) -> None:
         self.temp_dir = tempfile.TemporaryDirectory()

tests/test_updater_top_level_update.py

@@ -3,15 +3,16 @@
 
 """Test ngclient Updater top-level metadata update workflow"""
 
+from __future__ import annotations
+
 import builtins
 import datetime
 import os
 import sys
 import tempfile
 import unittest
-from collections.abc import Iterable
 from datetime import timezone
-from typing import Optional
+from typing import TYPE_CHECKING
 from unittest.mock import MagicMock, call, patch
 
 import freezegun
@@ -37,13 +38,16 @@
 )
 from tuf.ngclient import Updater
 
+if TYPE_CHECKING:
+    from collections.abc import Iterable
+
 
 class TestRefresh(unittest.TestCase):
     """Test update of top-level metadata following
     'Detailed client workflow' in the specification."""
 
     # set dump_dir to trigger repository state dumps
-    dump_dir: Optional[str] = None
+    dump_dir: str | None = None
 
     past_datetime = datetime.datetime.now(timezone.utc).replace(
         microsecond=0
@@ -109,7 +113,7 @@ def _assert_files_exist(self, roles: Iterable[str]) -> None:
         self.assertListEqual(sorted(found_files), sorted(expected_files))
 
     def _assert_content_equals(
-        self, role: str, version: Optional[int] = None
+        self, role: str, version: int | None = None
     ) -> None:
         """Assert that local file content is the expected"""
         expected_content = self.sim.fetch_metadata(role, version)

tuf/api/serialization/json.py

@@ -11,8 +11,9 @@
 # We should not have shadowed stdlib json but that milk spilled already
 # ruff: noqa: A005
 
+from __future__ import annotations
+
 import json
-from typing import Optional
 
 from securesystemslib.formats import encode_canonical
 
@@ -56,7 +57,7 @@ class JSONSerializer(MetadataSerializer):
 
     """
 
-    def __init__(self, compact: bool = False, validate: Optional[bool] = False):
+    def __init__(self, compact: bool = False, validate: bool | None = False):
         self.compact = compact
         self.validate = validate
 

tuf/ngclient/config.py

@@ -3,9 +3,10 @@
 
 """Configuration options for ``Updater`` class."""
 
+from __future__ import annotations
+
 from dataclasses import dataclass
 from enum import Flag, unique
-from typing import Optional
 
 
 @unique
@@ -52,4 +53,4 @@ class UpdaterConfig:
     targets_max_length: int = 5000000  # bytes
     prefix_targets_with_hash: bool = True
     envelope_type: EnvelopeType = EnvelopeType.METADATA
-    app_user_agent: Optional[str] = None
+    app_user_agent: str | None = None