Overview

Pydantic 2.7, released on June 21, 2024, adds the @deprecated decorator to mark obsolete fields.

Main Features

Deprecated decorator

The @deprecated decorator emits a warning when a deprecated field or validator is used.

python
from pydantic import BaseModel
from warnings import deprecated

class User(BaseModel):
    name: str
    username: str  # new field

    @deprecated('Use username instead')
    @property
    def login(self) -> str:
        return self.username

u = User(name='Alice', username='alice42')
print(u.username)  # alice42

Sources