Aller au contenu
Makersquad

Django REST Framework 3.11 est sorti

par Makersquad ·

Logo de Django REST framework sur fond dégradé

Date de sortie : 12 décembre 2019

Documentation officielle : https://www.django-rest-framework.org/community/release-notes/#311x-series

Django 3.0 est sorti le 2 décembre 2019, DRF 3.11 le 12 décembre 2019 et ajoute sa prise en charge. Cette version continue aussi de faire mûrir la génération de schémas OpenAPI. C’est la dernière version à supporter Django 1.11.

Les nouveautés principales

Support de Django 3.0

DRF 3.11 ajoute la prise en charge de Django 3.0. Les versions de Python supportées sont désormais 3.5, 3.6, 3.7 et 3.8, et celles de Django 1.11, 2.0, 2.1, 2.2 et 3.0.

Améliorations des schémas OpenAPI

La génération de schémas OpenAPI continue de mûrir. Parmi les points forts de la 3.11 :

  • le mappage automatique des renderers et parsers de DRF vers les types de média de requête et de réponse OpenAPI
  • un meilleur mappage vers les types JSON schema, par exemple pour les HStoreField et pour les grands entiers
  • le portage de l’ancienne analyse CoreAPI des docstrings pour former les descriptions d’opérations OpenAPI

Dans cet exemple, les descriptions des opérations get et post sont extraites de la docstring de la classe :

class DocStringExampleListView(APIView):
    """
    get: A description of my GET operation.
    post: A description of my POST operation.
    """
    permission_classes = [permissions.IsAuthenticatedOrReadOnly]

    def get(self, request, *args, **kwargs): ...
    def post(self, request, *args, **kwargs): ...

Nouveau mécanisme requires_context pour les validateurs et les valeurs par défaut

Un validateur ou une classe de valeur par défaut peut avoir besoin d’accéder au champ du serializer qui l’appelle, ou au .context avec lequel le serializer a été instancié. Auparavant, une implémentation pouvait fournir une méthode set_context, appelée avant la validation, mais cette approche posait des problèmes de situations de concurrence (race conditions).

Cette approche passe en dépréciation en attente : elle continue de fonctionner, sera dépréciée en 3.12 et supprimée en 3.13. À la place, les validateurs ou valeurs par défaut qui ont besoin du contexte déclarent un attribut requires_context = True sur la classe, et leur méthode __call__ reçoit un argument supplémentaire serializer_field.

Un validateur ressemble à ceci :

class CustomValidator:
    requires_context = True

    def __call__(self, value, serializer_field): ...

Une valeur par défaut ressemble à ceci :

class CustomDefault:
    requires_context = True

    def __call__(self, serializer_field): ...

Dernière version pour Django 1.11

DRF 3.11 est la dernière version à supporter Django 1.11 (fin de vie LTS en avril 2020) : la 3.12 exige Django 2.2 ou plus. Si vous êtes encore sur Django 1.11, c’est le moment de planifier la migration. Python 3.5 reste déclaré par la 3.12.

À retenir

DRF 3.11 ajoute la prise en charge de Django 3.0 et enrichit les schémas OpenAPI. Si vos validateurs ou valeurs par défaut utilisent set_context, passez à requires_context avant la 3.13, qui le supprime. C’est aussi la dernière version à supporter Django 1.11.

Échanger avec un expert Django

De l’idée au marché. Makersquad conçoit des logiciels sur mesure, pensés pour durer, avec de petites équipes d’experts autonomes. Depuis 2018.