Django 可选的 url 参数

Question

我有一个像这样的 Django URL：

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

视图.py：

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

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

我想/project_config/和/project_config/12345abdce/是同样有效的网址格式，因此，如果project_id通过，那么我就可以使用它。

目前，当我访问没有project_id参数的 URL 时，我得到 404。

Answer 1

有几种方法。

一种是在正则表达式中使用非捕获组： (?:/(?P<title>[a-zA-Z]+)/)?
使正则表达式 Django URL 令牌可选

另一种更容易遵循的方法是拥有多个符合您需求的规则，所有规则都指向同一个视图。

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

Answer 2

您可以使用嵌套路由

姜戈 <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")
        ))),
    ))),
)

姜戈 >=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 及以上版本编辑

Answer 3

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()您还可以将额外的参数传递给带有dict类型的可选参数kwargs 的视图。 在这种情况下，您的视图不需要属性project_id的默认值：

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

有关如何在最新的 Django 版本中完成此操作，请参阅有关 URL 调度的官方文档。

Answer 4

更简单的是使用：

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

Answer 5

以为我会在答案中添加一点。

如果您有多个 URL 定义，则必须分别命名它们。 因此，您在调用 reverse 时失去了灵活性，因为一个反向需要一个参数，而另一个则不需要。

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

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

Answer 6

姜戈 = 2.2

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

Answer 7

用 ？ 运行良好，您可以检查pythex 。 记得在视图方法的定义中添加参数 *args 和 **kwargs

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