Thông số url tùy chọn Django

Tôi có một URL Django như thế này:

url(
    r'^project_config/(?P<product>\w+)/(?P<project_id>\w+)/$',
    'tool.views.ProjectConfig',
    name='project_config'
),

lượt xem:

def ProjectConfig(request, product, project_id=None, template_name='project.html'):
    ...
    # do stuff

Vấn đề là tôi muốn project_idtham số là tùy chọn.

Tôi muốn /project_config/và /project_config/12345abdce/là các mẫu URL hợp lệ như nhau, để nếu project_id được thông qua, thì tôi có thể sử dụng nó.

Hiện tại, tôi nhận được 404 khi tôi truy cập URL mà không có project_idtham số.

Có một số cách tiếp cận.

Một là sử dụng nhóm không bắt trong regex: (?:/(?P<title>[a-zA-Z]+)/)?
Tạo mã thông báo URL Regex Django tùy chọn

Một cách khác, dễ thực hiện hơn là có nhiều quy tắc phù hợp với nhu cầu của bạn, tất cả đều hướng đến cùng một chế độ xem.

urlpatterns = patterns('',
    url(r'^project_config/$', views.foo),
    url(r'^project_config/(?P<product>\w+)/$', views.foo),
    url(r'^project_config/(?P<product>\w+)/(?P<project_id>\w+)/$', views.foo),
)

Hãy nhớ rằng trong chế độ xem của bạn, bạn cũng cần đặt mặc định cho tham số URL tùy chọn hoặc bạn sẽ gặp lỗi:

def foo(request, optional_parameter=''):
    # Your code goes here

Bạn có thể sử dụng các tuyến đường lồng nhau

Django <1,8

urlpatterns = patterns(''
    url(r'^project_config/', include(patterns('',
        url(r'^$', ProjectConfigView.as_view(), name="project_config")
        url(r'^(?P<product>\w+)$', include(patterns('',
            url(r'^$', ProductView.as_view(), name="product"),
            url(r'^(?P<project_id>\w+)$', ProjectDetailView.as_view(), name="project_detail")
        ))),
    ))),
)

Django> = 1,8

urlpatterns = [
    url(r'^project_config/', include([
        url(r'^$', ProjectConfigView.as_view(), name="project_config")
        url(r'^(?P<product>\w+)$', include([
            url(r'^$', ProductView.as_view(), name="product"),
            url(r'^(?P<project_id>\w+)$', ProjectDetailView.as_view(), name="project_detail")
        ])),
    ])),
]

Đây là DRY nhiều hơn rất nhiều (Giả sử bạn muốn đổi tên productkwarg thành product_id, bạn chỉ phải thay đổi dòng 4 và nó sẽ ảnh hưởng đến các URL bên dưới.

Đã chỉnh sửa cho Django 1.8 trở lên

Thậm chí đơn giản hơn là sử dụng:

(?P<project_id>\w+|)

"(A | b)" có nghĩa là a hoặc b, vì vậy trong trường hợp của bạn, nó sẽ là một hoặc nhiều ký tự từ (\ w +) hoặc không có gì.

Vì vậy, nó sẽ trông như:

url(
    r'^project_config/(?P<product>\w+)/(?P<project_id>\w+|)/$',
    'tool.views.ProjectConfig',
    name='project_config'
),

Phiên bản Django> 2.0 :

Cách tiếp cận về cơ bản là giống hệt với phương pháp được đưa ra trong câu trả lời của Yuji 'Tomita' Tomita . Tuy nhiên, bị ảnh hưởng là cú pháp:

# URLconf
...

urlpatterns = [
    path(
        'project_config/<product>/',
        views.get_product, 
        name='project_config'
    ),
    path(
        'project_config/<product>/<project_id>/',
        views.get_product,
        name='project_config'
    ),
]


# View (in views.py)
def get_product(request, product, project_id='None'):
    # Output the appropriate product
    ...

Sử dụng path()bạn cũng có thể chuyển các đối số bổ sung cho chế độ xem với đối số tùy chọn kwargslà loại dict. Trong trường hợp này, chế độ xem của bạn sẽ không cần mặc định cho thuộc tính project_id:

    ...
    path(
        'project_config/<product>/',
        views.get_product,
        kwargs={'project_id': None},
        name='project_config'
    ),
    ...

Để biết cách thực hiện trong phiên bản Django gần đây nhất , hãy xem các tài liệu chính thức về việc gửi URL .

Nghĩ rằng tôi sẽ thêm một chút vào câu trả lời.

Nếu bạn có nhiều định nghĩa URL thì bạn sẽ phải đặt tên riêng cho từng định nghĩa. Vì vậy, bạn mất tính linh hoạt khi gọi ngược lại vì một đảo ngược sẽ mong đợi một tham số trong khi cái kia sẽ không.

Một cách khác để sử dụng regex để chứa tham số tùy chọn:

r'^project_config/(?P<product>\w+)/((?P<project_id>\w+)/)?$'

Django = 2.2

urlpatterns = [
    re_path(r'^project_config/(?:(?P<product>\w+)/(?:(?P<project_id>\w+)/)/)?$', tool.views.ProjectConfig, name='project_config')
]

Sử dụng ? hoạt động tốt, bạn có thể kiểm tra trên pythex . Hãy nhớ thêm các tham số * args và ** kwargs trong định nghĩa của các phương thức xem

url('project_config/(?P<product>\w+)?(/(?P<project_id>\w+/)?)?', tool.views.ProjectConfig, name='project_config')