TI – Blog de Frank-Mich

Modèle hybride Pydantic/FastAPI

Posted on 2024-03-252024-03-26 by Frank-Mich L'Heureux

Histoire courte, j’ai un API qui n’est pas sous FastAPI, mais je me sers quand même de FastAPI pour générer la documentation au format d’OpenAPI.

J’ai donc des modèles pour les points de terminaisons et je souhaite qu’ils fonctionnent avec et sans FastAPI, car dans leur version pure, FastAPI n’est pas déployé. (Pour faire une autre histoire courte, installer FastAPI alourdi un peu le paquet à déployer, mais surtout les démarrage à froid des lambdas AWS à cause du délai d’initialisation de Sentry. Sentry détecte que FastAPI est présent dans l’environnement et ajoute automatiquement du monitoring, ce qui prend un bon 500ms supplémentaire. Mesuré en décembre 2023.)

Bref, en m’inspirant fortement d’une réponse sur StackOverflow, j’ai produit ceci.

# models.py
from typing import Annotated, Any, cast

from pydantic import BaseModel, Field
from pydantic.fields import FieldInfo

try:
    from fastapi import Query  # type:ignore[import-not-found]

    def FieldQuery(*args: Any, **kwargs: Any) -> FieldInfo:  # noqa:N802
        return cast(FieldInfo, Field(Query(*args, **kwargs)))

except ImportError:

    def FieldQuery(*args: Any, **kwargs: Any) -> FieldInfo:  # noqa:N802
        return cast(FieldInfo, Field(*args, **kwargs))  # type: ignore[pydantic-field]


class QueryParams(BaseModel):
    limit: Annotated[
        int,
        FieldQuery(
            -1,
            description="The limit of values to fetch. -1 means no limit.",
        ),
    ]

Puis, pour la route

# routes.py
from fastapi import FastAPI

from models import QueryParams

app = FastAPI()

@app.get("/things")
def get_things(
    params: Annotated[QueryParams, Depends()],
) -> dict:
    ...

Est-ce parfait? Avec les «type: ignore», «noqa», «import try/except», pas dutout. Ça ressemble à un gros hack.

Est-ce que ça fonctionne? Oh que oui!

Note: Les tags «noqa» et «type: ignore» sont respectivement liés au linting avec ruff et mypy.

Mon coffre à outils Python, édition 2024

Posted on 2024-01-172024-01-18 by Frank-Mich L'Heureux

Ça fait longtemps que je souhaite publier annuellement mes outils python préférés. C’est pratique pour plein de gens et ça permet de voir l’évolution de ceux-ci au fil du temps et des projets sur lesquels je contribue.

Voici donc la première édition de cette liste.

Recette: Migrer un blog WordPress vers AWS Lightsail

Posted on 2024-01-152024-01-17 by Frank-Mich L'Heureux

Le blog sur lequel vous vous trouvez actuellement était hébergé sur un serveur privé virtuel. Mon hébergeur a décidé de cesser ses activités et j’ai dû partir. Il m’a gentiment suggéré de considérer AWS Lightsail comme une option de migration. C’est ce que j’ai fait et c’est là que ce blog est maintenant hébergé.

Ce blog n’est pas nouveau. Il avait déjà du contenu. Il dispose également de personnalisations telles que des plugins et des thèmes. Cet article explique comment exporter le contenu et les personnalisations d’un ancien blog et les importer sur Lightsail. Sa précision peut varier en fonction du niveau de personnalisation de votre blog. Une connaissance de la ligne de commande (CLI) est requise.

Imprimer une date avisée en python

Posted on 2023-09-072023-09-07 by Frank-Mich L'Heureux

Un échantillon de code bien pratique que je ne cesse d’oublier.

from datetime import datetime, timezone

now = datetime.now(tz=timezone.utc)
print(now.astimezone().isoformat())

Modèle de FastAPI Stripe Webhook

Posted on 2023-08-302024-01-15 by Frank-Mich L'Heureux

L’équivalent FastAPI de vérifier-que-les-événements-proviennent-de-stripe

import os

from http import HTTPStatus
from typing import Annotated

import stripe
from fastapi import Depends, FastAPI, Header, HTTPException, Request


app = FastAPI()


async def get_body(request: Request) -> bytes:
    return await request.body()


@app.post("/webhook", status_code=HTTPStatus.NO_CONTENT)
def post_report(
    stripe_signature: Annotated[str, Header(alias="stripe-signature")],
    body: bytes = Depends(get_body),
) -> None:
    endpoint_secret = os.environ["ENDPOINT_SECRET"]

    try:
        # signature validation
        event = stripe.Webhook.construct_event(body, stripe_signature, endpoint_secret)
    except ValueError as e:
        # Invalid payload
        raise HTTPException(status_code=HTTPStatus.BAD_REQUEST) from e
    except stripe.error.SignatureVerificationError as e:
        # Invalid signature
        raise HTTPException(status_code=HTTPStatus.UNPROCESSABLE_ENTITY) from e

    print(event)

    return

Un problème possible, que j’ai rencontré, est que j’ai demandé à FastAPI de convertir request.body en un dictionnaire au niveau des paramètres de fonction (donc body: dict). Puis, je l’ai sérialisé en une chaîne de caractères pour l’étape de validation… et cela a échoué parce qu’il n’était plus identique à ce qui était entré.

Serverless: Comment partager les ids d’un API Gateway existant

Posted on 2023-01-312023-01-31 by Frank-Mich L'Heureux

La documentation de serverless indique comment partager les ids d’un API Gateway, mais la technique qui y est décrite ne semble fonctionner que pour un nouveau déploiement. (Dans mon cas, suivre cette technique a crée un 2è API Gateway vide dont les ids étaient partagés, ce qui, évidemment, ne répondait pas à mes besoins.)

Voici comment faire pour un déploiement existant.

Annotations de type en python – Annoter ou convertir?

Posted on 2022-12-062022-12-06 by Frank-Mich L'Heureux

Lors d’une revue de code, un collègue, Zachary Paden, me demandait pourquoi j’appelais la fonction typing.cast sur mes variables plutôt que de créer des variables temporaires simplement pour typer. Eh bien, tout comme il ignorait l’existence de cast, j’ignorais que cette approche fonctionnait. En bon nerdz que nous sommes, il a décidé de mesurer la performance de chacune des approches.

boto3 – Passer de monkeypatch à moto

Posted on 2022-11-182022-11-18 by Frank-Mich L'Heureux

Aujourd’hui, à la suggestion d’un collège (Zachary Paden), j’ai contemplé l’idée de migrer mes tests utilisant pytest/monkeypatch à moto. Ici je vais partager mon parcours et observations.

Minimiser la taille de ses lambdas en supprimant boto3 du paquet à déployer

Posted on 2022-08-292022-08-30 by Frank-Mich L'Heureux

En avril dernier, j’ai écrit un billet sur la gestion de boto3 dans les paquets déployés. (Voir Minimiser la taille de ses lambdas en évitant d’avoir boto3 et ses stubs dans le paquet à déployer.) Cette approche fonctionne lorsque toutes les dépendances peuvent être dans la section développement.

Mais, qu’en est-il lorsque des dépendances sont requises en production? Par exemple, nous avons récemment eu à déployer un lambda qui dépend d’awswrangler. La technique suggérée dans le précédent billet ne fonctionnait donc pas. Ici, je vais couvrir une approche différente qui permet de supprimer boto3 du paquet à déployer dans le contexte cité en exemple. Elle est cependant moins flexible et se base sur une technologie spécifique: serverless.

Recette: Exécuter une copie locale d’un site WordPress avec Docker

Posted on 2022-06-212024-01-15 by Frank-Mich L'Heureux

J’ai récemment décidé de publier mes articles en français et en anglais. Au préalable, je devais trouver et tester des plugins afin d’en choisir un. J’ai donc passé du temps, plus que je ne l’aurais cru, à le faire fonctionner localement à travers Docker. Comme j’ai rencontré quelques pièges, j’ai décidé de partager la recette.