Skip to content

Latest commit

 

History

History
172 lines (154 loc) · 5.11 KB

urls.md

File metadata and controls

172 lines (154 loc) · 5.11 KB

URL dispatcher

目录

URL dispatcher 官网
url 工具
URLconfs里用的函数

How Django processes a request

  1. 查看ROOT_URLCONF 一般是project/urls.py, 有时候某些middle会设置ROOT_URLCONF
  2. 载入ROOT_URLCONF包，寻找urlpatterns变量。如果一个urlpatterns没找到，会去下一个app找。所以两个app可以使用同一个路径
project.urls:
    url(r'testapp/', include('testapp.urls_v1', namespace="testapp_namespace")),     
    url(r'testapp/', include('testapp.urls_v2', namespace="testapp_namespace_v2")),
urls_v1:
    path('testint/<slug:pk>/', views.TestPathView.as_view(), name="testint"),
urls_v2:
    path('testint/<int:pk>/', views.TestPathView2.as_view(), name="testslug"),
  1. 没找到就报错

Example

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

Path converters

  • str: 匹配字符串，除了/
  • int: 匹配0或者任何正整数
  • slug: 字符和数字hyphen, underscore
  • uuid
  • path: 非空字符串，包括/

Registering custom path converters

Using regular expressions

官网 使用正则匹配的路径，不管匹配到的结果是什么样的，返回的都是字符串，请务必注意

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

Including other URLconfs

当django遇到include的时候，它会把当前匹配的url切换，然后把剩下的路径放入include去匹配

from django.urls import include, path

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

当然这个include也可以直接是一个列表传进去。

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

这一点在重复利用一个重复的pattern prefix时很有用。比如

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),
    ])),
]
  • 获取参数 included URLonf 会从 parent URLconfs 里面获取参数并传入view
# 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),
]

Passing extra options to view functions 传递额外的变量

urlpatterns = [ path('blog/<int:year>/', views.year_archive, {'foo': 'bar'}), ]
如果访问 blog/2015/ django就会调用 views.year_archive(request, year=2015, foo="bar")

如果这个变量和url里面的变量名一致,django要优先使用字典里的变量,而不是url里面的变量

url工具

官网

  • reverse
from django.urls import reverse
>>> reverse('reqres:ajax')
/reqres/ajax/
>>> reverse('request:ajax-detail', args=[1])
/reqres/ajax/1/
>>> reverse('request:ajax', kwargs={'pk': 1})
/reqres/ajax/1/
  • reverse_lazy

resolve

解析一个url, 返回ResolverMatch对象， request.resolver_match返回的也是这个对象

resolve_match = resolve(url)
resolve_match.name_space

* [ ] urlparse
* [ ] urlunparse
  • ResolverMatch
    • app_name
    • url_name

其他

  • get_script_prefix

TODO

  • Error handling
  • Registering custom path converters
  • What the URLconf searches agains