Django 2.0:路径转换器(Path converter)的用法

Django2.0于2017年12月2日已经正式发布。Django2.0支持Python3.4,3.5以及3.6,移除了对Python2.7的支持。官方强烈建议Python 3.x使用最新的版本。

在Django2.0其中一个新特性为:简化Url路由的语法

在代码上主要体现在新增了django.urls.path函数,它带来了更简洁、更可读的路由语法,如:

原来的url

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

Django2.0新语法

path('articles/<int:year>/', views.year_archive),

新语法支持url参数的类型转化。例子里的year_archive函数接收到的year参数作为参数,并且会自动转换year为整型而不是字符串。

在Django1.x里,我们需要对year做类型转换:

def year_archive(request, year):
    year = int(year)

URL参数捕获

在新的语法里,url字符串有以下规则:

  1. 在url里使用尖括号“<>”来捕获值
  2. 尖括号捕获值的格式<converter:name>。其中converter为路径转换器,name为参数名,如<int:year>。对于捕获的值没有路径转换器,那么它会匹配除了斜杠"/"外的所有字符作为捕获的值。
  3. url不需要以斜杠开头。

代码示例

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/:匹配到第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”)

Path Converter

url里捕获的值使用Path Converter来对值做转换,如类型转换。Django2.0自带了默人的Path Converter,同时也支持自定义Path Conveter。

默认Path converter

Django2.0自带的PathConveter包括:

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

注册自定义Path Converter

当默认的Path Converter不能满足需求时,Django2.0支持用户注册自定义的Path Converter。

Path Converter是一个类,定义Converter类需要包含下面的属性或方法:

  • regex属性,字符串类型
  • to_python(self, value) 方法,它处理将匹配的字符串转换为应该传递给view函数的类型。 如果它不能转换给定的值,它应该抛出ValueError。
  • to_url(self, value) 方法,和 to_python 相反,它会将Python类型转换为在URL中使用的字符串。

示例

定义Path Converter

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

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

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

使用register_converter()注册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),
    ...
]

正则表达式匹配

Django2.0也支持我们使用正则表达式来捕获值。注意,用正则表达式捕获值,需要使用re_path(),而不是前面介绍的path()。

正则表达式建议使用命名正则表达式组,语法如下:

(?P<name>pattern)

其中,尖括号里的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>[\w-_]+)/', views.article_detail),
]

与前面的示例不同点:

  • 这里的代码匹配更加严格,比如year为10000就无法匹配,因为它超出了正则规定的4位数
  • 传给view函数的参数为字符串类型,这点和 Django使用url 是一样的。

设置默认值

在path里支持对view设置默认值。


from django.urls import path

from . import views

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

# View (in blog/views.py)
def page(request, num=1):
    # Output the appropriate page of blog entries, according to num.
    ...

page函数num的默认值设置为1.

版权声明:著作权归作者所有。

相关推荐

Rxjs expand的用法分析

Rxjs的expand()函数声明:public expand(project: function(value: T, index: number), concurrent: number, scheduler: Scheduler): Observable expand()会递归调用project函数,project函数把源值映射为一个Observable,每次递归

[译]了解AttnGAN:文字到图像转换器

文字到图像的转换一直令我着迷,最近的AttnGAN论文引起了我的注意。 在这篇文章中,我会试着提供一个直观的说明,希望让你好奇,进一步挖掘:-)。在我们开始实际模型之前,有一些先决条件:1、注意力为了避免重蹈覆辙(并推广我自己的课程),请看我以前的帖子,我在这里提供了一个关于“深度学习中的注意力”的小介绍。2、生成式对抗网络简单地说,一个GAN是两个网络的组合:一个生成器(从噪声中产生有

[译]了解AttnGAN:文字到图像转换器

文字到图像的转换一直令我着迷,最近的AttnGAN论文引起了我的注意。 在这篇文章中,我会试着提供一个直观的说明,希望让你好奇,进一步挖掘:-)。在我们开始实际模型之前,有一些先决条件:1、注意力为了避免重蹈覆辙(并推广我自己的课程),请看我以前的帖子,我在这里提供了一个关于“深度学习中的注意力”的小介绍。2、生成式对抗网络简单地说,一个GAN是两个网络的组合:一个生成器(从噪声中产生有

代码编辑器monaco-editor用法入门

monaco editor是微软开源的一款web版代码编辑器。它支持智能提示,代码高亮,代码格式化。这里简单介绍下它的用法。1、下载安装monaco-editornpm install monaco-editor 下载后,安装目录为node_modules/monaco-editor/。2、添加loader.js脚本到页面在集成monaco-editor的页面,添加&

Spring发送邮件模块的用法

环境准备Spring的邮件模块底层依赖于JavaMail,它主要目的是为应用提供一个便捷有用的发邮件工具包。邮件模块的代码在spring-context-support的jar包里,所在的package为org.springframework.mail。Maven的pom.xm需要添加javax.mail jar包的依赖<dependency>   &nb