Skip to content

MyModel

Bases: BaseModel

Pydantic model with field descriptions.

Parameters:

Name Type Description Default
a int

Description of a in the docstring

required
b float

Description of b in the field metadata

42.0
c str
<dynamic>
Source code in src/fieldz_docs_example/pydantic.py
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
class MyModel(BaseModel):
    """Pydantic model with field descriptions.

    Parameters
    ----------
    a: int
        Description of a in the docstring
    """

    a: int
    b: float = Field(
        42.0,
        json_schema_extra={"description": "Description of `b` in the field metadata"},
    )
    c: str = Field(default_factory=lambda data: str(data["a"] + data["b"]))