Django学习：path语法

Myth丶恋晨 2022-05-27 04:44 139阅读 0赞

Django2.0 文档中，新增了 django.urls.path 函数，它允许使用一种更加简洁、可读的路由语法。比如之前的版本的代码：

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

在新版本中也可以写为：

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

## 一 问题引入 ##

下面是 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 解决以上的两个问题。

## 二 使用示例 ##

这是一个简单的例子：

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），比如使用 <int:name> 捕获一个整数变量。若果没有转化器，将匹配任何字符串，当然也包括了 / 字符。  
无需添加前导斜杠。  
以下是根据   [2.0官方文档][2.0]  而整理的示例分析表：

<table style="border-spacing:0px; margin:20px 0px; width:699px; border:1px solid rgb(221,221,221); font-size:14px; table-layout:fixed; color:rgb(85,85,85); font-family:Lato,'PingFang SC','Microsoft YaHei',sans-serif; text-align:justify; background-color:rgb(255,255,255)"> 
 <thead> 
  <tr> 
   <th style="padding-bottom:10px; vertical-align:middle; border-bottom-width:3px; border-right-color:rgb(238,238,238)"> 请求URL</th> 
   <th style="padding-bottom:10px; vertical-align:middle; border-bottom-width:3px; border-right-color:rgb(238,238,238)"> 匹配项</th> 
   <th style="padding-bottom:10px; vertical-align:middle; border-bottom-width:3px; border-right-color:rgb(238,238,238)"> 视图函数调用形式</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr style="background-color:rgb(249,249,249)"> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">/articles/2005/03/</td> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">第3个</td> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">views.month_archive(request, year=2005, month=3)</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">/articles/2003/</td> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">第1个</td> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">views.special_case_2003(request)</td> 
  </tr> 
  <tr style="background-color:rgb(249,249,249)"> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">/articles/2003</td> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">无</td> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">-</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">/articles/2003/03/building-a-django-site/</td> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">第4个</td> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">views.article_detail(request, year=2003, month=3, slug=”building-a-django-site”)</td> 
  </tr> 
 </tbody> 
</table>

## 三 path转化器 ##

文档原文是Path converters，暂且翻译为转化器。

Django默认支持以下5个转化器：

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

## 四 自定义转化器 ##

### 4.1 定义 ###

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

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

先看看默认的 IntConverter 和 StringConverter 是怎么实现的：

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),
        ...
    ]

## 五 使用正则表达式 ##

如果上述的paths和converters还是无法满足需求，也可以使用正则表达式，这时应当使用 django.urls.re\_path 函数。  
  
在Python正则表达式中，命名式分组语法为 (?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>[^/]+)/', views.article_detail),
    ]

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

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

**无命名分组**  
  
一般来说，不建议使用这种方式，因为有可能引入歧义，甚至错误。

## 六 Import变动 ##

django.urls.path 可以看成是 django.conf.urls.url 的增强形式。  
  
为了方便，其引用路径也有所变化，请注意下 urls 包路径的变更，不再是 conf 的子包了，目前和 views 、conf 一样，被认为是 Django 的核心组件。

<table style="border-spacing:0px; margin:20px 0px; width:699px; border:1px solid rgb(221,221,221); font-size:14px; table-layout:fixed; color:rgb(85,85,85); font-family:Lato,'PingFang SC','Microsoft YaHei',sans-serif; text-align:justify; background-color:rgb(255,255,255)"> 
 <thead> 
  <tr> 
   <th style="padding-bottom:10px; vertical-align:middle; border-bottom-width:3px; border-right-color:rgb(238,238,238)"> 1.X</th> 
   <th style="padding-bottom:10px; vertical-align:middle; border-bottom-width:3px; border-right-color:rgb(238,238,238)"> 2.0</th> 
   <th style="padding-bottom:10px; vertical-align:middle; border-bottom-width:3px; border-right-color:rgb(238,238,238)"> 备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr style="background-color:rgb(245,245,245)"> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">-</td> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">django.urls.path</td> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">新增，url的增强版</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">django.conf.urls.include</td> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">django.urls.include</td> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">路径变更</td> 
  </tr> 
  <tr style="background-color:rgb(249,249,249)"> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">django.conf.urls.url</td> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">django.urls.re_path</td> 
   <td style="vertical-align:middle; border-right-color:rgb(238,238,238)">异名同功能，url不会立即废弃</td> 
  </tr> 
 </tbody> 
</table>

## 七 代码改写 ##

将“问题引入”一节的代码使用新的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),
    ]

八 总结

第一，目前 路由（url）到视图（View）的流程可以概括为四个步骤：

url匹配
    正则捕获
    变量类型转化
    视图调用

Django2.0 和之前相比多了 变量类型转化 这一步骤。  
  
第二，新的path语法可以解决一下以下几个场景：

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

转自：[django2笔记:路由path语法][django2_path]

[2.0]: https://docs.djangoproject.com/en/2.0/topics/http/urls/#example
[django2_path]: https://kinegratii.github.io/2017/09/25/django2-url-path/