org.openapitools.codegen.languages

Class PythonClientExperimentalCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.PythonClientCodegen

org.openapitools.codegen.languages.PythonClientExperimentalCodegen

All Implemented Interfaces:

CodegenConfig

public class PythonClientExperimentalCodegen
extends PythonClientCodegen

Field Summary

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

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

Fields inherited from class org.openapitools.codegen.DefaultCodegen

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

Constructor Summary

Constructors

Constructor and Description
PythonClientExperimentalCodegen()

Method Summary

Modifier and Type	Method and Description
protected void	addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema)
String	dateToString(io.swagger.v3.oas.models.media.Schema p, Date date, DateFormat dateFormatter, DateFormat dateTimeFormatter)
CodegenModel	fromModel(String name, io.swagger.v3.oas.models.media.Schema schema) Convert OAS Model object to Codegen Model object
CodegenProperty	fromProperty(String name, io.swagger.v3.oas.models.media.Schema p) Convert OAS Property object to Codegen Property object
CodegenParameter	fromRequestBody(io.swagger.v3.oas.models.parameters.RequestBody body, Set<String> imports, String bodyParameterName)
CodegenResponse	fromResponse(String responseCode, io.swagger.v3.oas.models.responses.ApiResponse response) Convert OAS Response object to Codegen Response object
String	getName() Configures a friendly name for the generator.
String	getSimpleTypeDeclaration(io.swagger.v3.oas.models.media.Schema schema) Output the type declaration of the property
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p) Output the type declaration of a given name
String	getTypeString(io.swagger.v3.oas.models.media.Schema p, String prefix, String suffix)
void	handleMethodResponse(io.swagger.v3.oas.models.Operation operation, Map<String,io.swagger.v3.oas.models.media.Schema> schemas, CodegenOperation op, io.swagger.v3.oas.models.responses.ApiResponse methodResponse) Set op's returnBaseType, returnType, examples etc.
Map<String,Object>	postProcessAllModels(Map<String,Object> objs)
void	postProcessModelProperty(CodegenModel model, CodegenProperty p)
Map<String,Object>	postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
void	postProcessParameter(CodegenParameter p)
void	processOpts()
void	setParameterExampleValue(CodegenParameter p) 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	toInstantiationType(io.swagger.v3.oas.models.media.Schema property) 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).
void	updateCodegenPropertyEnum(CodegenProperty var) Update codegen property's enum by adding "enumVars" (with name and value)

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

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

Methods inherited from class org.openapitools.codegen.DefaultCodegen

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

Constructor Detail

PythonClientExperimentalCodegen

public PythonClientExperimentalCodegen()

Method Detail

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class PythonClientCodegen

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 PythonClientCodegen

Returns:

the friendly name for the generator

dateToString

public String dateToString(io.swagger.v3.oas.models.media.Schema p,
                           Date date,
                           DateFormat dateFormatter,
                           DateFormat dateTimeFormatter)

toDefaultValue

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

Return the default value of the property

Overrides:

toDefaultValue in class PythonClientCodegen

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 PythonClientCodegen

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)

Specified by:

postProcessAllModels in interface CodegenConfig

Overrides:

postProcessAllModels in class DefaultCodegen

fromProperty

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

Convert OAS Property object to Codegen Property object

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)

Overrides:

fromRequestBody in class DefaultCodegen

fromResponse

public CodegenResponse fromResponse(String responseCode,
                                    io.swagger.v3.oas.models.responses.ApiResponse response)

Convert OAS Response object to Codegen Response object

Overrides:

fromResponse in class DefaultCodegen

Parameters:

responseCode - HTTP response code

response - OAS Response object

Returns:

Codegen Response object

handleMethodResponse

public void handleMethodResponse(io.swagger.v3.oas.models.Operation operation,
                                 Map<String,io.swagger.v3.oas.models.media.Schema> schemas,
                                 CodegenOperation op,
                                 io.swagger.v3.oas.models.responses.ApiResponse methodResponse)

Set op's returnBaseType, returnType, examples etc.

Overrides:

handleMethodResponse in class DefaultCodegen

Parameters:

operation - endpoint Operation

schemas - a map of the schemas in the openapi spec

op - endpoint CodegenOperation

methodResponse - the default ApiResponse for the endpoint

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 PythonClientCodegen

postProcessParameter

public void postProcessParameter(CodegenParameter p)

Specified by:

postProcessParameter in interface CodegenConfig

Overrides:

postProcessParameter in class PythonClientCodegen

fromModel

public CodegenModel fromModel(String name,
                              io.swagger.v3.oas.models.media.Schema schema)

Convert OAS Model object to Codegen Model object

Specified by:

fromModel in interface CodegenConfig

Overrides:

fromModel in class DefaultCodegen

Parameters:

name - the name of the model

schema - OAS Model object

Returns:

Codegen Model object

getSimpleTypeDeclaration

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

Output the type declaration of the property

Parameters:

schema - property schema

Returns:

a string presentation of the property type

getTypeString

public String getTypeString(io.swagger.v3.oas.models.media.Schema p,
                            String prefix,
                            String suffix)

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 PythonClientCodegen

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)

Overrides:

addAdditionPropertiesToCodeGenModel in class DefaultCodegen

setParameterExampleValue

public void setParameterExampleValue(CodegenParameter p)

Description copied from class: DefaultCodegen

Return the example value of the parameter.

Overrides:

setParameterExampleValue in class PythonClientCodegen

Parameters:

p - Codegen parameter

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 PythonClientCodegen

Parameters:

name - the model name

Returns:

the file name of the model

toModelName

public String toModelName(String name)

Description copied from class: DefaultCodegen

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

Specified by:

toModelName in interface CodegenConfig

Overrides:

toModelName in class PythonClientCodegen

Parameters:

name - the name of the model

Returns:

capitalized model name

toModelDocFilename

public String toModelDocFilename(String name)

Description copied from class: DefaultCodegen

Return the capitalized file name of the model documentation

Specified by:

toModelDocFilename in interface CodegenConfig

Overrides:

toModelDocFilename in class PythonClientCodegen

Parameters:

name - the model name

Returns:

the file name of the model