refactor: generators are Iterable unless they are contextmanagers

Author: nedbat

coverage/bytecode.py

@@ -7,14 +7,13 @@
 
 import collections
 import dis
-from collections.abc import Iterator
 from types import CodeType
 from typing import Iterable, Optional
 
 from coverage.types import TArc, TOffset
 
 
-def code_objects(code: CodeType) -> Iterator[CodeType]:
+def code_objects(code: CodeType) -> Iterable[CodeType]:
     """Iterate over all the code objects in `code`."""
     stack = [code]
     while stack:

coverage/debug.py

@@ -139,7 +139,7 @@ def info_header(label: str) -> str:
     return "--{:-<60s}".format(" " + label + " ")
 
 
-def info_formatter(info: Iterable[tuple[str, Any]]) -> Iterator[str]:
+def info_formatter(info: Iterable[tuple[str, Any]]) -> Iterable[str]:
     """Produce a sequence of formatted lines from info.
 
     `info` is a sequence of pairs (label, data).  The produced lines are

coverage/report_core.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 import sys
-from collections.abc import Iterable, Iterator
+from collections.abc import Iterable
 from typing import IO, TYPE_CHECKING, Callable, Protocol
 
 from coverage.exceptions import NoDataError, NotPython
@@ -71,7 +71,7 @@ def render_report(
 def get_analysis_to_report(
     coverage: Coverage,
     morfs: Iterable[TMorf] | None,
-) -> Iterator[tuple[FileReporter, Analysis]]:
+) -> Iterable[tuple[FileReporter, Analysis]]:
     """Get the files to report on.
 
     For each morf in `morfs`, if it should be reported on (based on the omit

tests/conftest.py

@@ -13,7 +13,7 @@
 import sys
 import warnings
 
-from collections.abc import Iterator
+from collections.abc import Iterable
 
 import pytest
 
@@ -64,15 +64,15 @@ def set_warnings() -> None:
 
 
 @pytest.fixture(autouse=True)
-def reset_sys_path() -> Iterator[None]:
+def reset_sys_path() -> Iterable[None]:
     """Clean up sys.path changes around every test."""
     sys_path = list(sys.path)
     yield
     sys.path[:] = sys_path
 
 
 @pytest.fixture(autouse=True)
-def reset_environment() -> Iterator[None]:
+def reset_environment() -> Iterable[None]:
     """Make sure a test setting an envvar doesn't leak into another test."""
     old_environ = os.environ.copy()
     yield
@@ -96,7 +96,7 @@ def force_local_pyc_files() -> None:
 
 # Give this an underscored name so pylint won't complain when we use the fixture.
 @pytest.fixture(name="_create_pth_file")
-def create_pth_file_fixture() -> Iterator[None]:
+def create_pth_file_fixture() -> Iterable[None]:
     """Create and clean up a .pth file for tests that need it for subprocesses."""
     pth_files = create_pth_files()
     try:

tests/helpers.py

@@ -399,7 +399,7 @@ def get_output(self) -> str:
         return self.io.getvalue()
 
 
-def all_our_source_files() -> Iterator[tuple[Path, str]]:
+def all_our_source_files() -> Iterable[tuple[Path, str]]:
     """Iterate over all of our own source files.
 
     This is used in tests that need a bunch of Python code to analyze, so we

tests/mixins.py

@@ -14,7 +14,7 @@
 import os.path
 import sys
 
-from collections.abc import Iterable, Iterator
+from collections.abc import Iterable
 from typing import Any, Callable, cast
 
 import pytest
@@ -64,7 +64,7 @@ class TempDirMixin:
     run_in_temp_dir = True
 
     @pytest.fixture(autouse=True)
-    def _temp_dir(self, tmp_path_factory: pytest.TempPathFactory) -> Iterator[None]:
+    def _temp_dir(self, tmp_path_factory: pytest.TempPathFactory) -> Iterable[None]:
         """Create a temp dir for the tests, if they want it."""
         if self.run_in_temp_dir:
             tmpdir = tmp_path_factory.mktemp("t")

tests/test_files.py

@@ -11,7 +11,7 @@
 import re
 
 from typing import Any, Protocol
-from collections.abc import Iterable, Iterator
+from collections.abc import Iterable
 from unittest import mock
 
 import pytest
@@ -149,7 +149,7 @@ def globs_to_regex_params(
     partial: bool = False,
     matches: Iterable[str] = (),
     nomatches: Iterable[str] = (),
-) -> Iterator[Any]:
+) -> Iterable[Any]:
     """Generate parameters for `test_globs_to_regex`.
 
     `patterns`, `case_insensitive`, and `partial` are arguments for

tests/test_html.py

@@ -1442,7 +1442,7 @@ def html_data_from_cov(self, cov: Coverage, morf: TMorf) -> coverage.html.FileDa
         """Get HTML report data from a `Coverage` object for a morf."""
         with self.assert_warnings(cov, []):
             datagen = coverage.html.HtmlDataGeneration(cov)
-            fr, analysis = next(get_analysis_to_report(cov, [morf]))
+            fr, analysis = next(iter(get_analysis_to_report(cov, [morf])))
             file_data = datagen.data_for_file(fr, analysis)
             return file_data
 

tests/test_venv.py

@@ -11,7 +11,7 @@
 
 from pathlib import Path
 from typing import cast
-from collections.abc import Iterator
+from collections.abc import Iterable
 
 import pytest
 
@@ -208,7 +208,7 @@ class VirtualenvTest(CoverageTest):
     expected_stdout = "33\n110\n198\n1.5\n"
 
     @pytest.fixture(autouse=True)
-    def in_venv_world_fixture(self, venv_world: Path) -> Iterator[None]:
+    def in_venv_world_fixture(self, venv_world: Path) -> Iterable[None]:
         """For running tests inside venv_world, and cleaning up made files."""
         with change_dir(venv_world):
             self.make_file(

tests/test_xml.py

@@ -10,7 +10,7 @@
 import re
 
 from typing import Any
-from collections.abc import Iterator
+from collections.abc import Iterable
 from xml.etree import ElementTree
 
 import pytest
@@ -383,7 +383,7 @@ def unbackslash(v: Any) -> Any:
 class XmlPackageStructureTest(XmlTestHelpers, CoverageTest):
     """Tests about the package structure reported in the coverage.xml file."""
 
-    def package_and_class_tags(self, cov: Coverage) -> Iterator[tuple[str, dict[str, Any]]]:
+    def package_and_class_tags(self, cov: Coverage) -> Iterable[tuple[str, dict[str, Any]]]:
         """Run an XML report on `cov`, and get the package and class tags."""
         cov.xml_report()
         dom = ElementTree.parse("coverage.xml")