io.swagger.codegen.languages

Class PythonClientCodegen

java.lang.Object

io.swagger.codegen.DefaultCodegen

io.swagger.codegen.languages.PythonClientCodegen

All Implemented Interfaces:

CodegenConfig

public class PythonClientCodegen
extends DefaultCodegen
implements CodegenConfig

Field Summary

Fields

Modifier and Type	Field and Description
protected String	packageName
protected String	packageVersion

Fields inherited from class io.swagger.codegen.DefaultCodegen

additionalProperties, apiPackage, apiTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, importMapping, instantiationTypes, languageSpecificPrimitives, library, LOGGER, modelPackage, modelTemplateFiles, outputFolder, reservedWords, skipOverwrite, sortParamsByRequiredFlag, supportedLibraries, supportingFiles, supportsInheritance, templateDir, typeMapping

Constructor Summary

Constructors

Constructor and Description
PythonClientCodegen()

Method Summary

Methods

Modifier and Type	Method and Description
String	apiFileFolder()
String	escapeReservedWord(String name) Return the escaped name of the reserved word
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	getHelp()
String	getName()
String	getSwaggerType(io.swagger.models.properties.Property p) returns the swagger type for the property
CodegenType	getTag()
String	getTypeDeclaration(io.swagger.models.properties.Property p) Output the type declaration of the property
String	modelFileFolder()
void	processOpts()
void	setPackageName(String packageName)
void	setPackageVersion(String packageVersion)
String	toApiFilename(String name) Return the file name of the Api
String	toApiName(String name) Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
String	toApiVarName(String name) Return the variable name in the Api
String	toDefaultValue(io.swagger.models.properties.Property p) Return the default value of the property
String	toModelFilename(String name) Return the capitalized file name of the model
String	toModelName(String name) Output the proper model name (capitalized)
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.DefaultCodegen

additionalProperties, addOperationToGroup, apiFilename, apiPackage, apiTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, dashize, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, fromModel, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromResponse, fromSecurity, generateExamplePath, getLibrary, getOrGenerateOperationId, getOutputDir, getterAndSetterCapitalize, getTypeDeclaration, importMapping, initialCaps, instantiationTypes, isSkipOverwrite, languageSpecificPrimitives, modelPackage, modelTemplateFiles, needToImport, outputFolder, postProcessModelProperty, postProcessModels, postProcessOperations, postProcessParameter, postProcessSupportingFileData, preprocessSwagger, processSwagger, removeNonNameElementToCamelCase, reservedWords, sanitizeName, setApiPackage, setEnsureUniqueParams, setLibrary, setModelPackage, setNonArrayMapProperty, setOutputDir, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, toApiImport, toDefaultValueWithParam, toEnumName, toExamples, toInstantiationType, toModelImport, typeMapping, underscore

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.CodegenConfig

additionalProperties, addOperationToGroup, apiFilename, apiPackage, apiTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, fromModel, fromModel, fromOperation, fromOperation, fromSecurity, generateExamplePath, getLibrary, getOutputDir, getTypeDeclaration, importMapping, instantiationTypes, isSkipOverwrite, languageSpecificPrimitives, modelPackage, modelTemplateFiles, outputFolder, postProcessModelProperty, postProcessModels, postProcessOperations, postProcessParameter, postProcessSupportingFileData, preprocessSwagger, processSwagger, reservedWords, setLibrary, setOutputDir, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, toApiImport, toModelImport, typeMapping

Field Detail

packageName

protected String packageName

packageVersion

protected String packageVersion

Constructor Detail

PythonClientCodegen

public PythonClientCodegen()

Method Detail

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class DefaultCodegen

getTag

public CodegenType getTag()

Specified by:

getTag in interface CodegenConfig

getName

public String getName()

Specified by:

getName in interface CodegenConfig

getHelp

public String getHelp()

Specified by:

getHelp in interface CodegenConfig

escapeReservedWord

public String escapeReservedWord(String name)

Description copied from class: DefaultCodegen

Return the escaped name of the reserved word

Specified by:

escapeReservedWord in interface CodegenConfig

Overrides:

escapeReservedWord in class DefaultCodegen

Parameters:

name - the name to be escaped

Returns:

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

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

getTypeDeclaration

public String getTypeDeclaration(io.swagger.models.properties.Property p)

Description copied from class: DefaultCodegen

Output the type declaration of the property

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class DefaultCodegen

Parameters:

p - Swagger Property object

Returns:

a string presentation of the property type

getSwaggerType

public String getSwaggerType(io.swagger.models.properties.Property p)

Description copied from class: DefaultCodegen

returns the swagger type for the property

Overrides:

getSwaggerType in class DefaultCodegen

Parameters:

p - Swagger property object

Returns:

string presentation of the type

toVarName

public String toVarName(String name)

Description copied from class: DefaultCodegen

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

Overrides:

toVarName in class DefaultCodegen

Parameters:

name - the variable name

Returns:

the sanitized variable name

toParamName

public String toParamName(String name)

Description copied from class: DefaultCodegen

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

Specified by:

toParamName in interface CodegenConfig

Overrides:

toParamName in class DefaultCodegen

Parameters:

name - Codegen property object

Returns:

the sanitized parameter name

toModelName

public String toModelName(String name)

Description copied from class: DefaultCodegen

Output the proper model name (capitalized)

Specified by:

toModelName in interface CodegenConfig

Overrides:

toModelName in class DefaultCodegen

Parameters:

name - the name of the model

Returns:

capitalized model name

toModelFilename

public String toModelFilename(String name)

Description copied from class: DefaultCodegen

Return the capitalized file name of the model

Specified by:

toModelFilename in interface CodegenConfig

Overrides:

toModelFilename in class DefaultCodegen

Parameters:

name - the model name

Returns:

the file name of the model

toApiFilename

public String toApiFilename(String name)

Description copied from class: DefaultCodegen

Return the file name of the Api

Specified by:

toApiFilename in interface CodegenConfig

Overrides:

toApiFilename in class DefaultCodegen

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: DefaultCodegen

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

Specified by:

toApiName in interface CodegenConfig

Overrides:

toApiName in class DefaultCodegen

Parameters:

name - the name of the Api

Returns:

capitalized Api name ending with "Api"

toApiVarName

public String toApiVarName(String name)

Description copied from class: DefaultCodegen

Return the variable name in the Api

Specified by:

toApiVarName in interface CodegenConfig

Overrides:

toApiVarName in class DefaultCodegen

Parameters:

name - the varible name of the Api

Returns:

the snake-cased variable name

toOperationId

public String toOperationId(String operationId)

Description copied from class: DefaultCodegen

Return the operation ID (method name)

Overrides:

toOperationId in class DefaultCodegen

Parameters:

operationId - operation ID

Returns:

the sanitized method name

setPackageName

public void setPackageName(String packageName)

setPackageVersion

public void setPackageVersion(String packageVersion)

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.

toDefaultValue

public String toDefaultValue(io.swagger.models.properties.Property p)

Return the default value of the property

Overrides:

toDefaultValue in class DefaultCodegen

Parameters:

p - Swagger property object

Returns:

string presentation of the default value of the property