org.openapitools.codegen.languages

Class PythonClientCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractPythonCodegen

org.openapitools.codegen.languages.PythonClientCodegen

All Implemented Interfaces:

CodegenConfig

public class PythonClientCodegen
extends AbstractPythonCodegen

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiDocPath
static String	DEFAULT_LIBRARY
protected CodegenIgnoreProcessor	ignoreProcessor
protected String	modelDocPath
static String	PACKAGE_URL
protected String	packageUrl
static String	RECURSION_LIMIT
protected Map<Character,String>	regexModifiers
protected TemplateProcessor	templateProcessor
static String	USE_INLINE_MODEL_RESOLVER
static String	USE_NOSE
protected boolean	useInlineModelResolver
protected boolean	useNose

Fields inherited from class org.openapitools.codegen.languages.AbstractPythonCodegen

packageName, packageVersion, projectName

Fields inherited from class org.openapitools.codegen.DefaultCodegen

additionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, addSchemaImportsFromV3SpecLocations, addSuffixToDuplicateOperationNicknames, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, DefaultFeatureSet, defaultIncludes, disallowAdditionalPropertiesIfNotPresent, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, enumUnknownDefaultCase, enumUnknownDefaultCaseName, falseSchema, filesMetadataFilename, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importBaseType, importContainerType, importMapping, inlineSchemaNameDefault, inlineSchemaNameMapping, inputSpec, instantiationTypes, JSON_MIME_PATTERN, JSON_VENDOR_MIME_PATTERN, languageSpecificPrimitives, legacyDiscriminatorBehavior, library, loadDeepObjectIntoItems, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, openapiNormalizer, outputFolder, prependFormOrBodyParameters, releaseNote, removeEnumValuePrefix, removeOperationIdPrefix, removeOperationIdPrefixCount, removeOperationIdPrefixDelimiter, reservedWords, reservedWordsMappings, schemaMapping, serverVariables, skipOperationExample, skipOverwrite, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsAdditionalPropertiesWithComposedSchema, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, testPackage, trueSchema, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions, versionMetadataFilename

Constructor Summary

Constructors

Constructor and Description
PythonClientCodegen()

Method Summary

Modifier and Type	Method and Description
protected void	addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema) Handle the model for the 'additionalProperties' keyword in the OAS schema.
protected void	addBodyModelSchema(CodegenParameter codegenParameter, String name, io.swagger.v3.oas.models.media.Schema schema, Set<String> imports, String bodyParameterName, boolean forceSimpleRef) 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
void	addOperationToGroup(String tag, String resourcePath, io.swagger.v3.oas.models.Operation operation, CodegenOperation co, Map<String,List<CodegenOperation>> operations) 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
protected void	addParentContainer(CodegenModel model, String name, io.swagger.v3.oas.models.media.Schema schema) 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
String	addRegularExpressionDelimiter(String pattern) If the pattern misses the delimiter, add "/" to the beginning and end Otherwise, return the original pattern
protected void	addVarsRequiredVarsAdditionalProps(io.swagger.v3.oas.models.media.Schema schema, IJsonSchemaValidationProperties property)
String	apiDocFileFolder()
String	apiFileFolder()
String	apiFilename(String templateName, String tag)
String	apiTestFileFolder()
protected List<Map<String,Object>>	buildEnumVars(List<Object> values, String dataType)
String	defaultTemplatingEngine()
String	filenameFromRoot(List<String> pathSegments)
CodegenParameter	fromFormProperty(String name, io.swagger.v3.oas.models.media.Schema propertySchema, Set<String> imports) 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
CodegenModel	fromModel(String name, io.swagger.v3.oas.models.media.Schema sc) 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
CodegenOperation	fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, List<io.swagger.v3.oas.models.servers.Server> servers) Custom version of this method so we can move the body parameter into bodyParam
CodegenParameter	fromParameter(io.swagger.v3.oas.models.parameters.Parameter parameter, Set<String> imports) Convert OAS Parameter object to Codegen Parameter object
CodegenProperty	fromProperty(String name, io.swagger.v3.oas.models.media.Schema p, boolean required, boolean schemaIsFromAdditionalProperties) 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
CodegenParameter	fromRequestBody(io.swagger.v3.oas.models.parameters.RequestBody body, Set<String> imports, String bodyParameterName) 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
List<CodegenParameter>	fromRequestBodyToFormParameters(io.swagger.v3.oas.models.parameters.RequestBody body, Set<String> imports) 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
protected void	generateEndpoints(OperationsMap objs)
String	generatePackageName(String packageName) Generate Python package name from String `packageName`
String	generatorLanguageVersion()
String	getHelp()
protected String	getItemsName(io.swagger.v3.oas.models.media.Schema containingSchema, String containingSchemaName)
String	getModelName(io.swagger.v3.oas.models.media.Schema sc)
protected Map<String,io.swagger.v3.oas.models.media.Schema>	getModelNameToSchemaCache() Return a map from model name to Schema for efficient lookup.
String	getName() Configures a friendly name for the generator.
protected Object	getObjectExample(io.swagger.v3.oas.models.media.Schema sc) Gets an example if it exists
String	getSchemaType(io.swagger.v3.oas.models.media.Schema schema) Returns the python type for the property.
CodegenType	getTag()
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p) Output the type declaration of a given name
boolean	getUseInlineModelResolver()
protected String	handleSpecialCharacters(String value)
boolean	isDataTypeString(String dataType) checks if the data should be classified as "string" in enum e.g.
String	modelDocFileFolder()
String	modelFileFolder()
String	modelTestFileFolder()
String	packageFilename(List<String> pathSegments)
String	packagePath()
void	postProcess()
Map<String,ModelsMap>	postProcessAllModels(Map<String,ModelsMap> objs) Override with special post-processing for all models.
ModelsMap	postProcessModels(ModelsMap objs)
OperationsMap	postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels)
void	postProcessParameter(CodegenParameter p)
void	postProcessPattern(String pattern, Map<String,Object> vendorExtensions)
Map<String,Object>	postProcessSupportingFileData(Map<String,Object> objs)
void	preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
void	processOpts()
protected File	processTemplateToFile(Map<String,Object> templateData, String templateName, String outputFilename, boolean shouldGenerate, String skippedByOption)
protected Object	processTestExampleData(Object value) A method that allows generators to pre-process test example payloads This can be useful if one needs to change how values like null in string are represented
String	pythonDate(Object dateValue)
String	pythonDateTime(Object dateTimeValue)
String	sanitizeTag(String tag) Note: a custom version of this function is used so the original tag value can be used
protected void	setAddProps(io.swagger.v3.oas.models.media.Schema schema, IJsonSchemaValidationProperties property) Use cases: additional properties is unset: do nothing additional properties is true: add definition to property additional properties is false: add definition to property additional properties is schema: add definition to property
void	setPackageUrl(String packageUrl)
void	setParameterExampleValue(CodegenParameter codegenParameter, io.swagger.v3.oas.models.parameters.Parameter parameter) Set the codegenParameter example value We have a custom version of this function so we can invoke toExampleValue
void	setParameterExampleValue(CodegenParameter codegenParameter, io.swagger.v3.oas.models.parameters.RequestBody requestBody) Return the example value of the parameter.
void	setUseInlineModelResolver(String val)
void	setUseNose(String val)
String	toApiDocFilename(String name) Return the file name of the Api Documentation
String	toApiName(String name) Output the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is empty
String	toDefaultValue(io.swagger.v3.oas.models.media.Schema p) Return the default value of the property
String	toEnumVarName(String value, String datatype) Return the sanitized variable name for enum
String	toExampleValue(io.swagger.v3.oas.models.media.Schema schema) Return the example value of the property
String	toExampleValue(io.swagger.v3.oas.models.media.Schema schema, Object objExample)
String	toInstantiationType(io.swagger.v3.oas.models.media.Schema property) Return the instantiation type of the property, especially for map and array
String	toModelDocFilename(String name) Return the capitalized file name of the model documentation
String	toModelImport(String name) Return the fully-qualified "Model" name for import
String	toRegularExpression(String pattern) Return the regular expression/JSON schema pattern (http://json-schema.org/latest/json-schema-validation.html#anchor33)
protected String	toTestCaseName(String specTestCaseName)
io.swagger.v3.oas.models.media.Schema	unaliasSchema(io.swagger.v3.oas.models.media.Schema schema)
void	updateCodegenPropertyEnum(CodegenProperty var) Update codegen property's enum by adding "enumVars" (with name and value)
protected void	updateModelForAnyType(CodegenModel m, io.swagger.v3.oas.models.media.Schema schema)
protected void	updateModelForComposedSchema(CodegenModel m, io.swagger.v3.oas.models.media.Schema schema, Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions)
protected void	updateModelForInteger(CodegenModel model, io.swagger.v3.oas.models.media.Schema schema)
protected void	updateModelForNumber(CodegenModel model, io.swagger.v3.oas.models.media.Schema schema)
protected void	updateModelForObject(CodegenModel m, io.swagger.v3.oas.models.media.Schema schema)
protected void	updateModelForString(CodegenModel model, io.swagger.v3.oas.models.media.Schema schema) Sets the booleans that define the model's type
protected void	updatePropertyForAnyType(CodegenProperty property, io.swagger.v3.oas.models.media.Schema p)
protected void	updatePropertyForArray(CodegenProperty property, CodegenProperty innerProperty) Update property for array(list) container
protected void	updatePropertyForInteger(CodegenProperty property, io.swagger.v3.oas.models.media.Schema p)
protected void	updatePropertyForNumber(CodegenProperty property, io.swagger.v3.oas.models.media.Schema p)
protected void	updatePropertyForObject(CodegenProperty property, io.swagger.v3.oas.models.media.Schema p)
protected void	updatePropertyForString(CodegenProperty property, io.swagger.v3.oas.models.media.Schema p)

Methods inherited from class org.openapitools.codegen.languages.AbstractPythonCodegen

dropDots, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, generatorLanguage, patternCorrection, postProcessFile, setPackageName, setPackageVersion, setParameterExampleValue, setProjectName, toApiFilename, toApiTestFilename, toApiVarName, toModelFilename, toModelName, toModelTestFilename, toOperationId, toParamName, toVarName

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addHeaders, addImport, addImport, addImport, addImports, addImports, addImports, addImportsForPropertyType, addImportsToOneOfInterface, additionalProperties, addMustacheLambdas, addOneOfInterfaceModel, addOneOfNameExtension, addOption, addProperties, addRequiredVarsMap, addSwitch, addVars, addVars, apiDocFilename, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, createDiscriminator, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromProperty, fromProperty, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAdditionalProperties, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, getAlias, getAllModels, getAllOfDescendants, getAllowUnicodeIdentifiers, getApiNamePrefix, getApiNameSuffix, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDocExtension, getEnsureUniqueParams, getEnumDefaultValue, getEnumUnknownDefaultCase, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLegacyDiscriminatorBehavior, getLibrary, getModelNamePrefix, getModelNameSuffix, getMostInnerItems, getOneOfAnyOfDescendants, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getRemoveOperationIdPrefixCount, getRemoveOperationIdPrefixDelimiter, getSchemaAdditionalProperties, getSchemaFromBooleanOrSchema, getSchemaItems, getSingleSchemaType, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSupportedVendorExtensions, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseOneOfInterfaces, getUseOpenAPINormalizer, getVersionMetadataFilename, handleMethodResponse, handleMethodResponse, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameDefault, inlineSchemaNameMapping, instantiationTypes, isAnyTypeSchema, isDataTypeBinary, isDataTypeFile, isEnableMinimalUpdate, isEnablePostProcessFile, isFreeFormObject, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isReservedWord, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, lowerCamelCase, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestTemplateFiles, modifyFeatureSet, needToImport, openapiNormalizer, outputFolder, postProcessModelProperty, postProcessModelsEnum, processCompiler, processOpenAPI, processTemplatingEngine, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, schemaMapping, serverVariableOverrides, setAllowUnicodeIdentifiers, setApiNamePrefix, setApiNameSuffix, setApiPackage, setCircularReferences, setDisallowAdditionalPropertiesIfNotPresent, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setEnumUnknownDefaultCase, setFilesMetadataFilename, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLegacyDiscriminatorBehavior, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterEncodingValues, setParameterNullable, setPrependFormOrBodyParameters, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setRemoveOperationIdPrefixCount, setRemoveOperationIdPrefixDelimiter, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, setUseOneOfInterfaces, setVersionMetadataFilename, shouldAddImport, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toAllOfName, toAnyOfName, toApiImport, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toExamples, toGetter, toMediaTypeSchemaName, toModelImportMap, toOneOfName, toSetter, typeMapping, unaliasPropertySchema, updateAllModels, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateOption, updateParameterForString, updatePropertyForMap, updatePropertyForMap, updateRequestBodyForArray, updateRequestBodyForMap, updateRequestBodyForObject, updateRequestBodyForPrimitiveType, updateRequestBodyForString, vendorExtensions, writePropertyBack

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openapitools.codegen.CodegenConfig

additionalProperties, apiDocFilename, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getSupportedVendorExtensions, getTemplatingEngine, getTypeDeclaration, getUseOpenAPINormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameDefault, inlineSchemaNameMapping, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openapiNormalizer, outputFolder, postProcessModelProperty, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, schemaMapping, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOperationExample, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toBooleanGetter, toGetter, toModelImportMap, toSetter, typeMapping, updateAllModels, vendorExtensions

Field Detail

PACKAGE_URL

public static final String PACKAGE_URL

See Also:

Constant Field Values

DEFAULT_LIBRARY

public static final String DEFAULT_LIBRARY

See Also:

Constant Field Values

USE_NOSE

public static final String USE_NOSE

See Also:

Constant Field Values

RECURSION_LIMIT

public static final String RECURSION_LIMIT

See Also:

Constant Field Values

USE_INLINE_MODEL_RESOLVER

public static final String USE_INLINE_MODEL_RESOLVER

See Also:

Constant Field Values

packageUrl

protected String packageUrl

apiDocPath

protected String apiDocPath

modelDocPath

protected String modelDocPath

useNose

protected boolean useNose

useInlineModelResolver

protected boolean useInlineModelResolver

regexModifiers

protected Map<Character,String> regexModifiers

ignoreProcessor

protected CodegenIgnoreProcessor ignoreProcessor

templateProcessor

protected TemplateProcessor templateProcessor

Constructor Detail

PythonClientCodegen

public PythonClientCodegen()

Method Detail

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class AbstractPythonCodegen

packageFilename

public String packageFilename(List<String> pathSegments)

filenameFromRoot

public String filenameFromRoot(List<String> pathSegments)

processTemplateToFile

protected File processTemplateToFile(Map<String,Object> templateData,
                                     String templateName,
                                     String outputFilename,
                                     boolean shouldGenerate,
                                     String skippedByOption)
                              throws IOException

Throws:

IOException

apiFilename

public String apiFilename(String templateName,
                          String tag)

Specified by:

apiFilename in interface CodegenConfig

Overrides:

apiFilename in class DefaultCodegen

toApiName

public String toApiName(String name)

Description copied from class: DefaultCodegen

Output the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is empty

Specified by:

toApiName in interface CodegenConfig

Overrides:

toApiName in class AbstractPythonCodegen

Parameters:

name - the name of the Api

Returns:

capitalized Api name

generateEndpoints

protected void generateEndpoints(OperationsMap objs)

addVarsRequiredVarsAdditionalProps

protected void addVarsRequiredVarsAdditionalProps(io.swagger.v3.oas.models.media.Schema schema,
                                                  IJsonSchemaValidationProperties property)

Overrides:

addVarsRequiredVarsAdditionalProps in class DefaultCodegen

getName

public String getName()

Configures a friendly name for the generator. This will be used by the generator to select the library with the -g flag.

Specified by:

getName in interface CodegenConfig

Overrides:

getName in class DefaultCodegen

Returns:

the friendly name for the generator

getHelp

public String getHelp()

Specified by:

getHelp in interface CodegenConfig

Overrides:

getHelp in class DefaultCodegen

unaliasSchema

public io.swagger.v3.oas.models.media.Schema unaliasSchema(io.swagger.v3.oas.models.media.Schema schema)

Specified by:

unaliasSchema in interface CodegenConfig

Overrides:

unaliasSchema in class DefaultCodegen

pythonDate

public String pythonDate(Object dateValue)

pythonDateTime

public String pythonDateTime(Object dateTimeValue)

toDefaultValue

public String toDefaultValue(io.swagger.v3.oas.models.media.Schema p)

Return the default value of the property

Overrides:

toDefaultValue in class AbstractPythonCodegen

Parameters:

p - OpenAPI property object

Returns:

string presentation of the default value of the property

toModelImport

public String toModelImport(String name)

Description copied from class: DefaultCodegen

Return the fully-qualified "Model" name for import

Specified by:

toModelImport in interface CodegenConfig

Overrides:

toModelImport in class DefaultCodegen

Parameters:

name - the name of the "Model"

Returns:

the fully-qualified "Model" name for import

postProcessOperationsWithModels

public OperationsMap postProcessOperationsWithModels(OperationsMap objs,
                                                     List<ModelMap> allModels)

Specified by:

postProcessOperationsWithModels in interface CodegenConfig

Overrides:

postProcessOperationsWithModels in class DefaultCodegen

postProcessAllModels

public Map<String,ModelsMap> postProcessAllModels(Map<String,ModelsMap> 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

Specified by:

postProcessAllModels in interface CodegenConfig

Overrides:

postProcessAllModels in class DefaultCodegen

Parameters:

objs - a map going from the model name to a object holding the model info

Returns:

the updated objs

fromParameter

public CodegenParameter fromParameter(io.swagger.v3.oas.models.parameters.Parameter parameter,
                                      Set<String> imports)

Description copied from class: DefaultCodegen

Convert OAS Parameter object to Codegen Parameter object

Overrides:

fromParameter in class DefaultCodegen

Parameters:

parameter - OAS parameter object

imports - set of imports for library/package/module

Returns:

Codegen Parameter object

fromProperty

public CodegenProperty fromProperty(String name,
                                    io.swagger.v3.oas.models.media.Schema p,
                                    boolean required,
                                    boolean schemaIsFromAdditionalProperties)

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

Overrides:

fromProperty in class DefaultCodegen

Parameters:

name - name of the property

p - OAS property schema

required - true if the property is required in the next higher object schema, false otherwise

schemaIsFromAdditionalProperties - true if the property is defined by additional properties schema

Returns:

Codegen Property object

isDataTypeString

public boolean isDataTypeString(String dataType)

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"

Overrides:

isDataTypeString in class DefaultCodegen

Parameters:

dataType - data type

Returns:

true if it's a enum string

getItemsName

protected String getItemsName(io.swagger.v3.oas.models.media.Schema containingSchema,
                              String containingSchemaName)

Overrides:

getItemsName in class DefaultCodegen

updateCodegenPropertyEnum

public void updateCodegenPropertyEnum(CodegenProperty var)

Update codegen property's enum by adding "enumVars" (with name and value)

Overrides:

updateCodegenPropertyEnum in class DefaultCodegen

Parameters:

var - list of CodegenProperty

fromRequestBody

public CodegenParameter fromRequestBody(io.swagger.v3.oas.models.parameters.RequestBody body,
                                        Set<String> imports,
                                        String bodyParameterName)

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

Overrides:

fromRequestBody in class DefaultCodegen

Parameters:

body - request body

imports - import collection

bodyParameterName - body parameter name

Returns:

the resultant CodegenParameter

addBodyModelSchema

protected void addBodyModelSchema(CodegenParameter codegenParameter,
                                  String name,
                                  io.swagger.v3.oas.models.media.Schema schema,
                                  Set<String> imports,
                                  String bodyParameterName,
                                  boolean forceSimpleRef)

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

Overrides:

addBodyModelSchema in class DefaultCodegen

Parameters:

codegenParameter - the body parameter

name - model schema ref key in components

schema - the model schema (not refed)

imports - collection of imports

bodyParameterName - body parameter name

forceSimpleRef - if true use a model reference

toEnumVarName

public String toEnumVarName(String value,
                            String datatype)

Return the sanitized variable name for enum

Overrides:

toEnumVarName in class DefaultCodegen

Parameters:

value - enum variable name

datatype - data type

Returns:

the sanitized variable name for enum

buildEnumVars

protected List<Map<String,Object>> buildEnumVars(List<Object> values,
                                                 String dataType)

Overrides:

buildEnumVars in class DefaultCodegen

postProcessParameter

public void postProcessParameter(CodegenParameter p)

Specified by:

postProcessParameter in interface CodegenConfig

Overrides:

postProcessParameter in class DefaultCodegen

addParentContainer

protected void addParentContainer(CodegenModel model,
                                  String name,
                                  io.swagger.v3.oas.models.media.Schema schema)

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

Overrides:

addParentContainer in class DefaultCodegen

Parameters:

model - the codegen representation of the OAS schema.

name - the name of the model.

schema - the input OAS schema.

toTestCaseName

protected String toTestCaseName(String specTestCaseName)

Overrides:

toTestCaseName in class DefaultCodegen

handleSpecialCharacters

protected String handleSpecialCharacters(String value)

Overrides:

handleSpecialCharacters in class DefaultCodegen

processTestExampleData

protected Object processTestExampleData(Object value)

Description copied from class: DefaultCodegen

A method that allows generators to pre-process test example payloads This can be useful if one needs to change how values like null in string are represented

Overrides:

processTestExampleData in class DefaultCodegen

Parameters:

value - the test data payload

Returns:

the updated test data payload

fromModel

public CodegenModel fromModel(String name,
                              io.swagger.v3.oas.models.media.Schema sc)

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

Specified by:

fromModel in interface CodegenConfig

Overrides:

fromModel in class DefaultCodegen

Parameters:

name - the name of the model

sc - OAS Model object

Returns:

Codegen Model object

getSchemaType

public String getSchemaType(io.swagger.v3.oas.models.media.Schema schema)

Returns the python type for the property.

Overrides:

getSchemaType in class AbstractPythonCodegen

Parameters:

schema - property schema

Returns:

string presentation of the type

getModelName

public String getModelName(io.swagger.v3.oas.models.media.Schema sc)

getTypeDeclaration

public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)

Output the type declaration of a given name

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class DefaultCodegen

Parameters:

p - property schema

Returns:

a string presentation of the type

toInstantiationType

public String toInstantiationType(io.swagger.v3.oas.models.media.Schema property)

Description copied from class: DefaultCodegen

Return the instantiation type of the property, especially for map and array

Overrides:

toInstantiationType in class DefaultCodegen

Parameters:

property - property schema

Returns:

string presentation of the instantiation type of the property

addAdditionPropertiesToCodeGenModel

protected void addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel,
                                                   io.swagger.v3.oas.models.media.Schema schema)

Description copied from class: DefaultCodegen

Handle the model for the 'additionalProperties' keyword in the OAS schema.

Overrides:

addAdditionPropertiesToCodeGenModel in class DefaultCodegen

Parameters:

codegenModel - The codegen representation of the schema.

schema - The input OAS schema.

getObjectExample

protected Object getObjectExample(io.swagger.v3.oas.models.media.Schema sc)

Gets an example if it exists

Parameters:

sc - input schema

Returns:

the example value

toExampleValue

public String toExampleValue(io.swagger.v3.oas.models.media.Schema schema)

Description copied from class: DefaultCodegen

Return the example value of the property

Overrides:

toExampleValue in class AbstractPythonCodegen

Parameters:

schema - Property schema

Returns:

string presentation of the example value of the property

toExampleValue

public String toExampleValue(io.swagger.v3.oas.models.media.Schema schema,
                             Object objExample)

setParameterExampleValue

public void setParameterExampleValue(CodegenParameter codegenParameter,
                                     io.swagger.v3.oas.models.parameters.Parameter parameter)

Set the codegenParameter example value We have a custom version of this function so we can invoke toExampleValue

Overrides:

setParameterExampleValue in class AbstractPythonCodegen

Parameters:

codegenParameter - the item we are setting the example on

parameter - the base parameter that came from the spec

setParameterExampleValue

public void setParameterExampleValue(CodegenParameter codegenParameter,
                                     io.swagger.v3.oas.models.parameters.RequestBody requestBody)

Return the example value of the parameter.

Overrides:

setParameterExampleValue in class DefaultCodegen

Parameters:

codegenParameter - Codegen parameter

requestBody - Request body

fromFormProperty

public CodegenParameter fromFormProperty(String name,
                                         io.swagger.v3.oas.models.media.Schema propertySchema,
                                         Set<String> imports)

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

Overrides:

fromFormProperty in class DefaultCodegen

Parameters:

name - the property name

propertySchema - the property schema

imports - our import set

Returns:

the resultant CodegenParameter

getModelNameToSchemaCache

protected Map<String,io.swagger.v3.oas.models.media.Schema> getModelNameToSchemaCache()

Return a map from model name to Schema for efficient lookup.

Overrides:

getModelNameToSchemaCache in class DefaultCodegen

Returns:

map from model name to Schema.

setAddProps

protected void setAddProps(io.swagger.v3.oas.models.media.Schema schema,
                           IJsonSchemaValidationProperties property)

Use cases: additional properties is unset: do nothing additional properties is true: add definition to property additional properties is false: add definition to property additional properties is schema: add definition to property

Overrides:

setAddProps in class DefaultCodegen

Parameters:

schema - the schema that may contain an additional property schema

property - the property for the above schema

updatePropertyForArray

protected void updatePropertyForArray(CodegenProperty property,
                                      CodegenProperty innerProperty)

Update property for array(list) container

Overrides:

updatePropertyForArray in class DefaultCodegen

Parameters:

property - Codegen property

innerProperty - Codegen inner property of map or list

updateModelForString

protected void updateModelForString(CodegenModel model,
                                    io.swagger.v3.oas.models.media.Schema schema)

Sets the booleans that define the model's type

Overrides:

updateModelForString in class DefaultCodegen

Parameters:

model - the model to update

schema - the model's schema

updateModelForNumber

protected void updateModelForNumber(CodegenModel model,
                                    io.swagger.v3.oas.models.media.Schema schema)

Overrides:

updateModelForNumber in class DefaultCodegen

updateModelForInteger

protected void updateModelForInteger(CodegenModel model,
                                     io.swagger.v3.oas.models.media.Schema schema)

Overrides:

updateModelForInteger in class DefaultCodegen

updatePropertyForString

protected void updatePropertyForString(CodegenProperty property,
                                       io.swagger.v3.oas.models.media.Schema p)

Overrides:

updatePropertyForString in class DefaultCodegen

toRegularExpression

public String toRegularExpression(String pattern)

Description copied from class: DefaultCodegen

Return the regular expression/JSON schema pattern (http://json-schema.org/latest/json-schema-validation.html#anchor33)

Overrides:

toRegularExpression in class AbstractPythonCodegen

Parameters:

pattern - the pattern (regular expression)

Returns:

properly-escaped pattern

updatePropertyForNumber

protected void updatePropertyForNumber(CodegenProperty property,
                                       io.swagger.v3.oas.models.media.Schema p)

Overrides:

updatePropertyForNumber in class DefaultCodegen

updatePropertyForInteger

protected void updatePropertyForInteger(CodegenProperty property,
                                        io.swagger.v3.oas.models.media.Schema p)

Overrides:

updatePropertyForInteger in class DefaultCodegen

updatePropertyForObject

protected void updatePropertyForObject(CodegenProperty property,
                                       io.swagger.v3.oas.models.media.Schema p)

Overrides:

updatePropertyForObject in class DefaultCodegen

updatePropertyForAnyType

protected void updatePropertyForAnyType(CodegenProperty property,
                                        io.swagger.v3.oas.models.media.Schema p)

Overrides:

updatePropertyForAnyType in class DefaultCodegen

updateModelForObject

protected void updateModelForObject(CodegenModel m,
                                    io.swagger.v3.oas.models.media.Schema schema)

Overrides:

updateModelForObject in class DefaultCodegen

updateModelForAnyType

protected void updateModelForAnyType(CodegenModel m,
                                     io.swagger.v3.oas.models.media.Schema schema)

Overrides:

updateModelForAnyType in class DefaultCodegen

updateModelForComposedSchema

protected void updateModelForComposedSchema(CodegenModel m,
                                            io.swagger.v3.oas.models.media.Schema schema,
                                            Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions)

Overrides:

updateModelForComposedSchema in class DefaultCodegen

postProcessModels

public ModelsMap postProcessModels(ModelsMap objs)

Specified by:

postProcessModels in interface CodegenConfig

Overrides:

postProcessModels in class DefaultCodegen

postProcessPattern

public void postProcessPattern(String pattern,
                               Map<String,Object> vendorExtensions)

getTag

public CodegenType getTag()

Specified by:

getTag in interface CodegenConfig

Overrides:

getTag in class DefaultCodegen

apiDocFileFolder

public String apiDocFileFolder()

Specified by:

apiDocFileFolder in interface CodegenConfig

Overrides:

apiDocFileFolder in class DefaultCodegen

modelDocFileFolder

public String modelDocFileFolder()

Specified by:

modelDocFileFolder in interface CodegenConfig

Overrides:

modelDocFileFolder in class DefaultCodegen

toModelDocFilename

public String toModelDocFilename(String name)

Description copied from class: DefaultCodegen

Return the capitalized file name of the model documentation

Specified by:

toModelDocFilename in interface CodegenConfig

Overrides:

toModelDocFilename in class DefaultCodegen

Parameters:

name - the model name

Returns:

the file name of the model

toApiDocFilename

public String toApiDocFilename(String name)

Description copied from class: DefaultCodegen

Return the file name of the Api Documentation

Specified by:

toApiDocFilename in interface CodegenConfig

Overrides:

toApiDocFilename in class DefaultCodegen

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

addRegularExpressionDelimiter

public String addRegularExpressionDelimiter(String pattern)

Description copied from class: DefaultCodegen

If the pattern misses the delimiter, add "/" to the beginning and end Otherwise, return the original pattern

Overrides:

addRegularExpressionDelimiter in class DefaultCodegen

Parameters:

pattern - the pattern (regular expression)

Returns:

the pattern with delimiter

apiFileFolder

public String apiFileFolder()

Specified by:

apiFileFolder in interface CodegenConfig

Overrides:

apiFileFolder in class DefaultCodegen

modelFileFolder

public String modelFileFolder()

Specified by:

modelFileFolder in interface CodegenConfig

Overrides:

modelFileFolder in class DefaultCodegen

apiTestFileFolder

public String apiTestFileFolder()

Specified by:

apiTestFileFolder in interface CodegenConfig

Overrides:

apiTestFileFolder in class DefaultCodegen

modelTestFileFolder

public String modelTestFileFolder()

Specified by:

modelTestFileFolder in interface CodegenConfig

Overrides:

modelTestFileFolder in class DefaultCodegen

setUseNose

public void setUseNose(String val)

getUseInlineModelResolver

public boolean getUseInlineModelResolver()

Specified by:

getUseInlineModelResolver in interface CodegenConfig

Overrides:

getUseInlineModelResolver in class DefaultCodegen

setUseInlineModelResolver

public void setUseInlineModelResolver(String val)

setPackageUrl

public void setPackageUrl(String packageUrl)

packagePath

public String packagePath()

generatePackageName

public String generatePackageName(String packageName)

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.

Parameters:

packageName - Package name

Returns:

Python package name that conforms to PEP 0008

fromRequestBodyToFormParameters

public List<CodegenParameter> fromRequestBodyToFormParameters(io.swagger.v3.oas.models.parameters.RequestBody body,
                                                              Set<String> imports)

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

Overrides:

fromRequestBodyToFormParameters in class DefaultCodegen

Parameters:

body - the body that is being handled

imports - the imports for this body

Returns:

the list of length one containing a single type object CodegenParameter

fromOperation

public CodegenOperation fromOperation(String path,
                                      String httpMethod,
                                      io.swagger.v3.oas.models.Operation operation,
                                      List<io.swagger.v3.oas.models.servers.Server> servers)

Custom version of this method so we can move the body parameter into bodyParam

Specified by:

fromOperation in interface CodegenConfig

Overrides:

fromOperation in class DefaultCodegen

Parameters:

path - the path of the operation

httpMethod - HTTP method

operation - OAS operation object

servers - list of servers

Returns:

the resultant CodegenOperation instance

addOperationToGroup

public void addOperationToGroup(String tag,
                                String resourcePath,
                                io.swagger.v3.oas.models.Operation operation,
                                CodegenOperation co,
                                Map<String,List<CodegenOperation>> operations)

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

Specified by:

addOperationToGroup in interface CodegenConfig

Overrides:

addOperationToGroup in class DefaultCodegen

Parameters:

tag - name of the tag

resourcePath - path of the resource

operation - OAS Operation object

co - Codegen Operation object

operations - map of Codegen operations

defaultTemplatingEngine

public String defaultTemplatingEngine()

Specified by:

defaultTemplatingEngine in interface CodegenConfig

Overrides:

defaultTemplatingEngine in class DefaultCodegen

generatorLanguageVersion

public String generatorLanguageVersion()

Specified by:

generatorLanguageVersion in interface CodegenConfig

Overrides:

generatorLanguageVersion in class DefaultCodegen

preprocessOpenAPI

public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)

Specified by:

preprocessOpenAPI in interface CodegenConfig

Overrides:

preprocessOpenAPI in class DefaultCodegen

sanitizeTag

public String sanitizeTag(String tag)

Note: a custom version of this function is used so the original tag value can be used

Specified by:

sanitizeTag in interface CodegenConfig

Overrides:

sanitizeTag in class AbstractPythonCodegen

Parameters:

tag - Tag

Returns:

the tag to use

postProcessSupportingFileData

public Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)

Specified by:

postProcessSupportingFileData in interface CodegenConfig

Overrides:

postProcessSupportingFileData in class DefaultCodegen

postProcess

public void postProcess()

Specified by:

postProcess in interface CodegenConfig

Overrides:

postProcess in class DefaultCodegen