fields-metadata 1.8.0

A Python library for extracting field metadata from dataclasses and Pydantic models

fields-metadata

A Python library for extracting comprehensive field metadata from dataclasses and Pydantic models, with support for derived fields, custom annotations, filtering/sorting/grouping via therismos, and recursive traversal of nested structures.

Installation

pip install fields-metadata
pip install "fields-metadata[pydantic]"  # with Pydantic support

Quick Start

from dataclasses import dataclass
from typing import Annotated
from annotated_types import DocInfo, Ge
from fields_metadata import MetadataExtractor, HumanReadableId

@dataclass
class Person:
    name: Annotated[str, HumanReadableId(), DocInfo("Full name")]
    age: Annotated[int, Ge(0)]
    email: str | None = None

extractor = MetadataExtractor()
metadata = extractor.extract(Person)

print(metadata["name"].doc)        # "Full name"
print(metadata["age"].numeric)     # True
print(metadata["email"].optional)  # True

Full documentation: fields-metadata.readthedocs.io

License

MIT