diff options
| author | Robert Roskam <raiderrobert@gmail.com> | 2016-11-05 10:48:31 -0400 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2017-02-11 09:02:30 -0500 |
| commit | c0916144502b2b9d75b75ce6b01148aaa3dcaf68 (patch) | |
| tree | 2089c32b27ef5806dbfdfc50a3620fb34493d0f7 /docs | |
| parent | ded0632d94d3c50da29bdb0ddb061f6826b9fa48 (diff) | |
[1.11.x] Fixed #27367 -- Doc'd and tested reversing of URLs with the same name.
Thanks Reinout van Rees for contributing to the patch.
Backport of 98bcc5d81bca578f3a5b4d47907ba4ac40446887 from master
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/topics/http/urls.txt | 27 |
1 files changed, 20 insertions, 7 deletions
diff --git a/docs/topics/http/urls.txt b/docs/topics/http/urls.txt index 59b3b698f1..6e891e72f3 100644 --- a/docs/topics/http/urls.txt +++ b/docs/topics/http/urls.txt @@ -597,15 +597,28 @@ In order to perform URL reversing, you'll need to use **named URL patterns** as done in the examples above. The string used for the URL name can contain any characters you like. You are not restricted to valid Python names. -When you name your URL patterns, make sure you use names that are unlikely -to clash with any other application's choice of names. If you call your URL -pattern ``comment``, and another application does the same thing, there's -no guarantee which URL will be inserted into your template when you use -this name. +When naming URL patterns, choose names that are unlikely to clash with other +applications' choice of names. If you call your URL pattern ``comment`` +and another application does the same thing, the URL that +:func:`~django.urls.reverse()` finds depends on whichever pattern is last in +your project's ``urlpatterns`` list. Putting a prefix on your URL names, perhaps derived from the application -name, will decrease the chances of collision. We recommend something like -``myapp-comment`` instead of ``comment``. +name (such as ``myapp-comment`` instead of ``comment``), decreases the chance +of collision. + +You can deliberately choose the *same URL name* as another application if you +want to override a view. For example, a common use case is to override the +:class:`~django.contrib.auth.views.LoginView`. Parts of Django and most +third-party apps assume that this view has a URL pattern with the name +``login``. If you have a custom login view and give its URL the name ``login``, +:func:`~django.urls.reverse()` will find your custom view as long as it's in +``urlpatterns`` after ``django.contrib.auth.urls`` is included (if that's +included at all). + +You may also use the same name for multiple URL patterns if they differ in +their arguments. In addition to the URL name, :func:`~django.urls.reverse()` +matches the number of arguments and the names of the keyword arguments. .. _topics-http-defining-url-namespaces: |
