URL ディスパッチャ

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

.php や .cgi といった拡張子は必要なく、0,2097,1-1-1928,00 のような意味不明の URL にする必要もありません。

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

概要

あるアプリケーション向けの URL を設計するには、 URLconf (URL 設定: URL configuration) と呼びならわされている Python モジュールを作成します。このモジュールは pure Python のコードで、中にはただ URL パターン (単純な正規表現) から Python のコールバック関数 (自作のビュー) へのマッピングが入っているだけです。

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

Django は有効にされている言語にしたがって URL を翻訳するための手段も提供しています。詳しくは internationalization documentation を参照してください。

Django のリクエスト処理

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

  1. まず、Django は、どのモジュールをルート URLconf として使うか決定します。通常は、この値は ROOT_URLCONF に設定されています。ただし、 HttpRequest オブジェクトに urlconf という属性が設定されていた場合 ( middleware で設定されます) 、その値を ROOT_URLCONF の代わりに使います。
  2. Django は上記の Python モジュールをロードして、urlpatterns とい う名前の変数を探します。この変数の値は django.conf.urls.url() インスタンスの Python リストでなければなりません。
  3. Django は URL パターンを順に調べて、リクエスト URL に最初にマッチしたところで止まります。
  4. 何らかの正規表現にマッチしたら、 Django はマッピングされているビューを import して呼び出します。ビューは単純な Python 関数です (もしくは class-based view です) 。ビュー関数には以下の引数が渡されます。
    • HttpRequest のインスタンス。
    • マッチした正規表現から無名グループが返された場合は、それらキャプチャされた値が位置引数として渡されます。
    • 正規表現でマッチした名前付きグループからはキーワード引数が作られます。django.conf.urls.url() にオプションの kwargs 引数が指定されていた場合は、その中の引数で上書きされます。
  5. もし、正規表現が何にもマッチしなかったり、パターンマッチングプロセスの途中のどこかで例外が発生した場合、Django は、適切なエラーハンドリングビューを呼び出します。下の Error handling を見てください。

カスタマイズ例

URLconf のサンプルです。

from django.conf.urls import url

from . import views

urlpatterns = [
    url(r'^articles/2003/$', views.special_case_2003),
    url(r'^articles/([0-9]{4})/$', views.year_archive),
    url(r'^articles/([0-9]{4})/([0-9]{2})/$', views.month_archive),
    url(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$', views.article_detail),
]

Notes:

  • To capture a value from the URL, just put parenthesis around it.
  • There’s no need to add a leading slash, because every URL has that. For example, it’s ^articles, not ^/articles.
  • The 'r' in front of each regular expression string is optional but recommended. It tells Python that a string is 「raw」 – that nothing in the string should be escaped. See Dive Into Python’s explanation.

Example requests:

  • A request to /articles/2005/03/ would match the third entry in the list. Django would call the function views.month_archive(request, '2005', '03').
  • /articles/2005/3/ would not match any URL patterns, because the third entry in the list requires two digits for the month.
  • /articles/2003/ would match the first pattern in the list, not the second one, because the patterns are tested in order, and the first one is the first test to pass. Feel free to exploit the ordering to insert special cases like this. Here, Django would call the function views.special_case_2003(request)
  • /articles/2003 would not match any of these patterns, because each pattern requires that the URL end with a slash.
  • /articles/2003/03/03/ would match the final pattern. Django would call the function views.article_detail(request, '2003', '03', '03').

Named groups

The above example used simple, non-named regular-expression groups (via parenthesis) to capture bits of the URL and pass them as positional arguments to a view. In more advanced usage, it’s possible to use named regular-expression groups to capture URL bits and pass them as keyword arguments to a view.

In Python regular expressions, the syntax for named regular-expression groups is (?P<name>pattern), where name is the name of the group and pattern is some pattern to match.

Here’s the above example URLconf, rewritten to use named groups:

from django.conf.urls import url

from . import views

urlpatterns = [
    url(r'^articles/2003/$', views.special_case_2003),
    url(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive),
    url(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$', views.month_archive),
    url(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/(?P<day>[0-9]{2})/$', views.article_detail),
]

This accomplishes exactly the same thing as the previous example, with one subtle difference: The captured values are passed to view functions as keyword arguments rather than positional arguments. For example:

  • A request to /articles/2005/03/ would call the function views.month_archive(request, year='2005', month='03'), instead of views.month_archive(request, '2005', '03').
  • A request to /articles/2003/03/03/ would call the function views.article_detail(request, year='2003', month='03', day='03').

In practice, this means your URLconfs are slightly more explicit and less prone to argument-order bugs – and you can reorder the arguments in your views』 function definitions. Of course, these benefits come at the cost of brevity; some developers find the named-group syntax ugly and too verbose.

The matching/grouping algorithm

Here’s the algorithm the URLconf parser follows, with respect to named groups vs. non-named groups in a regular expression:

  1. If there are any named arguments, it will use those, ignoring non-named arguments.
  2. Otherwise, it will pass all non-named arguments as positional arguments.

In both cases, any extra keyword arguments that have been given as per Passing extra options to view functions (below) will also be passed to the view.

What the URLconf searches against

The URLconf searches against the requested URL, as a normal Python string. This does not include GET or POST parameters, or the domain name.

For example, in a request to https://www.example.com/myapp/, the URLconf will look for myapp/.

In a request to https://www.example.com/myapp/?page=3, the URLconf will look for myapp/.

The URLconf doesn’t look at the request method. In other words, all request methods – POST, GET, HEAD, etc. – will be routed to the same function for the same URL.

Captured arguments are always strings

Each captured argument is sent to the view as a plain Python string, regardless of what sort of match the regular expression makes. For example, in this URLconf line:

url(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive),
…the year argument passed to views.year_archive() will be a string,
not an integer, even though the [0-9]{4} will only match integer strings.

Specifying defaults for view arguments

A convenient trick is to specify default parameters for your views』 arguments. Here’s an example URLconf and view:

# URLconf
from django.conf.urls import url

from . import views

urlpatterns = [
    url(r'^blog/$', views.page),
    url(r'^blog/page(?P<num>[0-9]+)/$', views.page),
]

# View (in blog/views.py)
def page(request, num="1"):
    # Output the appropriate page of blog entries, according to num.
    ...

In the above example, both URL patterns point to the same view – views.page – but the first pattern doesn’t capture anything from the URL. If the first pattern matches, the page() function will use its default argument for num, "1". If the second pattern matches, page() will use whatever num value was captured by the regex.

Performance

Each regular expression in a urlpatterns is compiled the first time it’s accessed. This makes the system blazingly fast.

Syntax of the urlpatterns variable

urlpatterns should be a Python list of url() instances.

Error handling

When Django can’t find a regex matching the requested URL, or when an exception is raised, Django will invoke an error-handling view.

The views to use for these cases are specified by four variables. Their default values should suffice for most projects, but further customization is possible by overriding their default values.

See the documentation on customizing error views for the full details.

Such values can be set in your root URLconf. Setting these variables in any other URLconf will have no effect.

Values must be callables, or strings representing the full Python import path to the view that should be called to handle the error condition at hand.

The variables are:

他の URLconfs をインクルードする

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

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

from django.conf.urls import include, url

urlpatterns = [
    # ... snip ...
    url(r'^community/', include('django_website.aggregator.urls')),
    url(r'^contact/', include('django_website.contact.urls')),
    # ... snip ...
]

この例の正規表現には $ (最終文字列一致の文字) はありませんが、末尾にスラッシュが含まれています。 Django は include() (django.conf.urls.include()) に出会うたびに、そのポイントまでに一致した URL の部分を切り捨て、残りの文字列をさらなる処理のためにインクルードされている URLconf に送信します。

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

from django.conf.urls import include, url

from apps.main import views as main_views
from credit import views as credit_views

extra_patterns = [
    url(r'^reports/$', credit_views.report),
    url(r'^reports/(?P<id>[0-9]+)/$', credit_views.report),
    url(r'^charge/$', credit_views.charge),
]

urlpatterns = [
    url(r'^$', main_views.homepage),
    url(r'^help/', include('apps.help.urls')),
    url(r'^credit/', include(extra_patterns)),
]

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

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

from django.conf.urls import url
from . import views

urlpatterns = [
    url(r'^(?P<page_slug>[\w-]+)-(?P<page_id>\w+)/history/$', views.history),
    url(r'^(?P<page_slug>[\w-]+)-(?P<page_id>\w+)/edit/$', views.edit),
    url(r'^(?P<page_slug>[\w-]+)-(?P<page_id>\w+)/discuss/$', views.discuss),
    url(r'^(?P<page_slug>[\w-]+)-(?P<page_id>\w+)/permissions/$', views.permissions),
]

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

from django.conf.urls import include, url
from . import views

urlpatterns = [
    url(r'^(?P<page_slug>[\w-]+)-(?P<page_id>\w+)/', include([
        url(r'^history/$', views.history),
        url(r'^edit/$', views.edit),
        url(r'^discuss/$', views.discuss),
        url(r'^permissions/$', views.permissions),
    ])),
]

取り込まれたパラメータ

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

# In settings/urls/main.py
from django.conf.urls import include, url

urlpatterns = [
    url(r'^(?P<username>\w+)/blog/', include('foo.urls.blog')),
]

# In foo/urls/blog.py
from django.conf.urls import url
from . import views

urlpatterns = [
    url(r'^$', views.blog.index),
    url(r'^archive/$', views.blog.archive),
]

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

ネストされた引数

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

from django.conf.urls import url

urlpatterns = [
    url(r'blog/(page-(\d+)/)?$', blog_articles),                  # bad
    url(r'comments/(?:page-(?P<page_number>\d+)/)?$', comments),  # good
]

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

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

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

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

追加的なオプションをビュー関数に渡す

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

django.conf.urls.url() 関数は、省略可能な第3引数を取ることができます。この引数は、ビュー関数に引き渡す追加的なキーワード引数のディクショナリである必要があります。

For example:

from django.conf.urls import url
from . import views

urlpatterns = [
    url(r'^blog/(?P<year>[0-9]{4})/$', views.year_archive, {'foo': 'bar'}),
]

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

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

競合を解決する

名付けられたキーワード引数をキャプチャする URL パターンを使うこともできます。これは、追加の引数のディクショナリ内と同じ名前の引数を引き渡します。このとき、URL 内でキャプチャされた引数ではなく、ディクショナリ内の引数が使われます。

include() に追加のオプションを引き渡す

同じように、include() に対して追加のオプションを引き渡すこともできます。include() に追加のオプションを引き渡すとき、インクルードされた URLconf 内の それぞれの 行に追加のオプションが渡されます。

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

セット 1:

# main.py
from django.conf.urls import include, url

urlpatterns = [
    url(r'^blog/', include('inner'), {'blogid': 3}),
]

# inner.py
from django.conf.urls import url
from mysite import views

urlpatterns = [
    url(r'^archive/$', views.archive),
    url(r'^about/$', views.about),
]

セット 2:

# main.py
from django.conf.urls import include, url
from mysite import views

urlpatterns = [
    url(r'^blog/', include('inner')),
]

# inner.py
from django.conf.urls import url

urlpatterns = [
    url(r'^archive/$', views.archive, {'blogid': 3}),
    url(r'^about/$', views.about, {'blogid': 3}),
]

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

Reverse resolution of URLs

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

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

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

The primary piece of information we have available to get a URL is an identification (e.g. the name) of the view in charge of handling it. Other pieces of information that necessarily must participate in the lookup of the right URL are the types (positional, keyword) and values of the view arguments.

Django provides a solution such that the URL mapper is the only repository of the URL design. You feed it with your URLconf and then it can be used in both directions:

  • Starting with a URL requested by the user/browser, it calls the right Django view providing any arguments it might need with their values as extracted from the URL.
  • Starting with the identification of the corresponding Django view plus the values of arguments that would be passed to it, obtain the associated URL.

The first one is the usage we’ve been discussing in the previous sections. The second one is what is known as reverse resolution of URLs, reverse URL matching, reverse URL lookup, or simply URL reversing.

Django provides tools for performing URL reversing that match the different layers where URLs are needed:

  • In templates: Using the url template tag.
  • In Python code: Using the reverse() function.
  • In higher level code related to handling of URLs of Django model instances: The get_absolute_url() method.

例

Consider again this URLconf entry:

from django.conf.urls import url

from . import views

urlpatterns = [
    #...
    url(r'^articles/([0-9]{4})/$', views.year_archive, name='news-year-archive'),
    #...
]

According to this design, the URL for the archive corresponding to year nnnn is /articles/nnnn/.

You can obtain these in template code by using:

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

Or in Python code:

from django.urls import reverse
from django.http import HttpResponseRedirect

def redirect_to_year(request):
    # ...
    year = 2006
    # ...
    return HttpResponseRedirect(reverse('news-year-archive', args=(year,)))

If, for some reason, it was decided that the URLs where content for yearly article archives are published at should be changed then you would only need to change the entry in the URLconf.

In some scenarios where views are of a generic nature, a many-to-one relationship might exist between URLs and views. For these cases the view name isn’t a good enough identifier for it when comes the time of reversing URLs. Read the next section to know about the solution Django provides for this.

URL パターンに名前をつける

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

When naming URL patterns, choose names that are unlikely to clash with other applications』 choice of names. If you call your URL pattern comment and another application does the same thing, the URL that reverse() finds depends on whichever pattern is last in your project’s urlpatterns list.

Putting a prefix on your URL names, perhaps derived from the application name (such as myapp-comment instead of comment), decreases the chance of collision.

You can deliberately choose the same URL name as another application if you want to override a view. For example, a common use case is to override the LoginView. Parts of Django and most third-party apps assume that this view has a URL pattern with the name login. If you have a custom login view and give its URL the name login, reverse() will find your custom view as long as it’s in urlpatterns after django.contrib.auth.urls is included (if that’s included at all).

You may also use the same name for multiple URL patterns if they differ in their arguments. In addition to the URL name, reverse() matches the number of arguments and the names of the keyword arguments.

URL の名前空間

はじめに

URL の名前空間は、別のアプリケーションが同じ URL 名を使っている場合でも <naming-url-patterns>` をユニークにリバースできるようにします。(私たちがチュートリアルで行ったように) サードパーティ製のアプリケーションが常に名前空間を使った URL を使っているのがいい例です。同じように、アプリケーションの複数のインスタンスがデプロイされているときでも、URL がリバースできるようになります。言い換えると、単一のアプリケーションの複数のインスタンスは名前のついた URL を共有するので、名前空間は名前のついた URL を区別する方法を提供します。

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

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

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

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

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

名前空間の URL をリバースする

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

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

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

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

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

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

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

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

カスタマイズ例

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

urls.py
from django.conf.urls import include, url

urlpatterns = [
    url(r'^author-polls/', include('polls.urls', namespace='author-polls')),
    url(r'^publisher-polls/', include('polls.urls', namespace='publisher-polls')),
]
polls/urls.py
from django.conf.urls import url

from . import views

app_name = 'polls'
urlpatterns = [
    url(r'^$', views.IndexView.as_view(), name='index'),
    url(r'^(?P<pk>\d+)/$', views.DetailView.as_view(), name='detail'),
    ...
]

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

  • インスタンスの 1 つが現在参照されている場合 - インスタンス 'author-polls' 内の詳細ページをレンダリングしているとしましょう - 'polls:index' は 'author-polls' インスタンスのインデックスページを解決します; 例えば 以下の両方とも``」/author-polls/」`` となります。

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

    reverse('polls:index', current_app=self.request.resolver_match.namespace)

    テンプレート内:

    {% url 'polls:index' %}

  • 現在のインスタンスがない場合 - サイト上のどこか他のページをレンダリングしているとしましょう - 'polls:index' は polls の最後に登録されたインスタンスとして名前解決します。デフォルトのインスタンス ('polls' のインスタンス名前空間) が存在しないため、登録された polls の最後のインスタンスが使われます。urlpatterns 内で最後に明言されているので、'publisher-polls' となります。

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

デフォルトのインスタンスもある場合 - 例えば 'polls' と名前がつけられたインスタンス - 上記とのいい角違いは現在のインスタンスがない場合です (上記のリストの 2 番目の項目)。ここでは、'polls:index' は urlpatterns 内で最後に明言されたインスタンスの代わりにデフォルトのインスタンスのインデックスページに名前解決します。

URLの名前空間とインクルードされた URLconfs

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

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

polls/urls.py
from django.conf.urls import url

from . import views

app_name = 'polls'
urlpatterns = [
    url(r'^$', views.IndexView.as_view(), name='index'),
    url(r'^(?P<pk>\d+)/$', views.DetailView.as_view(), name='detail'),
    ...
]
urls.py
from django.conf.urls import include, url

urlpatterns = [
    url(r'^polls/', include('polls.urls')),
]

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

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

(<list of url() instances>, <application namespace>)

For example:

from django.conf.urls import include, url

from . import views

polls_patterns = ([
    url(r'^$', views.IndexView.as_view(), name='index'),
    url(r'^(?P<pk>\d+)/$', views.DetailView.as_view(), name='detail'),
], 'polls')

urlpatterns = [
    url(r'^polls/', include(polls_patterns)),
]

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

インスタンスの名前空間は、func:~django.conf.urls.include に namespace 引数を使うことで指定できます。 インスタンス名前空間が指定されていない場合、インクルードされた URLconf のアプリケーション名前空間がデフォルトとなります。これは、この名前空間に対するデフォルトのインスタンスにもなることを意味します。

HTTP リクエストのハンドリング
ビューを記述する
Back to Top