django.urls функции для использования в URLconfs

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('blog/', include('blog.urls')),
    ...
]

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

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

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

См. Именование URL-шаблонов, чтобы понять, почему аргумент 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'^blog/', include('blog.urls')),
    ...
]

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

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

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

include()

include(module, namespace=None)

include(pattern_list)

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

Функция, которая принимает полный путь импорта Python к другому модулю URLconf, который должен быть «включён» в этом месте. Также можно указать (необязательно) пространство имён приложения и пространство имён экземпляра, куда будут включены записи.

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

include() также принимает в качестве аргумента либо итерируемый объект, возвращающий URL-шаблоны, либо кортеж из двух элементов: этот итерируемый объект и имена пространств имён приложения.

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

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

register_converter()

register_converter(converter, type_name)

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

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

django.conf.urls функции для использования в URLconfs

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)

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.