Ticket #3402: django_stem.patch

django/conf/urls/defaults.py

@@ -1 @@
-from django.core.urlresolvers import RegexURLPattern, RegexURLResolver
+from django.core.urlresolvers import RegexURLPattern, RegexURLResolver, Stem
 
-__all__ = ['handler404', 'handler500', 'include', 'patterns']
+__all__ = ['handler404', 'handler500', 'include', 'patterns', 'stem']
 
 handler404 = 'django.views.defaults.page_not_found'
 handler500 = 'django.views.defaults.server_error'
 
+stem = Stem()
+
 include = lambda urlconf_module: [urlconf_module]
 
 def patterns(prefix, *tuples):

django/core/handlers/base.py

@@ -65 +65 @@
 
         resolver = urlresolvers.RegexURLResolver(r'^/', urlconf)
         try:
-            callback, callback_args, callback_kwargs = resolver.resolve(request.path)
+            callback, callback_args, callback_kwargs, stem = resolver.resolve(request.path)
 
             # Apply view middleware
             for middleware_method in self._view_middleware:

django/core/urlresolvers.py

@@ -11 +11 @@
 from django.core.exceptions import ImproperlyConfigured, ViewDoesNotExist
 import re
 
+class Stem(object):
+    pass
+
 class Resolver404(Http404):
     pass
 
 class NoReverseMatch(Exception):
     # Don't make this raise an error when used in a template.
-    silent_variable_failure = True  
+    silent_variable_failure = True
 
 def get_mod_func(callback):
     # Converts 'django.views.news.stories.story_detail' to
@@ -101 +104 @@
             self._callback_str = callback
         self.default_args = default_args or {}
 
-    def resolve(self, path):
+        self._stem = None
+        for k,v in self.default_args.iteritems():
+            if type(v) == Stem:
+                self._stem = k
+                break
+
+    def resolve(self, path, stem=''):
         match = self.regex.search(path)
         if match:
             # If there are any named groups, use those as kwargs, ignoring
@@ -113 +122 @@
             if not kwargs:
                 args = match.groups()
             # In both cases, pass any extra_kwargs as **kwargs.
+            if self._stem:
+                self.default_args[self._stem] = stem
             kwargs.update(self.default_args)
 
-            return self.callback, args, kwargs
+            return self.callback, args, kwargs, stem
 
     def _get_callback(self):
         if self._callback is not None:
@@ -152 +163 @@
         self.callback = None
         self.default_kwargs = default_kwargs or {}
 
-    def resolve(self, path):
+        self._stem = None
+        for k,v in self.default_kwargs.iteritems():
+            if type(v) == Stem:
+                self._stem = k
+                break
+
+    def resolve(self, path, stem=''):
         tried = []
         match = self.regex.search(path)
         if match:
+            stem += path[:match.end()]
             new_path = path[match.end():]
             for pattern in self.urlconf_module.urlpatterns:
                 try:
-                    sub_match = pattern.resolve(new_path)
+                    sub_match = pattern.resolve(new_path, stem)
                 except Resolver404, e:
                     tried.extend([(pattern.regex.pattern + '   ' + t) for t in e.args[0]['tried']])
                 else:
                     if sub_match:
+                        if self._stem:
+                            self.default_kwargs[self._stem] = sub_match[3]
                         sub_match_dict = dict(self.default_kwargs, **sub_match[2])
-                        return sub_match[0], sub_match[1], dict(match.groupdict(), **sub_match_dict)
+                        return sub_match[0], sub_match[1], dict(match.groupdict(), **sub_match_dict), sub_match[3]
                     tried.append(pattern.regex.pattern)
             raise Resolver404, {'tried': tried, 'path': new_path}
 
@@ -229 +249 @@
         from django.conf import settings
         urlconf = settings.ROOT_URLCONF
     resolver = RegexURLResolver(r'^/', urlconf)
-    return resolver.resolve(path)
+    return resolver.resolve(path)[:3]
 
 def reverse(viewname, urlconf=None, args=None, kwargs=None):
     args = args or []

docs/url_dispatch.txt

@@ -215 +215 @@
 A function that takes a full Python import path to another URLconf that should
 be "included" in this place. See _`Including other URLconfs` below.
 
+stem
+----
+
+** New in Django development version **
+
+An object that you can use in the optional dictionary to pass the part of the
+url that matched upto the point before matching against patterns in the current
+URLconf. See _`Including other URLconfs` below.
+
 Notes on capturing text in URLs
 ===============================
 
@@ -364 +373 @@
 In the above example, the captured ``"username"`` variable is passed to the
 included URLconf, as expected.
 
+Passing the stem of the matched URL
+-----------------------------------
+
+** New in Django development version **
+
+In the following example::
+
+    # In settings/urls/main.py
+    urlpatterns = patterns('',
+        (r'^blog/', include('foo.urls.blog')),
+    )
+
+    # In foo/urls/blog.py
+    urlpatterns = patterns('foo.views',
+        (r'^$', 'blog.index', {'stem':stem}),
+        (r'^archive/$', 'blog.archive', {'stem':stem}),
+    )
+    
+In the above example, both blog.index and blog.archive will be passed a kwarg
+called 'stem', and having the value '/blog/' (coming from settings/urls/main.py.)
+
 Passing extra options to view functions
 =======================================
 

tests/regressiontests/urlpatterns/urls3.py

@@ +1 @@
+from django.conf.urls.defaults import *
+
+urlpatterns = patterns('regressiontests.urlpatterns.tests',
+    (r'^test/$','view'),
+)
+ No newline at end of file

tests/regressiontests/urlpatterns/tests.py

@@ +1 @@
+"Unit tests for URL lookup"
+
+from django.conf import settings
+from django.core.urlresolvers import resolve
+import unittest
+
+def view(request):
+    pass
+
+class URLPattern(unittest.TestCase):
+    def setUp(self):
+        self._url_conf = settings.ROOT_URLCONF
+        settings.ROOT_URLCONF = 'regressiontests.urlpatterns.urls1'
+        
+    def tearDown(self):
+        settings.ROOT_URLCONF = self._url_conf
+        
+    def test_urlpattern_1(self):
+        result = resolve('/test/')
+        self.assertEqual('stem' in result[2], False)
+
+    def test_urlpattern_2(self):
+        result = resolve('/include/test/')
+        self.assertEqual('stem' in result[2], True)
+        self.assertEqual(result[2]['stem'],'/include/')
+
+    def test_urlpattern_3(self):
+        result = resolve('/include/include/test/')
+        self.assertEqual('stem' in result[2], True)
+        self.assertEqual(result[2]['stem'],'/include/include/')

tests/regressiontests/urlpatterns/urls1.py

@@ +1 @@
+from django.conf.urls.defaults import *
+
+urlpatterns = patterns('regressiontests.urlpatterns.tests',
+    (r'^test/$','view'),
+    (r'^include/',include('regressiontests.urlpatterns.urls2')),
+)
+ No newline at end of file

tests/regressiontests/urlpatterns/urls2.py

@@ +1 @@
+from django.conf.urls.defaults import *
+
+urlpatterns = patterns('regressiontests.urlpatterns.tests',
+    (r'^test/$','view',{'stem':stem}),
+    (r'^include/',include('regressiontests.urlpatterns.urls3'),{'stem':stem}),
+)
+ No newline at end of file

tests/regressiontests/urlpatterns/tests.py

@@ +1 @@
+"Unit tests for URL lookup"
+
+from django.conf import settings
+from django.core.urlresolvers import resolve
+import unittest
+
+def view(request):
+    pass
+
+class URLPattern(unittest.TestCase):
+    def setUp(self):
+        self._url_conf = settings.ROOT_URLCONF
+        settings.ROOT_URLCONF = 'regressiontests.urlpatterns.urls1'
+        
+    def tearDown(self):
+        settings.ROOT_URLCONF = self._url_conf
+        
+    def test_urlpattern_1(self):
+        result = resolve('/test/')
+        self.assertEqual('stem' in result[2], False)
+
+    def test_urlpattern_2(self):
+        result = resolve('/include/test/')
+        self.assertEqual('stem' in result[2], True)
+        self.assertEqual(result[2]['stem'],'/include/')
+
+    def test_urlpattern_3(self):
+        result = resolve('/include/include/test/')
+        self.assertEqual('stem' in result[2], True)
+        self.assertEqual(result[2]['stem'],'/include/include/')

tests/regressiontests/urlpatterns/urls1.py

@@ +1 @@
+from django.conf.urls.defaults import *
+
+urlpatterns = patterns('regressiontests.urlpatterns.tests',
+    (r'^test/$','view'),
+    (r'^include/',include('regressiontests.urlpatterns.urls2')),
+)
+ No newline at end of file

tests/regressiontests/urlpatterns/urls2.py

@@ +1 @@
+from django.conf.urls.defaults import *
+
+urlpatterns = patterns('regressiontests.urlpatterns.tests',
+    (r'^test/$','view',{'stem':stem}),
+    (r'^include/',include('regressiontests.urlpatterns.urls3'),{'stem':stem}),
+)
+ No newline at end of file

tests/regressiontests/urlpatterns/urls3.py

@@ +1 @@
+from django.conf.urls.defaults import *
+
+urlpatterns = patterns('regressiontests.urlpatterns.tests',
+    (r'^test/$','view'),
+)
+ No newline at end of file