欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

django2:路由path语法

程序员文章站 2022-07-07 19:07:23
[TOC] " " 9月23, "Django" 发布了2.0a1版本,这是一个 feature freeze 版本,如果没有什么意外的话,2.0正式版不会再增加新的功能了。按照以往的规律,预计正式版将在12月发布。 备注:Django 2.0 于12月2日已经正式发布。 ( "链接" ) 2.0无 ......

9月23,django 发布了2.0a1版本,这是一个 feature freeze 版本,如果没有什么意外的话,2.0正式版不会再增加新的功能了。按照以往的规律,预计正式版将在12月发布。

备注:django 2.0 于12月2日已经正式发布。 ()

2.0无疑是一个里程碑版本,移除了对 python2.7 的支持,最少需要 3.4 以上,建议使用3.5以上的版本。

what’s new in django2.0 文档中一共列出了三个新的特性:

  • 更简单的url路由语法 (simplified url routing syntax)
  • admin应用的针对移动设备的优化改进(mobile-friendly contrib.admin)
  • 支持sql开窗表达式(window expressions)

第一个特性,主要用于动态路由定义上。在django2.0代码实现中,主要的变化是新增了 django.urls.path 函数,它允许使用一种更加简洁、可读的路由语法。比如之前的版本的代码:

url(r'^articles/(?p[0-9]{4})/$', views.year_archive),

在新版本中也可以写为:

path('articles//', views.year_archive),

新语法支持类型转化,在上述的例子中, year_archive 函数接收到的year参数就变成整数而不是字符串。

如果你有接触过 flask 框架,就会发现和 variable-rules 的语法形式和功能都是相类似的。

1.问题引入

下面是 django1.x 的一段代码:

from django.conf.urls import url

def year_archive(request, year):
    year = int(year) # convert str to int
    # get articles from database

def detail_view(request, article_id):
    pass

def edit_view(request, article_id):
    pass

def delete_view(request, article_id):
    pass

urlpatterns = [
    url('articles/(?p<year>[0-9]{4})/', year_archive),
    url('article/(?p<article_id>[a-za-z0-9]+)/detail/', detail_view),
    url('articles/(?p<article_id>[a-za-z0-9]+)/edit/', edit_view),
    url('articles/(?p<article_id>[a-za-z0-9]+)/delete/', delete_view),
]

考虑下这样的两个问题:

第一个问题,函数 year_archive 中year参数是字符串类型的,因此需要先转化为整数类型的变量值,当然 year=int(year) 不会有诸如如typeerror或者valueerror的异常。那么有没有一种方法,在url中,使得这一转化步骤可以由django自动完成?

第二个问题,三个路由中 article_id 在业务中表示同一个字段,使用同样的正则表达式,但是你需要写三遍,当之后 article_id 规则改变后,需要同时修改三处代码,那么有没有一种方法,只需修改一处即可?

在 django2.0 中,可以使用 path 解决以上的两个问题。

2.使用示例

这是一个简单的例子:

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>/', views.article_detail),
]

基本规则:

  • 使用尖括号(<>)从url中捕获值。
  • 捕获值中可以包含一个转化器类型(converter type),比如使用 `捕获一个整数变量。若果没有转化器,将匹配任何字符串,当然也包括了/` 字符。
  • 无需添加前导斜杠。

以下是根据 而整理的示例分析表:

请求url 匹配项 视图函数调用形式
/articles/2005/03/ 第3个 views.month_archive(request, year=2005, month=3)
/articles/2003/ 第1个 views.special_case_2003(request)
/articles/2003 -
/articles/2003/03/building-a-django-site/ 第4个 views.article_detail(request, year=2003, month=3, slug=”building-a-django-site”)

3.path转化器

文档原文是path converters,暂且翻译为转化器。

django默认支持以下5个转化器:

  • str,匹配除了路径分隔符(/)之外的非空字符串,这是默认的形式
  • int,匹配正整数,包含0。
  • slug,匹配字母、数字以及横杠、下划线组成的字符串。
  • uuid,匹配格式化的uuid,如 075194d3-6885-417e-a8a8-6c931e272f00。
  • path,匹配任何非空字符串,包含了路径分隔符

4.自定义转化器

4.1 定义

对于一些复杂或者复用的需要,可以定义自己的转化器。转化器是一个类或接口,它的要求有三点:

  • regex 类属性,字符串类型
  • to_python(self, value) 方法,value是由类属性 regex 所匹配到的字符串,返回具体的python变量值,以供django传递到对应的视图函数中。
  • to_url(self, value) 方法,和 to_python 相反,value是一个具体的python变量值,返回其字符串,通常用于url反向引用。

先看看默认的 intconverterstringconverter 是怎么实现的:

class intconverter:
    regex = '[0-9]+'

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

    def to_url(self, value):
        return str(value)


class stringconverter:
    regex = '[^/]+'

    def to_python(self, value):
        return value

    def to_url(self, value):
        return value

第二个例子,是自己实现的4位年份的转化器。

class fourdigityearconverter:
    regex = '[0-9]{4}'

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

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

4.2 注册

使用register_converter 将其注册到url配置中:

from django.urls import register_converter, path

from . import converters, views

register_converter(converters.fourdigityearconverter, 'yyyy')

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

5.使用正则表达式

如果上述的paths和converters还是无法满足需求,也可以使用正则表达式,这时应当使用 django.urls.re_path函数。

在python正则表达式中,命名式分组语法为 (?ppattern) ,其中name为名称, pattern为待匹配的模式。

之前的示例代码也可以写为:

from django.urls import path, re_path

from . import views

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

这段代码和之前的代码实现了基本的功能,但是还是有一些区别:

  • 这里的代码匹配更加严格,比如year=10000在这里就无法匹配。
  • 传递给视图函数的变量都是字符串类型,这点和 url 是一致的。

无命名分组

一般来说,不建议使用这种方式,因为有可能引入歧义,甚至错误。

6.import变动

django.urls.path 可以看成是 django.conf.urls.url 的增强形式。

为了方便,其引用路径也有所变化,请注意下 urls 包路径的变更,不再是 conf 的子包了,目前和 viewsconf 一样,被认为是 django 的核心组件。

1.x 2.0 备注
- django.urls.path 新增,url的增强版
django.conf.urls.include django.urls.include 路径变更
django.conf.urls.url django.urls.re_path 异名同功能,url不会立即废弃

7.代码改写

将“问题引入”一节的代码使用新的path函数可以改写如下:

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

class fourdigityearconverter:
    regex = '[0-9]{4}'

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

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

register_converter(slugconverter, 'article_id')
register_converter(fourdigityearconverter, 'year')

def year_archive(request, year):
    print(type(year)) # <class 'int'>
    # get articles from database

def detail_view(request, article_id):
    pass

def edit_view(request, article_id):
    pass

def delete_view(request, article_id):
    pass

urlpatterns = [
    path('articles/<year:year>/', year_archive),
    path('article/<article_id:article_id>/detail/', detail_view),
    path('articles/<article_id:article_id>/edit/', edit_view),
    path('articles/<article_id:article_id>/delete/', delete_view),
]

8.总结

第一,目前 路由(url)到视图(view)的流程可以概括为四个步骤:

  1. url匹配
  2. 正则捕获
  3. 变量类型转化
  4. 视图调用

django2.0 和之前相比多了 变量类型转化 这一步骤。

第二,新的path语法可以解决一下以下几个场景:

  • 类型自动转化
  • 公用正则表达式