Replace Iterator[T] with Generator[T,None, None] (#11007)

Co-authored-by: Tzu-ping Chung <[email protected]>

Author: q0w

news/20ef81f6-dfa6-453a-a23a-74b0de4c2f88.trivial.rst

@@ -0,0 +1 @@
+Replace ``Iterator[T]`` with ``Generator[T, None, None]``.

src/pip/_internal/build_env.py

@@ -11,7 +11,7 @@
 from collections import OrderedDict
 from sysconfig import get_paths
 from types import TracebackType
-from typing import TYPE_CHECKING, Iterable, Iterator, List, Optional, Set, Tuple, Type
+from typing import TYPE_CHECKING, Generator, Iterable, List, Optional, Set, Tuple, Type
 
 from pip._vendor.certifi import where
 from pip._vendor.packaging.requirements import Requirement
@@ -42,7 +42,7 @@ def __init__(self, path: str) -> None:
 
 
 @contextlib.contextmanager
-def _create_standalone_pip() -> Iterator[str]:
+def _create_standalone_pip() -> Generator[str, None, None]:
     """Create a "standalone pip" zip file.
 
     The zip file's content is identical to the currently-running pip.

src/pip/_internal/cli/command_context.py

@@ -1,5 +1,5 @@
 from contextlib import ExitStack, contextmanager
-from typing import ContextManager, Iterator, TypeVar
+from typing import ContextManager, Generator, TypeVar
 
 _T = TypeVar("_T", covariant=True)
 
@@ -11,7 +11,7 @@ def __init__(self) -> None:
         self._main_context = ExitStack()
 
     @contextmanager
-    def main_context(self) -> Iterator[None]:
+    def main_context(self) -> Generator[None, None, None]:
         assert not self._in_main_context
 
         self._in_main_context = True

src/pip/_internal/cli/parser.py

@@ -6,7 +6,7 @@
 import sys
 import textwrap
 from contextlib import suppress
-from typing import Any, Dict, Iterator, List, Tuple
+from typing import Any, Dict, Generator, List, Tuple
 
 from pip._internal.cli.status_codes import UNKNOWN_ERROR
 from pip._internal.configuration import Configuration, ConfigurationError
@@ -175,7 +175,9 @@ def check_default(self, option: optparse.Option, key: str, val: Any) -> Any:
             print(f"An error occurred during configuration: {exc}")
             sys.exit(3)
 
-    def _get_ordered_configuration_items(self) -> Iterator[Tuple[str, Any]]:
+    def _get_ordered_configuration_items(
+        self,
+    ) -> Generator[Tuple[str, Any], None, None]:
         # Configuration gives keys in an unordered manner. Order them.
         override_order = ["global", self.name, ":env:"]
 

src/pip/_internal/cli/progress_bars.py

@@ -1,5 +1,5 @@
 import functools
-from typing import Callable, Iterator, Optional, Tuple
+from typing import Callable, Generator, Iterable, Iterator, Optional, Tuple
 
 from pip._vendor.rich.progress import (
     BarColumn,
@@ -16,15 +16,15 @@
 
 from pip._internal.utils.logging import get_indentation
 
-DownloadProgressRenderer = Callable[[Iterator[bytes]], Iterator[bytes]]
+DownloadProgressRenderer = Callable[[Iterable[bytes]], Iterator[bytes]]
 
 
 def _rich_progress_bar(
-    iterable: Iterator[bytes],
+    iterable: Iterable[bytes],
     *,
     bar_type: str,
     size: int,
-) -> Iterator[bytes]:
+) -> Generator[bytes, None, None]:
     assert bar_type == "on", "This should only be used in the default mode."
 
     if not size:

src/pip/_internal/cli/spinners.py

@@ -3,7 +3,7 @@
 import logging
 import sys
 import time
-from typing import IO, Iterator
+from typing import IO, Generator
 
 from pip._internal.utils.compat import WINDOWS
 from pip._internal.utils.logging import get_indentation
@@ -113,7 +113,7 @@ def reset(self) -> None:
 
 
 @contextlib.contextmanager
-def open_spinner(message: str) -> Iterator[SpinnerInterface]:
+def open_spinner(message: str) -> Generator[SpinnerInterface, None, None]:
     # Interactive spinner goes directly to sys.stdout rather than being routed
     # through the logging system, but it acts like it has level INFO,
     # i.e. it's only displayed if we're at level INFO or better.
@@ -141,7 +141,7 @@ def open_spinner(message: str) -> Iterator[SpinnerInterface]:
 
 
 @contextlib.contextmanager
-def hidden_cursor(file: IO[str]) -> Iterator[None]:
+def hidden_cursor(file: IO[str]) -> Generator[None, None, None]:
     # The Windows terminal does not support the hide/show cursor ANSI codes,
     # even via colorama. So don't even try.
     if WINDOWS:

src/pip/_internal/commands/list.py

@@ -1,7 +1,7 @@
 import json
 import logging
 from optparse import Values
-from typing import TYPE_CHECKING, Iterator, List, Optional, Sequence, Tuple, cast
+from typing import TYPE_CHECKING, Generator, List, Optional, Sequence, Tuple, cast
 
 from pip._vendor.packaging.utils import canonicalize_name
 
@@ -222,7 +222,7 @@ def get_not_required(
 
     def iter_packages_latest_infos(
         self, packages: "_ProcessedDists", options: Values
-    ) -> Iterator["_DistWithLatestInfo"]:
+    ) -> Generator["_DistWithLatestInfo", None, None]:
         with self._build_session(options) as session:
             finder = self._build_package_finder(options, session)
 

src/pip/_internal/commands/show.py

@@ -1,6 +1,6 @@
 import logging
 from optparse import Values
-from typing import Iterator, List, NamedTuple, Optional
+from typing import Generator, Iterable, Iterator, List, NamedTuple, Optional
 
 from pip._vendor.packaging.utils import canonicalize_name
 
@@ -67,7 +67,7 @@ class _PackageInfo(NamedTuple):
     files: Optional[List[str]]
 
 
-def search_packages_info(query: List[str]) -> Iterator[_PackageInfo]:
+def search_packages_info(query: List[str]) -> Generator[_PackageInfo, None, None]:
     """
     Gather details from installed distributions. Print distribution name,
     version, location, and installed files. Installed files requires a
@@ -135,7 +135,7 @@ def _get_requiring_packages(current_dist: BaseDistribution) -> Iterator[str]:
 
 
 def print_results(
-    distributions: Iterator[_PackageInfo],
+    distributions: Iterable[_PackageInfo],
     list_files: bool,
     verbose: bool,
 ) -> bool:

src/pip/_internal/locations/__init__.py

@@ -4,7 +4,7 @@
 import pathlib
 import sys
 import sysconfig
-from typing import Any, Dict, Iterator, List, Optional, Tuple
+from typing import Any, Dict, Generator, List, Optional, Tuple
 
 from pip._internal.models.scheme import SCHEME_KEYS, Scheme
 from pip._internal.utils.compat import WINDOWS
@@ -169,7 +169,7 @@ def _looks_like_msys2_mingw_scheme() -> bool:
     )
 
 
-def _fix_abiflags(parts: Tuple[str]) -> Iterator[str]:
+def _fix_abiflags(parts: Tuple[str]) -> Generator[str, None, None]:
     ldversion = sysconfig.get_config_var("LDVERSION")
     abiflags = getattr(sys, "abiflags", None)
 

src/pip/_internal/metadata/base.py

@@ -10,6 +10,7 @@
     TYPE_CHECKING,
     Collection,
     Container,
+    Generator,
     Iterable,
     Iterator,
     List,
@@ -470,7 +471,7 @@ def _iter_distributions(self) -> Iterator["BaseDistribution"]:
         """
         raise NotImplementedError()
 
-    def iter_distributions(self) -> Iterator["BaseDistribution"]:
+    def iter_distributions(self) -> Generator["BaseDistribution", None, None]:
         """Iterate through installed distributions."""
         for dist in self._iter_distributions():
             # Make sure the distribution actually comes from a valid Python