django.urls functions for use in URLconfsLink to this heading#path()Link to this heading#Returns an element for inclusion in urlpatterns. For example:
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]\nrouteLink to this heading#The route argument should be a string or\ngettext_lazy() (see\nTranslating URL patterns) 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.
When processing a request, Django starts at the first pattern in\nurlpatterns and makes its way down the list, comparing the requested URL\nagainst each pattern until it finds one that matches. See\nHow Django processes a request for more details.
Patterns don’t match GET and POST parameters, or the domain name. For example,\nin a request to https://www.example.com/myapp/, the URLconf will look for\nmyapp/. In a request to https://www.example.com/myapp/?page=3, the\nURLconf will also look for myapp/.
viewLink to this heading#The view argument is a view function or the result of\nas_view() for class-based views. It can\nalso be a django.urls.include().
When Django finds a matching pattern, it calls the specified view function with\nan HttpRequest object as the first argument and any\n«captured» values from the route as keyword arguments.
kwargsLink to this heading#The kwargs argument allows you to pass additional arguments to the view\nfunction or method. See Passing extra options to view functions for an example.
nameLink to this heading#Naming your URL lets you refer to it unambiguously from elsewhere in Django,\nespecially from within templates. This powerful feature allows you to make\nglobal changes to the URL patterns of your project while only touching a single\nfile.
\nSee Naming URL patterns for why the name\nargument is useful.
re_path()Link to this heading#Returns an element for inclusion in urlpatterns. For example:
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\nTranslating URL patterns) 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()Link to this heading#A function that takes a full Python import path to another URLconf module\nthat should be «included» in this place. Optionally, the application\nnamespace and instance namespace where the entries will be included\ninto can also be specified.
\nUsually, the application namespace should be specified by the included\nmodule. If an application namespace is set, the namespace argument\ncan be used to set a different instance namespace.
include() also accepts as an argument either an iterable that returns\nURL patterns or a 2-tuple containing such iterable plus the names of the\napplication namespaces.
See Including other URLconfs and URL namespaces and included URLconfs.
\nregister_converter()Link to this heading#The function for registering a converter for use in path()\nroutes.
The converter argument is a converter class, and type_name is the\nconverter name to use in path patterns. See\nRegistering custom path converters for an example.
django.conf.urls functions for use in URLconfsLink to this heading#static()Link to this heading#Helper function to return a URL pattern for serving files in debug mode:
\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)\nhandler400Link to this heading#A callable, or a string representing the full Python import path to the view\nthat should be called if the HTTP client has sent a request that caused an error\ncondition and a response with a status code of 400.
\nBy default, this is django.views.defaults.bad_request(). If you\nimplement a custom view, be sure it accepts request and exception\narguments and returns an HttpResponseBadRequest.
handler403Link to this heading#A callable, or a string representing the full Python import path to the view\nthat should be called if the user doesn’t have the permissions required to\naccess a resource.
\nBy default, this is django.views.defaults.permission_denied(). If you\nimplement a custom view, be sure it accepts request and exception\narguments and returns an HttpResponseForbidden.
handler404Link to this heading#A callable, or a string representing the full Python import path to the view\nthat should be called if none of the URL patterns match.
\nBy default, this is django.views.defaults.page_not_found(). If you\nimplement a custom view, be sure it accepts request and exception\narguments and returns an HttpResponseNotFound.
handler500Link to this heading#A callable, or a string representing the full Python import path to the view\nthat should be called in case of server errors. Server errors happen when you\nhave runtime errors in view code.
\nBy default, this is django.views.defaults.server_error(). If you\nimplement a custom view, be sure it accepts a request argument and returns\nan HttpResponseServerError.