Enforce modern annotations syntax (#4368)

Author: Avasam

pkg_resources/__init__.py

@@ -1,8 +1,9 @@
+from __future__ import annotations
 from importlib.machinery import ModuleSpec
 import importlib.util
 import sys
 from types import ModuleType
-from typing import Iterable, Optional, Sequence
+from typing import Iterable, Sequence
 
 
 class VendorImporter:
@@ -15,7 +16,7 @@ def __init__(
         self,
         root_name: str,
         vendored_names: Iterable[str] = (),
-        vendor_pkg: Optional[str] = None,
+        vendor_pkg: str | None = None,
     ):
         self.root_name = root_name
         self.vendored_names = set(vendored_names)
@@ -65,8 +66,8 @@ def exec_module(self, module: ModuleType):
     def find_spec(
         self,
         fullname: str,
-        path: Optional[Sequence[str]] = None,
-        target: Optional[ModuleType] = None,
+        path: Sequence[str] | None = None,
+        target: ModuleType | None = None,
     ):
         """Return a module spec for vendored names."""
         return (

pkg_resources/extern/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import builtins
 import sys
 import tempfile
@@ -9,7 +11,6 @@
 import stat
 import distutils.dist
 import distutils.command.install_egg_info
-from typing import List
 
 from unittest import mock
 
@@ -33,7 +34,7 @@ def __call__(self):
 
 
 class TestZipProvider:
-    finalizers: List[EggRemover] = []
+    finalizers: list[EggRemover] = []
 
     ref_time = datetime.datetime(2013, 5, 12, 13, 25, 0)
     "A reference time for a file modification"

pkg_resources/tests/test_pkg_resources.py

@@ -40,7 +40,7 @@ testing = [
 	"pytest-mypy",
 	"pytest-enabler >= 2.2",
 	# workaround for pypa/setuptools#3921
-	'pytest-ruff >= 0.2.1; sys_platform != "cygwin"',
+	'pytest-ruff >= 0.3.2; sys_platform != "cygwin"',
 
 	# local
 	"virtualenv>=13.0.0",

pyproject.toml

@@ -4,10 +4,18 @@ extend-select = [
 	"W",
 
 	# local
-	"UP",  # pyupgrade
-	"YTT",  # flake8-2020
+	"FA", # flake8-future-annotations
+	"F404", # late-future-import
+	"UP", # pyupgrade
+	"YTT", # flake8-2020
 ]
 ignore = [
+	"UP015", # redundant-open-modes, explicit is preferred
+	"UP030", # temporarily disabled
+	"UP031", # temporarily disabled
+	"UP032", # temporarily disabled
+	"UP038", # Using `X | Y` in `isinstance` call is slower and more verbose https://github.com/astral-sh/ruff/issues/7871
+
 	# https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
 	"W191",
 	"E111",
@@ -24,19 +32,16 @@ ignore = [
 	"ISC001",
 	"ISC002",
 ]
-extend-ignore = [
-	"UP015",  # redundant-open-modes, explicit is preferred
-	"UP030",  # temporarily disabled
-	"UP031",  # temporarily disabled
-	"UP032",  # temporarily disabled
-	"UP036",  # temporarily disabled
-]
 exclude = [
 	"**/_vendor",
 	"setuptools/_distutils",
 	"setuptools/config/_validate_pyproject",
 ]
 
+[lint.per-file-ignores]
+# Auto-generated code
+"setuptools/config/_validate_pyproject/*" = ["FA100"]
+
 [format]
 exclude = [
 	"**/_vendor",

ruff.toml

@@ -4,13 +4,14 @@
 See: https://packaging.python.org/en/latest/specifications/core-metadata/
 """
 
+from __future__ import annotations
+
 import os
 import stat
 import textwrap
 from email import message_from_file
 from email.message import Message
 from tempfile import NamedTemporaryFile
-from typing import Optional, List
 
 from distutils.util import rfc822_escape
 
@@ -38,31 +39,31 @@ def rfc822_unescape(content: str) -> str:
     return '\n'.join((lines[0].lstrip(), textwrap.dedent('\n'.join(lines[1:]))))
 
 
-def _read_field_from_msg(msg: Message, field: str) -> Optional[str]:
+def _read_field_from_msg(msg: Message, field: str) -> str | None:
     """Read Message header field."""
     value = msg[field]
     if value == 'UNKNOWN':
         return None
     return value
 
 
-def _read_field_unescaped_from_msg(msg: Message, field: str) -> Optional[str]:
+def _read_field_unescaped_from_msg(msg: Message, field: str) -> str | None:
     """Read Message header field and apply rfc822_unescape."""
     value = _read_field_from_msg(msg, field)
     if value is None:
         return value
     return rfc822_unescape(value)
 
 
-def _read_list_from_msg(msg: Message, field: str) -> Optional[List[str]]:
+def _read_list_from_msg(msg: Message, field: str) -> list[str] | None:
     """Read Message header field and return all results as list."""
     values = msg.get_all(field, None)
     if values == []:
         return None
     return values
 
 
-def _read_payload_from_msg(msg: Message) -> Optional[str]:
+def _read_payload_from_msg(msg: Message) -> str | None:
     value = str(msg.get_payload()).strip()
     if value == 'UNKNOWN' or not value:
         return None

setuptools/_core_metadata.py

@@ -26,6 +26,8 @@
 Again, this is not a formal definition! Just a "taste" of the module.
 """
 
+from __future__ import annotations
+
 import io
 import os
 import shlex
@@ -36,7 +38,7 @@
 import tempfile
 import warnings
 from pathlib import Path
-from typing import Dict, Iterator, List, Optional, Tuple, Union, Iterable
+from typing import Dict, Iterator, List, Optional, Union, Iterable
 
 import setuptools
 import distutils
@@ -113,7 +115,7 @@ def _get_immediate_subdirectories(a_dir):
     ]
 
 
-def _file_with_extension(directory: StrPath, extension: Union[str, Tuple[str, ...]]):
+def _file_with_extension(directory: StrPath, extension: str | tuple[str, ...]):
     matching = (f for f in os.listdir(directory) if f.endswith(extension))
     try:
         (file,) = matching
@@ -163,7 +165,7 @@ class _ConfigSettingsTranslator:
 
     # See pypa/setuptools#1928 pypa/setuptools#2491
 
-    def _get_config(self, key: str, config_settings: _ConfigSettings) -> List[str]:
+    def _get_config(self, key: str, config_settings: _ConfigSettings) -> list[str]:
         """
         Get the value of a specific key in ``config_settings`` as a list of strings.
 
@@ -371,7 +373,7 @@ def prepare_metadata_for_build_wheel(
     def _build_with_temp_dir(
         self,
         setup_command: Iterable[str],
-        result_extension: Union[str, Tuple[str, ...]],
+        result_extension: str | tuple[str, ...],
         result_directory: StrPath,
         config_settings: _ConfigSettings,
         arbitrary_args: Iterable[str] = (),
@@ -407,7 +409,7 @@ def build_wheel(
         self,
         wheel_directory: StrPath,
         config_settings: _ConfigSettings = None,
-        metadata_directory: Optional[StrPath] = None,
+        metadata_directory: StrPath | None = None,
     ):
         with suppress_known_deprecation():
             return self._build_with_temp_dir(
@@ -425,9 +427,7 @@ def build_sdist(
             ['sdist', '--formats', 'gztar'], '.tar.gz', sdist_directory, config_settings
         )
 
-    def _get_dist_info_dir(
-        self, metadata_directory: Optional[StrPath]
-    ) -> Optional[str]:
+    def _get_dist_info_dir(self, metadata_directory: StrPath | None) -> str | None:
         if not metadata_directory:
             return None
         dist_info_candidates = list(Path(metadata_directory).glob("*.dist-info"))
@@ -443,7 +443,7 @@ def build_editable(
             self,
             wheel_directory: StrPath,
             config_settings: _ConfigSettings = None,
-            metadata_directory: Optional[str] = None,
+            metadata_directory: str | None = None,
         ):
             # XXX can or should we hide our editable_wheel command normally?
             info_dir = self._get_dist_info_dir(metadata_directory)

setuptools/build_meta.py

@@ -7,10 +7,12 @@
 See https://setuptools.pypa.io/en/latest/deprecated/python_eggs.html#requires-txt
 """
 
+from __future__ import annotations
+
 import io
 from collections import defaultdict
 from itertools import filterfalse
-from typing import Dict, List, Tuple, Mapping, TypeVar
+from typing import Dict, Mapping, TypeVar
 
 from .. import _reqs
 from ..extern.jaraco.text import yield_lines
@@ -26,7 +28,7 @@
 
 def _prepare(
     install_requires: _StrOrIter, extras_require: Mapping[str, _StrOrIter]
-) -> Tuple[List[str], Dict[str, List[str]]]:
+) -> tuple[list[str], dict[str, list[str]]]:
     """Given values for ``install_requires`` and ``extras_require``
     create modified versions in a way that can be written in ``requires.txt``
     """
@@ -54,7 +56,7 @@ def _convert_extras_requirements(
 
 def _move_install_requirements_markers(
     install_requires: _StrOrIter, extras_require: Mapping[str, _Ordered[Requirement]]
-) -> Tuple[List[str], Dict[str, List[str]]]:
+) -> tuple[list[str], dict[str, list[str]]]:
     """
     The ``requires.txt`` file has an specific format:
         - Environment markers need to be part of the section headers and

setuptools/command/_requirestxt.py

@@ -1,4 +1,6 @@
-from typing import Dict, List, Protocol
+from __future__ import annotations
+
+from typing import Protocol
 from distutils.command.build import build as _build
 
 _ORIGINAL_SUBCOMMANDS = {"build_py", "build_clib", "build_ext", "build_scripts"}
@@ -87,7 +89,7 @@ def finalize_options(self):
     def run(self):
         """(Required by the original :class:`setuptools.Command` interface)"""
 
-    def get_source_files(self) -> List[str]:
+    def get_source_files(self) -> list[str]:
         """
         Return a list of all files that are used by the command to create the expected
         outputs.
@@ -98,7 +100,7 @@ def get_source_files(self) -> List[str]:
         All files should be strings relative to the project root directory.
         """
 
-    def get_outputs(self) -> List[str]:
+    def get_outputs(self) -> list[str]:
         """
         Return a list of files intended for distribution as they would have been
         produced by the build.
@@ -111,7 +113,7 @@ def get_outputs(self) -> List[str]:
            and don't correspond to any source file already present in the project.
         """
 
-    def get_output_mapping(self) -> Dict[str, str]:
+    def get_output_mapping(self) -> dict[str, str]:
         """
         Return a mapping between destination files as they would be produced by the
         build (dict keys) into the respective existing (source) files (dict values).

setuptools/command/build.py

@@ -1,9 +1,11 @@
+from __future__ import annotations
+
 import os
 import sys
 import itertools
 from importlib.machinery import EXTENSION_SUFFIXES
 from importlib.util import cache_from_source as _compiled_file_name
-from typing import Dict, Iterator, List, Tuple
+from typing import Iterator
 from pathlib import Path
 
 from distutils.command.build_ext import build_ext as _du_build_ext
@@ -93,7 +95,7 @@ def run(self):
         if old_inplace:
             self.copy_extensions_to_source()
 
-    def _get_inplace_equivalent(self, build_py, ext: Extension) -> Tuple[str, str]:
+    def _get_inplace_equivalent(self, build_py, ext: Extension) -> tuple[str, str]:
         fullname = self.get_ext_fullname(ext.name)
         filename = self.get_ext_filename(fullname)
         modpath = fullname.split('.')
@@ -125,7 +127,7 @@ def _get_equivalent_stub(self, ext: Extension, output_file: str) -> str:
         _, _, name = ext.name.rpartition(".")
         return f"{os.path.join(dir_, name)}.py"
 
-    def _get_output_mapping(self) -> Iterator[Tuple[str, str]]:
+    def _get_output_mapping(self) -> Iterator[tuple[str, str]]:
         if not self.inplace:
             return
 
@@ -265,7 +267,7 @@ def links_to_dynamic(self, ext):
         pkg = '.'.join(ext._full_name.split('.')[:-1] + [''])
         return any(pkg + libname in libnames for libname in ext.libraries)
 
-    def get_source_files(self) -> List[str]:
+    def get_source_files(self) -> list[str]:
         return [*_build_ext.get_source_files(self), *self._get_internal_depends()]
 
     def _get_internal_depends(self) -> Iterator[str]:
@@ -306,12 +308,12 @@ def skip(orig_path: str, reason: str) -> None:
 
             yield path.as_posix()
 
-    def get_outputs(self) -> List[str]:
+    def get_outputs(self) -> list[str]:
         if self.inplace:
             return list(self.get_output_mapping().keys())
         return sorted(_build_ext.get_outputs(self) + self.__get_stubs_outputs())
 
-    def get_output_mapping(self) -> Dict[str, str]:
+    def get_output_mapping(self) -> dict[str, str]:
         """See :class:`setuptools.commands.build.SubCommand`"""
         mapping = self._get_output_mapping()
         return dict(sorted(mapping, key=lambda x: x[0]))