Allow overriding generated package/project names (#133)

* Added config options for overriding the generated library's project & package names

Co-authored-by: Ethan Mann <[email protected]>

Author: emann

CHANGELOG.md

@@ -6,15 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 ## 0.5.2 - unreleased
-### Fixes
+### Additions
+- Added `project_name_override` and `package_name_override` config options to override the name of the generated project/package (#123)
 - The generated library's version is now the same as the OpenAPI doc's version (#134)
 
+
 ## 0.5.1 - 2020-08-05
 ### Fixes
 - Relative paths are now allowed in securitySchemes/OAuthFlow/tokenUrl (#130).
 - Schema validation errors will no longer print a stack trace (#131).
 - Invalid YAML/URL will no longer print stack trace (#128)
 
+
 ## 0.5.0 - 2020-08-05
 ### Changes
 - When encountering a problem, the generator will now differentiate between warnings (things it was able to skip past)

README.md

@@ -86,6 +86,16 @@ class_overrides:
 
 The easiest way to find what needs to be overridden is probably to generate your client and go look at everything in the
  models folder.
+ 
+ ### project_name_override and package_name_override
+Used to change the name of generated client library project/package. If the project name is changed but an override for the package name
+isn't provided, the package name will be converted from the project name using the standard convention (replacing `-`'s with `_`'s).
+
+Example:
+```yaml
+project_name_override: my-special-project-name
+package_name_override: my_extra_special_package_name
+```
 
 
 [CHANGELOG.md]: CHANGELOG.md

mypy.ini

@@ -4,6 +4,9 @@ disallow_untyped_defs = True
 warn_redundant_casts = True
 strict_equality = True
 
+[mypy-importlib_metadata]
+ignore_missing_imports = True
+
 [mypy-stringcase]
 ignore_missing_imports = True
 

openapi_python_client/__init__.py

@@ -18,33 +18,22 @@
 from .parser.errors import GeneratorError
 
 if sys.version_info.minor == 7:  # version did not exist in 3.7, need to use a backport
-    from importlib_metadata import version  # type: ignore
+    from importlib_metadata import version
 else:
     from importlib.metadata import version  # type: ignore
 
 
 __version__ = version(__package__)
 
 
-def _get_project_for_url_or_path(url: Optional[str], path: Optional[Path]) -> Union[_Project, GeneratorError]:
+def _get_project_for_url_or_path(url: Optional[str], path: Optional[Path]) -> Union[Project, GeneratorError]:
     data_dict = _get_document(url=url, path=path)
     if isinstance(data_dict, GeneratorError):
         return data_dict
     openapi = GeneratorData.from_dict(data_dict)
     if isinstance(openapi, GeneratorError):
         return openapi
-    return _Project(openapi=openapi)
-
-
-def load_config(*, path: Path) -> None:
-    """ Loads config from provided Path """
-    config_data = yaml.safe_load(path.read_text())
-
-    if "class_overrides" in config_data:
-        from .parser import reference
-
-        for class_name, class_data in config_data["class_overrides"].items():
-            reference.class_overrides[class_name] = reference.Reference(**class_data)
+    return Project(openapi=openapi)
 
 
 def create_new_client(*, url: Optional[str], path: Optional[Path]) -> Sequence[GeneratorError]:
@@ -93,17 +82,19 @@ def _get_document(*, url: Optional[str], path: Optional[Path]) -> Union[Dict[str
         return GeneratorError(header="Invalid YAML from provided source")
 
 
-class _Project:
+class Project:
     TEMPLATE_FILTERS = {"snakecase": utils.snake_case}
+    project_name_override: Optional[str] = None
+    package_name_override: Optional[str] = None
 
     def __init__(self, *, openapi: GeneratorData) -> None:
         self.openapi: GeneratorData = openapi
         self.env: Environment = Environment(loader=PackageLoader(__package__), trim_blocks=True, lstrip_blocks=True)
 
-        self.project_name: str = f"{openapi.title.replace(' ', '-').lower()}-client"
+        self.project_name: str = self.project_name_override or f"{openapi.title.replace(' ', '-').lower()}-client"
         self.project_dir: Path = Path.cwd() / self.project_name
 
-        self.package_name: str = self.project_name.replace("-", "_")
+        self.package_name: str = self.package_name_override or self.project_name.replace("-", "_")
         self.package_dir: Path = self.project_dir / self.package_name
         self.package_description: str = f"A client library for accessing {self.openapi.title}"
         self.version: str = openapi.version

openapi_python_client/cli.py

@@ -18,13 +18,13 @@ def _version_callback(value: bool) -> None:
 
 
 def _process_config(path: Optional[pathlib.Path]) -> None:
-    from openapi_python_client import load_config
+    from .config import Config
 
     if not path:
         return
 
     try:
-        load_config(path=path)
+        Config.load_from_path(path=path)
     except:  # noqa
         raise typer.BadParameter("Unable to parse config")
 

openapi_python_client/config.py

@@ -0,0 +1,35 @@
+from pathlib import Path
+from typing import Dict, Optional
+
+import yaml
+from pydantic import BaseModel
+
+
+class ClassOverride(BaseModel):
+    class_name: str
+    module_name: str
+
+
+class Config(BaseModel):
+    class_overrides: Optional[Dict[str, ClassOverride]]
+    project_name_override: Optional[str]
+    package_name_override: Optional[str]
+
+    def load_config(self) -> None:
+        """ Loads config from provided Path """
+
+        if self.class_overrides is not None:
+            from .parser import reference
+
+            for class_name, class_data in self.class_overrides.items():
+                reference.class_overrides[class_name] = reference.Reference(**dict(class_data))
+
+        from openapi_python_client import Project
+
+        Project.project_name_override = self.project_name_override
+        Project.package_name_override = self.package_name_override
+
+    @staticmethod
+    def load_from_path(path: Path) -> None:
+        config_data = yaml.safe_load(path.read_text())
+        Config(**config_data).load_config()

tests/test___init__.py

@@ -13,7 +13,7 @@ def test__get_project_for_url_or_path(mocker):
     _get_document = mocker.patch("openapi_python_client._get_document", return_value=data_dict)
     openapi = mocker.MagicMock()
     from_dict = mocker.patch("openapi_python_client.parser.GeneratorData.from_dict", return_value=openapi)
-    _Project = mocker.patch("openapi_python_client._Project")
+    _Project = mocker.patch("openapi_python_client.Project")
     url = mocker.MagicMock()
     path = mocker.MagicMock()
 
@@ -32,7 +32,7 @@ def test__get_project_for_url_or_path_generator_error(mocker):
     _get_document = mocker.patch("openapi_python_client._get_document", return_value=data_dict)
     error = GeneratorError()
     from_dict = mocker.patch("openapi_python_client.parser.GeneratorData.from_dict", return_value=error)
-    _Project = mocker.patch("openapi_python_client._Project")
+    _Project = mocker.patch("openapi_python_client.Project")
     url = mocker.MagicMock()
     path = mocker.MagicMock()
 
@@ -219,19 +219,36 @@ class TestProject:
     def test___init__(self, mocker):
         openapi = mocker.MagicMock(title="My Test API")
 
-        from openapi_python_client import _Project
+        from openapi_python_client import Project
 
-        project = _Project(openapi=openapi)
+        project = Project(openapi=openapi)
 
         assert project.openapi == openapi
         assert project.project_name == "my-test-api-client"
         assert project.package_name == "my_test_api_client"
         assert project.package_description == "A client library for accessing My Test API"
 
+    def test_project_and_package_name_overrides(self, mocker):
+        openapi = mocker.MagicMock(title="My Test API")
+
+        from openapi_python_client import Project
+
+        Project.project_name_override = "my-special-project-name"
+        project = Project(openapi=openapi)
+
+        assert project.project_name == "my-special-project-name"
+        assert project.package_name == "my_special_project_name"
+
+        Project.package_name_override = "my_special_package_name"
+        project = Project(openapi=openapi)
+
+        assert project.project_name == "my-special-project-name"
+        assert project.package_name == "my_special_package_name"
+
     def test_build(self, mocker):
-        from openapi_python_client import _Project
+        from openapi_python_client import Project
 
-        project = _Project(openapi=mocker.MagicMock(title="My Test API"))
+        project = Project(openapi=mocker.MagicMock(title="My Test API"))
         project.project_dir = mocker.MagicMock()
         project.package_dir = mocker.MagicMock()
         project._build_metadata = mocker.MagicMock()
@@ -253,9 +270,9 @@ def test_build(self, mocker):
         assert result == project._get_errors.return_value
 
     def test_build_file_exists(self, mocker):
-        from openapi_python_client import _Project
+        from openapi_python_client import Project
 
-        project = _Project(openapi=mocker.MagicMock(title="My Test API"))
+        project = Project(openapi=mocker.MagicMock(title="My Test API"))
         project.project_dir = mocker.MagicMock()
         project.project_dir.mkdir.side_effect = FileExistsError
         result = project.build()
@@ -265,10 +282,10 @@ def test_build_file_exists(self, mocker):
         assert result == [GeneratorError(detail="Directory already exists. Delete it or use the update command.")]
 
     def test_update(self, mocker):
-        from openapi_python_client import _Project, shutil
+        from openapi_python_client import Project, shutil
 
         rmtree = mocker.patch.object(shutil, "rmtree")
-        project = _Project(openapi=mocker.MagicMock(title="My Test API"))
+        project = Project(openapi=mocker.MagicMock(title="My Test API"))
         project.package_dir = mocker.MagicMock()
         project._build_metadata = mocker.MagicMock()
         project._build_models = mocker.MagicMock()
@@ -288,9 +305,9 @@ def test_update(self, mocker):
         assert result == project._get_errors.return_value
 
     def test_update_missing_dir(self, mocker):
-        from openapi_python_client import _Project
+        from openapi_python_client import Project
 
-        project = _Project(openapi=mocker.MagicMock(title="My Test API"))
+        project = Project(openapi=mocker.MagicMock(title="My Test API"))
         project.package_dir = mocker.MagicMock()
         project.package_dir.is_dir.return_value = False
         project._build_models = mocker.MagicMock()
@@ -302,9 +319,9 @@ def test_update_missing_dir(self, mocker):
         project._build_models.assert_not_called()
 
     def test__create_package(self, mocker):
-        from openapi_python_client import _Project
+        from openapi_python_client import Project
 
-        project = _Project(openapi=mocker.MagicMock(title="My Test API"))
+        project = Project(openapi=mocker.MagicMock(title="My Test API"))
         project.package_dir = mocker.MagicMock()
         package_init_template = mocker.MagicMock()
         project.env = mocker.MagicMock()
@@ -327,9 +344,9 @@ def test__create_package(self, mocker):
         pytyped_path.write_text.assert_called_once_with("# Marker file for PEP 561")
 
     def test__build_metadata(self, mocker):
-        from openapi_python_client import _Project
+        from openapi_python_client import Project
 
-        project = _Project(openapi=mocker.MagicMock(title="My Test API"))
+        project = Project(openapi=mocker.MagicMock(title="My Test API"))
         project.project_dir = mocker.MagicMock()
         pyproject_path = mocker.MagicMock(autospec=pathlib.Path)
         readme_path = mocker.MagicMock(autospec=pathlib.Path)
@@ -375,7 +392,7 @@ def test__build_metadata(self, mocker):
         git_ignore_path.write_text.assert_called_once_with(git_ignore_template.render())
 
     def test__build_models(self, mocker):
-        from openapi_python_client import GeneratorData, _Project
+        from openapi_python_client import GeneratorData, Project
 
         openapi = mocker.MagicMock(autospec=GeneratorData, title="My Test API")
         model_1 = mocker.MagicMock()
@@ -384,7 +401,7 @@ def test__build_models(self, mocker):
         enum_1 = mocker.MagicMock()
         enum_2 = mocker.MagicMock()
         openapi.enums = {"1": enum_1, "2": enum_2}
-        project = _Project(openapi=openapi)
+        project = Project(openapi=openapi)
         project.package_dir = mocker.MagicMock()
         models_init = mocker.MagicMock()
         types_py = mocker.MagicMock()
@@ -466,15 +483,15 @@ def test__build_api(self, mocker):
 
         from jinja2 import Template
 
-        from openapi_python_client import GeneratorData, _Project
+        from openapi_python_client import GeneratorData, Project
 
         openapi = mocker.MagicMock(autospec=GeneratorData, title="My Test API")
         tag_1 = mocker.MagicMock(autospec=str)
         tag_2 = mocker.MagicMock(autospec=str)
         collection_1 = mocker.MagicMock()
         collection_2 = mocker.MagicMock()
         openapi.endpoint_collections_by_tag = {tag_1: collection_1, tag_2: collection_2}
-        project = _Project(openapi=openapi)
+        project = Project(openapi=openapi)
         project.package_dir = mocker.MagicMock()
         api_errors = mocker.MagicMock(autospec=pathlib.Path)
         client_path = mocker.MagicMock()
@@ -557,11 +574,11 @@ def test__build_api(self, mocker):
 def test__reformat(mocker):
     import subprocess
 
-    from openapi_python_client import GeneratorData, _Project
+    from openapi_python_client import GeneratorData, Project
 
     sub_run = mocker.patch("subprocess.run")
     openapi = mocker.MagicMock(autospec=GeneratorData, title="My Test API")
-    project = _Project(openapi=openapi)
+    project = Project(openapi=openapi)
     project.project_dir = mocker.MagicMock(autospec=pathlib.Path)
 
     project._reformat()
@@ -577,7 +594,7 @@ def test__reformat(mocker):
 
 
 def test__get_errors(mocker):
-    from openapi_python_client import GeneratorData, _Project
+    from openapi_python_client import GeneratorData, Project
     from openapi_python_client.parser.openapi import EndpointCollection, Schemas
 
     openapi = mocker.MagicMock(
@@ -589,27 +606,6 @@ def test__get_errors(mocker):
         },
         schemas=mocker.MagicMock(autospec=Schemas, errors=[3]),
     )
-    project = _Project(openapi=openapi)
+    project = Project(openapi=openapi)
 
     assert project._get_errors() == [1, 2, 3]
-
-
-def test_load_config(mocker):
-    my_data = {"class_overrides": {"_MyCLASSName": {"class_name": "MyClassName", "module_name": "my_module_name"}}}
-    safe_load = mocker.patch("yaml.safe_load", return_value=my_data)
-    fake_path = mocker.MagicMock(autospec=pathlib.Path)
-
-    from openapi_python_client import load_config
-    from openapi_python_client.parser import reference
-
-    reference.class_overrides = {}
-
-    load_config(path=fake_path)
-
-    fake_path.read_text.assert_called_once()
-    safe_load.assert_called_once_with(fake_path.read_text())
-    from openapi_python_client.parser import reference
-
-    assert reference.class_overrides == {
-        "_MyCLASSName": reference.Reference(class_name="MyClassName", module_name="my_module_name")
-    }

tests/test_cli.py

@@ -25,8 +25,8 @@ def _create_new_client(mocker) -> MagicMock:
     return mocker.patch("openapi_python_client.create_new_client", return_value=[])
 
 
-def test_config(mocker, _create_new_client):
-    load_config = mocker.patch("openapi_python_client.load_config")
+def test_config_arg(mocker, _create_new_client):
+    load_config = mocker.patch("openapi_python_client.config.Config.load_from_path")
     from openapi_python_client.cli import app
 
     config_path = "config/path"
@@ -40,7 +40,9 @@ def test_config(mocker, _create_new_client):
 
 
 def test_bad_config(mocker, _create_new_client):
-    load_config = mocker.patch("openapi_python_client.load_config", side_effect=ValueError("Bad Config"))
+    load_config = mocker.patch(
+        "openapi_python_client.config.Config.load_from_path", side_effect=ValueError("Bad Config")
+    )
     from openapi_python_client.cli import app
 
     config_path = "config/path"