django.core.urlresolvers utility functions

reverse()

Если вам нужно вернуть абсолютную ссылку, соответствующую указанному представлению, как это делает url, Django предоставляет следующую функцию:

reverse(viewname[, urlconf=None, args=None, kwargs=None, current_app=None])

viewname может быть Python путь для импорта представления, название URL-шаблона или объект представления. Например, имеем следующий url:

url(r'^archive/$', 'news.views.archive', name='news_archive')

вы можете получить URL одним из следующих способов:

# using the Python path
reverse('news.views.archive')

# using the named URL
reverse('news_archive')

# passing a callable object
from news import views
reverse(views.archive)

Если URL принимает аргументы, вы можете их передать аргументом args. Например:

from django.core.urlresolvers import reverse

def myview(request):
    return HttpResponseRedirect(reverse('arch-summary', args=[1945]))

Вы можете использовать kwargs (словарь) вместо args (отдельных аргументов). Например:

>>> reverse('admin:app_list', kwargs={'app_label': 'auth'})
'/admin/auth/'

args и kwargs не могут быть переданы функции reverse() вместе, они используются по отдельности.

Если reverse() не найдет подходящего URL-а, будет вызвано исключение NoReverseMatch.

Функция reverse() может предоставлять достаточно большое количество шаблонов регулярных выражений, но не все из возможных. На данный момент шаблон не предоставляет возможности альтернативного использования символа вертикальной черты ("|"). You can quite happily use such patterns for matching against incoming URLs and sending them off to views, but you cannot reverse such patterns.

Аргумент current_app позволит вам получить полный путь к текущей странице. Он возвращает текущий экземпляр приложения из указанного пространства имён.

Аргумент urlconf принимает модуль URLconf, который содержит URL-шаблоны для поиска URL-а. По умолчанию используется URLconf текущего запроса.

Убедитесь, что все URL-шаблоны правильные.

Для определения URL-а по названию функции reverse() необходимо импортировать все файлы конфигурации URL-ов и проверить каждый. При этом импортируются все функции представления. Если при этом возникнет ошибка, reverse() вызовет исключение, даже если это не то представление, которое ищет reverse().

Убедитесь, что представления, указанные в ваших файлах URLconf действительно существуют и могут быть правильно импортированы. Не включайте строки, которые ссылаются на ещё не написанные представления, поскольку эти представления импортированы не будут.

Примечание

Строка, которую возвращает reverse(), уже кодирована. Чтобы узнать об этом подробнее смотрите urlquoted. Пример:

>>> reverse('cities', args=[u'Orléans'])
'.../Orl%C3%A9ans/'

Кроме того, нужно иметь ввиду, что применение кодирования символов (такое как urlquote() или urllib.quote) при выводе с reverse() может привести к нежелательным последствиям.

reverse_lazy()

lazy стоит расценивать как “ленивую” версию reverse().

reverse_lazy(viewname[, urlconf=None, args=None, kwargs=None, current_app=None])

Эта функция может быть полезна в случае, если вам нужно вернуть URL-адрес прежде, чем ваши настройки URLConf будут загружены. Перечислим несколько случаев, когда эта функция бывает необходима:

  • возврат URL как url атрибута для представления базовых классов.

  • возврат URL-а как декоратора (такого как login_url для django.contrib.auth.decorators.permission_required()).

  • возврат URL-адреса как переменной по умолчанию для параметров функции.

resolve()

Функция resolve() может быть использована для получения URL-адреса из соответствующего представления. Она имеет следующий синтаксис:

resolve(path, urlconf=None)

path – это путь к URL-адресу, который вы хотите получить. Как и в случае с reverse(), вы не должны волноваться о параметрах urlconf. Эта функция возвращает объект ResolverMatch, что делает доступным использование различных метаданных.

Если URL-адрес вернуть не удаётся, функция возбуждает исключение Http404).

class ResolverMatch
func

Функция представления, которая будет использована для передачи URL.

args

Аргументы, которые будут переданы в функцию представления, as parsed from the URL.

kwargs

именованные аргументы, которые будут переданы в функцию представления, as parsed from the URL.

url_name

Название URL-шаблона для сопоставления URL-адресов.

app_name

Название приложения из пространства имён для сопоставления URL-адресов.

namespace

Название выбранного пространства имён для сопоставления URL-адресов.

namespaces

Список пространств имен. Для foo:bar это будет ['foo', 'bar'].

view_name

Название представления, которое обрабатывает URL, включая пространства имен, если таковы используются.

С помощью объекта ResolverMatch можно впоследствии запросить информацию о соответствии между URL-адресом и используемом имени представления (т.е. какому URL-адресу какой шаблон принадлежит):

# Resolve a URL
match = resolve('/some/path/')
# Print the URL pattern that matches the URL
print(match.url_name)

Также объекту ResolverMatch можно передать три параметра:

func, args, kwargs = resolve('/some/path/')

Одним из возможных вариантов использования resolve() может быть проверка вызова представления, которое возбуждает исключение Http404 до того, как осуществить перенаправление:

from django.core.urlresolvers import resolve
from django.http import HttpResponseRedirect, Http404
from django.utils.six.moves.urllib.parse import urlparse

def myview(request):
    next = request.META.get('HTTP_REFERER', None) or '/'
    response = HttpResponseRedirect(next)

    # modify the request and response as required, e.g. change locale
    # and set corresponding locale cookie

    view, args, kwargs = resolve(urlparse(next)[2])
    kwargs['request'] = request
    try:
        view(*args, **kwargs)
    except Http404:
        return HttpResponseRedirect('/')
    return response

get_script_prefix()

get_script_prefix()

Как правило, вы всегда будете использовать reverse() для определения URL-адресов в вашем представлении. Однако, если ваше приложение состоит из целой иерархии URL-ов, иногда вам может понадобиться сгенерировать URL-адреса. В этом случае, вам нужно указать базовый URL-адрес проекта Django в пределах директории вашего web-сервера (обычно reverse() делает это за вас). Тогда необходимо вызвать get_script_prefix(), который будет возвращать часть сценария префикса из URL вашего проекта на Django. Если проект находится в корне web-сервера, это всегда "/".