Rename RequirementsBase type to RequirementsStem

Author: connesy

tests/helpers.py

@@ -5,7 +5,7 @@
 from pathlib import Path
 from typing import Callable, Optional
 
-from tests.types import P, RawFilesDict, RequirementsBase, RequirementsDict
+from tests.types import P, RawFilesDict, RequirementsDict, RequirementsStem
 
 RequirementFiles = dict[str, Path]
 current_python_version = f"{sys.version_info.major}.{sys.version_info.minor}"
@@ -54,13 +54,13 @@ def run_command(
 
 
 def collect_requirements(
-    func: Callable[P, tuple[RawFilesDict, RequirementsBase]]
-) -> Callable[P, tuple[RequirementsDict, RequirementsBase]]:
+    func: Callable[P, tuple[RawFilesDict, RequirementsStem]]
+) -> Callable[P, tuple[RequirementsDict, RequirementsStem]]:
     @wraps(func)
-    def wrapper(*args: P.args, **kwargs: P.kwargs) -> tuple[RequirementsDict, RequirementsBase]:
-        files_dict, requirements_base = func(*args, **kwargs)
+    def wrapper(*args: P.args, **kwargs: P.kwargs) -> tuple[RequirementsDict, RequirementsStem]:
+        files_dict, requirements_stem = func(*args, **kwargs)
         requirements_dict = {filename: "\n".join(requirements) for filename, requirements in files_dict.items()}
-        return requirements_dict, requirements_base
+        return requirements_dict, requirements_stem
 
     return wrapper
 

tests/test_venv_install.py

@@ -8,7 +8,7 @@
 
 from tests.helpers import run_command, write_files
 from tests.test_venv_install_cases import CasesVenvInstallRequirementstxt, CasesVenvInstallWithLock
-from tests.types import RequirementsBase, RequirementsDict
+from tests.types import RequirementsDict, RequirementsStem
 
 _package_name_regex = re.compile(r"^([a-zA-Z0-9_-]+)\b")
 
@@ -30,24 +30,24 @@ def test_venv_install_not_activated(tmp_path: Path, monkeypatch: pytest.MonkeyPa
 
 
 @pytest.mark.order(after="test_venv_activate.py::test_venv_activate")
-@parametrize_with_cases(argnames=["files", "requirements_base"], cases=CasesVenvInstallRequirementstxt)
+@parametrize_with_cases(argnames=["files", "requirements_stem"], cases=CasesVenvInstallRequirementstxt)
 @pytest.mark.parametrize("use_file_name", [True, False])
 def test_venv_install_requirements(
     files: RequirementsDict,
-    requirements_base: RequirementsBase,
+    requirements_stem: RequirementsStem,
     use_file_name: bool,
     tmp_path: Path,
     capfd: pytest.CaptureFixture,
 ):
     write_files(files=files, dir=tmp_path)
 
     # Install the requirements
-    if not (requirements_base is RequirementsBase.requirements or use_file_name):
-        pytest.skip(f"Empty file name case only valid for requirements.txt, not {requirements_base}")
+    if not (requirements_stem is RequirementsStem.requirements or use_file_name):
+        pytest.skip(f"Empty file name case only valid for requirements.txt, not {requirements_stem}")
 
     install_file_name = ""
     if use_file_name:
-        install_file_name = f"{requirements_base.value}.txt"
+        install_file_name = f"{requirements_stem.value}.txt"
 
     run_command(
         f"venv install {install_file_name} --skip-lock",
@@ -57,7 +57,7 @@ def test_venv_install_requirements(
 
     # Check pip install log output
     output: str = capfd.readouterr().out
-    assert f"Installing requirements from {requirements_base.value}.txt" in output
+    assert f"Installing requirements from {requirements_stem.value}.txt" in output
 
     installed_line = [line for line in output.splitlines() if line.startswith("Successfully installed")][0]
     requirement_lines = chain.from_iterable(contents.splitlines() for contents in files.values())
@@ -70,16 +70,16 @@ def test_venv_install_requirements(
 
 
 @pytest.mark.order(after="test_venv_activate.py::test_venv_activate")
-@parametrize_with_cases(argnames=["files", "requirements_base"], cases=CasesVenvInstallWithLock)
+@parametrize_with_cases(argnames=["files", "requirements_stem"], cases=CasesVenvInstallWithLock)
 def test_venv_install_with_lock(
     files: RequirementsDict,
-    requirements_base: RequirementsBase,
+    requirements_stem: RequirementsStem,
     tmp_path: Path,
 ):
     write_files(files=files, dir=tmp_path)
 
     run_command(
-        f"venv install {requirements_base}.txt",
+        f"venv install {requirements_stem}.txt",
         cwd=tmp_path,
         activated=True,
     )

tests/test_venv_install_cases.py

@@ -1,28 +1,28 @@
 from tests.helpers import collect_requirements
-from tests.types import RawFilesDict, RequirementsBase
+from tests.types import RawFilesDict, RequirementsStem
 
 
 class CasesVenvInstallRequirementstxt:
     @collect_requirements
-    def case_pypi(self) -> tuple[RawFilesDict, RequirementsBase]:
+    def case_pypi(self) -> tuple[RawFilesDict, RequirementsStem]:
         requirements_txt = [
             "python-json-logger==2.0.7",
         ]
 
         files = {"requirements.txt": requirements_txt}
-        return files, RequirementsBase.requirements
+        return files, RequirementsStem.requirements
 
     @collect_requirements
-    def case_git(self) -> tuple[RawFilesDict, RequirementsBase]:
+    def case_git(self) -> tuple[RawFilesDict, RequirementsStem]:
         requirements_txt = [
             "python-json-logger @ git+https://github.com/madzak/[email protected]",
         ]
 
         files = {"requirements.txt": requirements_txt}
-        return files, RequirementsBase.requirements
+        return files, RequirementsStem.requirements
 
     @collect_requirements
-    def case_pypi_dev(self) -> tuple[RawFilesDict, RequirementsBase]:
+    def case_pypi_dev(self) -> tuple[RawFilesDict, RequirementsStem]:
         requirements_txt = [
             "python-json-logger==2.0.7",
         ]
@@ -36,10 +36,10 @@ def case_pypi_dev(self) -> tuple[RawFilesDict, RequirementsBase]:
             "requirements.txt": requirements_txt,
             "dev-requirements.txt": dev_requirements_txt,
         }
-        return files, RequirementsBase.dev_requirements
+        return files, RequirementsStem.dev_requirements
 
     @collect_requirements
-    def case_git_dev(self) -> tuple[RawFilesDict, RequirementsBase]:
+    def case_git_dev(self) -> tuple[RawFilesDict, RequirementsStem]:
         requirements_txt = [
             "python-json-logger @ git+https://github.com/madzak/[email protected]",
         ]
@@ -53,15 +53,15 @@ def case_git_dev(self) -> tuple[RawFilesDict, RequirementsBase]:
             "requirements.txt": requirements_txt,
             "dev-requirements.txt": dev_requirements_txt,
         }
-        return files, RequirementsBase.dev_requirements
+        return files, RequirementsStem.dev_requirements
 
 
 class CasesVenvInstallWithLock:
     @collect_requirements
-    def case_pypi(self) -> tuple[RawFilesDict, RequirementsBase]:
+    def case_pypi(self) -> tuple[RawFilesDict, RequirementsStem]:
         requirements_txt = [
             "python-json-logger==2.0.7",
         ]
 
         files = {"requirements.txt": requirements_txt}
-        return files, RequirementsBase.requirements
+        return files, RequirementsStem.requirements

tests/test_venv_lock.py

@@ -6,7 +6,7 @@
 
 from tests.helpers import run_command, write_files
 from tests.test_venv_lock_cases import CasesVenvLock
-from tests.types import RequirementsBase, RequirementsDict
+from tests.types import RequirementsDict, RequirementsStem
 
 
 @pytest.mark.order(
@@ -15,26 +15,26 @@
         "test_venv_fill_credentials.py::test_venv_fill_credentials",
     ]
 )
-@parametrize_with_cases(argnames=["files", "requirements_base"], cases=CasesVenvLock)
+@parametrize_with_cases(argnames=["files", "requirements_stem"], cases=CasesVenvLock)
 @parametrize("use_short_name", [False, True])
 def test_venv_lock(
     files: RequirementsDict,
-    requirements_base: RequirementsBase,
+    requirements_stem: RequirementsStem,
     use_short_name: bool,
     tmp_path: Path,
 ):
     """Checks that we can lock requirements in an environment after installing them"""
     write_files(files=files, dir=tmp_path)
 
-    lock_file_path = f"{requirements_base}.lock"
+    lock_file_path = f"{requirements_stem}.lock"
     if use_short_name:
-        lock_file_arg = requirements_base.split("-")[0] if "-" in requirements_base else ""
+        lock_file_arg = requirements_stem.split("-")[0] if "-" in requirements_stem else ""
     else:
         lock_file_arg = lock_file_path
 
     run_command(
         commands=[
-            f"venv install {requirements_base}.txt --skip-lock",
+            f"venv install {requirements_stem}.txt --skip-lock",
             f"venv lock {lock_file_arg}",
         ],
         cwd=tmp_path,

tests/test_venv_lock_cases.py

@@ -1,10 +1,10 @@
 from tests.helpers import collect_requirements
-from tests.types import RawFilesDict, RequirementsBase
+from tests.types import RawFilesDict, RequirementsStem
 
 
 class CasesVenvLock:
     @collect_requirements
-    def case_requirements(self) -> tuple[RawFilesDict, RequirementsBase]:
+    def case_requirements(self) -> tuple[RawFilesDict, RequirementsStem]:
         requirements_txt = [
             "python-json-logger==2.0.7",
             "resolvelib @ git+https://github.com/sarugaku/[email protected]",
@@ -18,10 +18,10 @@ def case_requirements(self) -> tuple[RawFilesDict, RequirementsBase]:
             "requirements.txt": requirements_txt,
             "requirements.lock": requirements_lock,
         }
-        return files, RequirementsBase.requirements
+        return files, RequirementsStem.requirements
 
     @collect_requirements
-    def case_dev_requirements(self) -> tuple[RawFilesDict, RequirementsBase]:
+    def case_dev_requirements(self) -> tuple[RawFilesDict, RequirementsStem]:
         requirements_txt = [
             "python-json-logger==2.0.7",
         ]
@@ -41,4 +41,4 @@ def case_dev_requirements(self) -> tuple[RawFilesDict, RequirementsBase]:
             "dev-requirements.txt": dev_requirements_txt,
             "dev-requirements.lock": dev_requirements_lock,
         }
-        return files, RequirementsBase.dev_requirements
+        return files, RequirementsStem.dev_requirements

tests/types.py

@@ -8,6 +8,6 @@
 RequirementFiles = dict[str, Path]
 
 
-class RequirementsBase(str, Enum):
+class RequirementsStem(str, Enum):
     requirements = "requirements"
     dev_requirements = "dev-requirements"