Guard Type Hint Imports Used Only Inside Annotations

docs/html/conf.py

@@ -1,4 +1,5 @@
 """Sphinx configuration file for pip's documentation."""
+from __future__ import annotations
 
 import glob
 import os

docs/pip_sphinxext.py

@@ -1,21 +1,24 @@
 """pip sphinx extensions"""
+from __future__ import annotations
 
 import optparse
 import pathlib
 import re
 import sys
 from textwrap import dedent
-from typing import Dict, Iterable, Iterator, List, Optional, Union
+from typing import TYPE_CHECKING, Dict, Iterable, Iterator, List, Optional, Union
 
 from docutils import nodes, statemachine
 from docutils.parsers import rst
 from docutils.statemachine import StringList, ViewList
-from sphinx.application import Sphinx
 
 from pip._internal.cli import cmdoptions
 from pip._internal.commands import commands_dict, create_command
 from pip._internal.req.req_file import SUPPORTED_OPTIONS
 
+if TYPE_CHECKING:
+    from sphinx.application import Sphinx
+
 
 class PipNewsInclude(rst.Directive):
     required_arguments = 1

news/12488.feature.rst

@@ -0,0 +1 @@
+No longer import type hint only objects at runtime

noxfile.py

@@ -1,5 +1,6 @@
 """Automation using nox.
 """
+from __future__ import annotations
 
 import argparse
 import glob

pyproject.toml

@@ -168,13 +168,15 @@ select = [
     "W",
     "RUF100",
     "UP032",
+    "TCH",
 ]
 
 [tool.ruff.isort]
 # We need to explicitly make pip "first party" as it's imported by code in
 # the docs and tests directories.
 known-first-party = ["pip"]
 known-third-party = ["pip._vendor"]
+required-imports = ["from __future__ import annotations"]
 
 [tool.ruff.mccabe]
 max-complexity = 33  # default is 10

setup.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import sys
 
 from setuptools import setup

src/pip/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import List, Optional
 
 __version__ = "24.0.dev0"

src/pip/__main__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os
 import sys
 

src/pip/__pip-runner__.py

@@ -5,6 +5,7 @@
 """
 
 # /!\ This version compatibility check section must be Python 2 compatible. /!\
+from __future__ import annotations
 
 import sys
 

src/pip/_internal/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import List, Optional
 
 from pip._internal.utils import _log

src/pip/_internal/build_env.py

@@ -1,5 +1,6 @@
 """Build Environment used for isolation during sdist building
 """
+from __future__ import annotations
 
 import logging
 import os
@@ -8,7 +9,6 @@
 import sys
 import textwrap
 from collections import OrderedDict
-from types import TracebackType
 from typing import TYPE_CHECKING, Iterable, List, Optional, Set, Tuple, Type, Union
 
 from pip._vendor.certifi import where
@@ -23,6 +23,8 @@
 from pip._internal.utils.temp_dir import TempDirectory, tempdir_kinds
 
 if TYPE_CHECKING:
+    from types import TracebackType
+
     from pip._internal.index.package_finder import PackageFinder
 
 logger = logging.getLogger(__name__)

src/pip/_internal/cache.py

@@ -1,5 +1,6 @@
 """Cache Management
 """
+from __future__ import annotations
 
 import hashlib
 import json

src/pip/_internal/cli/autocompletion.py

@@ -1,5 +1,6 @@
 """Logic that powers autocompletion installed by ``pip completion``.
 """
+from __future__ import annotations
 
 import optparse
 import os

src/pip/_internal/cli/base_command.py

@@ -1,4 +1,5 @@
 """Base Command class, and related routines"""
+from __future__ import annotations
 
 import functools
 import logging

src/pip/_internal/cli/cmdoptions.py

@@ -9,6 +9,7 @@
 
 # The following comment should be removed at some point in the future.
 # mypy: strict-optional=False
+from __future__ import annotations
 
 import importlib.util
 import logging
@@ -17,11 +18,10 @@
 from functools import partial
 from optparse import SUPPRESS_HELP, Option, OptionGroup, OptionParser, Values
 from textwrap import dedent
-from typing import Any, Callable, Dict, Optional, Tuple
+from typing import TYPE_CHECKING, Any, Callable, Dict, Optional, Tuple
 
 from pip._vendor.packaging.utils import canonicalize_name
 
-from pip._internal.cli.parser import ConfigOptionParser
 from pip._internal.exceptions import CommandError
 from pip._internal.locations import USER_CACHE_DIR, get_src_prefix
 from pip._internal.models.format_control import FormatControl
@@ -30,6 +30,9 @@
 from pip._internal.utils.hashes import STRONG_HASHES
 from pip._internal.utils.misc import strtobool
 
+if TYPE_CHECKING:
+    from pip._internal.cli.parser import ConfigOptionParser
+
 logger = logging.getLogger(__name__)
 
 

src/pip/_internal/cli/command_context.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from contextlib import ExitStack, contextmanager
 from typing import ContextManager, Generator, TypeVar
 

src/pip/_internal/cli/main.py

@@ -1,5 +1,7 @@
 """Primary application entrypoint.
 """
+from __future__ import annotations
+
 import locale
 import logging
 import os

src/pip/_internal/cli/main_parser.py

@@ -1,5 +1,6 @@
 """A single place for constructing and exposing the main parser
 """
+from __future__ import annotations
 
 import os
 import subprocess

src/pip/_internal/cli/parser.py

@@ -1,4 +1,5 @@
 """Base option parser setup"""
+from __future__ import annotations
 
 import logging
 import optparse

src/pip/_internal/cli/progress_bars.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import functools
 from typing import Callable, Generator, Iterable, Iterator, Optional, Tuple
 

src/pip/_internal/cli/req_command.py

@@ -4,25 +4,22 @@
 needing download / PackageFinder capability don't unnecessarily import the
 PackageFinder machinery and all its vendored dependencies, etc.
 """
+from __future__ import annotations
 
 import logging
 import os
 import sys
 from functools import partial
-from optparse import Values
 from typing import TYPE_CHECKING, Any, List, Optional, Tuple
 
-from pip._internal.cache import WheelCache
 from pip._internal.cli import cmdoptions
 from pip._internal.cli.base_command import Command
 from pip._internal.cli.command_context import CommandContextMixIn
 from pip._internal.exceptions import CommandError, PreviousBuildDirError
 from pip._internal.index.collector import LinkCollector
 from pip._internal.index.package_finder import PackageFinder
 from pip._internal.models.selection_prefs import SelectionPreferences
-from pip._internal.models.target_python import TargetPython
 from pip._internal.network.session import PipSession
-from pip._internal.operations.build.build_tracker import BuildTracker
 from pip._internal.operations.prepare import RequirementPreparer
 from pip._internal.req.constructors import (
     install_req_from_editable,
@@ -31,8 +28,6 @@
     install_req_from_req_string,
 )
 from pip._internal.req.req_file import parse_requirements
-from pip._internal.req.req_install import InstallRequirement
-from pip._internal.resolution.base import BaseResolver
 from pip._internal.self_outdated_check import pip_self_version_check
 from pip._internal.utils.temp_dir import (
     TempDirectory,
@@ -42,8 +37,15 @@
 from pip._internal.utils.virtualenv import running_under_virtualenv
 
 if TYPE_CHECKING:
+    from optparse import Values
     from ssl import SSLContext
 
+    from pip._internal.cache import WheelCache
+    from pip._internal.models.target_python import TargetPython
+    from pip._internal.operations.build.build_tracker import BuildTracker
+    from pip._internal.req.req_install import InstallRequirement
+    from pip._internal.resolution.base import BaseResolver
+
 logger = logging.getLogger(__name__)
 
 

src/pip/_internal/cli/spinners.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import contextlib
 import itertools
 import logging

src/pip/_internal/cli/status_codes.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 SUCCESS = 0
 ERROR = 1
 UNKNOWN_ERROR = 2

src/pip/_internal/commands/__init__.py

@@ -1,12 +1,14 @@
 """
 Package containing all pip commands
 """
+from __future__ import annotations
 
 import importlib
 from collections import namedtuple
-from typing import Any, Dict, Optional
+from typing import TYPE_CHECKING, Any, Dict, Optional
 
-from pip._internal.cli.base_command import Command
+if TYPE_CHECKING:
+    from pip._internal.cli.base_command import Command
 
 CommandInfo = namedtuple("CommandInfo", "module_path, class_name, summary")
 

src/pip/_internal/commands/cache.py

@@ -1,14 +1,18 @@
+from __future__ import annotations
+
 import os
 import textwrap
-from optparse import Values
-from typing import Any, List
+from typing import TYPE_CHECKING, Any, List
 
 from pip._internal.cli.base_command import Command
 from pip._internal.cli.status_codes import ERROR, SUCCESS
 from pip._internal.exceptions import CommandError, PipError
 from pip._internal.utils import filesystem
 from pip._internal.utils.logging import getLogger
 
+if TYPE_CHECKING:
+    from optparse import Values
+
 logger = getLogger(__name__)
 
 

src/pip/_internal/commands/check.py

@@ -1,6 +1,7 @@
+from __future__ import annotations
+
 import logging
-from optparse import Values
-from typing import List
+from typing import TYPE_CHECKING, List
 
 from pip._internal.cli.base_command import Command
 from pip._internal.cli.status_codes import ERROR, SUCCESS
@@ -11,6 +12,9 @@
 )
 from pip._internal.utils.misc import write_output
 
+if TYPE_CHECKING:
+    from optparse import Values
+
 logger = logging.getLogger(__name__)
 
 

src/pip/_internal/commands/completion.py

@@ -1,12 +1,16 @@
+from __future__ import annotations
+
 import sys
 import textwrap
-from optparse import Values
-from typing import List
+from typing import TYPE_CHECKING, List
 
 from pip._internal.cli.base_command import Command
 from pip._internal.cli.status_codes import SUCCESS
 from pip._internal.utils.misc import get_prog
 
+if TYPE_CHECKING:
+    from optparse import Values
+
 BASE_COMPLETION = """
 # pip {shell} completion start{script}# pip {shell} completion end
 """

src/pip/_internal/commands/configuration.py

@@ -1,8 +1,9 @@
+from __future__ import annotations
+
 import logging
 import os
 import subprocess
-from optparse import Values
-from typing import Any, List, Optional
+from typing import TYPE_CHECKING, Any, List, Optional
 
 from pip._internal.cli.base_command import Command
 from pip._internal.cli.status_codes import ERROR, SUCCESS
@@ -16,6 +17,9 @@
 from pip._internal.utils.logging import indent_log
 from pip._internal.utils.misc import get_prog, write_output
 
+if TYPE_CHECKING:
+    from optparse import Values
+
 logger = logging.getLogger(__name__)
 
 

src/pip/_internal/commands/debug.py

@@ -1,11 +1,11 @@
+from __future__ import annotations
+
 import importlib.resources
 import locale
 import logging
 import os
 import sys
-from optparse import Values
-from types import ModuleType
-from typing import Any, Dict, List, Optional
+from typing import TYPE_CHECKING, Any, Dict, List, Optional
 
 import pip._vendor
 from pip._vendor.certifi import where
@@ -15,11 +15,16 @@
 from pip._internal.cli.base_command import Command
 from pip._internal.cli.cmdoptions import make_target_python
 from pip._internal.cli.status_codes import SUCCESS
-from pip._internal.configuration import Configuration
 from pip._internal.metadata import get_environment
 from pip._internal.utils.logging import indent_log
 from pip._internal.utils.misc import get_pip_version
 
+if TYPE_CHECKING:
+    from optparse import Values
+    from types import ModuleType
+
+    from pip._internal.configuration import Configuration
+
 logger = logging.getLogger(__name__)