Django之路由配置(url与path及re_path区别)_django urlpatterns url和path-程序员宅基地

技术标签: django  Django  后端  

url是Django 1.x中的写法,在Django2.1中,开始舍弃Django1.x中的url写法。在Django2.x中,描写url配置的有两个函数path和re_path,re_path()函数可以看做是django 1.x中得url函数,即可以在路径中使用正则。

默认url(route, view, kwargs=None, name=None)

默认path(route, view, kwargs=None, name=None)

默认re_path(route, view, kwargs=None, name=None)

本文重点描述path和re_path,前五条内容即可实现基本运用

1、概述

要设计应用程序的URL,可以创建一个非正式的称为URLconf(URL配置)的Python模块。此模块是纯Python代码,是URL路径表达式与Python函数(您的视图)之间的映射。该映射可以根据需要短或长。它可以引用其他映射。并且,因为它是纯Python代码,所以它可以动态构造。

2、django如何处理请求

当用户请求一个页面时,Django根据下面的逻辑执行操作:

(1)决定要使用的根URLconf模块。通常,这是ROOT_URLCONF设置的值,但是如果传入的HttpRequest对象具有urlconf属性(由中间件设置),则其值将被用于代替ROOT_URLCONF设置。
(2)加载该模块并寻找可用的urlpatterns。 它是django.conf.urls.url()实例的一个列表。
(3)依次匹配每个URL模式,在与请求的URL相匹配的第一个模式停下来。(注意url在列表中的位置)
(4)导入并调用匹配行中给定的视图,该视图是一个简单的Python函数(被称为视图函数),或基于类的视图。 视图将获得如下参数:
    <1>一个HttpRequest 实例。
    <2>如果匹配的正则表达式返回了没有命名的组,那么正则表达式匹配的内容将作为位置参数提供给视图。
    <3>关键字参数由正则表达式匹配的命名组组成,但是可以被django.conf.urls.url()的可选参数kwargs覆盖。
    <4>如果没有匹配到正则表达式,或者过程中抛出异常,将调用一个适当的错误处理视图。

3、转换器(django2.0 以上默认使用的是path转换器)

from django.urls import path
    from . import views

    urlpatterns = [
    path('articles/2003/', views.special_case_2003),
    path('articles/<int:year>/', views.year_archive),
    path('articles/<int:year>/<int:month>/', views.month_archive),
    path('articles/<int:year>/<int:month>/<slug:slug>/', views.article_detail),
    ]
/articles/2005/03/ 将匹配第三条,并调用views.month_archive(request, year=2005, month=3)/articles/2003/匹配第一条,并调用views.special_case_2003(request)/articles/2003将一条都匹配不上,因为它最后少了一个斜杠,而列表中的所有模式中都以斜杠结尾;
/articles/2003/03/building-a-django-site/ 将匹配最后一个,并调用views.article_detail(request, year=2003, month=3, slug="building-a-django-site"

注意:

(1)要捕获一段url中的值,需要使用尖括号,而不是之前的圆括号;
(2)可以转换捕获到的值为指定类型,比如例子中的int。默认情况下,捕获到的结果保存为字符串类型,不包含/这个特殊字符;
(3)匹配模式的最开头不需要添加/,因为默认情况下,每个url都带一个最前面的/。

默认情况下,Django内置下面的路径转换器:

str:匹配任何非空字符串,但不含斜杠/,如果你没有专门指定转换器,那么这个是默认使用的;
int:匹配0和正整数,返回一个int类型
slug:可理解为注释。该转换器匹配任何ASCII字符以及连接符和下划线,比如’ building-your-1st-django-site‘;
uuid:匹配一个uuid格式的对象。为了防止冲突,规定必须使用破折号,所有字母必须小写,例如’075194d3-6885-417e-a8a8-6c931e272f00‘ 。返回一个UUID对象;
path:匹配任何非空字符串,重点是可以包含路径分隔符’/‘。这个转换器可以帮助你匹配整个url而不是一段一段的url字符串。

4、使用正则表达式

如果路径和转换器语法不足以定义URL模式,则也可以使用正则表达式。使用 re_path()代替path()。

在Python正则表达式中,已命名正则表达式组的语法为(?Ppattern),其中name是组的名称,并且 pattern是要匹配的某种模式。

示例URLconf,使用正则表达式重写:

from django.urls import path, re_path

from . import views

urlpatterns = [
    path('articles/2003/', views.special_case_2003),
    re_path(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive),
    re_path(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$', views.month_archive),
    re_path(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/(?P<slug>[\w-]+)/$', views.article_detail),
]

与示例URLconf区别:

(1)将要匹配的确切URL受到更多限制。例如,年份10000将不再匹配,因为年份整数被限制为正好是四位数长。
(2)无论正则表达式进行哪种匹配,每个捕获的参数都将作为字符串发送到视图。
(3)当从使用re_path()切换为使用path(), re_path()反之亦然时,特别重要的是要注意视图参数的类型可能会发生变化,因此您可能需要调整视图。
(4)当命名的组与未命名的组两种样式混合使用时,任何未命名分组path('(\d+)/',view)都会被忽略,只有命名分组path('(?P<year>\d+)/',view)才会传递到视图函数。
(5)未命名分组将正则表达式匹配到的内容当作位置参数,命名分组将正则表达式匹配到的内容当作关键字参数

5、include()

在任何时候,urlpatterns都可以“include”其他URLconf模块。这本质上是一组位于其他url之下的“roots”。

from django.urls import include, path

urlpatterns = [
    path('community/', include('aggregator.urls')),
    path('contact/', include('contact.urls')),
]

每当Django遇到时include(),它都会截断直到该处匹配的URL的任何部分,并将剩余的字符串发送到包含的URLconf中以进行进一步处理。

另一种可能性是通过使用path()实例列表包括其他URL模块 。例如,考虑以下URLconf:

from django.urls import include, path

from apps.main import views as main_views
from credit import views as credit_views

extra_patterns = [
    path('reports/', credit_views.report),
    path('reports/<int:id>/', credit_views.report),
    path('charge/', credit_views.charge),
]

urlpatterns = [
    path('', main_views.homepage),
    path('help/', include('apps.help.urls')),
    path('credit/', include(extra_patterns)),
]

/credit/reports/将由credit_views.report()视图处理 。

可用于从URLconf中删除重复使用单个模式前缀的冗余。

from django.urls import path
from . import views

urlpatterns = [
    path('<page_slug>-<page_id>/history/', views.history),
    path('<page_slug>-<page_id>/edit/', views.edit),
    path('<page_slug>-<page_id>/discuss/', views.discuss),
    path('<page_slug>-<page_id>/permissions/', views.permissions),
]

可通过仅说明一次公共路径前缀并对不同的后缀进行分组:

from django.urls import include, path
from . import views

urlpatterns = [
    path('<page_slug>-<page_id>/', include([
        path('history/', views.history),
        path('edit/', views.edit),
        path('discuss/', views.discuss),
        path('permissions/', views.permissions),
    ])),
]
                    以下为深入了解内容

6、注册自定义路径转换器

对于更复杂的匹配要求,您可以定义自己的路径转换器。

转换器是包含以下内容的类:

一个regex类属性,作为一个字符串。
一个to_python(self, value)方法,用于将匹配的字符串转换为应该传递给视图函数的类型。如果它不能转换给定的值,就会引发ValueError。ValueError被解释为没有匹配,因此404响应被发送给用户,除非另一个URL模式匹配。
一个to_url(self, value)方法,用于将Python类型转换为要在URL中使用的字符串。
class FourDigitYearConverter:
    regex = '[0-9]{4}'

    def to_python(self, value):
        return int(value)

    def to_url(self, value):
        return '%04d' % value

使用register_converter()以下命令在URLconf中注册自定义转换器类 :

from django.urls import path, register_converter
from . import converters, views

register_converter(converters.FourDigitYearConverter, 'yyyy')

urlpatterns = [
    path('articles/2003/', views.special_case_2003),
    path('articles/<yyyy:year>/', views.year_archive),
    ...
]

7、URLconf匹配的内容

URLconf按照正常的Python字符串匹配请求的URL。不包括GET或POST参数或域名及请求方法。

例如,在对的请求中https://www.example.com/myapp/,URLconf将寻找myapp/。

在请求中https://www.example.com/myapp/?page=3,URLconf将寻找myapp/。

8、为视图参数指定默认值

一个方便的技巧是为视图的参数指定默认参数。这是一个示例URLconf和视图:

from django.urls import path

from . import views

urlpatterns = [
    path('blog/', views.page),
    path('blog/page<int:num>/', views.page),
]

两个URL模式都指向同一个视图 views.page,但是第一个模式没有从URL中捕获任何内容。如果第一个模式匹配,该page()函数将使用它的默认参数num;如果第二个模式匹配, page()将使用num捕获的任何值。

9、自定义错误视图

当Django无法找到所请求URL的匹配项时,或者引发异常时,Django会调用默认错误视图,Django中的默认错误视图对于大多数Web应用程序来说已经足够了,但是如果您需要任何自定义行为,可以在您的根URLconf中设置这些值,在任何其他URLconf中设置这些变量将无效。
值必须是可调用的,或者是表示视图的完整Python导入路径的字符串,应该调用该视图来处理当前的错误情况。

该page_not_found()视图被覆盖 handler404:

handler404 = 'mysite.views.my_custom_page_not_found_view'

该server_error()视图被覆盖 handler500:

handler500 = 'mysite.views.my_custom_error_view'

该permission_denied()视图被覆盖 handler403:

handler403 = 'mysite.views.my_custom_permission_denied_view'

该bad_request()视图被覆盖 handler400:

handler400 = 'mysite.views.my_custom_bad_request_view'

10、捕捉的参数

包含的URLconf从父URLconfs接收任何捕获的参数,:

# In settings/urls/main.py
from django.urls import include, path

urlpatterns = [
    path('<username>/blog/', include('foo.urls.blog')),
]

# In foo/urls/blog.py
from django.urls import path
from . import views

urlpatterns = [
    path('', views.blog.index),
    path('archive/', views.blog.archive),
]

在上面的示例中,捕获的"username"变量按预期传递给了include的URLconf。

11、传递额外的选项到函数

URLconfs有一个钩子,可让您将额外的参数作为Python字典传递给视图函数。

该path()函数可以使用可选的第三个参数,该参数应该是传递给view函数的额外关键字参数的字典。

from django.urls import path
from . import views

urlpatterns = [
    path('blog/<int:year>/', views.year_archive, {
    'foo': 'bar'}),
]

在此示例中,对于的请求/blog/2005/,Django将调用views.year_archive(request, year=2005, foo=‘bar’)
该技术在联合框架中用于将元数据和选项传递给视图。

注:URL模式可能会捕获命名的关键字参数,并且还会在其额外参数的字典中传递具有相同名称的参数。发生这种情况时,将使用字典中的参数代替URL中捕获的参数。

同样,您可以将额外选项传递给include(),所包含的URLconf中的每一行都将传递额外选项。

例如,这两个URLconf集在功能上是相同的:

设置一:

# main.py
from django.urls import include, path

urlpatterns = [
    path('blog/', include('inner'), {
    'blog_id': 3}),
]

# inner.py
from django.urls import path
from mysite import views

urlpatterns = [
    path('archive/', views.archive),
    path('about/', views.about),
]

设置二:

# main.py
from django.urls import include, path
from mysite import views

urlpatterns = [
    path('blog/', include('inner')),
]

# inner.py
from django.urls import path

urlpatterns = [
    path('archive/', views.archive, {
    'blog_id': 3}),
    path('about/', views.about, {
    'blog_id': 3}),
]

请注意,无论视图实际上是否接受这些选项,额外的选项将始终传递到所包含的URLconf中的每一行。因此,仅当您确定所包含的URLconf中的每个视图都接受要传递的额外选项时才有用。

12、URL的反向解析

在Django项目上进行工作时,通常需要获取最终形式的URL,以嵌入生成的内容(视图和资产URL,向用户显示的URL等)或在服务器上处理导航流程侧面(重定向等)

Django提供了一个解决方案,使得URL映射器是URL设计的唯一存储库。将其与URLconf一起提供,然后可以在两个方向上使用它:

(1)从用户/浏览器请求的URL开始,它将调用正确的Django视图,以提供可能需要的任何参数以及从URL中提取的值。
(2)从标识相应的Django视图以及将传递给该视图的参数值开始,获取关联的URL。

上述(2)是所谓的URL反向解析,反向URL匹配,反向URL查找或简称URL反向。

Django提供了执行URL反转的工具,这些工具与需要URL的不同层相匹配:

在模板中:使用url模板标记
在Python代码中:使用reverse()函数
在与Django模型实例的URL处理有关的更高级别的代码中:get_absolute_url()方法

再次考虑以下URLconf条目:

from django.urls import path

from . import views

urlpatterns = [
    path('articles/<int:year>/', views.year_archive, name='news-year-archive'),
]

可以使用以下模板代码获取它们:

<a href="{% url 'news-year-archive' 2012 %}">2012 Archive</a>
{
    # Or with the year in a template context variable: #}
<ul>
{
    % for yearvar in year_list %}
<li><a href="{% url 'news-year-archive' yearvar %}">{
    {
     yearvar }} Archive</a></li>
{
    % endfor %}
</ul>

在Python代码中:

from django.http import HttpResponseRedirect
from django.urls import reverse

def redirect_to_year(request):
    year = 2006
    return HttpResponseRedirect(reverse('news-year-archive', args=(year,)))

13、嵌套参数

正则表达式允许嵌套参数,而Django会解析它们并将其传递给视图。反转时,Django将尝试填写所有外部捕获的参数,而忽略任何嵌套的捕获参数。考虑以下URL模式,这些URL模式可以选择采用page参数:

from django.urls import re_path

urlpatterns = [
    re_path(r'^blog/(page-(\d+)/)?$', blog_articles),                  # bad
    re_path(r'^comments/(?:page-(?P<page_number>\d+)/)?$', comments),  # good
]

这两种模式都使用嵌套的参数并将解析:例如,blog/page-2/将导致与blog_articles的匹配,其中包含两个位置参数:page-2/和2。第二种模式将comments/page-2/与关键字参数page_number设置为2匹配。在本例中,外部参数是一个非捕获参数。
blog_articles视图需要反转最外层捕获的参数,在本例中是page-2/或无参数,而comments可以反转,既不需要参数,也不需要page_number的值。
嵌套捕获的参数在视图参数和URL之间创建了一个强耦合,正如blog_articles所示:视图接收URL的一部分(page-2/),而不是只接收视图想要的值。这种耦合在反转时更加明显,因为要反转视图,我们需要传递URL片段而不是页码。

只捕获视图需要处理的值,并在正则表达式需要参数而视图忽略参数时使用非捕获参数。
版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/weixin_44870139/article/details/105565242

智能推荐

vue引入原生高德地图_前端引入原生地图-程序员宅基地

文章浏览阅读556次,点赞2次,收藏3次。由于工作上的需要,今天捣鼓了半天高德地图。如果定制化开发需求不太高的话,可以用vue-amap,这个我就不多说了,详细就看官网 https://elemefe.github.io/vue-amap/#/zh-cn/introduction/install然而我们公司需要英文版的高德,我看vue-amap中好像没有这方面的配置,而且还有一些其他的定制化开发需求,然后就只用原生的高德。其实原生的引入也不复杂,但是有几个坑要填一下。1. index.html注意,引入的高德js一定要放在头部而_前端引入原生地图

ViewGroup重写大法 (一)-程序员宅基地

文章浏览阅读104次。本文介绍ViewGroup重写,我们所熟知的LinearLayout,RelativeLayout,FrameLayout等等,所有的容器类都是ViewGroup的子类,ViewGroup又继承View。我们在熟练应用这些现成的系统布局的时候可能有时候就不能满足我们自己的需求了,这是我们就要自己重写一个容器来实现效果。ViewGroup重写可以达到各种效果,下面写一个简单的重写一个Vi..._viewgroup 重写

Stm32学习笔记,3万字超详细_stm32笔记-程序员宅基地

文章浏览阅读1.8w次,点赞279次,收藏1.5k次。本文章主要记录本人在学习stm32过程中的笔记,也插入了不少的例程代码,方便到时候CV。绝大多数内容为本人手写,小部分来自stm32官方的中文参考手册以及网上其他文章;代码部分大多来自江科大和正点原子的例程,注释是我自己添加;配图来自江科大/正点原子/中文参考手册。笔记内容都是平时自己一点点添加,不知不觉都已经这么长了。其实每一个标题其实都可以发一篇,但是这样搞太琐碎了,所以还是就这样吧。_stm32笔记

CTS(13)---CTS 测试之Media相关测试failed 小结(一)_mediacodec框架 cts-程序员宅基地

文章浏览阅读1.8k次。Android o CTS 测试之Media相关测试failed 小结(一)CTSCTS 即兼容性测试套件,CTS 在桌面设备上运行,并直接在连接的设备或模拟器上执行测试用例。CTS 是一套单元测试,旨在集成到工程师构建设备的日常工作流程(例如通过连续构建系统)中。其目的是尽早发现不兼容性,并确保软件在整个开发过程中保持兼容性。CTS 是一个自动化测试工具,其中包括两个主要软件组件:CTS tra..._mediacodec框架 cts

chosen.js插件使用,回显,动态添加选项-程序员宅基地

文章浏览阅读4.5k次。官网:https://harvesthq.github.io/chosen/实例化$(".chosen-select").chosen({disable_search_threshold: 10});赋值var optValue = $(".chosen-select").val();回显1.设置回显的值$(".chosen-select").val(“opt1”);2.触发cho..._chosen.js

C++ uint8_t数据串如何按位写入_unit8_t 集合 赋值 c++-程序员宅基地

文章浏览阅读1.9k次。撸码不易,网上找不到,索性自己写,且撸且珍惜!void bitsWrite(uint8_t* buff, int pos, int size, uint32_t value){ uint32_t index[] = { 0x80000000, 0x40000000, 0x20000000, 0x10000000, 0x8000000, 0x4000000, 0x2000000, 0x1000000, 0x800000, 0x400000, 0_unit8_t 集合 赋值 c++

随便推点

Javaweb框架 思维导图_javaweb框架图-程序员宅基地

文章浏览阅读748次。javaweb知识点_javaweb框架图

adb的升级与版本更新_adb iptabls怎么升级-程序员宅基地

文章浏览阅读1.1w次,点赞3次,收藏16次。adb是没有自动升级的命令的,如果想要更新adb的版本,我们可以在网上找到自己想要的版本进行更新给大家提供几个版本https://pan.baidu.com/s/1yd0dsmWn5CK08MlyuubR7g&shfl=shareset 提取码: 94z81、下载解压后我们可以找到下面几个文件,并复制2、找到adb安装的文件夹下的platform-tools文件夹,我这里是..._adb iptabls怎么升级

微信苹果版删除所有的聊天记录的图文教程_mac微信怎么删除聊天列表-程序员宅基地

文章浏览阅读3.8k次。很多用户可能都知道怎么在Windows系统上删除微信的聊天记录,那么苹果电脑上的微信软件怎么删除所有的聊天记录呢?下面小编就专门来给大家讲下微信mac版删除所有的聊天记录的图文教程。点击后会弹出提示窗口,点击这里的确认按钮就可以将其清理掉了。在这里选择要清理的数据,然后点击下方右边的清理按钮就行了。在mac上打开微信后,点击左下角的横线图标。然后再点击这里的管理微信聊天数据按钮。打开了设置窗口,点击上方的“通用”。在这里点击下方的前往清理按钮。点击弹出菜单里的“设置”。_mac微信怎么删除聊天列表

【报错笔记】数据类型转换时报错:Request processing failed;nested exception is java.lang.NumberFormatException:..._request processing failed; nested exception is jav-程序员宅基地

文章浏览阅读7.7k次。数据类型转换时报错:Request processing failed;nested exception is java.lang.NumberFormatException:For input String “20151512345”报错原因:数字格式异常,接着后面有 For input string: “201515612343” 提示,这就告诉我们你当前想把 “201515612343” 转换成数字类型时出错了。解决方案:使用2015151612343这个数字太大了,所以直接使用string_request processing failed; nested exception is java.lang.numberformatexcepti

qml 自定义消息框_Qt qml 自定义消息提示框-程序员宅基地

文章浏览阅读387次。版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。本文链接:https://blog.csdn.net/a844651990/article/details/78376767Qt qml 自定义消息提示框QtQuick有提供比较传统的信息提示框MessageDialog,但是实际开发过程并不太能满足我们的需求。下面是根据controls2模块中..._qml 自定义 messagedialog

Redis.conf 默认出厂内容_默认出厂的原始redis.conf文件全部内容-程序员宅基地

文章浏览阅读599次。# Redis configuration file example.## Note that in order to read the configuration file, Redis must be# started with the file path as first argument:## ./redis-server /path/to/redis.conf # Note on units: when memory size is needed, it is pos._默认出厂的原始redis.conf文件全部内容

推荐文章

热门文章

相关标签