Django Ninja 1.2 est sorti
par Makersquad ·
Date de sortie : 27 juin 2024
Release officielle : Django Ninja 1.2.0
Django Ninja 1.2 met en tête de ses notes le support de la pagination asynchrone et le throttling. Elle apporte aussi plusieurs correctifs importants qui touchent à la fiabilité quotidienne : compatibilité avec Python 3.12.4, validation des champs nullable, et améliorations sur la pagination. Le genre de version qu’on applique sans hésiter.
Les nouveautés principales
Correction des ForwardRef pour Python 3.12.4
Python 3.12.4 a introduit un changement dans l’évaluation des ForwardRef (les références en avant utilisées dans les annotations de type) qui provoquait une erreur dans Django Ninja : ForwardRef._evaluate() missing 1 required keyword-only argument. Cette version corrige le problème. Si vous avez rencontré cette erreur après une mise à jour vers Python 3.12.4, c’est probablement ça.
Améliorations de LimitOffsetPagination
Le schéma d’entrée de LimitOffsetPagination déclare désormais une borne maximale (paramètre le=) pour limit. Le maximum est visible et validé au niveau du schéma, au lieu d’être appliqué en silence.
from ninja.pagination import paginate, LimitOffsetPagination
@api.get("/items", response=list[ItemOut])
@paginate(LimitOffsetPagination)
def list_items(request):
return Item.objects.all()
Attention, c’est un changement cassant pour les intégrations qui demandent une limit supérieure à celle fixée sur le serveur (NINJA_PAGINATION_MAX_LIMIT) : jusqu’ici la requête aboutissait et la réponse était tronquée au maximum, la limite est désormais imposée par le schéma d’entrée.
Validation des champs nullable corrigée
Un bug affectait les champs de modèles Django nullables qui ont une valeur par défaut non nulle, par exemple models.IntegerField(default=0, null=True), dans un ModelSchema : le schéma généré n’acceptait pas None comme valeur valide. C’est corrigé, le champ accepte None et garde sa valeur par défaut.
Support de SmallAutoField dans l’ORM
Django dispose de plusieurs types de champs auto-incrémentés : AutoField, BigAutoField, et SmallAutoField. Ce dernier n’était pas correctement pris en charge lors de la génération des schémas ORM. C’est désormais le cas.
class SmallItem(models.Model):
# Utilise un entier sur 2 octets au lieu de 4
id = models.SmallAutoField(primary_key=True)
name = models.CharField(max_length=100)
La création de schéma via create_schema ou ModelSchema fonctionne maintenant sans erreur pour ces modèles.
Correction de __dict__ avec validate_assignment
Avec validate_assignment = True sur un Schema, la validation est déclenchée à chaque réassignation de champ. Un bug faisait que cette configuration provoquait une AttributeError sur __dict__ dans DjangoGetter lors de l’assignation. C’est corrigé dans cette version.
Pagination asynchrone et throttling
Au delà des correctifs, la 1.2 introduit deux ajouts notables : le support de la pagination en mode asynchrone et un mécanisme de throttling pour limiter le débit des requêtes. Le backend django_auth_superuser est par ailleurs désormais exposé via __all__, ce qui le rend importable directement depuis le paquet.
À retenir
Django Ninja 1.2 ajoute la pagination asynchrone et le throttling, et corrige des bugs. Ces correctifs sont discrets mais peuvent avoir un impact réel en production, notamment la compatibilité Python 3.12.4 et la validation des champs nullable. À appliquer dès que possible si vous tournez sur Python 3.12.