Les objets requête et réponse

Aperçu rapide

Django utilise des objets requête et réponse pour transmettre l’état au travers du système.

Lorsqu’une page est demandée, Django crée un objet HttpRequest contenant des métadonnées au sujet de la requête. Puis, Django charge la vue appropriée, lui transmettant l’objet HttpRequest comme premier paramètre. Chaque vue est responsable de renvoyer un objet HttpResponse.

Ce document présente l’API des objets HttpRequest et HttpResponse, qui sont définis dans le module django.http.

Objets HttpRequest

class HttpRequest[source]

Attributs

Tous les attributs doivent être considérés en lecture seule sauf mention contraire.

HttpRequest.scheme[source]

Une chaîne représentant le protocole de la requête (normalement http ou https).

HttpRequest.body[source]

Le corps HTTP brut de la requête sous forme de chaine binaire. Cet attribut est utile pour traiter les données de manière différente que ne le fait la gestion habituelle des formulaires HTML : images binaires, contenu XML, etc. Pour ce qui concerne les données de formulaire conventionnelles, utilisez HttpRequest.POST.

Vous pouvez aussi lire le contenu d’un objet HttpRequest en utilisant une interface de type fichier avec HttpRequest.read() ou HttpRequest.readline(). Accéder à l’attribut body après avoir lu le contenu de la requête avec l’une de ces méthodes de flux d’entrée-sortie produira une RawPostDataException.

HttpRequest.path

Une chaîne représentant le chemin complet vers la page demandée, sans le protocole, le domaine ou la chaîne de requête.

Exemple : "/musique/groupes/les_beatles/"

HttpRequest.path_info

Sous certaines configurations de serveur web, la partie de l’URL après le nom d’hôte est divisée en une partie « préfixe de script » et une partie « information de chemin ». L’attribut path_info contient toujours la partie information de chemin du chemin, quel que soit le serveur web utilisé. Il est préférable d’utiliser cet attribut plutôt que path, car cela améliore la portabilité du code entre les serveurs de test et de déploiement.

Par exemple, si le réglage WSGIScriptAlias de votre application est défini à "/minfo", alors path pourrait être "/minfo/musique/groupes/les_beatles/" et path_info serait "/musique/groupes/les_beatles/".

HttpRequest.method

Une chaîne correspondant à la méthode HTTP utilisée dans la requête. Elle est toujours en majuscules. Par exemple :

if request.method == "GET":
    do_something()
elif request.method == "POST":
    do_something_else()
HttpRequest.encoding[source]

Une chaîne représentant le codage actuel utilisé pour décoder les données soumises par formulaire (ou None, ce qui signifie que c’est le réglage DEFAULT_CHARSET qui est utilisé). Vous pouvez redéfinir cet attribut pour modifier le codage utilisé lors de l’accès aux données de formulaires. Toute nouvelle lecture d’attribut (comme l’accès à GET ou à POST) utilisera la nouvelle valeur de encoding. C’est utile lorsque vous savez que les données de formulaire ne sont pas dans le codage DEFAULT_CHARSET.

HttpRequest.content_type

Une chaîne représentant le type MIME de la requête, tiré de l’en-tête CONTENT_TYPE.

HttpRequest.content_params

Un dictionnaire de paramètres clé/valeur inclus dans l’en-tête CONTENT_TYPE.

HttpRequest.GET

Un objet de type dictonnaire contenant tous les paramètres HTTP GET donnés. Voir la documentation QueryDict ci-dessous.

HttpRequest.POST

Un objet de type dictonnaire contenant tous les paramètres HTTP POST donnés, pour autant que la requête contienne des données de formulaire. Voir la documentation QueryDict ci-dessous. Si vous avez besoin d’accéder à des données brutes ou non liées à un formulaire provenant de la requête, privilégiez plutôt l’accès par l’attribut HttpRequest.body.

Il est possible qu’une requête arrive par POST avec un dictionnaire POST vide, comme par exemple quand un formulaire est soumis par la méthode HTTP POST mais ne contient pas de données de formulaire. C’est pourquoi il ne faut pas utiliser if request.POST pour savoir si la méthode POST a été utilisée, mais plutôt if request.method == "POST" (voir HttpRequest.method).

POST n’inclut pas d’informations quant à l’envoi de fichiers. Voir FILES.

HttpRequest.COOKIES

Un dictionnaire contenant tous les cookies. Les clés et les valeurs sont des chaînes.

HttpRequest.FILES

Un objet de type dictionnaire contenant tous les fichiers envoyés. Chaque clé de FILES correspond à l’attribut name de <input type="file" name="">. Chaque valeur de FILES est un objet UploadedFile.

Voir Gestion des fichiers pour plus d’informations.

FILES ne contient des données que si la méthode de requête est POST et que l’élément <form> qui a servi pour envoyer la requête contient enctype="multipart/form-data". Sinon, FILES est un objet de type dictionnaire vide.

HttpRequest.META

Un dictionnaire contenant tous les en-têtes HTTP disponibles. Ces en-têtes dépendent du client et du serveur, mais voici tout de même quelques exemples :

  • CONTENT_LENGTH – la longueur du corps de la requête (sous forme de chaîne).

  • CONTENT_TYPE – le type MIME du corps de la requête.

  • HTTP_ACCEPT – types de contenu acceptables pour la réponse.

  • HTTP_ACCEPT_ENCODING – codages acceptables pour la réponse.

  • HTTP_ACCEPT_LANGUAGE – langues acceptables pour la réponse.

  • HTTP_HOST – l’en-tête HTTP Host envoyé par le client.

  • HTTP_REFERER – la page d’origine, s’il y en a une.

  • HTTP_USER_AGENT – la chaîne « user-agent » du client.

  • QUERY_STRING – la chaîne des paramètres de requête, sous forme de chaîne unique (et non analysée).

  • REMOTE_ADDR – l’adresse IP du client.

  • REMOTE_HOST – le nom d’hôte du client.

  • REMOTE_USER – l’utilisateur authentifié par le serveur web, s’il y en a un.

  • REQUEST_METHOD – une chaîne telle que "GET" ou "POST".

  • SERVER_NAME – le nom d’hôte du serveur.

  • SERVER_PORT – le port du serveur (sous forme de chaîne).

À l’exception de CONTENT_LENGTH et CONTENT_TYPE, tels que présentés ci-dessus, tout en-tête HTTP de la requête est converti en clés META en convertissant tous les caractères en majuscules, remplaçant les tirets par des soulignements et en ajoutant un préfixe HTTP_ au nom. Par exemple, un en-tête nommé X-Bender correspond à la clé META HTTP_X_BENDER.

Notez que runserver ignore tous les en-têtes contenant des soulignements dans leur nom, ce qui fait qu’ils n’apparaîtront pas dans META. Ceci évite la falsification d’en-tête basée sur l’ambiguïté entre les soulignements et les tirets qui sont tous deux normalisés en soulignements dans les variables d’environnement WSGI. Cela correspond au comportement des serveurs web tels que Nginx et Apache 2.4+.

HttpRequest.headers est une manière plus simple d’accéder à tous les en-têtes préfixés par HTTP, ainsi qu’à CONTENT_LENGTH et CONTENT_TYPE.

HttpRequest.headers[source]

Un objet similaire à un dictionnaire, insensible à la casse, qui donne accès à tous les en-têtes de requête préfixés par HTTP (plus Content-Length et Content-Type).

Le nom de chaque en-tête est mis en forme en casse de titre (par ex. User-Agent) lors de leur affichage. Vous pouvez accéder aux en-têtes de manière insensible à la casse :

>>> request.headers
{'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6', ...}

>>> "User-Agent" in request.headers
True
>>> "user-agent" in request.headers
True

>>> request.headers["User-Agent"]
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6)
>>> request.headers["user-agent"]
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6)

>>> request.headers.get("User-Agent")
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6)
>>> request.headers.get("user-agent")
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6)

Afin de pouvoir être utilisé par exemple dans les gabarits Django, les en-têtes peuvent aussi être accédés avec une syntaxe par soulignement au lieu de tirets :

{{ request.headers.user_agent }}
HttpRequest.resolver_match

Une instance de ResolverMatch représentant l’URL résolue. Cet attribut n’est défini qu’après la phase de résolution d’URL, ce qui veut dire qu’il est disponible dans toutes les vues, mais pas dans les intergiciels qui sont exécutés avant la phase de résolution d’URL (l’attribut est cependant disponible dans process_view()).

Attributs définis par le code d’application

Django ne définit pas lui-même ces attributs, mais il les exploite s’ils sont définis par une application.

HttpRequest.current_app

La balise de gabarit url utilise sa valeur comme paramètre current_app de reverse().

HttpRequest.urlconf

Ceci sera utilisé comme configuration d’URL racine pour la requête en cours, écrasant la valeur de ROOT_URLCONF. Voir Processus de traitement des requêtes par Django pour plus de détails.

urlconf peut être défini à None pour annuler tout changement effectué par un intergiciel précédent et revenir à la valeur ROOT_URLCONF de départ.

HttpRequest.exception_reporter_filter

Cette valeur sera utilisée à la place de DEFAULT_EXCEPTION_REPORTER_FILTER pour la requête en cours. Voir Rapports d’erreur personnalisés pour plus de détails.

HttpRequest.exception_reporter_class

Cette valeur sera utilisée à la place de DEFAULT_EXCEPTION_REPORTER pour la requête en cours. Voir Rapports d’erreur personnalisés pour plus de détails.

Attributs définis par l’intergiciel

Certains intergiciels inclus dans les applications contribuées de Django définissent des attributs sur la requête. Si vous ne voyez pas un certain attribut dans la requête, vérifiez que la classe d’intergiciel correspondante figure bien dans MIDDLEWARE.

HttpRequest.session

Provenant de SessionMiddleware: un objet de type dictionnaire en lecture-écriture représentant la session en cours.

HttpRequest.site

Provenant de CurrentSiteMiddleware: une instance de Site ou de RequestSite telle que renvoyée par get_current_site() représentant le site en cours.

HttpRequest.user

Provenant de AuthenticationMiddleware: une instance de AUTH_USER_MODEL représentant l’utilisateur actuellement connecté. Si aucun utilisateur n’est actuellement connecté, user contiendra une instance de AnonymousUser. Vous pouvez les différencier par l’attribut is_authenticated, comme ceci :

if request.user.is_authenticated:
    ...  # Do something for logged-in users.
else:
    ...  # Do something for anonymous users.

La méthode auser() fait la même chose mais peut être utilisée dans des contextes asynchrones.

Méthodes

HttpRequest.auser()
New in Django 5.0.

Provenant de AuthenticationMiddleware: une coroutine. Renvoie une instance de AUTH_USER_MODEL représentant l’utilisateur actuellement connecté. Si aucun utilisateur n’est actuellement connecté, auser renverra une instance de AnonymousUser. Très semblable à l’attribut user, mais fonctionne en contexte asynchrone.

HttpRequest.get_host()[source]

Renvoie l’hôte d’origine de la requête en se basant sur les en-têtes HTTP_X_FORWARDED_HOST (si USE_X_FORWARDED_HOST est activé) et HTTP_HOST, dans cet ordre. S’ils ne contiennent pas la valeur recherchée, la méthode utilise une combinaison de SERVER_NAME et SERVER_PORT, comme expliqué dans la PEP 3333.

Exemple : "127.0.0.1:8000"

Génère l’exception django.core.exceptions.DisallowedHost si l’hôte ne se trouve pas dans ALLOWED_HOSTS ou si le nom de domaine n’est pas valide selon les RFC 1034/1035.

Note

La méthode get_host() échoue lorsque l’hôte est derrière plusieurs serveurs mandataires. Une des solutions est d’utiliser un intergiciel pour réécrire les en-têtes de serveurs mandataires, comme dans l’exemple suivant :

class MultipleProxyMiddleware:
    FORWARDED_FOR_FIELDS = [
        "HTTP_X_FORWARDED_FOR",
        "HTTP_X_FORWARDED_HOST",
        "HTTP_X_FORWARDED_SERVER",
    ]

    def __init__(self, get_response):
        self.get_response = get_response

    def __call__(self, request):
        """
        Rewrites the proxy headers so that only the most
        recent proxy is used.
        """
        for field in self.FORWARDED_FOR_FIELDS:
            if field in request.META:
                if "," in request.META[field]:
                    parts = request.META[field].split(",")
                    request.META[field] = parts[-1].strip()
        return self.get_response(request)

Cet intergiciel doit être positionné avant tout autre intergiciel se basant sur la valeur de get_host(), comme par exemple CommonMiddleware ou CsrfViewMiddleware.

HttpRequest.get_port()[source]

Renvoie le port d’origine de la requête en se basant sur les informations des variables META HTTP_X_FORWARDED_PORT (si USE_X_FORWARDED_PORT est activé) et SERVER_PORT, dans cet ordre.

HttpRequest.get_full_path()[source]

Renvoie le chemin path, intégrant les paramètres de requêtes, le cas échéant.

Exemple : "/musique/groupes/les_beatles/?print=true"

HttpRequest.get_full_path_info()[source]

Comme get_full_path(), mais utilise path_info au lieu de path.

Exemple : "/minfo/music/bands/the_beatles/?print=true"

HttpRequest.build_absolute_uri(location=None)[source]

Renvoie la forme absolue de l’URI location. Si aucun emplacement n’est indiqué, c’est l’emplacement provenant de request.get_full_path() qui est utilisé.

Si l’emplacement est déjà une forme URI absolue, il ne sera pas touché. Sinon, l’URI absolu est construit en se basant sur les variables de serveur disponibles dans la requête. Par exemple :

>>> request.build_absolute_uri()
'https://example.com/music/bands/the_beatles/?print=true'
>>> request.build_absolute_uri("/bands/")
'https://example.com/bands/'
>>> request.build_absolute_uri("https://example2.com/bands/")
'https://example2.com/bands/'

Note

Le mélange de HTTP et HTTPS sur le même site est découragé, ce qui fait que build_absolute_uri() génère toujours une URI absolue avec le même protocole que la requête actuelle. Si vous avez besoin de rediriger les utilisateurs vers HTTPS, il est préférable de laisser votre serveur web rediriger tout le trafic HTTP vers HTTPS.

Renvoie une valeur de cookie d’un cookie signé ou génère une exception django.core.signing.BadSignature si la signature n’est plus valable. Si vous fournissez le paramètre default, l’exception est supprimée et c’est cette valeur par défaut qui est renvoyée.

Le paramètre facultatif salt peut être utilisé pour fournir une protection supplémentaire contre les attaques par force brute contre la clé secrète. S’il est présent, le paramètre max-age sera comparé à l’horodatage signé lié à la valeur du cookie pour s’assurer que le cookie n’est pas plus ancien que max_age secondes.

Par exemple :

>>> request.get_signed_cookie("name")
'Tony'
>>> request.get_signed_cookie("name", salt="name-salt")
'Tony' # assuming cookie was set using the same salt
>>> request.get_signed_cookie("nonexistent-cookie")
KeyError: 'nonexistent-cookie'
>>> request.get_signed_cookie("nonexistent-cookie", False)
False
>>> request.get_signed_cookie("cookie-that-was-tampered-with")
BadSignature: ...
>>> request.get_signed_cookie("name", max_age=60)
SignatureExpired: Signature age 1677.3839159 > 60 seconds
>>> request.get_signed_cookie("name", False, max_age=60)
False

Voir Signature cryptographique pour plus d’informations.

HttpRequest.is_secure()[source]

Renvoie True si la requête est sécurisée, c’est-à-dire qu’elle a été opérée par HTTPS.

HttpRequest.accepts(mime_type)[source]

Renvoie True si l’en-tête Accept de la requête correspond au paramètre mime_type:

>>> request.accepts("text/html")
True

La plupart des navigateurs envoient par défaut Accept: */*, ce qui fait que la valeur renvoyée sera True pour tous les types de contenu. Une définition explicite de l’en-tête Accept dans les requêtes d’API peut être utile pour renvoyer un type de contenu différent pour ces consommateurs d’API bien précis. Consultez cet Exemple de négociation de contenu pour voir comment utiliser accepts() afin de renvoyer des contenus différents aux consommateurs d’une API.

Si une réponse varie en fonction du contenu de l’en-tête Accept et que vous utilisez une forme de cache comme l’intergiciel de cache de Django, vous devriez décorer la vue avec vary_on_headers('Accept') pour que les réponses soient mises en cache de manière appropriée.

HttpRequest.read(size=None)[source]
HttpRequest.readline()[source]
HttpRequest.readlines()[source]
HttpRequest.__iter__()[source]

Les méthodes implémentant une interface de type fichier pour la lecture d’une instance HttpRequest. Ceci rend possible la consommation d’une requête entrante par un système de flux. Un cas typique serait le traitement d’un gros contenu XML avec un analyseur itératif sans devoir construire une arborescence XML complète en mémoire.

Grâce à cette interface standard, une instance HttpRequest peut être directement transmise à un analyseur XML tel que ElementTree:

import xml.etree.ElementTree as ET

for element in ET.iterparse(request):
    process(element)

Objets QueryDict

class QueryDict[source]

Dans un objet HttpRequest, les attributs GET et POST sont des instances de django.http.QueryDict, une classe de type dictionnaire adaptée pour gérer plusieurs valeurs pour une même clé. C’est nécessaire parce que certains éléments de formulaire HTML, comme par exemple <select multiple>, transmettent plusieurs valeurs pour la même clé.

Les objets QueryDict request.POST et request.GET ne sont pas modifiables dans le cadre d’un cycle requête/réponse normal. Pour en obtenir une version modifiable, vous devez en faire une copie avec QueryDict.copy().

Méthodes

QueryDict implémente toutes les méthodes de dictionnaire standard dans la mesure où il s’agit d’une sous-classe du type dictionnaire. Les exceptions sont relevées ci-dessous :

QueryDict.__init__(query_string=None, mutable=False, encoding=None)[source]

Crée une instance d’objet QueryDict en fonction de query_string.

>>> QueryDict("a=1&a=2&c=3")
<QueryDict: {'a': ['1', '2'], 'c': ['3']}>

Si query_string n’est pas transmis, le dictionnaire QueryDict résultant sera vide (il ne possédera aucune clé ni valeur).

La plupart des objets QueryDict rencontrés, en particulier ceux correspondant à request.POST et request.GET ne sont pas modifiables. Si vous en créez un vous-même, vous pouvez le rendre modifiable en passant mutable=True à son constructeur __init__().

Les chaînes servant à définir les clés et les valeurs sont converties en chaînes str à l’aide du codage encoding. Si ce dernier n’est pas défini, le codage par défaut est DEFAULT_CHARSET.

classmethod QueryDict.fromkeys(iterable, value='', mutable=False, encoding=None)[source]

Crée un nouveau QueryDict avec les clés de iterable et chaque valeur valant value. Par exemple :

>>> QueryDict.fromkeys(["a", "a", "b"], value="val")
<QueryDict: {'a': ['val', 'val'], 'b': ['val']}>
QueryDict.__getitem__(key)

Renvoie la valeur de la clé indiquée. Si la clé possède plus d’une valeur, elle renvoie la dernière valeur. Génère django.utils.datastructures.MultiValueDictKeyError si la clé n’existe pas (cette exception héritant de l’exception Python standard KeyError, vous pouvez toujours l’intercepter par KeyError).

QueryDict.__setitem__(key, value)[source]

Définit la clé donnée à [value] (une liste dont l’unique élément est value). Notez que tout comme les autres fonctions de dictionnaire qui ont des effets de bord, cette méthode ne peut être appelée que pour un objet QueryDict modifiable (comme une instance créée par QueryDict.copy()).

QueryDict.__contains__(key)

Renvoie True si la clé donnée est définie. Cela permet par exemple d’écrire if "foo" in request.GET.

QueryDict.get(key, default=None)

Utilise la même logique que __getitem__(), avec un point d’entrée pour renvoyer une valeur par défaut si la clé n’existe pas.

QueryDict.setdefault(key, default=None)[source]

Comme dict.setdefault(), sauf qu’en interne, c’est __setitem__() qui est utilisé.

QueryDict.update(other_dict)

Accepte soit un objet QueryDict, soit un dictionnaire. Identique à dict.update(), sauf que le contenu est ajouté aux éléments actuels du dictionnaire au lieu de les remplacer. Par exemple :

>>> q = QueryDict("a=1", mutable=True)
>>> q.update({"a": "2"})
>>> q.getlist("a")
['1', '2']
>>> q["a"]  # returns the last
'2'
QueryDict.items()

Identique à dict.items(), sauf qu’elle utilise la même logique de dernière valeur que __getitem__() et renvoie un objet d’itération au lieu d’un objet vue. Par exemple :

>>> q = QueryDict("a=1&a=2&a=3")
>>> list(q.items())
[('a', '3')]
QueryDict.values()

Identique à dict.values(), sauf qu’elle utilise la même logique de dernière valeur que __getitem__() et renvoie un objet d’itération au lieu d’un objet vue. Par exemple :

>>> q = QueryDict("a=1&a=2&a=3")
>>> list(q.values())
['3']

De plus, QueryDict possède les méthodes suivantes :

QueryDict.copy()[source]

Renvoie une copie de l’objet en utilisant copy.deepcopy(). La copie est modifiable, même si l’objet de départ ne l’est pas.

QueryDict.getlist(key, default=None)

Renvoie une liste des données correspondant à la clé demandée. Renvoie une liste vide si la clé n’existe pas et que la valeur default vaut None. Elle renvoie dans tous les cas une liste, sauf si la valeur par défaut fournie n’est pas une liste.

QueryDict.setlist(key, list_)[source]

Définit la clé indiquée à list_ (au contraire de __setitem__()).

QueryDict.appendlist(key, item)[source]

Ajoute un élément à la liste interne associée à la clé.

QueryDict.setlistdefault(key, default_list=None)[source]

Identique à setdefault(), sauf qu’elle accepte une liste de valeurs au lieu d’une valeur unique.

QueryDict.lists()

Comme items(), sauf qu’elle inclut toutes les valeurs, sous forme de liste, pour chaque élément du dictionnaire. Par exemple :

>>> q = QueryDict("a=1&a=2&a=3")
>>> q.lists()
[('a', ['1', '2', '3'])]
QueryDict.pop(key)[source]

Renvoie une liste de valeurs correspondant à la clé donnée et les enlève du dictionnaire. Génère KeyError si la clé n’existe pas. Par exemple :

>>> q = QueryDict("a=1&a=2&a=3", mutable=True)
>>> q.pop("a")
['1', '2', '3']
QueryDict.popitem()[source]

Enlève un élément arbitraire du dictionnaire (puisque ce dernier n’a pas de notion de tri) et renvoie un tuple à deux valeurs contenant la clé ainsi qu’une liste de toutes les valeurs de cette clé. Génère KeyError si le dictionnaire concerné est vide. Par exemple :

>>> q = QueryDict("a=1&a=2&a=3", mutable=True)
>>> q.popitem()
('a', ['1', '2', '3'])
QueryDict.dict()

Renvoie une représentation dict de QueryDict. Pour chaque paire clé/liste dans QueryDict, dict comportera la paire clé/élément ou élément est un élément de la liste en suivant la même logique que QueryDict.__getitem__():

>>> q = QueryDict("a=1&a=3&a=5")
>>> q.dict()
{'a': '5'}
QueryDict.urlencode(safe=None)[source]

Renvoie une représentation textuelle des données au format « chaîne de requête ». Par exemple :

>>> q = QueryDict("a=2&b=3&b=5")
>>> q.urlencode()
'a=2&b=3&b=5'

Utilisez le paramètre safe pour transmettre des caractères qui n’ont pas besoin d’être codés. Par exemple :

>>> q = QueryDict(mutable=True)
>>> q["next"] = "/a&b/"
>>> q.urlencode(safe="/")
'next=/a%26b/'

Objets HttpResponse

class HttpResponse[source]

Contrairement aux objets HttpRequest qui sont automatiquement créés par Django, les objets HttpResponse sont de votre responsabilité. Chaque vue que vous écrivez est responsable d’instancier, de remplir et de renvoyer un objet HttpResponse.

La classe HttpResponse se trouve dans le module django.http.

Utilisation

Transmission de chaînes

L’utilisation typique est de transmettre le contenu de la page comme une chaîne, une chaîne d’octets ou un objet memoryview, au constructeur de HttpResponse:

>>> from django.http import HttpResponse
>>> response = HttpResponse("Here's the text of the web page.")
>>> response = HttpResponse("Text only, please.", content_type="text/plain")
>>> response = HttpResponse(b"Bytestrings are also accepted.")
>>> response = HttpResponse(memoryview(b"Memoryview as well."))

Mais si vous souhaitez ajouter du contenu de manière incrémentale, vous pouvez utiliser response comme un objet de type fichier :

>>> response = HttpResponse()
>>> response.write("<p>Here's the text of the web page.</p>")
>>> response.write("<p>Here's another paragraph.</p>")

Transmission d’itérateurs

Pour terminer, vous pouvez transmettre un itérateur au lieu d’une chaîne à HttpResponse. HttpResponse consomme immédiatement l’itérateur, stocke son contenu sous forme de chaîne et ne s’en occupe plus. Les objets ayant une méthode close() tels que les fichiers et les générateurs sont immédiatement fermés.

Si vous avez besoin que la réponse soit transmise sous forme de flux de l’itérateur vers le client, vous devez utilisez plutôt la classe StreamingHttpResponse.

Définition de champs d’en-tête

Pour définir ou enlever un champ d’en-tête de la réponse, utilisez HttpResponse.headers:

>>> response = HttpResponse()
>>> response.headers["Age"] = 120
>>> del response.headers["Age"]

Il est aussi possible de manipuler les en-têtes en traitant la réponse comme un dictionnaire :

>>> response = HttpResponse()
>>> response["Age"] = 120
>>> del response["Age"]

C’est une autre manière d’accéder à HttpResponse.headers, c’était l’interface d’origine offerte par HttpResponse.

Avec cette interface et contrairement à un dictionnaire, del ne génère pas d’exception KeyError si le champ d’en-tête n’existe pas.

Vous pouvez aussi définir des en-têtes lors de l’instanciation :

>>> response = HttpResponse(headers={"Age": 120})

Pour définir les champs d’en-tête Cache-Control et Vary, il est recommandé d’utiliser les méthodes patch_cache_control() et patch_vary_headers() provenant de django.utils.cache, car ces champs peuvent contenir plusieurs valeurs séparées par des virgules. Les méthodes « patch » garantissent que les autres valeurs, par exemple celles ajoutées par un intergiciel, ne sont pas écrasées.

Les champs d’en-tête HTTP ne peuvent contenir de sauts de ligne. Si vous essayez de définir un contenu de champ d’en-tête avec un caractère de saut de ligne (CR ou LF), une exception BadHeaderError sera générée.

Réponse indiquant au navigateur de la traiter comme fichier à télécharger

Pour indiquer au navigateur qu’une réponse doit être traitée comme un fichier à télécharger, définissez les en-têtes Content-Type et Content-Disposition. Par exemple, voici comment vous pouvez renvoyer une feuille de calcul Microsoft Excel :

>>> response = HttpResponse(
...     my_data,
...     headers={
...         "Content-Type": "application/vnd.ms-excel",
...         "Content-Disposition": 'attachment; filename="foo.xls"',
...     },
... )

Il n’y a rien de spécifique à Django à propos de l’en-tête Content-Disposition, mais cette syntaxe est vite oubliée, c’est pourquoi nous l’avons incluse ici.

Attributs

HttpResponse.content[source]

Une chaîne d’octets représentant le contenu, codée à partir d’une chaîne, si nécessaire.

HttpResponse.cookies

Un objet http.cookies.SimpleCookie contenant les cookies inclues dans la réponse.

HttpResponse.headers

Un objet similaire à un dictionnaire, insensible à la casse, qui offre une interface vers tous les en-têtes HTTP de la réponse, à l’exception de l’en-tête Set-Cookie. Voir Définition de champs d’en-tête et HttpResponse.cookies.

HttpResponse.charset

Une chaîne indiquant le jeu de caractères dans lequel la réponse sera codée. Si ce paramètre n’est pas indiqué au moment de l’instanciation de HttpResponse, il sera extrait à partir de content_type, et si ce n’est pas fructueux, c’est le réglage DEFAULT_CHARSET qui est utilisé.

HttpResponse.status_code

Le code de statut HTTP de la réponse.

Tant que reason_phrase n’est pas explicitement défini, la modification de la valeur de status_code en dehors du constructeur modifie également la valeur de reason_phrase.

HttpResponse.reason_phrase

La phrase de raison HTTP de la réponse. Elle utilise les phrases de raison par défaut du standard HTTP.

Tant que reason_phrase n’est pas explicitement défini, il est déterminé par la valeur de status_code.

HttpResponse.streaming

Cet attribut est toujours False.

Cet attribut existe pour que des intergiciels puissent traiter les réponses en flux différemment des réponse normales.

HttpResponse.closed

True si la réponse a été fermée.

Méthodes

HttpResponse.__init__(content=b'', content_type=None, status=200, reason=None, charset=None, headers=None)[source]

Instancie un objet HttpResponse avec les contenu, type de contenu et en-têtes de page indiqués.

content et le plus souvent un itérateur, une chaîne d’octets, un objet memoryview ou une chaîne. Les autres types sont convertis en chaîne d’octets en codant leur représentation textuelle. Les itérateurs doivent renvoyer des chaînes ou chaînes d’octets et celles-ci seront concaténées pour former le contenu de la réponse.

content_type est le type MIME pouvant être facultativement complété par un codage de jeu de caractères et sert à remplir l’en-tête HTTP Content-Type. Quand il n’est pas fourni, ce paramètre est formé par 'text/html' et DEFAULT_CHARSET, par défaut : "text/html; charset=utf-8".

status est le code d’état HTTP de la réponse. Vous pouvez utiliser la classe http.HTTPStatus de Python pour attribuer des alias signifiants, tel que HTTPStatus.NO_CONTENT.

reason est la phrase de réponse HTTP. Quand elle n’est pas indiquée, une phrase par défaut est utilisée.

charset est le jeu de caractères dans lequel la réponse sera codée. S’il n’est pas fourni, il sera extrait à partir de content_type, et si ce n’est pas fructueux, c’est le réglage DEFAULT_CHARSET qui est utilisé.

headers est un dict d’en-têtes HTTP pour la réponse.

HttpResponse.__setitem__(header, value)

Définit le nom d’en-tête donné à la valeur donnée. header et value doivent tous les deux être des chaînes.

HttpResponse.__delitem__(header)

Supprime l’en-tête nommé. Échoue silencieusement si l’en-tête n’existe pas. Insensible à la casse.

HttpResponse.__getitem__(header)

Renvoie la valeur correspondant au nom d’en-tête nommé. Insensible à la casse.

HttpResponse.get(header, alternate=None)

Renvoie la valeur correspondant au nom d’en-tête nommé, ou alternate si l’en-tête n’existe pas.

HttpResponse.has_header(header)

Renvoie True ou False sur la base d’une recherche insensible à la casse d’un en-tête ayant le nom indiqué.

HttpResponse.items()

Se comporte comme dict.items() pour les en-têtes HTTP de la réponse.

HttpResponse.setdefault(header, value)

Définit un en-tête pour autant qu’il ne soit pas déjà présent.

Définit un cookie. Les paramètres sont les mêmes que pour l’objet Morsel de la bibliothèque Python standard.

  • max_age doit être un objet timedelta, un nombre entier de secondes ou None (par défaut) si le cookie ne doit durer que le temps de la session du navigateur client. Si expires n’est pas fourni, il est calculé.

  • expires doit être soit une chaîne au format "Wdy, DD-Mon-YY HH:MM:SS GMT", soit un objet datetime.datetime en UTC. Si expires est un objet datetime, la valeur de max_age est calculée.

  • Utilisez domain si vous souhaitez définir un cookie inter-domaine. Par exemple, domain="example.com" définit un cookie lisible par les domaines www.example.com, blog.example.com, etc. Sinon, un cookie est seulement accessible par le domaine qui l’a définit.

  • Indiquez secure=True si vous voulez que le cookie ne soit envoyé au serveur que quand la requête est établie par une connexion https.

  • Utilisez httponly=True si vous souhaitez empêcher du code JavaScript client de pouvoir accéder au cookie.

    HttpOnly est un drapeau inclus dans un en-tête de réponse HTTP Set-Cookie. Il fait partie du standard RFC 6265 pour les cookies, et c’est un moyen utile de réduire le risque d’un script côté client accédant aux données d’un cookie protégé.

  • Utilisez samesite='Strict' ou samesite='Lax' pour indiquer au navigateur de ne pas envoyer ce cookie lors d’une requête vers une origine différente. SameSite n’est pas pris en charge par tous les navigateurs, ce n’est donc pas une solution de remplacement pour la protection CSRF de Django, mais plutôt une mesure défensive de consolidation.

    Utilisez samesite='None' (chaîne) pour indiquer explicitement que ce cookie doit être envoyé avec toutes les requêtes du même site et inter-sites.

Avertissement

La RFC 6265 précise que les agents utilisateurs doivent prendre en charge les cookies d’au moins 4096 octets. Pour beaucoup de navigateurs, c’est aussi la taille maximale. Django ne génère pas d’exception lors de la création d’un cookie de plus de 4096 octets, mais beaucoup de navigateurs ne vont pas stocker le cookie correctement.

Comme set_cookie(), mais le cookie est signé par chiffrement avant d’être défini. À utiliser en combinaison avec HttpRequest.get_signed_cookie(). Vous pouvez utiliser le paramètre facultatif salt pour renforcer la clé, mais vous ne devrez alors pas oublier de le transmettre aussi à l’appel HttpRequest.get_signed_cookie() correspondant.

Supprime le cookie correspondant à la clé nommée. Échoue silencieusement si la clé n’existe pas.

En raison du fonctionnement des cookies, path et domain doivent contenir les mêmes valeurs qui ont été utilisées pour set_cookie() – sinon, le cookie pourrait ne pas être supprimé.

HttpResponse.close()

Cette méthode est appelée à la fin de la requête directement par le serveur WSGI.

HttpResponse.write(content)[source]

Cette méthode transforme une instance HttpResponse en objet de type fichier.

HttpResponse.flush()

Cette méthode transforme une instance HttpResponse en objet de type fichier.

HttpResponse.tell()[source]

Cette méthode transforme une instance HttpResponse en objet de type fichier.

HttpResponse.getvalue()[source]

Renvoie la valeur de HttpResponse.content. Cette méthode transforme une instance HttpResponse en un objet de type flux.

HttpResponse.readable()

Toujours False. Cette méthode transforme une instance HttpResponse en un objet de type flux.

HttpResponse.seekable()

Toujours False. Cette méthode transforme une instance HttpResponse en un objet de type flux.

HttpResponse.writable()[source]

Toujours True. Cette méthode transforme une instance HttpResponse en un objet de type flux.

HttpResponse.writelines(lines)[source]

Écrit une liste de lignes dans la réponse. Les séparateurs de ligne ne sont pas ajoutés. Cette méthode transforme une instance HttpResponse en un objet de type flux.

Sous-classes de HttpResponse

Django inclut un certain nombre de sous-classes de HttpResponse gérant différents types de réponses HTTP. Comme HttpResponse, ces sous-classes se trouvent dans django.http.

class HttpResponseRedirect[source]

Le premier paramètre du constructeur est obligatoire, le chemin vers lequel la redirection doit se faire. Il peut s’agir d’une URL pleinement qualifiée (par ex. 'https://www.yahoo.com/search/'), un chemin absolu sans domaine (par ex. '/search/') ou même un chemin relatif (par ex. 'search/'). Dans ce dernier cas, le navigateur du client reconstruira lui-même l’URL complète en fonction du chemin actuel. Voir HttpResponse pour les autres paramètres facultatifs du constructeur. Notez que cette classe renvoie un code de statut HTTP 302.

url

Cet attribut en lecture seule représente l’URL vers laquelle la réponse va rediriger (équivalent à l’en-tête de réponse Location).

class HttpResponsePermanentRedirect[source]

Comme HttpResponseRedirect, mais renvoie une redirection permanente (code de statut HTTP 301) au lieu d’un redirection « found » (code de statut 302).

class HttpResponseNotModified[source]

Le constructeur n’accepte aucun paramètre et cette réponse n’accepte aucun contenu. Cette classe permet d’indiquer qu’une page n’a pas été modifiée depuis la dernière requête de l’utilisateur (code de statut 304).

class HttpResponseBadRequest[source]

Se comporte comme HttpResponse mais renvoie un code de statut 400.

class HttpResponseNotFound[source]

Se comporte comme HttpResponse mais renvoie un code de statut 404.

class HttpResponseForbidden[source]

Se comporte comme HttpResponse mais renvoie un code de statut 403.

class HttpResponseNotAllowed[source]

Comme HttpResponse mais renvoie un code de statut 405. Le premier paramètre du constructeur est obligatoire : une liste de méthodes autorisées (par ex. ['GET', 'POST']).

class HttpResponseGone[source]

Se comporte comme HttpResponse mais renvoie un code de statut 410.

class HttpResponseServerError[source]

Se comporte comme HttpResponse mais renvoie un code de statut 500.

Note

Si une sous-classe personnalisée de HttpResponse implémente une méthode render, Django considère qu’elle émule une réponse SimpleTemplateResponse, et la méthode render doit elle-même renvoyer un objet réponse valide.

Classes de réponses personnalisées

Si vous rencontrez le besoin d’utiliser une classe de réponse que Django ne fournit pas, vous pouvez la créer à l’aide de http.HTTPStatus. Par exemple

from http import HTTPStatus
from django.http import HttpResponse


class HttpResponseNoContent(HttpResponse):
    status_code = HTTPStatus.NO_CONTENT

Objets JsonResponse

class JsonResponse(data, encoder=DjangoJSONEncoder, safe=True, json_dumps_params=None, **kwargs)[source]

Une sous-classe de HttpResponse aidant à la création d’une réponse codée en JSON. Elle hérite de la plupart du comportement de sa classe parente avec quelques différences :

La valeur par défaut de son en-tête Content-Type est application/json.

Le premier paramètre, data, doit être une instance de dict. Si le paramètre safe est défini à False (voir ci-dessous), il peut s’agir de n’importe quel objet sérialisable en JSON.

Le codeur encoder qui contient par défaut django.core.serializers.json.DjangoJSONEncoder est utilisé pour sérialiser les données. Voir sérialisation JSON pour plus de détails sur ce sérialiseur.

Le paramètre booléen safe vaut True par défaut. S’il est défini à False, n’importe quel objet peut être soumis à la sérialisation (sinon seules les instances de dict sont autorisées). Si safe vaut True et qu’un objet qui n’est pas un dictionnaire est transmis comme premier paramètre, une exception TypeError est générée.

Le paramètre json_dumps_params est un dictionnaire de paramètres nommés à transmettre à l’appel json.dumps() utilisé pour générer la réponse.

Utilisation

Voici à quoi peut ressembler une utilisation typique :

>>> from django.http import JsonResponse
>>> response = JsonResponse({"foo": "bar"})
>>> response.content
b'{"foo": "bar"}'

Sérialisation d’objets non dictionnaires

Pour pouvoir sérialiser des objets autres que des dictionnaires, il faut définir le paramètre safe à False:

>>> response = JsonResponse([1, 2, 3], safe=False)

Dans le cas où safe=False n’est pas transmis, une exception TypeError est produite.

Notez qu’une API basée sur des objets dict est plus extensible, souple et facilite le maintien de la compatibilité ascendante. C’est pourquoi vous devriez éviter d’utiliser des objets qui ne sont pas des dictionnaires dans les réponses codées en JSON.

Avertissement

Avant la 5e édition de ECMAScript `_, il était possible de corrompre le constructeur ``Array` de JavaScript. C’est pour cette raison que Django ne permet pas de transmettre par défaut des objets non dictionnaires au constructeur JsonResponse. Cependant, la plupart des navigateurs modernes implémentent ECMAScript 5, ce qui élimine ce vecteur d’attaque. Il est donc possible de désactiver cette mesure de sécurité.

Modification du codeur JSON par défaut

Si vous avez besoin d’utiliser une classe de codage JSON différente, vous pouvez transmettre le paramètre encoder à la méthode du constructeur :

>>> response = JsonResponse(data, encoder=MyJSONEncoder)

Objets StreamingHttpResponse

class StreamingHttpResponse[source]

La classe StreamingHttpResponse est utilisée pour produire une réponse en flux de Django vers le navigateur.

Utilisation avancée

StreamingHttpResponse est une utilisation experte dans le sens où il est important de savoir si l’application sera servie de manière synchrone sous WSGI ou de manière asynchrone sous ASGI, et son utilisation doit s’ajuster en fonction de la situation.

Veuillez lire soigneusement ces remarques.

Un exemple d’utilisation de StreamingHttpResponse sous WSGI est la diffusion de contenu dans le cas où une réponse prendrait beaucoup trop de temps ou utiliserait trop de mémoire. Par exemple, c’est utile pour générer de gros fichiers CSV.

Il faut cependant tenir compte de conséquences sur les performances si on fait cela. Django fonctionnant sous WSGI est conçu pour traiter des requêtes de courte durée. Les réponses en flux lient un processus de travail pour toute la durée de la réponse. Cela peut amener à des pertes de performance.

Généralement, les tâches lourdes devraient être exécutées en dehors du cycle requête-réponse, plutôt que de faire appel à une réponse en flux.

Toutefois, si Django est sous un serveur ASGI, une réponse StreamingHttpResponse ne bloque pas le service d’autres requêtes si elle est en attente d’entrée/sortie. Cela ouvre des possibilités pour des requêtes de longue durée pour servir du contenu en flux et implémenter des modèles tels que le « long-polling » et les événements envoyés depuis le serveur (server-sent events).

Même avec ASGI, notez que StreamingHttpResponse ne devrait être utilisée que dans les situations qui exigent vraiment que l’accès par itération au contenu global ne se fasse qu’au moment de transférer les données au client. Comme le contenu n’est pas directement accessible, beaucoup d’intergiciels ne peuvent pas fonctionner correctement. Par exemple, les en-têtes ETag et Content-Length ne peuvent pas être générés pour les réponses en flux.

La classe StreamingHttpResponse n’hérite pas de HttpResponse, parce que son API est légèrement différente. Cependant, elle est presque identique, à l’exception des différences notables suivantes :

  • Elle devrait recevoir comme contenu un itérateur qui produit des chaînes d’octets, du contenu memoryview ou des chaînes de texte. Lorsque le serveur est sous WSGI, cela devrait être un itérateur synchrone. Sous ASGI, cela devrait être un itérateur asynchrone.

  • Le seul moyen d’accéder à son contenu est d’itérer sur l’objet réponse lui-même. Cela ne devrait se faire qu’au moment de renvoyer la réponse au client : vous ne devez pas le faire vous-même.

    Avec WSGI, l’itération sur la réponse se fera de manière synchrone. Avec ASGI, cela se fera de manière asynchrone (c’est pourquoi le type d’itérateur doit correspondre au protocole utilisé).

    Pour éviter un plantage, un type d’itérateur incorrect sera remplacé par le type correct durant l’itération et un avertissement sera donné, mais pour cela, l’itérateur doit être pleinement consommé, ce qui casse totalement l’intérêt d’utiliser une réponse StreamingHttpResponse.

  • Elle n’a pas d’attribut content. Par contre, elle possède l’attribut streaming_content. Il peut être exploité dans un intergiciel pour envelopper l’itérable de la réponse, mais il ne devrait pas être consommé.

  • Vous ne pouvez pas utiliser les méthodes de type fichier tell() ou write(). Si vous le faites, vous obtiendrez une exception.

La classe de base HttpResponseBase est commune aux classes HttpResponse et StreamingHttpResponse.

Attributs

StreamingHttpResponse.streaming_content[source]

Un itérateur de contenu de la réponse, codé en chaîne d’octets en fonction de HttpResponse.charset.

StreamingHttpResponse.status_code

Le code de statut HTTP de la réponse.

Tant que reason_phrase n’est pas explicitement défini, la modification de la valeur de status_code en dehors du constructeur modifie également la valeur de reason_phrase.

StreamingHttpResponse.reason_phrase

La phrase de raison HTTP de la réponse. Elle utilise les phrases de raison par défaut du standard HTTP.

Tant que reason_phrase n’est pas explicitement défini, il est déterminé par la valeur de status_code.

StreamingHttpResponse.streaming

Cet attribut est toujours True.

StreamingHttpResponse.is_async

Valeur booléenne indiquant si StreamingHttpResponse.streaming_content est un itérateur asynchrone ou non.

Ceci est utile pour les intergiciels devant envelopper StreamingHttpResponse.streaming_content.

Gestion des déconnexions

New in Django 5.0.

Si le client se déconnecte durant une réponse en flux, Django annule la coroutine qui traite la réponse. Si vous souhaitez purger manuellement les ressources, vous pouvez le faire en interceptant asyncio.CancelledError:

async def streaming_response():
    try:
        # Do some work here
        async for chunk in my_streaming_iterator():
            yield chunk
    except asyncio.CancelledError:
        # Handle disconnect
        ...
        raise


async def my_streaming_view(request):
    return StreamingHttpResponse(streaming_response())

Cet exemple ne montre que la manière de traiter la déconnexion du client alors que le flux de la réponse est en cours. Si vous effectuez des opérations de longue exécution dans votre vue avant de renvoyer l’objet StreamingHttpResponse, vous pouvez envisager de traiter les déconnexions dans la vue elle-même.

Objets FileResponse

class FileResponse(open_file, as_attachment=False, filename='', **kwargs)[source]

FileResponse est une sous-classe de StreamingHttpResponse optimisée pour les fichiers binaires. Elle utilise wsgi.file_wrapper si le serveur WSGI le propose, sinon elle diffuse le fichier par petits morceaux.

Si as_attachment=True, l’en-tête Content-Disposition est défini à attachment, ce qui pousse le navigateur à proposer le fichier en téléchargement pour l’utilisateur. Sinon, un en-tête Content-Disposition avec la valeur inline (valeur par défaut des navigateurs) sera défini si un nom de fichier est disponible.

Si open_file ne possède pas de nom ou si son nom n’est pas adéquat, fournissez un nom de fichier personnalisé en utilisant le paramètre filename. Notez que si vous passez un objet de type fichier tel que io.BytesIO, c’est à vous d’appeler seek() si nécessaire avant de le passer à FileResponse.

L’en-tête Content-Length est automatiquement défini lorsqu’il peut être déduit à partir du contenu de open_file.

L’en-tête Content-Type est automatiquement défini lorsqu’il peut être déduit à partir de filename ou du nom de open_file.

FileResponse accepte tout objet de type fichier avec contenu binaire, par exemple un fichier ouvert en mode binaire, comme ceci :

>>> from django.http import FileResponse
>>> response = FileResponse(open("myfile.png", "rb"))

Le fichier sera automatiquement fermé, ne l’ouvrez donc pas avec un gestionnaire de contexte.

Utilisation sous ASGI

L’API de fichier de Python est synchrone. Ceci signifie que le fichier doit être entièrement consommé afin d’être servi avec ASGI.

Si vous souhaitez servir un fichier de manière asynchrone, vous devez recourir à un paquet tiers fournissant une API de fichier asynchrone, tel que aiofiles.

Méthodes

FileResponse.set_headers(open_file)[source]

Cette méthode est automatiquement appelée durant l’initialisation de la réponse ; elle définit différents en-têtes (Content-Length, Content-Type et Content-Disposition) en fonction du fichier open_file.

Classe HttpResponseBase

class HttpResponseBase[source]

La classe HttpResponseBase est commune à toutes les réponses Django. Elle ne devrait jamais être utilisée directement pour créer des réponses, mais elle peut être utile pour du contrôle de type.

Back to Top