メインコンテンツへスキップ

​
pydantic とは？

Pydantic は、型アノテーションを使ったデータ検証のための素晴らしくモダンな Python ライブラリです。型の制約を強制し、データの一貫性を保証するとともに、検証が失敗したときには 明確なエラーメッセージを提供します。Pydantic は 強力でありながら使いやすく、構造化データを扱う開発者にとって 人気の選択肢となっています。

​
インストール

この SDK で Pydantic を使うには、pydantic の extra 依存関係付きで SDK をインストールする必要があります。これはデフォルトでは含まれていません。 
pip install "squarecloud[pydantic]"

​
機能

この SDK では、Pydantic は extra パラメータを辞書から Pydantic モデルへキャストするために使われ、より堅牢なデータ 検証と操作を可能にします。 
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})
この例では、Animal クラスは name と age という 2 つの フィールドを持つ Pydantic モデルです。status エンドポイントへリクエストが行われると、 extra パラメータは自動的に Animal インスタンスへキャストされ、 データへ簡単にアクセスして検証できるようになります。