fix: Modify the parameter name encoding to file_encoding, and set the default is UTF-8

Author: dongfangtianyu

openapi_python_client/__init__.py

@@ -44,19 +44,19 @@ class Project:
     project_name_override: Optional[str] = None
     package_name_override: Optional[str] = None
     package_version_override: Optional[str] = None
-    encoding: Optional[str] = None
+    file_encoding: str
 
     def __init__(
         self,
         *,
         openapi: GeneratorData,
         meta: MetaType,
         custom_template_path: Optional[Path] = None,
-        encoding: Optional[str] = None,
+        file_encoding: str = "utf-8",
     ) -> None:
         self.openapi: GeneratorData = openapi
         self.meta: MetaType = meta
-        self.encoding = encoding
+        self.encoding = file_encoding
 
         package_loader = PackageLoader(__package__)
         loader: BaseLoader
@@ -264,15 +264,15 @@ def _get_project_for_url_or_path(
     path: Optional[Path],
     meta: MetaType,
     custom_template_path: Optional[Path] = None,
-    encoding: Optional[str] = None,
+    file_encoding: str = "utf-8",
 ) -> 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, custom_template_path=custom_template_path, meta=meta, encoding=encoding)
+    return Project(openapi=openapi, custom_template_path=custom_template_path, meta=meta, file_encoding=file_encoding)
 
 
 def create_new_client(
@@ -281,7 +281,7 @@ def create_new_client(
     path: Optional[Path],
     meta: MetaType,
     custom_template_path: Optional[Path] = None,
-    encoding: Optional[str] = None,
+    file_encoding: str = "utf-8",
 ) -> Sequence[GeneratorError]:
     """
     Generate the client library
@@ -290,23 +290,30 @@ def create_new_client(
          A list containing any errors encountered when generating.
     """
     project = _get_project_for_url_or_path(
-        url=url, path=path, custom_template_path=custom_template_path, meta=meta, encoding=encoding
+        url=url, path=path, custom_template_path=custom_template_path, meta=meta, file_encoding=file_encoding
     )
     if isinstance(project, GeneratorError):
         return [project]
     return project.build()
 
 
 def update_existing_client(
-    *, url: Optional[str], path: Optional[Path], meta: MetaType, custom_template_path: Optional[Path] = None
+    *,
+    url: Optional[str],
+    path: Optional[Path],
+    meta: MetaType,
+    custom_template_path: Optional[Path] = None,
+    file_encoding: str = "utf-8",
 ) -> Sequence[GeneratorError]:
     """
     Update an existing client library
 
     Returns:
          A list containing any errors encountered when generating.
     """
-    project = _get_project_for_url_or_path(url=url, path=path, custom_template_path=custom_template_path, meta=meta)
+    project = _get_project_for_url_or_path(
+        url=url, path=path, custom_template_path=custom_template_path, meta=meta, file_encoding=file_encoding
+    )
     if isinstance(project, GeneratorError):
         return [project]
     return project.update()

openapi_python_client/cli.py

@@ -1,3 +1,4 @@
+import codecs
 import pathlib
 from pprint import pformat
 from typing import Optional, Sequence
@@ -116,7 +117,7 @@ def generate(
     url: Optional[str] = typer.Option(None, help="A URL to read the JSON from"),
     path: Optional[pathlib.Path] = typer.Option(None, help="A path to the JSON file"),
     custom_template_path: Optional[pathlib.Path] = typer.Option(None, **custom_template_path_options),  # type: ignore
-    encoding: Optional[str] = typer.Option(None, help="Set file encoding for client files"),  # type: ignore
+    file_encoding: str = typer.Option("utf-8", help="Encoding used when writing generated"),
     meta: MetaType = _meta_option,
 ) -> None:
     """ Generate a new OpenAPI Client library """
@@ -128,8 +129,15 @@ def generate(
     if url and path:
         typer.secho("Provide either --url or --path, not both", fg=typer.colors.RED)
         raise typer.Exit(code=1)
+
+    try:
+        codecs.getencoder(file_encoding)
+    except LookupError:
+        typer.secho("Unknown encoding : {}".format(file_encoding), fg=typer.colors.RED)
+        raise typer.Exit(code=1)
+
     errors = create_new_client(
-        url=url, path=path, meta=meta, custom_template_path=custom_template_path, encoding=encoding
+        url=url, path=path, meta=meta, custom_template_path=custom_template_path, file_encoding=file_encoding
     )
     handle_errors(errors)
 
@@ -140,6 +148,7 @@ def update(
     path: Optional[pathlib.Path] = typer.Option(None, help="A path to the JSON file"),
     custom_template_path: Optional[pathlib.Path] = typer.Option(None, **custom_template_path_options),  # type: ignore
     meta: MetaType = _meta_option,
+    file_encoding: str = typer.Option("utf-8", help="Encoding used when writing generated"),
 ) -> None:
     """ Update an existing OpenAPI Client library """
     from . import update_existing_client
@@ -151,5 +160,13 @@ def update(
         typer.secho("Provide either --url or --path, not both", fg=typer.colors.RED)
         raise typer.Exit(code=1)
 
-    errors = update_existing_client(url=url, path=path, meta=meta, custom_template_path=custom_template_path)
+    try:
+        codecs.getencoder(file_encoding)
+    except LookupError:
+        typer.secho("Unknown encoding : {}".format(file_encoding), fg=typer.colors.RED)
+        raise typer.Exit(code=1)
+
+    errors = update_existing_client(
+        url=url, path=path, meta=meta, custom_template_path=custom_template_path, file_encoding=file_encoding
+    )
     handle_errors(errors)

tests/test___init__.py

@@ -23,7 +23,9 @@ def test__get_project_for_url_or_path(mocker):
 
     _get_document.assert_called_once_with(url=url, path=path)
     from_dict.assert_called_once_with(data_dict)
-    _Project.assert_called_once_with(openapi=openapi, custom_template_path=None, meta=MetaType.POETRY, encoding=None)
+    _Project.assert_called_once_with(
+        openapi=openapi, custom_template_path=None, meta=MetaType.POETRY, file_encoding="utf-8"
+    )
     assert project == _Project.return_value
 
 
@@ -76,7 +78,7 @@ def test_create_new_client(mocker):
     result = create_new_client(url=url, path=path, meta=MetaType.POETRY)
 
     _get_project_for_url_or_path.assert_called_once_with(
-        url=url, path=path, custom_template_path=None, meta=MetaType.POETRY, encoding=None
+        url=url, path=path, custom_template_path=None, meta=MetaType.POETRY, file_encoding="utf-8"
     )
     project.build.assert_called_once()
     assert result == project.build.return_value
@@ -95,7 +97,7 @@ def test_create_new_client_project_error(mocker):
     result = create_new_client(url=url, path=path, meta=MetaType.POETRY)
 
     _get_project_for_url_or_path.assert_called_once_with(
-        url=url, path=path, custom_template_path=None, meta=MetaType.POETRY, encoding=None
+        url=url, path=path, custom_template_path=None, meta=MetaType.POETRY, file_encoding="utf-8"
     )
     assert result == [error]
 
@@ -113,7 +115,7 @@ def test_update_existing_client(mocker):
     result = update_existing_client(url=url, path=path, meta=MetaType.POETRY)
 
     _get_project_for_url_or_path.assert_called_once_with(
-        url=url, path=path, custom_template_path=None, meta=MetaType.POETRY
+        url=url, path=path, custom_template_path=None, meta=MetaType.POETRY, file_encoding="utf-8"
     )
     project.update.assert_called_once()
     assert result == project.update.return_value
@@ -132,7 +134,7 @@ def test_update_existing_client_project_error(mocker):
     result = update_existing_client(url=url, path=path, meta=MetaType.POETRY)
 
     _get_project_for_url_or_path.assert_called_once_with(
-        url=url, path=path, custom_template_path=None, meta=MetaType.POETRY
+        url=url, path=path, custom_template_path=None, meta=MetaType.POETRY, file_encoding="utf-8"
     )
     assert result == [error]
 
@@ -392,9 +394,9 @@ def test__build_metadata_poetry(self, mocker):
             project_name=project.project_name,
             package_name=project.package_name,
         )
-        readme_path.write_text.assert_called_once_with(readme_template.render(), encoding=None)
+        readme_path.write_text.assert_called_once_with(readme_template.render(), encoding="utf-8")
         git_ignore_template.render.assert_called_once()
-        git_ignore_path.write_text.assert_called_once_with(git_ignore_template.render(), encoding=None)
+        git_ignore_path.write_text.assert_called_once_with(git_ignore_template.render(), encoding="utf-8")
         project._build_pyproject_toml.assert_called_once_with(use_poetry=True)
 
     def test__build_metadata_setup(self, mocker):
@@ -429,9 +431,9 @@ def test__build_metadata_setup(self, mocker):
             project_name=project.project_name,
             package_name=project.package_name,
         )
-        readme_path.write_text.assert_called_once_with(readme_template.render(), encoding=None)
+        readme_path.write_text.assert_called_once_with(readme_template.render(), encoding="utf-8")
         git_ignore_template.render.assert_called_once()
-        git_ignore_path.write_text.assert_called_once_with(git_ignore_template.render(), encoding=None)
+        git_ignore_path.write_text.assert_called_once_with(git_ignore_template.render(), encoding="utf-8")
         project._build_pyproject_toml.assert_called_once_with(use_poetry=False)
         project._build_setup_py.assert_called_once()
 
@@ -475,7 +477,7 @@ def test__build_pyproject_toml(self, mocker, use_poetry):
             version=project.version,
             description=project.package_description,
         )
-        pyproject_path.write_text.assert_called_once_with(pyproject_template.render(), encoding=None)
+        pyproject_path.write_text.assert_called_once_with(pyproject_template.render(), encoding="utf-8")
 
     def test__build_setup_py(self, mocker):
         from openapi_python_client import MetaType, Project
@@ -505,7 +507,7 @@ def test__build_setup_py(self, mocker):
             version=project.version,
             description=project.package_description,
         )
-        setup_path.write_text.assert_called_once_with(setup_template.render(), encoding=None)
+        setup_path.write_text.assert_called_once_with(setup_template.render(), encoding="utf-8")
 
 
 def test__reformat(mocker):

tests/test_cli.py

@@ -31,16 +31,18 @@ def test_config_arg(mocker, _create_new_client):
 
     config_path = "config/path"
     path = "cool/path"
-    encoding = "utf-8"
+    file_encoding = "utf-8"
 
     result = runner.invoke(
-        app, [f"--config={config_path}", "generate", f"--path={path}", f"--encoding={encoding}"], catch_exceptions=False
+        app,
+        [f"--config={config_path}", "generate", f"--path={path}", f"--file-encoding={file_encoding}"],
+        catch_exceptions=False,
     )
 
     assert result.exit_code == 0
     load_config.assert_called_once_with(path=Path(config_path))
     _create_new_client.assert_called_once_with(
-        url=None, path=Path(path), custom_template_path=None, meta=MetaType.POETRY, encoding="utf-8"
+        url=None, path=Path(path), custom_template_path=None, meta=MetaType.POETRY, file_encoding="utf-8"
     )
 
 
@@ -86,7 +88,7 @@ def test_generate_url(self, _create_new_client):
 
         assert result.exit_code == 0
         _create_new_client.assert_called_once_with(
-            url=url, path=None, custom_template_path=None, meta=MetaType.POETRY, encoding=None
+            url=url, path=None, custom_template_path=None, meta=MetaType.POETRY, file_encoding="utf-8"
         )
 
     def test_generate_path(self, _create_new_client):
@@ -97,7 +99,7 @@ def test_generate_path(self, _create_new_client):
 
         assert result.exit_code == 0
         _create_new_client.assert_called_once_with(
-            url=None, path=Path(path), custom_template_path=None, meta=MetaType.POETRY, encoding=None
+            url=None, path=Path(path), custom_template_path=None, meta=MetaType.POETRY, file_encoding="utf-8"
         )
 
     def test_generate_meta(self, _create_new_client):
@@ -108,19 +110,19 @@ def test_generate_meta(self, _create_new_client):
 
         assert result.exit_code == 0
         _create_new_client.assert_called_once_with(
-            url=None, path=Path(path), custom_template_path=None, meta=MetaType.NONE, encoding=None
+            url=None, path=Path(path), custom_template_path=None, meta=MetaType.NONE, file_encoding="utf-8"
         )
 
     def test_generate_encoding(self, _create_new_client):
         path = "cool/path"
         encoding = "utf-8"
         from openapi_python_client.cli import MetaType, app
 
-        result = runner.invoke(app, ["generate", f"--path={path}", f"--encoding={encoding}"])
+        result = runner.invoke(app, ["generate", f"--path={path}", f"--file-encoding={encoding}"])
 
         assert result.exit_code == 0
         _create_new_client.assert_called_once_with(
-            url=None, path=Path(path), custom_template_path=None, meta=MetaType.POETRY, encoding="utf-8"
+            url=None, path=Path(path), custom_template_path=None, meta=MetaType.POETRY, file_encoding="utf-8"
         )
 
     def test_generate_handle_errors(self, _create_new_client):
@@ -192,7 +194,7 @@ def test_update_url(self, _update_existing_client):
 
         assert result.exit_code == 0
         _update_existing_client.assert_called_once_with(
-            url=url, path=None, custom_template_path=None, meta=MetaType.POETRY
+            url=url, path=None, custom_template_path=None, meta=MetaType.POETRY, file_encoding="utf-8"
         )
 
     def test_update_path(self, _update_existing_client):
@@ -203,5 +205,5 @@ def test_update_path(self, _update_existing_client):
 
         assert result.exit_code == 0
         _update_existing_client.assert_called_once_with(
-            url=None, path=Path(path), custom_template_path=None, meta=MetaType.POETRY
+            url=None, path=Path(path), custom_template_path=None, meta=MetaType.POETRY, file_encoding="utf-8"
         )