Changeset 4901

Timestamp:

04/01/07 02:25:20 (2 years ago)

Author:

mtredinnick

Message:

Added the ability to name URL patterns. Helps with disambiguity reverse matches.

Files:

• django/trunk/django/conf/urls/defaults.py (modified) (2 diffs)
• django/trunk/django/core/urlresolvers.py (modified) (4 diffs)
• django/trunk/docs/url_dispatch.txt (modified) (2 diffs)
• django/trunk/tests/regressiontests/templates/tests.py (modified) (1 diff)
• django/trunk/tests/regressiontests/templates/urls.py (modified) (1 diff)

django/trunk/django/conf/urls/defaults.py

@@ -1 +1 @@
-from django.core.urlresolvers import RegexURLPattern, RegexURLResolver
-
-
+, 'url'
-
-handler404 = 'django.views.defaults.page_not_found'
@@ -8 +8 @@
-include = lambda urlconf_module: [urlconf_module]
-
-tuple
+arg
-    pattern_list = []
-
-
-
-
-
+
+
+
-        else:
-RegexURLPattern(regex, prefix and (prefix + '.' + view_or_include) or view_or_include, *default_kwargs)
+t
-    return pattern_list
+
+def url(regex, view, kwargs=None, name=None, prefix=''):
+    if type(view) == list:
+        # For include(...) processing.
+        return RegexURLResolver(regex, view[0], kwargs)
+    else:
+        return RegexURLPattern(regex, prefix and (prefix + '.' + view) or view, kwargs, name)
+

django/trunk/django/core/urlresolvers.py

@@ -89 +89 @@
-
-class RegexURLPattern(object):
-
+, name=None
-        # regex is a string representing a regular expression.
-        # callback is either a string like 'foo.views.news.stories.story_detail'
@@ -101 +101 @@
-            self._callback_str = callback
-        self.default_args = default_args or {}
+        self.name = name
-
-    def resolve(self, path):
@@ -206 +207 @@
-                lookup_view = getattr(__import__(mod_name, {}, {}, ['']), func_name)
-            except (ImportError, AttributeError):
-
+
+
-        for pattern in self.urlconf_module.urlpatterns:
-            if isinstance(pattern, RegexURLResolver):
@@ -213 +215 @@
-                except NoReverseMatch:
-                    continue
-
+ or pattern.name == lookup_view
-                try:
-                    return pattern.reverse_helper(*args, **kwargs)

django/trunk/docs/url_dispatch.txt

@@ -186 +186 @@
-The remaining arguments should be tuples in this format::
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-handler404
@@ -480 +495 @@
-Note that if you use this technique -- passing objects rather than strings --
-the view prefix (as explained in "The view prefix" above) will have no effect.
+
+Naming URL patterns
+===================
+
+**New in development version**
+
+It is fairly common to use the same view function in multiple URL patterns in
+your URLConf. This leads to problems when you come to do reverse URL matching,
+because the ``permalink()`` decorator and ``{% url %}`` template tag use the
+name of the view function to find a match.
+
+To solve this problem, you can give a name to each of your URL patterns in
+order to distinguish them from other patterns using the same views and
+parameters. You can then use this name wherever you would otherwise use the
+name of the view function. For example, if you URLConf contains::
+
+    urlpatterns = patterns('',
+        url(r'/archive/(\d{4})/$', archive, name="full-archive"),
+        url(r'/archive-summary/(\d{4})/$', archive, {'summary': True}, "arch-summary"),
+    )
+
+...you could refer to either the summary archive view in a template as::
+
+    {% url arch-summary 1945 %}
+
+Even though both URL patterns refer to the ``archive`` view here, using the
+``name`` parameter to ``url()`` allows you to tell them apart in templates.
+
+The string used for the URL name can contain any characters you like. You are
+not restricted to valid Python names.
+
+.. note::
+
+    Make sure that when you name your URLs, 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 is no
+    guarantee which URL will be inserted into your template when you use this
+    name. Putting a prefix on your URL names, perhaps derived from
+    the application name, will decrease the chances of collision. Something
+    like *myapp-comment* is recommended over simply *comment*.
+

django/trunk/tests/regressiontests/templates/tests.py

@@ -693 +693 @@
-            'url02' : ('{% url regressiontests.templates.views.client_action client.id,action="update" %}', {'client': {'id': 1}}, '/url_tag/client/1/update/'),
-            'url03' : ('{% url regressiontests.templates.views.index %}', {}, '/url_tag/'),
+            'url04' : ('{% url named-client client.id %}', {'client': {'id': 1}}, '/url_tag/named-client/1/'),
-
-            # Failures
-04
-05
-06
+-fail01
+-fail02
+-fail03
-        }
-

django/trunk/tests/regressiontests/templates/urls.py

@@ -8 +8 @@
-    (r'^client/(\d+)/$', views.client),
-    (r'^client/(\d+)/(?P<action>[^/]+)/$', views.client_action),
+    url(r'^named-client/(\d+)/$', views.client, name="named-client"),
-)