Parâmetros de URL Opcionais do Django

Eu tenho uma URL do Django assim:

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

O problema é que eu quero que o project_idparâmetro seja opcional.

Eu quero /project_config/e /project_config/12345abdce/ser padrões de URL igualmente válidas, de modo que , se project_id for aprovada, então eu posso usá-lo.

Como está no momento, recebo um 404 quando acesso o URL sem o project_idparâmetro

Existem várias abordagens.

Uma é usar um grupo que não captura no regex: (?:/(?P<title>[a-zA-Z]+)/)?
Tornando opcional um token de URL do Regex Django

Outra maneira mais fácil de seguir é ter várias regras que atendam às suas necessidades, todas apontando para a mesma exibição.

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

Lembre-se de que, na sua visão, você também precisará definir um padrão para o parâmetro opcional do URL ou obterá um erro:

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

Você pode usar rotas aninhadas

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

Isso é muito mais seco ( productdigamos que você queira renomear o kwarg para product_id, você só precisa alterar a linha 4 e isso afetará os URLs abaixo.

Editado para Django 1.8 e superior

Ainda mais simples é usar:

(?P<project_id>\w+|)

O "(a | b)" significa a ou b; portanto, no seu caso, seriam um ou mais caracteres da palavra (\ w +) ou nada.

Então seria assim:

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

Django> versão 2.0 :

A abordagem é essencialmente idêntica à apresentada na resposta de Yuji 'Tomita' Tomita . Afetado, no entanto, é a sintaxe:

# 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()você também pode passar argumentos extras para uma visão com o argumento opcional kwargsque é do tipo dict. Nesse caso, sua visualização não precisaria de um padrão para o atributo project_id:

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

Para saber como isso é feito na versão mais recente do Django , consulte os documentos oficiais sobre o envio de URL .

Pensei em acrescentar um pouco à resposta.

Se você tiver várias definições de URL, precisará nomear cada uma delas separadamente. Portanto, você perde a flexibilidade ao chamar reverso, pois um reverso espera um parâmetro enquanto o outro não.

Outra maneira de usar o regex para acomodar o parâmetro opcional:

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

Usar ? funcionar bem, você pode verificar em pythex . Lembre-se de adicionar os parâmetros * args e ** kwargs na definição dos métodos de exibição

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