- Added environment variable possibility for APIConfig

- Adapted template for APIConfig to support this
- Moved to functions for access_token
- Adapted tests to reflect this

Author: MarcoMuellner

Dockerfile

@@ -62,7 +62,6 @@ Please see the [Quick start page] for details.
 - Support for multiple languages
 - Support for multiple authentication schemes
 - Support custom themes
-- Support environment variables and .env files
 
 ## Contributing
 

README.md

@@ -22,20 +22,27 @@
     type=AutoFormat,
     help="Option to choose which auto formatter is applied.",
 )
+@click.option(
+    "--env-token-name",
+    default=None,
+    help="Name of the environment variable that contains the token. If you set this, the code expects this environment "
+    "variable to be set and will raise an error if it is not.",
+)
 @click.version_option(version=__version__)
 def main(
     source: str,
     output: str,
     library: Optional[HTTPLibrary] = HTTPLibrary.httpx,
     autoformat: Optional[AutoFormat] = AutoFormat.black,
+    env_token_name: Optional[str] = None,
 ) -> None:
     """
     Generate Python code from an OpenAPI 3.0 specification.
 
     Provide a SOURCE (file or URL) containing the OpenAPI 3 specification and
     an OUTPUT path, where the resulting client is created.
     """
-    generate_data(source, output, library, autoformat)
+    generate_data(source, output, library, autoformat, env_token_name)
 
 
 if __name__ == "__main__":  # pragma: no cover

src/openapi_python_generator/__main__.py

@@ -142,11 +142,12 @@ def generate_data(
     output: Union[str, Path],
     library: Optional[HTTPLibrary] = HTTPLibrary.httpx,
     autoformat: Optional[AutoFormat] = AutoFormat.black,
+    env_token_name: Optional[str] = None,
 ) -> None:
     """
     Generate Python code from an OpenAPI 3.0 specification.
     """
     data = get_open_api(source)
     click.echo(f"Generating data from {source}")
-    result = generator(data, library_config_dict[library])
+    result = generator(data, library_config_dict[library], env_token_name)
     write_data(result, output, autoformat)

src/openapi_python_generator/generate_data.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from openapi_schema_pydantic import OpenAPI
 
 from openapi_python_generator.language_converters.python.jinja_config import (
@@ -7,12 +9,16 @@
 from openapi_python_generator.models import APIConfig
 
 
-def generate_api_config(data: OpenAPI) -> APIConfig:
+def generate_api_config(
+    data: OpenAPI, env_token_name: Optional[str] = None
+) -> APIConfig:
     """
     Generate the API model.
     """
     return APIConfig(
         file_name="api_config",
-        content=JINJA_ENV.get_template(API_CONFIG_TEMPLATE).render(**data.dict()),
+        content=JINJA_ENV.get_template(API_CONFIG_TEMPLATE).render(
+            env_token_name=env_token_name, **data.dict()
+        ),
         base_url=data.servers[0].url,
     )

src/openapi_python_generator/language_converters/python/api_config_generator.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from openapi_schema_pydantic import OpenAPI
 
 from openapi_python_generator.language_converters.python.api_config_generator import (
@@ -12,14 +14,16 @@
 from openapi_python_generator.models import ConversionResult, LibraryConfig
 
 
-def generator(data: OpenAPI, library_config: LibraryConfig) -> ConversionResult:
+def generator(
+    data: OpenAPI, library_config: LibraryConfig, env_token_name: Optional[str] = None
+) -> ConversionResult:
     """
     Generate Python code from an OpenAPI 3.0 specification.
     """
 
     models = generate_models(data.components)
     services = generate_services(data.paths, library_config)
-    api_config = generate_api_config(data)
+    api_config = generate_api_config(data, env_token_name)
 
     return ConversionResult(
         models=models,

src/openapi_python_generator/language_converters/python/generator.py

@@ -1,3 +1,28 @@
+{% if env_token_name is not none %}import os{% endif %}
+
+from typing import Optional
+
 class APIConfig():
     base_path: str = '{{ servers[0].url }}'
-    access_token: str = None
+{% if env_token_name is none %}
+    _access_token : Optional[str] = None
+{% endif %}
+
+    @staticmethod
+    def get_access_token() -> Optional[str]:
+{% if env_token_name is not none %}
+        try:
+            return os.environ['{{ env_token_name }}']
+        except KeyError:
+            return None
+{% else %}
+        return APIConfig._access_token
+{% endif %}
+
+    @staticmethod
+    def set_access_token(value : str):
+{% if env_token_name is not none %}
+        raise Exception("This client was generated with an environment variable for the access token. Please set the environment variable '{{ env_token_name }}' to the access token.")
+{% else %}
+        _access_token = value
+{% endif %}

src/openapi_python_generator/language_converters/python/templates/apiconfig.jinja2

@@ -4,7 +4,7 @@
     headers = {
         'Content-Type': 'application/json',
         'Accept': 'application/json',
-        'Authorization': f'Bearer { APIConfig.access_token }',
+        'Authorization': f'Bearer { APIConfig.get_access_token() }',
     }
     query_params = {
     {% if query_params|length > 0 %}

src/openapi_python_generator/language_converters/python/templates/httpx.jinja2

@@ -4,7 +4,7 @@ def {{ operation_id }}({{ params | join(',') }}) -> {% if return_type.type is no
     headers = {
         'Content-Type': 'application/json',
         'Accept': 'application/json',
-        'Authorization': f'Bearer { APIConfig.access_token }',
+        'Authorization': f'Bearer { APIConfig.get_access_token() }',
     }
     query_params = {
     {% if query_params|length > 0 %}

src/openapi_python_generator/language_converters/python/templates/requests.jinja2

@@ -1,5 +1,6 @@
 import json
 from datetime import datetime
+import os
 
 import orjson
 import pytest
@@ -12,6 +13,31 @@
 from openapi_python_generator.language_converters.python.generator import generator
 
 
+def test_get_auth_token_without_env(model_data_with_cleanup):
+    generate_data(test_data_path, test_result_path)
+
+    _locals = locals()
+
+    exec(
+        "from .test_result import *\nassert APIConfig.get_access_token() is None",
+        globals(),
+        _locals,
+    )
+
+
+def test_get_auth_token_with_env(model_data_with_cleanup):
+    generate_data(test_data_path, test_result_path, env_token_name="MY_TOKEN")
+
+    _locals = locals()
+
+    # Need to reload test_result, because older tests may have already been loaded and that would cause an error
+    exec(
+        "import test_result\nimport importlib\nimportlib.reload(test_result)\nimport os\nos.environ['MY_TOKEN'] = 'my_token'\nassert test_result.APIConfig.get_access_token() == 'my_token'",
+        globals(),
+        _locals,
+    )
+
+
 @pytest.mark.parametrize(
     "library",
     [