Ticket #3683: better_permalink.patch

django/db/models/__init__.py

@@ -16 +16 @@
 # Admin stages.
 ADD, CHANGE, BOTH = 1, 2, 3
 
-# Decorator. Takes a function that returns a tuple in this format:
-#     (viewname, viewargs, viewkwargs)
+# Decorator. Takes a function that returns a string containing the viewname
+# or a tuple in this format:
+#     (viewname, viewargs)
+# Where viewargs is either a dictionary of named arguments or a list
+# of ordered arguments.
+#
 # Returns a function that calls urlresolvers.reverse() on that data, to return
 # the URL for those parameters.
 def permalink(func):
     from django.core.urlresolvers import reverse
     def inner(*args, **kwargs):
         bits = func(*args, **kwargs)
-        viewname = bits[0]
-        return reverse(bits[0], None, *bits[1:3])
+        reverse_kwargs = {}
+        if isinstance(bits, (list, tuple)):
+            viewname = bits[0]
+            if len(bits) >= 3:
+                # For backwards compatibility, check for any third argument and
+                # use instead of the second if given - was previously used for
+                # the dict of kwargs.
+                args = bits[2]
+            elif len(bits) == 2:
+                args = bits[1]
+        else:
+            viewname = bits
+        if args:
+            if isinstance(args, dict):
+                reverse_kwargs['kwargs'] = args
+            else:
+                reverse_kwargs['args'] = args
+        return reverse(viewname, **reverse_kwargs)
     return inner
 
 class LazyDate(object):

docs/model-api.txt

@@ -1757 +1757 @@
 in the URLConf file and in the model.
 
 You can further decouple your models from the URLconf using the ``permalink``
-decorator. This decorator is passed the view function and any parameters you
-would use for accessing this instance directly. Django then works out the
-correct full URL path using the URLconf. For example::
+decorator. This decorator is passed a string containing the view function
+and if necessary, either a list of ordered parameters or a dictionary of
+named parameters you would use for accessing this instance directly. Django
+then works out the correct full URL path using the URLconf. For example::
 
     from django.db.models import permalink
 
     def get_absolute_url(self):
-        return ('people.views.details', str(self.id))
+        return 'people.views.details', {'person_id': self.id}
     get_absolute_url = permalink(get_absolute_url)
 
 In this way, you're tying the model's absolute URL to the view that is used