Formulaires Django

Les formulaires HTML sont un moyen classique d'assurer l'interactivité sur les sites web. Ce chapitre présentera comment utiliser Django pour traiter les données de formulaire soumises par les utilisateurs.


Requête HTTP

Le protocole HTTP fonctionne selon un mode « requête-réponse ». Lorsqu'un client envoie une requête, il peut y joindre des données. En analysant la requête, le serveur peut obtenir les données envoyées par le client et fournir des services spécifiques en fonction de l'URL.

Méthode GET

Dans notre projet précédent, créez un fichier search.py pour recevoir les requêtes des utilisateurs :

Code du fichier /HelloWorld/HelloWorld/search.py :

from django.http import HttpResponse from django.shortcuts import render # Formulaire def search_form(request): return render(request, 'search_form.html') # Recevoir les données de la requête def search(request): request.encoding='utf-8' if 'q' in request.GET and request.GET['q']: message = 'Le contenu que vous avez recherché est :' + request.GET['q'] else: message = 'Vous avez soumis un formulaire vide' return HttpResponse(message)

Ajoutez le formulaire search_form.html dans le répertoire templates :

Code du fichier /HelloWorld/templates/search_form.html :

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Exemple (example.com)</title> </head> <body> <form action="/search/" method="get"> <input type="text" name="q"> <input type="submit" value="Search"> </form> </body> </html>

Modifiez les règles du fichier urls.py sous la forme suivante :

Code du fichier /HelloWorld/HelloWorld/urls.py :

from django.conf.urls import url from . import views,testdb,search urlpatterns = [ url(r'^hello/$', views.example), url(r'^testdb/$', testdb.testdb), url(r'^search-form/$', search.search_form), url(r'^search/$', search.search), ]

Adresse d'accèshttp://127.0.0.1:8000/search-form/Et recherchez, les résultats sont les suivants :

Méthode POST

Ci-dessus, nous avons utilisé la méthode GET, et l'affichage de la vue et le traitement des requêtes sont gérés par deux fonctions distinctes.

Lors de la soumission de données, la méthode POST est plus couramment utilisée. Ci-dessous, nous utilisons cette méthode, et utilisons une seule URL et une fonction de gestion pour à la fois afficher la vue et traiter la requête.

Nous créons post.html dans templates :

Le code du fichier pour /HelloWorld/templates/post.html :

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Exemple (example.com)</title> </head> <body> <form action="/search-post/" method="post"> {% csrf_token %} <input type="text" name="q"> <input type="submit" value="Search"> </form> <p>{{ rlt }}</p> </body> </html>

À la fin du template, nous ajoutons un marqueur rlt pour réserver une position pour le résultat du traitement du formulaire.

Après le formulaire, il y a aussi une{% csrf_token %}balise. CSRF signifie Cross Site Request Forgery. C'est une fonctionnalité fournie par Django pour empêcher la soumission de requêtes déguisées. Les formulaires soumis avec la méthode POST doivent inclure cette balise.

Créez un nouveau fichier search2.py dans le répertoire HelloWorld et utilisez la fonction search_post pour gérer les requêtes POST :

/HelloWorld/HelloWorld/search2.py code du fichier :

# -*- coding: utf-8 -*- from django.shortcuts import render from django.views.decorators import csrf # Recevoir les données de la requête POST def search_post(request): ctx ={} if request.POST: ctx['rlt'] = request.POST['q'] return render(request, "post.html", ctx)

Modifiez les règles du fichier urls.py sous la forme suivante :

Code du fichier /HelloWorld/HelloWorld/urls.py :

from django.conf.urls import url from . import views,testdb,search,search2 urlpatterns = [ url(r'^hello/$', views.hello), url(r'^testdb/$', testdb.testdb), url(r'^search-form/$', search.search_form), url(r'^search/$', search.search), url(r'^search-post/$', search2.search_post), ]

Visitezhttp://127.0.0.1:8000/search-post/Les résultats affichés sont les suivants :

Après avoir terminé l'exemple ci-dessus, notre arborescence de répertoires est :

HelloWorld
|-- HelloWorld
|   |-- __init__.py
|   |-- __init__.pyc
|   |-- search.py
|   |-- search.pyc
|   |-- search2.py
|   |-- search2.pyc
|   |-- settings.py
|   |-- settings.pyc
|   |-- testdb.py
|   |-- testdb.pyc
|   |-- urls.py
|   |-- urls.pyc
|   |-- views.py
|   |-- views.pyc
|   |-- wsgi.py
|   `-- wsgi.pyc
|-- TestModel
|   |-- __init__.py
|   |-- __init__.pyc
|   |-- admin.py
|   |-- admin.pyc
|   |-- apps.py
|   |-- migrations
|   |   |-- 0001_initial.py
|   |   |-- 0001_initial.pyc
|   |   |-- __init__.py
|   |   `-- __init__.pyc
|   |-- models.py
|   |-- models.pyc
|   |-- tests.py
|   `-- views.py
|-- db.sqlite3
|-- manage.py
`-- templates
    |-- base.html
    |-- hello.html
    |-- post.html
    `-- search_form.html

Objet de requête

Le premier paramètre de chaque fonction de vue est un objet HttpRequest, comme la fonction example() ci-dessous :

from django.http import HttpResponse

def example(request):
    return HttpResponse("Hello world")

L'objet HttpRequest contient certaines informations sur l'URL de la requête actuelle :

Propriété

Description

path

Le chemin complet de la page demandée, sans inclure le nom de domaine — par exemple, "/hello/".

method

La représentation sous forme de chaîne de la méthode HTTP utilisée dans la requête. Représentation en majuscules. Par exemple :

if request.method == 'GET':
    do_something()
elif request.method == 'POST':
    do_something_else()

GET

Un objet semblable à un dictionnaire contenant tous les paramètres HTTP GET. Voir la documentation de QueryDict.

POST

Un objet semblable à un dictionnaire contenant tous les paramètres HTTP POST. Voir la documentation de QueryDict.

Il est possible que le serveur reçoive une requête POST vide. C'est-à-dire que le formulaire soumet une requête via la méthode HTTP POST, mais le formulaire peut ne contenir aucune donnée. Par conséquent, vous ne pouvez pas utiliser l'instruction if request.POST pour déterminer si la méthode HTTP POST est utilisée ; vous devez utiliser if request.method == "POST" (voir l'attribut method dans ce tableau).

Remarque : POST n'inclut pas les informations de téléversement de fichiers. Voir l'attribut FILES.

REQUEST

Pour plus de commodité, cet attribut est une combinaison des attributs POST et GET, mais il a un comportement spécial : il recherche d'abord l'attribut POST, puis l'attribut GET. Il est calqué sur $_REQUEST de PHP.

Par exemple, if GET = {"name": "john"} and POST = {"age": '34'}, alors REQUEST["name"] vaut "john" et REQUEST["age"] vaut "34".

Il est fortement recommandé d'utiliser GET et POST, car ces deux attributs sont plus explicites et le code écrit est plus facile à comprendre.

COOKIE

Un objet dictionnaire Python standard contenant tous les cookies. Les clés et les valeurs sont des chaînes de caractères.

FILES

Objet de type dictionnaire contenant tous les fichiers téléversés. Chaque clé dans FILES est la valeur de l'attribut name dans la balise <input type="file" name="" />. Chaque valeur dans FILES est également un objet dictionnaire Python standard, contenant les trois clés suivantes :

  • filename : le nom du fichier téléversé, représenté sous forme de chaîne Python.
  • content-type : type de contenu du fichier téléversé
  • content : le contenu brut du fichier téléversé.

Remarque : FILES ne contient des données que lorsque la méthode de requête est POST et que le <form> de la page de requête possède l'attribut enctype="multipart/form-data". Sinon, FILES est un dictionnaire vide.

META

Un dictionnaire contenant toutes les informations d'en-tête HTTP disponibles. Par exemple :

  • CONTENT_LENGTH
  • CONTENT_TYPE
  • QUERY_STRING : la chaîne de requête brute non analysée.
  • REMOTE_ADDR : adresse IP du client
  • REMOTE_HOST : nom d'hôte du client
  • SERVER_NAME : nom d'hôte du serveur
  • SERVER_PORT : port du serveur

Ces en-têtes dans META sont préfixés parHTTP_La partie avant les deux-points (:) est la clé, et la partie après est la valeur, par exemple :

  • HTTP_ACCEPT_ENCODING
  • HTTP_ACCEPT_LANGUAGE
  • HTTP_HOST : les informations d'en-tête d'hôte HTTP envoyées par le client.
  • HTTP_REFERER : page de référence
  • HTTP_USER_AGENT : chaîne user-agent du client
  • HTTP_X_BENDER : informations d'en-tête X-Bender

user

est un objet django.contrib.auth.models.User, représentant l'utilisateur actuellement connecté.

Si l'utilisateur qui accède n'est pas actuellement connecté, user sera initialisé comme une instance de django.contrib.auth.models.AnonymousUser.

Vous pouvez utiliser la méthode is_authenticated() de user pour déterminer si l'utilisateur est connecté :

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

Cet attribut n'est disponible que lorsque AuthenticationMiddleware dans Django est activé.

session

Le seul attribut en lecture-écriture, un objet dictionnaire représentant la session en cours. Cet attribut n'est disponible que lorsque la prise en charge des sessions de Django est activée.

raw_post_data

Les données HTTP POST brutes, non analysées. Cela est utile pour un traitement avancé.

L'objet Request possède également quelques méthodes utiles :

MéthodesDescription
__getitem__(key) Renvoie la valeur associée à la clé depuis GET/POST, en prenant d'abord POST, puis GET. Lève une KeyError si la clé n'existe pas.
Cela nous permet d'accéder à l'objet HttpRequest en utilisant la syntaxe des dictionnaires.
Par exemple, request["foo"] équivaut à l'opération consistant à chercher d'abord request.POST["foo"], puis request.GET["foo"].
has_key() Vérifie si request.GET ou request.POST contient la clé spécifiée par le paramètre.
get_full_path() Renvoie le chemin de la requête, y compris la chaîne de requête. Par exemple, "/music/bands/the_beatles/?print=true"
is_secure() Renvoie True si la requête est sécurisée, c’est-à-dire si elle a été effectuée via HTTPS.

Objet QueryDict

Dans l’objet HttpRequest, les attributs GET et POST sont des instances de la classe django.http.QueryDict.

QueryDict est une classe personnalisée semblable à un dictionnaire utilisée pour gérer le cas où une même clé correspond à plusieurs valeurs.

QueryDict implémente toutes les méthodes standard des dictionnaires. Il inclut également quelques méthodes spéciales :

Méthodes Description

__getitem__

Il y a une différence par rapport à la gestion standard des dictionnaires : si une clé correspond à plusieurs valeurs, __getitem__() renvoie la dernière valeur.

__setitem__

Définit la liste de valeurs (une liste Python) pour la clé spécifiée. Remarque : elle ne peut être appelée que sur un objet QueryDict mutable (c’est-à-dire une copie d’un objet QueryDict créée via copy()).

get()

Si une clé correspond à plusieurs valeurs, get() renvoie la dernière valeur.

update()

Le paramètre peut être un QueryDict ou un dictionnaire standard. Contrairement à la méthode update d’un dictionnaire standard, cette méthode ajoute des éléments de dictionnaire, au lieu de les remplacer :

>>> q = QueryDict('a=1')

>>> q = q.copy() # to make it mutable

>>> q.update({'a': '2'})

>>> q.getlist('a')

 ['1', '2']

>>> q['a'] # returns the last

['2']

items()

Il y a une différence avec la méthode items() d’un dictionnaire standard : cette méthode utilise la logique de valeur unique de __getitem__() :

>>> q = QueryDict('a=1&a=2&a=3')

>>> q.items()

[('a', '3')]

values()

Il y a une différence avec la méthode values() d’un dictionnaire standard : cette méthode utilise la logique de valeur unique de __getitem__() :

De plus, QueryDict dispose également de quelques méthodes, comme indiqué dans le tableau suivant :

Méthodes Description

copy()

Renvoie une copie de l’objet, implémentée en interne à l’aide de copy.deepcopy() de la bibliothèque standard Python. Cette copie est mutable — c’est-à-dire que les valeurs de la copie peuvent être modifiées.

getlist(key)

Renvoie toutes les valeurs correspondant au paramètre key, sous forme de liste Python. Si la clé n’existe pas, renvoie une liste vide. Il est garanti de renvoyer une liste d’un certain type..

setlist(key,list_)

Définit la valeur de key à list_ (contrairement à __setitem__()).

appendlist(key,item)

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

setlistdefault(key,list)

Il y a une différence avec setdefault : il accepte une liste comme paramètre plutôt qu'une valeur unique.

lists()

Il y a une différence par rapport à items() : il renvoie toutes les valeurs pour key sous forme de liste, par exemple :

>>> q = QueryDict('a=1&a=2&a=3')

>>> q.lists()

[('a', ['1', '2', '3'])]

urlencode()

Renvoie une chaîne formatée sous forme de chaîne de requête (par exemple : "a=2&b=3&b=5").

autres extensions