リクエストとレスポンスのオブジェクト¶

属性¶

特に記載がない限り、全ての属性は読み取り専用だと考えてください。

HttpRequest.scheme¶

リクエストのスキームを表す文字列です (通常は http か https)。

HttpRequest.body¶

The raw HTTP request body as a bytestring. This is useful for processing data in different ways than conventional HTML forms: binary images, XML payload etc. For processing conventional form data, use HttpRequest.POST.

You can also read from an HttpRequest using a file-like interface with HttpRequest.read() or HttpRequest.readline(). Accessing the body attribute after reading the request with either of these I/O stream methods will produce a RawPostDataException.

HttpRequest.path¶

A string representing the full path to the requested page, not including the scheme, domain, or query string.

例: "/music/bands/the_beatles/"

HttpRequest.path_info¶

ウェブサーバーの設定によっては、ホスト名の後ろの URL の部分が、スクリプト接頭辞部分とパス情報部分に分離されることがあります。path_info 属性には、どんなウェブサーバを使用していても常に、パスのパス情報部分が含まれます。path ではなくこの属性を使用することで、テストサーバとデプロイサーバ間の移動で問題が起こりにくいコードになります。

たとえば、アプリケーションの WSGIScriptAlias が "/minfo" に設定されている場合、path が "/minfo/music/bands/the_beatles/" である一方、path_info は "/music/bands/the_beatles/" となる可能性があります。

HttpRequest.method¶

リクエストで使用された HTTP メソッドを表す文字列です。この値は常に大文字となることが保証されています。たとえば、次のようになります。

if request.method == 'GET':
    do_something()
elif request.method == 'POST':
    do_something_else()

HttpRequest.encoding¶

A string representing the current encoding used to decode form submission data (or None, which means the DEFAULT_CHARSET setting is used). You can write to this attribute to change the encoding used when accessing the form data. Any subsequent attribute accesses (such as reading from GET or POST) will use the new encoding value. Useful if you know the form data is not in the DEFAULT_CHARSET encoding.

HttpRequest.content_type¶

リクエストの MIME タイプを表す文字列です。CONTENT_TYPE から識別されます。

HttpRequest.content_params¶

CONTENT_TYPE ヘッダに含まれる、キーと値のパラーメータのディクショナリです。

HttpRequest.GET¶

渡された HTTP GET パラメータを含む、ディクショナリライクのオブジェクトです。後述の QueryDict のドキュメントを参照してください。

HttpRequest.POST¶

A dictionary-like object containing all given HTTP POST parameters, providing that the request contains form data. See the QueryDict documentation below. If you need to access raw or non-form data posted in the request, access this through the HttpRequest.body attribute instead.

It's possible that a request can come in via POST with an empty POST dictionary -- if, say, a form is requested via the POST HTTP method but does not include form data. Therefore, you shouldn't use if request.POST to check for use of the POST method; instead, use if request.method == "POST" (see HttpRequest.method).

POST には file-upload の情報が含まれ ません 。詳しくは FILES をご覧ください。

HttpRequest.COOKIES¶

すべてのクッキーが格納されたディクショナリです。キーと値は文字列です。

HttpRequest.FILES¶

A dictionary-like object containing all uploaded files. Each key in FILES is the name from the <input type="file" name="">. Each value in FILES is an UploadedFile.

See ファイルの管理 for more information.

FILES will only contain data if the request method was POST and the <form> that posted to the request had enctype="multipart/form-data". Otherwise, FILES will be a blank dictionary-like object.

HttpRequest.META¶

利用できるすべての HTTP ヘッダーが格納されたディクショナリです。利用可能なヘッダーはクライアントとサーバーによって異なりますが、以下に例を示します。

• CONTENT_LENGTH -- リクエスト本文の (文字列としての) 長さです。
• CONTENT_TYPE -- リクエスト本文の MIME タイプです。
• HTTP_ACCEPT -- レスポンスに対して受け入れ可能なコンテンツのタイプです。
• HTTP_ACCEPT_ENCODING -- レスポンスに対して受け入れ可能なエンコーディングです。
• HTTP_ACCEPT_LANGUAGE -- レスポンスに対して受け入れ可能な言語です。
• HTTP_HOST -- クライアントによって送信された HTTP Host ヘッダです。
• HTTP_REFERER -- (存在する場合) リファラページです。
• HTTP_USER_AGENT -- クライアントのユーザエージェント文字列です。
• QUERY_STRING -- クエリ文字列で、単一の (未解析の) 文字列です。
• REMOTE_ADDR -- クライアントの IP アドレスです。
• REMOTE_HOST -- クライアントのホスト名です。
• REMOTE_USER -- (存在する場合) Web サーバによって認証されたユーザです。
• REQUEST_METHOD -- "GET" や "POST" といったです。
• SERVER_NAME -- サーバのホスト名です。
• SERVER_PORT -- (文字列としての) サーバのポートです。

With the exception of CONTENT_LENGTH and CONTENT_TYPE, as given above, any HTTP headers in the request are converted to META keys by converting all characters to uppercase, replacing any hyphens with underscores and adding an HTTP_ prefix to the name. So, for example, a header called X-Bender would be mapped to the META key HTTP_X_BENDER.

Note that runserver strips all headers with underscores in the name, so you won't see them in META. This prevents header-spoofing based on ambiguity between underscores and dashes both being normalizing to underscores in WSGI environment variables. It matches the behavior of Web servers like Nginx and Apache 2.4+.

HttpRequest.headers is a simpler way to access all HTTP-prefixed headers, plus CONTENT_LENGTH and CONTENT_TYPE.

HttpRequest.headers¶

A case insensitive, dict-like object that provides access to all HTTP-prefixed headers (plus Content-Length and Content-Type) from the request.

The name of each header is stylized with title-casing (e.g. User-Agent) when it's displayed. You can access headers case-insensitively:

>>> request.headers
{'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6', ...}

>>> 'User-Agent' in request.headers
True
>>> 'user-agent' in request.headers
True

>>> request.headers['User-Agent']
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6)
>>> request.headers['user-agent']
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6)

>>> request.headers.get('User-Agent')
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6)
>>> request.headers.get('user-agent')
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6)

For use in, for example, Django templates, headers can also be looked up using underscores in place of hyphens:

{{ request.headers.user_agent }}

HttpRequest.resolver_match¶

An instance of ResolverMatch representing the resolved URL. This attribute is only set after URL resolving took place, which means it's available in all views but not in middleware which are executed before URL resolving takes place (you can use it in process_view() though).

アプリケーションコードがセットする属性¶

Django はこれらの属性を自分で設定することはありませんが、アプリケーション側で設定された場合にはその値を利用します。

HttpRequest.current_app¶

url テンプレートタグは、その値を reverse() の current_app 引数に使います。

HttpRequest.urlconf¶

この値は、現在のリクエストに対する root URLconf として使用され、設定の ROOT_URLCONF を上書きします。詳しくは Django のリクエスト処理 をご覧ください。

urlconf は None に設定することで、それまでにミドルウェアで行われた変更を取り消し、元の ROOT_URLCONF を使用するようにできます。

HttpRequest.exception_reporter_filter¶

This will be used instead of DEFAULT_EXCEPTION_REPORTER_FILTER for the current request. See Custom error reports for details.

HttpRequest.exception_reporter_class¶

This will be used instead of DEFAULT_EXCEPTION_REPORTER for the current request. See Custom error reports for details.

ミドルウェアが設定する属性¶

Django の contrib アプリなどのミドルウェアの一部は、リクエストに属性を設定します。もし、リクエストに属性が設定されていない場合は、MIDDLEWARE リスト中に適切なミドルウェアが含まれているかを確認してください。

HttpRequest.session¶

SessionMiddleware は、現在のセッションを表す、読み書き可能でディクショナリライクなオブジェクトを設定します。

HttpRequest.site¶

CurrentSiteMiddleware は、現在のサイトを表す Site または RequestSite のインスタンスを、get_current_site() の返り値で設定します。

HttpRequest.user¶

From the AuthenticationMiddleware: An instance of AUTH_USER_MODEL representing the currently logged-in user. If the user isn't currently logged in, user will be set to an instance of AnonymousUser. You can tell them apart with is_authenticated, like so:

if request.user.is_authenticated:
    ... # Do something for logged-in users.
else:
    ... # Do something for anonymous users.

メソッド¶

HttpRequest.get_host()¶

Returns the originating host of the request using information from the HTTP_X_FORWARDED_HOST (if USE_X_FORWARDED_HOST is enabled) and HTTP_HOST headers, in that order. If they don't provide a value, the method uses a combination of SERVER_NAME and SERVER_PORT as detailed in PEP 3333.

Example: "127.0.0.1:8000"

Raises django.core.exceptions.DisallowedHost if the host is not in ALLOWED_HOSTS or the domain name is invalid according to RFC 1034/1035.

注釈

The get_host() method fails when the host is behind multiple proxies. One solution is to use middleware to rewrite the proxy headers, as in the following example:

class MultipleProxyMiddleware:
    FORWARDED_FOR_FIELDS = [
        'HTTP_X_FORWARDED_FOR',
        'HTTP_X_FORWARDED_HOST',
        'HTTP_X_FORWARDED_SERVER',
    ]

    def __init__(self, get_response):
        self.get_response = get_response

    def __call__(self, request):
        """
        Rewrites the proxy headers so that only the most
        recent proxy is used.
        """
        for field in self.FORWARDED_FOR_FIELDS:
            if field in request.META:
                if ',' in request.META[field]:
                    parts = request.META[field].split(',')
                    request.META[field] = parts[-1].strip()
        return self.get_response(request)

This middleware should be positioned before any other middleware that relies on the value of get_host() -- for instance, CommonMiddleware or CsrfViewMiddleware.

HttpRequest.get_port()¶

Returns the originating port of the request using information from the HTTP_X_FORWARDED_PORT (if USE_X_FORWARDED_PORT is enabled) and SERVER_PORT META variables, in that order.

HttpRequest.get_full_path()¶

Returns the path, plus an appended query string, if applicable.

Example: "/music/bands/the_beatles/?print=true"

HttpRequest.get_full_path_info()¶

Like get_full_path(), but uses path_info instead of path.

Example: "/minfo/music/bands/the_beatles/?print=true"

HttpRequest.build_absolute_uri(location=None)¶

Returns the absolute URI form of location. If no location is provided, the location will be set to request.get_full_path().

If the location is already an absolute URI, it will not be altered. Otherwise the absolute URI is built using the server variables available in this request. For example:

>>> request.build_absolute_uri()
'https://example.com/music/bands/the_beatles/?print=true'
>>> request.build_absolute_uri('/bands/')
'https://example.com/bands/'
>>> request.build_absolute_uri('https://example2.com/bands/')
'https://example2.com/bands/'

注釈

Mixing HTTP and HTTPS on the same site is discouraged, therefore build_absolute_uri() will always generate an absolute URI with the same scheme the current request has. If you need to redirect users to HTTPS, it's best to let your Web server redirect all HTTP traffic to HTTPS.

HttpRequest.get_signed_cookie(key, default=RAISE_ERROR, salt='', max_age=None)¶

Returns a cookie value for a signed cookie, or raises a django.core.signing.BadSignature exception if the signature is no longer valid. If you provide the default argument the exception will be suppressed and that default value will be returned instead.

The optional salt argument can be used to provide extra protection against brute force attacks on your secret key. If supplied, the max_age argument will be checked against the signed timestamp attached to the cookie value to ensure the cookie is not older than max_age seconds.

例:

>>> request.get_signed_cookie('name')
'Tony'
>>> request.get_signed_cookie('name', salt='name-salt')
'Tony' # assuming cookie was set using the same salt
>>> request.get_signed_cookie('nonexistent-cookie')
...
KeyError: 'nonexistent-cookie'
>>> request.get_signed_cookie('nonexistent-cookie', False)
False
>>> request.get_signed_cookie('cookie-that-was-tampered-with')
...
BadSignature: ...
>>> request.get_signed_cookie('name', max_age=60)
...
SignatureExpired: Signature age 1677.3839159 > 60 seconds
>>> request.get_signed_cookie('name', False, max_age=60)
False

See cryptographic signing for more information.

HttpRequest.is_secure()¶

Returns True if the request is secure; that is, if it was made with HTTPS.

HttpRequest.accepts(mime_type)¶

New in Django 3.1.

Returns True if the request Accept header matches the mime_type argument:

>>> request.accepts('text/html')
True

Most browsers send Accept: */* by default, so this would return True for all content types. Setting an explicit Accept header in API requests can be useful for returning a different content type for those consumers only. See Content negotiation example of using accepts() to return different content to API consumers.

If a response varies depending on the content of the Accept header and you are using some form of caching like Django's cache middleware, you should decorate the view with vary_on_headers('Accept') so that the responses are properly cached.

HttpRequest.is_ajax()¶

バージョン 3.1 で非推奨.

Returns True if the request was made via an XMLHttpRequest, by checking the HTTP_X_REQUESTED_WITH header for the string 'XMLHttpRequest'. Most modern JavaScript libraries send this header. If you write your own XMLHttpRequest call (on the browser side), you'll have to set this header manually if you want is_ajax() to work.

If a response varies on whether or not it's requested via AJAX and you are using some form of caching like Django's cache middleware, you should decorate the view with vary_on_headers('X-Requested-With') so that the responses are properly cached.

HttpRequest.read(size=None)¶

HttpRequest.readline()¶

HttpRequest.readlines()¶

HttpRequest.__iter__()¶

Methods implementing a file-like interface for reading from an HttpRequest instance. This makes it possible to consume an incoming request in a streaming fashion. A common use-case would be to process a big XML payload with an iterative parser without constructing a whole XML tree in memory.

Given this standard interface, an HttpRequest instance can be passed directly to an XML parser such as ElementTree:

import xml.etree.ElementTree as ET
for element in ET.iterparse(request):
    process(element)

メソッド¶

QueryDict はディクショナリのサブクラスなので、標準的なディクショナリのメソッドを全て実装しています。当てはまらないのはおおむね以下の通りです:

QueryDict.__init__(query_string=None, mutable=False, encoding=None)¶

QueryDictに基づいて QueryDict オブジェクトをインスタンス化します。

>>> QueryDict('a=1&a=2&c=3')
<QueryDict: {'a': ['1', '2'], 'c': ['3']}>

query_string が渡されなかった場合は、QueryDict 空となります (何のキーや値も持ちません)。

使用する QueryDict のほとんど、特に request.POST や request.GET における場合、編集不可となっています。自分でインスタンスを生成する場合は、__init__() に mutable=True を渡すことで編集可能にできます。

キーとバリューの両方を設定するための文字列は、encoding から str に変換されます。encoding がセットされていない場合、DEFAULT_CHARSET がデフォルトとなります。

classmethod QueryDict.fromkeys(iterable, value='', mutable=False, encoding=None)¶

イテラブルと value と一致する各値から、新しい QueryDict を作成します。例えば:

>>> QueryDict.fromkeys(['a', 'a', 'b'], value='val')
<QueryDict: {'a': ['val', 'val'], 'b': ['val']}>

QueryDict.__getitem__(key)¶

指定したキーに対する値を返します。キーが複数の値を持つ場合、最後の値を返します。キーが存在しない場合は django.utils.datastructures.MultiValueDictKeyError を発生させます (これは Python の標準的な KeyError サブクラスなので、KeyError をキャッチすることに固執できます)。

QueryDict.__setitem__(key, value)¶

指定したキーを [value] (各要素が value のリスト) にセットします。 副作用を持つ他のディクショナリ関数と同様に、編集可能な QueryDict (QueryDict.copy() で作成されたものなど) のみで呼び出し可能です.

QueryDict.__contains__(key)¶

指定したキーがセットされている場合 True を返します。例えば if "foo" in request.GET を実行するのと同じです。

QueryDict.get(key, default=None)¶

__getitem__() と同じロジックを使いますが、キーが存在しない場合のデフォルト値をフックします。

QueryDict.setdefault(key, default=None)¶

Like dict.setdefault(), except it uses __setitem__() internally.

QueryDict.update(other_dict)¶

QueryDict かディクショナリを取ります。dict.update() と同様に、現在の値を置き換えるのではなく、現在の値に 追加 します。例えば:

>>> q = QueryDict('a=1', mutable=True)
>>> q.update({'a': '2'})
>>> q.getlist('a')
['1', '2']
>>> q['a'] # returns the last
'2'

QueryDict.items()¶

Like dict.items(), except this uses the same last-value logic as __getitem__() and returns an iterator object instead of a view object. For example:

>>> q = QueryDict('a=1&a=2&a=3')
>>> list(q.items())
[('a', '3')]

QueryDict.values()¶

Like dict.values(), except this uses the same last-value logic as __getitem__() and returns an iterator instead of a view object. For example:

>>> q = QueryDict('a=1&a=2&a=3')
>>> list(q.values())
['3']

加えて、QueryDict は以下のメソッドを持ちます:

QueryDict.copy()¶

Returns a copy of the object using copy.deepcopy(). This copy will be mutable even if the original was not.

QueryDict.getlist(key, default=None)¶

Returns a list of the data with the requested key. Returns an empty list if the key doesn't exist and default is None. It's guaranteed to return a list unless the default value provided isn't a list.

QueryDict.setlist(key, list_)¶

Sets the given key to list_ (unlike __setitem__()).

QueryDict.appendlist(key, item)¶

Appends an item to the internal list associated with key.

QueryDict.setlistdefault(key, default_list=None)¶

Like setdefault(), except it takes a list of values instead of a single value.

QueryDict.lists()¶

Like items(), except it includes all values, as a list, for each member of the dictionary. For example:

>>> q = QueryDict('a=1&a=2&a=3')
>>> q.lists()
[('a', ['1', '2', '3'])]

QueryDict.pop(key)¶

Returns a list of values for the given key and removes them from the dictionary. Raises KeyError if the key does not exist. For example:

>>> q = QueryDict('a=1&a=2&a=3', mutable=True)
>>> q.pop('a')
['1', '2', '3']

QueryDict.popitem()¶

Removes an arbitrary member of the dictionary (since there's no concept of ordering), and returns a two value tuple containing the key and a list of all values for the key. Raises KeyError when called on an empty dictionary. For example:

>>> q = QueryDict('a=1&a=2&a=3', mutable=True)
>>> q.popitem()
('a', ['1', '2', '3'])

QueryDict.dict()¶

Returns a dict representation of QueryDict. For every (key, list) pair in QueryDict, dict will have (key, item), where item is one element of the list, using the same logic as QueryDict.__getitem__():

>>> q = QueryDict('a=1&a=3&a=5')
>>> q.dict()
{'a': '5'}

QueryDict.urlencode(safe=None)¶

Returns a string of the data in query string format. For example:

>>> q = QueryDict('a=2&b=3&b=5')
>>> q.urlencode()
'a=2&b=3&b=5'

Use the safe parameter to pass characters which don't require encoding. For example:

>>> q = QueryDict(mutable=True)
>>> q['next'] = '/a&b/'
>>> q.urlencode(safe='/')
'next=/a%26b/'

使い方¶

>>> from django.http import HttpResponse
>>> response = HttpResponse("Here's the text of the Web page.")
>>> response = HttpResponse("Text only, please.", content_type="text/plain")
>>> response = HttpResponse(b'Bytestrings are also accepted.')
>>> response = HttpResponse(memoryview(b'Memoryview as well.'))

>>> response = HttpResponse()
>>> response.write("<p>Here's the text of the Web page.</p>")
>>> response.write("<p>Here's another paragraph.</p>")

>>> response = HttpResponse()
>>> response.headers['Age'] = 120
>>> del response.headers['Age']

>>> response = HttpResponse()
>>> response['Age'] = 120
>>> del response['Age']

>>> response = HttpResponse(headers={'Age': 120})

>>> response = HttpResponse(my_data, headers={
...     'Content-Type': 'application/vnd.ms-excel',
...     'Content-Disposition': 'attachment; filename="foo.xls"',
... })

属性¶

HttpResponse.content¶

A bytestring representing the content, encoded from a string if necessary.

HttpResponse.headers¶

New in Django 3.2.

A case insensitive, dict-like object that provides an interface to all HTTP headers on the response. See ヘッダーフィールドをセットする.

HttpResponse.charset¶

応答がエンコードされる文字セットを示す文字列です。 HttpResponse のインスタンス化の際に指定されなかった場合、 content_type から抽出され、もしこれが失敗した場合は、 DEFAULT_CHARSET 設定が使用されます。

HttpResponse.status_code¶

レスポンスの HTTP status code です。

reason_phrase が明示的にセットされていない限り、コンストラクタの外で status_code の値を変更すると``reason_phrase`` の値も変更されます。

HttpResponse.reason_phrase¶

The HTTP reason phrase for the response. It uses the HTTP standard's default reason phrases.

Unless explicitly set, reason_phrase is determined by the value of status_code.

HttpResponse.streaming¶

これは常に False です。

この属性は、ミドルウェアが通常のレスポンスとは違う形でストリーミングレスポンスを扱えるようにするために存在しています。

HttpResponse.closed¶

レスポンスが閉じられた場合、True となります。

メソッド¶

HttpResponse.__init__(content=b'', content_type=None, status=200, reason=None, charset=None, headers=None)¶

Instantiates an HttpResponse object with the given page content, content type, and headers.

content is most commonly an iterator, bytestring, memoryview, or string. Other types will be converted to a bytestring by encoding their string representation. Iterators should return strings or bytestrings and those will be joined together to form the content of the response.

content_type is the MIME type optionally completed by a character set encoding and is used to fill the HTTP Content-Type header. If not specified, it is formed by 'text/html' and the DEFAULT_CHARSET settings, by default: "text/html; charset=utf-8".

status is the HTTP status code for the response. You can use Python's http.HTTPStatus for meaningful aliases, such as HTTPStatus.NO_CONTENT.

reason is the HTTP response phrase. If not provided, a default phrase will be used.

charset is the charset in which the response will be encoded. If not given it will be extracted from content_type, and if that is unsuccessful, the DEFAULT_CHARSET setting will be used.

headers is a dict of HTTP headers for the response.

Changed in Django 3.2:

The headers parameter was added.

HttpResponse.__setitem__(header, value)¶

Sets the given header name to the given value. Both header and value should be strings.

HttpResponse.__delitem__(header)¶

Deletes the header with the given name. Fails silently if the header doesn't exist. Case-insensitive.

HttpResponse.__getitem__(header)¶

Returns the value for the given header name. Case-insensitive.

HttpResponse.get(header, alternate=None)¶

Returns the value for the given header, or an alternate if the header doesn't exist.

HttpResponse.has_header(header)¶

Returns True or False based on a case-insensitive check for a header with the given name.

HttpResponse.items()¶

Acts like dict.items() for HTTP headers on the response.

HttpResponse.setdefault(header, value)¶

Sets a header unless it has already been set.

HttpResponse.set_cookie(key, value='', max_age=None, expires=None, path='/', domain=None, secure=False, httponly=False, samesite=None)¶

Sets a cookie. The parameters are the same as in the Morsel cookie object in the Python standard library.

• max_age should be an integer number of seconds, or None (default) if the cookie should last only as long as the client's browser session. If expires is not specified, it will be calculated.

• expires should either be a string in the format "Wdy, DD-Mon-YY HH:MM:SS GMT" or a datetime.datetime object in UTC. If expires is a datetime object, the max_age will be calculated.

• Use domain if you want to set a cross-domain cookie. For example, domain="example.com" will set a cookie that is readable by the domains www.example.com, blog.example.com, etc. Otherwise, a cookie will only be readable by the domain that set it.

• Use secure=True if you want the cookie to be only sent to the server when a request is made with the https scheme.

• Use httponly=True if you want to prevent client-side JavaScript from having access to the cookie.

  HttpOnly is a flag included in a Set-Cookie HTTP response header. It's part of the RFC 6265 standard for cookies and can be a useful way to mitigate the risk of a client-side script accessing the protected cookie data.

• Use samesite='Strict' or samesite='Lax' to tell the browser not to send this cookie when performing a cross-origin request. SameSite isn't supported by all browsers, so it's not a replacement for Django's CSRF protection, but rather a defense in depth measure.

  Use samesite='None' (string) to explicitly state that this cookie is sent with all same-site and cross-site requests.

Changed in Django 3.1:

Using samesite='None' (string) was allowed.

警告

RFC 6265 states that user agents should support cookies of at least 4096 bytes. For many browsers this is also the maximum size. Django will not raise an exception if there's an attempt to store a cookie of more than 4096 bytes, but many browsers will not set the cookie correctly.

HttpResponse.set_signed_cookie(key, value, salt='', max_age=None, expires=None, path='/', domain=None, secure=False, httponly=False, samesite=None)¶

Like set_cookie(), but cryptographic signing the cookie before setting it. Use in conjunction with HttpRequest.get_signed_cookie(). You can use the optional salt argument for added key strength, but you will need to remember to pass it to the corresponding HttpRequest.get_signed_cookie() call.

Changed in Django 3.1:

Using samesite='None' (string) was allowed.

HttpResponse.delete_cookie(key, path='/', domain=None, samesite=None)¶

Deletes the cookie with the given key. Fails silently if the key doesn't exist.

Due to the way cookies work, path and domain should be the same values you used in set_cookie() -- otherwise the cookie may not be deleted.

Changed in Django 2.2.15:

The samesite argument was added.

HttpResponse.close()¶

This method is called at the end of the request directly by the WSGI server.

HttpResponse.write(content)¶

This method makes an HttpResponse instance a file-like object.

HttpResponse.flush()¶

This method makes an HttpResponse instance a file-like object.

HttpResponse.tell()¶

This method makes an HttpResponse instance a file-like object.

HttpResponse.getvalue()¶

Returns the value of HttpResponse.content. This method makes an HttpResponse instance a stream-like object.

HttpResponse.readable()¶

Always False. This method makes an HttpResponse instance a stream-like object.

HttpResponse.seekable()¶

Always False. This method makes an HttpResponse instance a stream-like object.

HttpResponse.writable()¶

Always True. This method makes an HttpResponse instance a stream-like object.

HttpResponse.writelines(lines)¶

Writes a list of lines to the response. Line separators are not added. This method makes an HttpResponse instance a stream-like object.

HttpResponse subclasses¶

Django includes a number of HttpResponse subclasses that handle different types of HTTP responses. Like HttpResponse, these subclasses live in django.http.

class HttpResponseRedirect¶

The first argument to the constructor is required -- the path to redirect to. This can be a fully qualified URL (e.g. 'https://www.yahoo.com/search/'), an absolute path with no domain (e.g. '/search/'), or even a relative path (e.g. 'search/'). In that last case, the client browser will reconstruct the full URL itself according to the current path. See HttpResponse for other optional constructor arguments. Note that this returns an HTTP status code 302.

url¶

This read-only attribute represents the URL the response will redirect to (equivalent to the Location response header).

class HttpResponsePermanentRedirect¶

Like HttpResponseRedirect, but it returns a permanent redirect (HTTP status code 301) instead of a "found" redirect (status code 302).

class HttpResponseNotModified¶

The constructor doesn't take any arguments and no content should be added to this response. Use this to designate that a page hasn't been modified since the user's last request (status code 304).

class HttpResponseBadRequest¶

Acts just like HttpResponse but uses a 400 status code.

class HttpResponseNotFound¶

Acts just like HttpResponse but uses a 404 status code.

class HttpResponseForbidden¶

Acts just like HttpResponse but uses a 403 status code.

class HttpResponseNotAllowed¶

Like HttpResponse, but uses a 405 status code. The first argument to the constructor is required: a list of permitted methods (e.g. ['GET', 'POST']).

class HttpResponseGone¶

Acts just like HttpResponse but uses a 410 status code.

class HttpResponseServerError¶

Acts just like HttpResponse but uses a 500 status code.

from http import HTTPStatus
from django.http import HttpResponse

class HttpResponseNoContent(HttpResponse):
    status_code = HTTPStatus.NO_CONTENT

使い方¶

Typical usage could look like:

>>> from django.http import JsonResponse
>>> response = JsonResponse({'foo': 'bar'})
>>> response.content
b'{"foo": "bar"}'

>>> response = JsonResponse([1, 2, 3], safe=False)

>>> response = JsonResponse(data, encoder=MyJSONEncoder)

属性¶

StreamingHttpResponse.streaming_content¶

An iterator of the response content, bytestring encoded according to HttpResponse.charset.

StreamingHttpResponse.status_code¶

レスポンスの HTTP status code です。

reason_phrase が明示的にセットされていない限り、コンストラクタの外で status_code の値を変更すると``reason_phrase`` の値も変更されます。

StreamingHttpResponse.reason_phrase¶

The HTTP reason phrase for the response. It uses the HTTP standard's default reason phrases.

Unless explicitly set, reason_phrase is determined by the value of status_code.

StreamingHttpResponse.streaming¶

This is always True.

メソッド¶

FileResponse.set_headers(open_file)¶

This method is automatically called during the response initialization and set various headers (Content-Length, Content-Type, and Content-Disposition) depending on open_file.