django-rest-framework/rest_framework/utils/breadcrumbs.py

59 lines
2.1 KiB
Python
Raw Normal View History

from __future__ import unicode_literals
2015-06-25 23:55:51 +03:00
from django.core.urlresolvers import get_script_prefix, resolve
2015-05-19 17:49:37 +03:00
def get_breadcrumbs(url, request=None):
2013-04-26 18:09:55 +04:00
"""
Given a url returns a list of breadcrumbs, which are each a
tuple of (name, url).
"""
2015-05-19 17:49:37 +03:00
from rest_framework.reverse import preserve_builtin_query_params
2013-08-29 23:51:51 +04:00
from rest_framework.settings import api_settings
from rest_framework.views import APIView
2013-08-29 23:51:51 +04:00
view_name_func = api_settings.VIEW_NAME_FUNCTION
def breadcrumbs_recursive(url, breadcrumbs_list, prefix, seen):
2013-04-26 18:09:55 +04:00
"""
Add tuples of (name, url) to the breadcrumbs list,
progressively chomping off parts of the url.
"""
try:
(view, unused_args, unused_kwargs) = resolve(url)
except Exception:
pass
else:
2013-04-26 18:09:55 +04:00
# Check if this is a REST framework view,
# and if so add it to the breadcrumbs
2013-05-07 17:11:48 +04:00
cls = getattr(view, 'cls', None)
if cls is not None and issubclass(cls, APIView):
# Don't list the same view twice in a row.
# Probably an optional trailing slash.
if not seen or seen[-1] != view:
2013-08-29 23:51:51 +04:00
suffix = getattr(view, 'suffix', None)
name = view_name_func(cls, suffix)
2015-05-19 17:49:37 +03:00
insert_url = preserve_builtin_query_params(prefix + url, request)
breadcrumbs_list.insert(0, (name, insert_url))
seen.append(view)
if url == '':
# All done
return breadcrumbs_list
elif url.endswith('/'):
2013-04-26 18:09:55 +04:00
# Drop trailing slash off the end and continue to try to
# resolve more breadcrumbs
url = url.rstrip('/')
return breadcrumbs_recursive(url, breadcrumbs_list, prefix, seen)
# Drop trailing non-slash off the end and continue to try to
# resolve more breadcrumbs
url = url[:url.rfind('/') + 1]
return breadcrumbs_recursive(url, breadcrumbs_list, prefix, seen)
prefix = get_script_prefix().rstrip('/')
url = url[len(prefix):]
return breadcrumbs_recursive(url, [], prefix, [])