Django urls.ResolverMatch.route 属性に関する参考資料

Django の urls.ResolverMatch.route 属性について

django.urls.ResolverMatch.route 属性は、Django URL 解決処理において、リクエストされた URL と一致した URL パターンに関連付けられたルートを取得するために使用されます。ルートは、URL パターン定義時に name 引数で指定された名前です。

詳細

• urls.ResolverMatch オブジェクトは、URL 解決処理の結果として生成されます。このオブジェクトには、リクエストされた URL と一致した URL パターンに関する情報が含まれています。
• route 属性は、urls.ResolverMatch オブジェクトの読み取り専用属性です。この属性は、str 型の値を返します。
• 返される値は、URL パターン定義時に name 引数で指定された名前です。
• ルート名は、URL リバース機能で使用されます。URL リバース機能は、名前と引数に基づいて URL を生成するために使用されます。

例

以下の例は、urls.ResolverMatch.route 属性の使用方法を示しています。

# urls.py

urlpatterns = [
    path('admin/', admin.site.urls),
    path('blog/', include('blog.urls')),
]

# views.py

def home_view(request):
    # リクエストされた URL と一致した URL パターンを取得
    resolver_match = request.resolver_match

    # URL パターンに関連付けられたルート名を取得
    route_name = resolver_match.route

    # ルート名を使用して、別の URL を生成
    url = reverse(route_name, args=['argument1', 'argument2'])

    return HttpResponse(f'The route name is: {route_name}, the generated URL is: {url}')

この例では、home_view 関数は、request.resolver_match 属性を使用して、リクエストされた URL と一致した URL パターンを取得します。次に、route 属性を使用して、URL パターンに関連付けられたルート名を取得します。最後に、ルート名を使用して、別の URL を生成します。

補足

• urls.ResolverMatch.route 属性は、Django 2.0 以降で利用可能です。
• Django 1.x では、urls.ResolverMatch.url_name 属性を使用していました。

Django の urls.ResolverMatch.route 属性を使用したサンプルコード

# urls.py

urlpatterns = [
    path('admin/', admin.site.urls),
    path('blog/', include('blog.urls', namespace='blog')),
    path('about/', views.about_view, name='about'),
]

この例では、以下の URL パターンとルート名を定義しています。

• /admin/: Django 管理画面
• /blog/: ブログアプリ
• /about/: about ページ

ルート名の取得

# views.py

def home_view(request):
    # リクエストされた URL と一致した URL パターンを取得
    resolver_match = request.resolver_match

    # URL パターンに関連付けられたルート名を取得
    route_name = resolver_match.route

    return HttpResponse(f'The route name is: {route_name}')

このコードは、リクエストされた URL と一致した URL パターンのルート名を取得して、それを表示します。

URL リバース機能による URL 生成

# views.py

def detail_view(request, pk):
    # URL パターンに関連付けられたルート名を使用して、別の URL を生成
    url = reverse('blog:post_detail', args=[pk])

    return HttpResponseRedirect(url)

このコードは、blog:post_detail というルート名を使用して、post_detail ビューにアクセスするための URL を生成します。

名前空間を使用したルート名の取得

# views.py

def blog_home_view(request):
    # 名前空間を使用して、ルート名を取得
    route_name = 'blog:home'

    # ルート名を使用して、別の URL を生成
    url = reverse(route_name)

    return HttpResponse(f'The generated URL is: {url}')

このコードは、blog という名前空間を使用して、blog:home というルート名を取得し、それを利用して別の URL を生成します。

その他のサンプル

• 複数の URL パターンに同じルート名を割り当てることもできます。
• ルート名をテンプレートで使用することもできます。

これらのサンプルコードは、urls.ResolverMatch.route 属性の使用方法を理解するための参考として役立ちます。

Django で URL とビューを関連付ける他の方法

パス名

path() 関数を使用して URL パターンを定義する際に、name 引数でパス名を指定することができます。パス名は、URL リバース機能で使用されます。

# urls.py

urlpatterns = [
    path('admin/', admin.site.urls),
    path('blog/', include('blog.urls')),
    path('about/', views.about_view, name='about'),
]

この例では、about/ という URL パターンに about というパス名を指定しています。

名前空間

include() 関数を使用して URLconf をインクルードする際に、namespace 引数で名前空間を指定することができます。名前空間は、ルート名をユニークにするために使用されます。

# urls.py

urlpatterns = [
    path('admin/', admin.site.urls),
    path('blog/', include('blog.urls', namespace='blog')),
]

この例では、blog アプリの URLconf を blog という名前空間でインクルードしています。

デフォルト引数

path() 関数を使用して URL パターンを定義する際に、kwargs 引数でデフォルト引数を指定することができます。デフォルト引数は、URL パターンに一致する URL がない場合に、ビューに渡されます。

# urls.py

urlpatterns = [
    path('admin/', admin.site.urls),
    path('blog/<int:pk>/', views.post_detail_view, name='post_detail'),
]

この例では、blog/<int:pk>/ という URL パターンに pk という名前のデフォルト引数を指定しています。このデフォルト引数は、post_detail_view ビューに渡されます。

これらの方法は、urls.ResolverMatch.route 属性を使用するよりも簡潔な場合があり、状況に応じて使い分けることができます。