Parámetros de URL opcionales de Django

Tengo una URL de Django como esta:

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

El problema es que quiero que el project_idparámetro sea opcional.

Quiero /project_config/y /project_config/12345abdce/para ser patrones de URL igualmente válidas, de manera que si project_id se pasa, a continuación, lo puedo usar.

Tal como está en este momento, obtengo un 404 cuando accedo a la URL sin el project_idparámetro.

Hay varios enfoques.

Una es usar un grupo sin captura en la expresión regular: hacer opcional una señal de URL de Django de expresión regular (?:/(?P<title>[a-zA-Z]+)/)?

Otra forma más fácil de seguir es tener múltiples reglas que coincidan con sus necesidades, todas apuntando a la misma vista.

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

Tenga en cuenta que, desde su punto de vista, también deberá establecer un valor predeterminado para el parámetro de URL opcional, o recibirá un error:

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

Puedes usar rutas anidadas

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

Esto es mucho más SECO (supongamos que desea cambiar el nombre de productkwarg a product_id, solo tiene que cambiar la línea 4, y afectará las siguientes URL.

Editado para Django 1.8 y superior

Aún más simple es usar:

(?P<project_id>\w+|)

El "(a | b)" significa aob, por lo que en su caso sería uno o más caracteres de palabras (\ w +) o nada.

Entonces se vería así:

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

Django> versión 2.0 :

El enfoque es esencialmente idéntico al dado en la respuesta de Yuji 'Tomita' Tomita . Sin embargo, se ve afectada la sintaxis:

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

El uso path()también puede pasar argumentos adicionales a una vista con el argumento opcional kwargsque es de tipo dict. En este caso, su vista no necesitaría un valor predeterminado para el atributo project_id:

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

Para saber cómo se hace esto en la versión más reciente de Django , consulte los documentos oficiales sobre el envío de URL .

Pensé que agregaría un poco a la respuesta.

Si tiene varias definiciones de URL, deberá nombrar cada una de ellas por separado. Por lo tanto, pierde la flexibilidad al llamar al reverso, ya que un reverso esperará un parámetro mientras que el otro no.

Otra forma de usar regex para acomodar el 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')
]

Utilizar ? funciona bien, puedes comprobar en pythex . Recuerde agregar los parámetros * args y ** kwargs en la definición de los métodos de vista

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