Django Ninja 1.3 est sorti
par Makersquad ·
Date de sortie : 15 août 2024
Release officielle : Django Ninja 1.3.0
Django Ninja 1.3 est une version riche. Elle apporte un utilitaire dédié aux mises à jour partielles, un contexte de sérialisation enrichi et plusieurs améliorations autour des filtres et du client de test. Bonne lecture.
Les nouveautés principales
PatchDict : les mises à jour partielles enfin propres
Les mises à jour partielles (PATCH) sont un classique dans les APIs REST. Le problème : distinguer un champ absent de la requête d’un champ explicitement passé à None. Django Ninja 1.3 introduit PatchDict pour gérer exactement ce cas.
from ninja import PatchDict
class ProductIn(Schema):
name: str
price: float
description: str | None = None
@api.patch("/products/{product_id}", response=ProductOut)
def update_product(request, product_id: int, data: PatchDict[ProductIn]):
product = get_object_or_404(Product, id=product_id)
# data contient uniquement les champs fournis dans la requête
for field, value in data.items():
setattr(product, field, value)
product.save()
return product
PatchDict retourne un dictionnaire ne contenant que les champs réellement présents dans le payload, ce qui évite d’écraser involontairement des valeurs avec None.
Contexte de sérialisation enrichi
Le contexte de sérialisation expose maintenant la requête et le code de réponse. Dans un sérialiseur de modèle, vous pouvez accéder à request et response_status via info.context, ce qui ouvre la porte à une sérialisation dépendante du contexte HTTP.
from pydantic import model_serializer
class SchemaWithCustomSerializer(Schema):
test1: str
test2: str
@model_serializer(mode="wrap")
def ser_model(self, handler, info):
request = info.context["request"]
response_status = info.context["response_status"]
return handler(self)
Import string dans add_router
La méthode router.add_router accepte désormais une chaîne d’import pour référencer un routeur, ce qui permet de monter un routeur sans l’importer explicitement.
En-têtes par défaut pour NinjaClientBase
Dans les tests, NinjaClientBase accepte maintenant des en-têtes par défaut au niveau du client. Pratique pour passer un token d’authentification une seule fois plutôt que de le répéter à chaque appel.
client = TestClient(api, headers={"Authorization": "Bearer test-token"})
response = client.get("/protected-endpoint")
Les réponses de test exposent par ailleurs une propriété data à la manière de Django REST Framework, ce qui rend les assertions plus directes.
Types de filtres génériques
Django Ninja 1.3 autorise les types de filtres génériques : on crée un type de filtre personnalisé avec Pydantic, réutilisable dans plusieurs classes de filtre, en rendant le field_name implicite.
IContainsField = Annotated[Optional[str], Field(None, q='__icontains')]
class BookFilterSchema(FilterSchema):
name: IContainsField
Pour rappel, FilterSchema se déclare avec des annotations Python standard et infère les filtres ORM à partir des noms de champs. Pour des cas plus complexes (filtres __icontains, __gte, etc.), il reste possible d’annoter avec Field(..., q=...) pour spécifier l’expression de filtre exacte.
from ninja import FilterSchema, Field, Query
class ProductFilter(FilterSchema):
name: str | None = Field(None, q="name__icontains")
min_price: float | None = Field(None, q="price__gte")
category: str | None = None
@api.get("/products", response=list[ProductOut])
def list_products(request, filters: ProductFilter = Query(...)):
return filters.filter(Product.objects.all())
À retenir
Django Ninja 1.3 est une version utile au quotidien : des mises à jour partielles robustes avec PatchDict, un contexte de sérialisation plus complet, et plusieurs raffinements autour des routeurs, des filtres et du client de test. Si vous travaillez sur une API un peu conséquente, ces ajouts simplifient le code sans rien casser à l’existant.