django.urls à utiliser dans les configurations d’URLLien vers cette rubrique#path()Lien vers cette rubrique#Renvoie un élément à inclure dans urlpatterns. Par exemple
from django.urls import include, path\n\nurlpatterns = [\n path("index/", views.index, name="main-view"),\n path("bio/<username>/", views.bio, name="bio"),\n path("articles/<slug:title>/", views.article, name="article-detail"),\n path("articles/<slug:title>/<int:section>/", views.section, name="article-section"),\n path("blog/", include("blog.urls")),\n ...,\n]\nrouteLien vers cette rubrique#The route argument should be a string or\ngettext_lazy() (see\nTraduction de motifs d’URL) that contains a URL pattern. The string\nmay contain angle brackets (like <username> above) to capture part of the\nURL and send it as a keyword argument to the view. The angle brackets may\ninclude a converter specification (like the int part of <int:section>)\nwhich limits the characters matched and may also change the type of the\nvariable passed to the view. For example, <int:section> matches a string\nof decimal digits and converts the value to an int.
Lorsqu’il traite une requête, Django commence par le premier motif dans urlpatterns puis continue de parcourir la liste en comparant l’URL reçue avec chaque motif jusqu’à ce qu’il en trouve un qui correspond. Voir Processus de traitement des requêtes par Django pour plus de détails.
Les motifs ne cherchent pas dans les paramètres GET et POST, ni dans le nom de domaine. Par exemple, dans une requête vers https://www.example.com/myapp/, l’URLconf va chercher myapp/. Dans une requête vers https://www.example.com/myapp/?page=3, l’URLconf va aussi chercher myapp/.
viewLien vers cette rubrique#Le paramètre view est une fonction de vue ou le résultat de as_view() pour les vues fondées sur des classes. Cela peut aussi être une inclusion django.urls.include().
Lorsque Django trouve un motif correspondant, il appelle la fonction de vue spécifiée, avec un objet HttpRequest comme premier paramètre et toutes les valeurs « capturées » par la route sous forme de paramètres nommés.
kwargsLien vers cette rubrique#Le paramètre kwargs permet de transmettre des paramètres supplémentaires à la fonction ou méthode de vue. Voir Transmission de paramètres supplémentaires à une vue pour un exemple.
nameLien vers cette rubrique#Le nommage des URL permet de les référencer de manière non ambiguë depuis d’autres portions de code Django, en particulier depuis les gabarits. Cette fonctionnalité puissante permet d’effectuer des changements globaux dans les modèles d’URL de votre projet en ne modifiant qu’un seul fichier.
\nVoir Nommage des motifs d’URL pour connaître l’utilité du paramètre name.
re_path()Lien vers cette rubrique#Renvoie un élément à inclure dans urlpatterns. Par exemple
from django.urls import include, re_path\n\nurlpatterns = [\n re_path(r"^index/$", views.index, name="index"),\n re_path(r"^bio/(?P<username>\\w+)/$", views.bio, name="bio"),\n re_path(r"^blog/", include("blog.urls")),\n ...,\n]\nThe route argument should be a string or\ngettext_lazy() (see\nTraduction de motifs d’URL) that contains a regular expression compatible\nwith Python’s re module. Strings typically use raw string syntax\n(r'') so that they can contain sequences like \\d without the need to\nescape the backslash with another backslash. When a match is made, captured\ngroups from the regular expression are passed to the view – as named arguments\nif the groups are named, and as positional arguments otherwise. The values are\npassed as strings, without any type conversion.
When a route ends with $ the whole requested URL, matching against\npath_info, must match the regular expression\npattern (re.fullmatch() is used).
The view, kwargs and name arguments are the same as for\npath().
include()Lien vers cette rubrique#Une fonction acceptant un chemin d’importation Python complet vers un autre module de configuration d’URL devant être « inclus » à cet endroit. Il est possible d’indiquer aussi l’espace de noms d’application et l’espace de noms d’instance dans lesquels les éléments seront inclus.
\nHabituellement, l’espace de noms d’application doit être défini par le module inclus. Si un espace de noms d’application est défini, le paramètre namespace peut être utilisé pour définir un espace de noms d’instance différent.
include() accepte aussi en paramètre soit un objet itérable renvoyant des motifs d’URL ou un tuple binaire contenant un tel objet itérable accompagné des noms des espaces de noms d’application.
Voir Inclusion d’autres URLconfs et Espaces de noms d’URL et configurations d’URL incluses.
\nregister_converter()Lien vers cette rubrique#The function for registering a converter for use in path()\nroutes.
Le paramètre converter est une classe de convertisseur et type_name est le nom du convertisseur à utiliser dans les motifs de chemins. Voir Inscription de convertisseurs de chemin personnalisés pour trouver un exemple.
django.conf.urls à utiliser dans les configurations d’URLLien vers cette rubrique#static()Lien vers cette rubrique#Fonction utilitaire qui renvoie un motif d’URL pour servir les fichiers en mode débogage :
\nfrom django.conf import settings\nfrom django.conf.urls.static import static\n\nurlpatterns = [\n # ... the rest of your URLconf goes here ...\n] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)\nhandler400Lien vers cette rubrique#Un objet exécutable ou une chaîne représentant le chemin d’importation Python complet vers la vue devant être appelée si le client HTTP a envoyé une requête qui a provoqué une condition d’erreur et une réponse avec un code de statut 400.
\nPar défaut, il s’agit de django.views.defaults.bad_request(). Si vous implémentez une vue personnalisée, vérifiez qu’elle accepte les paramètres request et exception et qu’elle renvoie une réponse HttpResponseBadRequest.
handler403Lien vers cette rubrique#Un objet exécutable ou une chaîne représentant le chemin d’importation Python complet vers la vue devant être appelée si l’utilisateur n’a pas les droits nécessaires pour accéder à une ressource.
\nPar défaut, il s’agit de django.views.defaults.permission_denied(). Si vous implémentez une vue personnalisée, vérifiez qu’elle accepte les paramètres request et exception et qu’elle renvoie une réponse HttpResponseForbidden.
handler404Lien vers cette rubrique#Un objet exécutable ou une chaîne représentant le chemin d’importation Python complet vers la vue devant être appelée si aucun des motifs d’URL ne correspond.
\nPar défaut, il s’agit de django.views.defaults.page_not_found(). Si vous implémentez une vue personnalisée, vérifiez qu’elle accepte les paramètres request et exception et qu’elle renvoie une réponse HttpResponseNotFound.
handler500Lien vers cette rubrique#Un objet exécutable ou une chaîne représentant le chemin d’importation Python complet vers la vue devant être appelée en cas d’erreur de serveur. Les erreurs de serveur se produisent lorsque des erreurs d’exécution apparaissent dans le code des vues.
\nPar défaut, il s’agit de django.views.defaults.server_error(). Si vous implémentez une vue personnalisée, assurez-vous qu’elle accepte un paramètre request et qu’elle renvoie une réponse HttpResponseServerError.