Merge pull request #13371 from pradyunsg/modernise-type-annotations

Enable and enforce modern type annotations across the codebase

Author: pradyunsg

docs/html/conf.py

@@ -5,7 +5,6 @@
 import pathlib
 import re
 import sys
-from typing import List, Tuple
 
 # Add the docs/ directory to sys.path, because pip_sphinxext.py is there.
 docs_dir = os.path.dirname(os.path.dirname(__file__))
@@ -101,7 +100,7 @@
 
 
 # List of manual pages generated
-def determine_man_pages() -> List[Tuple[str, str, str, str, int]]:
+def determine_man_pages() -> list[tuple[str, str, str, str, int]]:
     """Determine which man pages need to be generated."""
 
     def to_document_name(path: str, base_dir: str) -> str:

docs/pip_sphinxext.py

@@ -1,11 +1,13 @@
 """pip sphinx extensions"""
 
+from __future__ import annotations
+
 import optparse
 import pathlib
 import re
 import sys
+from collections.abc import Iterable, Iterator
 from textwrap import dedent
-from typing import Dict, Iterable, Iterator, List, Optional, Union
 
 from docutils import nodes, statemachine
 from docutils.parsers import rst
@@ -24,7 +26,7 @@ def convert_cli_option_to_envvar(opt_name: str) -> str:
     return f"PIP_{normalized_opt_name}"
 
 
-def convert_cli_opt_names_to_envvars(original_cli_opt_names: List[str]) -> List[str]:
+def convert_cli_opt_names_to_envvars(original_cli_opt_names: list[str]) -> list[str]:
     return [
         convert_cli_option_to_envvar(opt_name) for opt_name in original_cli_opt_names
     ]
@@ -33,9 +35,7 @@ def convert_cli_opt_names_to_envvars(original_cli_opt_names: List[str]) -> List[
 class PipNewsInclude(rst.Directive):
     required_arguments = 1
 
-    def _is_version_section_title_underline(
-        self, prev: Optional[str], curr: str
-    ) -> bool:
+    def _is_version_section_title_underline(self, prev: str | None, curr: str) -> bool:
         """Find a ==== line that marks the version section title."""
         if prev is None:
             return False
@@ -69,7 +69,7 @@ def _iter_lines_with_refs(self, lines: Iterable[str]) -> Iterator[str]:
         if prev is not None:
             yield prev
 
-    def run(self) -> List[nodes.Node]:
+    def run(self) -> list[nodes.Node]:
         source = self.state_machine.input_lines.source(
             self.lineno - self.state_machine.input_offset - 1,
         )
@@ -90,7 +90,7 @@ class PipCommandUsage(rst.Directive):
     required_arguments = 1
     optional_arguments = 3
 
-    def run(self) -> List[nodes.Node]:
+    def run(self) -> list[nodes.Node]:
         cmd = create_command(self.arguments[0])
         cmd_prefix = "python -m pip"
         if len(self.arguments) > 1:
@@ -105,7 +105,7 @@ def run(self) -> List[nodes.Node]:
 class PipCommandDescription(rst.Directive):
     required_arguments = 1
 
-    def run(self) -> List[nodes.Node]:
+    def run(self) -> list[nodes.Node]:
         node = nodes.paragraph()
         node.document = self.state.document
         desc = ViewList()
@@ -120,8 +120,8 @@ def run(self) -> List[nodes.Node]:
 
 class PipOptions(rst.Directive):
     def _format_option(
-        self, option: optparse.Option, cmd_name: Optional[str] = None
-    ) -> List[str]:
+        self, option: optparse.Option, cmd_name: str | None = None
+    ) -> list[str]:
         bookmark_line = (
             f".. _`{cmd_name}_{option._long_opts[0]}`:"
             if cmd_name
@@ -157,15 +157,15 @@ def _format_option(
         ]
 
     def _format_options(
-        self, options: Iterable[optparse.Option], cmd_name: Optional[str] = None
+        self, options: Iterable[optparse.Option], cmd_name: str | None = None
     ) -> None:
         for option in options:
             if option.help == optparse.SUPPRESS_HELP:
                 continue
             for line in self._format_option(option, cmd_name):
                 self.view_list.append(line, "")
 
-    def run(self) -> List[nodes.Node]:
+    def run(self) -> list[nodes.Node]:
         node = nodes.paragraph()
         node.document = self.state.document
         self.view_list = ViewList()
@@ -242,7 +242,7 @@ class PipCLIDirective(rst.Directive):
     has_content = True
     optional_arguments = 1
 
-    def run(self) -> List[nodes.Node]:
+    def run(self) -> list[nodes.Node]:
         node = nodes.paragraph()
         node.document = self.state.document
 
@@ -310,7 +310,7 @@ def run(self) -> List[nodes.Node]:
         return [node]
 
 
-def setup(app: Sphinx) -> Dict[str, Union[bool, str]]:
+def setup(app: Sphinx) -> dict[str, bool | str]:
     app.add_directive("pip-command-usage", PipCommandUsage)
     app.add_directive("pip-command-description", PipCommandDescription)
     app.add_directive("pip-command-options", PipCommandOptions)

noxfile.py

@@ -5,8 +5,8 @@
 import os
 import shutil
 import sys
+from collections.abc import Iterator
 from pathlib import Path
-from typing import Iterator, List, Tuple
 
 import nox
 
@@ -136,7 +136,7 @@ def test(session: nox.Session) -> None:
 def docs(session: nox.Session) -> None:
     session.install("-r", REQUIREMENTS["docs"])
 
-    def get_sphinx_build_command(kind: str) -> List[str]:
+    def get_sphinx_build_command(kind: str) -> list[str]:
         # Having the conf.py in the docs/html is weird but needed because we
         # can not use a different configuration directory vs source directory
         # on RTD currently. So, we'll pass "-c docs/html" here.
@@ -214,7 +214,7 @@ def vendoring(session: nox.Session) -> None:
         session.run("vendoring", "sync", "-v")
         return
 
-    def pinned_requirements(path: Path) -> Iterator[Tuple[str, str]]:
+    def pinned_requirements(path: Path) -> Iterator[tuple[str, str]]:
         for line in path.read_text().splitlines(keepends=False):
             one, sep, two = line.partition("==")
             if not sep:
@@ -357,7 +357,7 @@ def build_release(session: nox.Session) -> None:
             shutil.copy(dist, final)
 
 
-def build_dists(session: nox.Session) -> List[str]:
+def build_dists(session: nox.Session) -> list[str]:
     """Return dists with valid metadata."""
     session.log(
         "# Check if there's any Git-untracked files before building the wheel",

pyproject.toml

@@ -154,7 +154,7 @@ distlib = "https://bitbucket.org/pypa/distlib/raw/master/LICENSE.txt"
 
 [tool.ruff]
 # Pinned to delay pyupgrade changes (https://github.com/pypa/pip/issues/13236)
-target-version = "py38"  # Pin Ruff to Python 3.8
+target-version = "py39"  # Pin Ruff to Python 3.9
 src = ["src"]
 line-length = 88
 extend-exclude = [
@@ -187,7 +187,7 @@ select = [
     "W",
     "RUF100",
     "UP",
-    "FA102",  # future-required-type-annotation
+    "FA",
 ]
 
 [tool.ruff.lint.isort]

src/pip/__init__.py

@@ -1,9 +1,9 @@
-from typing import List, Optional
+from __future__ import annotations
 
 __version__ = "25.2.dev0"
 
 
-def main(args: Optional[List[str]] = None) -> int:
+def main(args: list[str] | None = None) -> int:
     """This is an internal API only meant for use by pip's own console scripts.
 
     For additional details, see https://github.com/pypa/pip/issues/7498.

src/pip/_internal/__init__.py

@@ -1,4 +1,4 @@
-from typing import List, Optional
+from __future__ import annotations
 
 from pip._internal.utils import _log
 
@@ -7,7 +7,7 @@
 _log.init_logging()
 
 
-def main(args: Optional[List[str]] = None) -> int:
+def main(args: list[str] | None = None) -> int:
     """This is preserved for old console scripts that may still be referencing
     it.
 

src/pip/_internal/build_env.py

@@ -1,14 +1,17 @@
 """Build Environment used for isolation during sdist building"""
 
+from __future__ import annotations
+
 import logging
 import os
 import pathlib
 import site
 import sys
 import textwrap
 from collections import OrderedDict
+from collections.abc import Iterable
 from types import TracebackType
-from typing import TYPE_CHECKING, Iterable, List, Optional, Set, Tuple, Type, Union
+from typing import TYPE_CHECKING
 
 from pip._vendor.packaging.version import Version
 
@@ -27,7 +30,7 @@
 logger = logging.getLogger(__name__)
 
 
-def _dedup(a: str, b: str) -> Union[Tuple[str], Tuple[str, str]]:
+def _dedup(a: str, b: str) -> tuple[str] | tuple[str, str]:
     return (a, b) if a != b else (a,)
 
 
@@ -56,7 +59,7 @@ def get_runnable_pip() -> str:
     return os.fsdecode(source / "__pip-runner__.py")
 
 
-def _get_system_sitepackages() -> Set[str]:
+def _get_system_sitepackages() -> set[str]:
     """Get system site packages
 
     Usually from site.getsitepackages,
@@ -87,8 +90,8 @@ def __init__(self) -> None:
             for name in ("normal", "overlay")
         )
 
-        self._bin_dirs: List[str] = []
-        self._lib_dirs: List[str] = []
+        self._bin_dirs: list[str] = []
+        self._lib_dirs: list[str] = []
         for prefix in reversed(list(self._prefixes.values())):
             self._bin_dirs.append(prefix.bin_dir)
             self._lib_dirs.extend(prefix.lib_dirs)
@@ -156,9 +159,9 @@ def __enter__(self) -> None:
 
     def __exit__(
         self,
-        exc_type: Optional[Type[BaseException]],
-        exc_val: Optional[BaseException],
-        exc_tb: Optional[TracebackType],
+        exc_type: type[BaseException] | None,
+        exc_val: BaseException | None,
+        exc_tb: TracebackType | None,
     ) -> None:
         for varname, old_value in self._save_env.items():
             if old_value is None:
@@ -168,7 +171,7 @@ def __exit__(
 
     def check_requirements(
         self, reqs: Iterable[str]
-    ) -> Tuple[Set[Tuple[str, str]], Set[str]]:
+    ) -> tuple[set[tuple[str, str]], set[str]]:
         """Return 2 sets:
         - conflicting requirements: set of (installed, wanted) reqs tuples
         - missing requirements: set of reqs
@@ -202,7 +205,7 @@ def check_requirements(
 
     def install_requirements(
         self,
-        finder: "PackageFinder",
+        finder: PackageFinder,
         requirements: Iterable[str],
         prefix_as_string: str,
         *,
@@ -224,13 +227,13 @@ def install_requirements(
     @staticmethod
     def _install_requirements(
         pip_runnable: str,
-        finder: "PackageFinder",
+        finder: PackageFinder,
         requirements: Iterable[str],
         prefix: _Prefix,
         *,
         kind: str,
     ) -> None:
-        args: List[str] = [
+        args: list[str] = [
             sys.executable,
             pip_runnable,
             "install",
@@ -305,9 +308,9 @@ def __enter__(self) -> None:
 
     def __exit__(
         self,
-        exc_type: Optional[Type[BaseException]],
-        exc_val: Optional[BaseException],
-        exc_tb: Optional[TracebackType],
+        exc_type: type[BaseException] | None,
+        exc_val: BaseException | None,
+        exc_tb: TracebackType | None,
     ) -> None:
         pass
 
@@ -316,7 +319,7 @@ def cleanup(self) -> None:
 
     def install_requirements(
         self,
-        finder: "PackageFinder",
+        finder: PackageFinder,
         requirements: Iterable[str],
         prefix_as_string: str,
         *,