{"title":"URLconfs 中使用的 django.urls 函数","version":"6.1","locale":"zh-hans","docname":"ref/urls","url":"/zh-hans/6.1/ref/urls/","canonical":"https://djangodocs.dev/zh-hans/6.1/ref/urls/","summary":"path() Link to this heading # path ( route , view , kwargs = None , name = None ) Link to this definition # 返回一个元素，以便包含在 urlpatterns 中。例如： Code Copy from…","html":"
\n

URLconfs 中使用的 django.urls 函数Link to this heading#

\n
\n

path()Link to this heading#

\n
\n
\npath(route, view, kwargs=None, name=None)Link to this definition#
\n
\n\n

返回一个元素，以便包含在 urlpatterns 中。例如：

\n
Code
from django.urls import include, path\n\nurlpatterns = [\n    path("index/", views.index, name="main-view"),\n    path("bio/<username>/", views.bio, name="bio"),\n    path("articles/<slug:title>/", views.article, name="article-detail"),\n    path("articles/<slug:title>/<int:section>/", views.section, name="article-section"),\n    path("blog/", include("blog.urls")),\n    ...,\n]\n
\n
\n

routeLink to this heading#

\n

The route argument should be a string or\ngettext_lazy() (see\n翻译URL模式) that contains a URL pattern. The string\nmay contain angle brackets (like <username> above) to capture part of the\nURL and send it as a keyword argument to the view. The angle brackets may\ninclude a converter specification (like the int part of <int:section>)\nwhich limits the characters matched and may also change the type of the\nvariable passed to the view. For example, <int:section> matches a string\nof decimal digits and converts the value to an int.

\n

在处理请求时，Django 从 urlpatterns 中的第一个模式开始，依次向下遍历列表，将请求的 URL 与每个模式进行比较，直到找到匹配的模式。更多详细信息请参见 Django 如何处理一个请求。

\n

模式不会匹配 GET 和 POST 参数或域名。例如，在请求 https://www.example.com/myapp/ 时，URLconf 会查找 myapp/。在请求 https://www.example.com/myapp/?page=3 时，URLconf 同样会查找 myapp/。

\n
\n
\n

viewLink to this heading#

\n

view 参数是一个视图函数或基于类的视图的 as_view() 结果。它也可以是 django.urls.include()。

\n

当 Django 找到匹配的模式时，它会调用指定的视图函数，并将 HttpRequest 对象作为第一个参数，将路由中“捕获”的值作为关键字参数传递。

\n
\n
\n

kwargsLink to this heading#

\n

kwargs 参数允许你向视图函数或方法传递附加参数。参见 传递额外选项给视图函数 的例子。

\n
\n
\n

nameLink to this heading#

\n

为你的 URL 取名能使你在 Django 的任意地方唯一地引用它，尤其是在模板中。这个有用的特性允许你只改一个文件就能全局地修改某个 URL 模式。

\n

关于为什么 name 参数是有用的，请参见 命名 URL 模式。

\n
\n
\n
\n

re_path()Link to this heading#

\n
\n
\nre_path(route, view, kwargs=None, name=None)Link to this definition#
\n
\n\n

返回一个元素，以便包含在 urlpatterns 中。例如：

\n
Code
from django.urls import include, re_path\n\nurlpatterns = [\n    re_path(r"^index/$", views.index, name="index"),\n    re_path(r"^bio/(?P<username>\\w+)/$", views.bio, name="bio"),\n    re_path(r"^blog/", include("blog.urls")),\n    ...,\n]\n
\n

The route argument should be a string or\ngettext_lazy() (see\n翻译URL模式) that contains a regular expression compatible\nwith Python's re module. Strings typically use raw string syntax\n(r'') so that they can contain sequences like \\d without the need to\nescape the backslash with another backslash. When a match is made, captured\ngroups from the regular expression are passed to the view -- as named arguments\nif the groups are named, and as positional arguments otherwise. The values are\npassed as strings, without any type conversion.

\n

When a route ends with $ the whole requested URL, matching against\npath_info, must match the regular expression\npattern (re.fullmatch() is used).

\n

The view, kwargs and name arguments are the same as for\npath().

\n
\n
\n

include()Link to this heading#

\n
\n
\ninclude(module, namespace=None)Link to this definition#
\n
\ninclude(pattern_list)
\n
\ninclude((pattern_list, app_namespace), namespace=None)
\n

一个函数，它接收一个完整的 Python 导入路径到另一个应该被 “包含” 在这里的 URLconf 模块。可以选择指定 application namespace 和 instance namespace，在这两个空间中，条目将被包含进去。

\n

通常，应用程序的命名空间应该由包含的模块指定。如果设置了应用程序命名空间，namespace 参数可以用来设置不同的实例命名空间。

\n

include() 也接受一个返回 URL 模式的迭代函数或一个包含这种迭代函数加上应用程序名称空间的二元元组作为参数。

\n
\n
参数:
\n
    \n

  • module -- URLconf 模块（或模块名称）

    • \n

  • namespace (str) -- 包含的 URL 条目的实例命名空间。

    • \n

  • pattern_list -- 可迭代的 path() 和／或 re_path() 实例。

    • \n

  • app_namespace (str) -- 被包含的 URL 条目的应用命名空间

    • \n
\n
\n
\n
\n\n

参见 包含其它的URLconfs 和 URL 命名空间和包含的 URLconfs。

\n
\n
\n

register_converter()Link to this heading#

\n
\n
\nregister_converter(converter, type_name)Link to this definition#
\n
\n\n

The function for registering a converter for use in path()\nroutes.

\n

converter 参数是一个转换器类，type_name 是路径模式中使用的转换器名称。参见 注册自定义的路径转换器 的例子。

\n
\n
\n
\n

URLconfs 中使用的 django.conf.urls 函数Link to this heading#

\n
\n

static()Link to this heading#

\n
\n
\nstatic.static(prefix, view=django.views.static.serve, **kwargs)Link to this definition#
\n
\n\n

用于返回在调试模式下服务文件的 URL 模式的辅助函数：

\n
Code
from django.conf import settings\nfrom django.conf.urls.static import static\n\nurlpatterns = [\n    # ... the rest of your URLconf goes here ...\n] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)\n
\n
\n
\n

handler400Link to this heading#

\n
\n
\nhandler400Link to this definition#
\n
\n\n

一个可调用对象，或者一个代表视图的完整 Python 导入路径的字符串，如果 HTTP 客户端发送了一个引起错误条件的请求，并且响应的状态码为 400，那么就会调用该视图。

\n

默认情况下，这是 django.views.defaults.bad_request()。如果你实现了自定义视图，请确保它接受 request 和 exception 参数，并返回一个 HttpResponseBadRequest。

\n
\n
\n

handler403Link to this heading#

\n
\n
\nhandler403Link to this definition#
\n
\n\n

一个可调用对象，或者一个代表视图的完整 Python 导入路径的字符串，如果用户没有访问资源所需的权限，那么就会调用该视图。

\n

默认情况下，这是 django.views.defaults.permission_denied()。如果你实现了一个自定义视图，请确保它接受 request 和 exception 参数，并返回一个 HttpResponseForbidden。

\n
\n
\n

handler404Link to this heading#

\n
\n
\nhandler404Link to this definition#
\n
\n\n

一个可调用对象，或者一个代表视图的完整 Python 导入路径的字符串，如果没有任何 URL 模式匹配，那么就会调用该视图。

\n

默认情况下，这是 django.views.defaults.page_not_found()。如果你实现了自定义视图，请确保它接受 request 和 exception 参数，并返回一个 HttpResponseNotFound。

\n
\n
\n

handler500Link to this heading#

\n
\n
\nhandler500Link to this definition#
\n
\n\n

一个可调用对象，或者一个代表视图的完整 Python 导入路径的字符串，在服务器出错时会被调用。当你在视图代码中出现运行时错误时，就会发生服务器错误。

\n

默认情况下，这是 django.views.defaults.server_error()。如果你实现了自定义视图，请确保它接受一个 request 参数，并返回一个 HttpResponseServerError。

\n
\n
\n","rootId":"","toc":[{"title":"URLconfs 中使用的 django.urls 函数","anchor":"","children":[{"title":"path()","anchor":"path","children":[{"title":"route","anchor":"route","children":[]},{"title":"view","anchor":"view","children":[]},{"title":"kwargs","anchor":"kwargs","children":[]},{"title":"name","anchor":"name","children":[]}]},{"title":"re_path()","anchor":"re-path","children":[]},{"title":"include()","anchor":"include","children":[]},{"title":"register_converter()","anchor":"register-converter","children":[]}]},{"title":"URLconfs 中使用的 django.conf.urls 函数","anchor":"module-django.conf.urls","children":[{"title":"static()","anchor":"static","children":[]},{"title":"handler400","anchor":"handler400","children":[]},{"title":"handler403","anchor":"handler403","children":[]},{"title":"handler404","anchor":"handler404","children":[]},{"title":"handler500","anchor":"handler500","children":[]}]}],"breadcrumbs":[{"docname":"ref/index","title":"API 参考","url":"/zh-hans/6.1/ref/"}],"prev":{"docname":"ref/urlresolvers","title":"django.urls 实用函数","url":"/zh-hans/6.1/ref/urlresolvers/"},"next":{"docname":"ref/utils","title":"Django 实用程序","url":"/zh-hans/6.1/ref/utils/"},"formats":{"html":"/zh-hans/6.1/ref/urls/","markdown":"/zh-hans/6.1/ref/urls.md","json":"/zh-hans/6.1/ref/urls.json"},"source":"https://github.com/django/django/blob/stable/6.1.x/docs/ref/urls.txt","official":"https://docs.djangoproject.com/zh-hans/6.1/ref/urls/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0"],"inLocales":["en","sv","zh-hans","ga","fr","ja","id","it","pt-br","ko","es","el","pl"]}