Le paquet django.shortcuts rassemble des fonctions et des classes utilitaires qui recouvrent plusieurs niveaux de l’architecture MVC. En d’autres termes, ces fonctions/classes introduisent un couplage contrôlé à des fins de commodité.
render()Lien vers cette rubrique#Combine un gabarit donné avec un dictionnaire contexte donné et renvoie un objet HttpResponse avec le texte résultant.
Django ne met pas à disposition de fonction raccourci renvoyant une réponse TemplateResponse parce que le constructeur de TemplateResponse présente le même niveau de flexibilité que render().
requestL’objet requête utilisé pour générer la réponse.
\ntemplate_nameLe nom complet d’un gabarit à utiliser ou une liste de noms de gabarits. Si une liste est donnée, le premier gabarit de la liste qui est trouvé sera utilisé. Consultez la documentation du chargement de gabarits pour plus d’informations sur la façon dont les gabarits sont recherchés.
\ncontextUn dictionnaire de valeurs à ajouter un contexte du gabarit. Par défaut, ce dictionnaire est vide. Si une des valeurs du dictionnaire est exécutable, la vue l’appellera immédiatement avant de faire le rendu du gabarit.
\n\ncontext_instanceL’instance de contexte avec laquelle effectuer le rendu du gabarit. Par défaut, le gabarit sera rendu avec une instance RequestContext (complétée par des valeurs de request et context).
content_typeLe type MIME à utiliser pour le document produit. La valeur par défaut est celle du réglage DEFAULT_CONTENT_TYPE.
statusLe code d’état de la réponse. La valeur par défaut est 200.
current_appUne indication de l’application contenant la vue actuelle. Consultez la stratégie de résolution des URL en espaces de noms pour plus d’informations.
\n\nusingLe nom NAME d’un moteur de gabarit à utiliser pour charger le gabarit.
L’exemple suivant effectue le rendu du gabarit myapp/index.html avec le type MIME application/xhtml+xml:
from django.shortcuts import render\n\ndef my_view(request):\n # View code here...\n return render(request, 'myapp/index.html', {\n 'foo': 'bar',\n }, content_type='application/xhtml+xml')\nCet exemple est équivalent à :
\nfrom django.http import HttpResponse\nfrom django.template import loader\n\ndef my_view(request):\n # View code here...\n t = loader.get_template('myapp/index.html')\n c = {'foo': 'bar'}\n return HttpResponse(t.render(c, request), content_type='application/xhtml+xml')\nrender_to_response()Lien vers cette rubrique#Cette fonction a précédé l’introduction de render() et fonctionne de manière similaire, sauf qu’elle ne rend pas la requête disponible dans la réponse. Elle n’est plus recommandée et va probablement être rendue obsolète à l’avenir.
template_nameLe nom complet d’un gabarit à utiliser ou une liste de noms de gabarits. Si une liste est donnée, le premier gabarit de la liste qui est trouvé sera utilisé. Consultez la documentation du chargement de gabarits pour plus d’informations sur la façon dont les gabarits sont recherchés.
\ncontextUn dictionnaire de valeurs à ajouter un contexte du gabarit. Par défaut, ce dictionnaire est vide. Si une des valeurs du dictionnaire est exécutable, la vue l’appellera immédiatement avant de faire le rendu du gabarit.
\n\ncontext_instanceL’instance de contexte avec laquelle effectuer le rendu du gabarit. Par défaut, le gabarit sera rendu avec une instance Context (complétée par des valeurs de context). Si vous avez besoin d’utiliser des processeurs de contexte, produisez plutôt le gabarit avec une instance RequestContext. Votre code pourrait ressembler à ceci :
return render_to_response('my_template.html',\n my_context,\n context_instance=RequestContext(request))\ncontent_typeLe type MIME à utiliser pour le document produit. La valeur par défaut est celle du réglage DEFAULT_CONTENT_TYPE.
statusLe code d’état de la réponse. La valeur par défaut est 200.
usingLe nom NAME d’un moteur de gabarit à utiliser pour charger le gabarit.
redirect()Lien vers cette rubrique#Renvoie une réponse HttpResponseRedirect à l’URL correspondant aux paramètres transmis.
Les paramètres peuvent être :
\nUn modèle : la fonction get_absolute_url() du modèle sera appelée.
Un nom de vue, et potentiellement des paramètres : urlresolvers.reverse sera utilisée pour résoudre le nom.
Une URL absolue ou relative qui sera utilisée telle quelle comme emplacement de redirection.
Produit par défaut une redirection temporaire ; indiquez permanent=True pour produire une redirection permanente.
La fonction redirect() peut être utilisée de différentes manières.
En lui passant un objet ; la méthode get_absolute_url() de l’objet est appelée pour produire l’URL de redirection :
from django.shortcuts import redirect\n\ndef my_view(request):\n ...\n object = MyModel.objects.get(...)\n return redirect(object)\nEn lui passant le nom d’une vue et, en option, des paramètres positionnels ou nommés ; l’URL sera résolue en utilisant la méthode reverse():
def my_view(request):\n ...\n return redirect('some-view-name', foo='bar')\nEn lui passant une URL de redirection fixe :
\ndef my_view(request):\n ...\n return redirect('/some/url/')\nCela fonctionne aussi avec des URL complètes :
\ndef my_view(request):\n ...\n return redirect('https://example.com/')\nPar défaut, redirect() renvoie une redirection temporaire. Toutes les formes ci-dessus acceptent un paramètre permanent qui, s’il est défini à True, produit une redirection permanente :
def my_view(request):\n ...\n object = MyModel.objects.get(...)\n return redirect(object, permanent=True)\nget_object_or_404()Lien vers cette rubrique#Appelle get() d’un gestionnaire de modèle donné, mais génère une exception Http404 au lieu de l’exception DoesNotExist du modèle.
L’exemple suivant obtient l’objet``MyModel`` ayant la clé primaire 1 :
\nfrom django.shortcuts import get_object_or_404\n\ndef my_view(request):\n my_object = get_object_or_404(MyModel, pk=1)\nCet exemple est équivalent à :
\nfrom django.http import Http404\n\ndef my_view(request):\n try:\n my_object = MyModel.objects.get(pk=1)\n except MyModel.DoesNotExist:\n raise Http404("No MyModel matches the given query.")\nLe cas le plus courant est de transmettre un Model, comme montré ci-dessus. Cependant, vous pouvez aussi transmettre une instance QuerySet:
queryset = Book.objects.filter(title__startswith='M')\nget_object_or_404(queryset, pk=1)\nL’exemple ci-dessus est un peu tiré par les cheveux, car il est équivalent à :
\nget_object_or_404(Book, title__startswith='M', pk=1)\nmais cela reste utile dans les cas où vous recevez une variable queryset par un autre moyen.
Finalement, vous pouvez aussi utiliser un gestionnaire (Manager). C’est utile par exemple si vous avez un gestionnaire personnalisé
get_object_or_404(Book.dahl_objects, title='Matilda')\nIl est aussi possible d’utiliser des gestionnaires de liaison:
author = Author.objects.get(name='Roald Dahl')\nget_object_or_404(author.book_set, title='Matilda')\nNote : comme pour get(), une exception MultipleObjectsReturned sera levée si plus d’un objet est renvoyé.
get_list_or_404()Lien vers cette rubrique#Renvoie le résultat de filter() sur un gestionnaire de modèle donné transformé en liste, générant Http404 si la liste résultante est vide.
L’exemple suivant récupère tous les objets publiés de
\nfrom django.shortcuts import get_list_or_404\n\ndef my_view(request):\n my_objects = get_list_or_404(MyModel, published=True)\nCet exemple est équivalent à :
\nfrom django.http import Http404\n\ndef my_view(request):\n my_objects = list(MyModel.objects.filter(published=True))\n if not my_objects:\n raise Http404("No MyModel matches the given query.")\n