Package io.swagger.codegen.v3.generators.python

Class PythonClientCodegen

java.lang.Object

io.swagger.codegen.v3.generators.DefaultCodegenConfig

io.swagger.codegen.v3.generators.python.PythonClientCodegen

All Implemented Interfaces:

io.swagger.codegen.v3.CodegenConfig

public class PythonClientCodegen
extends DefaultCodegenConfig

Field Summary

Fields

Modifier and Type	Field	Description
protected String	apiDocPath
static final String	DEFAULT_LIBRARY
protected String	modelDocPath
static final String	PACKAGE_URL
protected String	packageName
protected String	packageUrl
protected String	packageVersion
protected String	projectName
protected Map<Character,String>	regexModifiers

Fields inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, configFiles, customTemplateDir, DEFAULT_CONTENT_TYPE, DEFAULT_TEMPLATE_DIR, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoBaseURL, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, inputURL, instantiationTypes, IS_NULLABLE_FALSE, IS_NULLABLE_TRUE, languageArguments, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, releaseNote, removeOperationIdPrefix, REQUEST_BODY_NAME, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, templateEngine, templateVersion, testPackage, typeAliases, typeMapping, unflattenedOpenAPI, useOas2, vendorExtensions

Constructor Summary

Constructors

Constructor	Description
PythonClientCodegen()

Method Summary

Modifier and Type	Method	Description
String	apiDocFileFolder()
String	apiFileFolder()
String	apiTestFileFolder()
String	escapeQuotationMark(String input)	Escape single and/or double quote to avoid code injection
String	escapeReservedWord(String name)	Return the escaped name of the reserved word
String	escapeUnsafeCharacters(String input)	override with any special text escaping logic to handle unsafe characters so as to avoid code injection
io.swagger.codegen.v3.CodegenModel	fromModel(String name, io.swagger.v3.oas.models.media.Schema schema, Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions)	Convert Swagger Model object to Codegen Model object
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.
String	getDefaultTemplateDir()
String	getHelp()
String	getName()
String	getSchemaType(io.swagger.v3.oas.models.media.Schema schema)	returns the swagger type for the property
io.swagger.codegen.v3.CodegenType	getTag()
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema schema)	Output the type declaration of the property
String	modelDocFileFolder()
String	modelFileFolder()
String	modelTestFileFolder()
void	postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model, io.swagger.codegen.v3.CodegenProperty property)
Map<String,Object>	postProcessModels(Map<String,Object> objs)
void	postProcessParameter(io.swagger.codegen.v3.CodegenParameter parameter)
void	postProcessPattern(String pattern, Map<String,Object> vendorExtensions)
void	processOpts()
String	sanitizeTag(String tag)	Sanitize tag
void	setPackageName(String packageName)
void	setPackageUrl(String packageUrl)
void	setPackageVersion(String packageVersion)
void	setParameterExampleValue(io.swagger.codegen.v3.CodegenParameter p)	Return the example value of the parameter.
void	setProjectName(String projectName)
String	toApiDocFilename(String name)	Return the file name of the Api Documentation
String	toApiFilename(String name)	Return the file name of the Api Test
String	toApiImport(String name)	Return the fully-qualified "Api" name for import
String	toApiName(String name)	Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
String	toApiTestFilename(String name)	Return the file name of the Api Test
String	toApiVarName(String name)	Return the variable name in the Api
String	toDefaultValue(io.swagger.v3.oas.models.media.Schema propertySchema)	Return the default value of the property
String	toInstantiationType(io.swagger.v3.oas.models.media.Schema schema)	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	toModelFilename(String name)	Return the capitalized file name of the model
String	toModelImport(String name)	Return the fully-qualified "Model" name for import
String	toModelName(String name)	Output the proper model name (capitalized).
String	toModelTestFilename(String name)	Return the capitalized file name of the model test
String	toOperationId(String operationId)	Return the operation ID (method name)
String	toParamName(String name)	Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.
String	toVarName(String name)	Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

Methods inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

addAdditionPropertiesToCodeGenModel, addCodegenContentParameters, addConsumesInfo, addHandlebarHelpers, addImport, additionalProperties, addOperationImports, addOperationToGroup, addOption, addOption, addParameters, addParentContainer, addProducesInfo, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configFiles, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, copyFirstAllOfProperties, customTemplateDir, dashize, defaultIgnoreImportMappingOption, defaultIncludes, detectParent, embeddedTemplateDir, ensureUniqueParameters, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fixUpParentAndInterfaces, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getAlias, getArgumentsLocation, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getGitRepoBaseURL, getGitRepoId, getGitUserId, getHideGenerationTimestamp, getHttpUserAgent, getIgnoreFilePathOverride, getIgnoreImportMapping, getInnerEnumAllowableValues, getInputSpec, getInputURL, getLanguageArguments, getLibrary, getOpenAPI, getOptionValue, getOrGenerateOperationId, getOutputDir, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSchemaFromBody, getSchemaFromParameter, getSchemaFromResponse, getSchemaHandler, getSortParamsByRequiredFlag, getSymbolName, getTemplateDir, getTemplateEngine, getTemplateVersion, getterAndSetterCapitalize, getTypeDeclaration, hasSchemaProperties, hasTrueAdditionalProperties, importMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isFileTypeSchema, isObjectSchema, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, needsUnflattenedSpec, needToImport, outputFolder, postProcessAllCodegenModels, postProcessAllModels, postProcessModelsEnum, postProcessOperations, postProcessOperationsWithModels, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processMapSchema, processModelEnums, processOpenAPI, processPropertySchemaContainerTypes, processPropertySchemaTypes, readLanguageArguments, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setInputURL, setLanguageArguments, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterJson, setParameterNullable, setReleaseNote, setRemoveOperationIdPrefix, setReservedWords, setReservedWordsLowerCase, setSchemaProperties, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, setTemplateEngine, setTemplateVersion, setUnflattenedOpenAPI, setUseOas2, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toRegularExpression, toSetter, typeMapping, underscore, updateCodegenModelEnumVars, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writeOptional, writePropertyBack

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.swagger.codegen.v3.CodegenConfig

checkAliasModel, getCodeName, getPriority, isPrivileged

Field Details

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

packageName

protected String packageName

packageVersion

protected String packageVersion

projectName

protected String projectName

packageUrl

protected String packageUrl

apiDocPath

protected String apiDocPath

modelDocPath

protected String modelDocPath

regexModifiers

protected Map<Character,String> regexModifiers

Constructor Details

PythonClientCodegen

public PythonClientCodegen()

Method Details

processOpts

public void processOpts()

Specified by:

processOpts in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

processOpts in class DefaultCodegenConfig

fromModel

public io.swagger.codegen.v3.CodegenModel fromModel(String name,
 io.swagger.v3.oas.models.media.Schema schema,
 Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions)

Description copied from class: DefaultCodegenConfig

Convert Swagger Model object to Codegen Model object

Specified by:

fromModel in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

fromModel in class DefaultCodegenConfig

Parameters:

name - the name of the model

schema - Swagger Model object

allDefinitions - a map of all Swagger models from the spec

Returns:

Codegen Model object

toModelImport

public String toModelImport(String name)

Description copied from class: DefaultCodegenConfig

Return the fully-qualified "Model" name for import

Specified by:

toModelImport in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toModelImport in class DefaultCodegenConfig

Parameters:

name - the name of the "Model"

Returns:

the fully-qualified "Model" name for import

toApiImport

public String toApiImport(String name)

Description copied from class: DefaultCodegenConfig

Return the fully-qualified "Api" name for import

Specified by:

toApiImport in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiImport in class DefaultCodegenConfig

Parameters:

name - the name of the "Api"

Returns:

the fully-qualified "Api" name for import

postProcessModels

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

Specified by:

postProcessModels in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessModels in class DefaultCodegenConfig

postProcessParameter

public void postProcessParameter(io.swagger.codegen.v3.CodegenParameter parameter)

Specified by:

postProcessParameter in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessParameter in class DefaultCodegenConfig

postProcessModelProperty

public void postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model,
 io.swagger.codegen.v3.CodegenProperty property)

Specified by:

postProcessModelProperty in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessModelProperty in class DefaultCodegenConfig

postProcessPattern

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

getTag

public io.swagger.codegen.v3.CodegenType getTag()

getName

public String getName()

getHelp

public String getHelp()

escapeReservedWord

public String escapeReservedWord(String name)

Description copied from class: DefaultCodegenConfig

Return the escaped name of the reserved word

Specified by:

escapeReservedWord in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

escapeReservedWord in class DefaultCodegenConfig

Parameters:

name - the name to be escaped

Returns:

the escaped reserved word throws Runtime exception as reserved word is not allowed (default behavior)

apiDocFileFolder

public String apiDocFileFolder()

Specified by:

apiDocFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

apiDocFileFolder in class DefaultCodegenConfig

modelDocFileFolder

public String modelDocFileFolder()

Specified by:

modelDocFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

modelDocFileFolder in class DefaultCodegenConfig

toModelDocFilename

public String toModelDocFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the capitalized file name of the model documentation

Specified by:

toModelDocFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toModelDocFilename in class DefaultCodegenConfig

Parameters:

name - the model name

Returns:

the file name of the model

toApiDocFilename

public String toApiDocFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the file name of the Api Documentation

Specified by:

toApiDocFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiDocFilename in class DefaultCodegenConfig

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

apiFileFolder

public String apiFileFolder()

Specified by:

apiFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

apiFileFolder in class DefaultCodegenConfig

modelFileFolder

public String modelFileFolder()

Specified by:

modelFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

modelFileFolder in class DefaultCodegenConfig

apiTestFileFolder

public String apiTestFileFolder()

Specified by:

apiTestFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

apiTestFileFolder in class DefaultCodegenConfig

modelTestFileFolder

public String modelTestFileFolder()

Specified by:

modelTestFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

modelTestFileFolder in class DefaultCodegenConfig

toInstantiationType

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

Description copied from class: DefaultCodegenConfig

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

Overrides:

toInstantiationType in class DefaultCodegenConfig

Parameters:

schema - Swagger property object

Returns:

string presentation of the instantiation type of the property

getTypeDeclaration

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

Description copied from class: DefaultCodegenConfig

Output the type declaration of the property

Specified by:

getTypeDeclaration in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

getTypeDeclaration in class DefaultCodegenConfig

Parameters:

schema - Schema Property object

Returns:

a string presentation of the property type

getSchemaType

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

Description copied from class: DefaultCodegenConfig

returns the swagger type for the property

Overrides:

getSchemaType in class DefaultCodegenConfig

Parameters:

schema - Schema property object

Returns:

string presentation of the type

toVarName

public String toVarName(String name)

Description copied from class: DefaultCodegenConfig

Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

Overrides:

toVarName in class DefaultCodegenConfig

Parameters:

name - the variable name

Returns:

the sanitized variable name

toParamName

public String toParamName(String name)

Description copied from class: DefaultCodegenConfig

Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.

Specified by:

toParamName in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toParamName in class DefaultCodegenConfig

Parameters:

name - Codegen property object

Returns:

the sanitized parameter name

toModelName

public String toModelName(String name)

Description copied from class: DefaultCodegenConfig

Output the proper model name (capitalized). In case the name belongs to the TypeSystem it won't be renamed.

Specified by:

toModelName in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toModelName in class DefaultCodegenConfig

Parameters:

name - the name of the model

Returns:

capitalized model name

toModelFilename

public String toModelFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the capitalized file name of the model

Specified by:

toModelFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toModelFilename in class DefaultCodegenConfig

Parameters:

name - the model name

Returns:

the file name of the model

toModelTestFilename

public String toModelTestFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the capitalized file name of the model test

Specified by:

toModelTestFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toModelTestFilename in class DefaultCodegenConfig

Parameters:

name - the model name

Returns:

the file name of the model

toApiFilename

public String toApiFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the file name of the Api Test

Specified by:

toApiFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiFilename in class DefaultCodegenConfig

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

toApiTestFilename

public String toApiTestFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the file name of the Api Test

Specified by:

toApiTestFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiTestFilename in class DefaultCodegenConfig

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

toApiName

public String toApiName(String name)

Description copied from class: DefaultCodegenConfig

Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty

Specified by:

toApiName in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiName in class DefaultCodegenConfig

Parameters:

name - the name of the Api

Returns:

capitalized Api name ending with "Api"

toApiVarName

public String toApiVarName(String name)

Description copied from class: DefaultCodegenConfig

Return the variable name in the Api

Specified by:

toApiVarName in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiVarName in class DefaultCodegenConfig

Parameters:

name - the varible name of the Api

Returns:

the snake-cased variable name

toOperationId

public String toOperationId(String operationId)

Description copied from class: DefaultCodegenConfig

Return the operation ID (method name)

Overrides:

toOperationId in class DefaultCodegenConfig

Parameters:

operationId - operation ID

Returns:

the sanitized method name

setPackageName

public void setPackageName(String packageName)

setProjectName

public void setProjectName(String projectName)

setPackageVersion

public void setPackageVersion(String packageVersion)

setPackageUrl

public void setPackageUrl(String packageUrl)

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

toDefaultValue

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

Return the default value of the property

Overrides:

toDefaultValue in class DefaultCodegenConfig

Parameters:

propertySchema - Swagger property object

Returns:

string presentation of the default value of the property

setParameterExampleValue

public void setParameterExampleValue(io.swagger.codegen.v3.CodegenParameter p)

Description copied from class: DefaultCodegenConfig

Return the example value of the parameter.

Overrides:

setParameterExampleValue in class DefaultCodegenConfig

Parameters:

p - Swagger property object

sanitizeTag

public String sanitizeTag(String tag)

Description copied from class: DefaultCodegenConfig

Sanitize tag

Specified by:

sanitizeTag in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

sanitizeTag in class DefaultCodegenConfig

Parameters:

tag - Tag

Returns:

Sanitized tag

getDefaultTemplateDir

public String getDefaultTemplateDir()

Specified by:

getDefaultTemplateDir in class DefaultCodegenConfig

escapeQuotationMark

public String escapeQuotationMark(String input)

Description copied from class: DefaultCodegenConfig

Escape single and/or double quote to avoid code injection

Specified by:

escapeQuotationMark in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

escapeQuotationMark in class DefaultCodegenConfig

Parameters:

input - String to be cleaned up

Returns:

string with quotation mark removed or escaped

escapeUnsafeCharacters

public String escapeUnsafeCharacters(String input)

Description copied from class: DefaultCodegenConfig

override with any special text escaping logic to handle unsafe characters so as to avoid code injection

Specified by:

escapeUnsafeCharacters in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

escapeUnsafeCharacters in class DefaultCodegenConfig

Parameters:

input - String to be cleaned up

Returns:

string with unsafe characters removed or escaped