{"title":"URL ディスパッチャ","version":"5.0","locale":"ja","docname":"topics/http/urls","url":"/ja/5.0/topics/http/urls/","canonical":"https://djangodocs.dev/ja/5.0/topics/http/urls/","summary":"すっきりした、簡潔で明解な URL スキームは、高品質な Web アプリケーションでは重要な要素です。 Django では、フレームワークの制限なしに、望み通りの URL を設計できます。 URL はすっきりした扱いやすいものにすべきであるという主張については、ワール ドワイドウェブの産みの親である Tim…","html":"

URL ディスパッチャLink to this heading#

\n

すっきりした、簡潔で明解な URL スキームは、高品質な Web アプリケーションでは重要な要素です。 Django では、フレームワークの制限なしに、望み通りの URL を設計できます。

\n

URL はすっきりした扱いやすいものにすべきであるという主張については、ワール ドワイドウェブの産みの親である Tim Berners-Lee の優れた解説、 Cool URIs don't change を参照してください。

\n
\n

概要Link to this heading#

\n

アプリケーションのURLを設計するには、俗に URLconf (URL configuration) と呼ばれる Python モジュールを作る必要があります。このモジュールは pure Python コードであり、URLパス表記とあなたの書いたビューの Python 関数とのマッピングです。

\n

このマッピングは短くもできますし、必要なだけ長くもできます。他のマッピングも参照できます。また、pure Python コードなので、動的に生成できます。

\n

Django は有効にされている言語に従って URL を翻訳するための手段も提供しています。詳しくは 国際化のドキュメント を参照してください。

\n
\n
\n

Django のリクエスト処理Link to this heading#

\n

ユーザが Django で作られたサイト上のページをリクエストした時に、どの Python コードが実行されるかは以下のアルゴリズムで決定されます。

\n
    \n

  1. まず、Django は、どのモジュールをルート URLconf として使うか決定します。通常は、この値は ROOT_URLCONF に設定されています。ただし、 HttpRequest オブジェクトに urlconf という属性が設定されていた場合 ( middleware で設定されます) 、その値を ROOT_URLCONF の代わりに使います。

    2. \n

  2. Django はその Python モジュールをロードして、urlpatterns という名前の変数を探します。この変数の値は django.urls.path() または django.urls.re_path() インスタンスの sequence でなければなりません。

    3. \n

  3. Django は URL パターンを順に調べて、 path_info にマッチする、リクエストされた URL にマッチする最初のパターンで停止します。

    4. \n

  4. ある 1 個の正規表現にマッチしたら、 Django はマッピングで指定されたビューを import して呼び出します。そのビューは Python 関数 (もしくは クラスベースのビュー) です。ビューには以下の引数が渡されます:

    \n
      \n

    • HttpRequest のインスタンス。

      • \n

    • マッチしたURLパターンに名前付きグループが含まれていない場合、正規表現でマッチした値が位置引数として提供されます。

      • \n

    • 指定された URL パス表現でマッチした名前付き部分からはキーワード引数が作られます。ただし、 django.urls.path() や django.urls.re_path() に kwargs オプション引数が指定されていた場合は、その中の引数で上書きされます。

      • \n
    \n
    5. \n

  5. もし、 URL 正規表現が何にもマッチしなかったり、パターンマッチングプロセスの途中のどこかで例外が発生した場合、Django は適切なエラーハンドリングビューを呼び出します。下の Error handling を見てください。

    6. \n
\n
\n
\n

カスタマイズ例Link to this heading#

\n

URLconf のサンプルです。

\n
Code
from django.urls import path\n\nfrom . import views\n\nurlpatterns = [\n    path("articles/2003/", views.special_case_2003),\n    path("articles/<int:year>/", views.year_archive),\n    path("articles/<int:year>/<int:month>/", views.month_archive),\n    path("articles/<int:year>/<int:month>/<slug:slug>/", views.article_detail),\n]\n
\n

メモ:

\n\n

リクエストの例:

\n\n
\n
\n

パス コンバータLink to this heading#

\n

デフォルトでは、以下のパスコンバータが使用可能です:

\n\n
\n
\n

独自のパスコンバータを登録するLink to this heading#

\n

より複雑なマッチング要件については、独自のパスコンバータを定義できます。

\n

コンバーターとは、以下のようなクラスです:

\n\n

例:

\n
Code
class FourDigitYearConverter:\n    regex = "[0-9]{4}"\n\n    def to_python(self, value):\n        return int(value)\n\n    def to_url(self, value):\n        return "%04d" % value\n
\n

register_converter(): を使用して、URLconf にカスタムコンバータクラスを登録します:

\n
Code
from django.urls import path, register_converter\n\nfrom . import converters, views\n\nregister_converter(converters.FourDigitYearConverter, "yyyy")\n\nurlpatterns = [\n    path("articles/2003/", views.special_case_2003),\n    path("articles/<yyyy:year>/", views.year_archive),\n    ...,\n]\n
\n
\n
\n

正規表現を使うLink to this heading#

\n

パスとコンバータ構文だけでは URL パターンを定義するのに不十分な場合は、正規表現を使うこともできます。その場合は path() の代わりに re_path() を使ってください。

\n

Python の正規表現では、名前付き正規表現グループの構文は (?P<name>pattern) です。ここで name はグループの名前で、 pattern はマッチするパターンです。

\n

先ほどのURLconfの例を正規表現を使って書き直したものです:

\n
Code
from django.urls import path, re_path\n\nfrom . import views\n\nurlpatterns = [\n    path("articles/2003/", views.special_case_2003),\n    re_path(r"^articles/(?P<year>[0-9]{4})/$", views.year_archive),\n    re_path(r"^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$", views.month_archive),\n    re_path(\n        r"^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/(?P<slug>[\\w-]+)/$",\n        views.article_detail,\n    ),\n]\n
\n

これは、前の例とほぼ同じことを実現します:

\n\n

path() を使っていたのを re_path() に切り替えたり、その逆を行ったりする場合は、ビューの引数の型が変わる可能性があることに十分注意してください。

\n
\n

名前なし正規表現グループの使用Link to this heading#

\n

名前付きグループ構文、例えば (?P<year>[0-9]{4}) の他に、より短い名前なしグループ、例えば ([0-9]{4}) を使うこともできます。

\n

このような使い方をすると、マッチの意図した意味とビューの引数との対応を間違えやすくなり、バグが混入しやすくなるので、使わないことを強く推奨します。

\n

どちらの場合でも、指定した正規表現内で1つのスタイルだけを使用することを推奨します。両方のスタイルが混在している場合、名前のないグループは無視され、名前のあるグループだけがビュー関数に渡されます。

\n
\n
\n

ネストされた引数Link to this heading#

\n

正規表現ではネストされた引数を使うことができ、Django はこれらを解決してビューに渡します。このとき、Django は全ての外側のキャプチャされた引数を埋めようとし、ネストされたキャプチャされた引数を無視します。任意でページ引数を取る以下の URL パターンを考えてみます:

\n
Code
from django.urls import re_path\n\nurlpatterns = [\n    re_path(r"^blog/(page-([0-9]+)/)?$", blog_articles),  # bad\n    re_path(r"^comments/(?:page-(?P<page_number>[0-9]+)/)?$", comments),  # good\n]\n
\n

両方のパターンでネストされた引数を使っており、解決します: 例えば、 blog/page-2/ は 2 つの潜在的な引数 (page-2/ と 2) で blog_articles と一致する結果となります。comments の 2 番目のパターンは、2 にセットされたキーワード引数 page_number で comments/page-2/ と一致します。 この例での外部の引数は、キャプチャされない引数 (?:...) です。

\n

blog_articles ビューは一番外側のキャプチャされた引数が解決されるのを必要としますが (この例では page-2/ か引数なし)、comments は引数なしか page_number に対する値のどちらかで解決できます。

\n

ネストされたキャプチャされた引数は、blog_articles (ビューが興味を持つ値だけでなく URL page-2/ の部分を受け取るビュー) によって示されるように、ビュー引数と URL の間に強力な結合を作ります: この結合は、ビューを解決する際にページ番号ではなくURLの部分を渡す必要があるため、解決するときにはさらに顕著になります。

\n

経験則として、正規表現が引数を必要とする一方でビューがそれを無視するときには、ビューが必要とする値だけをキャプチャして、キャプチャしない引数を使ってください。

\n
\n
\n
\n

URLconf の検索対象Link to this heading#

\n

URLconf はリクエストされた URL を通常の Python 文字列として検索します。これには GET や POST パラメータ、ドメイン名は含まれません。

\n

たとえば、https://www.example.com/myapp/ へのリクエストでは、URLconf は myapp/ を探します。

\n

https://www.example.com/myapp/?page=3 へのリクエストでは、URLconf は myapp/ を探します。

\n

URLconf はリクエストメソッドを見ません。つまり、すべてのリクエストメソッド (POST, GET, HEAD など) は同じURLの同じ関数にルーティングされます。

\n
\n
\n

ビュー引数のデフォルト値を指定するLink to this heading#

\n

便利なテクニックは、ビューの引数にデフォルトのパラメータを指定することです。以下は URLconf とビューの例です:

\n
Code
# URLconf\nfrom django.urls import path\n\nfrom . import views\n\nurlpatterns = [\n    path("blog/", views.page),\n    path("blog/page<int:num>/", views.page),\n]\n\n\n# View (in blog/views.py)\ndef page(request, num=1):\n    # Output the appropriate page of blog entries, according to num.\n    ...\n
\n

上記の例では、URLパターンはどちらも同じビュー、 views.page を指していますが、最初のパターンはURLから何も取得していません。最初のパターンにマッチした場合、 page() 関数は num のデフォルト引数である 1 を使用します。2番目のパターンにマッチした場合、 page() はキャプチャされた num の値を使用します。

\n
\n
\n

パフォーマンスLink to this heading#

\n

Django は urlpatterns リストにある正規表現を処理します。それ以降のリクエストでは、 URL リゾルバ経由でキャッシュされた設定を使います。

\n
\n
\n

urlpatterns 変数の構文Link to this heading#

\n

urlpatterns は django.urls.path() または django.urls.re_path() インスタンスの sequence でなければなりません。

\n
\n
\n

エラーハンドリングLink to this heading#

\n

Django がリクエストされた URL にマッチするものを見つけられなかったり、例外 が発生したりすると、Django はエラーハンドリングビューを起動します。

\n

これらのケースで使用するビューは、4種類の変数で指定します。ほとんどのプロジェクトではデフォルト値で十分ですが、デフォルト値を上書きすることでさらにカスタマイズできます。

\n

詳細は エラービューをカスタマイズする を参照してください。

\n

このような値はルートの URLconf で設定できます。他の URLconf でこれらの変数を設定しても意味はありません。

\n

値は呼び出し可能オブジェクト、つまり、エラー状態を処理するために呼び出すべきビューへの Python インポートパスを表す文字列でなければなりません。

\n

変数の種類は下記です。

\n\n
\n
\n

他の URLconfs をインクルードするLink to this heading#

\n

いずれの時点でも、urlpatterns は他の URLconf モジュールを "含む (インクルードする)" ことができます。これは基本的に、他の URL パターンに定義されている URL のセットを探索します。

\n

例えば、以下は Django website 自体に対する URLconf の引用です。これは複数の他の URLconfs をインクルードしています:

\n
Code
from django.urls import include, path\n\nurlpatterns = [\n    # ... snip ...\n    path("community/", include("aggregator.urls")),\n    path("contact/", include("contact.urls")),\n    # ... snip ...\n]\n
\n

Django が include() に出会うたびに、そのポイントまでにマッチした URL の部分を切り落とし、残りの文字列を、インクルードされた URLconf へ渡し、次の処理が行われます。

\n

他の方法として、 path() インスタンスのリストを使うことによって追加的な URL をインクルードすることもできます。例えば、以下の URLconf があったとします:

\n
Code
from django.urls import include, path\n\nfrom apps.main import views as main_views\nfrom credit import views as credit_views\n\nextra_patterns = [\n    path("reports/", credit_views.report),\n    path("reports/<int:id>/", credit_views.report),\n    path("charge/", credit_views.charge),\n]\n\nurlpatterns = [\n    path("", main_views.homepage),\n    path("help/", include("apps.help.urls")),\n    path("credit/", include(extra_patterns)),\n]\n
\n

この例では、/credit/reports/ という URL は credit_views.report() というビューによって処理されます。

\n

これを使うと、単一のパターンの接頭辞が繰り返し使われるような URLconf の冗長さを回避できます。例えば、以下の URLconf を考えてみます:

\n
Code
from django.urls import path\nfrom . import views\n\nurlpatterns = [\n    path("<page_slug>-<page_id>/history/", views.history),\n    path("<page_slug>-<page_id>/edit/", views.edit),\n    path("<page_slug>-<page_id>/discuss/", views.discuss),\n    path("<page_slug>-<page_id>/permissions/", views.permissions),\n]\n
\n

これは、パスの共通部分である接頭辞を一度だけ記述し、異なる接尾辞を以下のようにグループ化することで改善できます:

\n
Code
from django.urls import include, path\nfrom . import views\n\nurlpatterns = [\n    path(\n        "<page_slug>-<page_id>/",\n        include(\n            [\n                path("history/", views.history),\n                path("edit/", views.edit),\n                path("discuss/", views.discuss),\n                path("permissions/", views.permissions),\n            ]\n        ),\n    ),\n]\n
\n
\n

取り込まれたパラメータLink to this heading#

\n

インクルードされた URLconf は親の URLconf から取り込まれた全てのパラメータを受け取るので、以下の例は有効です:

\n
Code
# In settings/urls/main.py\nfrom django.urls import include, path\n\nurlpatterns = [\n    path("<username>/blog/", include("foo.urls.blog")),\n]\n\n# In foo/urls/blog.py\nfrom django.urls import path\nfrom . import views\n\nurlpatterns = [\n    path("", views.blog.index),\n    path("archive/", views.blog.archive),\n]\n
\n

上の例では、取り込まれた "username" 変数はインクルードされたURLconf に渡されます。

\n
\n
\n
\n

追加的なオプションをビュー関数に渡すLink to this heading#

\n

URLconfs は、Ptyhon のディクショナリとして、ビュー関数に追加の引数を引き渡せるようにするフックを持っています。

\n

path() 関数はオプションで第3引数を取ることができます。第3引数にはビュー関数に渡す追加のキーワード引数の辞書を指定します。

\n

例:

\n
Code
from django.urls import path\nfrom . import views\n\nurlpatterns = [\n    path("blog/<int:year>/", views.year_archive, {"foo": "bar"}),\n]\n
\n

この例では、/blog/2005/ へのリクエストに対して、Django は views.year_archive(request, year=2005, foo='bar') を呼び出します。

\n

このテクニックは 配信フィードフレームワーク で使われ、メタデータとオプションをビューに引き渡します。

\n\n
\n

include() に追加のオプションを引き渡すLink to this heading#

\n

同様に、 include() に追加オプションを渡すと、 インクルードされた URLconf の各行に追加オプションが渡されます。

\n

例えば、以下の 2 つの URLconf のセットはまったく同じように機能します:

\n

セット 1:

\n
Code
# main.py\nfrom django.urls import include, path\n\nurlpatterns = [\n    path("blog/", include("inner"), {"blog_id": 3}),\n]\n\n# inner.py\nfrom django.urls import path\nfrom mysite import views\n\nurlpatterns = [\n    path("archive/", views.archive),\n    path("about/", views.about),\n]\n
\n

セット 2:

\n
Code
# main.py\nfrom django.urls import include, path\nfrom mysite import views\n\nurlpatterns = [\n    path("blog/", include("inner")),\n]\n\n# inner.py\nfrom django.urls import path\n\nurlpatterns = [\n    path("archive/", views.archive, {"blog_id": 3}),\n    path("about/", views.about, {"blog_id": 3}),\n]\n
\n

行のビューが実際にそれらのオプションを有効として受け入れるかどうかに関わらず、追加のオプションが 常に インクルードされている URLconfの すべての 行に引き渡されることに注意してください。 このため、このテクニックは、インクルードされた URLconf のすべてのビューが、引き渡される追加のオプションを受け入れることが確実である場合にのみ役立ちます。

\n
\n
\n
\n

URL の逆引きLink to this heading#

\n

Django プロジェクトで作業するときの一般的なニーズとして、生成されたコンテンツ (ビューとアセットのURL、ユーザーに表示されるURLなど) への埋め込み、またはサーバーサイドでのナビゲーションフローの処理 (リダイレクトなど) のどちらかに対して、最終的なフォーム内で URL を取得することが挙げられます。

\n

こうした URL のハードコーディング (手間がかかり、スケールしにくく、誤りが起こりやすい戦略) は、避けることが強く望まれます。 同様に危険なのは、URLconf で記述された設計と並行して URL を生成するような一時的な仕組みを考え出してしまうことです。これは、時間の経過とともに古くて使えない URL が生成されてしまう原因となります。

\n

言い換えると、必要なのはDRYな仕組みです。 数々の利点の中でも、これは URL 設計が進化していけるようにします。プロジェクトソースコードを全て検索して古い URL を置換する必要はありません。

\n

URLを取得するために利用可能な主な情報は、それを扱うビューの識別（例えば名前）です。正しい URL を探し出すために必要な他の情報は、ビューの引数の型 (位置、キーワード) と値です。

\n

Django は URL マッパーが URL 設計の唯一のリポジトリとなるような解決策を提供します。URLconfを入力すると、双方向で使用できます:

\n\n

最初のものは、前のセクションで説明した使い方です。もう1つは、 URLの逆解決 、 逆URLマッチング 、 逆URLルックアップ 、あるいは単に URLの逆引き として知られているものです。

\n

Django は、 URL が必要とされる様々なレイヤにマッチする URL の逆引きを実行するためのツールを提供します:

\n\n
\n

例Link to this heading#

\n

このURLconfのエントリーについてもう一度考えてみましょう:

\n
Code
from django.urls import path\n\nfrom . import views\n\nurlpatterns = [\n    # ...\n    path("articles/<int:year>/", views.year_archive, name="news-year-archive"),\n    # ...\n]\n
\n

この設計によると、 nnnn 年に対応するアーカイブのURLは /articles/<nnnn>/ です。

\n

これらをテンプレートコードで取得するには、次のようにします:

\n
Django template
<a href="{% url 'news-year-archive' 2012 %}">2012 Archive</a>\n{# Or with the year in a template context variable: #}\n<ul>\n{% for yearvar in year_list %}\n<li><a href="{% url 'news-year-archive' yearvar %}">{{ yearvar }} Archive</a></li>\n{% endfor %}\n</ul>\n
\n

または Python コードで次のようにします:

\n
Code
from django.http import HttpResponseRedirect\nfrom django.urls import reverse\n\n\ndef redirect_to_year(request):\n    # ...\n    year = 2006\n    # ...\n    return HttpResponseRedirect(reverse("news-year-archive", args=(year,)))\n
\n

もし何らかの理由で、年間記事アーカイブのコンテンツが公開されるURLを変更することになった場合、URLconfのエントリを変更するだけです。

\n

ビューが一般的なものである場合、URLとビューの間に多対一の関係が存在することがあります。このような場合、 URL を反転させるときに、ビュー名は十分な識別子ではありません。Django が提供する解決策を知るには、次の節を読んでください。

\n
\n
\n
\n

URL パターンに名前をつけるLink to this heading#

\n

URL のリバースを処理するためには、上述の例で行ったように 名前をつけられた URL パターン を使う必要があります。URL 名として使う文字列には、どんな文字でも含めることができます。Python の有効な名前に制限を受けません。

\n

URL パターンに名前をつけるときは、他のアプリケーションが選んだ名前と衝突しにくい名前を選んでください。URL パターンを comment と命名し、他のアプリケーションが同じことをした場合、 reverse() が見つける URL は、プロジェクトの urlpatterns リストの最後にあるパターンに依存します。

\n

URL名にプレフィックス、例えばアプリケーション名から派生したもの（ comment の代わりに myapp-comment など）を付けると、衝突の可能性を減らせます。

\n

ビューをオーバーライドしたい場合、他のアプリケーションと 同じURL名 を意図的に選択できます。たとえば、よくある使用例は LoginView をオーバーライドすることです。Django の一部やほとんどのサードパーティアプリは、このビューが login という名前の URL パターンを持っていると仮定しています。カスタムログインビューがあり、その URL に login という名前をつけている場合、 reverse() は、django.contrib.auth.urls がインクルードされた後の urlpatterns にある限り（すべてを探して含まれていれば）、カスタムビューを見つけます。

\n

引数が異なれば、複数の URL パターンに同じ名前を使うこともできます。URL 名に加えて、 reverse() は引数の数とキーワード引数の名前もマッチします。パスコンバータは、マッチしなかったことを示すために ValueError を発生させることがあります。詳細は 独自のパスコンバータを登録する を参照してください。

\n
\n
\n

URL の名前空間Link to this heading#

\n
\n

はじめにLink to this heading#

\n

URL名前空間を使用すると、異なるアプリケーションが同じURL名を使用していても、 名前付きURLパターン を一意に逆引きできます。サードパーティアプリは常に名前空間付きのURLを使用することが良い習慣です（チュートリアルで行ったように）。同様に、アプリケーションの複数のインスタンスがデプロイされている場合にURLを逆引きすることも可能にします。言い換えれば、単一のアプリケーションの複数のインスタンスが名前付きURLを共有する場合、名前空間はこれらの名前付きURLを区別する方法を提供します。

\n

URL の名前空間を適切に使用する Django アプリケーションは、特定のサイトに対して何回でもデプロイできます。 たとえば django.contrib.admin には AdminSite クラスがあり、 admin のインスタンスを複数回デプロイ することができます。後者の例では、2 つの異なるユーザー (著者と出版者) に同じ機能を提供できるよう、チュートリアルで扱った polls アプリケーションを例に、2 つの異なる場所にデプロイするという考え方について説明します。

\n

URL の名前空間は 2 つの部分に分かれ、両方とも文字列で表されます:

\n
\n
アプリケーションの名前空間Link to this term#

デプロイされているアプリケーションの名前を示します。 単一のアプリケーションのすべてのインスタンスは、同一のアプリケーション名前空間を持ちます。 例えば、Django の admin アプリケーションには、'admin' という比較的分かりやすいアプリケーション名前空間を持っています。

\n
\n
インスタンスの名前空間Link to this term#

アプリケーションの特定のインスタンスを識別します。 インスタンス名前空間は、プロジェクト全体で一意である必要があります。ただし、インスタンス名前空間は、アプリケーション名前空間と同じにすることができます。これは、アプリケーションのデフォルトインスタンスを指定するために使用されます。 例えば、デフォルトの Django admin インスタンスは 'admin' というインスタンス名前空間を持っています。

\n
\n
\n

名前空間の URL は、 ':' 演算子を使って指定します。 たとえば、admin アプリケーションのメインインデックスページは 'admin:index' で参照されます。 これは 'admin' という名前空間と 'index' という名前の URL を示します。

\n

名前空間はネストすることもできます。 名前付きの URL 'sports:polls:index' は、トップレベルの名前空間 'sports' 内で定義されている名前空間 'polls' 内で 'index' と名前がつけられたパターンを探します。

\n
\n
\n

名前空間の URL を逆引きするLink to this heading#

\n

名前空間の URL (例: 'polls:index') が与えられると、Django 完全修飾名をパーツに分割し、以下のルックアップを試みます:

\n
    \n

  1. まず最初に、Django は アプリケーションの名前空間 (ここでは 'polls') との一致を検索します。これは、このアプリケーションのインスタンスのリストを生成します。

    2. \n

  2. 現在のアプリケーションが定義されている場合、Django はそのインスタンスに対して URL リゾルバを探し出し、返します。現在のアプリケーションは reverse() 関数への current_app 引数で指定できます。

    \n

    url テンプレートタグは、RequestContext 内で現在のアプリケーションとされているビューの名前空間を使います。このデフォルト設定は、request.current_app 属性で現在のアプリケーションを設定することでオーバーライドできます。

    \n
    3. \n

  3. 現在のアプリケーションがない場合、Django はデフォルトのアプリケーションインスタンスを探します。デフォルトのアプリケーションインスタンスは、 application namespace と一致する instance namespace を持つインスタンスです。 (ここでは 'polls' と呼ばれる polls のインスタンスです).

    4. \n

  4. デフォルトのアプリケーションインスタンスがない場合、Django は、そのインスタンス名が何であれ、アプリケーションの最後にデプロイされたインスタンスを利用します。

    5. \n

  5. 提供された名前空間がステップ 1 の application namespace と一致しない場合、Django は名前空間のルックアップを instance namespace として直接試みます。

    6. \n
\n

ネストされた名前空間がある場合、これらのステップはビューの名前のみが未解決になるまで名前空間の各パートに対して繰り返されます。その後に、このビュー名は見つかった名前空間内の URL として解決されます。

\n
\n

カスタマイズ例Link to this heading#

\n

実際の名前解決戦略を示すため、チュートリアルで扱った polls アプリケーションの 2 つのインスタンスの例を考えてみましょう: 1 つは 'author-polls'、もう 1 つは 'publisher-polls' と名付けられています。polls を作成して表示するときにインスタンス名前空間を考慮するように、そのアプリケーションを拡張したとします。

\n
urls.py
\n
Python
from django.urls import include, path\n\nurlpatterns = [\n    path("author-polls/", include("polls.urls", namespace="author-polls")),\n    path("publisher-polls/", include("polls.urls", namespace="publisher-polls")),\n]\n
\n
polls/urls.py
\n
Python
from django.urls import path\n\nfrom . import views\n\napp_name = "polls"\nurlpatterns = [\n    path("", views.IndexView.as_view(), name="index"),\n    path("<int:pk>/", views.DetailView.as_view(), name="detail"),\n    ...,\n]\n
\n

この設定を使うことで、以下のルックアップが可能となります:

\n
    \n

  • インスタンスの一つが現在参照されている場合（例えば、インスタンス 'author-polls' の詳細ページをレンダリングしている場合） 'polls:index' は 'author-polls' インスタンスのインデックスページを解決します。つまり、以下のどちらも "/author-polls/" という結果になります。

    \n

    クラスベースビューのメソッド内:

    \n
    Code
    reverse("polls:index", current_app=self.request.resolver_match.namespace)\n
    \n

    テンプレート内:

    \n
    Django template
    {% url 'polls:index' %}\n
    \n
    • \n

  • 現在のインスタンスがない場合（例えば、サイトの他の場所でページをレンダリングしている場合） 'polls:index' は polls の最後に登録されたインスタンスに名前解決されます。デフォルトのインスタンス ('polls' のインスタンス名前空間) がないため、登録された最後の polls のインスタンスが使用されます。これは、urlpatterns で最後に宣言されている 'publisher-polls' になります。

    • \n

  • 'author-polls:index' は、常に 'author-polls' のインスタンスのインデックスページに名前解決します (そして 'publisher-polls' に対しても同じです) .

    • \n
\n

デフォルトのインスタンス、つまり 'polls' という名前のインスタンスがある場合、上記からの唯一の変更点は現在のインスタンスがない場合（上記リストの2番目の項目）です。この場合、'polls:index' は urlpatterns で最後に宣言されたインスタンスの代わりにデフォルトインスタンスのインデックスページに名前解決されます。

\n
\n
\n
\n

URLの名前空間とインクルードされた URLconfsLink to this heading#

\n

インクルードされた URLconfs のアプリケーション名前空間は、2 つの方法で指定できます。

\n

1 つめは、インクルードされた URLconf で app_name 属性をセットする方法で、これは urlpatterns 属性と同じレベルに記述します。urlpatterns のリスト自体ではなく、実際のモジュールないし include() への文字列参照に対して引き渡す必要があります。

\n
polls/urls.py
\n
Python
from django.urls import path\n\nfrom . import views\n\napp_name = "polls"\nurlpatterns = [\n    path("", views.IndexView.as_view(), name="index"),\n    path("<int:pk>/", views.DetailView.as_view(), name="detail"),\n    ...,\n]\n
\n
urls.py
\n
Python
from django.urls import include, path\n\nurlpatterns = [\n    path("polls/", include("polls.urls")),\n]\n
\n

polls.urls 内で定義された URL は、アプリケーション名前空間 polls を持ちます。

\n

2つめは、埋め込みの名前空間データを含むオブジェクトをインクルードする方法です。 path() または re_path() インスタンスのリストを include() する場合、このオブジェクトに含まれる URL はグローバルの名前空間に含まれるようになります。ただし、以下を含む 2値タプルを include() することもできます:

\n
Text
(<list of path()/re_path() instances>, <application namespace>)\n
\n

例:

\n
Code
from django.urls import include, path\n\nfrom . import views\n\npolls_patterns = (\n    [\n        path("", views.IndexView.as_view(), name="index"),\n        path("<int:pk>/", views.DetailView.as_view(), name="detail"),\n    ],\n    "polls",\n)\n\nurlpatterns = [\n    path("polls/", include(polls_patterns)),\n]\n
\n

これは、与えられたアプリケーション名前空間に、指定された URL パターンをインクルードします。

\n

インスタンスの名前空間は、 include() に namespace 引数を使うことで指定できます。インスタンス名前空間が指定されていない場合、インクルードされた URLconf のアプリケーション名前空間がデフォルトとなります。つまり、その名前空間のデフォルトインスタンスになります。

\n
\n
","rootId":"url-dispatcher","toc":[{"title":"概要","anchor":"overview","children":[]},{"title":"Django のリクエスト処理","anchor":"how-django-processes-a-request","children":[]},{"title":"カスタマイズ例","anchor":"example","children":[]},{"title":"パス コンバータ","anchor":"path-converters","children":[]},{"title":"独自のパスコンバータを登録する","anchor":"registering-custom-path-converters","children":[]},{"title":"正規表現を使う","anchor":"using-regular-expressions","children":[{"title":"名前なし正規表現グループの使用","anchor":"using-unnamed-regular-expression-groups","children":[]},{"title":"ネストされた引数","anchor":"nested-arguments","children":[]}]},{"title":"URLconf の検索対象","anchor":"what-the-urlconf-searches-against","children":[]},{"title":"ビュー引数のデフォルト値を指定する","anchor":"specifying-defaults-for-view-arguments","children":[]},{"title":"パフォーマンス","anchor":"performance","children":[]},{"title":"urlpatterns 変数の構文","anchor":"syntax-of-the-urlpatterns-variable","children":[]},{"title":"エラーハンドリング","anchor":"error-handling","children":[]},{"title":"他の URLconfs をインクルードする","anchor":"including-other-urlconfs","children":[{"title":"取り込まれたパラメータ","anchor":"captured-parameters","children":[]}]},{"title":"追加的なオプションをビュー関数に渡す","anchor":"passing-extra-options-to-view-functions","children":[{"title":"include() に追加のオプションを引き渡す","anchor":"passing-extra-options-to-include","children":[]}]},{"title":"URL の逆引き","anchor":"reverse-resolution-of-urls","children":[{"title":"例","anchor":"examples","children":[]}]},{"title":"URL パターンに名前をつける","anchor":"naming-url-patterns","children":[]},{"title":"URL の名前空間","anchor":"url-namespaces","children":[{"title":"はじめに","anchor":"introduction","children":[]},{"title":"名前空間の URL を逆引きする","anchor":"reversing-namespaced-urls","children":[{"title":"カスタマイズ例","anchor":"id5","children":[]}]},{"title":"URLの名前空間とインクルードされた URLconfs","anchor":"url-namespaces-and-included-urlconfs","children":[]}]}],"breadcrumbs":[{"docname":"topics/index","title":"Django を使う","url":"/ja/5.0/topics/"},{"docname":"topics/http/index","title":"HTTP リクエストのハンドリング","url":"/ja/5.0/topics/http/"}],"prev":{"docname":"topics/http/index","title":"HTTP リクエストのハンドリング","url":"/ja/5.0/topics/http/"},"next":{"docname":"topics/http/views","title":"ビューを記述する","url":"/ja/5.0/topics/http/views/"},"formats":{"html":"/ja/5.0/topics/http/urls/","markdown":"/ja/5.0/topics/http/urls.md","json":"/ja/5.0/topics/http/urls.json"},"source":"https://github.com/django/django/blob/stable/5.0.x/docs/topics/http/urls.txt","official":"https://docs.djangoproject.com/ja/5.0/topics/http/urls/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9"],"inLocales":["en","zh-hans","fr","ja","id","it","pt-br","ko","es","el","pl"]}