django.urls служебные функции

reverse()

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

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

viewname может быть именем шаблона 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() генерирует исключение NoReverseMatch.

Функция reverse() может обращаться к большому количеству регулярных выражений шаблонов URL, но не ко всем возможным. Основное ограничение на данный момент состоит в том, что шаблон не может содержать альтернативные варианты с использованием вертикальной черты ("|") . Вы можете без проблем использовать такие шаблоны для сопоставления с поступающими URL-адресами и отправки их в представления, но вы не можете обращаться к таким шаблонам.

Аргумент current_app позволяет вам указать подсказку для решателя, указывая приложение, к которому относится текущее выполняемое представление. Этот аргумент current_app используется как подсказка для разрешения имен пространств приложений в URL-адреса на определённых экземплярах приложений в соответствии с стратегией разрешения URL-адресов с именами пространств.

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

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

reverse_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) [source]

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

Если URL-адрес не разрешается, функция генерирует исключение Resolver404 (подкласс Http404).

class ResolverMatch [source]

func

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

args

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

kwargs

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

url_name

Имя шаблона URL-адреса, который соответствует URL-адресу.

app_name

Пространство имен приложения для шаблона URL-адреса, который соответствует URL-адресу.

app_names

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

namespace

Пространство имён экземпляра для шаблона URL-адреса, который соответствует URL-адресу.

namespaces

Список отдельных компонентов пространства имён в полном пространстве имен экземпляра для шаблона URL-адреса, который соответствует URL-адресу. То есть, если пространство имён равно foo:bar, то namespaces будет ['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() [source]

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