mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-11-10 19:56:59 +03:00
46 lines
1.6 KiB
Python
46 lines
1.6 KiB
Python
from django.conf.urls.defaults import url
|
|
from rest_framework.settings import api_settings
|
|
|
|
|
|
def format_suffix_patterns(urlpatterns, suffix_required=False,
|
|
suffix_kwarg=None, allowed=None):
|
|
"""
|
|
Supplement existing urlpatterns with corrosponding patterns that also
|
|
include a '.format' suffix. Retains urlpattern ordering.
|
|
|
|
suffix_required:
|
|
If `True`, only suffixed URLs will be generated, and non-suffixed
|
|
URLs will not be used. Defaults to `False`.
|
|
|
|
suffix_kwarg:
|
|
The name of the kwarg that will be passed to the view.
|
|
Defaults to 'format'.
|
|
|
|
allowed:
|
|
An optional tuple/list of allowed suffixes. eg ['json', 'api']
|
|
Defaults to `None`, which allows any suffix.
|
|
|
|
"""
|
|
suffix_kwarg = suffix_kwarg or 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
|