urls.txt 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784
  1. ==============
  2. URL dispatcher
  3. ==============
  4. A clean, elegant URL scheme is an important detail in a high-quality Web
  5. application. Django lets you design URLs however you want, with no framework
  6. limitations.
  7. There's no ``.php`` or ``.cgi`` required, and certainly none of that
  8. ``0,2097,1-1-1928,00`` nonsense.
  9. See `Cool URIs don't change`_, by World Wide Web creator Tim Berners-Lee, for
  10. excellent arguments on why URLs should be clean and usable.
  11. .. _Cool URIs don't change: http://www.w3.org/Provider/Style/URI
  12. Overview
  13. ========
  14. To design URLs for an app, you create a Python module informally called a
  15. **URLconf** (URL configuration). This module is pure Python code and is a
  16. simple mapping between URL patterns (simple regular expressions) to Python
  17. functions (your views).
  18. This mapping can be as short or as long as needed. It can reference other
  19. mappings. And, because it's pure Python code, it can be constructed
  20. dynamically.
  21. Django also provides a way to translate URLs according to the active
  22. language. See the :ref:`internationalization documentation
  23. <url-internationalization>` for more information.
  24. .. _how-django-processes-a-request:
  25. How Django processes a request
  26. ==============================
  27. When a user requests a page from your Django-powered site, this is the
  28. algorithm the system follows to determine which Python code to execute:
  29. 1. Django determines the root URLconf module to use. Ordinarily,
  30. this is the value of the :setting:`ROOT_URLCONF` setting, but if the incoming
  31. ``HttpRequest`` object has an attribute called ``urlconf`` (set by
  32. middleware :ref:`request processing <request-middleware>`), its value
  33. will be used in place of the :setting:`ROOT_URLCONF` setting.
  34. 2. Django loads that Python module and looks for the variable
  35. ``urlpatterns``. This should be a Python list of :func:`django.conf.urls.url`
  36. instances.
  37. 3. Django runs through each URL pattern, in order, and stops at the first
  38. one that matches the requested URL.
  39. 4. Once one of the regexes matches, Django imports and calls the given view,
  40. which is a simple Python function (or a :doc:`class based view
  41. </topics/class-based-views/index>`). The view gets passed the following
  42. arguments:
  43. * An instance of :class:`~django.http.HttpRequest`.
  44. * If the matched regular expression returned no named groups, then the
  45. matches from the regular expression are provided as positional arguments.
  46. * The keyword arguments are made up of any named groups matched by the
  47. regular expression, overridden by any arguments specified in the optional
  48. ``kwargs`` argument to :func:`django.conf.urls.url`.
  49. 5. If no regex matches, or if an exception is raised during any
  50. point in this process, Django invokes an appropriate
  51. error-handling view. See `Error handling`_ below.
  52. Example
  53. =======
  54. Here's a sample URLconf::
  55. from django.conf.urls import url
  56. from . import views
  57. urlpatterns = [
  58. url(r'^articles/2003/$', views.special_case_2003),
  59. url(r'^articles/([0-9]{4})/$', views.year_archive),
  60. url(r'^articles/([0-9]{4})/([0-9]{2})/$', views.month_archive),
  61. url(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$', views.article_detail),
  62. ]
  63. Notes:
  64. * To capture a value from the URL, just put parenthesis around it.
  65. * There's no need to add a leading slash, because every URL has that. For
  66. example, it's ``^articles``, not ``^/articles``.
  67. * The ``'r'`` in front of each regular expression string is optional but
  68. recommended. It tells Python that a string is "raw" -- that nothing in
  69. the string should be escaped. See `Dive Into Python's explanation`_.
  70. Example requests:
  71. * A request to ``/articles/2005/03/`` would match the third entry in the
  72. list. Django would call the function
  73. ``views.month_archive(request, '2005', '03')``.
  74. * ``/articles/2005/3/`` would not match any URL patterns, because the
  75. third entry in the list requires two digits for the month.
  76. * ``/articles/2003/`` would match the first pattern in the list, not the
  77. second one, because the patterns are tested in order, and the first one
  78. is the first test to pass. Feel free to exploit the ordering to insert
  79. special cases like this.
  80. * ``/articles/2003`` would not match any of these patterns, because each
  81. pattern requires that the URL end with a slash.
  82. * ``/articles/2003/03/03/`` would match the final pattern. Django would call
  83. the function ``views.article_detail(request, '2003', '03', '03')``.
  84. .. _Dive Into Python's explanation: http://www.diveintopython.net/regular_expressions/street_addresses.html#re.matching.2.3
  85. Named groups
  86. ============
  87. The above example used simple, *non-named* regular-expression groups (via
  88. parenthesis) to capture bits of the URL and pass them as *positional* arguments
  89. to a view. In more advanced usage, it's possible to use *named*
  90. regular-expression groups to capture URL bits and pass them as *keyword*
  91. arguments to a view.
  92. In Python regular expressions, the syntax for named regular-expression groups
  93. is ``(?P<name>pattern)``, where ``name`` is the name of the group and
  94. ``pattern`` is some pattern to match.
  95. Here's the above example URLconf, rewritten to use named groups::
  96. from django.conf.urls import url
  97. from . import views
  98. urlpatterns = [
  99. url(r'^articles/2003/$', views.special_case_2003),
  100. url(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive),
  101. url(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$', views.month_archive),
  102. url(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/(?P<day>[0-9]{2})/$', views.article_detail),
  103. ]
  104. This accomplishes exactly the same thing as the previous example, with one
  105. subtle difference: The captured values are passed to view functions as keyword
  106. arguments rather than positional arguments. For example:
  107. * A request to ``/articles/2005/03/`` would call the function
  108. ``views.month_archive(request, year='2005', month='03')``, instead
  109. of ``views.month_archive(request, '2005', '03')``.
  110. * A request to ``/articles/2003/03/03/`` would call the function
  111. ``views.article_detail(request, year='2003', month='03', day='03')``.
  112. In practice, this means your URLconfs are slightly more explicit and less prone
  113. to argument-order bugs -- and you can reorder the arguments in your views'
  114. function definitions. Of course, these benefits come at the cost of brevity;
  115. some developers find the named-group syntax ugly and too verbose.
  116. The matching/grouping algorithm
  117. -------------------------------
  118. Here's the algorithm the URLconf parser follows, with respect to named groups
  119. vs. non-named groups in a regular expression:
  120. 1. If there are any named arguments, it will use those, ignoring non-named
  121. arguments.
  122. 2. Otherwise, it will pass all non-named arguments as positional arguments.
  123. In both cases, any extra keyword arguments that have been given as per `Passing
  124. extra options to view functions`_ (below) will also be passed to the view.
  125. What the URLconf searches against
  126. =================================
  127. The URLconf searches against the requested URL, as a normal Python string. This
  128. does not include GET or POST parameters, or the domain name.
  129. For example, in a request to ``http://www.example.com/myapp/``, the URLconf
  130. will look for ``myapp/``.
  131. In a request to ``http://www.example.com/myapp/?page=3``, the URLconf will look
  132. for ``myapp/``.
  133. The URLconf doesn't look at the request method. In other words, all request
  134. methods -- ``POST``, ``GET``, ``HEAD``, etc. -- will be routed to the same
  135. function for the same URL.
  136. Captured arguments are always strings
  137. =====================================
  138. Each captured argument is sent to the view as a plain Python string, regardless
  139. of what sort of match the regular expression makes. For example, in this
  140. URLconf line::
  141. url(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive),
  142. ...the ``year`` argument to ``views.year_archive()`` will be a string, not
  143. an integer, even though the ``[0-9]{4}`` will only match integer strings.
  144. Specifying defaults for view arguments
  145. ======================================
  146. A convenient trick is to specify default parameters for your views' arguments.
  147. Here's an example URLconf and view::
  148. # URLconf
  149. from django.conf.urls import url
  150. from . import views
  151. urlpatterns = [
  152. url(r'^blog/$', views.page),
  153. url(r'^blog/page(?P<num>[0-9]+)/$', views.page),
  154. ]
  155. # View (in blog/views.py)
  156. def page(request, num="1"):
  157. # Output the appropriate page of blog entries, according to num.
  158. ...
  159. In the above example, both URL patterns point to the same view --
  160. ``views.page`` -- but the first pattern doesn't capture anything from the
  161. URL. If the first pattern matches, the ``page()`` function will use its
  162. default argument for ``num``, ``"1"``. If the second pattern matches,
  163. ``page()`` will use whatever ``num`` value was captured by the regex.
  164. Performance
  165. ===========
  166. Each regular expression in a ``urlpatterns`` is compiled the first time it's
  167. accessed. This makes the system blazingly fast.
  168. Syntax of the urlpatterns variable
  169. ==================================
  170. ``urlpatterns`` should be a Python list of :func:`~django.conf.urls.url`
  171. instances.
  172. Error handling
  173. ==============
  174. When Django can't find a regex matching the requested URL, or when an
  175. exception is raised, Django will invoke an error-handling view.
  176. The views to use for these cases are specified by four variables. Their
  177. default values should suffice for most projects, but further customization is
  178. possible by assigning values to them.
  179. See the documentation on :ref:`customizing error views
  180. <customizing-error-views>` for the full details.
  181. Such values can be set in your root URLconf. Setting these variables in any
  182. other URLconf will have no effect.
  183. Values must be callables, or strings representing the full Python import path
  184. to the view that should be called to handle the error condition at hand.
  185. The variables are:
  186. * ``handler404`` -- See :data:`django.conf.urls.handler404`.
  187. * ``handler500`` -- See :data:`django.conf.urls.handler500`.
  188. * ``handler403`` -- See :data:`django.conf.urls.handler403`.
  189. * ``handler400`` -- See :data:`django.conf.urls.handler400`.
  190. .. _including-other-urlconfs:
  191. Including other URLconfs
  192. ========================
  193. At any point, your ``urlpatterns`` can "include" other URLconf modules. This
  194. essentially "roots" a set of URLs below other ones.
  195. For example, here's an excerpt of the URLconf for the `Django Web site`_
  196. itself. It includes a number of other URLconfs::
  197. from django.conf.urls import include, url
  198. urlpatterns = [
  199. # ... snip ...
  200. url(r'^community/', include('django_website.aggregator.urls')),
  201. url(r'^contact/', include('django_website.contact.urls')),
  202. # ... snip ...
  203. ]
  204. Note that the regular expressions in this example don't have a ``$``
  205. (end-of-string match character) but do include a trailing slash. Whenever
  206. Django encounters ``include()`` (:func:`django.conf.urls.include()`), it chops
  207. off whatever part of the URL matched up to that point and sends the remaining
  208. string to the included URLconf for further processing.
  209. Another possibility is to include additional URL patterns by using a list of
  210. :func:`~django.conf.urls.url` instances. For example, consider this URLconf::
  211. from django.conf.urls import include, url
  212. from apps.main import views as main_views
  213. from credit import views as credit_views
  214. extra_patterns = [
  215. url(r'^reports/(?P<id>[0-9]+)/$', credit_views.report),
  216. url(r'^charge/$', credit_views.charge),
  217. ]
  218. urlpatterns = [
  219. url(r'^$', main_views.homepage),
  220. url(r'^help/', include('apps.help.urls')),
  221. url(r'^credit/', include(extra_patterns)),
  222. ]
  223. In this example, the ``/credit/reports/`` URL will be handled by the
  224. ``credit.views.report()`` Django view.
  225. This can be used to remove redundancy from URLconfs where a single pattern
  226. prefix is used repeatedly. For example, consider this URLconf::
  227. from django.conf.urls import url
  228. from . import views
  229. urlpatterns = [
  230. url(r'^(?P<page_slug>\w+)-(?P<page_id>\w+)/history/$', views.history),
  231. url(r'^(?P<page_slug>\w+)-(?P<page_id>\w+)/edit/$', views.edit),
  232. url(r'^(?P<page_slug>\w+)-(?P<page_id>\w+)/discuss/$', views.discuss),
  233. url(r'^(?P<page_slug>\w+)-(?P<page_id>\w+)/permissions/$', views.permissions),
  234. ]
  235. We can improve this by stating the common path prefix only once and grouping
  236. the suffixes that differ::
  237. from django.conf.urls import include, url
  238. from . import views
  239. urlpatterns = [
  240. url(r'^(?P<page_slug>\w+)-(?P<page_id>\w+)/', include([
  241. url(r'^history/$', views.history),
  242. url(r'^edit/$', views.edit),
  243. url(r'^discuss/$', views.discuss),
  244. url(r'^permissions/$', views.permissions),
  245. ])),
  246. ]
  247. .. _`Django Web site`: https://www.djangoproject.com/
  248. Captured parameters
  249. -------------------
  250. An included URLconf receives any captured parameters from parent URLconfs, so
  251. the following example is valid::
  252. # In settings/urls/main.py
  253. from django.conf.urls import include, url
  254. urlpatterns = [
  255. url(r'^(?P<username>\w+)/blog/', include('foo.urls.blog')),
  256. ]
  257. # In foo/urls/blog.py
  258. from django.conf.urls import url
  259. from . import views
  260. urlpatterns = [
  261. url(r'^$', views.blog.index),
  262. url(r'^archive/$', views.blog.archive),
  263. ]
  264. In the above example, the captured ``"username"`` variable is passed to the
  265. included URLconf, as expected.
  266. .. _views-extra-options:
  267. Passing extra options to view functions
  268. =======================================
  269. URLconfs have a hook that lets you pass extra arguments to your view functions,
  270. as a Python dictionary.
  271. The :func:`django.conf.urls.url` function can take an optional third argument
  272. which should be a dictionary of extra keyword arguments to pass to the view
  273. function.
  274. For example::
  275. from django.conf.urls import url
  276. from . import views
  277. urlpatterns = [
  278. url(r'^blog/(?P<year>[0-9]{4})/$', views.year_archive, {'foo': 'bar'}),
  279. ]
  280. In this example, for a request to ``/blog/2005/``, Django will call
  281. ``views.year_archive(request, year='2005', foo='bar')``.
  282. This technique is used in the
  283. :doc:`syndication framework </ref/contrib/syndication>` to pass metadata and
  284. options to views.
  285. .. admonition:: Dealing with conflicts
  286. It's possible to have a URL pattern which captures named keyword arguments,
  287. and also passes arguments with the same names in its dictionary of extra
  288. arguments. When this happens, the arguments in the dictionary will be used
  289. instead of the arguments captured in the URL.
  290. Passing extra options to ``include()``
  291. --------------------------------------
  292. Similarly, you can pass extra options to :func:`~django.conf.urls.include`.
  293. When you pass extra options to ``include()``, *each* line in the included
  294. URLconf will be passed the extra options.
  295. For example, these two URLconf sets are functionally identical:
  296. Set one::
  297. # main.py
  298. from django.conf.urls import include, url
  299. urlpatterns = [
  300. url(r'^blog/', include('inner'), {'blogid': 3}),
  301. ]
  302. # inner.py
  303. from django.conf.urls import url
  304. from mysite import views
  305. urlpatterns = [
  306. url(r'^archive/$', views.archive),
  307. url(r'^about/$', views.about),
  308. ]
  309. Set two::
  310. # main.py
  311. from django.conf.urls import include, url
  312. from mysite import views
  313. urlpatterns = [
  314. url(r'^blog/', include('inner')),
  315. ]
  316. # inner.py
  317. from django.conf.urls import url
  318. urlpatterns = [
  319. url(r'^archive/$', views.archive, {'blogid': 3}),
  320. url(r'^about/$', views.about, {'blogid': 3}),
  321. ]
  322. Note that extra options will *always* be passed to *every* line in the included
  323. URLconf, regardless of whether the line's view actually accepts those options
  324. as valid. For this reason, this technique is only useful if you're certain that
  325. every view in the included URLconf accepts the extra options you're passing.
  326. Reverse resolution of URLs
  327. ==========================
  328. A common need when working on a Django project is the possibility to obtain URLs
  329. in their final forms either for embedding in generated content (views and assets
  330. URLs, URLs shown to the user, etc.) or for handling of the navigation flow on
  331. the server side (redirections, etc.)
  332. It is strongly desirable not having to hard-code these URLs (a laborious,
  333. non-scalable and error-prone strategy) or having to devise ad-hoc mechanisms for
  334. generating URLs that are parallel to the design described by the URLconf and as
  335. such in danger of producing stale URLs at some point.
  336. In other words, what's needed is a DRY mechanism. Among other advantages it
  337. would allow evolution of the URL design without having to go all over the
  338. project source code to search and replace outdated URLs.
  339. The piece of information we have available as a starting point to get a URL is
  340. an identification (e.g. the name) of the view in charge of handling it, other
  341. pieces of information that necessarily must participate in the lookup of the
  342. right URL are the types (positional, keyword) and values of the view arguments.
  343. Django provides a solution such that the URL mapper is the only repository of
  344. the URL design. You feed it with your URLconf and then it can be used in both
  345. directions:
  346. * Starting with a URL requested by the user/browser, it calls the right Django
  347. view providing any arguments it might need with their values as extracted from
  348. the URL.
  349. * Starting with the identification of the corresponding Django view plus the
  350. values of arguments that would be passed to it, obtain the associated URL.
  351. The first one is the usage we've been discussing in the previous sections. The
  352. second one is what is known as *reverse resolution of URLs*, *reverse URL
  353. matching*, *reverse URL lookup*, or simply *URL reversing*.
  354. Django provides tools for performing URL reversing that match the different
  355. layers where URLs are needed:
  356. * In templates: Using the :ttag:`url` template tag.
  357. * In Python code: Using the :func:`django.core.urlresolvers.reverse`
  358. function.
  359. * In higher level code related to handling of URLs of Django model instances:
  360. The :meth:`~django.db.models.Model.get_absolute_url` method.
  361. Examples
  362. --------
  363. Consider again this URLconf entry::
  364. from django.conf.urls import url
  365. from . import views
  366. urlpatterns = [
  367. #...
  368. url(r'^articles/([0-9]{4})/$', views.year_archive, name='news-year-archive'),
  369. #...
  370. ]
  371. According to this design, the URL for the archive corresponding to year *nnnn*
  372. is ``/articles/nnnn/``.
  373. You can obtain these in template code by using:
  374. .. code-block:: html+django
  375. <a href="{% url 'news-year-archive' 2012 %}">2012 Archive</a>
  376. {# Or with the year in a template context variable: #}
  377. <ul>
  378. {% for yearvar in year_list %}
  379. <li><a href="{% url 'news-year-archive' yearvar %}">{{ yearvar }} Archive</a></li>
  380. {% endfor %}
  381. </ul>
  382. Or in Python code::
  383. from django.core.urlresolvers import reverse
  384. from django.http import HttpResponseRedirect
  385. def redirect_to_year(request):
  386. # ...
  387. year = 2006
  388. # ...
  389. return HttpResponseRedirect(reverse('news-year-archive', args=(year,)))
  390. If, for some reason, it was decided that the URLs where content for yearly
  391. article archives are published at should be changed then you would only need to
  392. change the entry in the URLconf.
  393. In some scenarios where views are of a generic nature, a many-to-one
  394. relationship might exist between URLs and views. For these cases the view name
  395. isn't a good enough identifier for it when comes the time of reversing
  396. URLs. Read the next section to know about the solution Django provides for this.
  397. .. _naming-url-patterns:
  398. Naming URL patterns
  399. ===================
  400. In order to perform URL reversing, you'll need to use **named URL patterns**
  401. as done in the examples above. The string used for the URL name can contain any
  402. characters you like. You are not restricted to valid Python names.
  403. When you name your URL patterns, make sure you use names that are unlikely
  404. to clash with any other application's choice of names. If you call your URL
  405. pattern ``comment``, and another application does the same thing, there's
  406. no guarantee which URL will be inserted into your template when you use
  407. this name.
  408. Putting a prefix on your URL names, perhaps derived from the application
  409. name, will decrease the chances of collision. We recommend something like
  410. ``myapp-comment`` instead of ``comment``.
  411. .. _topics-http-defining-url-namespaces:
  412. URL namespaces
  413. ==============
  414. Introduction
  415. ------------
  416. URL namespaces allow you to uniquely reverse :ref:`named URL patterns
  417. <naming-url-patterns>` even if different applications use the same URL names.
  418. It's a good practice for third-party apps to always use namespaced URLs (as we
  419. did in the tutorial). Similarly, it also allows you to reverse URLs if multiple
  420. instances of an application are deployed. In other words, since multiple
  421. instances of a single application will share named URLs, namespaces provide a
  422. way to tell these named URLs apart.
  423. Django applications that make proper use of URL namespacing can be deployed more
  424. than once for a particular site. For example :mod:`django.contrib.admin` has an
  425. :class:`~django.contrib.admin.AdminSite` class which allows you to easily
  426. :ref:`deploy more than once instance of the admin <multiple-admin-sites>`.
  427. In a later example, we'll discuss the idea of deploying the polls application
  428. from the tutorial in two different locations so we can serve the same
  429. functionality to two different audiences (authors and publishers).
  430. A URL namespace comes in two parts, both of which are strings:
  431. .. glossary::
  432. application namespace
  433. This describes the name of the application that is being deployed. Every
  434. instance of a single application will have the same application namespace.
  435. For example, Django's admin application has the somewhat predictable
  436. application namespace of ``'admin'``.
  437. instance namespace
  438. This identifies a specific instance of an application. Instance namespaces
  439. should be unique across your entire project. However, an instance namespace
  440. can be the same as the application namespace. This is used to specify a
  441. default instance of an application. For example, the default Django admin
  442. instance has an instance namespace of ``'admin'``.
  443. Namespaced URLs are specified using the ``':'`` operator. For example, the main
  444. index page of the admin application is referenced using ``'admin:index'``. This
  445. indicates a namespace of ``'admin'``, and a named URL of ``'index'``.
  446. Namespaces can also be nested. The named URL ``'sports:polls:index'`` would
  447. look for a pattern named ``'index'`` in the namespace ``'polls'`` that is itself
  448. defined within the top-level namespace ``'sports'``.
  449. .. _topics-http-reversing-url-namespaces:
  450. Reversing namespaced URLs
  451. -------------------------
  452. When given a namespaced URL (e.g. ``'polls:index'``) to resolve, Django splits
  453. the fully qualified name into parts and then tries the following lookup:
  454. 1. First, Django looks for a matching :term:`application namespace` (in this
  455. example, ``'polls'``). This will yield a list of instances of that
  456. application.
  457. 2. If there is a *current* application defined, Django finds and returns
  458. the URL resolver for that instance. The *current* application can be
  459. specified as an attribute on the template context - applications that
  460. expect to have multiple deployments should set the ``current_app``
  461. attribute on any :class:`~django.template.Context` or
  462. :class:`~django.template.RequestContext` that is used to render a template.
  463. The current application can also be specified manually as an argument
  464. to the :func:`~django.core.urlresolvers.reverse` function.
  465. 3. If there is no current application. Django looks for a default
  466. application instance. The default application instance is the instance
  467. that has an :term:`instance namespace` matching the :term:`application
  468. namespace` (in this example, an instance of ``polls`` called ``'polls'``).
  469. 4. If there is no default application instance, Django will pick the last
  470. deployed instance of the application, whatever its instance name may be.
  471. 5. If the provided namespace doesn't match an :term:`application namespace` in
  472. step 1, Django will attempt a direct lookup of the namespace as an
  473. :term:`instance namespace`.
  474. If there are nested namespaces, these steps are repeated for each part of the
  475. namespace until only the view name is unresolved. The view name will then be
  476. resolved into a URL in the namespace that has been found.
  477. Example
  478. ~~~~~~~
  479. To show this resolution strategy in action, consider an example of two instances
  480. of the ``polls`` application from the tutorial: one called ``'author-polls'``
  481. and one called ``'publisher-polls'``. Assume we have enhanced that application
  482. so that it takes the instance namespace into consideration when creating and
  483. displaying polls.
  484. .. snippet::
  485. :filename: urls.py
  486. from django.conf.urls import include, url
  487. urlpatterns = [
  488. url(r'^author-polls/', include('polls.urls', namespace='author-polls', app_name='polls')),
  489. url(r'^publisher-polls/', include('polls.urls', namespace='publisher-polls', app_name='polls')),
  490. ]
  491. .. snippet::
  492. :filename: polls/urls.py
  493. from django.conf.urls import url
  494. from . import views
  495. urlpatterns = [
  496. url(r'^$', views.IndexView.as_view(), name='index'),
  497. url(r'^(?P<pk>\d+)/$', views.DetailView.as_view(), name='detail'),
  498. ...
  499. ]
  500. Using this setup, the following lookups are possible:
  501. * If one of the instances is current - say, if we were rendering the detail page
  502. in the instance ``'author-polls'`` - ``'polls:index'`` will resolve to the
  503. index page of the ``'author-polls'`` instance; i.e. both of the following will
  504. result in ``"/author-polls/"``.
  505. In the method of a class-based view::
  506. reverse('polls:index', current_app=self.request.resolver_match.namespace)
  507. and in the template:
  508. .. code-block:: html+django
  509. {% url 'polls:index' %}
  510. Note that reversing in the template requires the ``current_app`` be added as
  511. an attribute to the template context like this::
  512. def render_to_response(self, context, **response_kwargs):
  513. response_kwargs['current_app'] = self.request.resolver_match.namespace
  514. return super(DetailView, self).render_to_response(context, **response_kwargs)
  515. * If there is no current instance - say, if we were rendering a page
  516. somewhere else on the site - ``'polls:index'`` will resolve to the last
  517. registered instance of ``polls``. Since there is no default instance
  518. (instance namespace of ``'polls'``), the last instance of ``polls`` that is
  519. registered will be used. This would be ``'publisher-polls'`` since it's
  520. declared last in the ``urlpatterns``.
  521. * ``'author-polls:index'`` will always resolve to the index page of the instance
  522. ``'author-polls'`` (and likewise for ``'publisher-polls'``) .
  523. If there were also a default instance - i.e., an instance named ``'polls'`` -
  524. the only change from above would be in the case where there is no current
  525. instance (the second item in the list above). In this case ``'polls:index'``
  526. would resolve to the index page of the default instance instead of the instance
  527. declared last in ``urlpatterns``.
  528. .. _namespaces-and-include:
  529. URL namespaces and included URLconfs
  530. ------------------------------------
  531. URL namespaces of included URLconfs can be specified in two ways.
  532. Firstly, you can provide the :term:`application <application namespace>` and
  533. :term:`instance <instance namespace>` namespaces as arguments to
  534. :func:`~django.conf.urls.include()` when you construct your URL patterns. For
  535. example,::
  536. url(r'^polls/', include('polls.urls', namespace='author-polls', app_name='polls')),
  537. This will include the URLs defined in ``polls.urls`` into the
  538. :term:`application namespace` ``'polls'``, with the :term:`instance namespace`
  539. ``'author-polls'``.
  540. Secondly, you can include an object that contains embedded namespace data. If
  541. you ``include()`` a list of :func:`~django.conf.urls.url` instances,
  542. the URLs contained in that object will be added to the global namespace.
  543. However, you can also ``include()`` a 3-tuple containing::
  544. (<list of url() instances>, <application namespace>, <instance namespace>)
  545. For example::
  546. from django.conf.urls import include, url
  547. from . import views
  548. polls_patterns = [
  549. url(r'^$', views.IndexView.as_view(), name='index'),
  550. url(r'^(?P<pk>\d+)/$', views.DetailView.as_view(), name='detail'),
  551. ]
  552. url(r'^polls/', include((polls_patterns, 'polls', 'author-polls'))),
  553. This will include the nominated URL patterns into the given application and
  554. instance namespace.
  555. For example, the Django admin is deployed as instances of
  556. :class:`~django.contrib.admin.AdminSite`. ``AdminSite`` objects have a ``urls``
  557. attribute: A 3-tuple that contains all the patterns in the corresponding admin
  558. site, plus the application namespace ``'admin'``, and the name of the admin
  559. instance. It is this ``urls`` attribute that you ``include()`` into your
  560. projects ``urlpatterns`` when you deploy an admin instance.
  561. Be sure to pass a tuple to ``include()``. If you simply pass three arguments:
  562. ``include(polls_patterns, 'polls', 'author-polls')``, Django won't throw an
  563. error but due to the signature of ``include()``, ``'polls'`` will be the
  564. instance namespace and ``'author-polls'`` will be the application namespace
  565. instead of vice versa.