Opcjonalne parametry adresu URL w Django

Mam taki adres URL Django:

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

Problem w tym, że chcę, aby project_idparametr był opcjonalny.

Chcę /project_config/i /project_config/12345abdce/być równie ważne wzorców URL, tak, że jeśli project_id zostanie przyjęta, wtedy mogę go używać.

W tej chwili otrzymuję kod 404, gdy uzyskuję dostęp do adresu URL bez project_idparametru.

Istnieje kilka podejść.

Jednym z nich jest użycie nieprzechwytywanej grupy w wyrażeniu regularnym: (?:/(?P<title>[a-zA-Z]+)/)?
Ustalenie opcjonalnego tokenu adresu URL Regex Django

Innym, łatwiejszym do naśladowania sposobem jest posiadanie wielu reguł, które odpowiadają Twoim potrzebom, a wszystkie wskazują ten sam widok.

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

Pamiętaj, że w swoim widoku musisz również ustawić wartość domyślną dla opcjonalnego parametru adresu URL, w przeciwnym razie pojawi się błąd:

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

Możesz używać zagnieżdżonych tras

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

Jest to o wiele bardziej SUCHE (powiedzmy, że chcesz zmienić nazwę productkwarg na product_id, wystarczy zmienić wiersz 4, a wpłynie to na poniższe adresy URL.

Edytowane dla Django 1.8 i nowszych

Jeszcze prostsze jest użycie:

(?P<project_id>\w+|)

„(A | b)” oznacza a lub b, więc w twoim przypadku byłby to jeden lub więcej znaków wyrazu (\ w +) lub nic.

Więc wyglądałoby to tak:

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

Wersja Django> 2.0 :

Podejście jest zasadniczo identyczne z podejściem podanym w odpowiedzi Yuji „Tomita” Tomita . Problem dotyczy jednak składni:

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

Za pomocą path() można również przekazać dodatkowe argumenty do widoku z opcjonalnym argumentem kwargstypu dict. W tym przypadku widok nie potrzebuje wartości domyślnej dla atrybutu project_id:

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

Aby dowiedzieć się, jak to się robi w najnowszej wersji Django , zobacz oficjalną dokumentację dotyczącą wysyłania adresów URL .

Pomyślałem, że dodam trochę do odpowiedzi.

Jeśli masz wiele definicji adresów URL, musisz nadać im nazwy osobno. Więc tracisz elastyczność podczas wywoływania reverse, ponieważ jeden reverse będzie oczekiwał parametru, a drugi nie.

Inny sposób użycia wyrażenia regularnego w celu dostosowania opcjonalnego parametru:

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

Posługiwać się ? działa dobrze można sprawdzić na pythex . Pamiętaj, aby dodać parametry * args i ** kwargs w definicji metod widoku

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