Django optionale URL-Parameter

Ich habe eine Django-URL wie diese:

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

Das Problem ist, dass der project_idParameter optional sein soll.

Ich will /project_config/und /project_config/12345abdce/gleichermaßen gültiges URL - Muster sein, so dass , wenn project_id übergeben wird, dann kann ich es verwenden.

Im Moment bekomme ich eine 404, wenn ich ohne den project_idParameter auf die URL zugreife .

Es gibt verschiedene Ansätze.

Eine Möglichkeit besteht darin, eine nicht erfassende Gruppe in der Regex zu verwenden: (?:/(?P<title>[a-zA-Z]+)/)?
Erstellen eines Regex-Django-URL-Tokens Optional

Eine andere, einfacher zu befolgende Methode besteht darin, mehrere Regeln zu haben, die Ihren Anforderungen entsprechen und alle auf dieselbe Ansicht verweisen.

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

Beachten Sie, dass Sie in Ihrer Ansicht auch einen Standard für den optionalen URL-Parameter festlegen müssen, da sonst eine Fehlermeldung angezeigt wird:

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

Sie können verschachtelte Routen verwenden

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

Dies ist viel trockener ( productAngenommen product_id, Sie wollten das kwarg umbenennen in , Sie müssen nur Zeile 4 ändern, und dies wirkt sich auf die folgenden URLs aus.

Bearbeitet für Django 1.8 und höher

Noch einfacher zu bedienen ist:

(?P<project_id>\w+|)

Das "(a | b)" bedeutet a oder b, in Ihrem Fall also ein oder mehrere Wortzeichen (\ w +) oder nichts.

So würde es aussehen:

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

Django> 2.0 Version :

Der Ansatz ist im Wesentlichen identisch mit dem in Yuji 'Tomita' Tomitas Antwort angegebenen . Betroffen ist jedoch die Syntax:

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

Mit können path()Sie auch zusätzliche Argumente an eine Ansicht mit dem optionalen Argument kwargsvom Typ übergeben dict. In diesem Fall würde Ihre Ansicht keine Standardeinstellung für das Attribut benötigen project_id:

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

Wie dies in der neuesten Django-Version gemacht wird , finden Sie in den offiziellen Dokumenten zum URL-Versand .

Ich dachte, ich würde der Antwort etwas hinzufügen.

Wenn Sie mehrere URL-Definitionen haben, müssen Sie jede einzeln benennen. Sie verlieren also die Flexibilität, wenn Sie reverse aufrufen, da ein Reverse einen Parameter erwartet, der andere nicht.

Eine andere Möglichkeit, Regex zu verwenden, um den optionalen Parameter aufzunehmen:

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

Verwenden ? gut funktionieren, können Sie auf Pythex überprüfen . Denken Sie daran, die Parameter * args und ** kwargs in die Definition der Ansichtsmethoden aufzunehmen

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