Skip to content

Person dataclass

Class representing a person.

Parameters:

Name Type Description Default
name str

Name of the person.

 required
age int

Age in years (description in the field)

 0
Source code in src/fieldz_docs_example/dataclasses.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
@dataclass
class Person:
    """Class representing a person.

    Parameters
    ----------
    name : str
        Name of the person.
    """

    name: str
    age: int = field(
        default=0,
        metadata={"description": "Age in years (description in the field)"},
    )