public class PythonClientCodegen extends DefaultCodegen implements CodegenConfig
| 限定符和类型 | 字段和说明 |
|---|---|
protected String |
apiDocPath |
static String |
DEFAULT_LIBRARY |
protected String |
modelDocPath |
static String |
PACKAGE_URL |
protected String |
packageName |
protected String |
packageUrl |
protected String |
packageVersion |
protected String |
projectName |
protected Map<Character,String> |
regexModifiers |
additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, defaultIncludes, docExtension, embeddedTemplateDir, enablePostProcessFile, ensureUniqueParams, fileSuffix, gitRepoId, gitUserId, globalOpenAPI, globalSchemas, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, prependFormOrBodyParameters, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions| 构造器和说明 |
|---|
PythonClientCodegen() |
| 限定符和类型 | 方法和说明 |
|---|---|
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
|
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 |
getSchemaType(io.swagger.v3.oas.models.media.Schema p)
returns the OpenAPI type for the property.
|
CodegenType |
getTag() |
String |
getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)
Output the type declaration of the property
|
String |
modelDocFileFolder() |
String |
modelFileFolder() |
String |
modelTestFileFolder() |
void |
postProcessFile(File file,
String fileType)
Post-process the auto-generated file, e.g. using go-fmt to format the Go code.
|
void |
postProcessModelProperty(CodegenModel model,
CodegenProperty property) |
Map<String,Object> |
postProcessModels(Map<String,Object> objs) |
void |
postProcessParameter(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(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 |
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 p)
Return the default value of the property
|
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.
|
addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeSpecialCharacters, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAlias, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDocExtension, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getMostInnerItems, getOrGenerateOperationId, getOutputDir, getParameterDataType, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, needToImport, outputFolder, postProcessAllModels, postProcessModelsEnum, postProcessOperations, postProcessOperationsWithModels, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setDocExtension, setEnablePostProcessFile, setEnsureUniqueParams, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterExampleValue, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toArrayModelParamName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toGetter, toInstantiationType, toRegularExpression, toSetter, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBackclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitadditionalProperties, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromModel, fromOperation, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTypeDeclaration, importMapping, instantiationTypes, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessOperations, postProcessOperationsWithModels, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, reservedWords, reservedWordsMappings, sanitizeName, setDocExtension, setEnablePostProcessFile, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toBooleanGetter, toGetter, toSetter, typeMapping, vendorExtensionsprotected String packageName
protected String packageVersion
protected String projectName
protected String packageUrl
protected String apiDocPath
protected String modelDocPath
public void processOpts()
processOpts 在接口中 CodegenConfigprocessOpts 在类中 DefaultCodegenpublic String toModelImport(String name)
DefaultCodegentoModelImport 在接口中 CodegenConfigtoModelImport 在类中 DefaultCodegenname - the name of the "Model"public Map<String,Object> postProcessModels(Map<String,Object> objs)
postProcessModels 在接口中 CodegenConfigpostProcessModels 在类中 DefaultCodegenpublic void postProcessParameter(CodegenParameter parameter)
postProcessParameter 在接口中 CodegenConfigpostProcessParameter 在类中 DefaultCodegenpublic void postProcessModelProperty(CodegenModel model, CodegenProperty property)
postProcessModelProperty 在接口中 CodegenConfigpostProcessModelProperty 在类中 DefaultCodegenpublic void postProcessPattern(String pattern, Map<String,Object> vendorExtensions)
public CodegenType getTag()
getTag 在接口中 CodegenConfiggetTag 在类中 DefaultCodegenpublic String getName()
getName 在接口中 CodegenConfiggetName 在类中 DefaultCodegenpublic String getHelp()
getHelp 在接口中 CodegenConfiggetHelp 在类中 DefaultCodegenpublic String escapeReservedWord(String name)
DefaultCodegenescapeReservedWord 在接口中 CodegenConfigescapeReservedWord 在类中 DefaultCodegenname - the name to be escapedthrows Runtime exception as reserved word is not allowed (default behavior)
public String apiDocFileFolder()
apiDocFileFolder 在接口中 CodegenConfigapiDocFileFolder 在类中 DefaultCodegenpublic String modelDocFileFolder()
modelDocFileFolder 在接口中 CodegenConfigmodelDocFileFolder 在类中 DefaultCodegenpublic String toModelDocFilename(String name)
DefaultCodegentoModelDocFilename 在接口中 CodegenConfigtoModelDocFilename 在类中 DefaultCodegenname - the model namepublic String toApiDocFilename(String name)
DefaultCodegentoApiDocFilename 在接口中 CodegenConfigtoApiDocFilename 在类中 DefaultCodegenname - the file name of the Apipublic String apiFileFolder()
apiFileFolder 在接口中 CodegenConfigapiFileFolder 在类中 DefaultCodegenpublic String modelFileFolder()
modelFileFolder 在接口中 CodegenConfigmodelFileFolder 在类中 DefaultCodegenpublic String apiTestFileFolder()
apiTestFileFolder 在接口中 CodegenConfigapiTestFileFolder 在类中 DefaultCodegenpublic String modelTestFileFolder()
modelTestFileFolder 在接口中 CodegenConfigmodelTestFileFolder 在类中 DefaultCodegenpublic String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)
DefaultCodegengetTypeDeclaration 在接口中 CodegenConfiggetTypeDeclaration 在类中 DefaultCodegenp - property schemapublic String getSchemaType(io.swagger.v3.oas.models.media.Schema p)
DefaultCodegengetSchemaType 在类中 DefaultCodegenp - property schemapublic String toVarName(String name)
DefaultCodegentoVarName 在类中 DefaultCodegenname - the variable namepublic String toParamName(String name)
DefaultCodegentoParamName 在接口中 CodegenConfigtoParamName 在类中 DefaultCodegenname - Codegen property objectpublic String toModelName(String name)
DefaultCodegentoModelName 在接口中 CodegenConfigtoModelName 在类中 DefaultCodegenname - the name of the modelpublic String toModelFilename(String name)
DefaultCodegentoModelFilename 在接口中 CodegenConfigtoModelFilename 在类中 DefaultCodegenname - the model namepublic String toModelTestFilename(String name)
DefaultCodegentoModelTestFilename 在接口中 CodegenConfigtoModelTestFilename 在类中 DefaultCodegenname - the model namepublic String toApiFilename(String name)
DefaultCodegentoApiFilename 在接口中 CodegenConfigtoApiFilename 在类中 DefaultCodegenname - the file name of the Apipublic String toApiTestFilename(String name)
DefaultCodegentoApiTestFilename 在接口中 CodegenConfigtoApiTestFilename 在类中 DefaultCodegenname - the file name of the Apipublic String toApiName(String name)
DefaultCodegentoApiName 在接口中 CodegenConfigtoApiName 在类中 DefaultCodegenname - the name of the Apipublic String toApiVarName(String name)
DefaultCodegentoApiVarName 在接口中 CodegenConfigtoApiVarName 在类中 DefaultCodegenname - the varible name of the Apipublic String toOperationId(String operationId)
DefaultCodegentoOperationId 在类中 DefaultCodegenoperationId - operation IDpublic void setPackageName(String packageName)
public void setProjectName(String projectName)
public void setPackageVersion(String packageVersion)
public void setPackageUrl(String packageUrl)
public String generatePackageName(String packageName)
(PEP 0008) Python packages should also have short, all-lowercase names, although the use of underscores is discouraged.
packageName - Package namepublic String toDefaultValue(io.swagger.v3.oas.models.media.Schema p)
toDefaultValue 在类中 DefaultCodegenp - OpenAPI property objectpublic void setParameterExampleValue(CodegenParameter p)
DefaultCodegensetParameterExampleValue 在类中 DefaultCodegenp - Codegen parameterpublic String sanitizeTag(String tag)
DefaultCodegensanitizeTag 在接口中 CodegenConfigsanitizeTag 在类中 DefaultCodegentag - Tagpublic String escapeQuotationMark(String input)
DefaultCodegenescapeQuotationMark 在接口中 CodegenConfigescapeQuotationMark 在类中 DefaultCodegeninput - String to be cleaned uppublic String escapeUnsafeCharacters(String input)
DefaultCodegenescapeUnsafeCharacters 在接口中 CodegenConfigescapeUnsafeCharacters 在类中 DefaultCodegeninput - String to be cleaned uppublic void postProcessFile(File file, String fileType)
DefaultCodegenTODO: store these values in enum instead
postProcessFile 在接口中 CodegenConfigpostProcessFile 在类中 DefaultCodegenfile - file to be processedfileType - file typeCopyright © 2019. All rights reserved.