Parametri url opzionali di Django

Ho un URL Django come questo:

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

Il problema è che voglio che il project_idparametro sia facoltativo.

Voglio /project_config/e /project_config/12345abdce/essere ugualmente validi pattern URL, in modo che se project_id viene passato, allora posso usarlo.

Allo stato attuale, ottengo un 404 quando accedo all'URL senza il project_idparametro.

Esistono diversi approcci.

Uno è quello di utilizzare un gruppo non di acquisizione nella regex: (?:/(?P<title>[a-zA-Z]+)/)?
rendere facoltativo un token URL Regex Django

Un altro modo più semplice da seguire è avere più regole che soddisfino le tue esigenze, tutte puntando alla stessa vista.

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

Tieni presente che a tuo avviso dovrai anche impostare un valore predefinito per il parametro URL facoltativo, altrimenti visualizzerai un errore:

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

È possibile utilizzare percorsi nidificati

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

Questo è molto più ASCIUTTO ( productsupponiamo che tu voglia rinominare il kwarg in product_id, devi solo cambiare la linea 4 e influenzerà gli URL sotto.

A cura di Django 1.8 e versioni successive

Ancora più semplice è usare:

(?P<project_id>\w+|)

"(A | b)" significa a o b, quindi nel tuo caso sarebbe uno o più caratteri di parole (\ w +) o niente.

Quindi sembrerebbe:

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

Django> versione 2.0 :

L'approccio è essenzialmente identico a quello indicato nella risposta di Tomji "Tomita" di Yuji . Interessato, tuttavia, è la sintassi:

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

Usando path()puoi anche passare argomenti extra a una vista con l'argomento opzionale kwargsche è di tipo dict. In questo caso la tua vista non avrebbe bisogno di un valore predefinito per l'attributo project_id:

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

Per come eseguire questa operazione nella versione Django più recente , consulta i documenti ufficiali sulla distribuzione degli URL .

Ho pensato di aggiungere un po 'alla risposta.

Se hai più definizioni URL, dovrai nominarle ognuna separatamente. Quindi si perde la flessibilità quando si chiama reverse poiché un reverse si aspetta un parametro mentre l'altro no.

Un altro modo di usare regex per accogliere il parametro opzionale:

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

Uso ? funziona bene, puoi controllare su pythex . Ricorda di aggiungere i parametri * args e ** kwargs nella definizione dei metodi di visualizzazione

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