Passer au contenu principal

​
Qu’est-ce que pydantic ?

Pydantic est une bibliothèque Python moderne et remarquable pour la validation des données à l’aide d’annotations de type. Elle applique des contraintes de type, garantissant la cohérence des données et fournissant des messages d’erreur clairs lorsque la validation échoue. Pydantic est à la fois puissante et simple à utiliser, ce qui en fait un choix populaire auprès des développeurs travaillant avec des données structurées.

​
Installation

Pour utiliser Pydantic avec ce SDK, vous devez installer le SDK avec la dépendance supplémentaire pydantic, car elle n’est pas incluse par défaut : 
pip install "squarecloud[pydantic]"

​
Fonctionnalités

Dans ce SDK, Pydantic est utilisé pour convertir un paramètre extra depuis un dictionnaire vers un modèle Pydantic, permettant une validation et une manipulation des données plus robustes. 
import squarecloud as square
from squarecloud import Endpoint
from pydantic import BaseModel

class Animal(BaseModel):
    name: str
    age: int

@client.on_request(Endpoint.status())
async def get_extra_param(before, after, extra: Animal):
    print(extra.name)
    print(extra.age)

async def main():
    client = square.Client('your api key')
    await client.app_status('application_id', extra={'name': 'felix', 'age': 3})
Dans cet exemple, la classe Animal est un modèle Pydantic avec deux champs : name et age. Lorsqu’une requête est effectuée vers l’endpoint status, le paramètre extra est automatiquement converti en une instance Animal, ce qui vous permet d’accéder facilement aux données et de les valider.