();
+
+ if (i != -1) {
+ for (char c : pattern.substring(i).toCharArray()) {
+ if (regexModifiers.containsKey(c)) {
+ String modifier = regexModifiers.get(c);
+ modifiers.add(modifier);
+ }
+ }
+ }
+
+ vendorExtensions.put("x-regex", regex);
+ vendorExtensions.put("x-modifiers", modifiers);
+ }
+ }
+
+ @Override
+ public CodegenType getTag() {
+ return CodegenType.CLIENT;
+ }
+
+ @Override
+ public String apiDocFileFolder() {
+ return (outputFolder + "/" + apiDocPath);
+ }
+
+ @Override
+ public String modelDocFileFolder() {
+ return (outputFolder + "/" + modelDocPath);
+ }
+
+ @Override
+ public String toModelDocFilename(String name) {
+ return toModelName(name);
+ }
+
+ @Override
+ public String toApiDocFilename(String name) {
+ return toApiName(name);
+ }
+
+ @Override
+ public String addRegularExpressionDelimiter(String pattern) {
+ if (StringUtils.isEmpty(pattern)) {
+ return pattern;
+ }
+
+ if (!pattern.matches("^/.*")) {
+ // Perform a negative lookbehind on each `/` to ensure that it is escaped.
+ return "/" + pattern.replaceAll("(?=3.6"; };
+ public String apiFileFolder() {
+ return outputFolder + File.separatorChar + packagePath() + File.separatorChar + apiPackage() + File.separatorChar + "tags";
+ }
+
+ @Override
+ public String modelFileFolder() {
+ return outputFolder + File.separatorChar + packagePath() + File.separatorChar + modelPackage();
+ }
+
+ @Override
+ public String apiTestFileFolder() {
+ return outputFolder + File.separatorChar + testFolder;
+ }
+
+ @Override
+ public String modelTestFileFolder() {
+ return outputFolder + File.separatorChar + testFolder + File.separatorChar + "test_models";
+ }
+
+ public void setUseNose(String val) {
+ this.useNose = Boolean.parseBoolean(val);
+ }
+
+ @Override
+ public boolean getUseInlineModelResolver() { return useInlineModelResolver; }
+
+ public void setUseInlineModelResolver(String val) {
+ this.useInlineModelResolver = Boolean.parseBoolean(val);
+ }
+
+ public void setPackageUrl(String packageUrl) {
+ this.packageUrl = packageUrl;
+ }
+
+ public String packagePath() {
+ return packageName.replace('.', File.separatorChar);
+ }
+
+ /**
+ * Generate Python package name from String `packageName`
+ *
+ * (PEP 0008) Python packages should also have short, all-lowercase names,
+ * although the use of underscores is discouraged.
+ *
+ * @param packageName Package name
+ * @return Python package name that conforms to PEP 0008
+ */
+ @SuppressWarnings("static-method")
+ public String generatePackageName(String packageName) {
+ return underscore(packageName.replaceAll("[^\\w]+", ""));
+ }
+
+ /**
+ * A custom version of this method is needed to ensure that the form object parameter is kept as-is
+ * as an object and is not exploded into separate parameters
+ * @param body the body that is being handled
+ * @param imports the imports for this body
+ * @return the list of length one containing a single type object CodegenParameter
+ */
+ @Override
+ public List fromRequestBodyToFormParameters(RequestBody body, Set imports) {
+ List parameters = new ArrayList<>();
+ LOGGER.debug("debugging fromRequestBodyToFormParameters= {}", body);
+ Schema schema = ModelUtils.getSchemaFromRequestBody(body);
+ schema = ModelUtils.getReferencedSchema(this.openAPI, schema);
+ CodegenParameter cp = fromFormProperty("body", schema, imports);
+ cp.setContent(getContent(body.getContent(), imports, "RequestBody"));
+ cp.isFormParam = false;
+ cp.isBodyParam = true;
+ parameters.add(cp);
+ return parameters;
+ }
+
+ /**
+ * Custom version of this method so we can move the body parameter into bodyParam
+ *
+ * @param path the path of the operation
+ * @param httpMethod HTTP method
+ * @param operation OAS operation object
+ * @param servers list of servers
+ * @return the resultant CodegenOperation instance
+ */
+ @Override
+ public CodegenOperation fromOperation(String path,
+ String httpMethod,
+ Operation operation,
+ List servers) {
+ CodegenOperation co = super.fromOperation(path, httpMethod, operation, servers);
+ co.httpMethod = httpMethod.toLowerCase(Locale.ROOT);
+ // smuggle the path enum variable name in operationIdLowerCase
+ co.operationIdLowerCase = toEnumVarName(co.path, "str");
+ // smuggle pathModuleName in nickname
+ String pathModuleName = toVarName(path);
+ co.nickname = pathModuleName;
+ // smuggle path Api class name ins operationIdSnakeCase
+ co.operationIdSnakeCase = toModelName(path);
+
+ if (co.bodyParam == null) {
+ for (CodegenParameter cp: co.allParams) {
+ if (cp.isBodyParam) {
+ co.bodyParam = cp;
+ co.bodyParams.add(cp);
+ }
+ }
+ }
+ return co;
+ }
+
+ /**
+ * Custom version of this method to prevent mutation of
+ * codegenOperation.operationIdLowerCase/operationIdSnakeCase
+ * Property Usages:
+ * - operationId: endpoint method name when using tagged apis
+ * - httpMethod: endpoint method name when using path apis
+ * - operationIdCamelCase: Api class name containing single endpoint for tagged apis
+ * - operationIdLowerCase: (smuggled) path enum variable name
+ * - nickname: (smuggled) path module name for path apis
+ * - operationIdSnakeCase: (smuggled) path Api class name when using path apis
+ *
+ * @param tag name of the tag
+ * @param resourcePath path of the resource
+ * @param operation OAS Operation object
+ * @param co Codegen Operation object
+ * @param operations map of Codegen operations
+ */
+ @Override
+ @SuppressWarnings("static-method")
+ public void addOperationToGroup(String tag, String resourcePath, Operation operation, CodegenOperation
+ co, Map> operations) {
+ List opList = operations.get(tag);
+ if (opList == null) {
+ opList = new ArrayList<>();
+ operations.put(tag, opList);
+ }
+ // check for operationId uniqueness
+ String uniqueName = co.operationId;
+ int counter = 0;
+ for (CodegenOperation op : opList) {
+ if (uniqueName.equals(op.operationId)) {
+ uniqueName = co.operationId + "_" + counter;
+ counter++;
+ }
+ }
+ if (!co.operationId.equals(uniqueName)) {
+ LOGGER.warn("generated unique operationId `{}`", uniqueName);
+ }
+ co.operationId = uniqueName;
+ co.operationIdCamelCase = camelize(uniqueName);
+ opList.add(co);
+ co.baseName = tag;
+ }
+
+ @Override
+ public String defaultTemplatingEngine() {
+ return "handlebars";
+ }
+
+ @Override
+ public String generatorLanguageVersion() { return ">=3.7"; };
+
+ @Override
+ public void preprocessOpenAPI(OpenAPI openAPI) {
+ String originalSpecVersion;
+ String xOriginalSwaggerVersion = "x-original-swagger-version";
+ if (openAPI.getExtensions() != null && !openAPI.getExtensions().isEmpty() && openAPI.getExtensions().containsValue(xOriginalSwaggerVersion)) {
+ originalSpecVersion = (String) openAPI.getExtensions().get(xOriginalSwaggerVersion);
+ } else {
+ originalSpecVersion = openAPI.getOpenapi();
+ }
+ Integer specMajorVersion = Integer.parseInt(originalSpecVersion.substring(0, 1));
+ if (specMajorVersion < 3) {
+ throw new RuntimeException("Your spec version of "+originalSpecVersion+" is too low. python-experimental only works with specs with version >= 3.X.X. Please use a tool like Swagger Editor or Swagger Converter to convert your spec to v3");
+ }
+ }
+
+ /**
+ * Note: a custom version of this function is used so the original tag value can be used
+ *
+ * @param tag Tag
+ * @return the tag to use
+ */
+ @Override
+ public String sanitizeTag(String tag) {
+ return tag;
+ }
@Override
- protected void addImport(ComposedSchema composed, Schema childSchema, CodegenModel model, String modelName ) {
- // import everything (including child schema of a composed schema)
- addImport(model, modelName);
+ public void postProcess() {
+ System.out.println("################################################################################");
+ System.out.println("# Thanks for using OpenAPI Generator. #");
+ System.out.println("# Please consider donation to help us maintain this project \uD83D\uDE4F #");
+ System.out.println("# https://opencollective.com/openapi_generator/donate #");
+ System.out.println("# #");
+ System.out.println("# This generator was written by Justin Black (https://github.com/spacether) #");
+ System.out.println("# Please support his work directly via https://github.com/sponsors/spacether \uD83D\uDE4F#");
+ System.out.println("################################################################################");
}
}
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PythonExperimentalClientCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PythonExperimentalClientCodegen.java
deleted file mode 100644
index 391d1d823dab..000000000000
--- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PythonExperimentalClientCodegen.java
+++ /dev/null
@@ -1,2737 +0,0 @@
-/*
- * Copyright 2018 OpenAPI-Generator Contributors (https://openapi-generator.tech)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.openapitools.codegen.languages;
-
-import com.github.curiousoddman.rgxgen.RgxGen;
-import com.github.curiousoddman.rgxgen.config.RgxGenOption;
-import com.github.curiousoddman.rgxgen.config.RgxGenProperties;
-import com.google.common.base.CaseFormat;
-import io.swagger.v3.oas.models.OpenAPI;
-import io.swagger.v3.oas.models.Operation;
-import io.swagger.v3.oas.models.PathItem;
-import io.swagger.v3.oas.models.Paths;
-import io.swagger.v3.oas.models.servers.Server;
-import io.swagger.v3.oas.models.tags.Tag;
-
-import org.apache.commons.io.FileUtils;
-import org.openapitools.codegen.api.TemplatePathLocator;
-import org.openapitools.codegen.ignore.CodegenIgnoreProcessor;
-import org.openapitools.codegen.model.ModelMap;
-import org.openapitools.codegen.model.ModelsMap;
-import org.openapitools.codegen.model.OperationMap;
-import org.openapitools.codegen.model.OperationsMap;
-import org.openapitools.codegen.templating.*;
-import io.swagger.v3.core.util.Json;
-import io.swagger.v3.oas.models.media.*;
-import io.swagger.v3.oas.models.parameters.Parameter;
-import io.swagger.v3.oas.models.parameters.RequestBody;
-import io.swagger.v3.oas.models.security.SecurityScheme;
-import org.apache.commons.lang3.StringUtils;
-import org.openapitools.codegen.*;
-import org.openapitools.codegen.CodegenDiscriminator.MappedModel;
-import org.openapitools.codegen.api.TemplatingEngineAdapter;
-import org.openapitools.codegen.meta.GeneratorMetadata;
-import org.openapitools.codegen.meta.Stability;
-import org.openapitools.codegen.meta.features.*;
-import org.openapitools.codegen.utils.ModelUtils;
-import org.openapitools.codegen.utils.ProcessUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.openapitools.codegen.api.TemplateProcessor;
-
-import java.io.File;
-import java.io.IOException;
-import java.math.BigDecimal;
-import java.nio.file.Path;
-import java.time.OffsetDateTime;
-import java.time.ZoneOffset;
-import java.time.format.DateTimeFormatter;
-import java.util.*;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-import java.util.stream.Collectors;
-
-import static org.openapitools.codegen.utils.OnceLogger.once;
-import static org.openapitools.codegen.utils.StringUtils.camelize;
-import static org.openapitools.codegen.utils.StringUtils.underscore;
-
-public class PythonExperimentalClientCodegen extends AbstractPythonCodegen {
- private final Logger LOGGER = LoggerFactory.getLogger(PythonExperimentalClientCodegen.class);
-
- public static final String PACKAGE_URL = "packageUrl";
- public static final String DEFAULT_LIBRARY = "urllib3";
- // nose is a python testing framework, we use pytest if USE_NOSE is unset
- public static final String USE_NOSE = "useNose";
- public static final String RECURSION_LIMIT = "recursionLimit";
- public static final String USE_INLINE_MODEL_RESOLVER = "useInlineModelResolver";
-
- protected String packageUrl;
- protected String apiDocPath = "docs/apis/tags/";
- protected String modelDocPath = "docs/models/";
- protected boolean useNose = false;
- protected boolean useInlineModelResolver = false;
-
- protected Map regexModifiers;
-
- private String testFolder;
-
- // A cache to efficiently lookup a Schema instance based on the return value of `toModelName()`.
- private Map modelNameToSchemaCache;
- private DateTimeFormatter iso8601Date = DateTimeFormatter.ISO_DATE;
- private DateTimeFormatter iso8601DateTime = DateTimeFormatter.ISO_DATE_TIME;
-
- private String templateExtension;
- protected CodegenIgnoreProcessor ignoreProcessor;
- protected TemplateProcessor templateProcessor = null;
-
- // for apis.tags imports
- private Map tagModuleNameToApiClassname = new LinkedHashMap<>();
- // for apis.tags enum tag definition
- private Map enumToTag = new LinkedHashMap<>();
- // for apis.tags tag api definition
- private Map tagEnumToApiClassname = new LinkedHashMap<>();
-
- public PythonExperimentalClientCodegen() {
- super();
- loadDeepObjectIntoItems = false;
- importBaseType = false;
- addSchemaImportsFromV3SpecLocations = true;
- sortModelPropertiesByRequiredFlag = Boolean.TRUE;
- sortParamsByRequiredFlag = Boolean.TRUE;
- addSuffixToDuplicateOperationNicknames = false;
-
- modifyFeatureSet(features -> features
- .includeSchemaSupportFeatures(
- SchemaSupportFeature.Simple,
- SchemaSupportFeature.Composite,
- SchemaSupportFeature.Polymorphism,
- SchemaSupportFeature.Union,
- SchemaSupportFeature.allOf,
- SchemaSupportFeature.anyOf,
- SchemaSupportFeature.oneOf,
- SchemaSupportFeature.not
- )
- .includeDocumentationFeatures(DocumentationFeature.Readme)
- .wireFormatFeatures(EnumSet.of(WireFormatFeature.JSON, WireFormatFeature.Custom))
- .securityFeatures(EnumSet.of(
- SecurityFeature.BasicAuth,
- SecurityFeature.BearerToken,
- SecurityFeature.ApiKey,
- SecurityFeature.OAuth2_Implicit
- ))
- .includeDataTypeFeatures(
- DataTypeFeature.Null,
- DataTypeFeature.AnyType,
- DataTypeFeature.Uuid
- )
- .includeGlobalFeatures(
- GlobalFeature.ParameterizedServer,
- GlobalFeature.ParameterStyling
- )
- .excludeGlobalFeatures(
- GlobalFeature.XMLStructureDefinitions,
- GlobalFeature.Callbacks,
- GlobalFeature.LinkObjects
- )
- .excludeSchemaSupportFeatures(
- )
- .excludeParameterFeatures(
- ParameterFeature.Cookie
- )
- );
-
- // clear import mapping (from default generator) as python does not use it
- // at the moment
- importMapping.clear();
-
- modelPackage = "model";
- apiPackage = "apis";
- outputFolder = "generated-code" + File.separatorChar + "python";
-
- embeddedTemplateDir = templateDir = "python-experimental";
-
- testFolder = "test";
-
- // default HIDE_GENERATION_TIMESTAMP to true
- hideGenerationTimestamp = Boolean.TRUE;
-
- // from https://docs.python.org/3/reference/lexical_analysis.html#keywords
- setReservedWordsLowerCase(
- Arrays.asList(
- // local variable name used in API methods (endpoints)
- "all_params", "resource_path", "path_params", "query_params",
- "header_params", "form_params", "local_var_files", "body_params", "auth_settings",
- // @property
- "property",
- // python reserved words
- "and", "del", "from", "not", "while", "as", "elif", "global", "or", "with",
- "assert", "else", "if", "pass", "yield", "break", "except", "import",
- "print", "class", "exec", "in", "raise", "continue", "finally", "is",
- "return", "def", "for", "lambda", "try", "self", "nonlocal", "None", "True",
- "False", "async", "await",
- // types
- "float", "int", "str", "bool", "none_type", "dict", "frozendict", "list", "tuple", "file_type"));
-
- regexModifiers = new HashMap();
- regexModifiers.put('i', "IGNORECASE");
- regexModifiers.put('l', "LOCALE");
- regexModifiers.put('m', "MULTILINE");
- regexModifiers.put('s', "DOTALL");
- regexModifiers.put('u', "UNICODE");
- regexModifiers.put('x', "VERBOSE");
-
- cliOptions.clear();
- cliOptions.add(new CliOption(CodegenConstants.PACKAGE_NAME, "python package name (convention: snake_case).")
- .defaultValue("openapi_client"));
- cliOptions.add(new CliOption(CodegenConstants.PROJECT_NAME, "python project name in setup.py (e.g. petstore-api)."));
- cliOptions.add(new CliOption(CodegenConstants.PACKAGE_VERSION, "python package version.")
- .defaultValue("1.0.0"));
- cliOptions.add(new CliOption(PACKAGE_URL, "python package URL."));
- // this generator does not use SORT_PARAMS_BY_REQUIRED_FLAG
- // this generator uses the following order for endpoint paramters and model properties
- // required params
- // optional params which are set to unset as their default for method signatures only
- // optional params as **kwargs
- cliOptions.add(new CliOption(CodegenConstants.HIDE_GENERATION_TIMESTAMP, CodegenConstants.HIDE_GENERATION_TIMESTAMP_DESC)
- .defaultValue(Boolean.TRUE.toString()));
- cliOptions.add(new CliOption(CodegenConstants.SOURCECODEONLY_GENERATION, CodegenConstants.SOURCECODEONLY_GENERATION_DESC)
- .defaultValue(Boolean.FALSE.toString()));
- cliOptions.add(CliOption.newBoolean(USE_NOSE, "use the nose test framework").
- defaultValue(Boolean.FALSE.toString()));
- cliOptions.add(new CliOption(RECURSION_LIMIT, "Set the recursion limit. If not set, use the system default value."));
- cliOptions.add(CliOption.newBoolean(USE_INLINE_MODEL_RESOLVER, "use the inline model resolver, if true inline complex models will be extracted into components and $refs to them will be used").
- defaultValue(Boolean.FALSE.toString()));
-
- supportedLibraries.put("urllib3", "urllib3-based client");
- CliOption libraryOption = new CliOption(CodegenConstants.LIBRARY, "library template (sub-template) to use: urllib3");
- libraryOption.setDefault(DEFAULT_LIBRARY);
- cliOptions.add(libraryOption);
- setLibrary(DEFAULT_LIBRARY);
-
- // Composed schemas can have the 'additionalProperties' keyword, as specified in JSON schema.
- // In principle, this should be enabled by default for all code generators. However due to limitations
- // in other code generators, support needs to be enabled on a case-by-case basis.
- supportsAdditionalPropertiesWithComposedSchema = true;
-
- // When the 'additionalProperties' keyword is not present in a OAS schema, allow
- // undeclared properties. This is compliant with the JSON schema specification.
- this.setDisallowAdditionalPropertiesIfNotPresent(false);
-
- // this may set datatype right for additional properties
- instantiationTypes.put("map", "dict");
-
- languageSpecificPrimitives.add("file_type");
- languageSpecificPrimitives.add("none_type");
- typeMapping.put("decimal", "str");
-
- generatorMetadata = GeneratorMetadata.newBuilder(generatorMetadata)
- .stability(Stability.EXPERIMENTAL)
- .build();
- }
-
- @Override
- public void processOpts() {
- this.setLegacyDiscriminatorBehavior(false);
-
- super.processOpts();
-
- TemplatingEngineAdapter te = getTemplatingEngine();
- if (te instanceof HandlebarsEngineAdapter) {
- HandlebarsEngineAdapter hea = (HandlebarsEngineAdapter) te;
- hea.infiniteLoops(true);
- hea.setPrettyPrint(true);
- } else {
- throw new RuntimeException("Only the HandlebarsEngineAdapter is supported for this generator");
- }
-
- TemplatePathLocator commonTemplateLocator = new CommonTemplateContentLocator();
- TemplatePathLocator generatorTemplateLocator = new GeneratorTemplateContentLocator(this);
- TemplateManagerOptions templateManagerOptions = new TemplateManagerOptions(this.isEnableMinimalUpdate(),this.isSkipOverwrite());
- templateProcessor = new TemplateManager(
- templateManagerOptions,
- te,
- new TemplatePathLocator[]{generatorTemplateLocator, commonTemplateLocator}
- );
- templateExtension = te.getIdentifier();
-
- String ignoreFileLocation = this.getIgnoreFilePathOverride();
- if (ignoreFileLocation != null) {
- final File ignoreFile = new File(ignoreFileLocation);
- if (ignoreFile.exists() && ignoreFile.canRead()) {
- this.ignoreProcessor = new CodegenIgnoreProcessor(ignoreFile);
- } else {
- LOGGER.warn("Ignore file specified at {} is not valid. This will fall back to an existing ignore file if present in the output directory.", ignoreFileLocation);
- }
- }
-
- if (this.ignoreProcessor == null) {
- this.ignoreProcessor = new CodegenIgnoreProcessor(this.getOutputDir());
- }
-
- modelTemplateFiles.put("model." + templateExtension, ".py");
- /*
- This stub file exists to allow pycharm to read and use typing.overload decorators for it to see that
- dict_instance["someProp"] is of type SomeClass.properties.someProp
- See https://youtrack.jetbrains.com/issue/PY-42137/PyCharm-type-hinting-doesnt-work-well-with-overload-decorator
- */
- modelTemplateFiles.put("model_stub." + templateExtension, ".pyi");
- apiTemplateFiles.put("api." + templateExtension, ".py");
- modelTestTemplateFiles.put("model_test." + templateExtension, ".py");
- modelDocTemplateFiles.put("model_doc." + templateExtension, ".md");
- apiDocTemplateFiles.put("api_doc." + templateExtension, ".md");
-
- 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).");
- }
-
- Boolean excludeTests = false;
-
- if (additionalProperties.containsKey(CodegenConstants.PACKAGE_NAME)) {
- setPackageName((String) additionalProperties.get(CodegenConstants.PACKAGE_NAME));
- }
-
- if (additionalProperties.containsKey(CodegenConstants.PROJECT_NAME)) {
- setProjectName((String) additionalProperties.get(CodegenConstants.PROJECT_NAME));
- } else {
- // default: set project based on package name
- // e.g. petstore_api (package name) => petstore-api (project name)
- setProjectName(packageName.replaceAll("_", "-"));
- }
-
- if (additionalProperties.containsKey(CodegenConstants.PACKAGE_VERSION)) {
- setPackageVersion((String) additionalProperties.get(CodegenConstants.PACKAGE_VERSION));
- }
-
- additionalProperties.put(CodegenConstants.PROJECT_NAME, projectName);
- additionalProperties.put(CodegenConstants.PACKAGE_NAME, packageName);
- additionalProperties.put(CodegenConstants.PACKAGE_VERSION, packageVersion);
-
- if (additionalProperties.containsKey(CodegenConstants.EXCLUDE_TESTS)) {
- excludeTests = Boolean.valueOf(additionalProperties.get(CodegenConstants.EXCLUDE_TESTS).toString());
- }
-
- Boolean generateSourceCodeOnly = false;
- if (additionalProperties.containsKey(CodegenConstants.SOURCECODEONLY_GENERATION)) {
- generateSourceCodeOnly = Boolean.valueOf(additionalProperties.get(CodegenConstants.SOURCECODEONLY_GENERATION).toString());
- }
-
- if (generateSourceCodeOnly) {
- // tests in test
- testFolder = packagePath() + File.separatorChar + testFolder;
- // api docs in /docs/apis/tags/
- apiDocPath = packagePath() + File.separatorChar + apiDocPath;
- // model docs in /docs/models/
- modelDocPath = packagePath() + File.separatorChar + modelDocPath;
- }
- // make api and model doc path available in templates
- additionalProperties.put("apiDocPath", apiDocPath);
- additionalProperties.put("modelDocPath", modelDocPath);
-
- if (additionalProperties.containsKey(PACKAGE_URL)) {
- setPackageUrl((String) additionalProperties.get(PACKAGE_URL));
- }
-
- if (additionalProperties.containsKey(USE_NOSE)) {
- setUseNose((String) additionalProperties.get(USE_NOSE));
- }
-
- if (additionalProperties.containsKey(USE_INLINE_MODEL_RESOLVER)) {
- setUseInlineModelResolver((String) additionalProperties.get(USE_INLINE_MODEL_RESOLVER));
- }
-
- // check to see if setRecursionLimit is set and whether it's an integer
- if (additionalProperties.containsKey(RECURSION_LIMIT)) {
- try {
- Integer.parseInt((String) additionalProperties.get(RECURSION_LIMIT));
- } catch (NumberFormatException | NullPointerException e) {
- throw new IllegalArgumentException("recursionLimit must be an integer, e.g. 2000.");
- }
- }
-
- String readmePath = "README.md";
- String readmeTemplate = "README." + templateExtension;
- if (generateSourceCodeOnly) {
- readmePath = packagePath() + "_" + readmePath;
- readmeTemplate = "README_onlypackage." + templateExtension;
- }
- supportingFiles.add(new SupportingFile(readmeTemplate, "", readmePath));
-
- if (!generateSourceCodeOnly) {
- supportingFiles.add(new SupportingFile("tox." + templateExtension, "", "tox.ini"));
- supportingFiles.add(new SupportingFile("test-requirements." + templateExtension, "", "test-requirements.txt"));
- supportingFiles.add(new SupportingFile("requirements." + templateExtension, "", "requirements.txt"));
- supportingFiles.add(new SupportingFile("setup_cfg." + templateExtension, "", "setup.cfg"));
-
- supportingFiles.add(new SupportingFile("git_push.sh." + templateExtension, "", "git_push.sh"));
- supportingFiles.add(new SupportingFile("gitignore." + templateExtension, "", ".gitignore"));
- supportingFiles.add(new SupportingFile("travis." + templateExtension, "", ".travis.yml"));
- supportingFiles.add(new SupportingFile("gitlab-ci." + templateExtension, "", ".gitlab-ci.yml"));
- supportingFiles.add(new SupportingFile("setup." + templateExtension, "", "setup.py"));
- }
- supportingFiles.add(new SupportingFile("configuration." + templateExtension, packagePath(), "configuration.py"));
- supportingFiles.add(new SupportingFile("__init__package." + templateExtension, packagePath(), "__init__.py"));
-
- // If the package name consists of dots(openapi.client), then we need to create the directory structure like openapi/client with __init__ files.
- String[] packageNameSplits = packageName.split("\\.");
- String currentPackagePath = "";
- for (int i = 0; i < packageNameSplits.length - 1; i++) {
- if (i > 0) {
- currentPackagePath = currentPackagePath + File.separatorChar;
- }
- currentPackagePath = currentPackagePath + packageNameSplits[i];
- supportingFiles.add(new SupportingFile("__init__." + templateExtension, currentPackagePath, "__init__.py"));
- }
-
- supportingFiles.add(new SupportingFile("exceptions." + templateExtension, packagePath(), "exceptions.py"));
-
- if (Boolean.FALSE.equals(excludeTests)) {
- supportingFiles.add(new SupportingFile("__init__." + templateExtension, testFolder, "__init__.py"));
- supportingFiles.add(new SupportingFile("__init__." + templateExtension, testFolder + File.separator + "test_models", "__init__.py"));
- }
-
- supportingFiles.add(new SupportingFile("api_client." + templateExtension, packagePath(), "api_client.py"));
-
- if ("asyncio".equals(getLibrary())) {
- supportingFiles.add(new SupportingFile("asyncio/rest." + templateExtension, packagePath(), "rest.py"));
- additionalProperties.put("asyncio", "true");
- } else if ("tornado".equals(getLibrary())) {
- supportingFiles.add(new SupportingFile("tornado/rest." + templateExtension, packagePath(), "rest.py"));
- additionalProperties.put("tornado", "true");
- } else {
- supportingFiles.add(new SupportingFile("rest." + templateExtension, packagePath(), "rest.py"));
- }
-
- supportingFiles.add(new SupportingFile("schemas." + templateExtension, packagePath(), "schemas.py"));
-
- // add the models and apis folders
- supportingFiles.add(new SupportingFile("__init__models." + templateExtension, packagePath() + File.separatorChar + "models", "__init__.py"));
- supportingFiles.add(new SupportingFile("__init__model." + templateExtension, packagePath() + File.separatorChar + modelPackage, "__init__.py"));
- supportingFiles.add(new SupportingFile("__init__apis." + templateExtension, packagePath() + File.separatorChar + apiPackage, "__init__.py"));
- // Generate the 'signing.py' module, but only if the 'HTTP signature' security scheme is specified in the OAS.
- Map securitySchemeMap = openAPI != null ?
- (openAPI.getComponents() != null ? openAPI.getComponents().getSecuritySchemes() : null) : null;
- List authMethods = fromSecurity(securitySchemeMap);
- if (ProcessUtils.hasHttpSignatureMethods(authMethods)) {
- supportingFiles.add(new SupportingFile("signing." + templateExtension, packagePath(), "signing.py"));
- }
-
- // default this to true so the python ModelSimple models will be generated
- ModelUtils.setGenerateAliasAsModel(true);
- LOGGER.info(CodegenConstants.GENERATE_ALIAS_AS_MODEL + " is hard coded to true in this generator. Alias models will only be generated if they contain validations or enums");
-
- // check library option to ensure only urllib3 is supported
- if (!DEFAULT_LIBRARY.equals(getLibrary())) {
- throw new RuntimeException("Only the `urllib3` library is supported in the refactored `python` client generator at the moment. Please fall back to `python-legacy` client generator for the time being. We welcome contributions to add back `asyncio`, `tornado` support to the `python` client generator.");
- }
- }
-
- public String packageFilename(List pathSegments) {
- String prefix = outputFolder + File.separatorChar + packagePath() + File.separatorChar;
- String suffix = pathSegments.stream().collect(Collectors.joining(File.separator));
- return prefix + suffix;
- }
-
- public String filenameFromRoot(List pathSegments) {
- String prefix = outputFolder + File.separatorChar;
- String suffix = pathSegments.stream().collect(Collectors.joining(File.separator));
- return prefix + suffix;
- }
-
- protected File processTemplateToFile(Map templateData, String templateName, String outputFilename, boolean shouldGenerate, String skippedByOption) throws IOException {
- String adjustedOutputFilename = outputFilename.replaceAll("//", "/").replace('/', File.separatorChar);
- File target = new File(adjustedOutputFilename);
- if (ignoreProcessor.allowsFile(target)) {
- if (shouldGenerate) {
- Path outDir = java.nio.file.Paths.get(this.getOutputDir()).toAbsolutePath();
- Path absoluteTarget = target.toPath().toAbsolutePath();
- if (!absoluteTarget.startsWith(outDir)) {
- throw new RuntimeException(String.format(Locale.ROOT, "Target files must be generated within the output directory; absoluteTarget=%s outDir=%s", absoluteTarget, outDir));
- }
- return this.templateProcessor.write(templateData,templateName, target);
- } else {
- this.templateProcessor.skip(target.toPath(), String.format(Locale.ROOT, "Skipped by %s options supplied by user.", skippedByOption));
- return null;
- }
- } else {
- this.templateProcessor.ignore(target.toPath(), "Ignored by rule in ignore file.");
- return null;
- }
- }
-
- @Override
- public String apiFilename(String templateName, String tag) {
- String suffix = apiTemplateFiles().get(templateName);
- return apiFileFolder() + File.separator + toApiFilename(tag) + suffix;
- }
-
- private void generateFiles(List> processTemplateToFileInfos, String skippedByOption) {
- for (List processTemplateToFileInfo: processTemplateToFileInfos) {
- Map templateData = (Map) processTemplateToFileInfo.get(0);
- String templateName = (String) processTemplateToFileInfo.get(1);
- String outputFilename = (String) processTemplateToFileInfo.get(2);
- try {
- processTemplateToFile(templateData, templateName, outputFilename, true, skippedByOption);
- } catch (IOException e) {
- LOGGER.error("Error when writing template file {}", e.toString());
- }
- }
- }
-
- @Override
- public String toApiName(String name) {
- if (name.length() == 0) {
- return "DefaultApi";
- }
- return toModelName(name) + apiNameSuffix;
- }
-
- /*
- I made this method because endpoint parameters not contain a lot of needed metadata
- It is very verbose to write all of this info into the api template
- This ingests all operations under a tag in the objs input and writes out one file for each endpoint
- */
- protected void generateEndpoints(OperationsMap objs) {
- if (!(Boolean) additionalProperties.get(CodegenConstants.GENERATE_APIS)) {
- return;
- }
- Paths paths = openAPI.getPaths();
- if (paths == null) {
- return;
- }
- List> pathsFiles = new ArrayList<>();
- List> apisFiles = new ArrayList<>();
- List> testFiles = new ArrayList<>();
- String outputFilename;
-
- // endpoint tags may not exist in the root of the spec file
- // this is allowed per openapi
- // because spec tags may be empty ro incomplete, tags are also accumulated from endpoints
- List tags = openAPI.getTags();
- if (tags != null) {
- for (Tag tag: tags) {
- String tagName = tag.getName();
- String tagModuleName = toApiFilename(tagName);
- String apiClassname = toApiName(tagName);
- tagModuleNameToApiClassname.put(tagModuleName, apiClassname);
- String tagEnum = toEnumVarName(tagName, "str");
- enumToTag.put(tagEnum, tagName);
- tagEnumToApiClassname.put(tagEnum, apiClassname);
- }
- }
-
- OperationMap operations = objs.getOperations();
- List codegenOperations = operations.getOperation();
- HashMap pathModuleToPath = new HashMap<>();
- // paths.some_path.post.py (single endpoint definition)
- for (CodegenOperation co: codegenOperations) {
- if (co.tags != null) {
- for (Tag tag: co.tags) {
- String tagName = tag.getName();
- String tagModuleName = toApiFilename(tagName);
- String apiClassname = toApiName(tagName);
- tagModuleNameToApiClassname.put(tagModuleName, apiClassname);
- String tagEnum = toEnumVarName(tagName, "str");
- enumToTag.put(tagEnum, tagName);
- tagEnumToApiClassname.put(tagEnum, apiClassname);
- }
- }
- String path = co.path;
- String pathModuleName = co.nickname;
- if (!pathModuleToPath.containsKey(pathModuleName)) {
- pathModuleToPath.put(pathModuleName, path);
- }
- Map endpointMap = new HashMap<>();
- endpointMap.put("operation", co);
- endpointMap.put("imports", co.imports);
- endpointMap.put("packageName", packageName);
- outputFilename = packageFilename(Arrays.asList("paths", pathModuleName, co.httpMethod + ".py"));
- pathsFiles.add(Arrays.asList(endpointMap, "endpoint.handlebars", outputFilename));
- /*
- This stub file exists to allow pycharm to read and use typing.overload decorators for it to see that
- dict_instance["someProp"] is of type SomeClass.properties.someProp
- See https://youtrack.jetbrains.com/issue/PY-42137/PyCharm-type-hinting-doesnt-work-well-with-overload-decorator
- */
- String stubOutputFilename = packageFilename(Arrays.asList("paths", pathModuleName, co.httpMethod + ".pyi"));
- pathsFiles.add(Arrays.asList(endpointMap, "endpoint_stub.handlebars", stubOutputFilename));
-
- Map endpointTestMap = new HashMap<>();
- endpointTestMap.put("operation", co);
- endpointTestMap.put("packageName", packageName);
- outputFilename = filenameFromRoot(Arrays.asList("test", "test_paths", "test_" + pathModuleName, "test_" + co.httpMethod + ".py"));
- testFiles.add(Arrays.asList(endpointTestMap, "api_test.handlebars", outputFilename));
- outputFilename = filenameFromRoot(Arrays.asList("test", "test_paths", "test_" + pathModuleName, "__init__.py"));
- testFiles.add(Arrays.asList(new HashMap<>(), "__init__.handlebars", outputFilename));
- }
- outputFilename = filenameFromRoot(Arrays.asList("test", "test_paths", "__init__.py"));
- testFiles.add(Arrays.asList(new HashMap<>(), "__init__test_paths.handlebars", outputFilename));
-
- Map pathValToVar = new LinkedHashMap<>();
- Map pathModuleToApiClassname = new LinkedHashMap<>();
- Map pathEnumToApiClassname = new LinkedHashMap<>();
- for (Map.Entry pathsEntry : paths.entrySet()) {
- String path = pathsEntry.getKey();
- String pathEnumVar = toEnumVarName(path, "str");
- pathValToVar.put(path, pathEnumVar);
- String apiClassName = toModelName(path);
- pathEnumToApiClassname.put(pathEnumVar, apiClassName);
- pathModuleToApiClassname.put(toVarName(path), apiClassName);
- }
- // Note: __init__apis.handlebars is generated as a supporting file
- // apis.tag_to_api.py
- Map tagToApiMap = new HashMap<>();
- tagToApiMap.put("packageName", packageName);
- tagToApiMap.put("apiClassname", "Api");
- tagToApiMap.put("tagModuleNameToApiClassname", tagModuleNameToApiClassname);
- tagToApiMap.put("tagEnumToApiClassname", tagEnumToApiClassname);
- outputFilename = packageFilename(Arrays.asList("apis", "tag_to_api.py"));
- apisFiles.add(Arrays.asList(tagToApiMap, "apis_tag_to_api.handlebars", outputFilename));
- // apis.path_to_api.py
- Map allByPathsFileMap = new HashMap<>();
- allByPathsFileMap.put("packageName", packageName);
- allByPathsFileMap.put("apiClassname", "Api");
- allByPathsFileMap.put("pathModuleToApiClassname", pathModuleToApiClassname);
- allByPathsFileMap.put("pathEnumToApiClassname", pathEnumToApiClassname);
- outputFilename = packageFilename(Arrays.asList("apis", "path_to_api.py"));
- apisFiles.add(Arrays.asList(allByPathsFileMap, "apis_path_to_api.handlebars", outputFilename));
- // apis.paths.__init__.py
- Map initApiTagsMap = new HashMap<>();
- initApiTagsMap.put("packageName", packageName);
- initApiTagsMap.put("enumToTag", enumToTag);
- outputFilename = packageFilename(Arrays.asList("apis", "tags", "__init__.py"));
- apisFiles.add(Arrays.asList(initApiTagsMap, "__init__apis_tags.handlebars", outputFilename));
-
- // paths.__init__.py (contains path str enum)
- Map initOperationMap = new HashMap<>();
- initOperationMap.put("packageName", packageName);
- initOperationMap.put("apiClassname", "Api");
- initOperationMap.put("pathValToVar", pathValToVar);
- outputFilename = packageFilename(Arrays.asList("paths", "__init__.py"));
- pathsFiles.add(Arrays.asList(initOperationMap, "__init__paths_enum.handlebars", outputFilename));
- // apis.paths.__init__.py
- outputFilename = packageFilename(Arrays.asList("apis", "paths", "__init__.py"));
- apisFiles.add(Arrays.asList(initOperationMap, "__init__paths.handlebars", outputFilename));
- // paths.some_path.__init__.py
- // apis.paths.some_path.py
- for (Map.Entry entry: pathModuleToPath.entrySet()) {
- String pathModule = entry.getKey();
- String path = entry.getValue();
- String pathVar = pathValToVar.get(path);
- Map pathApiMap = new HashMap<>();
- pathApiMap.put("packageName", packageName);
- pathApiMap.put("pathModule", pathModule);
- pathApiMap.put("apiClassName", "Api");
- pathApiMap.put("pathVar", pathVar);
- outputFilename = packageFilename(Arrays.asList("paths", pathModule, "__init__.py"));
- pathsFiles.add(Arrays.asList(pathApiMap, "__init__paths_x.handlebars", outputFilename));
-
- PathItem pi = openAPI.getPaths().get(path);
- String apiClassName = pathEnumToApiClassname.get(pathVar);
- Map operationMap = new HashMap<>();
- operationMap.put("packageName", packageName);
- operationMap.put("pathModule", pathModule);
- operationMap.put("apiClassName", apiClassName);
- operationMap.put("pathItem", pi);
- outputFilename = packageFilename(Arrays.asList("apis", "paths", pathModule + ".py"));
- apisFiles.add(Arrays.asList(operationMap, "apis_path_module.handlebars", outputFilename));
- }
- generateFiles(pathsFiles, CodegenConstants.APIS);
- generateFiles(apisFiles, CodegenConstants.APIS);
- generateFiles(testFiles, CodegenConstants.API_TESTS);
- }
-
- /*
- We have a custom version of this method so for composed schemas and object schemas we add properties only if they
- are defined in that schema (x.properties). We do this because validation should be done independently in each schema
- If properties are hosted into composed schemas, they can collide or incorrectly list themself as required when
- they are not.
- */
- @Override
- protected void addVarsRequiredVarsAdditionalProps(Schema schema, IJsonSchemaValidationProperties property){
- setAddProps(schema, property);
- if (ModelUtils.isAnyType(schema) && supportsAdditionalPropertiesWithComposedSchema) {
- // if anyType schema has properties then add them
- if (schema.getProperties() != null && !schema.getProperties().isEmpty()) {
- if (schema instanceof ComposedSchema) {
- ComposedSchema cs = (ComposedSchema) schema;
- if (cs.getOneOf() != null && !cs.getOneOf().isEmpty()) {
- LOGGER.warn("'oneOf' is intended to include only the additional optional OAS extension discriminator object. " +
- "For more details, see https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.9.2.1.3 and the OAS section on 'Composition and Inheritance'.");
- }
- }
- HashSet requiredVars = new HashSet<>();
- if (schema.getRequired() != null) {
- requiredVars.addAll(schema.getRequired());
- }
- addVars(property, property.getVars(), schema.getProperties(), requiredVars);
- }
- addRequiredVarsMap(schema, property);
- return;
- } else if (ModelUtils.isTypeObjectSchema(schema)) {
- HashSet requiredVars = new HashSet<>();
- if (schema.getRequired() != null) {
- requiredVars.addAll(schema.getRequired());
- property.setHasRequired(true);
- }
- addVars(property, property.getVars(), schema.getProperties(), requiredVars);
- if (property.getVars() != null && !property.getVars().isEmpty()) {
- property.setHasVars(true);
- }
- }
- addRequiredVarsMap(schema, property);
- return;
- }
-
- /**
- * Configures a friendly name for the generator. This will be used by the
- * generator to select the library with the -g flag.
- *
- * @return the friendly name for the generator
- */
- @Override
- public String getName() {
- return "python-experimental";
- }
-
- @Override
- public String getHelp() {
- String newLine = System.getProperty("line.separator");
- return String.join(" allSchemas = ModelUtils.getSchemas(openAPI);
- if (allSchemas == null || allSchemas.isEmpty()) {
- // skip the warning as the spec can have no model defined
- //LOGGER.warn("allSchemas cannot be null/empty in unaliasSchema. Returned 'schema'");
- return schema;
- }
-
- if (schema != null && StringUtils.isNotEmpty(schema.get$ref())) {
- String simpleRef = ModelUtils.getSimpleRef(schema.get$ref());
- if (schemaMapping.containsKey(simpleRef)) {
- LOGGER.debug("Schema unaliasing of {} omitted because aliased class is to be mapped to {}", simpleRef, schemaMapping.get(simpleRef));
- return schema;
- }
- Schema ref = allSchemas.get(simpleRef);
- if (ref == null) {
- once(LOGGER).warn("{} is not defined", schema.get$ref());
- return schema;
- } else if (ref.getEnum() != null && !ref.getEnum().isEmpty()) {
- // top-level enum class
- return schema;
- } else if (ModelUtils.isArraySchema(ref)) {
- if (ModelUtils.isGenerateAliasAsModel(ref)) {
- return schema; // generate a model extending array
- } else {
- return unaliasSchema(allSchemas.get(ModelUtils.getSimpleRef(schema.get$ref())));
- }
- } else if (ModelUtils.isComposedSchema(ref)) {
- return schema;
- } else if (ModelUtils.isMapSchema(ref)) {
- if (ref.getProperties() != null && !ref.getProperties().isEmpty()) // has at least one property
- return schema; // treat it as model
- else {
- if (ModelUtils.isGenerateAliasAsModel(ref)) {
- return schema; // generate a model extending map
- } else {
- // treat it as a typical map
- return unaliasSchema(allSchemas.get(ModelUtils.getSimpleRef(schema.get$ref())));
- }
- }
- } else if (ModelUtils.isObjectSchema(ref)) { // model
- if (ref.getProperties() != null && !ref.getProperties().isEmpty()) { // has at least one property
- return schema;
- } else {
- // free form object (type: object)
- if (ModelUtils.hasValidation(ref)) {
- return schema;
- } else if (getAllOfDescendants(simpleRef, openAPI).size() > 0) {
- return schema;
- }
- return unaliasSchema(allSchemas.get(ModelUtils.getSimpleRef(schema.get$ref())));
- }
- } else if (ModelUtils.hasValidation(ref)) {
- // non object non array non map schemas that have validations
- // are returned so we can generate those schemas as models
- // we do this to:
- // - preserve the validations in that model class in python
- // - use those validations when we use this schema in composed oneOf schemas
- return schema;
- } else if (Boolean.TRUE.equals(ref.getNullable()) && ref.getEnum() == null) {
- // non enum primitive with nullable True
- // we make these models so instances of this will be subclasses of this model
- return schema;
- } else {
- return unaliasSchema(allSchemas.get(ModelUtils.getSimpleRef(schema.get$ref())));
- }
- }
- return schema;
- }
-
- public String pythonDate(Object dateValue) {
- String strValue = null;
- if (dateValue instanceof OffsetDateTime) {
- OffsetDateTime date = null;
- try {
- date = (OffsetDateTime) dateValue;
- } catch (ClassCastException e) {
- LOGGER.warn("Invalid `date` format for value {}", dateValue.toString());
- date = ((Date) dateValue).toInstant().atOffset(ZoneOffset.UTC);
- }
- strValue = date.format(iso8601Date);
- } else {
- strValue = dateValue.toString();
- }
- return strValue;
- }
-
- public String pythonDateTime(Object dateTimeValue) {
- String strValue = null;
- if (dateTimeValue instanceof OffsetDateTime) {
- OffsetDateTime dateTime = null;
- try {
- dateTime = (OffsetDateTime) dateTimeValue;
- } catch (ClassCastException e) {
- LOGGER.warn("Invalid `date-time` format for value {}", dateTimeValue.toString());
- dateTime = ((Date) dateTimeValue).toInstant().atOffset(ZoneOffset.UTC);
- }
- strValue = dateTime.format(iso8601DateTime);
- } else {
- strValue = dateTimeValue.toString();
- }
- return strValue;
- }
-
- /**
- * Return the default value of the property
- *
- * @param p OpenAPI property object
- * @return string presentation of the default value of the property
- */
- @Override
- public String toDefaultValue(Schema p) {
- Object defaultObject = null;
- if (p.getDefault() != null) {
- defaultObject = p.getDefault();
- }
-
- if (defaultObject == null) {
- return null;
- }
-
- String defaultValue = defaultObject.toString();
- if (ModelUtils.isDateSchema(p)) {
- defaultValue = pythonDate(defaultObject);
- } else if (ModelUtils.isDateTimeSchema(p)) {
- defaultValue = pythonDateTime(defaultObject);
- } else if (ModelUtils.isStringSchema(p) && !ModelUtils.isByteArraySchema(p) && !ModelUtils.isBinarySchema(p) && !ModelUtils.isFileSchema(p) && !ModelUtils.isUUIDSchema(p) && !ModelUtils.isEmailSchema(p)) {
- defaultValue = ensureQuotes(defaultValue);
- } else if (ModelUtils.isBooleanSchema(p)) {
- if (Boolean.valueOf(defaultValue) == false) {
- defaultValue = "False";
- } else {
- defaultValue = "True";
- }
- }
- return defaultValue;
- }
-
- @Override
- public String toModelImport(String name) {
- // name looks like Cat
- return "from " + packagePath() + "." + modelPackage() + "." + toModelFilename(name) + " import " + toModelName(name);
- }
-
- @Override
- @SuppressWarnings("static-method")
- public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List allModels) {
- // fix the imports that each model has, add the module reference to the model
- // loops through imports and converts them all
- // from 'Pet' to 'from petstore_api.model.pet import Pet'
-
- OperationMap val = objs.getOperations();
- List operations = val.getOperation();
- for (CodegenOperation operation : operations) {
- if (operation.imports.size() == 0) {
- continue;
- }
- String[] modelNames = operation.imports.toArray(new String[0]);
- operation.imports.clear();
- for (String modelName : modelNames) {
- operation.imports.add(toModelImport(modelName));
- }
- }
- generateEndpoints(objs);
- return objs;
- }
-
- /***
- * Override with special post-processing for all models.
- * we have a custom version of this method to:
- * - remove any primitive models that do not contain validations
- * these models are unaliased as inline definitions wherever the spec has them as refs
- * this means that the generated client does not use these models
- * because they are not used we do not write them
- * - fix the model imports, go from model name to the full import string with toModelImport + globalImportFixer
- * Also cleans the test folder if test cases exist and the testFolder is set because the tests are autogenerated
- *
- * @param objs a map going from the model name to a object hoding the model info
- * @return the updated objs
- */
- @Override
- public Map postProcessAllModels(Map objs) {
- super.postProcessAllModels(objs);
-
- boolean anyModelContainsTestCases = false;
- Map allDefinitions = ModelUtils.getSchemas(this.openAPI);
- for (String schemaName : allDefinitions.keySet()) {
- String modelName = toModelName(schemaName);
- ModelsMap objModel = objs.get(modelName);
- if (objModel == null) {
- // to avoid form parameter's models that are not generated (skipFormModel=true)
- continue;
- }
- for (ModelMap model : objModel.getModels()) {
- CodegenModel cm = model.getModel();
- if (cm.testCases != null && !cm.testCases.isEmpty()) {
- anyModelContainsTestCases = true;
- }
- String[] importModelNames = cm.imports.toArray(new String[0]);
- cm.imports.clear();
- for (String importModelName : importModelNames) {
- cm.imports.add(toModelImport(importModelName));
- }
- }
- }
- boolean testFolderSet = testFolder != null;
- if (testFolderSet && anyModelContainsTestCases) {
- // delete the test folder because tests there will be autogenerated
- String testPath = outputFolder + File.separatorChar + testFolder;
- File testDirectory = new File(testPath);
- try {
- FileUtils.cleanDirectory(testDirectory);
- } catch (IOException e) {
- LOGGER.info("Unable to delete the test folder because of exception=" + e.toString());
- }
-
- }
-
- return objs;
- }
-
- public CodegenParameter fromParameter(Parameter parameter, Set imports) {
- CodegenParameter cp = super.fromParameter(parameter, imports);
- if (parameter.getStyle() != null) {
- switch(parameter.getStyle()) {
- case MATRIX:
- cp.style = "MATRIX";
- break;
- case LABEL:
- cp.style = "LABEL";
- break;
- case FORM:
- cp.style = "FORM";
- break;
- case SIMPLE:
- cp.style = "SIMPLE";
- break;
- case SPACEDELIMITED:
- cp.style = "SPACE_DELIMITED";
- break;
- case PIPEDELIMITED:
- cp.style = "PIPE_DELIMITED";
- break;
- case DEEPOBJECT:
- cp.style = "DEEP_OBJECT";
- break;
- }
- }
- // clone this so we can change some properties on it
- CodegenProperty schemaProp = cp.getSchema().clone();
- // parameters may have valid python names like some_val or invalid ones like Content-Type
- // we always set nameInSnakeCase to null so special handling will not be done for these names
- // invalid python names will be handled in python by using a TypedDict which will allow us to have a type hint
- // for keys that cannot be variable names to the schema baseName
- if (schemaProp != null) {
- schemaProp.nameInSnakeCase = null;
- schemaProp.baseName = toModelName(cp.baseName) + "Schema";
- cp.setSchema(schemaProp);
- }
- return cp;
- }
-
- private boolean isValidPythonVarOrClassName(String name) {
- return name.matches("^[_a-zA-Z][_a-zA-Z0-9]*$");
- }
-
-
- /**
- * Convert OAS Property object to Codegen Property object
- * We have a custom version of this method to always set allowableValues.enumVars on all enum variables
- * Together with unaliasSchema this sets primitive types with validations as models
- * This method is used by fromResponse
- *
- * @param name name of the property
- * @param p OAS property schema
- * @param required true if the property is required in the next higher object schema, false otherwise
- * @param schemaIsFromAdditionalProperties true if the property is defined by additional properties schema
- * @return Codegen Property object
- */
- @Override
- public CodegenProperty fromProperty(String name, Schema p, boolean required, boolean schemaIsFromAdditionalProperties) {
- // fix needed for values with /n /t etc in them
- String fixedName = handleSpecialCharacters(name);
- CodegenProperty cp = super.fromProperty(fixedName, p, required, schemaIsFromAdditionalProperties);
-
- if (cp.isAnyType && cp.isNullable) {
- cp.isNullable = false;
- }
- if (cp.isNullable && cp.complexType == null) {
- cp.setIsNull(true);
- cp.isNullable = false;
- cp.setHasMultipleTypes(true);
- }
- postProcessPattern(cp.pattern, cp.vendorExtensions);
- // if we have a property that has a difficult name, either:
- // 1. name is reserved, like class int float
- // 2. name is invalid in python like '3rd' or 'Content-Type'
- // set cp.nameInSnakeCase to a value so we can tell that we are in this use case
- // we handle this in the schema templates
- // templates use its presence to handle these badly named variables / keys
- if ((isReservedWord(cp.baseName) || !isValidPythonVarOrClassName(cp.baseName)) && !cp.baseName.equals(cp.name)) {
- cp.nameInSnakeCase = cp.name;
- } else {
- cp.nameInSnakeCase = null;
- }
- if (cp.isEnum) {
- updateCodegenPropertyEnum(cp);
- }
- Schema unaliasedSchema = unaliasSchema(p);
- if (cp.isPrimitiveType && unaliasedSchema.get$ref() != null) {
- cp.complexType = cp.dataType;
- }
- setAdditionalPropsAndItemsVarNames(cp);
- return cp;
- }
-
- private void setAdditionalPropsAndItemsVarNames(IJsonSchemaValidationProperties item) {
- if (item.getAdditionalProperties() != null) {
- item.getAdditionalProperties().setBaseName("additional_properties");
- }
- if (item.getItems() != null) {
- item.getItems().setBaseName("items");
- }
- }
-
- /**
- * checks if the data should be classified as "string" in enum
- * e.g. double in C# needs to be double-quoted (e.g. "2.8") by treating it as a string
- * In the future, we may rename this function to "isEnumString"
- *
- * @param dataType data type
- * @return true if it's a enum string
- */
- @Override
- public boolean isDataTypeString(String dataType) {
- return "str".equals(dataType);
- }
-
- /**
- * Update codegen property's enum by adding "enumVars" (with name and value)
- *
- * @param var list of CodegenProperty
- */
- @Override
- public void updateCodegenPropertyEnum(CodegenProperty var) {
- // we have a custom version of this method to omit overwriting the defaultValue
- Map allowableValues = var.allowableValues;
-
- // handle array
- if (var.mostInnerItems != null) {
- allowableValues = var.mostInnerItems.allowableValues;
- }
-
- if (allowableValues == null) {
- return;
- }
-
- List values = (List) allowableValues.get("values");
- if (values == null) {
- return;
- }
-
- String varDataType = var.mostInnerItems != null ? var.mostInnerItems.dataType : var.dataType;
- Schema referencedSchema = getModelNameToSchemaCache().get(varDataType);
- String dataType = (referencedSchema != null) ? getTypeDeclaration(referencedSchema) : varDataType;
-
- // put "enumVars" map into `allowableValues", including `name` and `value`
- List> enumVars = buildEnumVars(values, dataType);
-
- // if "x-enum-varnames" or "x-enum-descriptions" defined, update varnames
- Map extensions = var.mostInnerItems != null ? var.mostInnerItems.getVendorExtensions() : var.getVendorExtensions();
- if (referencedSchema != null) {
- extensions = referencedSchema.getExtensions();
- }
- updateEnumVarsWithExtensions(enumVars, extensions, dataType);
- allowableValues.put("enumVars", enumVars);
- // overwriting defaultValue omitted from here
- }
-
- /***
- * We have a custom version of this method to produce links to models when they are
- * primitive type (not map, not array, not object) and include validations or are enums
- *
- * @param body requesst body
- * @param imports import collection
- * @param bodyParameterName body parameter name
- * @return the resultant CodegenParameter
- */
- @Override
- public CodegenParameter fromRequestBody(RequestBody body, Set imports, String bodyParameterName) {
- CodegenParameter cp = super.fromRequestBody(body, imports, bodyParameterName);
- cp.baseName = "body";
- Schema schema = ModelUtils.getSchemaFromRequestBody(body);
- if (schema.get$ref() == null) {
- return cp;
- }
- Schema unaliasedSchema = unaliasSchema(schema);
- CodegenProperty unaliasedProp = fromProperty("body", unaliasedSchema, false);
- Boolean dataTypeMismatch = !cp.dataType.equals(unaliasedProp.dataType);
- Boolean baseTypeMismatch = !cp.baseType.equals(unaliasedProp.complexType) && unaliasedProp.complexType != null;
- if (dataTypeMismatch || baseTypeMismatch) {
- cp.dataType = unaliasedProp.dataType;
- cp.baseType = unaliasedProp.complexType;
- }
- return cp;
- }
-
- /***
- * Adds the body model schema to the body parameter
- * We have a custom version of this method so we can flip forceSimpleRef
- * to True based upon the results of unaliasSchema
- * With this customization, we ensure that when schemas are passed to getSchemaType
- * - if they have ref in them they are a model
- * - if they do not have ref in them they are not a model
- * and code is also customized to allow anyType request body schemas
- *
- * @param codegenParameter the body parameter
- * @param name model schema ref key in components
- * @param schema the model schema (not refed)
- * @param imports collection of imports
- * @param bodyParameterName body parameter name
- * @param forceSimpleRef if true use a model reference
- */
- @Override
- protected void addBodyModelSchema(CodegenParameter codegenParameter, String name, Schema schema, Set imports, String bodyParameterName, boolean forceSimpleRef) {
- if (name != null) {
- Schema bodySchema = new Schema().$ref("#/components/schemas/" + name);
- Schema unaliased = unaliasSchema(bodySchema);
- if (unaliased.get$ref() != null) {
- forceSimpleRef = true;
- }
- }
-
- CodegenModel codegenModel = null;
- if (StringUtils.isNotBlank(name)) {
- schema.setName(name);
- codegenModel = fromModel(name, schema);
- }
-
- if (codegenModel != null && (codegenModel.hasVars || forceSimpleRef)) {
- if (StringUtils.isEmpty(bodyParameterName)) {
- codegenParameter.baseName = codegenModel.classname;
- } else {
- codegenParameter.baseName = bodyParameterName;
- }
- codegenParameter.paramName = toParamName(codegenParameter.baseName);
- codegenParameter.baseType = codegenModel.classname;
- codegenParameter.dataType = getTypeDeclaration(codegenModel.classname);
- codegenParameter.description = codegenModel.description;
- codegenParameter.isNullable = codegenModel.isNullable;
- } else {
- CodegenProperty codegenProperty = fromProperty("property", schema, false);
-
- if (ModelUtils.isMapSchema(schema)) {// http body is map
- // LOGGER.error("Map should be supported. Please report to openapi-generator github repo about the issue.");
- } else if (codegenProperty != null) {
- String codegenModelName, codegenModelDescription;
-
- if (codegenModel != null) {
- codegenModelName = codegenModel.classname;
- codegenModelDescription = codegenModel.description;
- } else {
- codegenModelName = "anyType";
- codegenModelDescription = "";
- }
-
- if (StringUtils.isEmpty(bodyParameterName)) {
- codegenParameter.baseName = codegenModelName;
- } else {
- codegenParameter.baseName = bodyParameterName;
- }
-
- codegenParameter.paramName = toParamName(codegenParameter.baseName);
- codegenParameter.baseType = codegenModelName;
- codegenParameter.dataType = getTypeDeclaration(codegenModelName);
- codegenParameter.description = codegenModelDescription;
- }
-
- // set nullable
- setParameterNullable(codegenParameter, codegenProperty);
- }
-
- }
-
-
- /**
- * Return the sanitized variable name for enum
- *
- * @param value enum variable name
- * @param datatype data type
- * @return the sanitized variable name for enum
- */
- public String toEnumVarName(String value, String datatype) {
- // our enum var names are keys in a python dict, so change spaces to underscores
- if (value.length() == 0) {
- return "EMPTY";
- } else if (value.equals("null")) {
- return "NONE";
- }
-
- String intPattern = "^[-\\+]?\\d+$";
- String floatPattern = "^[-\\+]?\\d+\\.\\d+$";
- Boolean intMatch = Pattern.matches(intPattern, value);
- Boolean floatMatch = Pattern.matches(floatPattern, value);
- if (intMatch || floatMatch) {
- String plusSign = "^\\+.+";
- String negSign = "^-.+";
- if (Pattern.matches(plusSign, value)) {
- value = value.replace("+", "POSITIVE_");
- } else if (Pattern.matches(negSign, value)) {
- value = value.replace("-", "NEGATIVE_");
- } else {
- value = "POSITIVE_" + value;
- }
- if (floatMatch) {
- value = value.replace(".", "_PT_");
- }
- return value;
- }
- // Replace " " with _
- String usedValue = value.replaceAll("\\s+", "_");
- // strip first character if it is invalid
- usedValue = usedValue.replaceAll("^[^_a-zA-Z]", "");
- // Replace / with _ for path enums
- usedValue = usedValue.replaceAll("/", "_");
- // Replace . with _ for tag enums
- usedValue = usedValue.replaceAll("\\.", "_");
- // add underscore at camelCase locations
- String regex = "([a-z])([A-Z]+)";
- String replacement = "$1_$2";
- usedValue = usedValue.replaceAll(regex, replacement);
- // Replace invalid characters with empty space
- usedValue = usedValue.replaceAll("[^_a-zA-Z0-9]*", "");
- // uppercase
- usedValue = usedValue.toUpperCase(Locale.ROOT);
-
- if (usedValue.length() == 0) {
- for (int i = 0; i < value.length(); i++){
- Character c = value.charAt(i);
- String charName = Character.getName(c.hashCode());
- usedValue += charNameToVarName(charName);
- }
- // remove trailing _
- usedValue = usedValue.replaceAll("[_]$", "");
- }
- return usedValue;
- }
-
- /**
- * Replace - and " " with _
- * Remove SIGN
- *
- * @param charName
- * @return
- */
- private String charNameToVarName(String charName) {
- String varName = charName.replaceAll("[\\-\\s]", "_");
- varName = varName.replaceAll("SIGN", "");
- return varName;
- }
-
- protected List> buildEnumVars(List values, String dataType) {
- List> enumVars = new ArrayList<>();
- int truncateIdx = 0;
-
- if (isRemoveEnumValuePrefix()) {
- String commonPrefix = findCommonPrefixOfVars(values);
- truncateIdx = commonPrefix.length();
- }
-
- for (Object value : values) {
- Map enumVar = new HashMap<>();
- String enumName;
- if (truncateIdx == 0) {
- enumName = String.valueOf(value);
- } else {
- enumName = value.toString().substring(truncateIdx);
- if (enumName.isEmpty()) {
- enumName = value.toString();
- }
- }
-
- enumVar.put("name", toEnumVarName(enumName, dataType));
- if (value instanceof Integer) {
- enumVar.put("value", value);
- } else if (value instanceof Double) {
- enumVar.put("value", value);
- } else if (value instanceof Long) {
- enumVar.put("value", value);
- } else if (value instanceof Float) {
- enumVar.put("value", value);
- } else if (value instanceof BigDecimal) {
- enumVar.put("value", value);
- } else if (value == null) {
- enumVar.put("value", "schemas.NoneClass.NONE");
- } else if (value instanceof Boolean) {
- if (value.equals(Boolean.TRUE)) {
- enumVar.put("value", "schemas.BoolClass.TRUE");
- } else {
- enumVar.put("value", "schemas.BoolClass.FALSE");
- }
- } else {
- String fixedValue = (String) processTestExampleData(value);
- enumVar.put("value", ensureQuotes(fixedValue));
- }
- enumVar.put("isString", isDataTypeString(dataType));
- enumVars.add(enumVar);
- }
-
- if (enumUnknownDefaultCase) {
- // If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.
- // With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
- Map enumVar = new HashMap<>();
- String enumName = enumUnknownDefaultCaseName;
-
- String enumValue;
- if (isDataTypeString(dataType)) {
- enumValue = enumUnknownDefaultCaseName;
- } else {
- // This is a dummy value that attempts to avoid collisions with previously specified cases.
- // Int.max / 192
- // The number 192 that is used to calculate this random value, is the Swift Evolution proposal for frozen/non-frozen enums.
- // [SE-0192](https://github.com/apple/swift-evolution/blob/master/proposals/0192-non-exhaustive-enums.md)
- // Since this functionality was born in the Swift 5 generator and latter on broth to all generators
- // https://github.com/OpenAPITools/openapi-generator/pull/11013
- enumValue = String.valueOf(11184809);
- }
-
- enumVar.put("name", toEnumVarName(enumName, dataType));
- enumVar.put("value", toEnumValue(enumValue, dataType));
- enumVar.put("isString", isDataTypeString(dataType));
- enumVars.add(enumVar);
- }
-
- return enumVars;
- }
-
- @Override
- public void postProcessParameter(CodegenParameter p) {
- postProcessPattern(p.pattern, p.vendorExtensions);
- if (p.baseType != null && languageSpecificPrimitives.contains(p.baseType)) {
- // set baseType to null so the api docs will not point to a model for languageSpecificPrimitives
- p.baseType = null;
- }
- }
-
- /**
- * Sets the value of the 'model.parent' property in CodegenModel
- * We have a custom version of this function so we can add the dataType on the ArrayModel
- */
- @Override
- protected void addParentContainer(CodegenModel model, String name, Schema schema) {
- super.addParentContainer(model, name, schema);
-
- List referencedModelNames = new ArrayList();
- model.dataType = getTypeString(schema, "", "", referencedModelNames);
- }
-
- protected String toTestCaseName(String specTestCaseName) {
- return CaseFormat.UPPER_CAMEL.to(CaseFormat.LOWER_UNDERSCORE, specTestCaseName);
- }
-
- protected String handleSpecialCharacters(String value) {
- // handles escape characters and the like
- String stringValue = value;
- String backslash = "\\";
- if (stringValue.contains(backslash)) {
- stringValue = stringValue.replace(backslash, "\\\\");
- }
- String nullChar = "\0";
- if (stringValue.contains(nullChar)) {
- stringValue = stringValue.replace(nullChar, "\\x00");
- }
- String doubleQuoteChar = "\"";
- if (stringValue.contains(doubleQuoteChar)) {
- stringValue = stringValue.replace(doubleQuoteChar, "\\\"");
- }
- String lineSep = System.lineSeparator();
- if (stringValue.contains(lineSep)) {
- stringValue = stringValue.replace(lineSep, "\\n");
- }
- String carriageReturn = "\r";
- if (stringValue.contains(carriageReturn)) {
- stringValue = stringValue.replace(carriageReturn, "\\r");
- }
- String tab = "\t";
- if (stringValue.contains(tab)) {
- stringValue = stringValue.replace(tab, "\\t");
- }
- String formFeed = "\f";
- if (stringValue.contains(formFeed)) {
- stringValue = stringValue.replace(formFeed, "\\f");
- }
- return stringValue;
- }
-
- protected Object processTestExampleData(Object value) {
- if (value instanceof Integer){
- return value;
- } else if (value instanceof Double || value instanceof Float || value instanceof Boolean){
- return value;
- } else if (value instanceof String) {
- return handleSpecialCharacters((String) value);
- } else if (value instanceof LinkedHashMap) {
- LinkedHashMap fixedValues = new LinkedHashMap();
- for (Map.Entry entry: ((LinkedHashMap) value).entrySet()) {
- String entryKey = (String) processTestExampleData(entry.getKey());
- Object entryValue = processTestExampleData(entry.getValue());
- fixedValues.put(entryKey, entryValue);
- }
- return fixedValues;
- } else if (value instanceof ArrayList) {
- ArrayList fixedValues = (ArrayList) value;
- for (int i = 0; i < fixedValues.size(); i++) {
- Object item = processTestExampleData(fixedValues.get(i));
- fixedValues.set(i, item);
- }
- return fixedValues;
- } else if (value == null) {
- return value;
- }
- return value;
- }
-
- /**
- * Convert OAS Model object to Codegen Model object
- * We have a custom version of this method so we can:
- * - set the correct regex values for requiredVars + optionalVars
- * - set model.defaultValue and model.hasRequired per the three use cases defined in this method
- *
- * @param name the name of the model
- * @param sc OAS Model object
- * @return Codegen Model object
- */
- @Override
- public CodegenModel fromModel(String name, Schema sc) {
- CodegenModel cm = super.fromModel(name, sc);
-
- if (cm.isNullable) {
- cm.setIsNull(true);
- cm.isNullable = false;
- cm.setHasMultipleTypes(true);
- }
- Boolean isNotPythonModelSimpleModel = (ModelUtils.isComposedSchema(sc) || ModelUtils.isObjectSchema(sc) || ModelUtils.isMapSchema(sc));
- setAdditionalPropsAndItemsVarNames(cm);
- if (isNotPythonModelSimpleModel) {
- return cm;
- }
- String defaultValue = toDefaultValue(sc);
- if (sc.getDefault() != null) {
- cm.defaultValue = defaultValue;
- }
- return cm;
- }
-
- /**
- * Returns the python type for the property.
- *
- * @param schema property schema
- * @return string presentation of the type
- **/
- @SuppressWarnings("static-method")
- @Override
- public String getSchemaType(Schema schema) {
- String openAPIType = getSingleSchemaType(schema);
- if (typeMapping.containsKey(openAPIType)) {
- String type = typeMapping.get(openAPIType);
- return type;
- }
- return toModelName(openAPIType);
- }
-
- public String getModelName(Schema sc) {
- if (sc.get$ref() != null) {
- Schema unaliasedSchema = unaliasSchema(sc);
- if (unaliasedSchema.get$ref() != null) {
- return toModelName(ModelUtils.getSimpleRef(sc.get$ref()));
- }
- }
- return null;
- }
-
- /**
- * Return a string representation of the Python types for the specified OAS schema.
- * Primitive types in the OAS specification are implemented in Python using the corresponding
- * Python primitive types.
- * Composed types (e.g. allAll, oneOf, anyOf) are represented in Python using list of types.
- *
- * The caller should set the prefix and suffix arguments to empty string, except when
- * getTypeString invokes itself recursively. A non-empty prefix/suffix may be specified
- * to wrap the return value in a python dict, list or tuple.
- *
- * Examples:
- * - "bool, date, float" The data must be a bool, date or float.
- * - "[bool, date]" The data must be an array, and the array items must be a bool or date.
- *
- * @param p The OAS schema.
- * @param prefix prepended to the returned value.
- * @param suffix appended to the returned value.
- * @param referencedModelNames a list of models that are being referenced while generating the types,
- * may be used to generate imports.
- * @return a comma-separated string representation of the Python types
- */
- private String getTypeString(Schema p, String prefix, String suffix, List referencedModelNames) {
- String fullSuffix = suffix;
- if (")".equals(suffix)) {
- fullSuffix = "," + suffix;
- }
- if (StringUtils.isNotEmpty(p.get$ref())) {
- // The input schema is a reference. If the resolved schema is
- // a composed schema, convert the name to a Python class.
- Schema unaliasedSchema = unaliasSchema(p);
- if (unaliasedSchema.get$ref() != null) {
- String modelName = toModelName(ModelUtils.getSimpleRef(p.get$ref()));
- if (referencedModelNames != null) {
- referencedModelNames.add(modelName);
- }
- return prefix + modelName + fullSuffix;
- }
- }
- if (ModelUtils.isAnyType(p)) {
- return prefix + "bool, date, datetime, dict, float, int, list, str, none_type" + suffix;
- }
- // Resolve $ref because ModelUtils.isXYZ methods do not automatically resolve references.
- if (ModelUtils.isNullable(ModelUtils.getReferencedSchema(this.openAPI, p))) {
- fullSuffix = ", none_type" + suffix;
- }
- if (ModelUtils.isNumberSchema(p)) {
- return prefix + "int, float" + fullSuffix;
- } else if (ModelUtils.isTypeObjectSchema(p)) {
- if (p.getAdditionalProperties() != null && p.getAdditionalProperties().equals(false)) {
- if (p.getProperties() == null) {
- // type object with no properties and additionalProperties = false, empty dict only
- return prefix + "{str: typing.Any}" + fullSuffix;
- } else {
- // properties only
- // TODO add type hints for those properties only as values
- return prefix + "{str: typing.Any}" + fullSuffix;
- }
- } else {
- // additionalProperties exists
- Schema inner = getAdditionalProperties(p);
- return prefix + "{str: " + getTypeString(inner, "(", ")", referencedModelNames) + "}" + fullSuffix;
- // TODO add code here to add property values too if they exist
- }
- } else if (ModelUtils.isArraySchema(p)) {
- ArraySchema ap = (ArraySchema) p;
- Schema inner = ap.getItems();
- if (inner == null) {
- // In OAS 3.0.x, the array "items" attribute is required.
- // In OAS >= 3.1, the array "items" attribute is optional such that the OAS
- // specification is aligned with the JSON schema specification.
- // When "items" is not specified, the elements of the array may be anything at all.
- // In that case, the return value should be:
- // "[bool, date, datetime, dict, float, int, list, str, none_type]"
- // Using recursion to wrap the allowed python types in an array.
- Schema anyType = new Schema(); // A Schema without any attribute represents 'any type'.
- return getTypeString(anyType, "[", "]", referencedModelNames);
- } else {
- return prefix + getTypeString(inner, "[", "]", referencedModelNames) + fullSuffix;
- }
- } else if (ModelUtils.isFileSchema(p)) {
- return prefix + "file_type" + fullSuffix;
- }
- String baseType = getSchemaType(p);
- return prefix + baseType + fullSuffix;
- }
-
- /**
- * Output the type declaration of a given name
- *
- * @param p property schema
- * @return a string presentation of the type
- */
- @Override
- public String getTypeDeclaration(Schema p) {
- // this is used to set dataType, which defines a python tuple of classes
- // in Python we will wrap this in () to make it a tuple but here we
- // will omit the parens so the generated documentation will not include
- // them
- return getTypeString(p, "", "", null);
- }
-
- @Override
- public String toInstantiationType(Schema property) {
- if (ModelUtils.isArraySchema(property) || ModelUtils.isMapSchema(property) || property.getAdditionalProperties() != null) {
- return getSchemaType(property);
- }
- return super.toInstantiationType(property);
- }
-
- @Override
- protected void addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel, Schema schema) {
- }
-
- /**
- * Gets an example if it exists
- *
- * @param sc input schema
- * @return the example value
- */
- protected Object getObjectExample(Schema sc) {
- Schema schema = sc;
- String ref = sc.get$ref();
- if (ref != null) {
- schema = ModelUtils.getSchema(this.openAPI, ModelUtils.getSimpleRef(ref));
- }
- // TODO handle examples in object models in the future
- Boolean objectModel = (ModelUtils.isObjectSchema(schema) || ModelUtils.isMapSchema(schema) || ModelUtils.isComposedSchema(schema));
- if (objectModel) {
- return null;
- }
- if (schema.getExample() != null) {
- return schema.getExample();
- }
- if (schema.getDefault() != null) {
- return schema.getDefault();
- } else if (schema.getEnum() != null && !schema.getEnum().isEmpty()) {
- return schema.getEnum().get(0);
- }
- return null;
- }
-
- /***
- * Ensures that the string has a leading and trailing quote
- *
- * @param in input string
- * @return quoted string
- */
- private String ensureQuotes(String in) {
- String strPattern = "^['\"].*?['\"]$";
- if (in.matches(strPattern)) {
- return in;
- }
- return "\"" + in + "\"";
- }
-
- @Override
- public String toExampleValue(Schema schema) {
- String modelName = getModelName(schema);
- Object objExample = getObjectExample(schema);
- return toExampleValueRecursive(modelName, schema, objExample, 1, "", 0, new ArrayList<>());
- }
-
- public String toExampleValue(Schema schema, Object objExample) {
- String modelName = getModelName(schema);
- return toExampleValueRecursive(modelName, schema, objExample, 1, "", 0, new ArrayList<>());
- }
-
- private Boolean simpleStringSchema(Schema schema) {
- Schema sc = schema;
- String ref = schema.get$ref();
- if (ref != null) {
- sc = ModelUtils.getSchema(this.openAPI, ModelUtils.getSimpleRef(ref));
- }
- if (ModelUtils.isStringSchema(sc) && !ModelUtils.isDateSchema(sc) && !ModelUtils.isDateTimeSchema(sc) && !"Number".equalsIgnoreCase(sc.getFormat()) && !ModelUtils.isByteArraySchema(sc) && !ModelUtils.isBinarySchema(sc) && schema.getPattern() == null) {
- return true;
- }
- return false;
- }
-
- private MappedModel getDiscriminatorMappedModel(CodegenDiscriminator disc) {
- for (MappedModel mm : disc.getMappedModels()) {
- String modelName = mm.getModelName();
- Schema modelSchema = getModelNameToSchemaCache().get(modelName);
- if (ModelUtils.isObjectSchema(modelSchema)) {
- return mm;
- }
- }
- return null;
- }
-
- /***
- * Recursively generates string examples for schemas
- *
- * @param modelName the string name of the refed model that will be generated for the schema or null
- * @param schema the schema that we need an example for
- * @param objExample the example that applies to this schema, for now only string example are used
- * @param indentationLevel integer indentation level that we are currently at
- * we assume the indentaion amount is 4 spaces times this integer
- * @param prefix the string prefix that we will use when assigning an example for this line
- * this is used when setting key: value, pairs "key: " is the prefix
- * and this is used when setting properties like some_property='some_property_example'
- * @param exampleLine this is the current line that we are generatign an example for, starts at 0
- * we don't indentin the 0th line because using the example value looks like:
- * prop = ModelName( line 0
- * some_property='some_property_example' line 1
- * ) line 2
- * and our example value is:
- * ModelName( line 0
- * some_property='some_property_example' line 1
- * ) line 2
- * @param includedSchemas are a list of schemas that we have moved through to get here. If the new schemas that we
- * are looking at is in includedSchemas then we have hit a cycle.
- * @return the string example
- */
- private String toExampleValueRecursive(String modelName, Schema schema, Object objExample, int indentationLevel, String prefix, Integer exampleLine, List includedSchemas) {
- boolean couldHaveCycle = includedSchemas.size() > 0 && potentiallySelfReferencingSchema(schema);
- // If we have seen the ContextAwareSchemaNode more than once before, we must be in a cycle.
- boolean cycleFound = false;
- if (couldHaveCycle) {
- cycleFound = includedSchemas.subList(0, includedSchemas.size()-1).stream().anyMatch(s -> schema.equals(s));
- }
- final String indentionConst = " ";
- String currentIndentation = "";
- String closingIndentation = "";
- for (int i = 0; i < indentationLevel; i++) currentIndentation += indentionConst;
- if (exampleLine.equals(0)) {
- closingIndentation = currentIndentation;
- currentIndentation = "";
- } else {
- closingIndentation = currentIndentation;
- }
- String openChars = "";
- String closeChars = "";
- if (modelName != null) {
- openChars = modelName + "(";
- closeChars = ")";
- }
-
- String fullPrefix = currentIndentation + prefix + openChars;
-
- String example = null;
- if (objExample != null) {
- example = objExample.toString();
- }
- if (null != schema.get$ref()) {
- Map allDefinitions = ModelUtils.getSchemas(this.openAPI);
- String ref = ModelUtils.getSimpleRef(schema.get$ref());
- Schema refSchema = allDefinitions.get(ref);
- if (null == refSchema) {
- LOGGER.warn("Unable to find referenced schema " + schema.get$ref() + "\n");
- return fullPrefix + "None" + closeChars;
- }
- String refModelName = getModelName(schema);
- return toExampleValueRecursive(refModelName, refSchema, objExample, indentationLevel, prefix, exampleLine, includedSchemas);
- } else if (ModelUtils.isNullType(schema)) {
- // The 'null' type is allowed in OAS 3.1 and above. It is not supported by OAS 3.0.x,
- // though this tooling supports it.
- return fullPrefix + "None" + closeChars;
- } else if (ModelUtils.isAnyType(schema)) {
- /*
- This schema may be a composed schema
- TODO generate examples for some of these use cases in the future like
- only oneOf without a discriminator
- */
- if (cycleFound) {
- return "";
- }
- Boolean hasProperties = (schema.getProperties() != null && !schema.getProperties().isEmpty());
- CodegenDiscriminator disc = createDiscriminator(modelName, schema, openAPI);
- if (ModelUtils.isComposedSchema(schema)) {
- if(includedSchemas.contains(schema)) {
- return "";
- }
- includedSchemas.add(schema);
- // complex composed object type schemas not yet handled and the code returns early
- if (hasProperties) {
- // what if this composed schema defined properties + allOf?
- // or items + properties, both a ist and a dict could be accepted as payloads
- return fullPrefix + "{}" + closeChars;
- }
- ComposedSchema cs = (ComposedSchema) schema;
- Integer allOfExists = 0;
- if (cs.getAllOf() != null && !cs.getAllOf().isEmpty()) {
- allOfExists = 1;
- }
- Integer anyOfExists = 0;
- if (cs.getAnyOf() != null && !cs.getAnyOf().isEmpty()) {
- anyOfExists = 1;
- }
- Integer oneOfExists = 0;
- if (cs.getOneOf() != null && !cs.getOneOf().isEmpty()) {
- oneOfExists = 1;
- }
- if (allOfExists + anyOfExists + oneOfExists > 1) {
- // what if it needs one oneOf schema, one anyOf schema, and two allOf schemas?
- return fullPrefix + "None" + closeChars;
- }
- // for now only oneOf with discriminator is supported
- if (oneOfExists == 1 && disc != null) {
- ;
- } else {
- return fullPrefix + "None" + closeChars;
- }
- }
- if (disc != null) {
- // a discriminator means that the type must be object
- MappedModel mm = getDiscriminatorMappedModel(disc);
- if (mm == null) {
- return fullPrefix + "None" + closeChars;
- }
- String discPropNameValue = mm.getMappingName();
- String chosenModelName = mm.getModelName();
- Schema modelSchema = getModelNameToSchemaCache().get(chosenModelName);
- CodegenProperty cp = new CodegenProperty();
- cp.setName(disc.getPropertyName());
- cp.setExample(discPropNameValue);
- return exampleForObjectModel(modelSchema, fullPrefix, closeChars, cp, indentationLevel, exampleLine, closingIndentation, includedSchemas);
- }
- return fullPrefix + "None" + closeChars;
- } else if (ModelUtils.isBooleanSchema(schema)) {
- if (example == null) {
- example = "True";
- } else {
- if ("false".equalsIgnoreCase(objExample.toString())) {
- example = "False";
- } else {
- example = "True";
- }
- }
- return fullPrefix + example + closeChars;
- } else if (ModelUtils.isStringSchema(schema)) {
- if (example != null) {
- return fullPrefix + ensureQuotes(handleSpecialCharacters(example)) + closeChars;
- }
- if (ModelUtils.isDateSchema(schema)) {
- if (objExample == null) {
- example = pythonDate("1970-01-01");
- } else {
- example = pythonDate(objExample);
- }
- } else if (ModelUtils.isDateTimeSchema(schema)) {
- if (objExample == null) {
- example = pythonDateTime("1970-01-01T00:00:00.00Z");
- } else {
- example = pythonDateTime(objExample);
- }
- } else if (ModelUtils.isBinarySchema(schema)) {
- if (example == null) {
- example = "/path/to/file";
- }
- example = "open('" + example + "', 'rb')";
- return fullPrefix + example + closeChars;
- } else if (ModelUtils.isByteArraySchema(schema)) {
- if (objExample == null) {
- example = "'YQ=='";
- }
- } else if ("Number".equalsIgnoreCase(schema.getFormat())) {
- // a BigDecimal:
- example = "2";
- } else if (StringUtils.isNotBlank(schema.getPattern())) {
- String pattern = schema.getPattern();
- /*
- RxGen does not support our ECMA dialect https://github.com/curious-odd-man/RgxGen/issues/56
- So strip off the leading / and trailing / and turn on ignore case if we have it
- */
- Pattern valueExtractor = Pattern.compile("^/?(.+?)/?(.?)$");
- Matcher m = valueExtractor.matcher(pattern);
- RgxGen rgxGen = null;
- if (m.find()) {
- int groupCount = m.groupCount();
- if (groupCount == 1) {
- // only pattern found
- String isolatedPattern = m.group(1);
- rgxGen = new RgxGen(isolatedPattern);
- } else if (groupCount == 2) {
- // patterns and flag found
- String isolatedPattern = m.group(1);
- String flags = m.group(2);
- if (flags.contains("i")) {
- rgxGen = new RgxGen(isolatedPattern);
- RgxGenProperties properties = new RgxGenProperties();
- RgxGenOption.CASE_INSENSITIVE.setInProperties(properties, true);
- rgxGen.setProperties(properties);
- } else {
- rgxGen = new RgxGen(isolatedPattern);
- }
- }
- } else {
- rgxGen = new RgxGen(pattern);
- }
-
- // this seed makes it so if we have [a-z] we pick a
- Random random = new Random(18);
- if (rgxGen != null) {
- example = rgxGen.generate(random);
- } else {
- throw new RuntimeException("rgxGen cannot be null. Please open an issue in the openapi-generator github repo.");
- }
- } else if (schema.getMinLength() != null) {
- example = "";
- int len = schema.getMinLength().intValue();
- for (int i = 0; i < len; i++) example += "a";
- } else if (ModelUtils.isUUIDSchema(schema)) {
- example = "046b6c7f-0b8a-43b9-b35d-6489e6daee91";
- } else {
- example = "string_example";
- }
- return fullPrefix + ensureQuotes(example) + closeChars;
- } else if (ModelUtils.isIntegerSchema(schema)) {
- if (objExample == null) {
- if (schema.getMinimum() != null) {
- example = schema.getMinimum().toString();
- } else {
- example = "1";
- }
- }
- return fullPrefix + example + closeChars;
- } else if (ModelUtils.isNumberSchema(schema)) {
- if (objExample == null) {
- if (schema.getMinimum() != null) {
- example = schema.getMinimum().toString();
- } else {
- example = "3.14";
- }
- }
- return fullPrefix + example + closeChars;
- } else if (ModelUtils.isArraySchema(schema)) {
- if (objExample instanceof Iterable) {
- // If the example is already a list, return it directly instead of wrongly wrap it in another list
- return fullPrefix + objExample.toString() + closeChars;
- }
- if (ModelUtils.isComposedSchema(schema)) {
- // complex composed array type schemas not yet handled and the code returns early
- return fullPrefix + "[]" + closeChars;
- }
- ArraySchema arrayschema = (ArraySchema) schema;
- Schema itemSchema = arrayschema.getItems();
- String itemModelName = getModelName(itemSchema);
- if(includedSchemas.contains(schema)) {
- return "";
- }
- includedSchemas.add(schema);
- String itemExample = toExampleValueRecursive(itemModelName, itemSchema, objExample, indentationLevel + 1, "", exampleLine + 1, includedSchemas);
- if (StringUtils.isEmpty(itemExample) || cycleFound) {
- return fullPrefix + "[]" + closeChars;
- } else {
- return fullPrefix + "[" + "\n" + itemExample + "\n" + closingIndentation + "]" + closeChars;
- }
- } else if (ModelUtils.isTypeObjectSchema(schema)) {
- if (modelName == null) {
- fullPrefix += "dict(";
- closeChars = ")";
- }
- if (cycleFound) {
- return fullPrefix + closeChars;
- }
- Boolean hasProperties = (schema.getProperties() != null && !schema.getProperties().isEmpty());
- CodegenDiscriminator disc = createDiscriminator(modelName, schema, openAPI);
- if (ModelUtils.isComposedSchema(schema)) {
- // complex composed object type schemas not yet handled and the code returns early
- if (hasProperties) {
- // what if this composed schema defined properties + allOf?
- return fullPrefix + closeChars;
- }
- ComposedSchema cs = (ComposedSchema) schema;
- Integer allOfExists = 0;
- if (cs.getAllOf() != null && !cs.getAllOf().isEmpty()) {
- allOfExists = 1;
- }
- Integer anyOfExists = 0;
- if (cs.getAnyOf() != null && !cs.getAnyOf().isEmpty()) {
- anyOfExists = 1;
- }
- Integer oneOfExists = 0;
- if (cs.getOneOf() != null && !cs.getOneOf().isEmpty()) {
- oneOfExists = 1;
- }
- if (allOfExists + anyOfExists + oneOfExists > 1) {
- // what if it needs one oneOf schema, one anyOf schema, and two allOf schemas?
- return fullPrefix + closeChars;
- }
- // for now only oneOf with discriminator is supported
- if (oneOfExists == 1 && disc != null) {
- ;
- } else {
- return fullPrefix + closeChars;
- }
- }
- if (disc != null) {
- MappedModel mm = getDiscriminatorMappedModel(disc);
- if (mm == null) {
- return fullPrefix + closeChars;
- }
- String discPropNameValue = mm.getMappingName();
- String chosenModelName = mm.getModelName();
- Schema modelSchema = getModelNameToSchemaCache().get(chosenModelName);
- CodegenProperty cp = new CodegenProperty();
- cp.setName(disc.getPropertyName());
- cp.setExample(discPropNameValue);
- return exampleForObjectModel(modelSchema, fullPrefix, closeChars, cp, indentationLevel, exampleLine, closingIndentation, includedSchemas);
- }
- Object addPropsObj = schema.getAdditionalProperties();
- if (hasProperties) {
- return exampleForObjectModel(schema, fullPrefix, closeChars, null, indentationLevel, exampleLine, closingIndentation, includedSchemas);
- } else if (addPropsObj instanceof Schema) {
- // TODO handle true case for additionalProperties
- Schema addPropsSchema = (Schema) addPropsObj;
- String key = "key";
- Object addPropsExample = getObjectExample(addPropsSchema);
- if (addPropsSchema.getEnum() != null && !addPropsSchema.getEnum().isEmpty()) {
- key = addPropsSchema.getEnum().get(0).toString();
- }
- addPropsExample = exampleFromStringOrArraySchema(addPropsSchema, addPropsExample, key);
- String addPropPrefix = key + "=";
- if (modelName == null) {
- addPropPrefix = ensureQuotes(key) + ": ";
- }
- String addPropsModelName = getModelName(addPropsSchema);
- if(includedSchemas.contains(schema)) {
- return "";
- }
- includedSchemas.add(schema);
-
- example = fullPrefix + "\n" + toExampleValueRecursive(addPropsModelName, addPropsSchema, addPropsExample, indentationLevel + 1, addPropPrefix, exampleLine + 1, includedSchemas) + ",\n" + closingIndentation + closeChars;
- } else {
- example = fullPrefix + closeChars;
- }
- } else {
- LOGGER.warn("Type " + schema.getType() + " not handled properly in toExampleValue");
- }
-
- return example;
- }
-
- private boolean potentiallySelfReferencingSchema(Schema schema) {
- return null != schema.get$ref() || ModelUtils.isArraySchema(schema) || ModelUtils.isMapSchema(schema) || ModelUtils.isObjectSchema(schema) || ModelUtils.isComposedSchema(schema);
- }
-
- private String exampleForObjectModel(Schema schema, String fullPrefix, String closeChars, CodegenProperty discProp, int indentationLevel, int exampleLine, String closingIndentation, List includedSchemas) {
-
- Map requiredAndOptionalProps = schema.getProperties();
- if (requiredAndOptionalProps == null || requiredAndOptionalProps.isEmpty()) {
- return fullPrefix + closeChars;
- }
-
- if(includedSchemas.contains(schema)) {
- return "";
- }
- includedSchemas.add(schema);
-
- String example = fullPrefix + "\n";
-
- for (Map.Entry entry : requiredAndOptionalProps.entrySet()) {
- String propName = entry.getKey();
- Schema propSchema = entry.getValue();
- propName = toVarName(propName);
- String propModelName = null;
- Object propExample = null;
- if (discProp != null && propName.equals(discProp.name)) {
- propModelName = null;
- propExample = discProp.example;
- } else {
- propModelName = getModelName(propSchema);
- propExample = exampleFromStringOrArraySchema(
- propSchema,
- null,
- propName);
- }
-
- example += toExampleValueRecursive(propModelName,
- propSchema,
- propExample,
- indentationLevel + 1,
- propName + "=",
- exampleLine + 1,
- includedSchemas) + ",\n";
- }
-
- // TODO handle additionalProperties also
- example += closingIndentation + closeChars;
- return example;
-
- }
-
- private Object exampleFromStringOrArraySchema(Schema sc, Object currentExample, String propName) {
- if (currentExample != null) {
- return currentExample;
- }
- Schema schema = sc;
- String ref = sc.get$ref();
- if (ref != null) {
- schema = ModelUtils.getSchema(this.openAPI, ModelUtils.getSimpleRef(ref));
- }
- Object example = getObjectExample(schema);
- if (example != null) {
- return example;
- } else if (simpleStringSchema(schema)) {
- return propName + "_example";
- } else if (ModelUtils.isArraySchema(schema)) {
- ArraySchema arraySchema = (ArraySchema) schema;
- Schema itemSchema = arraySchema.getItems();
- example = getObjectExample(itemSchema);
- if (example != null) {
- return example;
- } else if (simpleStringSchema(itemSchema)) {
- return propName + "_example";
- }
- }
- return null;
- }
-
-
- /***
- *
- * Set the codegenParameter example value
- * We have a custom version of this function so we can invoke toExampleValue
- *
- * @param codegenParameter the item we are setting the example on
- * @param parameter the base parameter that came from the spec
- */
- @Override
- public void setParameterExampleValue(CodegenParameter codegenParameter, Parameter parameter) {
- Schema schema = parameter.getSchema();
- if (schema == null) {
- LOGGER.warn("CodegenParameter.example defaulting to null because parameter lacks a schema");
- return;
- }
-
- Object example = null;
- if (codegenParameter.vendorExtensions != null && codegenParameter.vendorExtensions.containsKey("x-example")) {
- example = codegenParameter.vendorExtensions.get("x-example");
- } else if (parameter.getExample() != null) {
- example = parameter.getExample();
- } else if (parameter.getExamples() != null && !parameter.getExamples().isEmpty() && parameter.getExamples().values().iterator().next().getValue() != null) {
- example = parameter.getExamples().values().iterator().next().getValue();
- } else {
- example = getObjectExample(schema);
- }
- example = exampleFromStringOrArraySchema(schema, example, parameter.getName());
- String finalExample = toExampleValue(schema, example);
- codegenParameter.example = finalExample;
- }
-
- /**
- * Return the example value of the parameter.
- *
- * @param codegenParameter Codegen parameter
- * @param requestBody Request body
- */
- @Override
- public void setParameterExampleValue(CodegenParameter codegenParameter, RequestBody requestBody) {
- if (codegenParameter.vendorExtensions != null && codegenParameter.vendorExtensions.containsKey("x-example")) {
- codegenParameter.example = Json.pretty(codegenParameter.vendorExtensions.get("x-example"));
- }
-
- Content content = requestBody.getContent();
-
- if (content.size() > 1) {
- // @see ModelUtils.getSchemaFromContent()
- once(LOGGER).warn("Multiple MediaTypes found, using only the first one");
- }
-
- MediaType mediaType = content.values().iterator().next();
- Schema schema = mediaType.getSchema();
- if (schema == null) {
- LOGGER.warn("CodegenParameter.example defaulting to null because requestBody content lacks a schema");
- return;
- }
-
- Object example = null;
- if (mediaType.getExample() != null) {
- example = mediaType.getExample();
- } else if (mediaType.getExamples() != null && !mediaType.getExamples().isEmpty() && mediaType.getExamples().values().iterator().next().getValue() != null) {
- example = mediaType.getExamples().values().iterator().next().getValue();
- } else {
- example = getObjectExample(schema);
- }
- example = exampleFromStringOrArraySchema(schema, example, codegenParameter.paramName);
- codegenParameter.example = toExampleValue(schema, example);
- }
-
- /**
- * Create a CodegenParameter for a Form Property
- * We have a custom version of this method so we can invoke
- * setParameterExampleValue(codegenParameter, parameter)
- * rather than setParameterExampleValue(codegenParameter)
- * This ensures that all of our samples are generated in
- * toExampleValueRecursive
- *
- * @param name the property name
- * @param propertySchema the property schema
- * @param imports our import set
- * @return the resultant CodegenParameter
- */
- @Override
- public CodegenParameter fromFormProperty(String name, Schema propertySchema, Set imports) {
- CodegenParameter cp = super.fromFormProperty(name, propertySchema, imports);
- Parameter p = new Parameter();
- p.setSchema(propertySchema);
- p.setName(cp.paramName);
- setParameterExampleValue(cp, p);
- return cp;
- }
-
- /**
- * Return a map from model name to Schema for efficient lookup.
- *
- * @return map from model name to Schema.
- */
- protected Map getModelNameToSchemaCache() {
- if (modelNameToSchemaCache == null) {
- // Create a cache to efficiently lookup schema based on model name.
- Map m = new HashMap();
- ModelUtils.getSchemas(openAPI).forEach((key, schema) -> {
- m.put(toModelName(key), schema);
- });
- modelNameToSchemaCache = Collections.unmodifiableMap(m);
- }
- return modelNameToSchemaCache;
- }
-
- /**
- * Use cases:
- * additional properties is unset: do nothing
- * additional properties is true: add definiton to property
- * additional properties is false: add definiton to property
- * additional properties is schema: add definiton to property
- *
- * @param schema the schema that may contain an additional property schema
- * @param property the property for the above schema
- */
- @Override
- protected void setAddProps(Schema schema, IJsonSchemaValidationProperties property){
- Schema addPropsSchema = getSchemaFromBooleanOrSchema(schema.getAdditionalProperties());
- if (addPropsSchema == null) {
- return;
- }
- CodegenProperty addPropProp = fromProperty("", addPropsSchema, false, false);
- property.setAdditionalProperties(addPropProp);
- }
-
- /**
- * Update property for array(list) container
- *
- * @param property Codegen property
- * @param innerProperty Codegen inner property of map or list
- */
- @Override
- protected void updatePropertyForArray(CodegenProperty property, CodegenProperty innerProperty) {
- if (innerProperty == null) {
- if(LOGGER.isWarnEnabled()) {
- LOGGER.warn("skipping invalid array property {}", Json.pretty(property));
- }
- return;
- }
- property.dataFormat = innerProperty.dataFormat;
- if (languageSpecificPrimitives.contains(innerProperty.baseType)) {
- property.isPrimitiveType = true;
- }
- property.items = innerProperty;
- property.mostInnerItems = getMostInnerItems(innerProperty);
- // inner item is Enum
- if (isPropertyInnerMostEnum(property)) {
- // isEnum is set to true when the type is an enum
- // or the inner type of an array/map is an enum
- property.isEnum = true;
- // update datatypeWithEnum and default value for array
- // e.g. List => List
- updateDataTypeWithEnumForArray(property);
- // set allowable values to enum values (including array/map of enum)
- property.allowableValues = getInnerEnumAllowableValues(property);
- }
-
- }
-
- /**
- * Sets the booleans that define the model's type
- *
- * @param model the model to update
- * @param schema the model's schema
- */
- protected void updateModelForString(CodegenModel model, Schema schema) {
- if (ModelUtils.isDateTimeSchema(schema)) {
- // isString stays true, format stores that this is a date-time
- } else if (ModelUtils.isDateSchema(schema)) {
- // isString stays true, format stores that this is a date
- } else if (ModelUtils.isUUIDSchema(schema)) {
- // isString stays true, format stores that this is a uuid
- } else if (ModelUtils.isDecimalSchema(schema)) {
- // isString stays true, format stores that this is a uuid
- } else if (ModelUtils.isBinarySchema(schema)) {
- // format stores that this is binary
- model.isString = true;
- }
- }
-
- protected void updateModelForNumber(CodegenModel model, Schema schema) {
- model.setIsNumber(true);
- // float vs double info is stored in format
- }
-
- protected void updateModelForInteger(CodegenModel model, Schema schema) {
- model.isInteger = true;
- // int32 int64 info is stored in format
- }
-
- protected void updatePropertyForString(CodegenProperty property, Schema p) {
- if (ModelUtils.isByteArraySchema(p)) {
- // isString stays true, format stores that this is a byte
- } else if (ModelUtils.isBinarySchema(p)) {
- // format stores that this is binary
- property.isString = true;
- } else if (ModelUtils.isUUIDSchema(p)) {
- // isString stays true, format stores that this is a uuid
- } else if (ModelUtils.isURISchema(p)) {
- property.isUri = true;
- } else if (ModelUtils.isEmailSchema(p)) {
- property.isEmail = true;
- } else if (ModelUtils.isDateSchema(p)) { // date format
- // isString stays true, format stores that this is a date
- } else if (ModelUtils.isDateTimeSchema(p)) { // date-time format
- // isString stays true, format stores that this is a date-time
- } else if (ModelUtils.isDecimalSchema(p)) { // type: string, format: number
- // isString stays true, format stores that this is a number
- }
- property.pattern = toRegularExpression(p.getPattern());
- }
-
- protected void updatePropertyForNumber(CodegenProperty property, Schema p) {
- property.setIsNumber(true);
- // float and double differentiation is determined with format info
- }
-
- protected void updatePropertyForInteger(CodegenProperty property, Schema p) {
- property.isInteger = true;
- // int32 and int64 differentiation is determined with format info
- }
-
-
- @Override
- protected void updatePropertyForObject(CodegenProperty property, Schema p) {
- addVarsRequiredVarsAdditionalProps(p, property);
- }
-
- @Override
- protected void updatePropertyForAnyType(CodegenProperty property, Schema p) {
- // The 'null' value is allowed when the OAS schema is 'any type'.
- // See https://github.com/OAI/OpenAPI-Specification/issues/1389
- if (Boolean.FALSE.equals(p.getNullable())) {
- LOGGER.warn("Schema '{}' is any type, which includes the 'null' value. 'nullable' cannot be set to 'false'", p.getName());
- }
- addVarsRequiredVarsAdditionalProps(p, property);
- }
-
- @Override
- protected void updateModelForObject(CodegenModel m, Schema schema) {
- // custom version of this method so properties are always added with addVars
- if (schema.getProperties() != null || schema.getRequired() != null) {
- // passing null to allProperties and allRequired as there's no parent
- addVars(m, unaliasPropertySchema(schema.getProperties()), schema.getRequired(), null, null);
- }
- // an object or anyType composed schema that has additionalProperties set
- addAdditionPropertiesToCodeGenModel(m, schema);
- // process 'additionalProperties'
- setAddProps(schema, m);
- addRequiredVarsMap(schema, m);
- }
-
- @Override
- protected void updateModelForAnyType(CodegenModel m, Schema schema) {
- // The 'null' value is allowed when the OAS schema is 'any type'.
- // See https://github.com/OAI/OpenAPI-Specification/issues/1389
- if (Boolean.FALSE.equals(schema.getNullable())) {
- LOGGER.error("Schema '{}' is any type, which includes the 'null' value. 'nullable' cannot be set to 'false'", m.name);
- }
- // todo add items support here in the future
- if (schema.getProperties() != null || schema.getRequired() != null) {
- // passing null to allProperties and allRequired as there's no parent
- addVars(m, unaliasPropertySchema(schema.getProperties()), schema.getRequired(), null, null);
- }
- addAdditionPropertiesToCodeGenModel(m, schema);
- // process 'additionalProperties'
- setAddProps(schema, m);
- addRequiredVarsMap(schema, m);
- }
-
- @Override
- protected void updateModelForComposedSchema(CodegenModel m, Schema schema, Map allDefinitions) {
- final ComposedSchema composed = (ComposedSchema) schema;
-
- // TODO revise the logic below to set discriminator, xml attributes
- if (composed.getAllOf() != null) {
- int modelImplCnt = 0; // only one inline object allowed in a ComposedModel
- int modelDiscriminators = 0; // only one discriminator allowed in a ComposedModel
- for (Schema innerSchema : composed.getAllOf()) { // TODO need to work with anyOf, oneOf as well
- if (m.discriminator == null && innerSchema.getDiscriminator() != null) {
- LOGGER.debug("discriminator is set to null (not correctly set earlier): {}", m.name);
- m.setDiscriminator(createDiscriminator(m.name, innerSchema, this.openAPI));
- if (!this.getLegacyDiscriminatorBehavior()) {
- m.addDiscriminatorMappedModelsImports();
- }
- modelDiscriminators++;
- }
-
- if (innerSchema.getXml() != null) {
- m.xmlPrefix = innerSchema.getXml().getPrefix();
- m.xmlNamespace = innerSchema.getXml().getNamespace();
- m.xmlName = innerSchema.getXml().getName();
- }
- if (modelDiscriminators > 1) {
- LOGGER.error("Allof composed schema is inheriting >1 discriminator. Only use one discriminator: {}", composed);
- }
-
- if (modelImplCnt++ > 1) {
- LOGGER.warn("More than one inline schema specified in allOf:. Only the first one is recognized. All others are ignored.");
- break; // only one schema with discriminator allowed in allOf
- }
- }
- }
-
- CodegenComposedSchemas cs = m.getComposedSchemas();
- if (cs != null) {
- if (cs.getAllOf() != null && !cs.getAllOf().isEmpty()) {
- for (CodegenProperty cp: cs.getAllOf()) {
- if (cp.complexType != null) {
- addImport(m, cp.complexType);
- }
- }
- }
- if (cs.getOneOf() != null && !cs.getOneOf().isEmpty()) {
- for (CodegenProperty cp: cs.getOneOf()) {
- if (cp.complexType != null) {
- addImport(m, cp.complexType);
- }
- }
- }
- if (cs.getAnyOf() != null && !cs.getAnyOf().isEmpty()) {
- for (CodegenProperty cp: cs.getAnyOf()) {
- if (cp.complexType != null) {
- addImport(m, cp.complexType);
- }
- }
- }
- }
- }
-
- @Override
- public ModelsMap postProcessModels(ModelsMap objs) {
- // process enum in models
- return postProcessModelsEnum(objs);
- }
-
- /*
- * The OpenAPI pattern spec follows the Perl convention and style of modifiers. Python
- * does not support this in as natural a way so it needs to convert it. See
- * https://docs.python.org/2/howto/regex.html#compilation-flags for details.
- */
- public void postProcessPattern(String pattern, Map vendorExtensions) {
- if (pattern != null) {
- int regexLength = pattern.length();
- String regex = pattern;
- int i = pattern.lastIndexOf('/');
- if (regexLength >= 2 && pattern.charAt(0) == '/' && i != -1) {
- // json schema tests do not include the leading and trailing slashes
- // so I do not think that they are required
- regex = pattern.substring(1, i);
- }
- regex = regex.replace("'", "\\'");
- List modifiers = new ArrayList();
-
- if (i != -1) {
- for (char c : pattern.substring(i).toCharArray()) {
- if (regexModifiers.containsKey(c)) {
- String modifier = regexModifiers.get(c);
- modifiers.add(modifier);
- }
- }
- }
-
- vendorExtensions.put("x-regex", regex);
- vendorExtensions.put("x-modifiers", modifiers);
- }
- }
-
- @Override
- public CodegenType getTag() {
- return CodegenType.CLIENT;
- }
-
- @Override
- public String apiDocFileFolder() {
- return (outputFolder + "/" + apiDocPath);
- }
-
- @Override
- public String modelDocFileFolder() {
- return (outputFolder + "/" + modelDocPath);
- }
-
- @Override
- public String toModelDocFilename(String name) {
- return toModelName(name);
- }
-
- @Override
- public String toApiDocFilename(String name) {
- return toApiName(name);
- }
-
- @Override
- public String addRegularExpressionDelimiter(String pattern) {
- if (StringUtils.isEmpty(pattern)) {
- return pattern;
- }
-
- if (!pattern.matches("^/.*")) {
- // Perform a negative lookbehind on each `/` to ensure that it is escaped.
- return "/" + pattern.replaceAll("(?
- * (PEP 0008) Python packages should also have short, all-lowercase names,
- * although the use of underscores is discouraged.
- *
- * @param packageName Package name
- * @return Python package name that conforms to PEP 0008
- */
- @SuppressWarnings("static-method")
- public String generatePackageName(String packageName) {
- return underscore(packageName.replaceAll("[^\\w]+", ""));
- }
-
- /**
- * A custom version of this method is needed to ensure that the form object parameter is kept as-is
- * as an object and is not exploded into separate parameters
- * @param body the body that is being handled
- * @param imports the imports for this body
- * @return the list of length one containing a single type object CodegenParameter
- */
- @Override
- public List fromRequestBodyToFormParameters(RequestBody body, Set imports) {
- List parameters = new ArrayList<>();
- LOGGER.debug("debugging fromRequestBodyToFormParameters= {}", body);
- Schema schema = ModelUtils.getSchemaFromRequestBody(body);
- schema = ModelUtils.getReferencedSchema(this.openAPI, schema);
- CodegenParameter cp = fromFormProperty("body", schema, imports);
- cp.setContent(getContent(body.getContent(), imports, "RequestBody"));
- cp.isFormParam = false;
- cp.isBodyParam = true;
- parameters.add(cp);
- return parameters;
- }
-
- /**
- * Custom version of this method so we can move the body parameter into bodyParam
- *
- * @param path the path of the operation
- * @param httpMethod HTTP method
- * @param operation OAS operation object
- * @param servers list of servers
- * @return the resultant CodegenOperation instance
- */
- @Override
- public CodegenOperation fromOperation(String path,
- String httpMethod,
- Operation operation,
- List servers) {
- CodegenOperation co = super.fromOperation(path, httpMethod, operation, servers);
- co.httpMethod = httpMethod.toLowerCase(Locale.ROOT);
- // smuggle the path enum variable name in operationIdLowerCase
- co.operationIdLowerCase = toEnumVarName(co.path, "str");
- // smuggle pathModuleName in nickname
- String pathModuleName = toVarName(path);
- co.nickname = pathModuleName;
- // smuggle path Api class name ins operationIdSnakeCase
- co.operationIdSnakeCase = toModelName(path);
-
- if (co.bodyParam == null) {
- for (CodegenParameter cp: co.allParams) {
- if (cp.isBodyParam) {
- co.bodyParam = cp;
- co.bodyParams.add(cp);
- }
- }
- }
- return co;
- }
-
- /**
- * Custom version of this method to prevent mutation of
- * codegenOperation.operationIdLowerCase/operationIdSnakeCase
- * Property Usages:
- * - operationId: endpoint method name when using tagged apis
- * - httpMethod: endpoint method name when using path apis
- * - operationIdCamelCase: Api class name containing single endpoint for tagged apis
- * - operationIdLowerCase: (smuggled) path enum variable name
- * - nickname: (smuggled) path module name for path apis
- * - operationIdSnakeCase: (smuggled) path Api class name when using path apis
- *
- * @param tag name of the tag
- * @param resourcePath path of the resource
- * @param operation OAS Operation object
- * @param co Codegen Operation object
- * @param operations map of Codegen operations
- */
- @Override
- @SuppressWarnings("static-method")
- public void addOperationToGroup(String tag, String resourcePath, Operation operation, CodegenOperation
- co, Map> operations) {
- List opList = operations.get(tag);
- if (opList == null) {
- opList = new ArrayList<>();
- operations.put(tag, opList);
- }
- // check for operationId uniqueness
- String uniqueName = co.operationId;
- int counter = 0;
- for (CodegenOperation op : opList) {
- if (uniqueName.equals(op.operationId)) {
- uniqueName = co.operationId + "_" + counter;
- counter++;
- }
- }
- if (!co.operationId.equals(uniqueName)) {
- LOGGER.warn("generated unique operationId `{}`", uniqueName);
- }
- co.operationId = uniqueName;
- co.operationIdCamelCase = camelize(uniqueName);
- opList.add(co);
- co.baseName = tag;
- }
-
- @Override
- public String defaultTemplatingEngine() {
- return "handlebars";
- }
-
- @Override
- public String generatorLanguageVersion() { return ">=3.7"; };
-
- @Override
- public void preprocessOpenAPI(OpenAPI openAPI) {
- String originalSpecVersion;
- String xOriginalSwaggerVersion = "x-original-swagger-version";
- if (openAPI.getExtensions() != null && !openAPI.getExtensions().isEmpty() && openAPI.getExtensions().containsValue(xOriginalSwaggerVersion)) {
- originalSpecVersion = (String) openAPI.getExtensions().get(xOriginalSwaggerVersion);
- } else {
- originalSpecVersion = openAPI.getOpenapi();
- }
- Integer specMajorVersion = Integer.parseInt(originalSpecVersion.substring(0, 1));
- if (specMajorVersion < 3) {
- throw new RuntimeException("Your spec version of "+originalSpecVersion+" is too low. python-experimental only works with specs with version >= 3.X.X. Please use a tool like Swagger Editor or Swagger Converter to convert your spec to v3");
- }
- }
-
- /**
- * Note: a custom version of this function is used so the original tag value can be used
- *
- * @param tag Tag
- * @return the tag to use
- */
- @Override
- public String sanitizeTag(String tag) {
- return tag;
- }
-
- @Override
- public void postProcess() {
- System.out.println("################################################################################");
- System.out.println("# Thanks for using OpenAPI Generator. #");
- System.out.println("# Please consider donation to help us maintain this project \uD83D\uDE4F #");
- System.out.println("# https://opencollective.com/openapi_generator/donate #");
- System.out.println("# #");
- System.out.println("# This generator was written by Justin Black (https://github.com/spacether) #");
- System.out.println("# Please support his work directly via https://github.com/sponsors/spacether \uD83D\uDE4F#");
- System.out.println("################################################################################");
- }
-}
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PythonPriorClientCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PythonPriorClientCodegen.java
new file mode 100644
index 000000000000..c6d071e3b990
--- /dev/null
+++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PythonPriorClientCodegen.java
@@ -0,0 +1,1521 @@
+/*
+ * Copyright 2018 OpenAPI-Generator Contributors (https://openapi-generator.tech)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.openapitools.codegen.languages;
+
+import com.google.common.collect.Sets;
+import io.swagger.v3.core.util.Json;
+import io.swagger.v3.oas.models.media.*;
+import io.swagger.v3.oas.models.media.ArraySchema;
+import io.swagger.v3.oas.models.media.MediaType;
+import io.swagger.v3.oas.models.media.Schema;
+import io.swagger.v3.oas.models.parameters.Parameter;
+import io.swagger.v3.oas.models.parameters.RequestBody;
+import io.swagger.v3.oas.models.security.SecurityScheme;
+import org.apache.commons.lang3.StringUtils;
+import org.openapitools.codegen.*;
+import org.openapitools.codegen.CodegenDiscriminator.MappedModel;
+import org.openapitools.codegen.meta.features.*;
+import org.openapitools.codegen.model.ModelMap;
+import org.openapitools.codegen.model.ModelsMap;
+import org.openapitools.codegen.model.OperationMap;
+import org.openapitools.codegen.model.OperationsMap;
+import org.openapitools.codegen.utils.ModelUtils;
+import org.openapitools.codegen.utils.ProcessUtils;
+import org.openapitools.codegen.meta.GeneratorMetadata;
+import org.openapitools.codegen.meta.Stability;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import com.github.curiousoddman.rgxgen.RgxGen;
+import com.github.curiousoddman.rgxgen.config.RgxGenOption;
+import com.github.curiousoddman.rgxgen.config.RgxGenProperties;
+
+import java.time.OffsetDateTime;
+import java.time.ZoneOffset;
+import java.time.format.DateTimeFormatter;
+import java.io.File;
+import java.util.*;
+import java.util.regex.Pattern;
+import java.util.regex.Matcher;
+
+import static org.openapitools.codegen.utils.OnceLogger.once;
+
+public class PythonPriorClientCodegen extends PythonLegacyClientCodegen {
+ private final Logger LOGGER = LoggerFactory.getLogger(PythonPriorClientCodegen.class);
+
+ // A cache to efficiently lookup a Schema instance based on the return value of `toModelName()`.
+ private Map modelNameToSchemaCache;
+ private DateTimeFormatter iso8601Date = DateTimeFormatter.ISO_DATE;
+ private DateTimeFormatter iso8601DateTime = DateTimeFormatter.ISO_DATE_TIME;
+
+ public PythonPriorClientCodegen() {
+ super();
+
+ embeddedTemplateDir = templateDir = "python-prior";
+
+ // Composed schemas can have the 'additionalProperties' keyword, as specified in JSON schema.
+ // In principle, this should be enabled by default for all code generators. However due to limitations
+ // in other code generators, support needs to be enabled on a case-by-case basis.
+ supportsAdditionalPropertiesWithComposedSchema = true;
+
+ modifyFeatureSet(features -> features
+ .includeDocumentationFeatures(DocumentationFeature.Readme)
+ .wireFormatFeatures(EnumSet.of(WireFormatFeature.JSON, WireFormatFeature.XML, WireFormatFeature.Custom))
+ .securityFeatures(EnumSet.of(
+ SecurityFeature.BasicAuth,
+ SecurityFeature.BearerToken,
+ SecurityFeature.ApiKey,
+ SecurityFeature.OAuth2_Implicit
+ ))
+ .includeGlobalFeatures(
+ GlobalFeature.ParameterizedServer
+ )
+ .excludeGlobalFeatures(
+ GlobalFeature.XMLStructureDefinitions,
+ GlobalFeature.Callbacks,
+ GlobalFeature.LinkObjects,
+ GlobalFeature.ParameterStyling
+ )
+ .excludeSchemaSupportFeatures(
+ SchemaSupportFeature.Polymorphism
+ )
+ .excludeParameterFeatures(
+ ParameterFeature.Cookie
+ )
+ );
+ // needed for type object with additionalProperties: false
+ typeMapping.put("object", "dict");
+
+ languageSpecificPrimitives.add("file_type");
+ languageSpecificPrimitives.add("none_type");
+
+ // this generator does not use SORT_PARAMS_BY_REQUIRED_FLAG
+ // this generator uses the following order for endpoint parameters and model properties
+ // required params/props with no enum of length one
+ // required params/props with enum of length one (which is used to set a default value as a python named arg value)
+ // optional params/props with **kwargs in python
+ cliOptions.remove(4);
+
+ cliOptions.add(new CliOption(CodegenConstants.PYTHON_ATTR_NONE_IF_UNSET, CodegenConstants.PYTHON_ATTR_NONE_IF_UNSET_DESC)
+ .defaultValue(Boolean.FALSE.toString()));
+
+ cliOptions.add(new CliOption(CodegenConstants.INIT_REQUIRED_VARS, CodegenConstants.INIT_REQUIRED_VARS_DESC)
+ .defaultValue(Boolean.FALSE.toString()));
+
+ // option to change how we process + set the data in the 'additionalProperties' keyword.
+ CliOption disallowAdditionalPropertiesIfNotPresentOpt = CliOption.newBoolean(
+ CodegenConstants.DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT,
+ CodegenConstants.DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT_DESC).defaultValue(Boolean.FALSE.toString());
+ Map disallowAdditionalPropertiesIfNotPresentOpts = new HashMap<>();
+ disallowAdditionalPropertiesIfNotPresentOpts.put("false",
+ "The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.");
+ disallowAdditionalPropertiesIfNotPresentOpts.put("true",
+ "Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default. NOTE: "+
+ "this option breaks composition and will be removed in 6.0.0"
+ );
+ disallowAdditionalPropertiesIfNotPresentOpt.setEnum(disallowAdditionalPropertiesIfNotPresentOpts);
+ cliOptions.add(disallowAdditionalPropertiesIfNotPresentOpt);
+
+ generatorMetadata = GeneratorMetadata.newBuilder(generatorMetadata)
+ .stability(Stability.STABLE)
+ .build();
+ }
+
+ @Override
+ public void processOpts() {
+ this.setLegacyDiscriminatorBehavior(false);
+
+ super.processOpts();
+ modelPackage = packageName + "." + "model";
+
+ supportingFiles.add(new SupportingFile("model_utils.mustache", packagePath(), "model_utils.py"));
+
+
+ // add the models and apis folders
+ supportingFiles.add(new SupportingFile("__init__models.mustache", packagePath() + File.separatorChar + "models", "__init__.py"));
+ SupportingFile originalInitModel = supportingFiles.stream()
+ .filter(sf -> sf.getTemplateFile().equals("__init__model.mustache"))
+ .reduce((a, b) -> {
+ throw new IllegalStateException("Multiple elements: " + a + ", " + b);
+ })
+ .orElse(null);
+ supportingFiles.remove(originalInitModel);
+ supportingFiles.add(new SupportingFile("__init__model.mustache", packagePath() + File.separatorChar + "model", "__init__.py"));
+ supportingFiles.add(new SupportingFile("__init__apis.mustache", packagePath() + File.separatorChar + "apis", "__init__.py"));
+ // Generate the 'signing.py' module, but only if the 'HTTP signature' security scheme is specified in the OAS.
+ Map securitySchemeMap = openAPI != null ?
+ (openAPI.getComponents() != null ? openAPI.getComponents().getSecuritySchemes() : null) : null;
+ List authMethods = fromSecurity(securitySchemeMap);
+ if (ProcessUtils.hasHttpSignatureMethods(authMethods)) {
+ supportingFiles.add(new SupportingFile("signing.mustache", packagePath(), "signing.py"));
+ }
+
+ Boolean generateSourceCodeOnly = false;
+ if (additionalProperties.containsKey(CodegenConstants.SOURCECODEONLY_GENERATION)) {
+ generateSourceCodeOnly = Boolean.valueOf(additionalProperties.get(CodegenConstants.SOURCECODEONLY_GENERATION).toString());
+ }
+
+ // default this to true so the python ModelSimple models will be generated
+ ModelUtils.setGenerateAliasAsModel(true);
+ LOGGER.info(
+ "{} is hard coded to true in this generator. Alias models will only be generated if they contain validations or enums",
+ CodegenConstants.GENERATE_ALIAS_AS_MODEL);
+
+ Boolean attrNoneIfUnset = false;
+ if (additionalProperties.containsKey(CodegenConstants.PYTHON_ATTR_NONE_IF_UNSET)) {
+ attrNoneIfUnset = Boolean.valueOf(additionalProperties.get(CodegenConstants.PYTHON_ATTR_NONE_IF_UNSET).toString());
+ }
+ additionalProperties.put("attrNoneIfUnset", attrNoneIfUnset);
+
+ // When the 'additionalProperties' keyword is not present in a OAS schema, allow
+ // undeclared properties. This is compliant with the JSON schema specification.
+ // setting this to false is required to have composed schemas work because:
+ // anyOf SchemaA + SchemaB, requires that props present only in A are accepted in B because in B
+ // they are additional properties
+ Boolean disallowAddProps = false;
+ if (additionalProperties.containsKey(CodegenConstants.DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT)) {
+ disallowAddProps = Boolean.valueOf(additionalProperties.get(CodegenConstants.DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT).toString());
+ }
+ this.setDisallowAdditionalPropertiesIfNotPresent(disallowAddProps);
+
+ Boolean initRequiredVars = false;
+ if (additionalProperties.containsKey(CodegenConstants.INIT_REQUIRED_VARS)) {
+ initRequiredVars = Boolean.valueOf(additionalProperties.get(CodegenConstants.INIT_REQUIRED_VARS).toString());
+ }
+ additionalProperties.put("initRequiredVars", initRequiredVars);
+
+ // check library option to ensure only urllib3 is supported
+ if (!DEFAULT_LIBRARY.equals(getLibrary())) {
+ throw new RuntimeException("Only the `urllib3` library is supported in the refactored `python` client generator at the moment. Please fall back to `python-legacy` client generator for the time being. We welcome contributions to add back `asyncio`, `tornado` support to the `python` client generator.");
+ }
+ }
+
+ /**
+ * Configures a friendly name for the generator. This will be used by the
+ * generator to select the library with the -g flag.
+ *
+ * @return the friendly name for the generator
+ */
+ @Override
+ public String getName() {
+ return "python-prior";
+ }
+
+ @Override
+ public Schema unaliasSchema(Schema schema) {
+ Map allSchemas = ModelUtils.getSchemas(openAPI);
+ if (allSchemas == null || allSchemas.isEmpty()) {
+ // skip the warning as the spec can have no model defined
+ //LOGGER.warn("allSchemas cannot be null/empty in unaliasSchema. Returned 'schema'");
+ return schema;
+ }
+
+ if (schema != null && StringUtils.isNotEmpty(schema.get$ref())) {
+ String simpleRef = ModelUtils.getSimpleRef(schema.get$ref());
+ if (schemaMapping.containsKey(simpleRef)) {
+ LOGGER.debug("Schema unaliasing of {} omitted because aliased class is to be mapped to {}", simpleRef, schemaMapping.get(simpleRef));
+ return schema;
+ }
+ Schema ref = allSchemas.get(simpleRef);
+ if (ref == null) {
+ once(LOGGER).warn("{} is not defined", schema.get$ref());
+ return schema;
+ } else if (ref.getEnum() != null && !ref.getEnum().isEmpty()) {
+ // top-level enum class
+ return schema;
+ } else if (ModelUtils.isArraySchema(ref)) {
+ if (ModelUtils.isGenerateAliasAsModel(ref)) {
+ return schema; // generate a model extending array
+ } else {
+ return unaliasSchema(allSchemas.get(ModelUtils.getSimpleRef(schema.get$ref())));
+ }
+ } else if (ModelUtils.isComposedSchema(ref)) {
+ return schema;
+ } else if (ModelUtils.isMapSchema(ref)) {
+ if (ref.getProperties() != null && !ref.getProperties().isEmpty()) // has at least one property
+ return schema; // treat it as model
+ else {
+ if (ModelUtils.isGenerateAliasAsModel(ref)) {
+ return schema; // generate a model extending map
+ } else {
+ // treat it as a typical map
+ return unaliasSchema(allSchemas.get(ModelUtils.getSimpleRef(schema.get$ref())));
+ }
+ }
+ } else if (ModelUtils.isObjectSchema(ref)) { // model
+ if (ref.getProperties() != null && !ref.getProperties().isEmpty()) { // has at least one property
+ return schema;
+ } else {
+ // free form object (type: object)
+ if (ModelUtils.hasValidation(ref)) {
+ return schema;
+ } else if (!getAllOfDescendants(simpleRef, openAPI).isEmpty()) {
+ return schema;
+ } else {
+ return unaliasSchema(allSchemas.get(ModelUtils.getSimpleRef(schema.get$ref())));
+ }
+ }
+ } else if (ModelUtils.hasValidation(ref)) {
+ // non object non array non map schemas that have validations
+ // are returned so we can generate those schemas as models
+ // we do this to:
+ // - preserve the validations in that model class in python
+ // - use those validations when we use this schema in composed oneOf schemas
+ return schema;
+ } else {
+ return unaliasSchema(allSchemas.get(ModelUtils.getSimpleRef(schema.get$ref())));
+ }
+ }
+ return schema;
+ }
+
+ public String pythonDate(Object dateValue) {
+ String strValue = null;
+ if (dateValue instanceof OffsetDateTime) {
+ OffsetDateTime date = null;
+ try {
+ date = (OffsetDateTime) dateValue;
+ } catch (ClassCastException e) {
+ LOGGER.warn("Invalid `date` format for value {}", dateValue);
+ date = ((Date) dateValue).toInstant().atOffset(ZoneOffset.UTC);
+ }
+ strValue = date.format(iso8601Date);
+ } else {
+ strValue = dateValue.toString();
+ }
+ return "dateutil_parser('" + strValue + "').date()";
+ }
+
+ public String pythonDateTime(Object dateTimeValue) {
+ String strValue = null;
+ if (dateTimeValue instanceof OffsetDateTime) {
+ OffsetDateTime dateTime = null;
+ try {
+ dateTime = (OffsetDateTime) dateTimeValue;
+ } catch (ClassCastException e) {
+ LOGGER.warn("Invalid `date-time` format for value {}", dateTimeValue);
+ dateTime = ((Date) dateTimeValue).toInstant().atOffset(ZoneOffset.UTC);
+ }
+ strValue = dateTime.format(iso8601DateTime);
+ } else {
+ strValue = dateTimeValue.toString();
+ }
+ return "dateutil_parser('" + strValue + "')";
+ }
+
+ /**
+ * Return the default value of the property
+ *
+ * @param p OpenAPI property object
+ * @return string presentation of the default value of the property
+ */
+ @Override
+ public String toDefaultValue(Schema p) {
+ // if a variable has no default set and only has one allowed value
+ // using enum of length == 1 we use that value. Server/client usage:
+ // python servers: should only use default values for optional params
+ // python clients: should only use default values for required params
+ Object defaultObject = null;
+ if (p.getDefault() != null) {
+ defaultObject = p.getDefault();
+ } else if (p.getEnum() != null && p.getEnum().size() == 1) {
+ defaultObject = p.getEnum().get(0);
+ }
+
+ if (defaultObject == null) {
+ return null;
+ }
+
+ String defaultValue = defaultObject.toString();
+ if (ModelUtils.isDateSchema(p)) {
+ defaultValue = pythonDate(defaultObject);
+ } else if (ModelUtils.isDateTimeSchema(p)) {
+ defaultValue = pythonDateTime(defaultObject);
+ } else if (ModelUtils.isStringSchema(p) && !ModelUtils.isByteArraySchema(p) && !ModelUtils.isBinarySchema(p) && !ModelUtils.isFileSchema(p) && !ModelUtils.isUUIDSchema(p) && !ModelUtils.isEmailSchema(p)) {
+ defaultValue = ensureQuotes(defaultValue);
+ } else if (ModelUtils.isBooleanSchema(p)) {
+ if (!Boolean.valueOf(defaultValue)) {
+ defaultValue = "False";
+ } else {
+ defaultValue = "True";
+ }
+ }
+ return defaultValue;
+ }
+
+ @Override
+ public String toModelImport(String name) {
+ // name looks like Cat
+ return "from " + modelPackage() + "." + toModelFilename(name) + " import " + toModelName(name);
+ }
+
+ @Override
+ @SuppressWarnings("static-method")
+ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List allModels) {
+ // fix the imports that each model has, add the module reference to the model
+ // loops through imports and converts them all
+ // from 'Pet' to 'from petstore_api.model.pet import Pet'
+
+ OperationMap val = objs.getOperations();
+ List operations = val.getOperation();
+ for (CodegenOperation operation : operations) {
+ if (operation.imports.isEmpty()) {
+ continue;
+ }
+ String[] modelNames = operation.imports.toArray(new String[0]);
+ operation.imports.clear();
+ for (String modelName : modelNames) {
+ operation.imports.add(toModelImport(modelName));
+ }
+ }
+ return objs;
+ }
+
+ /***
+ * Override with special post-processing for all models.
+ * we have a custom version of this method to:
+ * - remove any primitive models that do not contain validations
+ * these models are unaliased as inline definitions wherever the spec has them as refs
+ * this means that the generated client does not use these models
+ * because they are not used we do not write them
+ * - fix the model imports, go from model name to the full import string with toModelImport + globalImportFixer
+ *
+ * @param objs a map going from the model name to an object holding the model info
+ * @return the updated objs
+ */
+ @Override
+ public Map postProcessAllModels(Map objs) {
+ super.postProcessAllModels(objs);
+
+ List modelsToRemove = new ArrayList<>();
+ Map allDefinitions = ModelUtils.getSchemas(this.openAPI);
+ for (String schemaName : allDefinitions.keySet()) {
+ Schema refSchema = new Schema().$ref("#/components/schemas/" + schemaName);
+ Schema unaliasedSchema = unaliasSchema(refSchema);
+ String modelName = toModelName(schemaName);
+ if (unaliasedSchema.get$ref() == null) {
+ modelsToRemove.add(modelName);
+ } else {
+ ModelsMap objModel = objs.get(modelName);
+ if (objModel != null) { // to avoid form parameter's models that are not generated (skipFormModel=true)
+ for (ModelMap model : objModel.getModels()) {
+ CodegenModel cm = model.getModel();
+ String[] importModelNames = cm.imports.toArray(new String[0]);
+ cm.imports.clear();
+ for (String importModelName : importModelNames) {
+ cm.imports.add(toModelImport(importModelName));
+ String globalImportFixer = "globals()['" + importModelName + "'] = " + importModelName;
+ cm.imports.add(globalImportFixer);
+ }
+ }
+ }
+ }
+ }
+
+ for (String modelName : modelsToRemove) {
+ objs.remove(modelName);
+ }
+
+ return objs;
+ }
+
+ /**
+ * Convert OAS Property object to Codegen Property object
+ * We have a custom version of this method to always set allowableValues.enumVars on all enum variables
+ * Together with unaliasSchema this sets primitive types with validations as models
+ * This method is used by fromResponse
+ *
+ * @param name name of the property
+ * @param p OAS property object
+ * @return Codegen Property object
+ */
+ @Override
+ public CodegenProperty fromProperty(String name, Schema p, boolean required) {
+ CodegenProperty cp = super.fromProperty(name, p, required);
+ if (cp.isEnum) {
+ updateCodegenPropertyEnum(cp);
+ }
+ if (cp.isPrimitiveType && p.get$ref() != null) {
+ cp.complexType = cp.dataType;
+ }
+ if (cp.isArray && cp.complexType == null && cp.mostInnerItems.complexType != null) {
+ cp.complexType = cp.mostInnerItems.complexType;
+ }
+ return cp;
+ }
+
+ /**
+ * Update codegen property's enum by adding "enumVars" (with name and value)
+ *
+ * @param var list of CodegenProperty
+ */
+ @Override
+ public void updateCodegenPropertyEnum(CodegenProperty var) {
+ // we have a custom version of this method to omit overwriting the defaultValue
+ Map allowableValues = var.allowableValues;
+
+ // handle array
+ if (var.mostInnerItems != null) {
+ allowableValues = var.mostInnerItems.allowableValues;
+ }
+
+ if (allowableValues == null) {
+ return;
+ }
+
+ List values = (List) allowableValues.get("values");
+ if (values == null) {
+ return;
+ }
+
+ String varDataType = var.mostInnerItems != null ? var.mostInnerItems.dataType : var.dataType;
+ Schema referencedSchema = getModelNameToSchemaCache().get(varDataType);
+ String dataType = (referencedSchema != null) ? getTypeDeclaration(referencedSchema) : varDataType;
+
+ // put "enumVars" map into `allowableValues", including `name` and `value`
+ List> enumVars = buildEnumVars(values, dataType);
+
+ // if "x-enum-varnames" or "x-enum-descriptions" defined, update varnames
+ Map extensions = var.mostInnerItems != null ? var.mostInnerItems.getVendorExtensions() : var.getVendorExtensions();
+ if (referencedSchema != null) {
+ extensions = referencedSchema.getExtensions();
+ }
+ updateEnumVarsWithExtensions(enumVars, extensions, dataType);
+ allowableValues.put("enumVars", enumVars);
+ // overwriting defaultValue omitted from here
+ }
+
+ /***
+ * We have a custom version of this method to produce links to models when they are
+ * primitive type (not map, not array, not object) and include validations or are enums
+ *
+ * @param body request body
+ * @param imports import collection
+ * @param bodyParameterName body parameter name
+ * @return the resultant CodegenParameter
+ */
+ @Override
+ public CodegenParameter fromRequestBody(RequestBody body, Set imports, String bodyParameterName) {
+ CodegenParameter cp = super.fromRequestBody(body, imports, bodyParameterName);
+ Schema schema = ModelUtils.getSchemaFromRequestBody(body);
+ if (schema.get$ref() == null) {
+ return cp;
+ }
+ Schema unaliasedSchema = unaliasSchema(schema);
+ CodegenProperty unaliasedProp = fromProperty("body", unaliasedSchema, false);
+ Boolean dataTypeMismatch = !cp.dataType.equals(unaliasedProp.dataType);
+ Boolean baseTypeMismatch = !cp.baseType.equals(unaliasedProp.complexType) && unaliasedProp.complexType != null;
+ if (dataTypeMismatch || baseTypeMismatch) {
+ cp.dataType = unaliasedProp.dataType;
+ cp.baseType = unaliasedProp.complexType;
+ }
+ return cp;
+ }
+
+ /***
+ * Adds the body model schema to the body parameter
+ * We have a custom version of this method so we can flip forceSimpleRef
+ * to True based upon the results of unaliasSchema
+ * With this customization, we ensure that when schemas are passed to getSchemaType
+ * - if they have ref in them they are a model
+ * - if they do not have ref in them they are not a model
+ *
+ * @param codegenParameter the body parameter
+ * @param name model schema ref key in components
+ * @param schema the model schema (not refed)
+ * @param imports collection of imports
+ * @param bodyParameterName body parameter name
+ * @param forceSimpleRef if true use a model reference
+ */
+ @Override
+ protected void addBodyModelSchema(CodegenParameter codegenParameter, String name, Schema schema, Set imports, String bodyParameterName, boolean forceSimpleRef) {
+ if (name != null) {
+ Schema bodySchema = new Schema().$ref("#/components/schemas/" + name);
+ Schema unaliased = unaliasSchema(bodySchema);
+ if (unaliased.get$ref() != null) {
+ forceSimpleRef = true;
+ }
+ }
+ super.addBodyModelSchema(codegenParameter, name, schema, imports, bodyParameterName, forceSimpleRef);
+
+ }
+
+
+ /**
+ * Return the sanitized variable name for enum
+ *
+ * @param value enum variable name
+ * @param datatype data type
+ * @return the sanitized variable name for enum
+ */
+ public String toEnumVarName(String value, String datatype) {
+ // our enum var names are keys in a python dict, so change spaces to underscores
+ if (value.length() == 0) {
+ return "EMPTY";
+ }
+
+ String var = value.replaceAll("\\s+", "_").toUpperCase(Locale.ROOT);
+ return var;
+ }
+
+ /**
+ * Return the enum value in the language specified format
+ * e.g. status becomes "status"
+ *
+ * @param value enum variable name
+ * @param datatype data type
+ * @return the sanitized value for enum
+ */
+ public String toEnumValue(String value, String datatype) {
+ if ("int".equals(datatype) || "float".equals(datatype)) {
+ return value;
+ } else if ("bool".equals(datatype)) {
+ return value.substring(0, 1).toUpperCase(Locale.ROOT) + value.substring(1);
+ } else {
+ return ensureQuotes(value);
+ }
+ }
+
+ @Override
+ public void postProcessModelProperty(CodegenModel model, CodegenProperty p) {
+ postProcessPattern(p.pattern, p.vendorExtensions);
+ // set property.complexType so the model docs will link to the ClassName.md
+ if (p.complexType == null && p.isArray && p.mostInnerItems.complexType != null && !languageSpecificPrimitives.contains(p.mostInnerItems.complexType)) {
+ // fix ListContainers
+ p.complexType = p.mostInnerItems.complexType;
+ }
+ }
+
+ @Override
+ public void postProcessParameter(CodegenParameter p) {
+ postProcessPattern(p.pattern, p.vendorExtensions);
+ if (p.baseType != null && languageSpecificPrimitives.contains(p.baseType)) {
+ // set baseType to null so the api docs will not point to a model for languageSpecificPrimitives
+ p.baseType = null;
+ }
+ }
+
+ private void fixComposedSchemaRequiredVars(Schema schema, CodegenModel result) {
+ // for composed schema models, if the required properties are only from oneOf or anyOf models
+ // remove them from the composed schema's required vars
+ // for composed schemas our code adds oneOf and anyOf required properties to
+ // the composed schema's required properties
+ // but they should not be required because if we have ComposedSchema: oneOf -schemaA -schemaB
+ // and the required props are only in schemaB, we do not need to use them when making an instance of
+ // ComposedSchema + schemaA
+ ComposedSchema cs = (ComposedSchema) schema;
+
+ // these are the properties that are from properties in self cs or cs allOf
+ Map selfProperties = new LinkedHashMap<>();
+ List selfRequired = new ArrayList<>();
+
+ // these are the properties that are from properties in cs oneOf or cs anyOf
+ Map otherProperties = new LinkedHashMap<>();
+ List otherRequired = new ArrayList<>();
+
+ List oneOfanyOfSchemas = new ArrayList<>();
+ List oneOf = cs.getOneOf();
+ if (oneOf != null) {
+ oneOfanyOfSchemas.addAll(oneOf);
+ }
+ List anyOf = cs.getAnyOf();
+ if (anyOf != null) {
+ oneOfanyOfSchemas.addAll(anyOf);
+ }
+ for (Schema sc : oneOfanyOfSchemas) {
+ Schema refSchema = ModelUtils.getReferencedSchema(this.openAPI, sc);
+ addProperties(otherProperties, otherRequired, refSchema, new HashSet<>());
+ }
+ Set otherRequiredSet = new HashSet<>(otherRequired);
+
+ List allOf = cs.getAllOf();
+ if ((schema.getProperties() != null && !schema.getProperties().isEmpty()) || allOf != null) {
+ // NOTE: this function also adds the allOf properties inside schema
+ addProperties(selfProperties, selfRequired, schema, new HashSet<>());
+ }
+ if (result.discriminator != null) {
+ selfRequired.add(result.discriminator.getPropertyBaseName());
+ }
+ Set selfRequiredSet = new HashSet<>(selfRequired);
+
+ List reqVars = result.getRequiredVars();
+ List reqVarsThatMustBeOptional = new ArrayList<>();
+ if (reqVars != null) {
+ for (CodegenProperty cp : reqVars) {
+ String propName = cp.baseName;
+ if (otherRequiredSet.contains(propName) && !selfRequiredSet.contains(propName)) {
+ cp.required = false;
+ reqVarsThatMustBeOptional.add(cp);
+ }
+ }
+ }
+ for (CodegenProperty cp : reqVarsThatMustBeOptional) {
+ result.getRequiredVars().remove(cp);
+ result.getOptionalVars().add(cp);
+ }
+ }
+
+ /**
+ * Sets the value of the 'model.parent' property in CodegenModel
+ * We have a custom version of this function so we can add the dataType on the ArrayModel
+ */
+ @Override
+ protected void addParentContainer(CodegenModel model, String name, Schema schema) {
+ super.addParentContainer(model, name, schema);
+
+ List referencedModelNames = new ArrayList<>();
+ model.dataType = getTypeString(schema, "", "", referencedModelNames);
+ }
+
+ /**
+ * Convert OAS Model object to Codegen Model object
+ * We have a custom version of this method so we can:
+ * - set the correct regex values for requiredVars + optionalVars
+ * - set model.defaultValue and model.hasRequired per the three use cases defined in this method
+ *
+ * @param name the name of the model
+ * @param sc OAS Model object
+ * @return Codegen Model object
+ */
+ @Override
+ public CodegenModel fromModel(String name, Schema sc) {
+ CodegenModel cm = super.fromModel(name, sc);
+ if (cm.requiredVars.size() > 0 && (cm.oneOf.size() > 0 || cm.anyOf.size() > 0)) {
+ fixComposedSchemaRequiredVars(sc, cm);
+ }
+ ArrayList> listOfLists = new ArrayList<>();
+ listOfLists.add(cm.requiredVars);
+ listOfLists.add(cm.optionalVars);
+ for (List cpList : listOfLists) {
+ for (CodegenProperty cp : cpList) {
+ // sets regex values
+ postProcessModelProperty(cm, cp);
+ }
+ }
+ Boolean isNotPythonModelSimpleModel = (ModelUtils.isComposedSchema(sc) || ModelUtils.isObjectSchema(sc) || ModelUtils.isMapSchema(sc));
+ if (isNotPythonModelSimpleModel) {
+ return cm;
+ }
+ // Use cases for default values / enums of length one
+ // 1. no default exists
+ // schema does not contain default
+ // cm.defaultValue unset, cm.hasRequired = true
+ // 2. spec has a default
+ // schema contains default
+ // cm.defaultValue set, cm.hasRequired = false
+ // different value here to differentiate between use case 3 below
+ // This defaultValue is used when a consumer (client or server) lacks the input argument, defaultValue will be used
+ // 3. only one value is allowed in an enum
+ // schema does not contain default
+ // cm.defaultValue set, cm.hasRequired = false
+ // because we know what value needs to be set so the user doesn't need to input it
+ // This defaultValue is used in the client and is sent to the server
+ String defaultValue = toDefaultValue(sc);
+ if (sc.getDefault() == null && defaultValue == null) {
+ cm.hasRequired = true;
+ } else if (sc.getDefault() != null) {
+ cm.defaultValue = defaultValue;
+ cm.hasRequired = false;
+ } else if (defaultValue != null && cm.defaultValue == null) {
+ cm.defaultValue = defaultValue;
+ cm.hasRequired = false;
+ }
+ return cm;
+ }
+
+ /**
+ * Returns the python type for the property.
+ *
+ * @param schema property schema
+ * @return string presentation of the type
+ **/
+ @SuppressWarnings("static-method")
+ @Override
+ public String getSchemaType(Schema schema) {
+ String openAPIType = getSingleSchemaType(schema);
+ if (typeMapping.containsKey(openAPIType)) {
+ String type = typeMapping.get(openAPIType);
+ return type;
+ }
+ return toModelName(openAPIType);
+ }
+
+ public String getModelName(Schema sc) {
+ if (sc.get$ref() != null) {
+ Schema unaliasedSchema = unaliasSchema(sc);
+ if (unaliasedSchema.get$ref() != null) {
+ return toModelName(ModelUtils.getSimpleRef(sc.get$ref()));
+ }
+ }
+ return null;
+ }
+
+ @Override
+ protected Schema getAdditionalProperties(Schema schema) {
+ /*
+ Use cases:
+ 1. addProps set to schema in spec: return that schema
+ 2. addProps unset w/ getDisallowAdditionalPropertiesIfNotPresent -> null
+ 3. addProps unset w/ getDisallowAdditionalPropertiesIfNotPresent=False -> new Schema()
+ 4. addProps true -> new Schema() NOTE: v3 only
+ 5. addprops false -> null NOTE: v3 only
+ */
+ Object addProps = schema.getAdditionalProperties();
+ if (addProps instanceof Schema) {
+ return (Schema) addProps;
+ }
+ if (addProps == null) {
+ // When reaching this code path, this should indicate the 'additionalProperties' keyword is
+ // not present in the OAS schema. This is true for OAS 3.0 documents.
+ // However, the parsing logic is broken for OAS 2.0 documents because of the
+ // https://github.com/swagger-api/swagger-parser/issues/1369 issue.
+ // When OAS 2.0 documents are parsed, the swagger-v2-converter ignores the 'additionalProperties'
+ // keyword if the value is boolean. That means codegen is unable to determine whether
+ // additional properties are allowed or not.
+ //
+ // The original behavior was to assume additionalProperties had been set to false.
+ if (getDisallowAdditionalPropertiesIfNotPresent()) {
+ // If the 'additionalProperties' keyword is not present in a OAS schema,
+ // interpret as if the 'additionalProperties' keyword had been set to false.
+ // This is NOT compliant with the JSON schema specification. It is the original
+ // 'openapi-generator' behavior.
+ return null;
+ }
+ /*
+ // The disallowAdditionalPropertiesIfNotPresent CLI option has been set to true,
+ // but for now that only works with OAS 3.0 documents.
+ // The new behavior does not work with OAS 2.0 documents.
+ if (extensions == null || !extensions.containsKey(EXTENSION_OPENAPI_DOC_VERSION)) {
+ // Fallback to the legacy behavior.
+ return null;
+ }
+ // Get original swagger version from OAS extension.
+ // Note openAPI.getOpenapi() is always set to 3.x even when the document
+ // is converted from a OAS/Swagger 2.0 document.
+ // https://github.com/swagger-api/swagger-parser/pull/1374
+ SemVer version = new SemVer((String)extensions.get(EXTENSION_OPENAPI_DOC_VERSION));
+ if (version.major != 3) {
+ return null;
+ }
+ */
+ }
+ if (addProps == null || (addProps instanceof Boolean && (Boolean) addProps)) {
+ // Return empty schema to allow any type
+ return new Schema();
+ }
+ return null;
+ }
+
+ /**
+ * Return a string representation of the Python types for the specified OAS schema.
+ * Primitive types in the OAS specification are implemented in Python using the corresponding
+ * Python primitive types.
+ * Composed types (e.g. allAll, oneOf, anyOf) are represented in Python using list of types.
+ *
+ * The caller should set the prefix and suffix arguments to empty string, except when
+ * getTypeString invokes itself recursively. A non-empty prefix/suffix may be specified
+ * to wrap the return value in a python dict, list or tuple.
+ *
+ * Examples:
+ * - "bool, date, float" The data must be a bool, date or float.
+ * - "[bool, date]" The data must be an array, and the array items must be a bool or date.
+ *
+ * @param p The OAS schema.
+ * @param prefix prepended to the returned value.
+ * @param suffix appended to the returned value.
+ * @param referencedModelNames a list of models that are being referenced while generating the types,
+ * may be used to generate imports.
+ * @return a comma-separated string representation of the Python types
+ */
+ private String getTypeString(Schema p, String prefix, String suffix, List referencedModelNames) {
+ String fullSuffix = suffix;
+ if (")".equals(suffix)) {
+ fullSuffix = "," + suffix;
+ }
+ if (StringUtils.isNotEmpty(p.get$ref())) {
+ // The input schema is a reference. If the resolved schema is
+ // a composed schema, convert the name to a Python class.
+ Schema unaliasedSchema = unaliasSchema(p);
+ if (unaliasedSchema.get$ref() != null) {
+ String modelName = toModelName(ModelUtils.getSimpleRef(p.get$ref()));
+ if (referencedModelNames != null) {
+ referencedModelNames.add(modelName);
+ }
+ return prefix + modelName + fullSuffix;
+ }
+ }
+ if (ModelUtils.isAnyType(p)) {
+ // for v2 specs only, swagger-parser never generates an AnyType schemas even though it should generate them
+ // https://github.com/swagger-api/swagger-parser/issues/1378
+ // switch to v3 if you need AnyType to work
+ return prefix + "bool, date, datetime, dict, float, int, list, str, none_type" + suffix;
+ }
+ String originalSpecVersion = "X";
+ if (this.openAPI.getExtensions() != null && this.openAPI.getExtensions().containsKey("x-original-swagger-version")) {
+ originalSpecVersion = (String) this.openAPI.getExtensions().get("x-original-swagger-version");
+ originalSpecVersion = originalSpecVersion.substring(0, 1);
+
+ }
+ Boolean v2DisallowAdditionalPropertiesIfNotPresentAddPropsNullCase = (getAdditionalProperties(p) == null && this.getDisallowAdditionalPropertiesIfNotPresent() && originalSpecVersion.equals("2"));
+ Schema emptySchema = new Schema();
+ Boolean v2WithCompositionAddPropsAnyTypeSchemaCase = (getAdditionalProperties(p) != null && emptySchema.equals(getAdditionalProperties(p)) && originalSpecVersion.equals("2"));
+ if (isFreeFormObject(p) && (v2DisallowAdditionalPropertiesIfNotPresentAddPropsNullCase || v2WithCompositionAddPropsAnyTypeSchemaCase)) {
+ // for v2 specs only, input AnyType schemas (type unset) or schema {} results in FreeFromObject schemas
+ // per https://github.com/swagger-api/swagger-parser/issues/1378
+ // v2 spec uses cases
+ // 1. AnyType schemas
+ // 2. type object schema with no other info
+ // use case 1 + 2 -> both become use case 1
+ // switch to v3 if you need use cases 1 + 2 to work correctly
+ return prefix + "bool, date, datetime, dict, float, int, list, str, none_type" + fullSuffix;
+ }
+ // Resolve $ref because ModelUtils.isXYZ methods do not automatically resolve references.
+ if (ModelUtils.isNullable(ModelUtils.getReferencedSchema(this.openAPI, p))) {
+ fullSuffix = ", none_type" + suffix;
+ }
+ Boolean v3WithCompositionAddPropsAnyTypeSchemaCase = (getAdditionalProperties(p) != null && emptySchema.equals(getAdditionalProperties(p)) && originalSpecVersion.equals("3"));
+ if (isFreeFormObject(p) && v3WithCompositionAddPropsAnyTypeSchemaCase) {
+ // v3 code path, use case: type object schema with no other schema info
+ return prefix + "{str: (bool, date, datetime, dict, float, int, list, str, none_type)}" + fullSuffix;
+ } else if ((ModelUtils.isMapSchema(p) || "object".equals(p.getType())) && getAdditionalProperties(p) != null) {
+ Schema inner = getAdditionalProperties(p);
+ return prefix + "{str: " + getTypeString(inner, "(", ")", referencedModelNames) + "}" + fullSuffix;
+ } else if (ModelUtils.isArraySchema(p)) {
+ ArraySchema ap = (ArraySchema) p;
+ Schema inner = ap.getItems();
+ if (inner == null) {
+ // In OAS 3.0.x, the array "items" attribute is required.
+ // In OAS >= 3.1, the array "items" attribute is optional such that the OAS
+ // specification is aligned with the JSON schema specification.
+ // When "items" is not specified, the elements of the array may be anything at all.
+ // In that case, the return value should be:
+ // "[bool, date, datetime, dict, float, int, list, str, none_type]"
+ // Using recursion to wrap the allowed python types in an array.
+ Schema anyType = new Schema(); // A Schema without any attribute represents 'any type'.
+ return getTypeString(anyType, "[", "]", referencedModelNames);
+ } else {
+ return prefix + getTypeString(inner, "[", "]", referencedModelNames) + fullSuffix;
+ }
+ }
+ if (ModelUtils.isFileSchema(p)) {
+ return prefix + "file_type" + fullSuffix;
+ }
+ String baseType = getSchemaType(p);
+ return prefix + baseType + fullSuffix;
+ }
+
+ /**
+ * Output the type declaration of a given name
+ *
+ * @param p property schema
+ * @return a string presentation of the type
+ */
+ @Override
+ public String getTypeDeclaration(Schema p) {
+ // this is used to set dataType, which defines a python tuple of classes
+ // in Python we will wrap this in () to make it a tuple but here we
+ // will omit the parens so the generated documentation will not include
+ // them
+ return getTypeString(p, "", "", null);
+ }
+
+ @Override
+ public String toInstantiationType(Schema property) {
+ if (ModelUtils.isArraySchema(property) || ModelUtils.isMapSchema(property) || property.getAdditionalProperties() != null) {
+ return getSchemaType(property);
+ }
+ return super.toInstantiationType(property);
+ }
+
+ @Override
+ protected void addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel, Schema schema) {
+ Schema addProps = getAdditionalProperties(schema);
+ if (addProps != null) {
+ // if AdditionalProperties exists, get its datatype and
+ // store it in codegenModel.additionalPropertiesType.
+ // The 'addProps' may be a reference, getTypeDeclaration will resolve
+ // the reference.
+ List referencedModelNames = new ArrayList<>();
+ getTypeString(addProps, "", "", referencedModelNames);
+ if (referencedModelNames.size() != 0) {
+ // Models that are referenced in the 'additionalPropertiesType' keyword
+ // must be added to the imports.
+ codegenModel.imports.addAll(referencedModelNames);
+ }
+ }
+ // If addProps is null, the value of the 'additionalProperties' keyword is set
+ // to false, i.e. no additional properties are allowed.
+ }
+
+ /**
+ * Gets an example if it exists
+ *
+ * @param sc input schema
+ * @return the example value
+ */
+ protected Object getObjectExample(Schema sc) {
+ Schema schema = sc;
+ String ref = sc.get$ref();
+ if (ref != null) {
+ schema = ModelUtils.getSchema(this.openAPI, ModelUtils.getSimpleRef(ref));
+ }
+ // TODO handle examples in object models in the future
+ Boolean objectModel = (ModelUtils.isObjectSchema(schema) || ModelUtils.isMapSchema(schema) || ModelUtils.isComposedSchema(schema));
+ if (objectModel) {
+ return null;
+ }
+ if (schema.getExample() != null) {
+ return schema.getExample();
+ }
+ if (schema.getDefault() != null) {
+ return schema.getDefault();
+ } else if (schema.getEnum() != null && !schema.getEnum().isEmpty()) {
+ return schema.getEnum().get(0);
+ }
+ return null;
+ }
+
+ /***
+ * Ensures that the string has a leading and trailing quote
+ *
+ * @param in input string
+ * @return quoted string
+ */
+ private String ensureQuotes(String in) {
+ Pattern pattern = Pattern.compile("\r\n|\r|\n");
+ Matcher matcher = pattern.matcher(in);
+ if (matcher.find()) {
+ // if a string has a new line in it add triple quotes to make it a python multiline string
+ return "'''" + in + "'''";
+ }
+ String strPattern = "^['\"].*?['\"]$";
+ if (in.matches(strPattern)) {
+ return in;
+ }
+ return "\"" + in + "\"";
+ }
+
+ @Override
+ public String toExampleValue(Schema schema) {
+ Object objExample = getObjectExample(schema);
+ String modelName = getModelName(schema);
+ return toExampleValueRecursive(modelName, schema, objExample, 1, "", 0, Sets.newHashSet());
+ }
+
+ public String toExampleValue(Schema schema, Object objExample) {
+ String modelName = getModelName(schema);
+ return toExampleValueRecursive(modelName, schema, objExample, 1, "", 0, Sets.newHashSet());
+ }
+
+ private Boolean simpleStringSchema(Schema schema) {
+ Schema sc = schema;
+ String ref = schema.get$ref();
+ if (ref != null) {
+ sc = ModelUtils.getSchema(this.openAPI, ModelUtils.getSimpleRef(ref));
+ }
+ if (ModelUtils.isStringSchema(sc) && !ModelUtils.isDateSchema(sc) && !ModelUtils.isDateTimeSchema(sc) && !"Number".equalsIgnoreCase(sc.getFormat()) && !ModelUtils.isByteArraySchema(sc) && !ModelUtils.isBinarySchema(sc) && schema.getPattern() == null) {
+ return true;
+ }
+ return false;
+ }
+
+ private MappedModel getDiscriminatorMappedModel(CodegenDiscriminator disc) {
+ for (MappedModel mm : disc.getMappedModels()) {
+ String modelName = mm.getModelName();
+ Schema modelSchema = getModelNameToSchemaCache().get(modelName);
+ if (ModelUtils.isObjectSchema(modelSchema)) {
+ return mm;
+ }
+ }
+ return null;
+ }
+
+ /***
+ * Recursively generates string examples for schemas
+ *
+ * @param modelName the string name of the refed model that will be generated for the schema or null
+ * @param schema the schema that we need an example for
+ * @param objExample the example that applies to this schema, for now only string example are used
+ * @param indentationLevel integer indentation level that we are currently at
+ * we assume the indentation amount is 4 spaces times this integer
+ * @param prefix the string prefix that we will use when assigning an example for this line
+ * this is used when setting key: value, pairs "key: " is the prefix
+ * and this is used when setting properties like some_property='some_property_example'
+ * @param exampleLine this is the current line that we are generating an example for, starts at 0
+ * we don't indent the 0th line because using the example value looks like:
+ * prop = ModelName( line 0
+ * some_property='some_property_example' line 1
+ * ) line 2
+ * and our example value is:
+ * ModelName( line 0
+ * some_property='some_property_example' line 1
+ * ) line 2
+ * @param seenSchemas This set contains all the schemas passed into the recursive function. It is used to check
+ * if a schema was already passed into the function and breaks the infinite recursive loop. The
+ * only schemas that are not added are ones that contain $ref != null
+ * @return the string example
+ */
+ private String toExampleValueRecursive(String modelName, Schema schema, Object objExample, int indentationLevel, String prefix, Integer exampleLine, Set seenSchemas) {
+ final String indentionConst = " ";
+ String currentIndentation = "";
+ String closingIndentation = "";
+ for (int i = 0; i < indentationLevel; i++) currentIndentation += indentionConst;
+ if (exampleLine.equals(0)) {
+ closingIndentation = currentIndentation;
+ currentIndentation = "";
+ } else {
+ closingIndentation = currentIndentation;
+ }
+ String openChars = "";
+ String closeChars = "";
+ if (modelName != null) {
+ openChars = modelName + "(";
+ closeChars = ")";
+ }
+
+ String fullPrefix = currentIndentation + prefix + openChars;
+
+ String example = null;
+ if (objExample != null) {
+ example = objExample.toString();
+ }
+ // checks if the current schema has already been passed in. If so, breaks the current recursive pass
+ if (seenSchemas.contains(schema)) {
+ if (modelName != null) {
+ return fullPrefix + closeChars;
+ } else {
+ // this is a recursive schema
+ // need to add a reasonable example to avoid
+ // infinite recursion
+ if (ModelUtils.isNullable(schema)) {
+ // if the schema is nullable, then 'None' is a valid value
+ return fullPrefix + "None" + closeChars;
+ } else if (ModelUtils.isArraySchema(schema)) {
+ // the schema is an array, add an empty array
+ return fullPrefix + "[]" + closeChars;
+ } else {
+ // the schema is an object, make an empty object
+ return fullPrefix + "{}" + closeChars;
+ }
+ }
+ }
+
+ if (null != schema.get$ref()) {
+ Map allDefinitions = ModelUtils.getSchemas(this.openAPI);
+ String ref = ModelUtils.getSimpleRef(schema.get$ref());
+ Schema refSchema = allDefinitions.get(ref);
+ if (null == refSchema) {
+ LOGGER.warn("Unable to find referenced schema {}\n", schema.get$ref());
+ return fullPrefix + "None" + closeChars;
+ }
+ String refModelName = getModelName(schema);
+ return toExampleValueRecursive(refModelName, refSchema, objExample, indentationLevel, prefix, exampleLine, seenSchemas);
+ } else if (ModelUtils.isNullType(schema) || ModelUtils.isAnyType(schema)) {
+ // The 'null' type is allowed in OAS 3.1 and above. It is not supported by OAS 3.0.x,
+ // though this tooling supports it.
+ return fullPrefix + "None" + closeChars;
+ } else if (ModelUtils.isBooleanSchema(schema)) {
+ if (objExample == null) {
+ example = "True";
+ } else {
+ if ("false".equalsIgnoreCase(objExample.toString())) {
+ example = "False";
+ } else {
+ example = "True";
+ }
+ }
+ return fullPrefix + example + closeChars;
+ } else if (ModelUtils.isDateSchema(schema)) {
+ if (objExample == null) {
+ example = pythonDate("1970-01-01");
+ } else {
+ example = pythonDate(objExample);
+ }
+ return fullPrefix + example + closeChars;
+ } else if (ModelUtils.isDateTimeSchema(schema)) {
+ if (objExample == null) {
+ example = pythonDateTime("1970-01-01T00:00:00.00Z");
+ } else {
+ example = pythonDateTime(objExample);
+ }
+ return fullPrefix + example + closeChars;
+ } else if (ModelUtils.isBinarySchema(schema)) {
+ if (objExample == null) {
+ example = "/path/to/file";
+ }
+ example = "open('" + example + "', 'rb')";
+ return fullPrefix + example + closeChars;
+ } else if (ModelUtils.isByteArraySchema(schema)) {
+ if (objExample == null) {
+ example = "'YQ=='";
+ }
+ return fullPrefix + example + closeChars;
+ } else if (ModelUtils.isStringSchema(schema)) {
+ if (objExample == null) {
+ // a BigDecimal:
+ if ("Number".equalsIgnoreCase(schema.getFormat())) {
+ example = "2";
+ return fullPrefix + example + closeChars;
+ } else if (StringUtils.isNotBlank(schema.getPattern())) {
+ String pattern = schema.getPattern();
+ /*
+ RxGen does not support our ECMA dialect https://github.com/curious-odd-man/RgxGen/issues/56
+ So strip off the leading /, trailing / and trailing /i, and turn on ignore case if we have it
+ */
+ Pattern valueExtractor = Pattern.compile("^/?(.+?)/?(i?)$");
+ Matcher m = valueExtractor.matcher(pattern);
+ RgxGen rgxGen = null;
+ if (m.find()) {
+ int groupCount = m.groupCount();
+ if (groupCount == 1) {
+ // only pattern found
+ String isolatedPattern = m.group(1);
+ rgxGen = new RgxGen(isolatedPattern);
+ } else if (groupCount == 2) {
+ // patterns and flag found
+ String isolatedPattern = m.group(1);
+ String flags = m.group(2);
+ if (flags.contains("i")) {
+ rgxGen = new RgxGen(isolatedPattern);
+ RgxGenProperties properties = new RgxGenProperties();
+ RgxGenOption.CASE_INSENSITIVE.setInProperties(properties, true);
+ rgxGen.setProperties(properties);
+ } else {
+ rgxGen = new RgxGen(isolatedPattern);
+ }
+ }
+ } else {
+ rgxGen = new RgxGen(pattern);
+ }
+
+ // this seed makes it so if we have [a-z] we pick a
+ Random random = new Random(18);
+ if (rgxGen != null) {
+ example = rgxGen.generate(random);
+ } else {
+ throw new RuntimeException("rgxGen cannot be null. Please open an issue in the openapi-generator github repo.");
+ }
+ } else if (schema.getMinLength() != null) {
+ example = "";
+ int len = schema.getMinLength().intValue();
+ for (int i = 0; i < len; i++) example += "a";
+ } else if (ModelUtils.isUUIDSchema(schema)) {
+ example = "046b6c7f-0b8a-43b9-b35d-6489e6daee91";
+ } else {
+ example = "string_example";
+ }
+ }
+ return fullPrefix + ensureQuotes(example) + closeChars;
+ } else if (ModelUtils.isIntegerSchema(schema)) {
+ if (objExample == null) {
+ if (schema.getMinimum() != null) {
+ example = schema.getMinimum().toString();
+ } else {
+ example = "1";
+ }
+ }
+ return fullPrefix + example + closeChars;
+ } else if (ModelUtils.isNumberSchema(schema)) {
+ if (objExample == null) {
+ if (schema.getMinimum() != null) {
+ example = schema.getMinimum().toString();
+ } else {
+ example = "3.14";
+ }
+ }
+ return fullPrefix + example + closeChars;
+ } else if (ModelUtils.isArraySchema(schema)) {
+ ArraySchema arrayschema = (ArraySchema) schema;
+ Schema itemSchema = arrayschema.getItems();
+ String itemModelName = getModelName(itemSchema);
+ if (objExample instanceof Iterable && itemModelName == null) {
+ // If the example is already a list, return it directly instead of wrongly wrap it in another list
+ return fullPrefix + objExample + closeChars;
+ }
+ Set newSeenSchemas = new HashSet<>(seenSchemas);
+ newSeenSchemas.add(schema);
+ example = fullPrefix + "[" + "\n" + toExampleValueRecursive(itemModelName, itemSchema, objExample, indentationLevel + 1, "", exampleLine + 1, newSeenSchemas) + ",\n" + closingIndentation + "]" + closeChars;
+ return example;
+ } else if (ModelUtils.isMapSchema(schema)) {
+ if (modelName == null) {
+ fullPrefix += "{";
+ closeChars = "}";
+ }
+ Object addPropsObj = schema.getAdditionalProperties();
+ // TODO handle true case for additionalProperties
+ if (addPropsObj instanceof Schema) {
+ Schema addPropsSchema = (Schema) addPropsObj;
+ String key = "key";
+ Object addPropsExample = getObjectExample(addPropsSchema);
+ if (addPropsSchema.getEnum() != null && !addPropsSchema.getEnum().isEmpty()) {
+ key = addPropsSchema.getEnum().get(0).toString();
+ }
+ addPropsExample = exampleFromStringOrArraySchema(addPropsSchema, addPropsExample, key);
+ String addPropPrefix = key + "=";
+ if (modelName == null) {
+ addPropPrefix = ensureQuotes(key) + ": ";
+ }
+ String addPropsModelName = getModelName(addPropsSchema);
+ Set newSeenSchemas = new HashSet<>(seenSchemas);
+ newSeenSchemas.add(schema);
+ example = fullPrefix + "\n" + toExampleValueRecursive(addPropsModelName, addPropsSchema, addPropsExample, indentationLevel + 1, addPropPrefix, exampleLine + 1, newSeenSchemas) + ",\n" + closingIndentation + closeChars;
+ } else {
+ example = fullPrefix + closeChars;
+ }
+ return example;
+ } else if (ModelUtils.isObjectSchema(schema)) {
+ if (modelName == null) {
+ fullPrefix += "{";
+ closeChars = "}";
+ }
+ CodegenDiscriminator disc = createDiscriminator(modelName, schema, openAPI);
+ if (disc != null) {
+ MappedModel mm = getDiscriminatorMappedModel(disc);
+ if (mm != null) {
+ String discPropNameValue = mm.getMappingName();
+ String chosenModelName = mm.getModelName();
+ // TODO handle this case in the future, this is when the discriminated
+ // schema allOf includes this schema, like Cat allOf includes Pet
+ // so this is the composed schema use case
+ } else {
+ return fullPrefix + closeChars;
+ }
+ }
+ Set newSeenSchemas = new HashSet<>(seenSchemas);
+ newSeenSchemas.add(schema);
+ String exampleForObjectModel = exampleForObjectModel(schema, fullPrefix, closeChars, null, indentationLevel, exampleLine, closingIndentation, newSeenSchemas);
+ return exampleForObjectModel;
+ } else if (ModelUtils.isComposedSchema(schema)) {
+ // TODO add examples for composed schema models without discriminators
+
+ CodegenDiscriminator disc = createDiscriminator(modelName, schema, openAPI);
+ if (disc != null) {
+ MappedModel mm = getDiscriminatorMappedModel(disc);
+ if (mm != null) {
+ String discPropNameValue = mm.getMappingName();
+ String chosenModelName = mm.getModelName();
+ Schema modelSchema = getModelNameToSchemaCache().get(chosenModelName);
+ CodegenProperty cp = new CodegenProperty();
+ cp.setName(disc.getPropertyName());
+ cp.setExample(discPropNameValue);
+ // Adds schema to seenSchemas before running example model function. removes schema after running
+ // the function. It also doesn't keep track of any schemas within the ObjectModel.
+ Set newSeenSchemas = new HashSet<>(seenSchemas);
+ newSeenSchemas.add(schema);
+ String exampleForObjectModel = exampleForObjectModel(modelSchema, fullPrefix, closeChars, cp, indentationLevel, exampleLine, closingIndentation, newSeenSchemas);
+ return exampleForObjectModel;
+ } else {
+ return fullPrefix + closeChars;
+ }
+ }
+ return fullPrefix + closeChars;
+ } else {
+ LOGGER.warn("Type {} not handled properly in toExampleValue", schema.getType());
+ }
+
+ return example;
+ }
+
+ private String exampleForObjectModel(Schema schema, String fullPrefix, String closeChars, CodegenProperty discProp, int indentationLevel, int exampleLine, String closingIndentation, Set seenSchemas) {
+ Map requiredAndOptionalProps = schema.getProperties();
+ if (requiredAndOptionalProps == null || requiredAndOptionalProps.isEmpty()) {
+ return fullPrefix + closeChars;
+ }
+
+ String example = fullPrefix + "\n";
+ for (Map.Entry entry : requiredAndOptionalProps.entrySet()) {
+ String propName = entry.getKey();
+ Schema propSchema = entry.getValue();
+ boolean readOnly = false;
+ if (propSchema.getReadOnly() != null) {
+ readOnly = propSchema.getReadOnly();
+ }
+ if (readOnly) {
+ continue;
+ }
+ String ref = propSchema.get$ref();
+ if (ref != null) {
+ Schema refSchema = ModelUtils.getSchema(this.openAPI, ModelUtils.getSimpleRef(ref));
+ if (refSchema.getReadOnly() != null) {
+ readOnly = refSchema.getReadOnly();
+ }
+ if (readOnly) {
+ continue;
+ }
+ }
+ propName = toVarName(propName);
+ String propModelName = null;
+ Object propExample = null;
+ if (discProp != null && propName.equals(discProp.name)) {
+ propModelName = null;
+ propExample = discProp.example;
+ } else {
+ propModelName = getModelName(propSchema);
+ propExample = exampleFromStringOrArraySchema(propSchema, null, propName);
+ }
+ example += toExampleValueRecursive(propModelName, propSchema, propExample, indentationLevel + 1, propName + "=", exampleLine + 1, seenSchemas) + ",\n";
+ }
+ // TODO handle additionalProperties also
+ example += closingIndentation + closeChars;
+ return example;
+ }
+
+ private Object exampleFromStringOrArraySchema(Schema sc, Object currentExample, String propName) {
+ if (currentExample != null) {
+ return currentExample;
+ }
+ Schema schema = sc;
+ String ref = sc.get$ref();
+ if (ref != null) {
+ schema = ModelUtils.getSchema(this.openAPI, ModelUtils.getSimpleRef(ref));
+ }
+ Object example = getObjectExample(schema);
+ if (example != null) {
+ return example;
+ } else if (simpleStringSchema(schema)) {
+ return propName + "_example";
+ } else if (ModelUtils.isArraySchema(schema)) {
+ ArraySchema arraySchema = (ArraySchema) schema;
+ Schema itemSchema = arraySchema.getItems();
+ example = getObjectExample(itemSchema);
+ if (example != null) {
+ return example;
+ } else if (simpleStringSchema(itemSchema)) {
+ return propName + "_example";
+ }
+ }
+ return null;
+ }
+
+
+ /***
+ *
+ * Set the codegenParameter example value
+ * We have a custom version of this function so we can invoke toExampleValue
+ *
+ * @param codegenParameter the item we are setting the example on
+ * @param parameter the base parameter that came from the spec
+ */
+ @Override
+ public void setParameterExampleValue(CodegenParameter codegenParameter, Parameter parameter) {
+ Schema schema = parameter.getSchema();
+ if (schema == null) {
+ LOGGER.warn("CodegenParameter.example defaulting to null because parameter lacks a schema");
+ return;
+ }
+
+ Object example = null;
+ if (codegenParameter.vendorExtensions != null && codegenParameter.vendorExtensions.containsKey("x-example")) {
+ example = codegenParameter.vendorExtensions.get("x-example");
+ } else if (parameter.getExample() != null) {
+ example = parameter.getExample();
+ } else if (parameter.getExamples() != null && !parameter.getExamples().isEmpty() && parameter.getExamples().values().iterator().next().getValue() != null) {
+ example = parameter.getExamples().values().iterator().next().getValue();
+ } else {
+ example = getObjectExample(schema);
+ }
+ example = exampleFromStringOrArraySchema(schema, example, parameter.getName());
+ String finalExample = toExampleValue(schema, example);
+ codegenParameter.example = finalExample;
+ }
+
+ /**
+ * Return the example value of the parameter.
+ *
+ * @param codegenParameter Codegen parameter
+ * @param requestBody Request body
+ */
+ @Override
+ public void setParameterExampleValue(CodegenParameter codegenParameter, RequestBody requestBody) {
+ if (codegenParameter.vendorExtensions != null && codegenParameter.vendorExtensions.containsKey("x-example")) {
+ codegenParameter.example = Json.pretty(codegenParameter.vendorExtensions.get("x-example"));
+ }
+
+ Content content = requestBody.getContent();
+
+ if (content.size() > 1) {
+ // @see ModelUtils.getSchemaFromContent()
+ once(LOGGER).warn("Multiple MediaTypes found, using only the first one");
+ }
+
+ MediaType mediaType = content.values().iterator().next();
+ Schema schema = mediaType.getSchema();
+ if (schema == null) {
+ LOGGER.warn("CodegenParameter.example defaulting to null because requestBody content lacks a schema");
+ return;
+ }
+
+ Object example = null;
+ if (mediaType.getExample() != null) {
+ example = mediaType.getExample();
+ } else if (mediaType.getExamples() != null && !mediaType.getExamples().isEmpty() && mediaType.getExamples().values().iterator().next().getValue() != null) {
+ example = mediaType.getExamples().values().iterator().next().getValue();
+ } else {
+ example = getObjectExample(schema);
+ }
+ example = exampleFromStringOrArraySchema(schema, example, codegenParameter.paramName);
+ codegenParameter.example = toExampleValue(schema, example);
+ }
+
+ /**
+ * Create a CodegenParameter for a Form Property
+ * We have a custom version of this method so we can invoke
+ * setParameterExampleValue(codegenParameter, parameter)
+ * rather than setParameterExampleValue(codegenParameter)
+ * This ensures that all of our samples are generated in
+ * toExampleValueRecursive
+ *
+ * @param name the property name
+ * @param propertySchema the property schema
+ * @param imports our import set
+ * @return the resultant CodegenParameter
+ */
+ @Override
+ public CodegenParameter fromFormProperty(String name, Schema propertySchema, Set imports) {
+ CodegenParameter cp = super.fromFormProperty(name, propertySchema, imports);
+ Parameter p = new Parameter();
+ p.setSchema(propertySchema);
+ p.setName(cp.paramName);
+ setParameterExampleValue(cp, p);
+ return cp;
+ }
+
+ /**
+ * Return a map from model name to Schema for efficient lookup.
+ *
+ * @return map from model name to Schema.
+ */
+ protected Map getModelNameToSchemaCache() {
+ if (modelNameToSchemaCache == null) {
+ // Create a cache to efficiently lookup schema based on model name.
+ Map m = new HashMap<>();
+ ModelUtils.getSchemas(openAPI).forEach((key, schema) -> {
+ m.put(toModelName(key), schema);
+ });
+ modelNameToSchemaCache = Collections.unmodifiableMap(m);
+ }
+ return modelNameToSchemaCache;
+ }
+
+ @Override
+ public String generatorLanguageVersion() { return ">=3.6"; };
+
+ @Override
+ protected void addImport(ComposedSchema composed, Schema childSchema, CodegenModel model, String modelName ) {
+ // import everything (including child schema of a composed schema)
+ addImport(model, modelName);
+ }
+}
diff --git a/modules/openapi-generator/src/main/resources/META-INF/services/org.openapitools.codegen.CodegenConfig b/modules/openapi-generator/src/main/resources/META-INF/services/org.openapitools.codegen.CodegenConfig
index 55a1e66eb88d..11a9572215d3 100644
--- a/modules/openapi-generator/src/main/resources/META-INF/services/org.openapitools.codegen.CodegenConfig
+++ b/modules/openapi-generator/src/main/resources/META-INF/services/org.openapitools.codegen.CodegenConfig
@@ -98,7 +98,7 @@ org.openapitools.codegen.languages.ProtobufSchemaCodegen
org.openapitools.codegen.languages.PythonLegacyClientCodegen
org.openapitools.codegen.languages.PythonClientCodegen
org.openapitools.codegen.languages.PythonFastAPIServerCodegen
-org.openapitools.codegen.languages.PythonExperimentalClientCodegen
+org.openapitools.codegen.languages.PythonPriorClientCodegen
org.openapitools.codegen.languages.PythonFlaskConnexionServerCodegen
org.openapitools.codegen.languages.PythonAiohttpConnexionServerCodegen
org.openapitools.codegen.languages.PythonBluePlanetServerCodegen
diff --git a/modules/openapi-generator/src/main/resources/python/README.mustache b/modules/openapi-generator/src/main/resources/python-prior/README.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/README.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/README.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/README_common.mustache b/modules/openapi-generator/src/main/resources/python-prior/README_common.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/README_common.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/README_common.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/README_onlypackage.mustache b/modules/openapi-generator/src/main/resources/python-prior/README_onlypackage.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/README_onlypackage.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/README_onlypackage.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/__init__.mustache b/modules/openapi-generator/src/main/resources/python-prior/__init__.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/__init__.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/__init__.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/__init__api.mustache b/modules/openapi-generator/src/main/resources/python-prior/__init__api.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/__init__api.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/__init__api.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/__init__apis.mustache b/modules/openapi-generator/src/main/resources/python-prior/__init__apis.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/__init__apis.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/__init__apis.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/__init__model.mustache b/modules/openapi-generator/src/main/resources/python-prior/__init__model.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/__init__model.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/__init__model.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/__init__models.mustache b/modules/openapi-generator/src/main/resources/python-prior/__init__models.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/__init__models.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/__init__models.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/__init__package.mustache b/modules/openapi-generator/src/main/resources/python-prior/__init__package.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/__init__package.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/__init__package.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/api.mustache b/modules/openapi-generator/src/main/resources/python-prior/api.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/api.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/api.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/api_client.mustache b/modules/openapi-generator/src/main/resources/python-prior/api_client.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/api_client.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/api_client.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/api_doc.mustache b/modules/openapi-generator/src/main/resources/python-prior/api_doc.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/api_doc.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/api_doc.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/api_doc_example.mustache b/modules/openapi-generator/src/main/resources/python-prior/api_doc_example.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/api_doc_example.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/api_doc_example.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/api_test.mustache b/modules/openapi-generator/src/main/resources/python-prior/api_test.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/api_test.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/api_test.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/asyncio/rest.mustache b/modules/openapi-generator/src/main/resources/python-prior/asyncio/rest.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/asyncio/rest.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/asyncio/rest.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/configuration.mustache b/modules/openapi-generator/src/main/resources/python-prior/configuration.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/configuration.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/configuration.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/exceptions.mustache b/modules/openapi-generator/src/main/resources/python-prior/exceptions.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/exceptions.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/exceptions.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/git_push.sh.mustache b/modules/openapi-generator/src/main/resources/python-prior/git_push.sh.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/git_push.sh.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/git_push.sh.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/gitignore.mustache b/modules/openapi-generator/src/main/resources/python-prior/gitignore.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/gitignore.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/gitignore.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/gitlab-ci.mustache b/modules/openapi-generator/src/main/resources/python-prior/gitlab-ci.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/gitlab-ci.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/gitlab-ci.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model.mustache b/modules/openapi-generator/src/main/resources/python-prior/model.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_doc.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_doc.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_doc.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_doc.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/classvars.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/classvars.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/classvars.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/classvars.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/docstring_allowed.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/docstring_allowed.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/docstring_allowed.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/docstring_allowed.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/docstring_init_required_kwargs.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/docstring_init_required_kwargs.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/docstring_init_required_kwargs.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/docstring_init_required_kwargs.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/docstring_openapi_validations.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/docstring_openapi_validations.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/docstring_openapi_validations.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/docstring_openapi_validations.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/invalid_pos_args.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/invalid_pos_args.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/invalid_pos_args.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/invalid_pos_args.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/method_from_openapi_data_composed.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/method_from_openapi_data_composed.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/method_from_openapi_data_composed.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/method_from_openapi_data_composed.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/method_from_openapi_data_normal.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/method_from_openapi_data_normal.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/method_from_openapi_data_normal.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/method_from_openapi_data_normal.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/method_from_openapi_data_shared.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/method_from_openapi_data_shared.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/method_from_openapi_data_shared.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/method_from_openapi_data_shared.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/method_from_openapi_data_simple.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/method_from_openapi_data_simple.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/method_from_openapi_data_simple.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/method_from_openapi_data_simple.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/method_init_composed.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/method_init_composed.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/method_init_composed.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/method_init_composed.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/method_init_normal.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/method_init_normal.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/method_init_normal.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/method_init_normal.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/method_init_shared.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/method_init_shared.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/method_init_shared.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/method_init_shared.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/method_init_simple.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/method_init_simple.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/method_init_simple.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/method_init_simple.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/method_set_attribute.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/method_set_attribute.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/method_set_attribute.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/method_set_attribute.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/methods_setattr_getattr_composed.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/methods_setattr_getattr_composed.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/methods_setattr_getattr_composed.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/methods_setattr_getattr_composed.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/methods_setattr_getattr_normal.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/methods_setattr_getattr_normal.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/methods_setattr_getattr_normal.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/methods_setattr_getattr_normal.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/methods_shared.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/methods_shared.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/methods_shared.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/methods_shared.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/methods_todict_tostr_eq_shared.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/methods_todict_tostr_eq_shared.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/methods_todict_tostr_eq_shared.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/methods_todict_tostr_eq_shared.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/methods_tostr_eq_simple.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/methods_tostr_eq_simple.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/methods_tostr_eq_simple.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/methods_tostr_eq_simple.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/model_composed.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/model_composed.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/model_composed.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/model_composed.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/model_normal.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/model_normal.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/model_normal.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/model_normal.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/model_simple.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/model_simple.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/model_simple.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/model_simple.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/validations.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_templates/validations.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_templates/validations.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_templates/validations.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_test.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_test.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_test.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_test.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/model_utils.mustache b/modules/openapi-generator/src/main/resources/python-prior/model_utils.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/model_utils.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/model_utils.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/partial_header.mustache b/modules/openapi-generator/src/main/resources/python-prior/partial_header.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/partial_header.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/partial_header.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/python_doc_auth_partial.mustache b/modules/openapi-generator/src/main/resources/python-prior/python_doc_auth_partial.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/python_doc_auth_partial.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/python_doc_auth_partial.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/requirements.mustache b/modules/openapi-generator/src/main/resources/python-prior/requirements.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/requirements.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/requirements.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/rest.mustache b/modules/openapi-generator/src/main/resources/python-prior/rest.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/rest.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/rest.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/setup.mustache b/modules/openapi-generator/src/main/resources/python-prior/setup.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/setup.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/setup.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/setup_cfg.mustache b/modules/openapi-generator/src/main/resources/python-prior/setup_cfg.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/setup_cfg.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/setup_cfg.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/signing.mustache b/modules/openapi-generator/src/main/resources/python-prior/signing.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/signing.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/signing.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/test-requirements.mustache b/modules/openapi-generator/src/main/resources/python-prior/test-requirements.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/test-requirements.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/test-requirements.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/tornado/rest.mustache b/modules/openapi-generator/src/main/resources/python-prior/tornado/rest.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/tornado/rest.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/tornado/rest.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/tox.mustache b/modules/openapi-generator/src/main/resources/python-prior/tox.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/tox.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/tox.mustache
diff --git a/modules/openapi-generator/src/main/resources/python/travis.mustache b/modules/openapi-generator/src/main/resources/python-prior/travis.mustache
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python/travis.mustache
rename to modules/openapi-generator/src/main/resources/python-prior/travis.mustache
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/README.handlebars b/modules/openapi-generator/src/main/resources/python/README.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/README.handlebars
rename to modules/openapi-generator/src/main/resources/python/README.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/README_common.handlebars b/modules/openapi-generator/src/main/resources/python/README_common.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/README_common.handlebars
rename to modules/openapi-generator/src/main/resources/python/README_common.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/README_onlypackage.handlebars b/modules/openapi-generator/src/main/resources/python/README_onlypackage.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/README_onlypackage.handlebars
rename to modules/openapi-generator/src/main/resources/python/README_onlypackage.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/__init__.handlebars b/modules/openapi-generator/src/main/resources/python/__init__.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/__init__.handlebars
rename to modules/openapi-generator/src/main/resources/python/__init__.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/__init__apis.handlebars b/modules/openapi-generator/src/main/resources/python/__init__apis.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/__init__apis.handlebars
rename to modules/openapi-generator/src/main/resources/python/__init__apis.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/__init__apis_tags.handlebars b/modules/openapi-generator/src/main/resources/python/__init__apis_tags.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/__init__apis_tags.handlebars
rename to modules/openapi-generator/src/main/resources/python/__init__apis_tags.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/__init__model.handlebars b/modules/openapi-generator/src/main/resources/python/__init__model.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/__init__model.handlebars
rename to modules/openapi-generator/src/main/resources/python/__init__model.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/__init__models.handlebars b/modules/openapi-generator/src/main/resources/python/__init__models.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/__init__models.handlebars
rename to modules/openapi-generator/src/main/resources/python/__init__models.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/__init__package.handlebars b/modules/openapi-generator/src/main/resources/python/__init__package.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/__init__package.handlebars
rename to modules/openapi-generator/src/main/resources/python/__init__package.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/__init__paths.handlebars b/modules/openapi-generator/src/main/resources/python/__init__paths.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/__init__paths.handlebars
rename to modules/openapi-generator/src/main/resources/python/__init__paths.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/__init__paths_enum.handlebars b/modules/openapi-generator/src/main/resources/python/__init__paths_enum.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/__init__paths_enum.handlebars
rename to modules/openapi-generator/src/main/resources/python/__init__paths_enum.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/__init__paths_x.handlebars b/modules/openapi-generator/src/main/resources/python/__init__paths_x.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/__init__paths_x.handlebars
rename to modules/openapi-generator/src/main/resources/python/__init__paths_x.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/__init__test_paths.handlebars b/modules/openapi-generator/src/main/resources/python/__init__test_paths.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/__init__test_paths.handlebars
rename to modules/openapi-generator/src/main/resources/python/__init__test_paths.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/api.handlebars b/modules/openapi-generator/src/main/resources/python/api.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/api.handlebars
rename to modules/openapi-generator/src/main/resources/python/api.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/api_client.handlebars b/modules/openapi-generator/src/main/resources/python/api_client.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/api_client.handlebars
rename to modules/openapi-generator/src/main/resources/python/api_client.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/api_doc.handlebars b/modules/openapi-generator/src/main/resources/python/api_doc.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/api_doc.handlebars
rename to modules/openapi-generator/src/main/resources/python/api_doc.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/api_doc_example.handlebars b/modules/openapi-generator/src/main/resources/python/api_doc_example.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/api_doc_example.handlebars
rename to modules/openapi-generator/src/main/resources/python/api_doc_example.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/api_doc_schema_type_hint.handlebars b/modules/openapi-generator/src/main/resources/python/api_doc_schema_type_hint.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/api_doc_schema_type_hint.handlebars
rename to modules/openapi-generator/src/main/resources/python/api_doc_schema_type_hint.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/api_test.handlebars b/modules/openapi-generator/src/main/resources/python/api_test.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/api_test.handlebars
rename to modules/openapi-generator/src/main/resources/python/api_test.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/api_test_partial.handlebars b/modules/openapi-generator/src/main/resources/python/api_test_partial.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/api_test_partial.handlebars
rename to modules/openapi-generator/src/main/resources/python/api_test_partial.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/apis_path_module.handlebars b/modules/openapi-generator/src/main/resources/python/apis_path_module.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/apis_path_module.handlebars
rename to modules/openapi-generator/src/main/resources/python/apis_path_module.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/apis_path_to_api.handlebars b/modules/openapi-generator/src/main/resources/python/apis_path_to_api.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/apis_path_to_api.handlebars
rename to modules/openapi-generator/src/main/resources/python/apis_path_to_api.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/apis_tag_to_api.handlebars b/modules/openapi-generator/src/main/resources/python/apis_tag_to_api.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/apis_tag_to_api.handlebars
rename to modules/openapi-generator/src/main/resources/python/apis_tag_to_api.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/comma.handlebars b/modules/openapi-generator/src/main/resources/python/comma.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/comma.handlebars
rename to modules/openapi-generator/src/main/resources/python/comma.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/configuration.handlebars b/modules/openapi-generator/src/main/resources/python/configuration.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/configuration.handlebars
rename to modules/openapi-generator/src/main/resources/python/configuration.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/doc_auth_partial.handlebars b/modules/openapi-generator/src/main/resources/python/doc_auth_partial.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/doc_auth_partial.handlebars
rename to modules/openapi-generator/src/main/resources/python/doc_auth_partial.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/endpoint.handlebars b/modules/openapi-generator/src/main/resources/python/endpoint.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/endpoint.handlebars
rename to modules/openapi-generator/src/main/resources/python/endpoint.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/endpoint_args.handlebars b/modules/openapi-generator/src/main/resources/python/endpoint_args.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/endpoint_args.handlebars
rename to modules/openapi-generator/src/main/resources/python/endpoint_args.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/endpoint_args_passed.handlebars b/modules/openapi-generator/src/main/resources/python/endpoint_args_passed.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/endpoint_args_passed.handlebars
rename to modules/openapi-generator/src/main/resources/python/endpoint_args_passed.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/endpoint_body_serialization.handlebars b/modules/openapi-generator/src/main/resources/python/endpoint_body_serialization.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/endpoint_body_serialization.handlebars
rename to modules/openapi-generator/src/main/resources/python/endpoint_body_serialization.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/endpoint_parameter.handlebars b/modules/openapi-generator/src/main/resources/python/endpoint_parameter.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/endpoint_parameter.handlebars
rename to modules/openapi-generator/src/main/resources/python/endpoint_parameter.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/endpoint_stub.handlebars b/modules/openapi-generator/src/main/resources/python/endpoint_stub.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/endpoint_stub.handlebars
rename to modules/openapi-generator/src/main/resources/python/endpoint_stub.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/exceptions.handlebars b/modules/openapi-generator/src/main/resources/python/exceptions.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/exceptions.handlebars
rename to modules/openapi-generator/src/main/resources/python/exceptions.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/git_push.sh.handlebars b/modules/openapi-generator/src/main/resources/python/git_push.sh.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/git_push.sh.handlebars
rename to modules/openapi-generator/src/main/resources/python/git_push.sh.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/gitignore.handlebars b/modules/openapi-generator/src/main/resources/python/gitignore.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/gitignore.handlebars
rename to modules/openapi-generator/src/main/resources/python/gitignore.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/gitlab-ci.handlebars b/modules/openapi-generator/src/main/resources/python/gitlab-ci.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/gitlab-ci.handlebars
rename to modules/openapi-generator/src/main/resources/python/gitlab-ci.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model.handlebars b/modules/openapi-generator/src/main/resources/python/model.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model.handlebars
rename to modules/openapi-generator/src/main/resources/python/model.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_doc.handlebars b/modules/openapi-generator/src/main/resources/python/model_doc.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_doc.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_doc.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_stub.handlebars b/modules/openapi-generator/src/main/resources/python/model_stub.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_stub.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_stub.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/classname.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/classname.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/classname.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/classname.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/composed_schemas.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/composed_schemas.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/composed_schemas.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/composed_schemas.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/dict_partial.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/dict_partial.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/dict_partial.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/dict_partial.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/enums.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/enums.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/enums.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/enums.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/format_base.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/format_base.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/format_base.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/format_base.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/imports_schema_types.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/imports_schema_types.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/imports_schema_types.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/imports_schema_types.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/imports_schemas.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/imports_schemas.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/imports_schemas.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/imports_schemas.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/list_partial.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/list_partial.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/list_partial.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/list_partial.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/new.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/new.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/new.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/new.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/notes_msg.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/notes_msg.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/notes_msg.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/notes_msg.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/payload_renderer.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/payload_renderer.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/payload_renderer.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/payload_renderer.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/property_getitems_with_addprops.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/property_getitems_with_addprops.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/property_getitems_with_addprops.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/property_getitems_with_addprops.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/property_getitems_with_addprops_getitem.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/property_getitems_with_addprops_getitem.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/property_getitems_with_addprops_getitem.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/property_getitems_with_addprops_getitem.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/property_getitems_without_addprops.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/property_getitems_without_addprops.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/property_getitems_without_addprops.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/property_getitems_without_addprops.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/property_type_hints.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/property_type_hints.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/property_type_hints.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/property_type_hints.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/property_type_hints_required.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/property_type_hints_required.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/property_type_hints_required.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/property_type_hints_required.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/schema.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/schema.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/schema.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/schema.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/schema_accessed_types.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/schema_accessed_types.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/schema_accessed_types.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/schema_accessed_types.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/schema_composed_or_anytype.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/schema_composed_or_anytype.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/schema_composed_or_anytype.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/schema_composed_or_anytype.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/schema_dict.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/schema_dict.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/schema_dict.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/schema_dict.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/schema_list.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/schema_list.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/schema_list.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/schema_list.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/schema_python_types.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/schema_python_types.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/schema_python_types.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/schema_python_types.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/schema_simple.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/schema_simple.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/schema_simple.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/schema_simple.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/validations.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/validations.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/validations.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/validations.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/var_equals_cls.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/var_equals_cls.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/var_equals_cls.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/var_equals_cls.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_templates/xbase_schema.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/xbase_schema.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_templates/xbase_schema.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_templates/xbase_schema.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/model_test.handlebars b/modules/openapi-generator/src/main/resources/python/model_test.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/model_test.handlebars
rename to modules/openapi-generator/src/main/resources/python/model_test.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/partial_header.handlebars b/modules/openapi-generator/src/main/resources/python/partial_header.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/partial_header.handlebars
rename to modules/openapi-generator/src/main/resources/python/partial_header.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/requirements.handlebars b/modules/openapi-generator/src/main/resources/python/requirements.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/requirements.handlebars
rename to modules/openapi-generator/src/main/resources/python/requirements.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/rest.handlebars b/modules/openapi-generator/src/main/resources/python/rest.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/rest.handlebars
rename to modules/openapi-generator/src/main/resources/python/rest.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/schema_doc.handlebars b/modules/openapi-generator/src/main/resources/python/schema_doc.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/schema_doc.handlebars
rename to modules/openapi-generator/src/main/resources/python/schema_doc.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/schemas.handlebars b/modules/openapi-generator/src/main/resources/python/schemas.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/schemas.handlebars
rename to modules/openapi-generator/src/main/resources/python/schemas.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/setup.handlebars b/modules/openapi-generator/src/main/resources/python/setup.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/setup.handlebars
rename to modules/openapi-generator/src/main/resources/python/setup.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/setup_cfg.handlebars b/modules/openapi-generator/src/main/resources/python/setup_cfg.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/setup_cfg.handlebars
rename to modules/openapi-generator/src/main/resources/python/setup_cfg.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/signing.handlebars b/modules/openapi-generator/src/main/resources/python/signing.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/signing.handlebars
rename to modules/openapi-generator/src/main/resources/python/signing.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/test-requirements.handlebars b/modules/openapi-generator/src/main/resources/python/test-requirements.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/test-requirements.handlebars
rename to modules/openapi-generator/src/main/resources/python/test-requirements.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/tox.handlebars b/modules/openapi-generator/src/main/resources/python/tox.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/tox.handlebars
rename to modules/openapi-generator/src/main/resources/python/tox.handlebars
diff --git a/modules/openapi-generator/src/main/resources/python-experimental/travis.handlebars b/modules/openapi-generator/src/main/resources/python/travis.handlebars
similarity index 100%
rename from modules/openapi-generator/src/main/resources/python-experimental/travis.handlebars
rename to modules/openapi-generator/src/main/resources/python/travis.handlebars
diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/DefaultCodegenTest.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/DefaultCodegenTest.java
index f1d1d182d132..cfdc60aa0aa5 100644
--- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/DefaultCodegenTest.java
+++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/DefaultCodegenTest.java
@@ -268,7 +268,7 @@ public void testDateTimeFormParameterHasDefaultValue() {
@Test
public void testOriginalOpenApiDocumentVersion() {
// Test with OAS 2.0 document.
- String location = "src/test/resources/2_0/python-client-experimental/petstore-with-fake-endpoints-models-for-testing.yaml";
+ String location = "src/test/resources/2_0/python-prior/petstore-with-fake-endpoints-models-for-testing.yaml";
OpenAPI openAPI = TestUtils.parseFlattenSpec(location);
SemVer version = ModelUtils.getOpenApiVersion(openAPI, location, null);
Assert.assertEquals(version, new SemVer("2.0.0"));
diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PythonClientOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PythonClientOptionsProvider.java
index dd11b886a9a6..f4ed0384bfbf 100644
--- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PythonClientOptionsProvider.java
+++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PythonClientOptionsProvider.java
@@ -19,7 +19,7 @@
import com.google.common.collect.ImmutableMap;
import org.openapitools.codegen.CodegenConstants;
-import org.openapitools.codegen.languages.PythonClientCodegen;
+import org.openapitools.codegen.languages.PythonPriorClientCodegen;
import java.util.Map;
@@ -42,7 +42,7 @@ public String getLanguage() {
@Override
public Map createOptions() {
ImmutableMap.Builder builder = new ImmutableMap.Builder();
- return builder.put(PythonClientCodegen.PACKAGE_URL, PACKAGE_URL_VALUE)
+ return builder.put(PythonPriorClientCodegen.PACKAGE_URL, PACKAGE_URL_VALUE)
.put(CodegenConstants.PACKAGE_NAME, PACKAGE_NAME_VALUE)
.put(CodegenConstants.PROJECT_NAME, PROJECT_NAME_VALUE)
.put(CodegenConstants.PACKAGE_VERSION, PACKAGE_VERSION_VALUE)
@@ -50,9 +50,9 @@ public Map createOptions() {
.put(CodegenConstants.SOURCECODEONLY_GENERATION, "false")
.put(CodegenConstants.LIBRARY, "urllib3")
.put(CodegenConstants.DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT, DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT)
- .put(PythonClientCodegen.USE_NOSE, USE_NOSE_VALUE)
- .put(PythonClientCodegen.RECURSION_LIMIT, RECURSION_LIMIT)
- .put(PythonClientCodegen.PYTHON_ATTR_NONE_IF_UNSET, PYTHON_ATTR_NONE_IF_UNSET)
+ .put(PythonPriorClientCodegen.USE_NOSE, USE_NOSE_VALUE)
+ .put(PythonPriorClientCodegen.RECURSION_LIMIT, RECURSION_LIMIT)
+ .put(PythonPriorClientCodegen.PYTHON_ATTR_NONE_IF_UNSET, PYTHON_ATTR_NONE_IF_UNSET)
.put(CodegenConstants.INIT_REQUIRED_VARS, INIT_REQUIRED_VARS)
.build();
}
diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/python/PythonClientTest.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/python/PythonClientTest.java
index 2ff86d741d6e..56b5d92a79a7 100644
--- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/python/PythonClientTest.java
+++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/python/PythonClientTest.java
@@ -15,548 +15,105 @@
*/
package org.openapitools.codegen.python;
-import com.google.common.io.Resources;
-import java.io.IOException;
-import java.nio.charset.StandardCharsets;
-import org.openapitools.codegen.config.CodegenConfigurator;
-import com.google.common.collect.Sets;
+import com.google.common.io.Resources;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.Operation;
import io.swagger.v3.oas.models.media.*;
-import io.swagger.v3.parser.util.SchemaTypeUtil;
-
-import java.io.File;
-import java.math.BigDecimal;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.util.Arrays;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-
import org.openapitools.codegen.*;
import org.openapitools.codegen.languages.PythonClientCodegen;
import org.openapitools.codegen.utils.ModelUtils;
import org.testng.Assert;
-import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+
@SuppressWarnings("static-method")
public class PythonClientTest {
- @Test(description = "convert a python model with dots")
- public void modelTest() {
- final OpenAPI openAPI= TestUtils.parseFlattenSpec("src/test/resources/2_0/v1beta3.json");
- final DefaultCodegen codegen = new PythonClientCodegen();
- codegen.setOpenAPI(openAPI);
-
- codegen.setOpenAPI(openAPI);
- final CodegenModel simpleName = codegen.fromModel("v1beta3.Binding", openAPI.getComponents().getSchemas().get("v1beta3.Binding"));
- Assert.assertEquals(simpleName.name, "v1beta3.Binding");
- Assert.assertEquals(simpleName.classname, "V1beta3Binding");
- Assert.assertEquals(simpleName.classVarName, "v1beta3_binding");
-
- codegen.setOpenAPI(openAPI);
- final CodegenModel compoundName = codegen.fromModel("v1beta3.ComponentStatus", openAPI.getComponents().getSchemas().get("v1beta3.ComponentStatus"));
- Assert.assertEquals(compoundName.name, "v1beta3.ComponentStatus");
- Assert.assertEquals(compoundName.classname, "V1beta3ComponentStatus");
- Assert.assertEquals(compoundName.classVarName, "v1beta3_component_status");
-
- final String path = "/api/v1beta3/namespaces/{namespaces}/bindings";
- final Operation operation = openAPI.getPaths().get(path).getPost();
- final CodegenOperation codegenOperation = codegen.fromOperation(path, "post", operation, null);
- Assert.assertEquals(codegenOperation.returnType, "V1beta3Binding");
- Assert.assertEquals(codegenOperation.returnBaseType, "V1beta3Binding");
- }
-
- @Test(description = "convert a simple java model")
- public void simpleModelTest() {
- final Schema schema = new Schema()
- .description("a sample model")
- .addProperties("id", new IntegerSchema().format(SchemaTypeUtil.INTEGER64_FORMAT))
- .addProperties("name", new StringSchema())
- .addProperties("createdAt", new DateTimeSchema())
- .addRequiredItem("id")
- .addRequiredItem("name");
- final DefaultCodegen codegen = new PythonClientCodegen();
- OpenAPI openAPI = TestUtils.createOpenAPIWithOneSchema("sample", schema);
- codegen.setOpenAPI(openAPI);
- final CodegenModel cm = codegen.fromModel("sample", schema);
-
- Assert.assertEquals(cm.name, "sample");
- Assert.assertEquals(cm.classname, "Sample");
- Assert.assertEquals(cm.description, "a sample model");
- Assert.assertEquals(cm.vars.size(), 3);
-
- final CodegenProperty property1 = cm.vars.get(0);
- Assert.assertEquals(property1.baseName, "id");
- Assert.assertEquals(property1.dataType, "int");
- Assert.assertEquals(property1.name, "id");
- Assert.assertNull(property1.defaultValue);
- Assert.assertEquals(property1.baseType, "int");
- Assert.assertTrue(property1.required);
- Assert.assertTrue(property1.isPrimitiveType);
-
- final CodegenProperty property2 = cm.vars.get(1);
- Assert.assertEquals(property2.baseName, "name");
- Assert.assertEquals(property2.dataType, "str");
- Assert.assertEquals(property2.name, "name");
- Assert.assertNull(property2.defaultValue);
- Assert.assertEquals(property2.baseType, "str");
- Assert.assertTrue(property2.required);
- Assert.assertTrue(property2.isPrimitiveType);
-
- final CodegenProperty property3 = cm.vars.get(2);
- Assert.assertEquals(property3.baseName, "createdAt");
- Assert.assertEquals(property3.dataType, "datetime");
- Assert.assertEquals(property3.name, "created_at");
- Assert.assertNull(property3.defaultValue);
- Assert.assertEquals(property3.baseType, "datetime");
- Assert.assertFalse(property3.required);
- }
-
- @Test(description = "convert a model with list property")
- public void listPropertyTest() {
- final Schema model = new Schema()
- .description("a sample model")
- .addProperties("id", new IntegerSchema().format(SchemaTypeUtil.INTEGER64_FORMAT))
- .addProperties("urls", new ArraySchema()
- .items(new StringSchema()))
- .addRequiredItem("id");
- final DefaultCodegen codegen = new PythonClientCodegen();
- OpenAPI openAPI = TestUtils.createOpenAPIWithOneSchema("sample", model);
- codegen.setOpenAPI(openAPI);
- final CodegenModel cm = codegen.fromModel("sample", model);
-
- Assert.assertEquals(cm.name, "sample");
- Assert.assertEquals(cm.classname, "Sample");
- Assert.assertEquals(cm.description, "a sample model");
- Assert.assertEquals(cm.vars.size(), 2);
-
- final CodegenProperty property1 = cm.vars.get(0);
- Assert.assertEquals(property1.baseName, "id");
- Assert.assertEquals(property1.dataType, "int");
- Assert.assertEquals(property1.name, "id");
- Assert.assertNull(property1.defaultValue);
- Assert.assertEquals(property1.baseType, "int");
- Assert.assertTrue(property1.required);
- Assert.assertTrue(property1.isPrimitiveType);
-
- final CodegenProperty property2 = cm.vars.get(1);
- Assert.assertEquals(property2.baseName, "urls");
- Assert.assertEquals(property2.dataType, "[str]");
- Assert.assertEquals(property2.name, "urls");
- Assert.assertNull(property2.defaultValue);
- Assert.assertEquals(property2.baseType, "list");
- Assert.assertEquals(property2.containerType, "array");
- Assert.assertFalse(property2.required);
- Assert.assertTrue(property2.isPrimitiveType);
- Assert.assertTrue(property2.isContainer);
- }
-
- @Test(description = "convert a model with a map property")
- public void mapPropertyTest() {
- final Schema model = new Schema()
- .description("a sample model")
- .addProperties("translations", new MapSchema()
- .additionalProperties(new StringSchema()))
- .addRequiredItem("id");
- final DefaultCodegen codegen = new PythonClientCodegen();
- OpenAPI openAPI = TestUtils.createOpenAPIWithOneSchema("sample", model);
- codegen.setOpenAPI(openAPI);
- final CodegenModel cm = codegen.fromModel("sample", model);
-
- Assert.assertEquals(cm.name, "sample");
- Assert.assertEquals(cm.classname, "Sample");
- Assert.assertEquals(cm.description, "a sample model");
- Assert.assertEquals(cm.vars.size(), 1);
-
- final CodegenProperty property1 = cm.vars.get(0);
- Assert.assertEquals(property1.baseName, "translations");
- Assert.assertEquals(property1.dataType, "{str: (str,)}");
- Assert.assertEquals(property1.name, "translations");
- Assert.assertEquals(property1.baseType, "dict");
- Assert.assertEquals(property1.containerType, "map");
- Assert.assertFalse(property1.required);
- Assert.assertTrue(property1.isContainer);
- Assert.assertTrue(property1.isPrimitiveType);
- }
-
- @Test(description = "convert a model with complex property")
- public void complexPropertyTest() {
- final DefaultCodegen codegen = new PythonClientCodegen();
- OpenAPI openAPI = TestUtils.createOpenAPI();
- final Schema model = new Schema()
- .description("a sample model")
- .addProperties("children", new Schema().$ref("#/components/schemas/Children"));
- final Schema children = new Schema()
- .type("object")
- .addProperties("number", new Schema().type("integer"));
- openAPI.getComponents().addSchemas("sample", model);
- openAPI.getComponents().addSchemas("Children", children);
- codegen.setOpenAPI(openAPI);
-
- final CodegenModel cm = codegen.fromModel("sample", model);
-
- Assert.assertEquals(cm.name, "sample");
- Assert.assertEquals(cm.classname, "Sample");
- Assert.assertEquals(cm.description, "a sample model");
- Assert.assertEquals(cm.vars.size(), 1);
-
- final CodegenProperty property1 = cm.vars.get(0);
- Assert.assertEquals(property1.baseName, "children");
- Assert.assertEquals(property1.dataType, "Children");
- Assert.assertEquals(property1.name, "children");
- Assert.assertEquals(property1.baseType, "Children");
- Assert.assertFalse(property1.required);
- Assert.assertFalse(property1.isContainer);
- }
-
- @Test(description = "convert a model with complex list property")
- public void complexListPropertyTest() {
- final DefaultCodegen codegen = new PythonClientCodegen();
- OpenAPI openAPI = TestUtils.createOpenAPI();
- final Schema model = new Schema()
- .description("a sample model")
- .addProperties("children", new ArraySchema()
- .items(new Schema().$ref("#/components/schemas/Children")));
- final Schema children = new Schema()
- .type("object")
- .addProperties("number", new Schema().type("integer"));
- openAPI.getComponents().addSchemas("sample", model);
- openAPI.getComponents().addSchemas("Children", children);
- codegen.setOpenAPI(openAPI);
-
- final CodegenModel cm = codegen.fromModel("sample", model);
-
- Assert.assertEquals(cm.name, "sample");
- Assert.assertEquals(cm.classname, "Sample");
- Assert.assertEquals(cm.description, "a sample model");
- Assert.assertEquals(cm.vars.size(), 1);
-
- final CodegenProperty property1 = cm.vars.get(0);
- Assert.assertEquals(property1.baseName, "children");
- Assert.assertEquals(property1.complexType, "Children");
- Assert.assertEquals(property1.dataType, "[Children]");
- Assert.assertEquals(property1.name, "children");
- Assert.assertEquals(property1.baseType, "list");
- Assert.assertEquals(property1.containerType, "array");
- Assert.assertFalse(property1.required);
- Assert.assertTrue(property1.isContainer);
- }
-
- @Test(description = "convert a model with complex map property")
- public void complexMapPropertyTest() {
- final DefaultCodegen codegen = new PythonClientCodegen();
- OpenAPI openAPI = TestUtils.createOpenAPI();
- final Schema model = new Schema()
- .description("a sample model")
- .addProperties("children", new MapSchema()
- .additionalProperties(new Schema().$ref("#/components/schemas/Children")));
- final Schema children = new Schema()
- .type("object")
- .addProperties("number", new Schema().type("integer"));
- openAPI.getComponents().addSchemas("sample", model);
- openAPI.getComponents().addSchemas("Children", children);
- codegen.setOpenAPI(openAPI);
-
- final CodegenModel cm = codegen.fromModel("sample", model);
-
- Assert.assertEquals(cm.name, "sample");
- Assert.assertEquals(cm.classname, "Sample");
- Assert.assertEquals(cm.description, "a sample model");
- Assert.assertEquals(cm.vars.size(), 1);
- Assert.assertEquals(Sets.intersection(cm.imports, Sets.newHashSet("Children")).size(), 1);
-
- final CodegenProperty property1 = cm.vars.get(0);
- Assert.assertEquals(property1.baseName, "children");
- Assert.assertEquals(property1.complexType, "Children");
- Assert.assertEquals(property1.dataType, "{str: (Children,)}");
- Assert.assertEquals(property1.name, "children");
- Assert.assertEquals(property1.baseType, "dict");
- Assert.assertEquals(property1.containerType, "map");
- Assert.assertFalse(property1.required);
- Assert.assertTrue(property1.isContainer);
- }
-
+ @Test(description = "tests RecursiveExampleValueWithCycle")
+ public void testRecursiveExampleValueWithCycle() throws Exception {
- // should not start with 'null'. need help from the community to investigate further
- @Test(description = "convert an array model")
- public void arrayModelTest() {
+ final OpenAPI openAPI = TestUtils.parseSpec("src/test/resources/3_0/issue_7532.yaml");
final PythonClientCodegen codegen = new PythonClientCodegen();
- OpenAPI openAPI = TestUtils.createOpenAPI();
-
- final Schema model = new ArraySchema()
- .items(new Schema().$ref("#/components/schemas/Children"))
- .description("an array model");
- final Schema children = new Schema()
- .type("object")
- .addProperties("number", new Schema().type("integer"));
- openAPI.getComponents().addSchemas("sample", model);
- openAPI.getComponents().addSchemas("Children", children);
- codegen.setOpenAPI(openAPI);
-
- final CodegenModel cm = codegen.fromModel("sample", model);
-
- Assert.assertEquals(cm.name, "sample");
- Assert.assertEquals(cm.classname, "Sample");
- Assert.assertEquals(cm.classVarName, "sample");
- Assert.assertEquals(cm.description, "an array model");
- Assert.assertEquals(cm.vars.size(), 0); // the array model has no vars
- Assert.assertEquals(cm.parent, "list");
- Assert.assertEquals(cm.imports.size(), 1);
- Assert.assertEquals(Sets.intersection(cm.imports, Sets.newHashSet("Children")).size(), 1);
-
- final Map childExample = new HashMap<>();
- childExample.put("number", 3);
- final List> example = Arrays.asList(childExample);
- String exampleValue = codegen.toExampleValue(model, example);
- Assert.assertEquals("[Children(number=1,),]", exampleValue.replaceAll("\\s+",""));
- }
-
- // should not start with 'null'. need help from the community to investigate further
- @Test(description = "convert a map model")
- public void mapModelTest() {
- final DefaultCodegen codegen = new PythonClientCodegen();
- OpenAPI openAPI = TestUtils.createOpenAPI();
- final Schema sample = new Schema()
- .description("a map model")
- .additionalProperties(new Schema().$ref("#/components/schemas/Children"));
- final Schema children = new Schema()
- .type("object")
- .addProperties("number", new Schema().type("integer"));
- openAPI.getComponents().addSchemas("sample", sample);
- openAPI.getComponents().addSchemas("Children", children);
codegen.setOpenAPI(openAPI);
- final CodegenModel cm = codegen.fromModel("sample", sample);
-
- Assert.assertEquals(cm.name, "sample");
- Assert.assertEquals(cm.classname, "Sample");
- Assert.assertEquals(cm.description, "a map model");
- Assert.assertEquals(cm.vars.size(), 0);
- Assert.assertEquals(cm.parent, null);
- Assert.assertEquals(cm.imports.size(), 1);
- }
-
- @Test(description = "parse date and date-time example value")
- public void parseDateAndDateTimeExamplesTest() {
- final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/python/petstore-with-fake-endpoints-models-for-testing-with-http-signature.yaml");
- final DefaultCodegen codegen = new PythonClientCodegen();
+ Schema schemaWithCycleInTreesProperty = openAPI.getComponents().getSchemas().get("Forest");
+ String exampleValue = codegen.toExampleValue(schemaWithCycleInTreesProperty, null);
- Schema modelSchema = ModelUtils.getSchema(openAPI, "DateTimeTest");
- String defaultValue = codegen.toDefaultValue(modelSchema);
- Assert.assertEquals(defaultValue, "dateutil_parser('2010-01-01T10:10:10.000111+01:00')");
- }
-
- @Test(description = "format imports of models containing special characters")
- public void importSpecialModelNameTest() {
- final PythonClientCodegen codegen = new PythonClientCodegen();
-
- String importValue = codegen.toModelImport("special.ModelName");
- Assert.assertEquals(importValue, "from models.special_model_name import SpecialModelName");
+ String expectedValue = Resources.toString(
+ Resources.getResource("3_0/issue_7532_tree_example_value_expected.txt"),
+ StandardCharsets.UTF_8);
+ expectedValue = expectedValue.replaceAll("\\r\\n", "\n");
+ Assert.assertEquals(exampleValue.trim(), expectedValue.trim());
}
- @Test(description = "format imports of models containing special characters")
- public void defaultSettingInPrimitiveModelWithValidations() {
+ @Test
+ public void testSpecWithTooLowVersionThrowsException() throws RuntimeException {
+ final OpenAPI openAPI = TestUtils.parseSpec("src/test/resources/2_0/petstore.yaml");
final PythonClientCodegen codegen = new PythonClientCodegen();
-
- OpenAPI openAPI = TestUtils.createOpenAPI();
- final Schema noDefault = new Schema()
- .type("number")
- .minimum(new BigDecimal("10"));
- final Schema hasDefault = new Schema()
- .type("number")
- .minimum(new BigDecimal("10"));
- hasDefault.setDefault("15.0");
- final Schema noDefaultEumLengthOne = new Schema()
- .type("number")
- .minimum(new BigDecimal("10"));
- noDefaultEumLengthOne.setEnum(Arrays.asList("15.0"));
- openAPI.getComponents().addSchemas("noDefaultModel", noDefault);
- openAPI.getComponents().addSchemas("hasDefaultModel", hasDefault);
- openAPI.getComponents().addSchemas("noDefaultEumLengthOneModel", noDefaultEumLengthOne);
- codegen.setOpenAPI(openAPI);
-
- final CodegenModel noDefaultModel = codegen.fromModel("noDefaultModel", noDefault);
- Assert.assertEquals(noDefaultModel.defaultValue, null);
- Assert.assertEquals(noDefaultModel.hasRequired, true);
-
- final CodegenModel hasDefaultModel = codegen.fromModel("hasDefaultModel", hasDefault);
- Assert.assertEquals(hasDefaultModel.defaultValue, "15.0");
- Assert.assertEquals(hasDefaultModel.hasRequired, false);
-
- final CodegenModel noDefaultEumLengthOneModel = codegen.fromModel("noDefaultEumLengthOneModel", noDefaultEumLengthOne);
- Assert.assertEquals(noDefaultEumLengthOneModel.defaultValue, "15.0");
- Assert.assertEquals(noDefaultEumLengthOneModel.hasRequired, false);
+ codegen.preprocessOpenAPI(openAPI);
}
@Test
- public void testObjectModelWithRefedAdditionalPropertiesIsGenerated() throws Exception {
- File output = Files.createTempDirectory("test").toFile();
-
- final CodegenConfigurator configurator = new CodegenConfigurator()
- .setGeneratorName("python")
- .setInputSpec("src/test/resources/3_0/issue_7372.yaml")
- .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
-
- final ClientOptInput clientOptInput = configurator.toClientOptInput();
- DefaultGenerator generator = new DefaultGenerator();
- List files = generator.opts(clientOptInput).generate();
-
- TestUtils.ensureContainsFile(files, output, "openapi_client/model/a.py");
- TestUtils.ensureContainsFile(files, output, "openapi_client/model/b.py");
- output.deleteOnExit();
+ public void testSpecWithAcceptableVersion() {
+ final OpenAPI openAPI = TestUtils.parseSpec("src/test/resources/3_0/petstore.yaml");
+ final PythonClientCodegen codegen = new PythonClientCodegen();
+ codegen.preprocessOpenAPI(openAPI);
+ Assert.assertEquals(openAPI.getOpenapi() , "3.0.0");
+ Assert.assertTrue(openAPI.getExtensions() == null);
}
@Test
- public void testFreeFormSchemas() throws Exception {
- File output = Files.createTempDirectory("test").toFile();
-
- final CodegenConfigurator configurator = new CodegenConfigurator()
- .setGeneratorName("python")
- .setInputSpec("src/test/resources/3_0/issue_7361.yaml")
- .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
-
- final ClientOptInput clientOptInput = configurator.toClientOptInput();
- DefaultGenerator generator = new DefaultGenerator();
- List files = generator.opts(clientOptInput).generate();
-
- TestUtils.ensureContainsFile(files, output, "openapi_client/model/free_form_with_validation.py");
- TestUtils.ensureContainsFile(files, output, "openapi_client/model/free_form_interface.py");
- TestUtils.ensureDoesNotContainsFile(files, output, "openapi_client/model/free_form.py");
- output.deleteOnExit();
+ public void testSpecWithAcceptableVersionAndExtension() {
+ final OpenAPI openAPI = TestUtils.parseSpec("src/test/resources/3_0/issue_12196.yaml");
+ final PythonClientCodegen codegen = new PythonClientCodegen();
+ codegen.preprocessOpenAPI(openAPI);
+ Assert.assertEquals(openAPI.getOpenapi() , "3.0.0");
+ Assert.assertFalse(openAPI.getExtensions().isEmpty());
+ Assert.assertFalse(openAPI.getExtensions().containsValue("x-original-swagger-version"));
}
- @Test(description = "tests ObjectWithValidations")
- public void testObjectWithValidations() {
- final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/issue_7361.yaml");
- final DefaultCodegen codegen = new PythonClientCodegen();
- codegen.setOpenAPI(openAPI);
+ @Test(description = "tests GeoJson Example for GeoJsonGeometry")
+ public void testRecursiveGeoJsonExampleWhenTypeIsGeoJsonGeometry() throws IOException {
- String modelName = "FreeFormWithValidation";
- Schema modelSchema = ModelUtils.getSchema(openAPI, modelName);
- final CodegenModel model = codegen.fromModel(modelName, modelSchema);
- Assert.assertEquals((int) model.getMinProperties(), 1);
- }
-
- @Test(description = "tests RegexObjects")
- public void testRegexObjects() {
- final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/issue_11521.yaml");
- final DefaultCodegen codegen = new PythonClientCodegen();
- codegen.setOpenAPI(openAPI);
+ testEndpointExampleValue("/geojson",
+ "src/test/resources/3_0/issue_13043_recursive_model.yaml",
+ "3_0/issue_13043_recursive_model_expected_value.txt");
- String modelName = "DateTimeObject";
- Schema modelSchema = ModelUtils.getSchema(openAPI, modelName);
- final CodegenModel model = codegen.fromModel(modelName, modelSchema);
- final CodegenProperty property1 = model.vars.get(0);
- Assert.assertEquals(property1.baseName, "datetime");
- Assert.assertEquals(property1.pattern, "/[\\d]{4}-[\\d]{2}-[\\d]{2}T[\\d]{1,2}:[\\d]{2}Z/");
- Assert.assertEquals(property1.vendorExtensions.get("x-regex"), "[\\d]{4}-[\\d]{2}-[\\d]{2}T[\\d]{1,2}:[\\d]{2}Z");
- // ignore warnings, should be the same as in issue_11521.yaml
- Pattern pattern = Pattern.compile("[\\d]{4}-[\\d]{2}-[\\d]{2}T[\\d]{1,2}:[\\d]{2}Z");
- Matcher matcher = pattern.matcher(property1.example);
- Assert.assertTrue(matcher.find());
}
- @Test(description = "tests uuid example works even if a pattern is provided")
- public void testUuidExampleWorksEvenIfPatternIsDefined() {
- final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/issues_13069.yaml");
- final DefaultCodegen codegen = new PythonClientCodegen();
- codegen.setOpenAPI(openAPI);
-
- Operation operation = openAPI.getPaths().get("/test").getGet();
- CodegenParameter codegenParameter = CodegenModelFactory.newInstance(CodegenModelType.PARAMETER);
- codegen.setParameterExampleValue(codegenParameter, operation.getParameters().get(0));
+ @Test(description = "tests GeoJson Example for GeometryCollection")
+ public void testRecursiveGeoJsonExampleWhenTypeIsGeometryCollection() throws IOException {
- String modelName = "UUID";
- Schema modelSchema = ModelUtils.getSchema(openAPI, modelName);
- final CodegenModel model = codegen.fromModel(modelName, modelSchema);
+ testEndpointExampleValue("/geojson_geometry_collection",
+ "src/test/resources/3_0/issue_13043_recursive_model.yaml",
+ "3_0/issue_13043_geometry_collection_expected_value.txt");
- Pattern pattern = Pattern.compile("[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}");
- Matcher matcher = pattern.matcher(codegenParameter.example);
- Assert.assertTrue(matcher.find());
}
- @Test(description = "tests RecursiveToExample")
- public void testRecursiveToExample() throws IOException {
- final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/issue_8052_recursive_model.yaml");
+ private void testEndpointExampleValue(String endpoint, String specFilePath, String expectedAnswerPath) throws IOException {
+ final OpenAPI openAPI = TestUtils.parseFlattenSpec(specFilePath);
final PythonClientCodegen codegen = new PythonClientCodegen();
codegen.setOpenAPI(openAPI);
- final Operation operation = openAPI.getPaths().get("/geojson").getPost();
+ final Operation operation = openAPI.getPaths().get(endpoint).getPost();
Schema schema = ModelUtils.getSchemaFromRequestBody(operation.getRequestBody());
String exampleValue = codegen.toExampleValue(schema, null);
// uncomment if you need to regenerate the expected value
- // PrintWriter printWriter = new PrintWriter("src/test/resources/3_0/issue_8052_recursive_model_expected_value.txt");
+ // PrintWriter printWriter = new PrintWriter("src/test/resources/" + expectedAnswerPath);
// printWriter.write(exampleValue);
// printWriter.close();
// org.junit.Assert.assertTrue(false);
String expectedValue = Resources.toString(
- Resources.getResource("3_0/issue_8052_recursive_model_expected_value.txt"),
+ Resources.getResource(expectedAnswerPath),
StandardCharsets.UTF_8);
expectedValue = expectedValue.replaceAll("\\r\\n", "\n");
-
-
Assert.assertEquals(exampleValue.trim(), expectedValue.trim());
}
- @Test(description = "tests NoProxyPyClient")
- public void testNoProxyPyClient() throws Exception {
-
- final String gen = "python";
- final String spec = "src/test/resources/3_0/petstore.yaml";
-
- File output = Files.createTempDirectory("test").toFile();
- final CodegenConfigurator configurator = new CodegenConfigurator()
- .setGeneratorName(gen)
- .setInputSpec(spec)
- .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
- final ClientOptInput clientOptInput = configurator.toClientOptInput();
- DefaultGenerator generator = new DefaultGenerator();
- List