• 3.1
  • 3.2
  • 6.1
  • Версия документации: 5.0

django.core.urlresolvers utility functions

reverse

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

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

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

from news import views

path("archive/", views.archive, name="news-archive")

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

# using the named URL
reverse("news-archive")

# passing a callable object
# (This is discouraged because you can't reverse namespaced views this way.)
from news import views

reverse(views.archive)

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

from django.urls 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() может предоставлять достаточно большое количество шаблонов регулярных выражений, но не все из возможных. На данный момент шаблон не предоставляет возможности использования символа вертикальной черты ("|") для указания альтернативного выбора. Вы можете использовать такой шаблон для обработки входящего URL-а и получения представления, но вы не можете получить URL для такого шаблона с помощью reverse().

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

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

Примечание

Строка, возвращаемая функцией reverse(), уже urlquoted. Например:

>>> reverse("cities", args=["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

Все аргументы ключевых слов, которые будут переданы в функцию просмотра, т. е. captured_kwargs и extra_kwargs.

captured_kwargs

Захваченные аргументы ключевого слова, которые будут переданы в функцию просмотра после анализа URL-адреса.

extra_kwargs

Дополнительные аргументы ключевого слова, которые будут переданы в функцию просмотра.

url_name

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

route

Маршрут соответствующего шаблона URL.

Например, если path('users/<id>/', ...) является соответствующим шаблоном, route будет содержать 'users/<id>/'.

tried

Список шаблонов URL-адресов, опробованных до того, как URL-адрес соответствовал одному или исчерпал доступные шаблоны.

app_name

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

app_names

Список пространств имен, из которых состоит полное пространство имен приложения для URL-шаблона, который удовлетворяет URL-у. Для foo:bar это будет ['foo', 'bar'].

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 urllib.parse import urlparse
from django.urls import resolve
from django.http import Http404, HttpResponseRedirect


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 на его веб-сервере (обычно reverse() позаботится об этом за вас). В этом случае вы можете вызвать get_script_prefix(), который вернет часть URL-адреса, содержащую префикс скрипта, для вашего проекта Django. Если ваш проект Django находится в корне веб-сервера, это всегда "/".

Предупреждение

Эту функцию нельзя использовать вне цикла запрос-ответ, поскольку она полагается на значения, инициализированные во время этого цикла.

Back to Top