io.swagger.codegen.v3.generators.python

Class PythonFlaskConnexionCodegen

java.lang.Object

io.swagger.codegen.v3.generators.DefaultCodegenConfig

io.swagger.codegen.v3.generators.python.PythonFlaskConnexionCodegen

All Implemented Interfaces:

io.swagger.codegen.v3.CodegenConfig

public class PythonFlaskConnexionCodegen
extends DefaultCodegenConfig

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTROLLER_PACKAGE
protected String	controllerPackage
static String	DEFAULT_CONTROLLER
protected String	defaultController
protected String	packageName
protected String	packageVersion
protected Map<Character,String>	regexModifiers
protected int	serverPort
static String	SUPPORT_PYTHON2

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

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, copyFistAllOfProperties, customTemplateDir, DEFAULT_CONTENT_TYPE, DEFAULT_TEMPLATE_DIR, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoBaseURL, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, inputURL, instantiationTypes, 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 and Description
PythonFlaskConnexionCodegen()

Method Summary

Modifier and Type	Method and Description
protected void	addImport(io.swagger.codegen.v3.CodegenModel codegenModel, String type)
protected void	addOperationImports(io.swagger.codegen.v3.CodegenOperation codegenOperation, Set<String> operationImports)
protected void	addRouterControllerExtensions(io.swagger.v3.oas.models.Paths paths)
protected void	addSecurityExtensions(Map<String,io.swagger.v3.oas.models.security.SecurityScheme> securitySchemes)
String	apiFileFolder() Location to write api files.
String	apiPackage()
String	escapeQuotationMark(String input) Escape single and/or double quote to avoid code injection
String	escapeReservedWord(String name) Escapes a reserved word as defined in the `reservedWords` array.
String	escapeUnsafeCharacters(String input) override with any special text escaping logic to handle unsafe characters so as to avoid code injection
String	getDefaultTemplateDir()
String	getHelp() Returns human-friendly help for the generator.
String	getName() Configures a friendly name for the generator.
String	getSchemaType(io.swagger.v3.oas.models.media.Schema p) returns the swagger type for the property
io.swagger.codegen.v3.CodegenType	getTag() Configures the type of generator.
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema schemaProperty) Output the type declaration of the property
Map<String,Object>	postProcessAllModels(Map<String,Object> processedModels)
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)
Map<String,Object>	postProcessSupportingFileData(Map<String,Object> objs)
void	preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
void	processOpts()
void	setPackageName(String packageName)
void	setPackageVersion(String packageVersion)
void	setParameterExampleValue(io.swagger.codegen.v3.CodegenParameter p) Return the example value of the parameter.
String	toApiFilename(String name) Return the file name of the Api Test
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	toDefaultValue(io.swagger.v3.oas.models.media.Schema schemaProperty) Return the default value of the property
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	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, additionalProperties, addOperationToGroup, addOption, addOption, addParameters, addParentContainer, addProducesInfo, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, customTemplateDir, dashize, defaultIgnoreImportMappingOption, defaultIncludes, detectParent, embeddedTemplateDir, ensureUniqueParameters, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fixUpParentAndInterfaces, fromModel, 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, isObjectSchema, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needsUnflattenedSpec, needToImport, outputFolder, postProcessAllCodegenModels, postProcessModelsEnum, postProcessOperations, postProcessOperationsWithModels, processCompiler, processMapSchema, processModelEnums, processOpenAPI, processPropertySchemaContainerTypes, processPropertySchemaTypes, readLanguageArguments, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setInputURL, setLanguageArguments, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterNullable, setReleaseNote, setRemoveOperationIdPrefix, setReservedWords, setReservedWordsLowerCase, setSchemaProperties, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, setTemplateEngine, setTemplateVersion, setUnflattenedOpenAPI, setUseOas2, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiImport, toApiVarName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toInstantiationType, toModelDocFilename, toModelTestFilename, toRegularExpression, toSetter, typeMapping, underscore, updateCodegenModelEnumVars, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, 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

Field Detail

CONTROLLER_PACKAGE

public static final String CONTROLLER_PACKAGE

See Also:

Constant Field Values

DEFAULT_CONTROLLER

public static final String DEFAULT_CONTROLLER

See Also:

Constant Field Values

SUPPORT_PYTHON2

public static final String SUPPORT_PYTHON2

See Also:

Constant Field Values

serverPort

protected int serverPort

packageName

protected String packageName

packageVersion

protected String packageVersion

controllerPackage

protected String controllerPackage

defaultController

protected String defaultController

regexModifiers

protected Map<Character,String> regexModifiers

Constructor Detail

PythonFlaskConnexionCodegen

public PythonFlaskConnexionCodegen()

Method Detail

processOpts

public void processOpts()

Specified by:

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

Overrides:

processOpts in class DefaultCodegenConfig

apiPackage

public String apiPackage()

Specified by:

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

Overrides:

apiPackage in class DefaultCodegenConfig

getTag

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

Configures the type of generator.

Returns:

the CodegenType for this generator

See Also:

CodegenType

getName

public String getName()

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

Returns:

the friendly name for the generator

getHelp

public String getHelp()

Returns human-friendly help for the generator. Provide the consumer with help tips, parameters here

Returns:

A string value for the help message

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"

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

escapeReservedWord

public String escapeReservedWord(String name)

Escapes a reserved word as defined in the `reservedWords` array. Handle escaping those terms here. This logic is only called if a variable matches the reserved words

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 term

apiFileFolder

public String apiFileFolder()

Location to write api files. You can use the apiPackage() as defined when the class is instantiated

Specified by:

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

Overrides:

apiFileFolder in class DefaultCodegenConfig

getTypeDeclaration

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

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:

schemaProperty - Schema Property object

Returns:

a string presentation of the property type

getSchemaType

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

Description copied from class: DefaultCodegenConfig

returns the swagger type for the property

Overrides:

getSchemaType in class DefaultCodegenConfig

Parameters:

p - Schema property object

Returns:

string presentation of the type

preprocessOpenAPI

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

Specified by:

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

Overrides:

preprocessOpenAPI in class DefaultCodegenConfig

addOperationImports

protected void addOperationImports(io.swagger.codegen.v3.CodegenOperation codegenOperation,
                                   Set<String> operationImports)

Overrides:

addOperationImports in class DefaultCodegenConfig

postProcessSupportingFileData

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

Specified by:

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

Overrides:

postProcessSupportingFileData in class DefaultCodegenConfig

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

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

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

getDefaultTemplateDir

public String getDefaultTemplateDir()

Specified by:

getDefaultTemplateDir in class DefaultCodegenConfig

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

toDefaultValue

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

Return the default value of the property

Overrides:

toDefaultValue in class DefaultCodegenConfig

Parameters:

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

setPackageName

public void setPackageName(String packageName)

setPackageVersion

public void setPackageVersion(String packageVersion)

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

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

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

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

postProcessPattern

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

addRouterControllerExtensions

protected void addRouterControllerExtensions(io.swagger.v3.oas.models.Paths paths)

addSecurityExtensions

protected void addSecurityExtensions(Map<String,io.swagger.v3.oas.models.security.SecurityScheme> securitySchemes)

postProcessAllModels

public Map<String,Object> postProcessAllModels(Map<String,Object> processedModels)

Specified by:

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

Overrides:

postProcessAllModels in class DefaultCodegenConfig

addImport

protected void addImport(io.swagger.codegen.v3.CodegenModel codegenModel,
                         String type)

Overrides:

addImport in class DefaultCodegenConfig