DjangoのオプションのURLパラメータ

私はこのようなDjango URLを持っています：

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

問題は、project_idパラメーターをオプションにすることです。

私が欲しい/project_config/と/project_config/12345abdce/なるよう、均等に有効なURLパターンであることを場合 project_id渡され、その後、私はそれを使用することができます。

現時点では、project_idパラメータなしでURLにアクセスすると404が返されます。

いくつかのアプローチがあります。

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

ネストされたルートを使用できます

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

これはproductはるかに乾燥しています（たとえば、kwargの名前をに変更したいとします。4 product_id行目を変更するだけで、以下のURLに影響します。

Django 1.8以降用に編集

さらに簡単なのは以下を使用することです：

(?P<project_id>\w+|)

「（a | b）」はaまたはbを意味するので、あなたの場合、それは1つ以上の単語文字（\ w +）か、何もないことになります。

したがって、次のようになります。

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

Django> 2.0バージョン：

このアプローチは、「冨田裕二」という富田の回答に記載されているアプローチと本質的に同じです。ただし、影響を受けるのは構文です。

# 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()すると、タイプのオプションの引数を使用して、ビューに追加の引数を渡すこともできます。この場合、ビューには属性のデフォルトは必要ありません。kwargsdictproject_id

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

最新のDjangoバージョンでこれがどのように行われるかについては、URLディスパッチに関する公式ドキュメントを参照してください。

私は答えに少し追加すると思いました。

複数のURL定義がある場合は、それぞれに個別に名前を付ける必要があります。したがって、リバースを呼び出すときに柔軟性が失われます。これは、1つのリバースがパラメーターを期待する一方で、もう1つはそうではないためです。

正規表現を使用してオプションのパラメーターに対応する別の方法：

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

使用する ？うまく機能するなら、pythexで確認できます。ビューメソッドの定義にパラメータ* argsおよび** kwargsを追加することを忘れないでください

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