Rename python_files to get_filtered_python_files

Author: ArBridgeman

exasol/toolbox/nox/_format.py

@@ -9,7 +9,7 @@
     Mode,
     _version,
     check_for_config_attribute,
-    python_files,
+    get_filtered_python_files,
 )
 from noxconfig import (
     PROJECT_CONFIG,
@@ -45,7 +45,7 @@ def command(*args: str) -> Iterable[str]:
 @nox.session(name="project:fix", python=False)
 def fix(session: Session) -> None:
     """Runs all automated fixes on the code base"""
-    py_files = python_files(PROJECT_CONFIG.root)
+    py_files = get_filtered_python_files(PROJECT_CONFIG.root)
     _version(session, Mode.Fix)
     _pyupgrade(session, config=PROJECT_CONFIG, files=py_files)
     _ruff(session, mode=Mode.Fix, files=py_files)
@@ -55,6 +55,6 @@ def fix(session: Session) -> None:
 @nox.session(name="project:format", python=False)
 def fmt_check(session: Session) -> None:
     """Checks the project for correct formatting"""
-    py_files = python_files(PROJECT_CONFIG.root)
+    py_files = get_filtered_python_files(PROJECT_CONFIG.root)
     _ruff(session, mode=Mode.Check, files=py_files)
     _code_format(session=session, mode=Mode.Check, files=py_files)

exasol/toolbox/nox/_lint.py

@@ -10,7 +10,7 @@
 import tomlkit
 from nox import Session
 
-from exasol.toolbox.nox._shared import python_files
+from exasol.toolbox.nox._shared import get_filtered_python_files
 from exasol.toolbox.util.dependencies.shared_models import PoetryFiles
 from noxconfig import PROJECT_CONFIG
 
@@ -120,22 +120,22 @@ def report_illegal(illegal: dict[str, list[str]], console: rich.console.Console)
 @nox.session(name="lint:code", python=False)
 def lint(session: Session) -> None:
     """Runs the static code analyzer on the project"""
-    py_files = python_files(PROJECT_CONFIG.root / PROJECT_CONFIG.source)
-    _pylint(session, py_files)
+    py_files = get_filtered_python_files(PROJECT_CONFIG.root / PROJECT_CONFIG.source)
+    _pylint(session=session, files=py_files)
 
 
 @nox.session(name="lint:typing", python=False)
 def type_check(session: Session) -> None:
     """Runs the type checker on the project"""
-    py_files = [f"{file}" for file in python_files(PROJECT_CONFIG.root)]
-    _type_check(session, py_files)
+    py_files = get_filtered_python_files(PROJECT_CONFIG.root)
+    _type_check(session=session, files=py_files)
 
 
 @nox.session(name="lint:security", python=False)
 def security_lint(session: Session) -> None:
     """Runs the security linter on the project"""
-    py_files = python_files(PROJECT_CONFIG.root / PROJECT_CONFIG.source)
-    _security_lint(session, py_files)
+    py_files = get_filtered_python_files(PROJECT_CONFIG.root / PROJECT_CONFIG.source)
+    _security_lint(session=session, files=py_files)
 
 
 @nox.session(name="lint:dependencies", python=False)

exasol/toolbox/nox/_shared.py

@@ -3,7 +3,6 @@
 import argparse
 from collections import ChainMap
 from collections.abc import (
-    Iterable,
     MutableMapping,
 )
 from enum import (
@@ -39,9 +38,9 @@ class Mode(Enum):
     Check = auto()
 
 
-def python_files(project_root: Path) -> Iterable[str]:
+def get_filtered_python_files(project_root: Path) -> list[str]:
     """
-    Returns iterable of python files after removing unwanted paths
+    Returns iterable of Python files after removing excluded paths
     """
     check_for_config_attribute(config=PROJECT_CONFIG, attribute="excluded_python_paths")
     files = project_root.glob("**/*.py")

exasol/toolbox/nox/tasks.py

@@ -34,7 +34,7 @@
 def check(session: Session) -> None:
     """Runs all available checks on the project"""
     context = _context(session, coverage=True)
-    py_files = python_files(PROJECT_CONFIG.root)
+    py_files = get_filtered_python_files(PROJECT_CONFIG.root)
     _version(session, Mode.Check)
     _code_format(session, Mode.Check, py_files)
     _pylint(session, py_files)
@@ -65,7 +65,7 @@ def check(session: Session) -> None:
     Mode,
     _context,
     _version,
-    python_files,
+    get_filtered_python_files,
 )
 
 from exasol.toolbox.nox._ci import (

test/unit/nox/_shared_test.py

@@ -8,7 +8,7 @@
 from exasol.toolbox.config import BaseConfig
 from exasol.toolbox.nox._shared import (
     check_for_config_attribute,
-    python_files,
+    get_filtered_python_files,
 )
 
 
@@ -48,13 +48,13 @@ def create_files(tmp_directory, directories):
     yield file_list
 
 
-def test_python_files(
+def test_get_filtered_python_files(
     tmp_directory, create_files, package_directory, path_filter_directory
 ):
     config = BaseConfig(add_to_excluded_python_paths=(path_filter_directory,))
 
     with patch("exasol.toolbox.nox._shared.PROJECT_CONFIG", config):
-        actual = python_files(tmp_directory)
+        actual = get_filtered_python_files(tmp_directory)
 
     assert len(actual) == 1
     assert "toolbox-dummy" in actual[0]