unify variable names and types

Author: David Andersson

open_alchemy/build/__init__.py

@@ -197,7 +197,10 @@ def calculate_spec_info(*, schemas: types.Schemas, spec: typing.Any) -> TSpecInf
     )
 
 
-def generate_setup(*, name: str, version: str) -> str:
+TName = str
+
+
+def generate_setup(*, name: TName, version: TVersion) -> str:
     """
     Generate the content of the setup.py file.
 
@@ -217,7 +220,7 @@ def generate_setup(*, name: str, version: str) -> str:
     )
 
 
-def generate_manifest(*, name: str) -> str:
+def generate_manifest(*, name: TName) -> str:
     """
     Generate the content of the MANIFEST.in file.
 
@@ -286,8 +289,17 @@ def generate_init(open_alchemy: str, models_file: str) -> str:
     )
 
 
+TPath = str
+
+
 def dump(
-    *, path: str, name: str, setup: str, manifest: str, spec: str, init: str
+    *,
+    path: TPath,
+    name: TName,
+    setup: str,
+    manifest: str,
+    spec_str: TSpecStr,
+    init: str,
 ) -> None:
     """
     Dump the files needed for the package at a path.
@@ -311,13 +323,13 @@ def dump(
         # Write files in the package directory.
         package = directory / name
         package.mkdir(parents=True, exist_ok=True)
-        (package / "spec.json").write_text(spec)
+        (package / "spec.json").write_text(spec_str)
         (package / "__init__.py").write_text(init)
     except OSError as exc:
         raise exceptions.BuildError(str(exc)) from exc
 
 
-def build_dist(name: str, path: str, format_: PackageFormat) -> None:
+def build_dist(name: TName, path: TPath, format_: PackageFormat) -> None:
     """
     Build a distribution package.
 
@@ -338,7 +350,7 @@ def build_dist(name: str, path: str, format_: PackageFormat) -> None:
         build_wheel(name, path)
 
 
-def build_sdist(name: str, path: str) -> None:
+def build_sdist(name: TName, path: TPath) -> None:
     """
     Build a .tar.gz source distribution and place it in a "dist" folder.
 
@@ -351,7 +363,7 @@ def build_sdist(name: str, path: str) -> None:
     helpers.command.run([sys.executable, "setup.py", "sdist"], str(pkg_dir))
 
 
-def build_wheel(name: str, path: str) -> None:
+def build_wheel(name: TName, path: TPath) -> None:
     """
     Build a .whl package and place it in a "dist" folder.
 
@@ -373,8 +385,8 @@ def build_wheel(name: str, path: str) -> None:
 def execute(
     *,
     spec: typing.Any,
-    name: str,
-    path: str,
+    name: TName,
+    path: TPath,
     format_: PackageFormat,
 ) -> None:
     """
@@ -402,7 +414,7 @@ def execute(
         name=name,
         setup=setup,
         manifest=manifest,
-        spec=spec_info.spec_str,
+        spec_str=spec_info.spec_str,
         init=init,
     )
 

tests/open_alchemy/test_build.py

@@ -125,13 +125,12 @@ def test_calculate_spec_info_version():
     WHEN calculate_spec_info is called with the spec
     THEN the version is returned.
     """
-    version = "version 1"
-    spec = {"info": {"version": version}}
+    spec = {}
     schemas = {}
 
     spec_info = build.calculate_spec_info(spec=spec, schemas=schemas)
 
-    assert spec_info.version == version
+    assert spec_info.version == "63581fa2bdc5cef14183"
 
 
 @pytest.mark.parametrize(
@@ -394,15 +393,15 @@ def test_dump(tmp_path):
     name = "name 1"
     setup = "setup file"
     manifest = "manifest file"
-    spec = "spec file"
+    spec_str = "spec file"
     init = "init file"
 
     build.dump(
         path=str(dist_path),
         name=name,
         setup=setup,
         manifest=manifest,
-        spec=spec,
+        spec_str=spec_str,
         init=init,
     )
 
@@ -426,7 +425,7 @@ def test_dump(tmp_path):
     expected_spec_path = package_path / "spec.json"
     assert expected_spec_path.is_file()
     with open(expected_spec_path) as in_file:
-        assert in_file.read() == spec
+        assert in_file.read() == spec_str
 
     # Check init file
     expected_init_path = package_path / "__init__.py"
@@ -447,15 +446,15 @@ def test_dump_path_not_exists(tmp_path):
     name = "name 1"
     setup = "setup file"
     manifest = "manifest file"
-    spec = "spec file"
+    spec_str = "spec file"
     init = "init file"
 
     build.dump(
         path=str(dist_path),
         name=name,
         setup=setup,
         manifest=manifest,
-        spec=spec,
+        spec_str=spec_str,
         init=init,
     )
 
@@ -474,7 +473,7 @@ def test_dump_path_is_file(tmp_path):
     name = "name 1"
     setup = "setup file"
     manifest = "manifest file"
-    spec = "spec file"
+    spec_str = "spec file"
     init = "init file"
 
     with pytest.raises(exceptions.BuildError):
@@ -483,7 +482,7 @@ def test_dump_path_is_file(tmp_path):
             name=name,
             setup=setup,
             manifest=manifest,
-            spec=spec,
+            spec_str=spec_str,
             init=init,
         )
 
@@ -501,7 +500,7 @@ def test_dump_path_name_exists(tmp_path):
     name = "name 1"
     setup = "setup file"
     manifest = "manifest file"
-    spec = "spec file"
+    spec_str = "spec file"
     init = "init file"
 
     (dist_path / name).mkdir()
@@ -511,7 +510,7 @@ def test_dump_path_name_exists(tmp_path):
         name=name,
         setup=setup,
         manifest=manifest,
-        spec=spec,
+        spec_str=spec_str,
         init=init,
     )
 
@@ -529,7 +528,7 @@ def test_dump_path_name_is_file(tmp_path):
     name = "name 1"
     setup = "setup file"
     manifest = "manifest file"
-    spec = "spec file"
+    spec_str = "spec file"
     init = "init file"
 
     with open(dist_path / name, "w") as out_file:
@@ -541,7 +540,7 @@ def test_dump_path_name_is_file(tmp_path):
             name=name,
             setup=setup,
             manifest=manifest,
-            spec=spec,
+            spec_str=spec_str,
             init=init,
         )