django.conf.urls utility functionsLink to this heading#patterns()Link to this heading#A function that takes a prefix, and an arbitrary number of URL patterns, and\nreturns a list of URL patterns in the format Django needs.
\nThe first argument to patterns() is a string prefix. Here's the example\nURLconf from the Django overview:
from django.conf.urls import patterns, url\n\nurlpatterns = patterns('',\n url(r'^articles/([0-9]{4})/$', 'news.views.year_archive'),\n url(r'^articles/([0-9]{4})/([0-9]{2})/$', 'news.views.month_archive'),\n url(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$', 'news.views.article_detail'),\n)\nIn this example, each view has a common prefix -- 'news.views'.\nInstead of typing that out for each entry in urlpatterns, you can use the\nfirst argument to the patterns() function to specify a prefix to apply to\neach view function.
With this in mind, the above example can be written more concisely as:
\nfrom django.conf.urls import patterns, url\n\nurlpatterns = patterns('news.views',\n url(r'^articles/([0-9]{4})/$', 'year_archive'),\n url(r'^articles/([0-9]{4})/([0-9]{2})/$', 'month_archive'),\n url(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$', 'article_detail'),\n)\nNote that you don't put a trailing dot (".") in the prefix. Django puts\nthat in automatically.
The remaining arguments should be tuples in this format:
\n(regular expression, Python callback function [, optional_dictionary [, optional_name]])\nThe optional_dictionary and optional_name parameters are described in\nPassing extra options to view functions.
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)\nurl()Link to this heading#urlpatterns should be a list of url() instances. For example:
urlpatterns = [\n url(r'^index/$', index_view, name="main-view"),\n ...\n]\nThis function takes five arguments, most of which are optional:
\nurl(regex, view, kwargs=None, name=None, prefix='')\nThe kwargs parameter allows you to pass additional arguments to the view\nfunction or method. See Passing extra options to view functions for an example.
See Naming URL patterns for why the name\nparameter is useful.
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, a 2-tuple containing such iterable plus the names of the\napplication namespaces, or a 3-tuple containing the iterable and the names\nof both the application and instance namespace.
module -- URLconf module (or module name)
namespace (string) -- Instance namespace for the URL entries being included
app_name (string) -- Application namespace for the URL entries being included
pattern_list -- Iterable of django.conf.urls.url() instances
app_namespace (string) -- Application namespace for the URL entries being included
instance_namespace (string) -- Instance namespace for the URL entries being included
See Including other URLconfs and URL namespaces and included URLconfs.
\n\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 returns an\nHttpResponseBadRequest.
See the documentation about the 400 (bad request) view for more information.
\nhandler403Link 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 returns an\nHttpResponseForbidden.
See the documentation about the 403 (HTTP Forbidden) view for more information.
\nhandler404Link 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 returns an\nHttpResponseNotFound.
See the documentation about the 404 (HTTP Not Found) view for more information.
\nhandler500Link 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 returns an\nHttpResponseServerError.
See the documentation about the 500 (HTTP Internal Server Error) view for more information.
\n