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

reverse()

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

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

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)

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

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

class ResolverMatch

func

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

args

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

kwargs

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

url_name

Имя URL-шаблона, соответствующего URL.

route

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

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

tried

Новое в Django 3.2.

Список 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()

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