add Python generator config setting for backwards compatibility

Author: ctreatma

bin/configs/python-aiohttp.yaml

@@ -8,6 +8,7 @@ additionalProperties:
   mapNumberTo: float
   poetry1: true
   disallowAdditionalPropertiesIfNotPresent: true
+  legacyDisallowAdditionalPropertiesDefaultBehavior: true
 nameMappings:
   _type: underscore_type
   type_: type_with_underscore

bin/configs/python-echo-api.yaml

@@ -5,3 +5,4 @@ templateDir: modules/openapi-generator/src/main/resources/python
 additionalProperties:
   hideGenerationTimestamp: "true"
   disallowAdditionalPropertiesIfNotPresent: true
+  legacyDisallowAdditionalPropertiesDefaultBehavior: true

bin/configs/python-fastapi.yaml

@@ -6,3 +6,4 @@ sourceFolder: "src"
 additionalProperties:
   hideGenerationTimestamp: "true"
   disallowAdditionalPropertiesIfNotPresent: true
+  legacyDisallowAdditionalPropertiesDefaultBehavior: true

bin/configs/python-httpx.yaml

@@ -7,6 +7,8 @@ additionalProperties:
   packageName: petstore_api
   mapNumberTo: float
   poetry1: false
+  disallowAdditionalPropertiesIfNotPresent: true
+  legacyDisallowAdditionalPropertiesDefaultBehavior: true
 nameMappings:
   _type: underscore_type
   type_: type_with_underscore

bin/configs/python-pydantic-v1-aiohttp.yaml

@@ -7,3 +7,4 @@ additionalProperties:
   packageName: petstore_api
   mapNumberTo: float
   disallowAdditionalPropertiesIfNotPresent: true
+  legacyDisallowAdditionalPropertiesDefaultBehavior: true

bin/configs/python-pydantic-v1-echo-api.yaml

@@ -5,3 +5,4 @@ templateDir: modules/openapi-generator/src/main/resources/python-pydantic-v1
 additionalProperties:
   hideGenerationTimestamp: "true"
   disallowAdditionalPropertiesIfNotPresent: true
+  legacyDisallowAdditionalPropertiesDefaultBehavior: true

bin/configs/spring-boot-oneof-interface.yaml

@@ -10,3 +10,4 @@ additionalProperties:
   hideGenerationTimestamp: "true"
   useOneOfInterfaces: "true"
   useDeductionForOneOfInterfaces: "true"
+  disallowAdditionalPropertiesIfNotPresent: "true"

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

@@ -403,6 +403,10 @@ public static enum ENUM_PROPERTY_NAMING_TYPE {camelCase, PascalCase, snake_case,
     public static final String LEGACY_DISCRIMINATOR_BEHAVIOR = "legacyDiscriminatorBehavior";
     public static final String LEGACY_DISCRIMINATOR_BEHAVIOR_DESC = "Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).";
 
+    public static final String LEGACY_DEFAULT_DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT_BEHAVIOR = "legacyDisallowAdditionalPropertiesDefaultBehavior";
+    public static final String LEGACY_DEFAULT_DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT_BEHAVIOR_DESC = "Set to true for Python generators so that generated code matches what was previously produced when `disallowAdditionalProperties` was unspecified";
+
+
     public static final String USE_SINGLE_REQUEST_PARAMETER = "useSingleRequestParameter";
     public static final String USE_SINGLE_REQUEST_PARAMETER_DESC = "Setting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.";
 

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

@@ -54,6 +54,8 @@ public abstract class AbstractPythonCodegen extends DefaultCodegen implements Co
     protected String packageName = "openapi_client";
     @Setter protected String packageVersion = "1.0.0";
     @Setter protected String projectName; // for setup.py, e.g. petstore-api
+    @Setter
+    protected boolean legacyDisallowAdditionalPropertiesDefaultBehavior = false;
     protected boolean hasModelsToImport = Boolean.FALSE;
     protected String mapNumberTo = "Union[StrictFloat, StrictInt]";
     protected Map<Character, String> regexModifiers;
@@ -150,6 +152,10 @@ public AbstractPythonCodegen() {
     public void processOpts() {
         super.processOpts();
 
+        if (additionalProperties.containsKey(CodegenConstants.LEGACY_DEFAULT_DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT_BEHAVIOR)) {
+            setLegacyDisallowAdditionalPropertiesDefaultBehavior(Boolean.parseBoolean(additionalProperties.get(CodegenConstants.LEGACY_DEFAULT_DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT_BEHAVIOR).toString()));
+        }
+
         if (StringUtils.isEmpty(System.getenv("PYTHON_POST_PROCESS_FILE"))) {
             LOGGER.info("Environment variable PYTHON_POST_PROCESS_FILE not defined so the Python code may not be properly formatted. To define it, try 'export PYTHON_POST_PROCESS_FILE=\"/usr/local/bin/yapf -i\"' (Linux/Mac)");
             LOGGER.info("NOTE: To enable file post-processing, 'enablePostProcessFile' must be set to `true` (--enable-post-process-file for CLI).");
@@ -991,6 +997,10 @@ private ModelsMap postProcessModelsMap(ModelsMap objs) {
             // set the extensions if the key is absent
             model.getVendorExtensions().putIfAbsent("x-py-readonly", readOnlyFields);
 
+            if (legacyDisallowAdditionalPropertiesDefaultBehavior) {
+                model.vendorExtensions.putIfAbsent("x-py-legacy-disallow-additional-properties-default-behavior", true);
+            }
+
             // remove the items of postponedModelImports in modelImports to avoid circular imports error
             if (!modelImports.isEmpty() && !postponedModelImports.isEmpty()) {
                 modelImports.removeAll(postponedModelImports);

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

@@ -51,6 +51,8 @@ public abstract class AbstractPythonPydanticV1Codegen extends DefaultCodegen imp
     protected String packageName = "openapi_client";
     @Setter protected String packageVersion = "1.0.0";
     @Setter protected String projectName; // for setup.py, e.g. petstore-api
+    @Setter
+    protected boolean legacyDisallowAdditionalPropertiesDefaultBehavior = false;
     protected boolean hasModelsToImport = Boolean.FALSE;
     protected String mapNumberTo = "Union[StrictFloat, StrictInt]";
     protected Map<Character, String> regexModifiers;
@@ -140,6 +142,10 @@ public AbstractPythonPydanticV1Codegen() {
     public void processOpts() {
         super.processOpts();
 
+        if (additionalProperties.containsKey(CodegenConstants.LEGACY_DEFAULT_DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT_BEHAVIOR)) {
+            setLegacyDisallowAdditionalPropertiesDefaultBehavior(Boolean.parseBoolean(additionalProperties.get(CodegenConstants.LEGACY_DEFAULT_DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT_BEHAVIOR).toString()));
+        }
+
         if (StringUtils.isEmpty(System.getenv("PYTHON_POST_PROCESS_FILE"))) {
             LOGGER.info("Environment variable PYTHON_POST_PROCESS_FILE not defined so the Python code may not be properly formatted. To define it, try 'export PYTHON_POST_PROCESS_FILE=\"/usr/local/bin/yapf -i\"' (Linux/Mac)");
             LOGGER.info("NOTE: To enable file post-processing, 'enablePostProcessFile' must be set to `true` (--enable-post-process-file for CLI).");
@@ -985,6 +991,10 @@ private ModelsMap postProcessModelsMap(ModelsMap objs) {
             model.getVendorExtensions().putIfAbsent("x-py-datetime-imports", datetimeImports);
             model.getVendorExtensions().putIfAbsent("x-py-readonly", readOnlyFields);
 
+            if (legacyDisallowAdditionalPropertiesDefaultBehavior) {
+                model.vendorExtensions.putIfAbsent("x-py-legacy-disallow-additional-properties-default-behavior", true);
+            }
+
             // remove the items of postponedModelImports in modelImports to avoid circular imports error
             if (!modelImports.isEmpty() && !postponedModelImports.isEmpty()) {
                 modelImports.removeAll(postponedModelImports);