{"title":"URLconf で使用するための django.urls 関数","version":"5.0","locale":"ja","docname":"ref/urls","url":"/ja/5.0/ref/urls/","canonical":"https://djangodocs.dev/ja/5.0/ref/urls/","summary":"path() Link to this heading # path ( route , view , kwargs = None , name = None ) Link to this definition # urlpatterns に含める要素を返します。例えば： Code Copy from django.urls…","html":"
\n

URLconf で使用するための django.urls 関数Link to this heading#

\n
\n

path()Link to this heading#

\n
\n
\npath(route, view, kwargs=None, name=None)Link to this definition#
\n
\n\n

urlpatterns に含める要素を返します。例えば：

\n
Code
from django.urls import include, path\n\nurlpatterns = [\n    path("index/", views.index, name="main-view"),\n    path("bio/<username>/", views.bio, name="bio"),\n    path("articles/<slug:title>/", views.article, name="article-detail"),\n    path("articles/<slug:title>/<int:section>/", views.section, name="article-section"),\n    path("blog/", include("blog.urls")),\n    ...,\n]\n
\n

route 引数は、URL パターンを含む文字列、または gettext_lazy() ( URL パターンを翻訳する を参照) であるべきです。この文字列には、角括弧を使用して URL の一部をキャプチャし (上記の <username> のように)、それをキーワード引数としてビューに送ることができます。角括弧には、一致する文字を制限し、ビューに渡される変数の型を変更することもできるコンバータ指定 (<int:section> の int 部分のような) を含めることができます。例えば、 <int:section> は十進数の文字列に一致し、値を int に変換します。さらに詳しくは Django のリクエスト処理 を参照してください。

\n

view 引数は、ビュー関数またはクラスベースのビューにおける as_view() の結果です。また、 django.urls.include() であることあります。

\n

kwargs 引数を使用すると、ビュー関数またはメソッドに追加の引数を渡すことができます。例については、追加的なオプションをビュー関数に渡す を参照してください。

\n

name 引数が有用な理由については、URL パターンの命名 を参照してください。

\n
\n
\n

re_path()Link to this heading#

\n
\n
\nre_path(route, view, kwargs=None, name=None)Link to this definition#
\n
\n\n

urlpatterns に含める要素を返します。例えば：

\n
Code
from django.urls import include, re_path\n\nurlpatterns = [\n    re_path(r"^index/$", views.index, name="index"),\n    re_path(r"^bio/(?P<username>\\w+)/$", views.bio, name="bio"),\n    re_path(r"^blog/", include("blog.urls")),\n    ...,\n]\n
\n

route 引数は、Python の re モジュールと互換性のある正規表現を含む、文字列または gettext_lazy() ( URL パターンを翻訳する を参照) でなければなりません。文字列では通常、生文字列の構文 (r'') を使用して、\\d のようなシーケンスを含むことができるように、バックスラッシュを別のバックスラッシュでエスケープする必要がないようにします。一致が見つかった場合、正規表現からキャプチャされたグループがビューに渡されます ―― グループに名前がある場合は名前付き引数として、それ以外の場合は位置引数としてです。値は文字列として渡され、型変換は行われません。

\n

route が $ で終わる場合、リクエストされた全 URL が正規表現パターンと一致する必要があります（re.fullmatch() が使用されます）。これは path_info に対してマッチングされます。

\n

view 、 kwargs 、そして name 引数は path() におけるものと同じです。

\n\n
\n
\n

include()Link to this heading#

\n
\n
\ninclude(module, namespace=None)Link to this definition#
\n
\ninclude(pattern_list)
\n
\ninclude((pattern_list, app_namespace), namespace=None)
\n

この場所に "含める" べき他のURLconfモジュールへのフルPythonインポートパスを取る関数です。オプションで、エントリが含まれる application namespace と instance namespace も指定できます。

\n

通常、アプリケーションの名前空間は、include されたモジュールによって指定されるべきです。アプリケーションの名前空間が設定されている場合、 namespace 引数を使用して異なるインスタンスの名前空間を設定できます。

\n

include() は、URL パターンを返すイテレータ、またはそのようなイテレータに加えてアプリケーションの名前空間の名前を含む 2値タプルを引数として受け入れることもできます。

\n
\n
パラメータ:
\n
    \n

  • module -- URLconf モジュール（またはモジュール名）

    • \n

  • namespace (str) -- インクルードされる URL エントリのインスタンス名前空間

    • \n

  • pattern_list -- path() および/または re_path() のインスタンスのイテラブル。

    • \n

  • app_namespace (str) -- include される URL エントリのアプリケーション名前空間

    • \n
\n
\n
\n
\n\n

他の URLconfs をインクルードする および URLの名前空間とインクルードされた URLconfs を参照してください。

\n
\n
\n

register_converter()Link to this heading#

\n
\n
\nregister_converter(converter, type_name)Link to this definition#
\n
\n\n

path() の route に使用するためのコンバータを登録するための関数です。

\n

converter 引数はコンバータークラスであり、 type_name はパスパターンで使用するコンバーター名です。例については 独自のパスコンバータを登録する を参照してください。

\n
\n
\n
\n

URLconf で使用するための django.conf.urls の関数Link to this heading#

\n
\n

static()Link to this heading#

\n
\n
\nstatic.static(prefix, view=django.views.static.serve, **kwargs)Link to this definition#
\n
\n\n

デバッグモードでファイルを配信するための URL パターンを返すヘルパー関数です:

\n
Code
from django.conf import settings\nfrom django.conf.urls.static import static\n\nurlpatterns = [\n    # ... the rest of your URLconf goes here ...\n] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)\n
\n
\n
\n

handler400Link to this heading#

\n
\n
\nhandler400Link to this definition#
\n
\n\n

呼び出し可能オブジェクト、またはエラー状態を引き起こし、ステータスコードが400のレスポンスを送信した場合に呼び出されるべきビューへの完全なPythonインポートパスを表す文字列です。 HTTPクライアントがリクエストを送信した場合に該当します。

\n

デフォルトでは、これは django.views.defaults.bad_request() です。カスタムビューを実装する場合は、request および exception 引数を受け入れ、 HttpResponseBadRequest を返すことを確認してください。

\n
\n
\n

handler403Link to this heading#

\n
\n
\nhandler403Link to this definition#
\n
\n\n

呼び出し可能オブジェクト、またはユーザーがリソースへのアクセスに必要な権限を持っていない場合に呼び出されるべきビューの完全な Python インポートパスを表す文字列。

\n

デフォルトでは、これは django.views.defaults.permission_denied() です。カスタムビューを実装する場合には、request と exception 引数を受け入れ、 HttpResponseForbidden を返すことを確認してください。

\n
\n
\n

handler404Link to this heading#

\n
\n
\nhandler404Link to this definition#
\n
\n\n

呼び出し可能オブジェクト、もしくは、URL パターンに一致するものがない場合に呼び出されるべきビューへの完全な Python インポートパスを表す文字列。

\n

デフォルトでは、これは django.views.defaults.page_not_found() です。カスタムビューを実装する場合は、request と exception 引数を受け取り、HttpResponseNotFound を返すようにしてください。

\n
\n
\n

handler500Link to this heading#

\n
\n
\nhandler500Link to this definition#
\n
\n\n

呼び出し可能オブジェクト、もしくはサーバーエラーが発生した場合に呼び出されるべきビューを完全なPythonインポートパスで表した文字列です。サーバーエラーは、ビューコード内で実行時エラーが発生した時に起こります。

\n

デフォルトでは、これは django.views.defaults.server_error() です。独自のビューを実装する場合は、request 引数を受け取り、 HttpResponseServerError を返すことを確認してください。

\n
\n
\n","rootId":"","toc":[{"title":"URLconf で使用するための django.urls 関数","anchor":"","children":[{"title":"path()","anchor":"path","children":[]},{"title":"re_path()","anchor":"re-path","children":[]},{"title":"include()","anchor":"include","children":[]},{"title":"register_converter()","anchor":"register-converter","children":[]}]},{"title":"URLconf で使用するための django.conf.urls の関数","anchor":"module-django.conf.urls","children":[{"title":"static()","anchor":"static","children":[]},{"title":"handler400","anchor":"handler400","children":[]},{"title":"handler403","anchor":"handler403","children":[]},{"title":"handler404","anchor":"handler404","children":[]},{"title":"handler500","anchor":"handler500","children":[]}]}],"breadcrumbs":[{"docname":"ref/index","title":"API リファレンス","url":"/ja/5.0/ref/"}],"prev":{"docname":"ref/urlresolvers","title":"django.urls ユーティリティ関数","url":"/ja/5.0/ref/urlresolvers/"},"next":{"docname":"ref/utils","title":"Django ユーティリティ (django.utils)","url":"/ja/5.0/ref/utils/"},"formats":{"html":"/ja/5.0/ref/urls/","markdown":"/ja/5.0/ref/urls.md","json":"/ja/5.0/ref/urls.json"},"source":"https://github.com/django/django/blob/stable/5.0.x/docs/ref/urls.txt","official":"https://docs.djangoproject.com/ja/5.0/ref/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"]}