Skip to content

Person Model

Person data model with validation and computed fields.

Person Class

app.models.person.Person

Bases: BaseModel

Person data model for face recognition system.

Represents a person with personal information, face encodings, and relationship data. Uses Pydantic for validation and serialization, compatible with MongoDB ObjectId.

Attributes:

Name Type Description
id Optional[PyObjectId]

MongoDB document ID. Default: None.
name str

Person's first name. Default: "Unknown", length 2-50.
surname str

Person's last name. Default: "Unknown", length 2-50.
birthday datetime

Person's date of birth. Required, must be valid date.
relationship RelationshipType

Relationship type to the user. Default: ALTRO.
encoding Optional[dict]

Dictionary of face encodings (hash -> embedding vector). Default: None.
role RoleType

Person's role in the system. Default: GUEST.
Source code in backend/app/models/person.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
class Person(BaseModel):
    """Person data model for face recognition system.

    Represents a person with personal information, face encodings, and relationship data.
    Uses Pydantic for validation and serialization, compatible with MongoDB ObjectId.

    Attributes:
        id (Optional[PyObjectId]): MongoDB document ID. Default: None.
        name (str): Person's first name. Default: "Unknown", length 2-50.
        surname (str): Person's last name. Default: "Unknown", length 2-50.
        birthday (datetime): Person's date of birth. Required, must be valid date.
        relationship (RelationshipType): Relationship type to the user. Default: ALTRO.
        encoding (Optional[dict]): Dictionary of face encodings (hash -> embedding vector). Default: None.
        role (RoleType): Person's role in the system. Default: GUEST.

    """

    id: Optional[PyObjectId] = Field(alias="_id", default=None)
    name: str = Field(default="Unknown", min_length=2, max_length=MAX_LENGTH)
    surname: str = Field(default="Unknown", min_length=2, max_length=MAX_LENGTH)

    birthday: datetime 

    relationship: RelationshipType = RelationshipType.ALTRO
    encoding: Optional[dict] = None 
    role: RoleType = RoleType.GUEST   


    model_config = ConfigDict(
        populate_by_name=True,
        arbitrary_types_allowed=True 
    )


    @field_validator('birthday') 
    @classmethod
    def check_data_passata(cls, v: datetime) -> datetime:
        """Validate that birthday is a valid past date.

        Checks that the birthday is not in the future and not before year 1900.

        Args:
            v (datetime): The birthday datetime to validate.

        Returns:
            datetime: The validated birthday datetime.

        Raises:
            ValueError: If birthday is in the future or before year 1900.

        """
        if v.date() > date.today():
            raise ValueError("La data di nascita non può essere nel futuro!")

        if v.year < 1900:
            raise ValueError("Data di nascita non valida (troppo indietro nel tempo)")

        return v


    @computed_field
    def age(self) -> int:
        """Calculate person's age based on birthday.

        Computes age as the difference between current date and birthday,
        accounting for whether the birthday has occurred this year.

        Returns:
            int: Person's age in years. Returns 0 if birthday is not set.

        """
        today = date.today()
        if not self.birthday:
            return 0

        return today.year - self.birthday.year - (
            (today.month, today.day) < (self.birthday.month, self.birthday.day)
        )

Functions

age 

age()

Calculate person's age based on birthday.

Computes age as the difference between current date and birthday, accounting for whether the birthday has occurred this year.

Returns:

Name Type Description
int int

Person's age in years. Returns 0 if birthday is not set.
Source code in backend/app/models/person.py 
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
@computed_field
def age(self) -> int:
    """Calculate person's age based on birthday.

    Computes age as the difference between current date and birthday,
    accounting for whether the birthday has occurred this year.

    Returns:
        int: Person's age in years. Returns 0 if birthday is not set.

    """
    today = date.today()
    if not self.birthday:
        return 0

    return today.year - self.birthday.year - (
        (today.month, today.day) < (self.birthday.month, self.birthday.day)
    )

check_data_passata classmethod 

check_data_passata(v)

Validate that birthday is a valid past date.

Checks that the birthday is not in the future and not before year 1900.

Parameters:

Name Type Description Default
v datetime

The birthday datetime to validate.

 required

Returns:

Name Type Description
datetime datetime

The validated birthday datetime.

Raises:

Type Description
ValueError

If birthday is in the future or before year 1900.
Source code in backend/app/models/person.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
@field_validator('birthday') 
@classmethod
def check_data_passata(cls, v: datetime) -> datetime:
    """Validate that birthday is a valid past date.

    Checks that the birthday is not in the future and not before year 1900.

    Args:
        v (datetime): The birthday datetime to validate.

    Returns:
        datetime: The validated birthday datetime.

    Raises:
        ValueError: If birthday is in the future or before year 1900.

    """
    if v.date() > date.today():
        raise ValueError("La data di nascita non può essere nel futuro!")

    if v.year < 1900:
        raise ValueError("Data di nascita non valida (troppo indietro nel tempo)")

    return v