python: feature flag for lazy imports (OpenAPITools#21885)

* python: feature flag for lazy imports

* python: update samples

* python: add python-lazyImports to test job

* python: reuse tests in lazyImports sample

* python: avoid using non-imported submodules

* add normalizer option

---------

Co-authored-by: Pascal Bachor <[email protected]>
Co-authored-by: William Cheng <[email protected]>

Author: 2 people

.github/workflows/samples-python-petstore.yaml

@@ -35,6 +35,7 @@ jobs:
         sample:
           - samples/openapi3/client/petstore/python-aiohttp
           - samples/openapi3/client/petstore/python
+          - samples/openapi3/client/petstore/python-lazyImports
     services:
       petstore-api:
         image: swaggerapi/petstore

bin/configs/python-lazyImports.yaml

@@ -0,0 +1,18 @@
+generatorName: python
+outputDir: samples/openapi3/client/petstore/python-lazyImports
+inputSpec: modules/openapi-generator/src/test/resources/3_0/python/petstore-with-fake-endpoints-models-for-testing.yaml
+templateDir: modules/openapi-generator/src/main/resources/python
+additionalProperties:
+  packageName: petstore_api
+  useOneOfDiscriminatorLookup: "true"
+  disallowAdditionalPropertiesIfNotPresent: false
+  mapNumberTo: StrictFloat
+  lazyImports: 'true'
+nameMappings:
+  _type: underscore_type
+  type_: type_with_underscore
+modelNameMappings:
+  # The OpenAPI spec ApiResponse conflicts with the internal ApiResponse
+  ApiResponse: ModelApiResponse
+openapiNormalizer:
+  SIMPLIFY_ONEOF_ANYOF_ENUM: false

docs/generators/python.md

@@ -24,6 +24,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|true|
 |generateSourceCodeOnly|Specifies that only a library source code is to be generated.| |false|
 |hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
+|lazyImports|Enable lazy imports.| |false|
 |library|library template (sub-template) to use: asyncio, tornado (deprecated), urllib3| |urllib3|
 |mapNumberTo|Map number to Union[StrictFloat, StrictInt], StrictStr or float.| |Union[StrictFloat, StrictInt]|
 |packageName|python package name (convention: snake_case).| |openapi_client|

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PythonClientCodegen.java

@@ -48,6 +48,7 @@ public class PythonClientCodegen extends AbstractPythonCodegen implements Codege
     public static final String DATE_FORMAT = "dateFormat";
     public static final String SET_ENSURE_ASCII_TO_FALSE = "setEnsureAsciiToFalse";
     public static final String POETRY1_FALLBACK = "poetry1";
+    public static final String LAZY_IMPORTS = "lazyImports";
 
     @Setter protected String packageUrl;
     protected String apiDocPath = "docs/";
@@ -151,6 +152,7 @@ public PythonClientCodegen() {
                 .defaultValue("%Y-%m-%d"));
         cliOptions.add(new CliOption(CodegenConstants.USE_ONEOF_DISCRIMINATOR_LOOKUP, CodegenConstants.USE_ONEOF_DISCRIMINATOR_LOOKUP_DESC).defaultValue("false"));
         cliOptions.add(new CliOption(POETRY1_FALLBACK, "Fallback to formatting pyproject.toml to Poetry 1.x format."));
+        cliOptions.add(new CliOption(LAZY_IMPORTS, "Enable lazy imports.").defaultValue(Boolean.FALSE.toString()));
 
         supportedLibraries.put("urllib3", "urllib3-based client");
         supportedLibraries.put("asyncio", "asyncio-based client");
@@ -264,6 +266,10 @@ public void processOpts() {
             additionalProperties.put(DATE_FORMAT, dateFormat);
         }
 
+        if (additionalProperties.containsKey(LAZY_IMPORTS)) {
+            additionalProperties.put(LAZY_IMPORTS, Boolean.valueOf(additionalProperties.get(LAZY_IMPORTS).toString()));
+        }
+
         String modelPath = packagePath() + File.separatorChar + modelPackage.replace('.', File.separatorChar);
         String apiPath = packagePath() + File.separatorChar + apiPackage.replace('.', File.separatorChar);
 

modules/openapi-generator/src/main/resources/python/__init__api.mustache

@@ -1,6 +1,9 @@
 # flake8: noqa
 
-if __import__("typing").TYPE_CHECKING:
+{{^lazyImports}}
+{{>exports_api}}
+{{/lazyImports}}
+{{#lazyImports}}if __import__("typing").TYPE_CHECKING:
     {{>exports_api}}
 else:
     from lazy_imports import LazyModule, as_package, load
@@ -13,3 +16,4 @@ else:
             doc=__doc__,
         )
     )
+{{/lazyImports}}

modules/openapi-generator/src/main/resources/python/__init__model.mustache

@@ -3,8 +3,10 @@
 # flake8: noqa
 {{>partial_header}}
 
-
-if __import__("typing").TYPE_CHECKING:
+{{^lazyImports}}
+{{>exports_model}}
+{{/lazyImports}}
+{{#lazyImports}}if __import__("typing").TYPE_CHECKING:
     {{>exports_model}}
 else:
     from lazy_imports import LazyModule, as_package, load
@@ -17,3 +19,4 @@ else:
             doc=__doc__,
         )
     )
+{{/lazyImports}}

modules/openapi-generator/src/main/resources/python/__init__package.mustache

@@ -24,7 +24,10 @@ __all__ = [
     {{/-last}}{{#-last}},{{/-last}}{{/model}}{{/models}}
 ]
 
-if __import__("typing").TYPE_CHECKING:
+{{^lazyImports}}
+{{>exports_package}}
+{{/lazyImports}}
+{{#lazyImports}}if __import__("typing").TYPE_CHECKING:
     {{>exports_package}}
 else:
     from lazy_imports import LazyModule, as_package, load
@@ -39,6 +42,7 @@ else:
             doc=__doc__,
         )
     )
+{{/lazyImports}}
 {{#recursionLimit}}
 
 __import__('sys').setrecursionlimit({{{.}}})

modules/openapi-generator/src/main/resources/python/pyproject.mustache

@@ -48,7 +48,9 @@ pycryptodome = ">= 3.9.0"
 {{/hasHttpSignatureMethods}}
 pydantic = ">= 2"
 typing-extensions = ">= 4.7.1"
+{{#lazyImports}}
 lazy-imports = ">= 1, < 2"
+{{/lazyImports}}
 {{/poetry1}}
 {{^poetry1}}
 requires-python = ">=3.9"
@@ -69,7 +71,9 @@ dependencies = [
 {{/hasHttpSignatureMethods}}
   "pydantic (>=2)",
   "typing-extensions (>=4.7.1)",
+{{#lazyImports}}
   "lazy-imports (>=1,<2)"
+{{/lazyImports}}
 ]
 
 [project.urls]

modules/openapi-generator/src/main/resources/python/requirements.mustache

@@ -13,4 +13,6 @@ pycryptodome >= 3.9.0
 {{/hasHttpSignatureMethods}}
 pydantic >= 2
 typing-extensions >= 4.7.1
+{{#lazyImports}}
 lazy-imports >= 1, < 2
+{{/lazyImports}}

modules/openapi-generator/src/main/resources/python/setup.mustache

@@ -30,7 +30,9 @@ REQUIRES = [
 {{/hasHttpSignatureMethods}}
     "pydantic >= 2",
     "typing-extensions >= 4.7.1",
+{{#lazyImports}}
     "lazy-imports >= 1, < 2",
+{{/lazyImports}}
 ]
 
 setup(