org.openapitools.codegen.languages

Class PythonClientCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.PythonLegacyClientCodegen

org.openapitools.codegen.languages.PythonClientCodegen

All Implemented Interfaces:

CodegenConfig

public class PythonClientCodegen
extends PythonLegacyClientCodegen

Field Summary

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

apiDocPath, DEFAULT_LIBRARY, modelDocPath, PACKAGE_URL, packageName, packageUrl, packageVersion, projectName, RECURSION_LIMIT, regexModifiers, USE_NOSE, useNose

Fields inherited from class org.openapitools.codegen.DefaultCodegen

additionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, DefaultFeatureSet, defaultIncludes, disallowAdditionalPropertiesIfNotPresent, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, JSON_MIME_PATTERN, JSON_VENDOR_MIME_PATTERN, languageSpecificPrimitives, legacyDiscriminatorBehavior, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, prependFormOrBodyParameters, releaseNote, removeEnumValuePrefix, removeOperationIdPrefix, reservedWords, reservedWordsMappings, serverVariables, skipOverwrite, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsAdditionalPropertiesWithComposedSchema, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, testPackage, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions

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
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
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
CodegenProperty	fromProperty(String name, io.swagger.v3.oas.models.media.Schema p) 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
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.
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p) Output the type declaration of a given name
Map<String,Object>	postProcessAllModels(Map<String,Object> objs) Override with special post-processing for all models.
void	postProcessModelProperty(CodegenModel model, CodegenProperty p)
Map<String,Object>	postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
void	postProcessParameter(CodegenParameter p)
void	processOpts()
String	pythonDate(Object dateValue)
String	pythonDateTime(Object dateTimeValue)
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.
String	toDefaultValue(io.swagger.v3.oas.models.media.Schema p) Return the default value of the property
String	toEnumValue(String value, String datatype) Return the enum value in the language specified format e.g.
String	toEnumVarName(String value, String datatype) Return the sanitized variable name for enum
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	toModelImport(String name) Return the fully-qualified "Model" name for import
io.swagger.v3.oas.models.media.Schema	unaliasSchema(io.swagger.v3.oas.models.media.Schema schema, Map<String,String> usedImportMappings)
void	updateCodegenPropertyEnum(CodegenProperty var) Update codegen property's enum by adding "enumVars" (with name and value)

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

addRegularExpressionDelimiter, apiDocFileFolder, apiFileFolder, apiTestFileFolder, dropDots, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, generatePackageName, getHelp, getTag, modelDocFileFolder, modelFileFolder, modelTestFileFolder, packagePath, patternCorrection, postProcessFile, postProcessModels, postProcessPattern, sanitizeTag, setPackageName, setPackageUrl, setPackageVersion, setParameterExampleValue, setProjectName, setUseNose, toApiDocFilename, toApiFilename, toApiName, toApiTestFilename, toApiVarName, toExampleValue, toModelDocFilename, toModelFilename, toModelName, toModelTestFilename, toOperationId, toParamName, toRegularExpression, toVarName

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addHeaders, addImport, addImportsToOneOfInterface, additionalProperties, addMustacheLambdas, addOneOfInterfaceModel, addOneOfNameExtension, addOperationToGroup, addOption, addProperties, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, createDiscriminator, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromOperation, fromParameter, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAdditionalProperties, getAlias, getAllModels, getAllOfDescendants, getAllowUnicodeIdentifiers, getApiNamePrefix, getApiNameSuffix, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDocExtension, getEnsureUniqueParams, getFeatureSet, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLegacyDiscriminatorBehavior, getLibrary, getModelNamePrefix, getModelNameSuffix, getMostInnerItems, getOneOfAnyOfDescendants, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getSchemaAdditionalProperties, getSchemaItems, getSingleSchemaType, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseOneOfInterfaces, handleMethodResponse, handleMethodResponse, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, instantiationTypes, isAnyTypeSchema, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isFreeFormObject, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, lowerCamelCase, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestTemplateFiles, modifyFeatureSet, needToImport, outputFolder, postProcess, postProcessModelsEnum, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, processTemplatingEngine, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, serverVariableOverrides, setAllowUnicodeIdentifiers, setApiNamePrefix, setApiNameSuffix, setApiPackage, setCircularReferences, setDisallowAdditionalPropertiesIfNotPresent, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLegacyDiscriminatorBehavior, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterContentType, setParameterNullable, setPrependFormOrBodyParameters, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, setUseOneOfInterfaces, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toAllOfName, toAnyOfName, toApiImport, toArrayModelParamName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toExamples, toGetter, toModelImportMap, toOneOfName, toSetter, typeMapping, updateAllModels, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateOption, updatePropertyForArray, updatePropertyForMap, 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, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getDocExtension, getFeatureSet, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTemplatingEngine, getTypeDeclaration, importMapping, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcess, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toBooleanGetter, toGetter, toModelImportMap, toSetter, typeMapping, updateAllModels, vendorExtensions

Constructor Detail

PythonClientCodegen

public PythonClientCodegen()

Method Detail

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class PythonLegacyClientCodegen

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 PythonLegacyClientCodegen

Returns:

the friendly name for the generator

unaliasSchema

public io.swagger.v3.oas.models.media.Schema unaliasSchema(io.swagger.v3.oas.models.media.Schema schema,
                                                           Map<String,String> usedImportMappings)

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 PythonLegacyClientCodegen

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 PythonLegacyClientCodegen

Parameters:

name - the name of the "Model"

Returns:

the fully-qualified "Model" name for import

postProcessOperationsWithModels

public Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs,
                                                          List<Object> allModels)

Specified by:

postProcessOperationsWithModels in interface CodegenConfig

Overrides:

postProcessOperationsWithModels in class DefaultCodegen

postProcessAllModels

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

Specified by:

postProcessAllModels in interface CodegenConfig

Overrides:

postProcessAllModels in class DefaultCodegen

Parameters:

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

Returns:

the updated objs

fromProperty

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

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 object

Returns:

Codegen Property object

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 - requesst 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

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

toEnumValue

public String toEnumValue(String value,
                          String datatype)

Return the enum value in the language specified format e.g. status becomes "status"

Overrides:

toEnumValue in class DefaultCodegen

Parameters:

value - enum variable name

datatype - data type

Returns:

the sanitized value for enum

postProcessModelProperty

public void postProcessModelProperty(CodegenModel model,
                                     CodegenProperty p)

Specified by:

postProcessModelProperty in interface CodegenConfig

Overrides:

postProcessModelProperty in class PythonLegacyClientCodegen

postProcessParameter

public void postProcessParameter(CodegenParameter p)

Specified by:

postProcessParameter in interface CodegenConfig

Overrides:

postProcessParameter in class PythonLegacyClientCodegen

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.

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 PythonLegacyClientCodegen

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 PythonLegacyClientCodegen

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,
                             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 PythonLegacyClientCodegen

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.