org.openapitools.codegen.languages.AbstractPythonCodegen Maven / Gradle / Ivy
/*
* Copyright 2018 OpenAPI-Generator Contributors (https://openapi-generator.tech)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openapitools.codegen.languages;
import static org.openapitools.codegen.utils.StringUtils.camelize;
import static org.openapitools.codegen.utils.StringUtils.escape;
import static org.openapitools.codegen.utils.StringUtils.underscore;
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Random;
import java.util.Set;
import java.util.TreeSet;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
import lombok.Setter;
import org.apache.commons.io.FilenameUtils;
import org.apache.commons.lang3.StringUtils;
import org.openapitools.codegen.CodegenConfig;
import org.openapitools.codegen.CodegenConstants;
import org.openapitools.codegen.CodegenMediaType;
import org.openapitools.codegen.CodegenModel;
import org.openapitools.codegen.CodegenOperation;
import org.openapitools.codegen.CodegenParameter;
import org.openapitools.codegen.CodegenProperty;
import org.openapitools.codegen.CodegenResponse;
import org.openapitools.codegen.DefaultCodegen;
import org.openapitools.codegen.GeneratorLanguage;
import org.openapitools.codegen.IJsonSchemaValidationProperties;
import org.openapitools.codegen.meta.features.SecurityFeature;
import org.openapitools.codegen.model.ModelMap;
import org.openapitools.codegen.model.ModelsMap;
import org.openapitools.codegen.model.OperationMap;
import org.openapitools.codegen.model.OperationsMap;
import org.openapitools.codegen.utils.ModelUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.github.curiousoddman.rgxgen.RgxGen;
import io.swagger.v3.oas.models.examples.Example;
import io.swagger.v3.oas.models.media.Schema;
import io.swagger.v3.oas.models.parameters.Parameter;
public abstract class AbstractPythonCodegen extends DefaultCodegen implements CodegenConfig {
private final Logger LOGGER = LoggerFactory.getLogger(AbstractPythonCodegen.class);
public static final String MAP_NUMBER_TO = "mapNumberTo";
protected String packageName = "openapi_client";
@Setter protected String packageVersion = "1.0.0";
@Setter protected String projectName; // for setup.py, e.g. petstore-api
protected boolean hasModelsToImport = Boolean.FALSE;
protected String mapNumberTo = "Union[StrictFloat, StrictInt]";
protected Map regexModifiers;
private Map schemaKeyToModelNameCache = new HashMap<>();
// map of set (model imports)
private HashMap> circularImports = new HashMap<>();
// map of codegen models
private HashMap codegenModelMap = new HashMap<>();
public AbstractPythonCodegen() {
super();
modifyFeatureSet(features -> features.securityFeatures(EnumSet.of(
SecurityFeature.BasicAuth,
SecurityFeature.BearerToken,
SecurityFeature.ApiKey,
SecurityFeature.OAuth2_Implicit
)));
// from https://docs.python.org/3/reference/lexical_analysis.html#keywords
setReservedWordsLowerCase(
Arrays.asList(
// pydantic
"field",
// local variable name used in API methods (endpoints)
"all_params", "resource_path", "path_params", "query_params",
"header_params", "form_params", "local_var_files", "body_params", "auth_settings",
// @property
"property",
// typing keywords
"schema", "base64", "json",
"date", "float",
// python reserved words
"and", "del", "from", "not", "while", "as", "elif", "global", "or", "with",
"assert", "else", "if", "pass", "yield", "break", "except", "import",
"print", "class", "exec", "in", "raise", "continue", "finally", "is",
"return", "def", "for", "lambda", "try", "self", "nonlocal", "None", "True",
"False", "async", "await"));
languageSpecificPrimitives.clear();
languageSpecificPrimitives.add("int");
languageSpecificPrimitives.add("float");
languageSpecificPrimitives.add("list");
languageSpecificPrimitives.add("dict");
languageSpecificPrimitives.add("List");
languageSpecificPrimitives.add("Dict");
languageSpecificPrimitives.add("bool");
languageSpecificPrimitives.add("str");
languageSpecificPrimitives.add("datetime");
languageSpecificPrimitives.add("date");
languageSpecificPrimitives.add("object");
// TODO file and binary is mapped as `file`
languageSpecificPrimitives.add("file");
languageSpecificPrimitives.add("bytes");
typeMapping.clear();
typeMapping.put("integer", "int");
typeMapping.put("float", "float");
typeMapping.put("number", "float");
typeMapping.put("long", "int");
typeMapping.put("double", "float");
typeMapping.put("array", "list");
typeMapping.put("set", "list");
typeMapping.put("map", "dict");
typeMapping.put("boolean", "bool");
typeMapping.put("string", "str");
typeMapping.put("date", "date");
typeMapping.put("DateTime", "datetime");
typeMapping.put("object", "object");
typeMapping.put("AnyType", "object");
typeMapping.put("file", "file");
// TODO binary should be mapped to byte array
// mapped to String as a workaround
typeMapping.put("binary", "str");
typeMapping.put("ByteArray", "str");
// map uuid to string for the time being
typeMapping.put("UUID", "str");
typeMapping.put("URI", "str");
typeMapping.put("null", "none_type");
regexModifiers = new HashMap();
regexModifiers.put('i', "IGNORECASE");
regexModifiers.put('l', "LOCALE");
regexModifiers.put('m', "MULTILINE");
regexModifiers.put('s', "DOTALL");
regexModifiers.put('u', "UNICODE");
regexModifiers.put('x', "VERBOSE");
}
@Override
public void processOpts() {
super.processOpts();
if (StringUtils.isEmpty(System.getenv("PYTHON_POST_PROCESS_FILE"))) {
LOGGER.info("Environment variable PYTHON_POST_PROCESS_FILE not defined so the Python code may not be properly formatted. To define it, try 'export PYTHON_POST_PROCESS_FILE=\"/usr/local/bin/yapf -i\"' (Linux/Mac)");
LOGGER.info("NOTE: To enable file post-processing, 'enablePostProcessFile' must be set to `true` (--enable-post-process-file for CLI).");
} else if (!this.isEnablePostProcessFile()) {
LOGGER.info("Warning: Environment variable 'PYTHON_POST_PROCESS_FILE' is set but file post-processing is not enabled. To enable file post-processing, 'enablePostProcessFile' must be set to `true` (--enable-post-process-file for CLI).");
}
}
@Override
public String escapeReservedWord(String name) {
if (this.reservedWordsMappings().containsKey(name)) {
return this.reservedWordsMappings().get(name);
}
return "_" + name;
}
/**
* Return the default value of the property
*
* @param p OpenAPI property object
* @return string presentation of the default value of the property
*/
@Override
public String toDefaultValue(Schema p) {
// If the Schema is a $ref, get the default value from the reference.
String ref = ModelUtils.getSimpleRef(p.get$ref());
if (ref != null) {
Schema referencedSchema = ModelUtils.getSchemas(this.openAPI).get(ref);
if (referencedSchema != null) {
String defaultValue = toDefaultValue(referencedSchema);
if (defaultValue != null) {
return defaultValue;
}
// No default was found for the $ref, so see if one has been defined locally.
}
}
if (ModelUtils.isBooleanSchema(p)) {
if (p.getDefault() != null) {
if (!Boolean.valueOf(p.getDefault().toString()))
return "False";
else
return "True";
}
} else if (ModelUtils.isDateSchema(p)) {
// TODO
} else if (ModelUtils.isDateTimeSchema(p)) {
// TODO
} else if (ModelUtils.isNumberSchema(p)) {
if (p.getDefault() != null) {
return p.getDefault().toString();
}
} else if (ModelUtils.isIntegerSchema(p)) {
if (p.getDefault() != null) {
return p.getDefault().toString();
}
} else if (ModelUtils.isEnumSchema(p)) {
// Enum must come before string to use enum reference!
if (p.getDefault() != null) {
String defaultValue = String.valueOf(p.getDefault());
if (defaultValue != null) {
return defaultValue;
}
}
} else if (ModelUtils.isStringSchema(p)) {
if (p.getDefault() != null) {
String defaultValue = String.valueOf(p.getDefault());
if (defaultValue != null) {
defaultValue = defaultValue.replace("\\", "\\\\")
.replace("'", "\'");
if (Pattern.compile("\r\n|\r|\n").matcher(defaultValue).find()) {
return "'''" + defaultValue + "'''";
} else {
return "'" + defaultValue + "'";
}
}
}
} else if (ModelUtils.isArraySchema(p)) {
if (p.getDefault() != null) {
return p.getDefault().toString();
} else {
return null;
}
}
return null;
}
@Override
public String toVarName(String name) {
// obtain the name from nameMapping directly if provided
if (nameMapping.containsKey(name)) {
return nameMapping.get(name);
}
// sanitize name
name = sanitizeName(name); // FIXME: a parameter should not be assigned. Also declare the methods parameters as 'final'.
// remove dollar sign
name = name.replace("$", "");
// if it's all upper case, convert to lower case
if (name.matches("^[A-Z_]*$")) {
name = name.toLowerCase(Locale.ROOT);
}
// underscore the variable name
// petId => pet_id
name = underscore(name);
// remove leading underscore
name = name.replaceAll("^_*", "");
// for reserved word or word starting with number, append _
if (isReservedWord(name) || name.matches("^\\d.*")) {
name = escapeReservedWord(name);
}
return name;
}
@Override
public String toRegularExpression(String pattern) {
return addRegularExpressionDelimiter(pattern);
}
@Override
public String toParamName(String name) {
// obtain the name from parameterNameMapping directly if provided
if (parameterNameMapping.containsKey(name)) {
return parameterNameMapping.get(name);
}
// to avoid conflicts with 'callback' parameter for async call
if ("callback".equals(name)) {
return "param_callback";
}
// should be the same as variable name
return toVarName(name);
}
@Override
public String toOperationId(String operationId) {
// throw exception if method name is empty (should not occur as an auto-generated method name will be used)
if (StringUtils.isEmpty(operationId)) {
throw new RuntimeException("Empty method name (operationId) not allowed");
}
// method name cannot use reserved keyword, e.g. return
if (isReservedWord(operationId)) {
LOGGER.warn("{} (reserved word) cannot be used as method name. Renamed to {}", operationId, underscore(sanitizeName("call_" + operationId)));
operationId = "call_" + operationId;
}
// operationId starts with a number
if (operationId.matches("^\\d.*")) {
LOGGER.warn("{} (starting with a number) cannot be used as method name. Renamed to {}", operationId, underscore(sanitizeName("call_" + operationId)));
operationId = "call_" + operationId;
}
return underscore(sanitizeName(operationId));
}
@Override
public String escapeQuotationMark(String input) {
// remove ' to avoid code injection
return input.replace("'", "");
}
@Override
public String escapeUnsafeCharacters(String input) {
// remove multiline comment
return input.replace("'''", "'_'_'");
}
@Override
public void postProcessFile(File file, String fileType) {
super.postProcessFile(file, fileType);
if (file == null) {
return;
}
String pythonPostProcessFile = System.getenv("PYTHON_POST_PROCESS_FILE");
if (StringUtils.isEmpty(pythonPostProcessFile)) {
return; // skip if PYTHON_POST_PROCESS_FILE env variable is not defined
}
// only process files with py extension
if ("py".equals(FilenameUtils.getExtension(file.toString()))) {
this.executePostProcessor(new String[] {pythonPostProcessFile, file.toString()});
}
}
@Override
public String toExampleValue(Schema schema) {
return toExampleValueRecursive(schema, new ArrayList<>(), 5);
}
private String toExampleValueRecursive(Schema schema, List includedSchemas, int indentation) {
boolean cycleFound = includedSchemas.stream().filter(s -> schema.equals(s)).count() > 1;
if (cycleFound) {
return "";
}
String indentationString = "";
for (int i = 0; i < indentation; i++) indentationString += " ";
String example = null;
if (schema.getExample() != null) {
example = schema.getExample().toString();
}
if (ModelUtils.isNullType(schema) && null != example) {
// The 'null' type is allowed in OAS 3.1 and above. It is not supported by OAS 3.0.x,
// though this tooling supports it.
return "None";
}
// correct "true"s into "True"s, since super.toExampleValue uses "toString()" on Java booleans
if (ModelUtils.isBooleanSchema(schema) && null != example) {
if ("false".equalsIgnoreCase(example)) example = "False";
else example = "True";
}
// correct "'"s into "'"s after toString()
if (ModelUtils.isStringSchema(schema) && schema.getDefault() != null && !ModelUtils.isDateSchema(schema) && !ModelUtils.isDateTimeSchema(schema)) {
example = String.valueOf(schema.getDefault());
}
if (StringUtils.isNotBlank(example) && !"null".equals(example)) {
if (ModelUtils.isStringSchema(schema)) {
example = "'" + example + "'";
}
return example;
}
if (schema.getEnum() != null && !schema.getEnum().isEmpty()) {
// Enum case:
example = schema.getEnum().get(0).toString();
if (ModelUtils.isStringSchema(schema)) {
example = "'" + escapeTextInSingleQuotes(example) + "'";
}
if (null == example)
LOGGER.warn("Empty enum. Cannot built an example!");
return example;
} else if (null != schema.get$ref()) {
// $ref case:
Map allDefinitions = ModelUtils.getSchemas(this.openAPI);
String ref = ModelUtils.getSimpleRef(schema.get$ref());
if (allDefinitions != null) {
Schema refSchema = allDefinitions.get(ref);
if (null == refSchema) {
return "None";
} else {
String refTitle = refSchema.getTitle();
if (StringUtils.isBlank(refTitle) || "null".equals(refTitle)) {
refSchema.setTitle(ref);
}
if (StringUtils.isNotBlank(schema.getTitle()) && !"null".equals(schema.getTitle())) {
includedSchemas.add(schema);
}
return toExampleValueRecursive(refSchema, includedSchemas, indentation);
}
} else {
LOGGER.warn("allDefinitions not defined in toExampleValue!\n");
}
}
if (ModelUtils.isDateSchema(schema)) {
example = "datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date()";
return example;
} else if (ModelUtils.isDateTimeSchema(schema)) {
example = "datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f')";
return example;
} else if (ModelUtils.isBinarySchema(schema)) {
example = "bytes(b'blah')";
return example;
} else if (ModelUtils.isByteArraySchema(schema)) {
example = "YQ==";
} else if (ModelUtils.isStringSchema(schema)) {
// a BigDecimal:
if ("Number".equalsIgnoreCase(schema.getFormat())) {
return "1";
}
if (StringUtils.isNotBlank(schema.getPattern())) {
String pattern = schema.getPattern();
RgxGen rgxGen = new RgxGen(patternCorrection(pattern));
// this seed makes it so if we have [a-z] we pick a
Random random = new Random(18);
String sample = rgxGen.generate(random);
// omit leading / and trailing /, omit trailing /i
Pattern valueExtractor = Pattern.compile("^/\\^?(.+?)\\$?/.?$");
Matcher m = valueExtractor.matcher(sample);
if (m.find()) {
example = m.group(m.groupCount());
} else {
example = sample;
}
}
if (example == null) {
example = "";
}
int len = 0;
if (null != schema.getMinLength()) {
len = schema.getMinLength().intValue();
if (len < 1) {
example = "";
} else {
for (int i = 0; i < len; i++) example += i;
}
}
} else if (ModelUtils.isIntegerSchema(schema)) {
if (schema.getMinimum() != null)
example = schema.getMinimum().toString();
else
example = "56";
} else if (ModelUtils.isNumberSchema(schema)) {
if (schema.getMinimum() != null)
example = schema.getMinimum().toString();
else
example = "1.337";
} else if (ModelUtils.isBooleanSchema(schema)) {
example = "True";
} else if (ModelUtils.isArraySchema(schema)) {
if (StringUtils.isNotBlank(schema.getTitle()) && !"null".equals(schema.getTitle())) {
includedSchemas.add(schema);
}
example = "[\n" + indentationString + toExampleValueRecursive(ModelUtils.getSchemaItems(schema), includedSchemas, indentation + 1) + "\n" + indentationString + "]";
} else if (ModelUtils.isMapSchema(schema)) {
if (StringUtils.isNotBlank(schema.getTitle()) && !"null".equals(schema.getTitle())) {
includedSchemas.add(schema);
}
Object additionalObject = schema.getAdditionalProperties();
if (additionalObject instanceof Schema) {
Schema additional = (Schema) additionalObject;
String theKey = "'key'";
if (additional.getEnum() != null && !additional.getEnum().isEmpty()) {
theKey = additional.getEnum().get(0).toString();
if (ModelUtils.isStringSchema(additional)) {
theKey = "'" + escapeTextInSingleQuotes(theKey) + "'";
}
}
example = "{\n" + indentationString + theKey + " : " + toExampleValueRecursive(additional, includedSchemas, indentation + 1) + "\n" + indentationString + "}";
} else {
example = "{ }";
}
} else if (ModelUtils.isObjectSchema(schema)) {
if (StringUtils.isBlank(schema.getTitle())) {
example = "None";
return example;
}
// I remove any property that is a discriminator, since it is not well supported by the python generator
String toExclude = null;
if (schema.getDiscriminator() != null) {
toExclude = schema.getDiscriminator().getPropertyName();
}
example = packageName + ".models." + underscore(schema.getTitle()) + "." + schema.getTitle() + "(";
// if required only:
// List reqs = schema.getRequired();
// if required and optionals
List reqs = new ArrayList<>();
if (schema.getProperties() != null && !schema.getProperties().isEmpty()) {
for (Object toAdd : schema.getProperties().keySet()) {
reqs.add((String) toAdd);
}
Map properties = schema.getProperties();
Set propkeys = null;
if (properties != null) propkeys = properties.keySet();
if (toExclude != null && reqs.contains(toExclude)) {
reqs.remove(toExclude);
}
for (String toRemove : includedSchemas.stream().map(Schema::getTitle).collect(Collectors.toList())) {
if (reqs.contains(toRemove)) {
reqs.remove(toRemove);
}
}
if (StringUtils.isNotBlank(schema.getTitle()) && !"null".equals(schema.getTitle())) {
includedSchemas.add(schema);
}
if (null != schema.getRequired()) for (Object toAdd : schema.getRequired()) {
reqs.add((String) toAdd);
}
if (null != propkeys) for (String propname : propkeys) {
Schema schema2 = properties.get(propname);
if (reqs.contains(propname)) {
String refTitle = schema2.getTitle();
if (StringUtils.isBlank(refTitle) || "null".equals(refTitle)) {
schema2.setTitle(propname);
}
example += "\n" + indentationString + underscore(propname) + " = " +
toExampleValueRecursive(schema2, includedSchemas, indentation + 1) + ", ";
}
}
}
example += ")";
} else {
LOGGER.debug("Type {} not handled properly in toExampleValue", schema.getType());
}
if (ModelUtils.isStringSchema(schema)) {
example = "'" + escapeTextInSingleQuotes(example) + "'";
}
return example;
}
@Override
public void setParameterExampleValue(CodegenParameter p) {
String example;
if (p.defaultValue == null) {
example = p.example;
} else {
p.example = p.defaultValue;
return;
}
String type = p.baseType;
if (type == null) {
type = p.dataType;
}
if ("String".equalsIgnoreCase(type) || "str".equalsIgnoreCase(type)) {
if (example == null) {
example = p.paramName + "_example";
}
example = "'" + escapeTextInSingleQuotes(example) + "'";
} else if ("Integer".equals(type) || "int".equals(type)) {
if (example == null) {
example = "56";
}
} else if ("Float".equalsIgnoreCase(type) || "Double".equalsIgnoreCase(type)) {
if (example == null) {
example = "3.4";
}
} else if ("BOOLEAN".equalsIgnoreCase(type) || "bool".equalsIgnoreCase(type)) {
if (example == null) {
example = "True";
}
} else if ("file".equalsIgnoreCase(type)) {
if (example == null) {
example = "/path/to/file";
}
example = "'" + escapeTextInSingleQuotes(example) + "'";
} else if ("Date".equalsIgnoreCase(type)) {
if (example == null) {
example = "2013-10-20";
}
example = "'" + escapeTextInSingleQuotes(example) + "'";
} else if ("DateTime".equalsIgnoreCase(type)) {
if (example == null) {
example = "2013-10-20T19:20:30+01:00";
}
example = "'" + escapeTextInSingleQuotes(example) + "'";
} else if (!languageSpecificPrimitives.contains(type)) {
// type is a model class, e.g. User
example = this.packageName + "." + type + "()";
} else {
LOGGER.debug("Type {} not handled properly in setParameterExampleValue", type);
}
if (example == null) {
example = "None";
} else if (Boolean.TRUE.equals(p.isArray)) {
example = "[" + example + "]";
} else if (Boolean.TRUE.equals(p.isMap)) {
example = "{'key': " + example + "}";
}
p.example = example;
}
@Override
public void setParameterExampleValue(CodegenParameter codegenParameter, Parameter parameter) {
Schema schema = parameter.getSchema();
if (parameter.getExample() != null) {
codegenParameter.example = parameter.getExample().toString();
} else if (parameter.getExamples() != null && !parameter.getExamples().isEmpty()) {
Example example = parameter.getExamples().values().iterator().next();
if (example.getValue() != null) {
codegenParameter.example = example.getValue().toString();
}
} else if (schema != null && schema.getExample() != null) {
codegenParameter.example = schema.getExample().toString();
}
setParameterExampleValue(codegenParameter);
}
@Override
public String sanitizeTag(String tag) {
return sanitizeName(tag);
}
public String patternCorrection(String pattern) {
// Java does not recognize starting and ending forward slashes and mode modifiers
// It considers them as characters with no special meaning and tries to find them in the match string
boolean checkEnding = pattern.endsWith("/i") || pattern.endsWith("/g") || pattern.endsWith("/m");
if (checkEnding) pattern = pattern.substring(0, pattern.length() - 2);
if (pattern.endsWith("/")) pattern = pattern.substring(0, pattern.length() - 1);
if (pattern.startsWith("/")) pattern = pattern.substring(1);
return pattern;
}
public void setPackageName(String packageName) {
this.packageName = packageName;
additionalProperties.put(CodegenConstants.PACKAGE_NAME, this.packageName);
}
@Override
public String getTypeDeclaration(Schema p) {
p = ModelUtils.unaliasSchema(openAPI, p);
if (ModelUtils.isArraySchema(p)) {
Schema inner = ModelUtils.getSchemaItems(p);
return getSchemaType(p) + "[" + getCollectionItemTypeDeclaration(inner) + "]";
} else if (ModelUtils.isMapSchema(p)) {
Schema inner = ModelUtils.getAdditionalProperties(p);
return getSchemaType(p) + "[str, " + getCollectionItemTypeDeclaration(inner) + "]";
}
String openAPIType = getSchemaType(p);
if (typeMapping.containsKey(openAPIType)) {
return typeMapping.get(openAPIType);
}
if (languageSpecificPrimitives.contains(openAPIType)) {
return openAPIType;
}
return toModelName(openAPIType);
}
private String getCollectionItemTypeDeclaration(Schema inner) {
String innerDeclaration = getTypeDeclaration(inner);
if (Boolean.TRUE.equals(inner.getNullable())) {
innerDeclaration = "Optional[" + innerDeclaration + "]";
}
return innerDeclaration;
}
@Override
public String getSchemaType(Schema p) {
String openAPIType = super.getSchemaType(p);
String type;
if (openAPIType == null) {
LOGGER.error("OpenAPI Type for {} is null. Default to UNKNOWN_OPENAPI_TYPE instead.", p.getName());
openAPIType = "UNKNOWN_OPENAPI_TYPE";
}
if (typeMapping.containsKey(openAPIType)) {
type = typeMapping.get(openAPIType);
if (type != null) {
return type;
}
} else {
type = openAPIType;
}
return toModelName(type);
}
@Override
public String toModelName(String name) {
// obtain the name from modelNameMapping directly if provided
if (modelNameMapping.containsKey(name)) {
return modelNameMapping.get(name);
}
// check if schema-mapping has a different model for this class, so we can use it
// instead of the auto-generated one.
if (schemaMapping.containsKey(name)) {
return schemaMapping.get(name);
}
// memoization
String origName = name;
if (schemaKeyToModelNameCache.containsKey(origName)) {
return schemaKeyToModelNameCache.get(origName);
}
String sanitizedName = sanitizeName(name); // FIXME: a parameter should not be assigned. Also declare the methods parameters as 'final'.
// remove dollar sign
sanitizedName = sanitizedName.replace("$", "");
// remove whitespace
sanitizedName = sanitizedName.replaceAll("\\s+", "");
String nameWithPrefixSuffix = sanitizedName;
if (!StringUtils.isEmpty(modelNamePrefix)) {
// add '_' so that model name can be camelized correctly
nameWithPrefixSuffix = modelNamePrefix + "_" + nameWithPrefixSuffix;
}
if (!StringUtils.isEmpty(modelNameSuffix)) {
// add '_' so that model name can be camelized correctly
nameWithPrefixSuffix = nameWithPrefixSuffix + "_" + modelNameSuffix;
}
// camelize the model name
// phone_number => PhoneNumber
String camelizedName = camelize(nameWithPrefixSuffix);
// model name cannot use reserved keyword, e.g. return
if (isReservedWord(camelizedName)) {
String modelName = "Model" + camelizedName; // e.g. return => ModelReturn (after camelize)
LOGGER.warn("{} (reserved word) cannot be used as model name. Renamed to {}", camelizedName, modelName);
schemaKeyToModelNameCache.put(origName, modelName);
return modelName;
}
// model name starts with number
if (camelizedName.matches("^\\d.*")) {
String modelName = "Model" + camelizedName; // e.g. return => ModelReturn (after camelize)
LOGGER.warn("{} (model name starts with number) cannot be used as model name. Renamed to {}", camelizedName, modelName);
schemaKeyToModelNameCache.put(origName, modelName);
return modelName;
}
schemaKeyToModelNameCache.put(origName, camelizedName);
return camelizedName;
}
@Override
public String toModelFilename(String name) {
// underscore the model file name
// PhoneNumber => phone_number
return underscore(dropDots(toModelName(name)));
}
@Override
public String toModelTestFilename(String name) {
return "test_" + toModelFilename(name);
}
@Override
public String toApiFilename(String name) {
// e.g. PhoneNumberApi.py => phone_number_api.py
return underscore(toApiName(name));
}
@Override
public String toApiTestFilename(String name) {
return "test_" + toApiFilename(name);
}
@Override
public String toApiName(String name) {
return super.toApiName(name);
}
@Override
public String toApiVarName(String name) {
return underscore(toApiName(name));
}
protected static String dropDots(String str) {
return str.replaceAll("\\.", "_");
}
@Override
public GeneratorLanguage generatorLanguage() {
return GeneratorLanguage.PYTHON;
}
@Override
public Map postProcessAllModels(Map objs) {
final Map processed = super.postProcessAllModels(objs);
for (Map.Entry entry : objs.entrySet()) {
// create hash map of codegen model
CodegenModel cm = ModelUtils.getModelByName(entry.getKey(), objs);
codegenModelMap.put(cm.classname, ModelUtils.getModelByName(entry.getKey(), objs));
}
// create circular import
for (String m : codegenModelMap.keySet()) {
createImportMapOfSet(m, codegenModelMap);
}
for (Map.Entry entry : processed.entrySet()) {
entry.setValue(postProcessModelsMap(entry.getValue()));
}
return processed;
}
private ModelsMap postProcessModelsMap(ModelsMap objs) {
// process enum in models
objs = postProcessModelsEnum(objs);
// TODO: migrate almost (all?) everything to the `PythonImports` class.
TreeSet modelImports = new TreeSet<>();
TreeSet postponedModelImports = new TreeSet<>();
for (ModelMap m : objs.getModels()) {
TreeSet exampleImports = new TreeSet<>();
TreeSet postponedExampleImports = new TreeSet<>();
List readOnlyFields = new ArrayList<>();
hasModelsToImport = false;
int property_count = 1;
PythonImports moduleImports = new PythonImports();
CodegenModel model = m.getModel();
PydanticType pydantic = new PydanticType(
modelImports,
exampleImports,
postponedModelImports,
postponedExampleImports,
moduleImports,
model.classname
);
// handle null type in oneOf
if (model.getComposedSchemas() != null && model.getComposedSchemas().getOneOf() != null
&& !model.getComposedSchemas().getOneOf().isEmpty()) {
int index = 0;
List oneOfs = model.getComposedSchemas().getOneOf();
for (CodegenProperty oneOf : oneOfs) {
if ("none_type".equals(oneOf.dataType)) {
oneOfs.remove(index);
break; // return earlier assuming there's only 1 null type defined
}
index++;
}
}
List codegenProperties = null;
if (!model.oneOf.isEmpty()) { // oneOfValidationError
codegenProperties = model.getComposedSchemas().getOneOf();
moduleImports.add("typing", "Any");
moduleImports.add("typing", "List");
moduleImports.add("pydantic", "Field");
moduleImports.add("pydantic", "StrictStr");
moduleImports.add("pydantic", "ValidationError");
moduleImports.add("pydantic", "field_validator");
} else if (!model.anyOf.isEmpty()) { // anyOF
codegenProperties = model.getComposedSchemas().getAnyOf();
moduleImports.add("pydantic", "Field");
moduleImports.add("pydantic", "StrictStr");
moduleImports.add("pydantic", "ValidationError");
moduleImports.add("pydantic", "field_validator");
} else { // typical model
codegenProperties = model.vars;
// if super class
if (model.getDiscriminator() != null && model.getDiscriminator().getMappedModels() != null) {
moduleImports.add("typing", "Union");
moduleImports.add("importlib", "import_module");
}
}
if (!model.allOf.isEmpty()) { // allOf
for (CodegenProperty cp : model.allVars) {
if (!cp.isPrimitiveType || cp.isModel) {
if (cp.isArray || cp.isMap){ // if array or map
modelImports.add(cp.items.dataType);
}else{ // if model
modelImports.add(cp.getDataType());
}
}
}
}
// if model_generic.mustache is used
if (model.oneOf.isEmpty() && model.anyOf.isEmpty() && !model.isEnum) {
moduleImports.add("typing", "ClassVar");
moduleImports.add("typing", "Dict");
moduleImports.add("typing", "Any");
if(this.disallowAdditionalPropertiesIfNotPresent || model.isAdditionalPropertiesTrue) {
moduleImports.add("typing", "List");
}
}
// if pydantic model
if (!model.isEnum) {
moduleImports.add("pydantic", "ConfigDict");
}
//loop through properties/schemas to set up typing, pydantic
for (CodegenProperty cp : codegenProperties) {
// is readOnly?
if (cp.isReadOnly) {
readOnlyFields.add(cp.name);
}
String typing = pydantic.generatePythonType(cp);
cp.vendorExtensions.put("x-py-typing", typing);
// setup x-py-name for each oneOf/anyOf schema
if (!model.oneOf.isEmpty()) { // oneOf
cp.vendorExtensions.put("x-py-name", String.format(Locale.ROOT, "oneof_schema_%d_validator", property_count++));
} else if (!model.anyOf.isEmpty()) { // anyOf
cp.vendorExtensions.put("x-py-name", String.format(Locale.ROOT, "anyof_schema_%d_validator", property_count++));
}
}
// add parent model to import
if (!StringUtils.isEmpty(model.parent)) {
modelImports.add(model.parent);
} else if (!model.isEnum) {
moduleImports.add("pydantic", "BaseModel");
}
// set enum type in extensions and update `name` in enumVars
if (model.isEnum) {
for (Map enumVars : (List>) model.getAllowableValues().get("enumVars")) {
if ((Boolean) enumVars.get("isString")) {
model.vendorExtensions.putIfAbsent("x-py-enum-type", "str");
// update `name`, e.g.
enumVars.put("name", toEnumVariableName((String) enumVars.get("value"), "str"));
} else {
model.vendorExtensions.putIfAbsent("x-py-enum-type", "int");
// Do not overwrite the variable name if already set through x-enum-varnames
if (model.vendorExtensions.get("x-enum-varnames") == null) {
enumVars.put("name", toEnumVariableName((String) enumVars.get("value"), "int"));
}
}
}
}
// set the extensions if the key is absent
model.getVendorExtensions().putIfAbsent("x-py-readonly", readOnlyFields);
// remove the items of postponedModelImports in modelImports to avoid circular imports error
if (!modelImports.isEmpty() && !postponedModelImports.isEmpty()){
modelImports.removeAll(postponedModelImports);
}
// import models one by one
if (!modelImports.isEmpty()) {
Set modelsToImport = new TreeSet<>();
for (String modelImport : modelImports) {
if (modelImport.equals(model.classname)) {
// skip self import
continue;
}
modelsToImport.add("from " + packageName + ".models." + underscore(modelImport) + " import " + modelImport);
}
if (!modelsToImport.isEmpty()) {
model.getVendorExtensions().putIfAbsent("x-py-model-imports", modelsToImport);
}
}
if (!moduleImports.isEmpty()) {
model.getVendorExtensions().putIfAbsent("x-py-other-imports", moduleImports.exports());
}
if (!postponedModelImports.isEmpty()) {
Set modelsToImport = new TreeSet<>();
for (String modelImport : postponedModelImports) {
if (modelImport.equals(model.classname)) {
// skip self import
continue;
}
modelsToImport.add("from " + packageName + ".models." + underscore(modelImport) + " import " + modelImport);
}
model.getVendorExtensions().putIfAbsent("x-py-postponed-model-imports", modelsToImport);
}
}
return objs;
}
/*
* Gets the pydantic type given a Codegen Property
*
* @param cp codegen property
* @param modelImports model imports
* @param exampleImports example imports
* @param postponedModelImports postponed model imports
* @param postponedExampleImports postponed example imports
* @param classname class name
* @return pydantic type
*
*/
private PythonType getPydanticType(CodegenProperty cp,
Set modelImports,
Set exampleImports,
Set postponedModelImports,
Set postponedExampleImports,
PythonImports moduleImports,
String classname) {
PydanticType pt = new PydanticType(
modelImports,
exampleImports,
postponedModelImports,
postponedExampleImports,
moduleImports,
classname
);
return pt.getType(cp);
}
public void setMapNumberTo(String mapNumberTo) {
if ("Union[StrictFloat, StrictInt]".equals(mapNumberTo)
|| "StrictFloat".equals(mapNumberTo)
|| "float".equals(mapNumberTo)) {
this.mapNumberTo = mapNumberTo;
} else {
throw new IllegalArgumentException("mapNumberTo value must be Union[StrictFloat, StrictInt], StrictFloat or float");
}
}
public String toEnumVariableName(String name, String datatype) {
if ("int".equals(datatype)) {
return "NUMBER_" + name.replace("-", "MINUS_");
}
// remove quote e.g. 'abc' => abc
if (name.startsWith("'") && name.endsWith("'")) {
name = name.substring(1, name.length() - 1);
}
if (name.length() == 0) {
return "EMPTY";
}
if (" ".equals(name)) {
return "SPACE";
}
if ("_".equals(name)) {
return "UNDERSCORE";
}
if (reservedWords.contains(name)) {
name = name.toUpperCase(Locale.ROOT);
} else if (((CharSequence) name).chars().anyMatch(character -> specialCharReplacements.keySet().contains(String.valueOf((char) character)))) {
name = underscore(escape(name, specialCharReplacements, Collections.singletonList("_"), "_")).toUpperCase(Locale.ROOT);
} else {
name = name.toUpperCase(Locale.ROOT);
}
name = name.replace(" ", "_");
name = name.replaceFirst("^_", "");
name = name.replaceFirst("_$", "");
if (name.matches("\\d.*")) {
name = "ENUM_" + name.toUpperCase(Locale.ROOT);
}
return name;
}
/**
* Update circularImports with the model name (key) and its imports gathered recursively
*
* @param modelName model name
* @param codegenModelMap a map of CodegenModel
*/
void createImportMapOfSet(String modelName, Map codegenModelMap) {
HashSet imports = new HashSet<>();
circularImports.put(modelName, imports);
CodegenModel cm = codegenModelMap.get(modelName);
if (cm == null) {
LOGGER.warn("Failed to lookup model in createImportMapOfSet: " + modelName);
return;
}
List codegenProperties = null;
if (cm.oneOf != null && !cm.oneOf.isEmpty()) { // oneOf
codegenProperties = cm.getComposedSchemas().getOneOf();
} else if (cm.anyOf != null && !cm.anyOf.isEmpty()) { // anyOF
codegenProperties = cm.getComposedSchemas().getAnyOf();
} else { // typical model
codegenProperties = cm.vars;
}
for (CodegenProperty cp : codegenProperties) {
String modelNameFromDataType = getModelNameFromDataType(cp);
if (modelNameFromDataType != null) { // model
imports.add(modelNameFromDataType); // update import
// go through properties or sub-schemas of the model recursively to identify more (model) import if any
updateImportsFromCodegenModel(modelNameFromDataType, codegenModelMap.get(modelNameFromDataType), imports);
}
}
}
/**
* Returns the model name (if any) from data type of codegen property.
* Returns null if it's not a model.
*
* @param cp Codegen property
* @return model name
*/
private String getModelNameFromDataType(CodegenProperty cp) {
if (cp.isArray) {
return getModelNameFromDataType(cp.items);
} else if (cp.isMap) {
return getModelNameFromDataType(cp.items);
} else if (!cp.isPrimitiveType || cp.isModel) {
return cp.getDataType();
} else {
return null;
}
}
/**
* Update set of imports from codegen model recursivly
*
* @param modelName model name
* @param cm codegen model
* @param imports set of imports
*/
public void updateImportsFromCodegenModel(String modelName, CodegenModel cm, Set imports) {
if (cm == null) {
LOGGER.warn("Failed to lookup model in createImportMapOfSet " + modelName);
return;
}
List codegenProperties = null;
if (cm.oneOf != null && !cm.oneOf.isEmpty()) { // oneOfValidationError
codegenProperties = cm.getComposedSchemas().getOneOf();
} else if (cm.anyOf != null && !cm.anyOf.isEmpty()) { // anyOF
codegenProperties = cm.getComposedSchemas().getAnyOf();
} else { // typical model
codegenProperties = cm.vars;
}
for (CodegenProperty cp : codegenProperties) {
String modelNameFromDataType = getModelNameFromDataType(cp);
if (modelNameFromDataType != null) { // model
if (modelName.equals(modelNameFromDataType)) { // self referencing
continue;
} else if (imports.contains(modelNameFromDataType)) { // circular import
continue;
} else {
imports.add(modelNameFromDataType); // update import
// go through properties of the model recursively to identify more (model) import if any
updateImportsFromCodegenModel(modelNameFromDataType, codegenModelMap.get(modelNameFromDataType), imports);
}
}
}
}
@Override
public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List allModels) {
hasModelsToImport = false;
TreeSet modelImports = new TreeSet<>();
TreeSet postponedModelImports = new TreeSet<>();
PythonImports moduleImports = new PythonImports();
OperationMap objectMap = objs.getOperations();
List operations = objectMap.getOperation();
for (CodegenOperation operation : operations) {
TreeSet exampleImports = new TreeSet<>(); // import for each operation to be show in sample code
TreeSet postponedExampleImports = new TreeSet<>(); // import for each operation to be show in sample code
List params = operation.allParams;
for (CodegenParameter cp : params) {
PydanticType pydantic = new PydanticType(
modelImports,
exampleImports,
postponedModelImports,
postponedExampleImports,
moduleImports,
null
);
String typing = pydantic.generatePythonType(cp);
cp.vendorExtensions.put("x-py-typing", typing);
}
// update typing import for operation return type
if (!StringUtils.isEmpty(operation.returnType)) {
// Not interested in the result, only in the update of the imports
getPydanticType(
operation.returnProperty,
modelImports,
exampleImports,
postponedModelImports,
postponedExampleImports,
moduleImports,
null
);
}
// update typing import for operation responses type
// only python-fastapi needs this at the moment
if (this instanceof PythonFastAPIServerCodegen) {
for (CodegenResponse response : operation.responses) {
// Not interested in the result, only in the update of the imports
getPydanticType(
response.returnProperty,
modelImports,
exampleImports,
postponedModelImports,
postponedExampleImports,
moduleImports,
null
);
}
}
// add import for code samples
// import models one by one
if (!exampleImports.isEmpty()) {
List imports = new ArrayList<>();
for (String exampleImport : exampleImports) {
imports.add("from " + packageName + ".models." + underscore(exampleImport) + " import " + exampleImport);
}
operation.vendorExtensions.put("x-py-example-import", imports);
}
if (!postponedExampleImports.isEmpty()) {
List imports = new ArrayList<>();
for (String exampleImport : postponedExampleImports) {
imports.add("from " + packageName + ".models." + underscore(exampleImport) + " import "
+ exampleImport);
}
operation.vendorExtensions.put("x-py-example-import", imports);
}
// Remove constant params from allParams list and add to constantParams
handleConstantParams(operation);
}
List> newImports = new ArrayList<>();
for (String importLine : moduleImports.exports()) {
Map item = new HashMap<>();
item.put("import", importLine);
newImports.add(item);
}
// import models one by one
if (!modelImports.isEmpty()) {
for (String modelImport : modelImports) {
Map item = new HashMap<>();
item.put("import", "from " + packageName + ".models." + underscore(modelImport) + " import " + modelImport);
newImports.add(item);
}
}
if (!postponedModelImports.isEmpty()) {
for (String modelImport : postponedModelImports) {
Map item = new HashMap<>();
item.put("import", "from " + packageName + ".models." + underscore(modelImport) + " import " + modelImport);
newImports.add(item);
}
}
// reset imports with newImports
objs.setImports(newImports);
return objs;
}
@Override
public void postProcessParameter(CodegenParameter parameter) {
postProcessPattern(parameter.pattern, parameter.vendorExtensions);
}
@Override
public void postProcessModelProperty(CodegenModel model, CodegenProperty property) {
postProcessPattern(property.pattern, property.vendorExtensions);
}
/*
* The OpenAPI pattern spec follows the Perl convention and style of modifiers. Python
* does not support this in as natural a way so it needs to convert it. See
* https://docs.python.org/2/howto/regex.html#compilation-flags for details.
*
* @param pattern (the String pattern to convert from python to Perl convention)
* @param vendorExtensions (list of custom x-* properties for extra functionality-see https://swagger.io/docs/specification/openapi-extensions/)
* @return void
* @throws IllegalArgumentException if pattern does not follow the Perl /pattern/modifiers convention
*
* Includes fix for issue #6675
*/
public void postProcessPattern(String pattern, Map vendorExtensions) {
if (pattern != null) {
int i = pattern.lastIndexOf('/');
// TOOD update the check below follow python convention
//Must follow Perl /pattern/modifiers convention
if (pattern.charAt(0) != '/' || i < 2) {
throw new IllegalArgumentException("Pattern must follow the Perl "
+ "/pattern/modifiers convention. " + pattern + " is not valid.");
}
String regex = pattern.substring(1, i).replace("'", "\\'");
List modifiers = new ArrayList();
for (char c : pattern.substring(i).toCharArray()) {
if (regexModifiers.containsKey(c)) {
String modifier = regexModifiers.get(c);
modifiers.add(modifier);
}
}
vendorExtensions.put("x-regex", regex.replace("\"", "\\\""));
vendorExtensions.put("x-pattern", pattern.replace("\"", "\\\""));
vendorExtensions.put("x-modifiers", modifiers);
}
}
@Override
public String addRegularExpressionDelimiter(String pattern) {
if (StringUtils.isEmpty(pattern)) {
return pattern;
}
if (!pattern.matches("^/.*")) {
// Perform a negative lookbehind on each `/` to ensure that it is escaped.
return "/" + pattern.replaceAll("(? typeParams;
private Map annotations;
private Map constraints;
private String defaultValue;
public PythonType() {
this(null);
}
public PythonType(String type) {
this.setType(type);
this.defaultValue = null;
this.typeParams = new ArrayList<>();
this.annotations = new HashMap<>();
this.constraints = new HashMap<>();
}
public PythonType setType(String type) {
this.type = type;
return this;
}
public PythonType setDefaultValue(boolean value) {
if (value) {
defaultValue = "True";
} else {
defaultValue = "False";
}
return this;
}
public PythonType setDefaultValue(Object value) {
defaultValue = value.toString();
return this;
}
public PythonType constrain(String name, String value) {
return constrain(name, value, true);
}
public PythonType constrain(String name, String value, boolean quote) {
if (quote) {
// TODO:jon proper quoting
value = "\"" + value + "\"";
}
constraints.put(name, value);
return this;
}
public PythonType constrain(String name, boolean value) {
if (value) {
constraints.put(name, "True");
} else {
constraints.put(name, "False");
}
return this;
}
public PythonType constrain(String name, Object value) {
constraints.put(name, value);
return this;
}
/* Annotate a field with extra information.
*
* Annotation are made to add extra information about a field.
*
* If the information you need to add is a type constraint (to make the
* type more specific), use `constrain` instead.
*/
public PythonType annotate(String name, String value) {
return annotate(name, value, true);
}
public PythonType annotate(String name, String value, boolean quote) {
if (quote) {
// TODO:jon proper quoting
value = "\"" + value + "\"";
}
annotations.put(name, value);
return this;
}
public PythonType annotate(String name, boolean value) {
if (value) {
annotations.put(name, "True");
} else {
annotations.put(name, "False");
}
return this;
}
public PythonType annotate(String name, Object value) {
annotations.put(name, value);
return this;
}
/* A "type param" is the parameter to a generic type (the `str` in `list[str]`).
*
* A Python type can have multiple type parameters: it assumes the
* Python type on which the type parameter is added to is a generic
* type.
*
* Type parameters can be as simple or as complex as needed. They are just
* another list of `PythonType`.
*/
public PythonType addTypeParam(PythonType typeParam) {
this.typeParams.add(typeParam);
return this;
}
/* The left-hand side of:
*
* my_field: TypeConstraint = TypeAnnotations
*
* A "type constraint" is a Python / Pydantic type, potentially
* annotated with extra constraints, such as "less than", "maximum
* number of items", etc.
*
* The Python / Pydantic type can be as expressive as needed:
*
* - it could simply be `str`
* - or something more complex like `Optional[List[Dict[str, List[int]]]]`.
*
* Note that the default value (if available) and/or the metadata about
* the field / variable being defined are *not* part of the
* constraints but part of the "type value".
*/
public String asTypeConstraint(PythonImports imports) {
return asTypeConstraint(imports, false);
}
/* Generate the Python type, constraints + annotations
*
* This should be mostly used to build the type definition for a
* function/method parameter, such as :
*
* def f(my_param: TypeConstrainWithAnnotations):
* ...
*
* Note that the default value is not managed here, but directly in
* the Mustache template.
*/
public String asTypeConstraintWithAnnotations(PythonImports imports) {
return asTypeConstraint(imports, true);
}
private String asTypeConstraint(PythonImports imports, boolean withAnnotations) {
String typeParam = "";
if (this.typeParams.size() > 0) {
List types = new ArrayList<>();
for (PythonType t : this.typeParams) {
types.add(t.asTypeConstraint(imports));
}
typeParam = "[" + StringUtils.join(types, ", ") + "]";
}
String currentType = this.type + typeParam;
// Build the parameters for the `Field`, possibly associated with
// the type definition.
// There can be no constraints nor annotations, in which case we
// simply won't build a Field object.
List fieldParams = new ArrayList<>();
for (Map.Entry entry: this.constraints.entrySet()) {
String ans = entry.getKey() + "=";
ans += entry.getValue().toString();
fieldParams.add(ans);
}
if (withAnnotations) {
for (Map.Entry entry: this.annotations.entrySet()) {
String ans = entry.getKey() + "=";
ans += entry.getValue().toString();
fieldParams.add(ans);
}
}
if (fieldParams.size() > 0) {
imports.add("pydantic", "Field");
imports.add("typing_extensions", "Annotated");
currentType = "Annotated[" + currentType + ", Field(" + StringUtils.join(fieldParams, ", ") + ")]";
}
return currentType;
}
/* The right-hand side of:
*
* my_field: TypeConstraint = TypeValue
*
* A "type value" is either:
*
* * The default value of a field, if no other information is available
* * A Pydantic `Field`, containing potentially the default value,
* plus all the extra metadata that defines what a field is (description, alias, etc.).
*
* Constraints on the type are *not* part of the "type value", but are part of the "type constraints".
*/
@Nullable
public String asTypeValue(PythonImports imports) {
String defaultValue = this.defaultValue;
if (this.annotations.size() > 0) {
String typeValue = "";
List ants = new ArrayList<>();
if (defaultValue != null) {
// Keep the default value first, if possible.
ants.add("default=" + defaultValue);
}
for (Map.Entry entry: this.annotations.entrySet()) {
String ans = entry.getKey() + "=";
ans += entry.getValue().toString();
ants.add(ans);
}
imports.add("pydantic", "Field");
typeValue = "Field(" + StringUtils.join(ants, ", ") + ")";
return typeValue;
}
return defaultValue;
}
}
/* Track the list of resources to imports from where.
*
* PythonImports are tracked as a set of modules to import from, and actual
* resources (classes, functions, etc.) to import.
*
* The same resource can be safely "imported" many times from the same
* module; during the rendering of the actual Python imports, duplicated
* entries will be automatically removed.
*
* */
class PythonImports {
private Map> imports;
public PythonImports() {
imports = new HashMap<>();
}
/* Add a new import:
*
* from $from import $what
*
*/
private void add(String from, String what) {
// Fetch the set of all the objects already imported from `from` (if any).
Set allImportsFrom = imports.get(from);
if (allImportsFrom == null) {
allImportsFrom = new TreeSet<>();
}
// Just one more thing to import from `from`.
allImportsFrom.add(what);
imports.put(from, allImportsFrom);
}
/* Export a list of import statements as:
*
* from $from import $what
*
*/
public Set exports() {
Set results = new TreeSet<>();
for (Map.Entry> entry : imports.entrySet()) {
String importLine = String.format(
Locale.ROOT, "from %s import %s",
entry.getKey(), StringUtils.join(entry.getValue(), ", "));
results.add(importLine);
}
return results;
}
public boolean isEmpty() {
return imports.isEmpty();
}
}
class PydanticType {
private Set modelImports;
private Set exampleImports;
private Set postponedModelImports;
private Set postponedExampleImports;
private PythonImports moduleImports;
private String classname;
public PydanticType(
Set modelImports,
Set exampleImports,
Set postponedModelImports,
Set postponedExampleImports,
PythonImports moduleImports,
String classname
) {
this.modelImports = modelImports;
this.exampleImports = exampleImports;
this.postponedModelImports = postponedModelImports;
this.postponedExampleImports = postponedExampleImports;
this.moduleImports = moduleImports;
this.classname = classname;
}
private PythonType arrayType(IJsonSchemaValidationProperties cp) {
PythonType pt = new PythonType();
if (cp.getMaxItems() != null) {
pt.constrain("max_length", cp.getMaxItems());
}
if (cp.getMinItems()!= null) {
pt.constrain("min_length", cp.getMinItems());
}
if (cp.getUniqueItems()) {
// A unique "array" is a set
// TODO: pydantic v2: Pydantic suggest to convert this to a set, but this has some implications:
// https://github.com/pydantic/pydantic-core/issues/296
// Also, having a set instead of list creates complications:
// random JSON serialization order, unable to easily serialize
// to JSON, etc.
//pt.setType("Set");
//moduleImports.add("typing", "Set");
pt.setType("List");
moduleImports.add("typing", "List");
} else {
pt.setType("List");
moduleImports.add("typing", "List");
}
pt.addTypeParam(collectionItemType(cp.getItems()));
return pt;
}
private PythonType collectionItemType(CodegenProperty itemCp) {
PythonType itemPt = getType(itemCp);
if (itemCp != null && !itemPt.type.equals("Any") && itemCp.isNullable) {
moduleImports.add("typing", "Optional");
PythonType opt = new PythonType("Optional");
opt.addTypeParam(itemPt);
itemPt = opt;
}
return itemPt;
}
private PythonType stringType(IJsonSchemaValidationProperties cp) {
if (cp.getHasValidation()) {
PythonType pt = new PythonType("str");
// e.g. constr(regex=r'/[a-z]/i', strict=True)
pt.constrain("strict", true);
if (cp.getMaxLength() != null) {
pt.constrain("max_length", cp.getMaxLength());
}
if (cp.getMinLength() != null) {
pt.constrain("min_length", cp.getMinLength());
}
if (cp.getPattern() != null) {
moduleImports.add("pydantic", "field_validator");
// use validator instead as regex doesn't support flags, e.g. IGNORECASE
//fieldCustomization.add(Locale.ROOT, String.format(Locale.ROOT, "regex=r'%s'", cp.getPattern()));
}
return pt;
} else {
if ("password".equals(cp.getFormat())) { // TDOO avoid using format, use `is` boolean flag instead
moduleImports.add("pydantic", "SecretStr");
return new PythonType("SecretStr");
} else {
moduleImports.add("pydantic", "StrictStr");
return new PythonType("StrictStr");
}
}
}
private PythonType mapType(IJsonSchemaValidationProperties cp) {
moduleImports.add("typing", "Dict");
PythonType pt = new PythonType("Dict");
pt.addTypeParam(new PythonType("str"));
pt.addTypeParam(collectionItemType(cp.getItems()));
return pt;
}
private PythonType numberType(IJsonSchemaValidationProperties cp) {
if (cp.getHasValidation()) {
PythonType floatt = new PythonType("float");
PythonType intt = new PythonType("int");
// e.g. confloat(ge=10, le=100, strict=True)
if (cp.getMaximum() != null) {
if (cp.getExclusiveMaximum()) {
floatt.constrain("lt", cp.getMaximum(), false);
intt.constrain("lt", (int) Math.ceil(Double.valueOf(cp.getMaximum()))); // e.g. < 7.59 => < 8
} else {
floatt.constrain("le", cp.getMaximum(), false);
intt.constrain("le", (int) Math.floor(Double.valueOf(cp.getMaximum()))); // e.g. <= 7.59 => <= 7
}
}
if (cp.getMinimum() != null) {
if (cp.getExclusiveMinimum()) {
floatt.constrain("gt", cp.getMinimum(), false);
intt.constrain("gt", (int) Math.floor(Double.valueOf(cp.getMinimum()))); // e.g. > 7.59 => > 7
} else {
floatt.constrain("ge", cp.getMinimum(), false);
intt.constrain("ge", (int) Math.ceil(Double.valueOf(cp.getMinimum()))); // e.g. >= 7.59 => >= 8
}
}
if (cp.getMultipleOf() != null) {
floatt.constrain("multiple_of", cp.getMultipleOf());
}
if ("Union[StrictFloat, StrictInt]".equals(mapNumberTo)) {
floatt.constrain("strict", true);
intt.constrain("strict", true);
moduleImports.add("typing", "Union");
PythonType pt = new PythonType("Union");
pt.addTypeParam(floatt);
pt.addTypeParam(intt);
return pt;
} else if ("StrictFloat".equals(mapNumberTo)) {
floatt.constrain("strict", true);
return floatt;
} else { // float
return floatt;
}
} else {
if ("Union[StrictFloat, StrictInt]".equals(mapNumberTo)) {
moduleImports.add("typing", "Union");
moduleImports.add("pydantic", "StrictFloat");
moduleImports.add("pydantic", "StrictInt");
PythonType pt = new PythonType("Union");
pt.addTypeParam(new PythonType("StrictFloat"));
pt.addTypeParam(new PythonType("StrictInt"));
return pt;
} else if ("StrictFloat".equals(mapNumberTo)) {
moduleImports.add("pydantic", "StrictFloat");
return new PythonType("StrictFloat");
} else {
return new PythonType("float");
}
}
}
private PythonType intType(IJsonSchemaValidationProperties cp) {
if (cp.getHasValidation()) {
PythonType pt = new PythonType("int");
// e.g. conint(ge=10, le=100, strict=True)
pt.constrain("strict", true);
if (cp.getMaximum() != null) {
if (cp.getExclusiveMaximum()) {
pt.constrain("lt", cp.getMaximum(), false);
} else {
pt.constrain("le", cp.getMaximum(), false);
}
}
if (cp.getMinimum() != null) {
if (cp.getExclusiveMinimum()) {
pt.constrain("gt", cp.getMinimum(), false);
} else {
pt.constrain("ge", cp.getMinimum(), false);
}
}
if (cp.getMultipleOf() != null) {
pt.constrain("multiple_of", cp.getMultipleOf());
}
return pt;
} else {
moduleImports.add("pydantic", "StrictInt");
return new PythonType("StrictInt");
}
}
private PythonType binaryType(IJsonSchemaValidationProperties cp) {
if (cp.getHasValidation()) {
PythonType bytest = new PythonType("bytes");
PythonType strt = new PythonType("str");
// e.g. conbytes(min_length=2, max_length=10)
bytest.constrain("strict", true);
strt.constrain("strict", true);
if (cp.getMaxLength() != null) {
bytest.constrain("max_length", cp.getMaxLength());
strt.constrain("max_length", cp.getMaxLength());
}
if (cp.getMinLength() != null) {
bytest.constrain("min_length", cp.getMinLength());
strt.constrain("min_length", cp.getMinLength());
}
if (cp.getPattern() != null) {
moduleImports.add("pydantic", "field_validator");
// use validator instead as regex doesn't support flags, e.g. IGNORECASE
//fieldCustomization.add(Locale.ROOT, String.format(Locale.ROOT, "regex=r'%s'", cp.getPattern()));
}
moduleImports.add("typing", "Union");
PythonType pt = new PythonType("Union");
pt.addTypeParam(bytest);
pt.addTypeParam(strt);
if (cp.getIsBinary()) {
moduleImports.add("typing", "Tuple");
PythonType tt = new PythonType("Tuple");
// this string is a filename, not a validated value
tt.addTypeParam(new PythonType("str"));
tt.addTypeParam(bytest);
pt.addTypeParam(tt);
}
return pt;
} else {
// same as above which has validation
moduleImports.add("pydantic", "StrictBytes");
moduleImports.add("pydantic", "StrictStr");
moduleImports.add("typing", "Union");
PythonType pt = new PythonType("Union");
pt.addTypeParam(new PythonType("StrictBytes"));
pt.addTypeParam(new PythonType("StrictStr"));
if (cp.getIsBinary()) {
moduleImports.add("typing", "Tuple");
PythonType tt = new PythonType("Tuple");
tt.addTypeParam(new PythonType("StrictStr"));
tt.addTypeParam(new PythonType("StrictBytes"));
pt.addTypeParam(tt);
}
return pt;
}
}
private PythonType boolType(IJsonSchemaValidationProperties cp) {
moduleImports.add("pydantic", "StrictBool");
return new PythonType("StrictBool");
}
private PythonType decimalType(IJsonSchemaValidationProperties cp) {
PythonType pt = new PythonType("Decimal");
moduleImports.add("decimal", "Decimal");
if (cp.getHasValidation()) {
// e.g. condecimal(ge=10, le=100, strict=True)
pt.constrain("strict", true);
if (cp.getMaximum() != null) {
if (cp.getExclusiveMaximum()) {
pt.constrain("gt", cp.getMaximum(), false);
} else {
pt.constrain("ge", cp.getMaximum(), false);
}
}
if (cp.getMinimum() != null) {
if (cp.getExclusiveMinimum()) {
pt.constrain("lt", cp.getMinimum(), false);
} else {
pt.constrain("le", cp.getMinimum(), false);
}
}
if (cp.getMultipleOf() != null) {
pt.constrain("multiple_of", cp.getMultipleOf());
}
}
return pt;
}
private PythonType anyType(IJsonSchemaValidationProperties cp) {
moduleImports.add("typing", "Any");
return new PythonType("Any");
}
private PythonType dateType(IJsonSchemaValidationProperties cp) {
if (cp.getIsDate()) {
moduleImports.add("datetime", "date");
}
if (cp.getIsDateTime()) {
moduleImports.add("datetime", "datetime");
}
return new PythonType(cp.getDataType());
}
private PythonType uuidType(IJsonSchemaValidationProperties cp) {
return new PythonType(cp.getDataType());
}
private PythonType modelType(IJsonSchemaValidationProperties cp) {
// add model prefix
hasModelsToImport = true;
modelImports.add(cp.getDataType());
exampleImports.add(cp.getDataType());
return new PythonType(cp.getDataType());
}
private PythonType fromCommon(IJsonSchemaValidationProperties cp) {
if (cp == null) {
// if codegen property (e.g. map/dict of undefined type) is null, default to string
LOGGER.warn("Codegen property is null (e.g. map/dict of undefined type). Default to typing.Any.");
moduleImports.add("typing", "Any");
return new PythonType("Any");
}
if (cp.getIsEnum()) {
moduleImports.add("pydantic", "field_validator");
}
if (cp.getIsArray()) {
return arrayType(cp);
} else if (cp.getIsMap() || cp.getIsFreeFormObject()) {
return mapType(cp);
} else if (cp.getIsString()) {
return stringType(cp);
} else if (cp.getIsNumber() || cp.getIsFloat() || cp.getIsDouble()) {
return numberType(cp);
} else if (cp.getIsInteger() || cp.getIsLong() || cp.getIsShort() || cp.getIsUnboundedInteger()) {
return intType(cp);
} else if (cp.getIsBinary() || cp.getIsByteArray()) {
return binaryType(cp);
} else if (cp.getIsBoolean()) {
return boolType(cp);
} else if (cp.getIsDecimal()) {
return decimalType(cp);
} else if (cp.getIsAnyType()) {
return anyType(cp);
} else if (cp.getIsDate() || cp.getIsDateTime()) {
return dateType(cp);
} else if (cp.getIsUuid()) {
return uuidType(cp);
}
return null;
}
public String generatePythonType(CodegenProperty cp) {
PythonType pt = this.getType(cp);
return this.finalizeType(cp, pt);
}
private PythonType getType(CodegenProperty cp) {
PythonType result = fromCommon(cp);
/* comment out the following since Literal requires python 3.8
also need to put cp.isEnum check after isArray, isMap check
if (cp.isEnum) {
// use Literal for inline enum
moduleImports.add("typing", "Literal");
List values = new ArrayList<>();
List> enumVars = (List>) cp.allowableValues.get("enumVars");
if (enumVars != null) {
for (Map enumVar : enumVars) {
values.add((String) enumVar.get("value"));
}
}
return String.format(Locale.ROOT, "%sEnum", cp.nameInPascalCase);
} else*/
if (result == null) {
// TODO: Cleanup
if (!cp.isPrimitiveType || cp.isModel) { // model
// skip import if it's a circular reference
if (classname == null) {
// for parameter model, import directly
hasModelsToImport = true;
modelImports.add(cp.getDataType());
exampleImports.add(cp.getDataType());
} else {
if (circularImports.containsKey(cp.getDataType())) {
if (circularImports.get(cp.getDataType()).contains(classname)) {
hasModelsToImport = true;
postponedModelImports.add(cp.getDataType());
postponedExampleImports.add(cp.getDataType());
// cp.getDataType() import map of set contains this model (classname), don't import
LOGGER.debug("Skipped importing {} in {} due to circular import.", cp.getDataType(), classname);
} else {
// not circular import, so ok to import it
hasModelsToImport = true;
modelImports.add(cp.getDataType());
exampleImports.add(cp.getDataType());
}
} else {
LOGGER.error("Failed to look up {} from the imports (map of set) of models.", cp.getDataType());
}
}
result = new PythonType(cp.getDataType());
} else {
throw new RuntimeException("Error! Codegen Property not yet supported in getPydanticType: " + cp);
}
}
return result;
}
private String finalizeType(CodegenProperty cp, PythonType pt) {
if (!cp.required || cp.isNullable) {
moduleImports.add("typing", "Optional");
PythonType opt = new PythonType("Optional");
opt.addTypeParam(pt);
pt = opt;
}
if (!StringUtils.isEmpty(cp.description)) { // has description
pt.annotate("description", cp.description);
}
// field
if (cp.baseName != null && !cp.baseName.equals(cp.name)) { // base name not the same as name
pt.annotate("alias", cp.baseName);
}
/* TODO review as example may break the build
if (!StringUtils.isEmpty(cp.getExample())) { // has example
fields.add(String.format(Locale.ROOT, "example=%s", cp.getExample()));
}*/
//String defaultValue = null;
if (!cp.required) { //optional
if (cp.defaultValue == null) {
pt.setDefaultValue("None");
} else {
if (cp.isArray || cp.isMap) {
// TODO handle default value for array/map
pt.setDefaultValue("None");
} else {
//defaultValue = ;
pt.setDefaultValue(cp.defaultValue);
}
}
}
String typeConstraint = pt.asTypeConstraint(moduleImports);
String typeValue = pt.asTypeValue(moduleImports);
if (typeValue == null) {
return typeConstraint;
} else {
return typeConstraint + " = " + typeValue;
}
}
public String generatePythonType(CodegenParameter cp) {
PythonType pt = this.getType(cp);
return this.finalizeType(cp, pt);
}
private PythonType getType(CodegenParameter cp) {
// TODO: cleanup
PythonType result = fromCommon(cp);
if (result == null) {
if (!cp.isPrimitiveType) {
// add model prefix
hasModelsToImport = true;
modelImports.add(cp.getDataType());
exampleImports.add(cp.getDataType());
result = new PythonType(cp.getDataType());
} else if (cp.getContent() != null) {
LinkedHashMap contents = cp.getContent();
for (String key : contents.keySet()) {
CodegenMediaType cmt = contents.get(key);
// TODO process the first one only at the moment
if (cmt != null)
// TODO: don't loop back to the deprecated getPydanticType method
return getPydanticType(cmt.getSchema(), modelImports, exampleImports, postponedModelImports, postponedExampleImports, moduleImports, classname);
}
throw new RuntimeException("Error! Failed to process getPydanticType when getting the content: " + cp);
} else {
throw new RuntimeException("Error! Codegen Parameter not yet supported in getPydanticType: " + cp);
}
}
return result;
}
private String finalizeType(CodegenParameter cp, PythonType pt) {
if (!cp.required || cp.isNullable) {
moduleImports.add("typing", "Optional");
PythonType opt = new PythonType("Optional");
opt.addTypeParam(pt);
pt = opt;
}
if (!StringUtils.isEmpty(cp.description)) { // has description
pt.annotate("description", cp.description);
}
/* TODO support example
if (!StringUtils.isEmpty(cp.getExample())) { // has example
fields.add(String.format(Locale.ROOT, "example=%s", cp.getExample()));
}*/
//return pt.asTypeConstraint(moduleImports);
return pt.asTypeConstraintWithAnnotations(moduleImports);
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy