Django可选的url参数

问题描述 投票:140回答:6

我有一个像这样的Django URL:

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

views.朋友:

def ProjectConfig(request, product, project_id=None, template_name='project.html'):
    ...
    # do stuff

问题是我希望project_id参数是可选的。

我希望/project_config//project_config/12345abdce/是同样有效的URL模式,所以如果project_id通过,那么我可以使用它。

就目前而言,当我访问没有project_id参数的URL时,我得到404。

python django django-views django-urls
6个回答
337
投票

有几种方法。

一种是在正则表达式中使用非捕获组:(?:/(?P<title>[a-zA-Z]+)/)? Making a Regex Django URL Token Optional

另一种更容易理解的方法是使多个规则符合您的需求,所有规则都指向同一个视图。

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

36
投票

您可以使用嵌套路由

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

这是更多DRY(假设您想将product kwarg重命名为product_id,您只需更改第4行,它将影响以下URL。

编辑Django 1.8及以上版本


23
投票

更简单的是使用:

(?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'
),

9
投票

以为我会在答案中添加一些内容。

如果您有多个URL定义,那么您必须分别为每个URL定义。因此,在调用reverse时会失去灵活性,因为一个反向将期望一个参数而另一个反之则不会。

使用正则表达式来容纳可选参数的另一种方法:

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

7
投票

Django> 2.0版本:

该方法基本上与Yuji 'Tomita' Tomita's Answer中给出的方法相同。但是,受影响的是语法:

# 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你也可以用pass extra arguments to a view作为可选参数dict。在这种情况下,您的视图不需要属性project_id的默认值:

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

有关如何在最新的Django版本中完成此操作,请参阅the official docs about URL dispatching


1
投票

Django = 2.2

urlpatterns = [
    re_path(r'^project_config/(?:(?P<product>\w+)/(?:(?P<project_id>\w+)/)/)?$', tool.views.ProjectConfig, name='project_config')
]
© www.soinside.com 2019 - 2024. All rights reserved.