Saltar a contenido

Modelos base

Modelos Pydantic compartidos por el SDK: la base abstracta, respuestas paginadas, y la respuesta de health().

Modelos

Modelos Pydantic base compartidos por todos los endpoints.

DatosMexicoModel

Bases: BaseModel

Base model strict de Pydantic v2 con configuración común.

Todos los modelos del SDK heredan de esta clase para asegurar consistencia de validación. extra="allow" permite que la API agregue campos nuevos sin romper a los clientes que ya tengan una versión anterior del SDK.

ApiResponse

Bases: DatosMexicoModel

Wrapper genérico para responses estándar de la API.

Subclase para endpoints cuyo response sea de la forma {"data": ..., "meta": ...}. Endpoints más simples pueden heredar directamente de DatosMexicoModel.

PaginatedResponse

Bases: DatosMexicoModel, Generic[T]

Response paginada estándar.

Los endpoints que devuelven listas paginadas siguen el contrato

{"data": [...], "total": N, "page": p, "per_page": pp, "pages": P}

Es genérico sobre el tipo de elementos en data. Para anotar la paginación de un dataset específico, usar PaginatedResponse[Servidor].

HealthResponse

Bases: DatosMexicoModel

Respuesta del endpoint GET /health.

Examples:

>>> from datos_mexico import DatosMexico
>>> client = DatosMexico()
>>> health = client.health()
>>> health.status
'ok'