Необов’язкові параметри 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параметра.

Є кілька підходів.

Перший - використовувати групу, яка не захоплює, в регулярному вираженні: (?:/(?P<title>[a-zA-Z]+)/)?
Зробити токеном URL-адреси Django Regex необов'язково

Ще один, простіший спосіб - це мати кілька правил, які відповідають вашим потребам, і всі вони вказують на один і той же погляд.

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

Можна використовувати вкладені маршрути

Джанго <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")
        ))),
    ))),
)

Джанго> = 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")
        ])),
    ])),
]

Це набагато більше СУХОГО (скажімо, ви хочете перейменувати 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 :

Підхід по суті ідентичний тому, який подано у відповіді Томіти Юджі "Томіта" . Однак на це впливає синтаксис:

# 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-адрес, вам доведеться назвати кожне з них окремо. Таким чином, ви втрачаєте гнучкість при виклику зворотного зв'язку, оскільки один зворотний очікує параметр, а інший не буде.

Ще один спосіб використання регулярного вираження для розміщення необов'язкового параметра:

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

Джанго = 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')