griffe-fieldz

Griffe扩展，添加对数据类（pydantic、attrs等）的支持。此扩展会将数据类的字段注入到文档中，防止您在docstrings中重复字段元数据。

它支持fieldz支持的所有内容，目前包括

• dataclasses.dataclass
• pydantic.BaseModel
• attrs.define
• msgspec.Struct

安装

使用pip

pip install griffe-fieldz

要在MkDocs项目中使用扩展，使用以下配置

# mkdocs.yml
plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          extensions:
          - griffe_fieldz

您可以使用以下任何选项，作为griffe_fieldz键下的字典提供。

例如

        options:
          extensions:
          - griffe_fieldz: {include_inherited: true}