พารามิเตอร์ URL ทางเลือก Django

ฉันมี Django URL เช่นนี้:

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

views.py:

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

ปัญหาคือฉันต้องการให้project_idพารามิเตอร์เป็นตัวเลือก

ฉันต้องการ/project_config/และ/project_config/12345abdce/เป็นรูปแบบ URL ที่ถูกต้องเท่าเทียมกันดังนั้นหาก project_idผ่านไปแล้วฉันสามารถใช้ได้

ในขณะนี้ฉันได้รับ 404 เมื่อฉันเข้าถึง URL โดยไม่มีproject_idพารามิเตอร์

มีหลายวิธี

หนึ่งคือการใช้กลุ่มที่ไม่ได้รับการจับภาพใน regex: การ (?:/(?P<title>[a-zA-Z]+)/)?
สร้างโทเค็น URL Django URL เป็นตัวเลือก

อีกวิธีที่ง่ายกว่าคือการมีกฎหลายข้อที่ตรงกับความต้องการของคุณทั้งหมดชี้ไปที่มุมมองเดียวกัน

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

โปรดทราบว่าในมุมมองของคุณคุณจะต้องตั้งค่าเริ่มต้นสำหรับพารามิเตอร์ URL ที่เป็นตัวเลือกหรือคุณจะได้รับข้อผิดพลาด:

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

คุณสามารถใช้เส้นทางที่ซ้อนกัน

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

นี่คือ DRY ที่มากขึ้น (สมมติว่าคุณต้องการเปลี่ยนชื่อproductkwarg เป็นproduct_idคุณเพียงแค่เปลี่ยนบรรทัดที่ 4 และจะมีผลต่อ URL ด้านล่าง

แก้ไขสำหรับ Django 1.8 ขึ้นไป

ง่ายยิ่งขึ้นคือการใช้:

(?P<project_id>\w+|)

"(a | b)" หมายถึง a หรือ b ดังนั้นในกรณีของคุณมันจะเป็นอักขระคำอย่างน้อยหนึ่งตัว (\ w +) หรือไม่มีอะไรเลย

ดังนั้นมันจะมีลักษณะ:

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

Django> เวอร์ชั่น 2.0 :

วิธีการที่จะเป็นหลักที่เหมือนกันกับคนที่ได้รับในคำตอบ Yuji 'โทมิตะ' Tomita ของ อย่างไรก็ตามได้รับผลกระทบคือไวยากรณ์:

# 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
    ...

ใช้path()คุณยังสามารถส่งผ่านอาร์กิวเมนต์พิเศษเพื่อมุมมองที่มีอาร์กิวเมนต์ตัวเลือกที่เป็นชนิดkwargs dictในกรณีนี้มุมมองของคุณจะไม่ต้องการค่าเริ่มต้นสำหรับแอตทริบิวต์project_id:

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

สำหรับวิธีนี้จะทำในรุ่น Django ล่าสุดดูเอกสารอย่างเป็นทางการเกี่ยวกับ URL เยี่ยงอย่าง

คิดว่าฉันจะเพิ่มคำตอบเล็กน้อย

หากคุณมีคำจำกัดความ URL หลายรายการคุณจะต้องตั้งชื่อให้แยกกัน ดังนั้นคุณจะสูญเสียความยืดหยุ่นเมื่อทำการโทรกลับเนื่องจากการย้อนกลับอันหนึ่งจะคาดหวังว่าพารามิเตอร์ในขณะที่อีกทางหนึ่งจะไม่

อีกวิธีในการใช้ regex เพื่อรองรับพารามิเตอร์ทางเลือก:

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

ใช้งานหรือ ทำงานได้ดีคุณสามารถตรวจสอบpythex อย่าลืมเพิ่มพารามิเตอร์ * args และ ** kwargs ในคำจำกัดความของวิธีการดู

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