Paramètres d'URL facultatifs de Django

J'ai une URL Django comme celle-ci:

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

Le problème est que je veux que le project_idparamètre soit facultatif.

Je veux /project_config/et /project_config/12345abdce/être des modèles d'URL aussi valides, de sorte que si project_id est passé, alors je peux l' utiliser.

Dans l'état actuel des choses, j'obtiens un 404 lorsque j'accède à l'URL sans le project_idparamètre.

Il existe plusieurs approches.

La première consiste à utiliser un groupe non capturant dans l'expression régulière: (?:/(?P<title>[a-zA-Z]+)/)?
Rendre un jeton d'URL Django Regex facultatif

Un autre moyen plus simple à suivre consiste à avoir plusieurs règles qui correspondent à vos besoins, toutes pointant vers la même vue.

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

Gardez à l'esprit que dans votre vue, vous devrez également définir une valeur par défaut pour le paramètre d'URL facultatif, sinon vous obtiendrez une erreur:

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

Vous pouvez utiliser des itinéraires imbriqués

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

C'est beaucoup plus DRY ( productdisons que vous vouliez renommer le kwarg en product_id, il vous suffit de changer la ligne 4, et cela affectera les URL ci-dessous.

Édité pour Django 1.8 et supérieur

Encore plus simple est d'utiliser:

(?P<project_id>\w+|)

Le "(a | b)" signifie a ou b, donc dans votre cas ce serait un ou plusieurs caractères de mot (\ w +) ou rien.

Cela ressemblerait donc à:

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

Django> version 2.0 :

L'approche est essentiellement identique à celle donnée dans la réponse de Yuji 'Tomita' Tomita . La syntaxe est cependant affectée:

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

En utilisant, path()vous pouvez également passer des arguments supplémentaires à une vue avec l'argument facultatif kwargsde type dict. Dans ce cas, votre vue n'aurait pas besoin d'une valeur par défaut pour l'attribut project_id:

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

Pour savoir comment cela se fait dans la version la plus récente de Django , consultez la documentation officielle sur la répartition des URL .

J'ai pensé que j'ajouterais un peu à la réponse.

Si vous avez plusieurs définitions d'URL, vous devrez nommer chacune d'elles séparément. Ainsi, vous perdez la flexibilité lors de l'appel inverse car un inverse attendra un paramètre tandis que l'autre ne le fera pas.

Une autre façon d'utiliser regex pour accueillir le paramètre facultatif:

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

Utilisation ? fonctionne bien, vous pouvez vérifier sur pythex . N'oubliez pas d'ajouter les paramètres * args et ** kwargs dans la définition des méthodes de vue

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