深入解析datamodel-code-generator模块化使用方法-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00313/article/details/148601843

深入解析datamodel-code-generator模块化使用方法

datamodel-code-generator Pydantic model and dataclasses.dataclass generator for easy conversion of JSON, OpenAPI, JSON Schema, and YAML data sources. 项目地址: https://gitcode.com/gh_mirrors/da/datamodel-code-generator

datamodel-code-generator是一个强大的工具，不仅可以通过命令行使用，还能作为Python模块集成到你的项目中。本文将详细介绍如何以编程方式使用这个工具，帮助你更好地理解其内部工作机制。

安装准备

首先需要安装datamodel-code-generator及其依赖项：

pip install 'datamodel-code-generator[http]'

这个安装命令包含了处理HTTP请求所需的额外依赖，确保工具能够处理远程JSON Schema等场景。

基础使用方法

使用generate函数生成模型

datamodel_code_generator.generate函数是工具的核心接口，它提供了与命令行工具相同的功能，但可以通过Python代码直接调用。下面是一个完整的示例：

from pathlib import Path
from tempfile import TemporaryDirectory
from datamodel_code_generator import InputFileType, generate
from datamodel_code_generator import DataModelType

# 定义JSON Schema
json_schema = """{
    "type": "object",
    "properties": {
        "number": {"type": "number"},
        "street_name": {"type": "string"},
        "street_type": {"type": "string",
                        "enum": ["Street", "Avenue", "Boulevard"]
                        }
    }
}"""

# 使用临时目录存储生成的文件
with TemporaryDirectory() as temp_dir:
    output_path = Path(temp_dir) / 'model.py'
    
    # 调用generate函数
    generate(
        json_schema,
        input_file_type=InputFileType.JsonSchema,
        input_filename="example.json",
        output=output_path,
        output_model_type=DataModelType.PydanticV2BaseModel,
    )
    
    # 读取生成的内容
    generated_code = output_path.read_text()

print(generated_code)

生成结果解析

执行上述代码会输出以下Python代码：

# generated by datamodel-codegen:
#   filename:  example.json
#   timestamp: 2020-12-21T08:01:06+00:00

from __future__ import annotations

from enum import Enum
from typing import Optional

from pydantic import BaseModel


class StreetType(Enum):
    Street = 'Street'
    Avenue = 'Avenue'
    Boulevard = 'Boulevard'


class Model(BaseModel):
    number: Optional[float] = None
    street_name: Optional[str] = None
    street_type: Optional[StreetType] = None

这段代码包含了：

一个枚举类StreetType，对应JSON Schema中的enum定义
一个Pydantic的BaseModel类Model，包含了所有定义的属性
完整的类型注解和Optional处理

高级用法：直接调用解析器

对于需要更精细控制的场景，可以直接使用解析器：

from datamodel_code_generator import DataModelType, PythonVersion
from datamodel_code_generator.model import get_data_model_types
from datamodel_code_generator.parser.jsonschema import JsonSchemaParser

# 定义JSON Schema
json_schema = """{
    "type": "object",
    "properties": {
        "number": {"type": "number"},
        "street_name": {"type": "string"},
        "street_type": {"type": "string",
                        "enum": ["Street", "Avenue", "Boulevard"]
                        }
    }
}"""

# 获取数据模型类型配置
data_model_types = get_data_model_types(
    DataModelType.PydanticV2BaseModel,
    target_python_version=PythonVersion.PY_311
)

# 创建解析器实例
parser = JsonSchemaParser(
    json_schema,
    data_model_type=data_model_types.data_model,
    data_model_root_type=data_model_types.root_model,
    data_model_field_type=data_model_types.field_model,
    data_type_manager_type=data_model_types.data_type_manager,
    dump_resolve_reference_action=data_model_types.dump_resolve_reference_action,
)

# 执行解析
result = parser.parse()
print(result)

这种方法提供了更大的灵活性，允许你：