Служебные функции django.urls ¶
Если вам нужно использовать что-то похожее на тег шаблона 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 — это модуль конфигурации URL-адреса, содержащий шаблоны URL-адресов, используемые для разрешения. По умолчанию используется конфигурация корневого URL-адреса текущего потока.
Строка URL, возвращаемая пользователем reverse() , уже экранирована . Например :
>>> reverse('cities', args=['Orléans']) '. /Orl%C3%A9ans/'
Если вы примените другие кодировки (например, urllib.parse.quote() ) к значению, возвращаемому функцией reverse() , это может привести к нежелательным результатам.
reverse_lazy() ¶
reverse_lazy ( viewname , urlconf = None , args = None , kwargs = None , current_app = None ) ¶
Эта функция полезна, когда вам нужно выполнить разрешение URL перед загрузкой конфигурации URL. Вот несколько распространенных случаев использования этой функции:
- Назначение обратного URL-адреса в качестве атрибута url общего представления на основе классов.
- присвоение обратного URL-адреса декоратору (как для параметра login_url декоратора django.contrib.auth.decorators.permission_required() ).
- назначение обратного URL-адреса в качестве значения по умолчанию параметра в сигнатуре функции.
resolve() ¶
Функцию resolve() можно использовать для разрешения пути URL к соответствующей функции просмотра. Его подпись следующая:
resolve ( путь , urlconf = Нет ) ¶
path — это URL-адрес для разрешения. Как и в случае с reverse() настройками, беспокоиться не о чем urlconf . Фокус возвращает объект, ResolverMatch позволяющий получить доступ к различным метаданным о разрешенном URL.
Если URL-адрес не разрешен, функция генерирует исключение Resolver404 (которое является подклассом Http404 ).
класс ResolverMatch ¶ func ¶
Функция просмотра, которая использовалась бы для обслуживания URL.
Параметры, которые были бы переданы функции просмотра, поскольку они были взяты из URL-адреса.
Именованные параметры, которые были бы переданы функции просмотра, поскольку они были взяты из URL-адреса.
Имя шаблона URL-адреса, соответствующего URL-адресу.
Маршрут соответствующего шаблона URL.
Например, если установить шаблон соответствия, будет содержать . path(‘users//’, . ) route ‘users//’
Пространство имен приложения для шаблона URL, соответствующего URL.
Список отдельных компонентов пространства имен в полном пространстве имен приложения шаблона URL-адреса, соответствующего URL-адресу. Если например app_name содержит foo:bar , то app_names будет содержать . [‘foo’, ‘bar’]
Пространство имен экземпляра для шаблона URL, соответствующего URL.
Список отдельных компонентов пространства имен в полном пространстве имен экземпляра шаблона URL, соответствующего URL. Если, например, пространство имен foo:bar , namespaces будет содержать . [‘foo’, ‘bar’]
Имя представления, соответствующего 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/')
Одним из возможных вариантов использования for 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. Если этот проект размещен в корне своего веб-сервера, значение всегда будет «/» .
Перенаправления (redirect). Функция reverse
В Django подобные редиректы достаточно просто выполняются с помощью функции: django.shortcuts.redirect Давайте для примера сделаем перенаправление со страницы архива, если год больше 2023:
def archive(request, year): if year > 2023: return redirect('/') return HttpResponse(f"Архив по годам
")
Здесь в качестве первого параметра указывается страница, на которую происходит перенаправление, в данном случае – это главная страница сайта. Также в файле settings.py вернем прежнее значение параметра DEBUG:
DEBUG = True
Если теперь выполнить запрос: 127.0.0.1:8000/archive/2024/ то мы попадем на главную страницу с кодом перенаправления 302 (см. консоль). Если же нам нужно указать постоянный редирект с кодом 301, то записывается дополнительный параметр:
return redirect('/', permanent=True)
Вообще в качестве первого аргумента функции redirect() можно передавать не только конкретный URL, но и представление. В частности, вместо ‘/’ можно передать ссылку на функцию index следующим образом:
return redirect(index, permanent=True)
В данном случае это будет одно и то же.
Классы HttpResponseRedirect и HttpResponsePermanentRedirect
- HttpResponseRedirect – для редиректа с кодом 302;
- HttpResponsePermanentRedirect – для редиректа с кодом 301
def archive(request, year): if year > 2023: return HttpResponseRedirect('/') return HttpResponse(f"Архив по годам
")
На самом деле функция redirect() использует в своей работе эти классы, но, вместе с тем, она несколько более гибкая. Поэтому какой вариант выбирать решает сам программист, исходя из логики построения кода.
Параметр name функции path
Однако указывать в функции redirect, да и вообще где бы то ни было в приложении конкретный URL-адрес (кроме их списка в коллекции urlpatterns) – это порочная практика, или, как еще говорят – хардкодинг. Вместо этого каждому шаблону пути можно присвоить свое уникальное имя и использовать его в рамках всего проекта. Давайте определим имена для наших URL-запросов. Для этого перейдем в файл women/urls.py и в каждой функции path пропишем параметр name с уникальными именами:
urlpatterns = [ path('', views.index, name='home'), path('cats//', views.categories_by_slug, name='cats'), path('cats//', views.categories, name='cats_id'), re_path(r'^archive/(?P[0-9])/', views.archive, name='archive'), ]
Конечно, эти имена вы можете выбрать и другие – это лишь пример. И далее, в функции redirect мы можем выполнить перенаправление на главную страницу, указав имя home:
return redirect('home', permanent=True)
Как видите, это гораздо понятнее и безопаснее использования конкретных URL-адресов. Если в дальнейшем маршрут изменится, то автоматически изменится и адрес перенаправления для home.
Функция reverse()
Если же маршрут помимо имени содержит еще параметры, как например, маршрут ‘cats’ с параметром slug, то для корректного перенаправления необходимо в функции redirect() вторым и последующими аргументами передать требуемые параметры. В нашем случае это можно сделать так:
return redirect('cats', 'music')
В результате, функция redirect() вычислит следующий URL: http://127.0.0.1:8000/cats/music/ и сделает на него перенаправление. Но мы можем разделить операции вычисления URL и непосредственно перенаправление. Для этого в Django имеется функция: django.urls.reverse() которая возвращает строку URL-адреса, вычисленный на основе переданного имени и набора аргументов. Например, для вычисления адреса маршрута cats с параметром ‘music’ функцию reverse() можно вызвать следующим образом:
url_redirect = reverse('cats', args=('music', ))
А, затем, передать этот маршрут в функцию reverse():
return redirect(url_redirect)
или в соответствующий класс:
return HttpResponsePermanentRedirect(url_redirect)
django.urls utility functions¶
If you need to use something similar to the url template tag in your code, Django provides the following function:
reverse ( viewname , urlconf = None , args = None , kwargs = None , current_app = None )¶
viewname can be a URL pattern name or the callable view object. For example, given the following url :
from news import views path("archive/", views.archive, name="news-archive")
you can use any of the following to reverse the 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)
If the URL accepts arguments, you may pass them in args . For example:
from django.urls import reverse def myview(request): return HttpResponseRedirect(reverse("arch-summary", args=[1945]))
You can also pass kwargs instead of args . For example:
>>> reverse("admin:app_list", kwargs="app_label": "auth">) '/admin/auth/'
args and kwargs cannot be passed to reverse() at the same time.
If no match can be made, reverse() raises a NoReverseMatch exception.
The reverse() function can reverse a large variety of regular expression patterns for URLs, but not every possible one. The main restriction at the moment is that the pattern cannot contain alternative choices using the vertical bar ( «|» ) character. You can quite happily use such patterns for matching against incoming URLs and sending them off to views, but you cannot reverse such patterns.
The current_app argument allows you to provide a hint to the resolver indicating the application to which the currently executing view belongs. This current_app argument is used as a hint to resolve application namespaces into URLs on specific application instances, according to the namespaced URL resolution strategy .
The urlconf argument is the URLconf module containing the URL patterns to use for reversing. By default, the root URLconf for the current thread is used.
The string returned by reverse() is already urlquoted . For example:
>>> reverse("cities", args=["Orléans"]) '. /Orl%C3%A9ans/'
Applying further encoding (such as urllib.parse.quote() ) to the output of reverse() may produce undesirable results.
reverse_lazy() ¶
A lazily evaluated version of reverse().
reverse_lazy ( viewname , urlconf = None , args = None , kwargs = None , current_app = None )¶
It is useful for when you need to use a URL reversal before your project’s URLConf is loaded. Some common cases where this function is necessary are:
- providing a reversed URL as the url attribute of a generic class-based view.
- providing a reversed URL to a decorator (such as the login_url argument for the django.contrib.auth.decorators.permission_required() decorator).
- providing a reversed URL as a default value for a parameter in a function’s signature.
resolve() ¶
The resolve() function can be used for resolving URL paths to the corresponding view functions. It has the following signature:
resolve ( path , urlconf = None )¶
path is the URL path you want to resolve. As with reverse() , you don’t need to worry about the urlconf parameter. The function returns a ResolverMatch object that allows you to access various metadata about the resolved URL.
If the URL does not resolve, the function raises a Resolver404 exception (a subclass of Http404 ) .
class ResolverMatch ¶ func ¶
The view function that would be used to serve the URL
The arguments that would be passed to the view function, as parsed from the URL.
All keyword arguments that would be passed to the view function, i.e. captured_kwargs and extra_kwargs .
New in Django 4.1.
The captured keyword arguments that would be passed to the view function, as parsed from the URL.
New in Django 4.1.
The additional keyword arguments that would be passed to the view function.
The name of the URL pattern that matches the URL.
The route of the matching URL pattern.
For example, if path(‘users//’, . ) is the matching pattern, route will contain ‘users//’ .
The list of URL patterns tried before the URL either matched one or exhausted available patterns.
The application namespace for the URL pattern that matches the URL.
The list of individual namespace components in the full application namespace for the URL pattern that matches the URL. For example, if the app_name is ‘foo:bar’ , then app_names will be [‘foo’, ‘bar’] .
The instance namespace for the URL pattern that matches the URL.
The list of individual namespace components in the full instance namespace for the URL pattern that matches the URL. i.e., if the namespace is foo:bar , then namespaces will be [‘foo’, ‘bar’] .
The name of the view that matches the URL, including the namespace if there is one.
A ResolverMatch object can then be interrogated to provide information about the URL pattern that matches a URL:
# Resolve a URL match = resolve("/some/path/") # Print the URL pattern that matches the URL print(match.url_name)
A ResolverMatch object can also be assigned to a triple:
func, args, kwargs = resolve("/some/path/")
One possible use of resolve() would be to test whether a view would raise a Http404 error before redirecting to it:
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 ()¶
Normally, you should always use reverse() to define URLs within your application. However, if your application constructs part of the URL hierarchy itself, you may occasionally need to generate URLs. In that case, you need to be able to find the base URL of the Django project within its web server (normally, reverse() takes care of this for you). In that case, you can call get_script_prefix() , which will return the script prefix portion of the URL for your Django project. If your Django project is at the root of its web server, this is always «/» .
This function cannot be used outside of the request-response cycle since it relies on values initialized during that cycle.
Маршрутизация — Python: Разработка на фреймворке Django
Важнейшей частью любого веб-фреймворка является механизм, который отвечает за маршрутизацию. Во Flask для построения карты маршрутов использовались специальные декораторы. В Django для этого используется свой небольшой eDSL . Он описывает urlpatterns — набор образцов, с которыми сопоставляются пути из каждого входящего запроса.
Каждый образец состоит из описания статических и динамических частей пути в виде строки или регулярного выражения:
- Статические части пути в образце просто проверяются на равенство соответствующим участкам пути в запросе
- Динамические участки пути позволяют захватывать значения и передавать во view в качестве аргументов
Как только выясняется, что путь или его начало совпали с образцом, происходит либо вызов view, либо передача оставшейся части пути во вложенный блок urlpatterns. В большинстве больших Django-проектов urlpatterns вложены друг в друга и представляют собой дерево.
В этом уроке подробно разберем статические и динамические маршруты, а также рассмотрим вложенные urlpatterns и обратные маршруты.
Статические маршруты
Мы с вами уже описали один статический маршрут:
urlpatterns = [ path('', views.index), ] Здесь path сопоставляет образец » с вьюхой views.index . Образец «пустая строка» соответствует пустому пути — запросам главной страницы сайта. Любой не пустой путь не совпадет с таким образцом. Статические образцы обычно описываются строками вида ‘fruits/apples/golden_one и ожидают запросов строго по этому же пути.
Имя домена не фигурирует в urlpatterns, что позволяет размещать одно и то же приложение на любом домене.
Динамические маршруты
Авторы Django — сторонники использования читаемых URL. Это означает, что маршруты в Django-приложениях выглядят так, что понятно, куда ведет путь. Например, по пути /users/42/pets/101/med_info/ можно догадаться, что запрашивается медицинская информация (med_info) для питомца с идентификатором 101 (pets/101). Он принадлежит пользователю с идентификатором 42 (user/42).
Иногда получается пойти дальше и вместо идентификаторов использовать имена. Например, такое возможно для имен пользователей, которые обычно уникальны в пределах системы. URL при использовании имен может выглядеть так: /users/~bob/books/ .
Пути, которые включают в себя данные — идентификаторы и имена — называются динамическими. И динамические маршруты используются как раз с такими путями.
В образце, который описывает динамический маршрут, указываются именованные динамические участки. Каждый такой участок обрабатывает свою часть пути и определяет значение для аргумента, который будет передан во view. В итоге от view уже не требуется какая-либо обработка пути, хотя это и возможно.
Опишем urlpatterns для примера пути, который приведен выше:
## urls.py urlpatterns = [ path('users//pets//med_info/', med_info_view), … ] ## views.py def med_info_view(request, user_id, pet_id): . Здесь означает ту самую динамическую часть пути. int означает, что в этом участке пути ожидается целое число в виде строки. Если сервер получит запрос по пути /users/42/pets/101/med_info/ , маршрутизация закончится вызовом вью med_info_view(request, user_id=42, pet_id=101) .
Кроме int Django предоставляет и другие преобразователи путей — path converters. Более того, можно определять и собственные. А если пути специфические, то всегда можно использовать регулярные выражения, чтобы выделить интересные нам части пути.
Вложенные urlpatterns
Иногда маршрутов становится слишком много и среди них намечаются группы, у которых общая статическая часть. Например, это маршруты ко views одного приложения. В этом случае стоит воспользоваться возможностью включения одних urlpatterns в другие.
Предположим, у нас в проекте есть приложение project.users , в котором все views находятся под общим префиксом /users/. Нам достаточно создать модуль project.users.urls с описанием urlpatterns уже без префикса и подключить модуль в корневой project.urls :
# project.users.urls from django.urls import path from project.users import views urlpatterns = [ path('', views.users_view), path('/pets//med_info/', views.pet_med_info_view), … ] # project.urls from django.urls import path, include urlpatterns = [ … path('users/', include('project.users.urls')), … ] В новом наборе urlpatterns у образцов нет префикса users. А в основном urlpatterns указано, что все пути, которые начинаются с users, нужно сопоставлять с образцами из project.users.urls .
Мы подключили вложенные urlpatterns с помощью функции django.urls.include и указали модуль в виде строки. Можно импортировать модуль и указать вместо цели маршрута сразу его: path(‘users’, project.users.urls) — эти два варианта эквивалентны. Но неявное подключение вместо импорта решает одну важную задачу: избавляет от потенциальных циклических импортов.
Ранее мы закомментировали в нашем мини-проекте строчку path(‘admin’, admin.site.urls) . Это тоже включение админки в нашу карту маршрутов по префиксу admin. Подобным образом в приложение часто подключаются сторонние пакеты, у которых собственные маршруты.
Обратные маршруты или reverse
Часто нужно получить для определенного маршрута правильный путь. Например, необходимо кому-то дать ссылку на медицинскую карточку питомца пользователя. Если мы будем вручную собирать путь из строк, то при изменениях в маршруте новый путь может стать некорректным.
Чтобы была возможность для любого маршрута всегда получить правильный путь, нужно произвести операцию, обратную маршрутизации — у Django есть функции reverse и reverse_lazy . Они позволяют получить путь по имени маршрута. Поэтому маршруты, которые нужно обращать, необходимо поименовать (задать уникальное имя):
urlpatterns = [ … path( '/pets//med_info/', views.pet_med_info_view, name='pet_med_info', # ), … ] Когда маршрут поименован, можно получить путь вызовом вида reverse(‘pet_med_info’, kwargs=) . Как бы ни менялась маршрутизация в дальнейшем, пока путь содержит те же именованные участки и назван по-старому, эта функция будет давать актуальный для маршрута путь.
Открыть доступ
Курсы программирования для новичков и опытных разработчиков. Начните обучение бесплатно
- 130 курсов, 2000+ часов теории
- 1000 практических заданий в браузере
- 360 000 студентов
Наши выпускники работают в компаниях: