path()¶

path(route, view, kwargs=None, name=None)¶

Возвращает элемент для включения в urlpatterns. Например:

from django.urls import include, path

urlpatterns = [
    path('index/', views.index, name='main-view'),
    path('bio/<username>/', views.bio, name='bio'),
    path('articles/<slug:title>/', views.article, name='article-detail'),
    path('articles/<slug:title>/<int:section>/', views.section, name='article-section'),
    path('weblog/', include('blog.urls')),
    ...
]

Аргумент route должен быть строкой или gettext_lazy() (см. Перевод шаблонов URL), содержащей шаблон URL. Строка может содержать угловые скобки (как <username> выше), чтобы захватить часть URL и отправить ее в качестве аргумента ключевого слова в представление. Угловые скобки могут включать спецификацию конвертера (например, int часть <int:section>), которая ограничивает совпадающие символы, а также может изменить тип переменной, передаваемой представлению. Например, <int:section> соответствует строке десятичных цифр и преобразует значение в int. Более подробную информацию смотрите в Как Django обрабатывает запрос.

Аргумент view является функцией представления или результатом as_view() для представлений на основе классов. Он также может быть django.urls.include().

Аргумент kwargs позволяет передавать дополнительные аргументы в функцию или метод представления. Пример см. в Передача дополнительных параметров функции предствления.

О том, почему аргумент Naming URL patterns полезен, см. в name.

re_path()¶

re_path(route, view, kwargs=None, name=None)¶

Возвращает элемент для включения в urlpatterns. Например:

from django.urls import include, re_path

urlpatterns = [
    re_path(r'^index/$', views.index, name='index'),
    re_path(r'^bio/(?P<username>\w+)/$', views.bio, name='bio'),
    re_path(r'^weblog/', include('blog.urls')),
    ...
]

Аргумент route должен быть строкой или gettext_lazy() (см. Перевод шаблонов URL), содержащей регулярное выражение, совместимое с модулем Python re. Строки обычно используют синтаксис необработанных строк (r''), поэтому они могут содержать последовательности типа \d без необходимости экранировать обратный слеш другим обратным слешем. Когда происходит совпадение, захваченные группы из регулярного выражения передаются в представление - как именованные аргументы, если группы именованные, и как позиционные аргументы в противном случае. Значения передаются как строки, без преобразования типов.

Когда route заканчивается на $, весь запрашиваемый URL, сопоставленный с path_info, должен соответствовать шаблону регулярного выражения (используется:py:func:re.fullmatch).

Аргументы view, kwargs и name такие же, как и для path().

include()¶

include(module, namespace=None)[исходный код]¶

include(pattern_list)

include((pattern_list, app_namespace), namespace=None)

Функция, принимающая полный путь импорта Python к другому модулю URLconf, который должен быть «включен» в это место. Опционально можно также указать application namespace и instance namespace, в которые будут включены записи.

Обычно пространство имен приложения должно быть задано включенным модулем. Если пространство имен приложения задано, аргумент namespace может быть использован для задания другого пространства имен экземпляра.

include() также принимает в качестве аргумента либо итерабель, возвращающий шаблоны URL, либо кортеж, содержащий такую итерабель плюс имена пространств имен приложений.

Параметры:	module – Модуль URLconf (или имя модуля) namespace (str) – Пространство имен экземпляра для включаемых записей URL pattern_list – Итерабельность экземпляров path() и/или re_path(). app_namespace (str) – Пространство имен приложения для включаемых записей URL

См. Включение других URLconfs и Пространства имен URL и включенные URLconfs.

register_converter()¶

register_converter(converter, type_name)[исходный код]¶

Функция для регистрации конвертера для использования в path() routes.

Аргумент converter - это класс конвертера, а type_name - имя конвертера, которое следует использовать в шаблонах путей. Пример см. в Регистрация пользовательских конвертеров пути.

static()¶

static.static(prefix, view=django.views.static.serve, **kwargs)¶

Вспомогательная функция для возврата шаблона URL для обслуживания файлов в режиме отладки:

from django.conf import settings
from django.conf.urls.static import static

urlpatterns = [
    # ... the rest of your URLconf goes here ...
] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

url()¶

url(regex, view, kwargs=None, name=None)[исходный код]¶

Эта функция является псевдонимом для django.urls.re_path().

handler400¶

handler400¶

Вызываемый объект, или строка, представляющая полный путь импорта Python к представлению, которое должно быть вызвано, если HTTP-клиент отправил запрос, вызвавший состояние ошибки и ответ с кодом состояния 400.

По умолчанию это django.views.defaults.bad_request(). Если вы реализуете пользовательское представление, убедитесь, что оно принимает аргументы request и exception и возвращает HttpResponseBadRequest.

handler403¶

handler403¶

Вызываемый объект, или строка, представляющая полный путь импорта Python к представлению, которое должно быть вызвано, если у пользователя нет необходимых разрешений для доступа к ресурсу.

По умолчанию это django.views.defaults.permission_denied(). Если вы реализуете пользовательское представление, убедитесь, что оно принимает аргументы request и exception и возвращает HttpResponseForbidden.

handler404¶

handler404¶

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

По умолчанию это django.views.defaults.page_not_found(). Если вы реализуете пользовательское представление, убедитесь, что оно принимает аргументы request и exception и возвращает HttpResponseNotFound.

handler500¶

handler500¶

Вызываемый объект, или строка, представляющая полный путь импорта Python к представлению, которое должно быть вызвано в случае ошибок сервера. Ошибки сервера возникают, когда в коде представления есть ошибки времени выполнения.

По умолчанию это django.views.defaults.server_error(). Если вы реализуете пользовательское представление, убедитесь, что оно принимает аргумент request и возвращает HttpResponseServerError.