Django は、システムを通じてステータスを渡すために、リクエストとレスポンスのオブジェクトを使います。
あるページがリクエストされたとき、Django はリクエストに関するメタデータを含んだ HttpRequest オブジェクトを生成します。それから Django は HttpRequest をビュー関数の最初の関数として渡し、適切なビューを読み込みます。あらゆるビューは HttpResponse オブジェクトを返す必要があります。
このドキュメントでは、HttpRequest と HttpResponse オブジェクトの API を説明しています。これは django.http モジュールにて定義されています。
HttpRequest オブジェクト¶特に記載がない限り、全ての属性は読み取り専用だと考えてください。
HttpRequest.scheme¶リクエストのスキームを表す文字列です (通常は http か https)。
HttpRequest.body¶The raw HTTP request body as a byte string. 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.
また、ファイルライクなインターフェイスを使った HttpRequest を読み出すこともできます。HttpRequest.read() を参照してください。
HttpRequest.path¶リクエストされたページへのフルパスを表す文字列です。スキーマやドメインは含みません。
例: "/music/bands/the_beatles/"
HttpRequest.path_info¶Under some Web server configurations, the portion of the URL after the
host name is split up into a script prefix portion and a path info
portion. The path_info attribute always contains the path info portion
of the path, no matter what Web server is being used. Using this instead
of path can make your code easier to move between
test and deployment servers.
For example, if the WSGIScriptAlias for your application is set to
"/minfo", then path might be "/minfo/music/bands/the_beatles/"
and path_info would be "/music/bands/the_beatles/".
HttpRequest.method¶リクエスト内で使われている HTTP メソッドを表す文字列です。必ず大文字です。例は以下の通りです:
if request.method == 'GET':
do_something()
elif request.method == 'POST':
do_something_else()
HttpRequest.encoding¶フォームが送信したデータをデコードするために使われる、現在の文字コードを表す文字列です。(もしくは None で、これは:setting:DEFAULT_CHARSET 設定が使われることを意味します)。フォームデータにアクセスするときに使われる文字コードを変更するために、この属性に書き込むことができます。この後の属性アクセス (GET や POST からの読み出しなど)は新しい encoding 値を使います。フォームデータが DEFAULT_CHARSET の文字コードにないことが明らかなときに役立ちます。
HttpRequest.content_type¶リクエストの MIME タイプを表す文字列です。CONTENT_TYPE から識別されます。
HttpRequest.content_params¶CONTENT_TYPE ヘッダに含まれる、キーと値のパラーメータのディクショナリです。
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 above).
Note: POST does not include file-upload information. See FILES.
HttpRequest.COOKIES¶A standard Python dictionary containing all cookies. Keys and values are strings.
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 Managing files for more information.
Note that 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 ヘッダを含む、標準の Python ディクショナリです。利用可能なヘッダはクライアントとサーバによって異なりますが、以下はその主な例です:
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.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 doesn’t set these attributes itself but makes use of them if set by your application.
HttpRequest.current_app¶The url template tag will use its value as the current_app
argument to reverse().
HttpRequest.urlconf¶This will be used as the root URLconf for the current request, overriding
the ROOT_URLCONF setting. See
How Django processes a request for details.
urlconf can be set to None to revert any changes made by previous
middleware and return to using the ROOT_URLCONF.
Setting urlconf=None raised
ImproperlyConfigured in older versions.
Some of the middleware included in Django’s contrib apps set attributes on the
request. If you don’t see the attribute on a request, be sure the appropriate
middleware class is listed in MIDDLEWARE.
HttpRequest.session¶From the SessionMiddleware: A
readable and writable, dictionary-like object that represents the current
session.
HttpRequest.site¶From the CurrentSiteMiddleware:
An instance of Site or
RequestSite as returned by
get_current_site()
representing the 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"
注釈
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:
from django.utils.deprecation import MiddlewareMixin
class MultipleProxyMiddleware(MiddlewareMixin):
FORWARDED_FOR_FIELDS = [
'HTTP_X_FORWARDED_FOR',
'HTTP_X_FORWARDED_HOST',
'HTTP_X_FORWARDED_SERVER',
]
def process_request(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()
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.build_absolute_uri(location)[ソース]¶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.
Example: "https://example.com/music/bands/the_beatles/?print=true"
注釈
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.
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.
For example:
>>> 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('non-existing-cookie')
...
KeyError: 'non-existing-cookie'
>>> request.get_signed_cookie('non-existing-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.is_ajax()[ソース]¶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.__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 オブジェクト¶HttpRequest オブジェクトの中で、GET や POST 属性は django.http.QueryDict のインスタンスで、同じキーに対する複数の値を解決するためにカスタマイズされた、ディクショナリライクのクラスです。HTML のフォーム、特に notably <select multiple> は、同一のキーで複数の値を渡すことがあるため、このクラスが必要となります。
request.POST や request.GET 上の QueryDict通常のリクエスト・レスポンスのサイクルでアクセスしたときには不変です。変更可能なものを取得するには .copy() を使う必要があります。
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 空となります (何のキーや値も持ちません)。
Most QueryDicts you encounter, and in particular those at
request.POST and request.GET, will be immutable. If you are
instantiating one yourself, you can make it mutable by passing
mutable=True to its __init__().
Strings for setting both keys and values will be converted from encoding
to unicode. If encoding is not set, it defaults to DEFAULT_CHARSET.
QueryDict.__getitem__(key)¶Returns the value for the given key. If the key has more than one value,
__getitem__() returns the last value. Raises
django.utils.datastructures.MultiValueDictKeyError if the key does not
exist. (This is a subclass of Python’s standard KeyError, so you can
stick to catching KeyError.)
QueryDict.__setitem__(key, value)[ソース]¶Sets the given key to [value] (a Python list whose single element is
value). Note that this, as other dictionary functions that have side
effects, can only be called on a mutable QueryDict (such as one that
was created via copy()).
QueryDict.__contains__(key)¶Returns True if the given key is set. This lets you do, e.g., if "foo"
in request.GET.
QueryDict.get(key, default=None)¶Uses the same logic as __getitem__() above, with a hook for returning a
default value if the key doesn’t exist.
QueryDict.setdefault(key, default=None)[ソース]¶Just like the standard dictionary setdefault() method, except it uses
__setitem__() internally.
QueryDict.update(other_dict)¶Takes either a QueryDict or standard dictionary. Just like the standard
dictionary update() method, except it appends to the current
dictionary items rather than replacing them. For example:
>>> q = QueryDict('a=1', mutable=True)
>>> q.update({'a': '2'})
>>> q.getlist('a')
['1', '2']
>>> q['a'] # returns the last
'2'
QueryDict.items()¶Just like the standard dictionary items() method, except this uses the
same last-value logic as __getitem__(). For example:
>>> q = QueryDict('a=1&a=2&a=3')
>>> q.items()
[('a', '3')]
QueryDict.iteritems()¶Just like the standard dictionary iteritems() method. Like
QueryDict.items() this uses the same last-value logic as
QueryDict.__getitem__().
Python 2 のみで使えます。
QueryDict.iterlists()¶Like QueryDict.iteritems() except it includes all values, as a list,
for each member of the dictionary.
Python 2 のみで使えます。
QueryDict.values()¶Just like the standard dictionary values() method, except this uses the
same last-value logic as __getitem__(). For example:
>>> q = QueryDict('a=1&a=2&a=3')
>>> q.values()
['3']
QueryDict.itervalues()¶Just like QueryDict.values(), except an iterator.
Python 2 のみで使えます。
In addition, QueryDict has the following methods:
QueryDict.copy()[ソース]¶Returns a copy of the object, using copy.deepcopy() from the Python
standard library. This copy will be mutable even if the original was not.
QueryDict.getlist(key, default=None)¶Returns the data with the requested key, as a Python list. Returns an empty list if the key doesn’t exist and no default value was provided. It’s guaranteed to return a list of some sort unless the default value provided is not a list.
QueryDict.setlistdefault(key, default_list=None)[ソース]¶Just 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 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 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. Example:
>>> q = QueryDict('a=2&b=3&b=5')
>>> q.urlencode()
'a=2&b=3&b=5'
Optionally, urlencode can be passed characters which do not require encoding. For example:
>>> q = QueryDict(mutable=True)
>>> q['next'] = '/a&b/'
>>> q.urlencode(safe='/')
'next=/a%26b/'
HttpResponse オブジェクト¶Django によって自動的に生成される HttpRequest オブジェクトとは対照的に、HttpResponse オブジェクトはプログラマが作成するものです。プログラム内に記述されるあらゆるビューは、HttpResponse をインスタンス化し、データを格納して返す必要があります。
HttpResponse クラスは django.http モジュール内に存在します。
一般的な使い方は、HttpResponse コンストラクタに、文字列として、ページの内容を引き渡すことです:
>>> 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 をファイルライクなオブジェクトとして使うことができます:
>>> response = HttpResponse()
>>> response.write("<p>Here's the text of the Web page.</p>")
>>> response.write("<p>Here's another paragraph.</p>")
最後に、HttpResponse に文字列ではなくイテレータを引き渡すことができます。HttpResponse はイテレータをただちに消費し、その内容を文字列と保持してから破棄します。close() メソッドで、ファイルやジェネレータのようなオブジェクト即座に閉じられます。
レスポンスに対して、イテレータからクライアントにストリーミングさせる必要がある場合には、代わりに StreamingHttpResponse クラスを使う必要があります。
close() メソッドを持つオブジェクトは、かつては WSGI サーバーがレスポンス上で close() を呼んだときに閉じられていました。
レスポンス上でヘッダーフィールドをセットしたり削除するためには、ディクショナリのように扱ってください:
>>> response = HttpResponse()
>>> response['Age'] = 120
>>> del response['Age']
ディクショナリとは異なり、ヘッダーフィールドが存在しないときでも del が KeyError を投げない点に注意してください。
For setting the Cache-Control and Vary header fields, it is recommended
to use the patch_cache_control() and
patch_vary_headers() methods from
django.utils.cache, since these fields can have multiple, comma-separated
values. The “patch” methods ensure that other values, e.g. added by a
middleware, are not removed.
HTTP header fields cannot contain newlines. An attempt to set a header field
containing a newline character (CR or LF) will raise BadHeaderError
To tell the browser to treat the response as a file attachment, use the
content_type argument and set the Content-Disposition header. For example,
this is how you might return a Microsoft Excel spreadsheet:
>>> response = HttpResponse(my_data, content_type='application/vnd.ms-excel')
>>> response['Content-Disposition'] = 'attachment; filename="foo.xls"'
There’s nothing Django-specific about the Content-Disposition header, but
it’s easy to forget the syntax, so we’ve included it here.
HttpResponse.content¶内容を表すバイト文字列で、必要に応じて Unicode オブジェクトからエンコードされます。
HttpResponse.charset¶応答がエンコードされる文字セットを示す文字列です。 HttpResponse のインスタンス化の際に指定されなかった場合、content_type から抽出され、もしこれが失敗した場合は、DEFAULT_CHARSET 設定が使用されます。
HttpResponse.status_code¶レスポンスの HTTP status code です。
reason_phrase が明示的にセットされていない限り、コンストラクタの外で status_code の値を変更すると``reason_phrase`` の値も変更されます。
HttpResponse.reason_phrase¶レスポンスの HTTP Reason-Phrase です。
``reason_phrase``は、これからはデフォルトでは大文字ではありません。 現在は rfc:HTTP standard’s <7231#section-6.1> デフォルトの Reason-Phrase を使用しています。
明示的にセットされない限り、reason_phrase は status_code の現在の値によって決まります。
HttpResponse.streaming¶これは常に False です。
この属性は、ミドルウェアが通常のレスポンスとは違う形でストリーミングレスポンスを扱えるようにするために存在しています。
HttpResponse.closed¶レスポンスが閉じられた場合、True となります。
HttpResponse.__init__(content='', content_type=None, status=200, reason=None, charset=None)[ソース]¶Instantiates an HttpResponse object with the given page content and
content type.
content should be an iterator or a string. If it’s an
iterator, it should return strings, and those strings will be
joined together to form the content of the response. If it is not
an iterator or a string, it will be converted to a string when
accessed.
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 the DEFAULT_CONTENT_TYPE and
DEFAULT_CHARSET settings, by default: “text/html; charset=utf-8”.
status is the HTTP status code for the response.
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.
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.has_header(header)¶Returns True or False based on a case-insensitive check for a
header with the given name.
HttpResponse.setdefault(header, value)¶Sets a header unless it has already been set.
Sets a cookie. The parameters are the same as in the
Morsel cookie object in the Python standard library.
max_age should be a 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=".lawrence.com" will set a cookie that is readable by
the domains www.lawrence.com, blogs.lawrence.com and
calendars.lawrence.com. Otherwise, a cookie will only be readable by
the domain that set it.
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 is not part of the RFC 2109 standard for cookies, and it isn’t honored consistently by all browsers. However, when it is honored, it can be a useful way to mitigate the risk of a client-side script from accessing the protected cookie data.
警告
Both RFC 2109 and RFC 6265 state 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.
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.
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.
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.
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).
HttpResponsePermanentRedirect[ソース]¶Like HttpResponseRedirect, but it returns a permanent redirect
(HTTP status code 301) instead of a “found” redirect (status code 302).
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).
HttpResponseBadRequest[ソース]¶Acts just like HttpResponse but uses a 400 status code.
HttpResponseNotFound[ソース]¶Acts just like HttpResponse but uses a 404 status code.
HttpResponseForbidden[ソース]¶Acts just like HttpResponse but uses a 403 status code.
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']).
HttpResponseGone[ソース]¶Acts just like HttpResponse but uses a 410 status code.
HttpResponseServerError[ソース]¶Acts just like HttpResponse but uses a 500 status code.
注釈
If a custom subclass of HttpResponse implements a render
method, Django will treat it as emulating a
SimpleTemplateResponse, and the
render method must itself return a valid response object.
JsonResponse objects¶JsonResponse(data, encoder=DjangoJSONEncoder, safe=True, json_dumps_params=None, **kwargs)[ソース]¶An HttpResponse subclass that helps to create a JSON-encoded
response. It inherits most behavior from its superclass with a couple
differences:
Its default Content-Type header is set to application/json.
The first parameter, data, should be a dict instance. If the
safe parameter is set to False (see below) it can be any
JSON-serializable object.
The encoder, which defaults to
django.core.serializers.json.DjangoJSONEncoder, will be used to
serialize the data. See JSON serialization for more details about this serializer.
The safe boolean parameter defaults to True. If it’s set to
False, any object can be passed for serialization (otherwise only
dict instances are allowed). If safe is True and a non-dict
object is passed as the first argument, a TypeError will be raised.
The json_dumps_params parameter is a dictionary of keyword arguments
to pass to the json.dumps() call used to generate the response.
The json_dumps_params argument was added.
Typical usage could look like:
>>> from django.http import JsonResponse
>>> response = JsonResponse({'foo': 'bar'})
>>> response.content
b'{"foo": "bar"}'
In order to serialize objects other than dict you must set the safe
parameter to False:
>>> response = JsonResponse([1, 2, 3], safe=False)
Without passing safe=False, a TypeError will be raised.
警告
Before the 5th edition of ECMAScript
it was possible to poison the JavaScript Array constructor. For this
reason, Django does not allow passing non-dict objects to the
JsonResponse constructor by default. However, most
modern browsers implement EcmaScript 5 which removes this attack vector.
Therefore it is possible to disable this security precaution.
If you need to use a different JSON encoder class you can pass the encoder
parameter to the constructor method:
>>> response = JsonResponse(data, encoder=MyJSONEncoder)
StreamingHttpResponse objects¶The StreamingHttpResponse class is used to stream a response from
Django to the browser. You might want to do this if generating the response
takes too long or uses too much memory. For instance, it’s useful for
generating large CSV files.
Performance considerations
Django is designed for short-lived requests. Streaming responses will tie a worker process for the entire duration of the response. This may result in poor performance.
Generally speaking, you should perform expensive tasks outside of the request-response cycle, rather than resorting to a streamed response.
The StreamingHttpResponse is not a subclass of HttpResponse,
because it features a slightly different API. However, it is almost identical,
with the following notable differences:
content attribute. Instead, it has a
streaming_content attribute.tell() or write() methods.
Doing so will raise an exception.StreamingHttpResponse should only be used in situations where it is
absolutely required that the whole content isn’t iterated before transferring
the data to the client. Because the content can’t be accessed, many
middlewares can’t function normally. For example the ETag and
Content-Length headers can’t be generated for streaming responses.
StreamingHttpResponse.streaming_content¶An iterator of strings representing the content.
StreamingHttpResponse.status_code¶レスポンスの HTTP status code です。
reason_phrase が明示的にセットされていない限り、コンストラクタの外で status_code の値を変更すると``reason_phrase`` の値も変更されます。
StreamingHttpResponse.reason_phrase¶レスポンスの HTTP Reason-Phrase です。
``reason_phrase``は、これからはデフォルトでは大文字ではありません。 現在は rfc:HTTP standard’s <7231#section-6.1> デフォルトの Reason-Phrase を使用しています。
明示的にセットされない限り、reason_phrase は status_code の現在の値によって決まります。
StreamingHttpResponse.streaming¶This is always True.
FileResponse objects¶FileResponse is a subclass of StreamingHttpResponse optimized
for binary files. It uses wsgi.file_wrapper if provided by the wsgi server,
otherwise it streams the file out in small chunks.
FileResponse expects a file open in binary mode like so:
>>> from django.http import FileResponse
>>> response = FileResponse(open('myfile.png', 'rb'))
4月 04, 2017