org.openapitools.codegen.languages

Class AbstractPythonConnexionServerCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractPythonCodegen

org.openapitools.codegen.languages.AbstractPythonConnexionServerCodegen

All Implemented Interfaces:

CodegenConfig

Direct Known Subclasses:

PythonAiohttpConnexionServerCodegen, PythonBluePlanetServerCodegen, PythonFlaskConnexionServerCodegen

public abstract class AbstractPythonConnexionServerCodegen
extends AbstractPythonCodegen
implements CodegenConfig

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTROLLER_PACKAGE
protected String	controllerPackage
static String	DEFAULT_CONTROLLER
protected String	defaultController
static String	FEATURE_CORS
protected boolean	featureCORS
protected boolean	fixBodyName
static String	MOVE_TESTS_UNDER_PYTHON_SRC_ROOT
protected boolean	moveTestsUnderPythonSrcRoot
static String	PYTHON_SRC_ROOT
protected String	pythonSrcRoot
protected Map<Character,String>	regexModifiers
protected int	serverPort
static String	SUPPORT_PYTHON2
static String	USE_NOSE
static String	USE_PYTHON_SRC_ROOT_IN_IMPORTS
protected boolean	useNose
protected boolean	usePythonSrcRootInImports

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

packageName, packageVersion, projectName

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, enumUnknownDefaultCase, enumUnknownDefaultCaseName, filesMetadataFilename, 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, removeOperationIdPrefixCount, removeOperationIdPrefixDelimiter, reservedWords, reservedWordsMappings, serverVariables, skipOperationExample, skipOverwrite, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsAdditionalPropertiesWithComposedSchema, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, testPackage, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions, versionMetadataFilename

Constructor Summary

Constructors

Constructor and Description
AbstractPythonConnexionServerCodegen(String templateDirectory, boolean fixBodyNameValue)

Method Summary

Modifier and Type	Method and Description
protected void	addSupportingFiles()
String	apiFileFolder() Location to write api files.
String	apiPackage()
String	getHelp() Returns human-friendly help for the generator.
CodegenType	getTag() Configures the type of generator.
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p) Output the language-specific type declaration of the property.
String	modelFileFolder()
String	packagePath()
Map<String,Object>	postProcessAllModels(Map<String,Object> objs)
void	postProcessModelProperty(CodegenModel model, CodegenProperty property)
Map<String,Object>	postProcessModels(Map<String,Object> objs)
Map<String,Object>	postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
void	postProcessParameter(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()
String	pythonSrcOutputFolder()
void	setFeatureCORS(String val)
void	setMoveTestsUnderPythonSrcRoot(String val)
void	setPythonSrcRoot(String val)
void	setUseNose(String val)
void	setUsePythonSrcRootInImports(String val)
String	toApiFilename(String name) Return the file name of the Api Test
String	toApiName(String name) Output the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is empty
String	toApiTestFilename(String name) Return the file name of the Api Test
String	toModelImport(String name) Return the fully-qualified "Model" name for import

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

dropDots, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, getSchemaType, patternCorrection, postProcessFile, sanitizeTag, setPackageName, setPackageVersion, setParameterExampleValue, setParameterExampleValue, setProjectName, toApiVarName, toDefaultValue, toExampleValue, toModelFilename, toModelName, toModelTestFilename, toOperationId, toParamName, toRegularExpression, toVarName

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addBodyModelSchema, addHeaders, addImport, addImportsForPropertyType, addImportsToOneOfInterface, additionalProperties, addMustacheLambdas, addOneOfInterfaceModel, addOneOfNameExtension, addOperationToGroup, addOption, addParentContainer, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, createDiscriminator, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromOperation, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAdditionalProperties, 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, getModelNameToSchemaCache, getMostInnerItems, getName, getOneOfAnyOfDescendants, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getRemoveOperationIdPrefixCount, getRemoveOperationIdPrefixDelimiter, getSchemaAdditionalProperties, getSchemaItems, getSingleSchemaType, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseOneOfInterfaces, getVersionMetadataFilename, handleMethodResponse, handleMethodResponse, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, instantiationTypes, isAnyTypeSchema, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isFreeFormObject, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isReservedWord, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, lowerCamelCase, modelDocFileFolder, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, modifyFeatureSet, needToImport, outputFolder, postProcess, postProcessModelsEnum, processCompiler, processOpenAPI, processTemplatingEngine, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, serverVariableOverrides, setAddProps, 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, setParameterContentType, setParameterExampleValue, setParameterNullable, setPrependFormOrBodyParameters, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setRemoveOperationIdPrefixCount, setRemoveOperationIdPrefixDelimiter, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, setUseOneOfInterfaces, setVersionMetadataFilename, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toAllOfName, toAnyOfName, toApiDocFilename, toApiImport, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toGetter, toInstantiationType, toMediaTypeSchemaName, toModelDocFilename, toModelImportMap, toOneOfName, toSetter, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateModelForAnyType, updateModelForComposedSchema, updateModelForObject, updateOption, updateParameterForString, updatePropertyForAnyType, updatePropertyForArray, updatePropertyForMap, updatePropertyForMap, updatePropertyForObject, updatePropertyForString, 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, addOperationToGroup, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, encodePath, escapeQuotationMark, escapeReservedWord, escapeText, escapeTextWhileAllowingNewLines, escapeUnsafeCharacters, fileSuffix, fromModel, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getName, getOutputDir, getReleaseNote, getTemplatingEngine, getTypeDeclaration, getVersionMetadataFilename, importMapping, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcess, postProcessFile, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, 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, toApiDocFilename, toApiImport, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelFilename, toModelImportMap, toModelName, toModelTestFilename, toParamName, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensions

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

FEATURE_CORS

public static final String FEATURE_CORS

See Also:

Constant Field Values

USE_NOSE

public static final String USE_NOSE

See Also:

Constant Field Values

PYTHON_SRC_ROOT

public static final String PYTHON_SRC_ROOT

See Also:

Constant Field Values

USE_PYTHON_SRC_ROOT_IN_IMPORTS

public static final String USE_PYTHON_SRC_ROOT_IN_IMPORTS

See Also:

Constant Field Values

MOVE_TESTS_UNDER_PYTHON_SRC_ROOT

public static final String MOVE_TESTS_UNDER_PYTHON_SRC_ROOT

See Also:

Constant Field Values

serverPort

protected int serverPort

controllerPackage

protected String controllerPackage

defaultController

protected String defaultController

regexModifiers

protected Map<Character,String> regexModifiers

fixBodyName

protected boolean fixBodyName

featureCORS

protected boolean featureCORS

useNose

protected boolean useNose

pythonSrcRoot

protected String pythonSrcRoot

usePythonSrcRootInImports

protected boolean usePythonSrcRootInImports

moveTestsUnderPythonSrcRoot

protected boolean moveTestsUnderPythonSrcRoot

Constructor Detail

AbstractPythonConnexionServerCodegen

public AbstractPythonConnexionServerCodegen(String templateDirectory,
                                            boolean fixBodyNameValue)

Method Detail

addSupportingFiles

protected void addSupportingFiles()

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class AbstractPythonCodegen

setFeatureCORS

public void setFeatureCORS(String val)

setUseNose

public void setUseNose(String val)

setPythonSrcRoot

public void setPythonSrcRoot(String val)

setUsePythonSrcRootInImports

public void setUsePythonSrcRootInImports(String val)

setMoveTestsUnderPythonSrcRoot

public void setMoveTestsUnderPythonSrcRoot(String val)

pythonSrcOutputFolder

public String pythonSrcOutputFolder()

apiPackage

public String apiPackage()

Specified by:

apiPackage in interface CodegenConfig

Overrides:

apiPackage in class DefaultCodegen

getTag

public CodegenType getTag()

Configures the type of generator.

Specified by:

getTag in interface CodegenConfig

Overrides:

getTag in class DefaultCodegen

Returns:

the CodegenType for this generator

See Also:

CodegenType

getHelp

public String getHelp()

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

Specified by:

getHelp in interface CodegenConfig

Overrides:

getHelp in class DefaultCodegen

Returns:

A string value for the help message

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

toApiFilename

public String toApiFilename(String name)

Description copied from class: DefaultCodegen

Return the file name of the Api Test

Specified by:

toApiFilename in interface CodegenConfig

Overrides:

toApiFilename in class AbstractPythonCodegen

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

Return the file name of the Api Test

Specified by:

toApiTestFilename in interface CodegenConfig

Overrides:

toApiTestFilename in class AbstractPythonCodegen

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

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 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.v3.oas.models.media.Schema p)

Description copied from class: DefaultCodegen

Output the language-specific type declaration of the property.

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class AbstractPythonCodegen

Parameters:

p - property schema

Returns:

a string presentation of the property type

preprocessOpenAPI

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

Specified by:

preprocessOpenAPI in interface CodegenConfig

Overrides:

preprocessOpenAPI in class DefaultCodegen

postProcessSupportingFileData

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

Specified by:

postProcessSupportingFileData in interface CodegenConfig

Overrides:

postProcessSupportingFileData in class DefaultCodegen

packagePath

public String packagePath()

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

postProcessModelProperty

public void postProcessModelProperty(CodegenModel model,
                                     CodegenProperty property)

Specified by:

postProcessModelProperty in interface CodegenConfig

Overrides:

postProcessModelProperty in class DefaultCodegen

postProcessModels

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

Specified by:

postProcessModels in interface CodegenConfig

Overrides:

postProcessModels in class DefaultCodegen

postProcessAllModels

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

Specified by:

postProcessAllModels in interface CodegenConfig

Overrides:

postProcessAllModels in class DefaultCodegen

postProcessParameter

public void postProcessParameter(CodegenParameter parameter)

Specified by:

postProcessParameter in interface CodegenConfig

Overrides:

postProcessParameter in class DefaultCodegen

postProcessOperationsWithModels

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

Specified by:

postProcessOperationsWithModels in interface CodegenConfig

Overrides:

postProcessOperationsWithModels in class DefaultCodegen

postProcessPattern

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