aboutsummaryrefslogtreecommitdiffstats
path: root/rest_framework/urlpatterns.py
diff options
context:
space:
mode:
authorTom Christie2012-10-30 14:32:31 +0000
committerTom Christie2012-10-30 14:32:31 +0000
commit9b30dab4f772f67a626e176dc4fae0a3ef9c2c81 (patch)
treeca138abf4792f58ffa28684f784f201ee1eef6d7 /rest_framework/urlpatterns.py
parent7e5b1501b5cede61a9391fb1a751d2ebcdb37031 (diff)
parent4e7805cb24d73e7f706318b5e5a27e3f9ba39d14 (diff)
downloaddjango-rest-framework-9b30dab4f772f67a626e176dc4fae0a3ef9c2c81.tar.bz2
Merge branch 'restframework2' into rest-framework-2-merge2.0.0
Conflicts: .gitignore .travis.yml AUTHORS README.rst djangorestframework/mixins.py djangorestframework/renderers.py djangorestframework/resources.py djangorestframework/serializer.py djangorestframework/templates/djangorestframework/base.html djangorestframework/templates/djangorestframework/login.html djangorestframework/templatetags/add_query_param.py djangorestframework/tests/accept.py djangorestframework/tests/authentication.py djangorestframework/tests/content.py djangorestframework/tests/reverse.py djangorestframework/tests/serializer.py djangorestframework/views.py docs/examples.rst docs/examples/blogpost.rst docs/examples/modelviews.rst docs/examples/objectstore.rst docs/examples/permissions.rst docs/examples/pygments.rst docs/examples/views.rst docs/howto/alternativeframeworks.rst docs/howto/mixin.rst docs/howto/reverse.rst docs/howto/usingurllib2.rst docs/index.rst docs/topics/release-notes.md examples/sandbox/views.py rest_framework/__init__.py rest_framework/compat.py rest_framework/utils/breadcrumbs.py setup.py
Diffstat (limited to 'rest_framework/urlpatterns.py')
-rw-r--r--rest_framework/urlpatterns.py42
1 files changed, 42 insertions, 0 deletions
diff --git a/rest_framework/urlpatterns.py b/rest_framework/urlpatterns.py
new file mode 100644
index 00000000..316ccd19
--- /dev/null
+++ b/rest_framework/urlpatterns.py
@@ -0,0 +1,42 @@
+from django.conf.urls.defaults import url
+from rest_framework.settings import api_settings
+
+
+def format_suffix_patterns(urlpatterns, suffix_required=False, allowed=None):
+ """
+ Supplement existing urlpatterns with corrosponding patterns that also
+ include a '.format' suffix. Retains urlpattern ordering.
+
+ urlpatterns:
+ A list of URL patterns.
+
+ suffix_required:
+ If `True`, only suffixed URLs will be generated, and non-suffixed
+ URLs will not be used. Defaults to `False`.
+
+ allowed:
+ An optional tuple/list of allowed suffixes. eg ['json', 'api']
+ Defaults to `None`, which allows any suffix.
+ """
+ suffix_kwarg = api_settings.FORMAT_SUFFIX_KWARG
+ if allowed:
+ if len(allowed) == 1:
+ allowed_pattern = allowed[0]
+ else:
+ allowed_pattern = '(%s)' % '|'.join(allowed)
+ suffix_pattern = r'\.(?P<%s>%s)$' % (suffix_kwarg, allowed_pattern)
+ else:
+ suffix_pattern = r'\.(?P<%s>[a-z]+)$' % suffix_kwarg
+
+ ret = []
+ for urlpattern in urlpatterns:
+ # Form our complementing '.format' urlpattern
+ regex = urlpattern.regex.pattern.rstrip('$') + suffix_pattern
+ view = urlpattern._callback or urlpattern._callback_str
+ kwargs = urlpattern.default_args
+ name = urlpattern.name
+ # Add in both the existing and the new urlpattern
+ if not suffix_required:
+ ret.append(urlpattern)
+ ret.append(url(regex, view, kwargs, name))
+ return ret