Rearrange args

Author: sco1

.pre-commit-hooks.yaml

@@ -6,8 +6,8 @@
   types: [toml]
 
 - id: check-eol-cached
-  name: Check supported Python EOL (cached)
-  entry: checkeol --cached
+  name: Check supported Python EOL (cache only)
+  entry: checkeol --cache_only
   language: python
   files: '^pyproject.toml$'
   types: [toml]

pre_commit_python_eol/check_eol.py

@@ -81,13 +81,17 @@ def from_json(cls, ver: str, metadata: dict[str, t.Any]) -> PythonRelease:
             end_of_life=_parse_eol_date(metadata["end_of_life"]),
         )
 
-    def is_eol(self, cached: bool) -> bool:
-        """Check if this version is end-of-life."""
+    def is_eol(self, use_system_date: bool) -> bool:
+        """
+        Check if this version is end-of-life.
+
+        If `use_system_date` is `True`, an additional date-based check is performed for versions
+        that are not explicitly EOL.
+        """
         if self.status == ReleasePhase.EOL:
             return True
 
-        # When running cached, don't use the current date, and trust .status
-        if not cached:
+        if use_system_date:
             utc_today = dt.datetime.now(dt.timezone.utc).date()
             if self.end_of_life <= utc_today:
                 return True
@@ -114,13 +118,16 @@ def _get_cached_release_cycle(cache_json: Path) -> list[PythonRelease]:
 
 
 def check_python_support(
-    toml_file: Path, *, cached: bool = False, cache_json: Path = CACHED_RELEASE_CYCLE
+    toml_file: Path, cache_json: Path = CACHED_RELEASE_CYCLE, use_system_date: bool = True
 ) -> None:
     """
     Check the input TOML's `requires-python` for overlap with EOL Python version(s).
 
     If overlap(s) are present, an exception is raised whose message enumerates all EOL Python
     versions supported by the TOML file.
+
+    If `use_system_date` is `True`, an additional date-based check is performed for versions that
+    are not explicitly EOL.
     """
     with toml_file.open("rb") as f:
         contents = tomllib.load(f)
@@ -132,7 +139,9 @@ def check_python_support(
     package_spec = specifiers.SpecifierSet(requires_python)
     release_cycle = _get_cached_release_cycle(cache_json)
 
-    eol_supported = [r for r in release_cycle if r.python_ver in package_spec and r.is_eol(cached)]
+    eol_supported = [
+        r for r in release_cycle if ((r.python_ver in package_spec) and r.is_eol(use_system_date))
+    ]
 
     if eol_supported:
         eol_supported.sort(key=attrgetter("python_ver"))  # Sort ascending for error msg generation
@@ -143,13 +152,13 @@ def check_python_support(
 def main(argv: abc.Sequence[str] | None = None) -> int:  # noqa: D103
     parser = argparse.ArgumentParser()
     parser.add_argument("filenames", nargs="*", type=Path)
-    parser.add_argument("--cached", action="store_true")
+    parser.add_argument("--cache_only", action="store_true")
     args = parser.parse_args(argv)
 
     ec = 0
     for file in args.filenames:
         try:
-            check_python_support(file, cached=args.cached)
+            check_python_support(file, use_system_date=(not args.cache_only))
         except EOLPythonError as e:
             print(f"{file}: {e}")
             ec = 1

tests/test_check_eol.py

@@ -215,6 +215,21 @@ def test_check_python_support_multi_eol_raises(path_with_cache: tuple[Path, Path
     assert str(e.value).endswith("3.7, 3.8")
 
 
+def test_check_cached_python_support_single_eol_no_raises_by_date(
+    path_with_cache: tuple[Path, Path],
+) -> None:
+    base_path, cache_path = path_with_cache
+    pyproject = base_path / "pyproject.toml"
+    pyproject.write_text(SAMPLE_PYPROJECT_SINGLE_EOL_BY_DATE)
+
+    with time_machine.travel(dt.date(year=2031, month=11, day=1)):
+        check_python_support(
+            pyproject,
+            cache_json=cache_path,
+            use_system_date=False,
+        )
+
+
 def test_check_cached_python_support_no_eol(path_with_cache: tuple[Path, Path]) -> None:
     base_path, cache_path = path_with_cache
     pyproject = base_path / "pyproject.toml"
@@ -223,7 +238,7 @@ def test_check_cached_python_support_no_eol(path_with_cache: tuple[Path, Path])
     check_python_support(
         pyproject,
         cache_json=cache_path,
-        cached=True,
+        use_system_date=False,
     )
 
 
@@ -236,22 +251,7 @@ def test_check_cached_python_support_single_eol_raises(path_with_cache: tuple[Pa
         check_python_support(
             pyproject,
             cache_json=cache_path,
-            cached=True,
+            use_system_date=False,
         )
 
     assert str(e.value).endswith("3.8")
-
-
-def test_check_cached_python_support_single_eol_no_raises_by_date(
-    path_with_cache: tuple[Path, Path],
-) -> None:
-    base_path, cache_path = path_with_cache
-    pyproject = base_path / "pyproject.toml"
-    pyproject.write_text(SAMPLE_PYPROJECT_SINGLE_EOL_BY_DATE)
-
-    with time_machine.travel(dt.date(year=2031, month=11, day=1)):
-        check_python_support(
-            pyproject,
-            cache_json=cache_path,
-            cached=True,
-        )