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('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 позволяет передать дополнительные аргументы функции или методу представления. См. Передача дополнительных параметров функциям представления для примера.

См. Именование шаблонов 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'^weblog/', include('blog.urls')),
    ...
]

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

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

include()

include(module, namespace=None)

include(pattern_list)

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

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

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

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

Parameters:	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)

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.