Django の http.QueryDict.get() メソッドのサンプルコード

Django の http.QueryDict.get() メソッドは、URL クエリ文字列から指定されたキーの値を取得するために使用されます。これは、GET または POST リクエストで送信されたデータにアクセスする便利な方法です。

使い方

get() メソッドは、次の形式で使用されます。

value = request.GET.get(key, default=None)

• request は、現在のリクエストを表す HttpRequest オブジェクトです。
• GET は、リクエストのクエリ文字列を表す QueryDict オブジェクトです。
• key は、取得したい値のキーです。
• default は、キーが存在しない場合に返される値です。デフォルト値を指定しない場合は、None が返されます。

例

次の例では、URL クエリ文字列から name パラメータの値を取得しています。

def my_view(request):
    name = request.GET.get('name')
    return HttpResponse('Hello, {}!'.format(name))

その他のメソッド

get() メソッドに加えて、QueryDict オブジェクトには、以下のメソッドも用意されています。

• getlist(key): キーに関連付けられたすべての値を取得します。
• get_int(key, default=None): キーの値を整数に変換して返します。

補足

• QueryDict オブジェクトは、キーと値のペアの順序を保持しません。
• キーが存在しない場合、get() メソッドは None を返します。
• デフォルト値を指定することで、キーが存在しない場合に別の値を返すことができます。
• getlist() メソッドは、キーに複数の値が関連付けられている場合に役立ちます。
• get_int(), get_float(), get_bool() メソッドは、データ型変換を安全に行うために使用できます。

Django の http.QueryDict.get() メソッドのサンプルコード

def my_view(request):
    # URL クエリ文字列から "name" パラメータの値を取得
    name = request.GET.get('name')

    # 取得した値を使用して処理を行う
    if name:
        return HttpResponse('Hello, {}!'.format(name))
    else:
        return HttpResponse('No name provided.')

URL クエリ文字列から複数の値を取得する

def my_view(request):
    # URL クエリ文字列から "colors" パラメータの値を取得
    colors = request.GET.getlist('colors')

    # 取得した値を使用して処理を行う
    if colors:
        return HttpResponse('Your favorite colors are: {}'.format(', '.join(colors)))
    else:
        return HttpResponse('No colors provided.')

URL クエリ文字列から値を取得し、データ型変換を行う

def my_view(request):
    # URL クエリ文字列から "age" パラメータの値を取得
    age_str = request.GET.get('age')

    # 取得した値を整数に変換
    try:
        age = int(age_str)
    except ValueError:
        return HttpResponse('Invalid age provided.')

    # 変換した値を使用して処理を行う
    if age:
        return HttpResponse('You are {} years old.'.format(age))
    else:
        return HttpResponse('No age provided.')

キーが存在しない場合のデフォルト値

def my_view(request):
    # URL クエリ文字列から "country" パラメータの値を取得
    # キーが存在しない場合は "Unknown" を返す
    country = request.GET.get('country', default='Unknown')

    # 取得した値を使用して処理を行う
    return HttpResponse('You are from {}.'.format(country))

get_int(), get_float(), get_bool() メソッドの使用

def my_view(request):
    # URL クエリ文字列から "score" パラメータの値を取得
    # 存在しない場合は 0 を返す
    score = request.GET.get_int('score', default=0)

    # URL クエリ文字列から "price" パラメータの値を取得
    # 存在しない場合は None を返す
    price = request.GET.get_float('price', default=None)

    # URL クエリ文字列から "active" パラメータの値を取得
    # 存在しない場合は False を返す
    active = request.GET.get_bool('active', default=False)

    # 取得した値を使用して処理を行う
    ...

Django で URL クエリ文字列から値を取得する他の方法

request.META['QUERY_STRING'] は、URL のクエリ文字列全体を取得します。この方法を使用して、独自の処理でクエリ文字列を解析することができます。

例

def my_view(request):
    query_string = request.META['QUERY_STRING']
    # クエリ文字列を解析...

urlparse モジュール

Python 標準ライブラリの urlparse モジュールを使用して、URL を解析し、クエリ文字列から値を取得することができます。

例

from urllib.parse import urlparse

def my_view(request):
    url = request.build_absolute_uri()
    parsed_url = urlparse(url)
    query_params = parse_qs(parsed_url.query)
    # クエリパラメータから値を取得...

qs_parser モジュール

Django の django.utils.http モジュールにある qs_parser モジュールを使用して、クエリ文字列を解析し、値を取得することができます。

例

from django.utils.http import qs_parser

def my_view(request):
    query_string = request.META['QUERY_STRING']
    params = qs_parser.parse_qs(query_string)
    # クエリパラメータから値を取得...