Obyek permintaan dan tanggapan¶
Ikhtisar cepat¶
Django menggunakan obyek permintaan dan tanggapan untuk melewatkan keadaan melalui sistem.
When a page is requested, Django creates an HttpRequest
object that
contains metadata about the request. Then Django loads the appropriate view,
passing the HttpRequest
as the first argument to the view function.
Each view is responsible for returning an HttpResponse
object.
Dokumen ini menjelaskan API untuk obyek HttpRequest
dan HttpResponse
, yang ditentukan dalam modul django.http
.
Obyek HttpRequest
¶
-
class
HttpRequest
¶
Atribut¶
Semua atribut harus dianggap hanya-baca, meskipun dinyatakan sebaliknya.
-
HttpRequest.
scheme
¶ Sebuah string mewakili skema dari permintaan (biasanya
http
atauhttps
).
-
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 withHttpRequest.read()
orHttpRequest.readline()
. Accessing thebody
attribute after reading the request with either of these I/O stream methods will produce aRawPostDataException
.
-
HttpRequest.
path
¶ A string representing the full path to the requested page, not including the scheme, domain, or query string.
Contoh:
"/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 ofpath
can make your code easier to move between test and deployment servers.Sebagai contoh, jika
WSGIScriptAlias
untuk aplikasi anda disetel menjadi"/minfo"
, kemudianpath
mungkin"/minfo/music/bands/the_beatles/"
danpath_info
menjadi"/music/bands/the_beatles/"
.
-
HttpRequest.
method
¶ Sebuah string mewakili metode HTTP digunakan dalam permintaan. Ini dijamin menjadi huruf besar. Sebagai contoh:
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 theDEFAULT_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 fromGET
orPOST
) will use the newencoding
value. Useful if you know the form data is not in theDEFAULT_CHARSET
encoding.
-
HttpRequest.
content_type
¶ Sebuah string mewakili jenis MIME dari permintaan, diuraikan dari kepala
CONTENT_TYPE
.
-
HttpRequest.
content_params
¶ Sebuah dictionary dari parameter kunci/nilai disertakan dalam kepala
CONTENT_TYPE
.
-
HttpRequest.
GET
¶ Sebuah obyek seperti-dictionary mengandung semua parameter HTTP GET diberikan. Lihat dokumentasi
QueryDict
dibawah.
-
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 theHttpRequest.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 useif request.POST
to check for use of the POST method; instead, useif request.method == "POST"
(seeHttpRequest.method
).POST
tidak meneyrtakan informasi unggah-berkas. LihatFILES
.
-
HttpRequest.
COOKIES
¶ Sebuah dictionary mengandung semua kue-kue. Kunci dan nilai adalah string.
-
HttpRequest.
FILES
¶ A dictionary-like object containing all uploaded files. Each key in
FILES
is thename
from the<input type="file" name="">
. Each value inFILES
is anUploadedFile
.Lihat Mengelola berkas untuk informasi lebih.
FILES
will only contain data if the request method was POST and the<form>
that posted to the request hadenctype="multipart/form-data"
. Otherwise,FILES
will be a blank dictionary-like object.
-
HttpRequest.
META
¶ Sebuah dictionary mengandung semua kepala HTTP tersedia. Kepala tersedia bergantung pada klien dan peladen, tetapi disini ada beberapa contoh:
CONTENT_LENGTH
-- Panjang dari badan peminta (sebagai string).CONTENT_TYPE
-- Jenis MIME dari badan peminta.HTTP_ACCEPT
-- Jenis-jenis isi diterima untuk tanggapan.HTTP_ACCEPT_ENCODING
-- Penyandian yang diterima untuk tanggapan.HTTP_ACCEPT_LANGUAGE
-- Bahasa yang diterima untuk tanggapan.HTTP_HOST
-- Kepala HTTP Host dikirim oleh klien.HTTP_REFERER
-- Halaman acuan, jika ada.HTTP_USER_AGENT
-- String agen-user klien.QUERY_STRING
-- String permintaan, sebagai tunggal (tidak diurai) string.REMOTE_ADDR
-- Alamat IP dari klien.REMOTE_HOST
-- Hostname dari klien.REMOTE_USER
-- The user authenticated by the web server, if any.REQUEST_METHOD
-- Sebuah string seperti"GET"
atau"POST"
.SERVER_NAME
-- Hostname dari peladen.SERVER_PORT
-- Port dari peladen (sebagai string).
With the exception of
CONTENT_LENGTH
andCONTENT_TYPE
, as given above, any HTTP headers in the request are converted toMETA
keys by converting all characters to uppercase, replacing any hyphens with underscores and adding anHTTP_
prefix to the name. So, for example, a header calledX-Bender
would be mapped to theMETA
keyHTTP_X_BENDER
.Note that
runserver
strips all headers with underscores in the name, so you won't see them inMETA
. 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, plusCONTENT_LENGTH
andCONTENT_TYPE
.
-
HttpRequest.
headers
¶ A case insensitive, dict-like object that provides access to all HTTP-prefixed headers (plus
Content-Length
andContent-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 inprocess_view()
though).
Atribut-atribut disetel oleh kode aplikasi¶
Django tidak menyetel atribut ini sendiri tetapi menggunakan mereka jika disetel oleh aplikasi anda.
-
HttpRequest.
current_app
¶ Etiket cetakan
url
akan menggunakan nilainya sebagai argumencurrent_app
padareverse()
.
-
HttpRequest.
urlconf
¶ Ini akan digunaan sebagai akar URLconf utnuk permintaan saat ini, menimpa pengaturan
ROOT_URLCONF
. Lihat Bagaimana Django mengolah permintaan untuk rincian.urlconf
dapat disetel menjadiNone
untuk merubah perubahan apapun dibuat oleh middleware sebelumnya dan mengembalikannya menggunakanROOT_URLCONF
.
-
HttpRequest.
exception_reporter_filter
¶ This will be used instead of
DEFAULT_EXCEPTION_REPORTER_FILTER
for the current request. See Penyesuaian laporan kesalahan for details.
-
HttpRequest.
exception_reporter_class
¶ This will be used instead of
DEFAULT_EXCEPTION_REPORTER
for the current request. See Penyesuaian laporan kesalahan for details.
Atribut-atribut disetel oleh middleware¶
Beberapa middleware disertakan dalam aplikasi bantuan Django menyetel atribut pada permintaan. Jika anda tidak melihat atribut pada sebuah permintaan, pastikan kelas middleware sesuai didaftarkan dalam MIDDLEWARE
.
-
HttpRequest.
session
¶ Dari
SessionMiddleware
: Dapat dibaca dan ditulis, obyek seperti dictionary yang mewakili sesi saat ini.
-
HttpRequest.
site
¶ Dari
CurrentSiteMiddleware
: Sebuah instance dariSite
atauRequestSite
seperti dikembalikan olehget_current_site()
mewakili situs saat ini.
-
HttpRequest.
user
¶ From the
AuthenticationMiddleware
: An instance ofAUTH_USER_MODEL
representing the currently logged-in user. If the user isn't currently logged in,user
will be set to an instance ofAnonymousUser
. You can tell them apart withis_authenticated
, like so:if request.user.is_authenticated: ... # Do something for logged-in users. else: ... # Do something for anonymous users.
Cara¶
-
HttpRequest.
get_host
()¶ Mengembalikan rumah asal dari permintaan menggunakan informasi dari
HTTP_X_FORWARDED_HOST
(jikaUSE_X_FORWARDED_HOST
diadakan) dan kepalaHTTP_HOST
, dalam urutan itu. Jika mereka tidak menyediakan sebuah nilai, metode menggunakan sebuah perpaduan dariSERVER_NAME
danSERVER_PORT
seperti dirincikan dalam PEP 3333.Contoh:
"127.0.0.1:8000"
Raises
django.core.exceptions.DisallowedHost
if the host is not inALLOWED_HOSTS
or the domain name is invalid according to RFC 1034/1035.Catatan
Metode
get_host()
ketika rumah dibelakang banyak proxy. Satu pemecahan adalah menggunakan middleware untuk menulis kembali kepala proxy, seperti dalam contoh berikut: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)
Middleware ini harus ditempatkan sebelum middleware lain apapun yang bergantung pada nilai dari
get_host()
-- untuk contoh,CommonMiddleware
atauCsrfViewMiddleware
.
-
HttpRequest.
get_port
()¶ Mengembalikan port asal dari permintaan menggunakan informasi dari
HTTP_X_FORWARDED_PORT
(jikaUSE_X_FORWARDED_PORT
diadakan) dan variabelSERVER_PORT
META
, dalam urutan itu.
-
HttpRequest.
get_full_path
()¶ Mengembalikan
path
, ditambah sebuah string permintaan ditambahkan, jika dapat dipakai.Contoh:
"/music/bands/the_beatles/?print=true"
-
HttpRequest.
get_full_path_info
()¶ Seperti
get_full_path()
, tetapi menggunakanpath_info
daripadapath
.Contoh:
"/minfo/music/bands/the_beatles/?print=true"
-
HttpRequest.
build_absolute_uri
(location=None)¶ Mengembalikan bentuk URI mutlak dari
location
. Jika tidak ada tempat disediakan, tempat akan disetel menjadirequest.get_full_path()
.Jika tempat adalah sudah sebuah URI mutlak, itu tidak akan diubah. Sebaliknya URI mutlak dibangun menggunakan variabel-variabel peladen dalam permintaan ini. Sebagai contoh:
>>> 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/'
Catatan
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 thedefault
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, themax_age
argument will be checked against the signed timestamp attached to the cookie value to ensure the cookie is not older thanmax_age
seconds.Sebagai contoh:
>>> 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
Lihat penandatangan kriptograpi untuk informasi lebih.
-
HttpRequest.
is_secure
()¶ Mengembalikan
True
jika permintaan adalah aman; yaitu, jika itu telah dibuat dengan HTTPS.
-
HttpRequest.
accepts
(mime_type)¶ Returns
True
if the requestAccept
header matches themime_type
argument:>>> request.accepts('text/html') True
Most browsers send
Accept: */*
by default, so this would returnTrue
for all content types. Setting an explicitAccept
header in API requests can be useful for returning a different content type for those consumers only. See Content negotiation example of usingaccepts()
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'scache middleware
, you should decorate the view withvary_on_headers('Accept')
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.Diberikan antarmuka standar ini, sebuah instance
HttpRequest
dapat dilewatkan langsung pada sebuah pengurai XML sepertiElementTree
:import xml.etree.ElementTree as ET for element in ET.iterparse(request): process(element)
Obyek QueryDict
¶
-
class
QueryDict
¶
In an HttpRequest
object, the GET
and
POST
attributes are instances of django.http.QueryDict
,
a dictionary-like class customized to deal with multiple values for the same
key. This is necessary because some HTML form elements, notably
<select multiple>
, pass multiple values for the same key.
The QueryDict
s at request.POST
and request.GET
will be immutable
when accessed in a normal request/response cycle. To get a mutable version you
need to use QueryDict.copy()
.
Cara¶
QueryDict
menerapkan semua metode dictionary standar karena itu adalah subkelas dari dictionary. Pengecualian diuraikan disini:
-
QueryDict.
__init__
(query_string=None, mutable=False, encoding=None)¶ Memakai obyek
QueryDict
berdasarkan padaquery_string
.>>> QueryDict('a=1&a=2&c=3') <QueryDict: {'a': ['1', '2'], 'c': ['3']}>
Jika
query_string
tidak dilewatkan, hasilQueryDict
akan kosong (itu tidak akan memiliki kunci atau nilai).Most
QueryDict
s you encounter, and in particular those atrequest.POST
andrequest.GET
, will be immutable. If you are instantiating one yourself, you can make it mutable by passingmutable=True
to its__init__()
.Strings for setting both keys and values will be converted from
encoding
tostr
. Ifencoding
is not set, it defaults toDEFAULT_CHARSET
.
-
classmethod
QueryDict.
fromkeys
(iterable, value='', mutable=False, encoding=None)¶ Membuat sebuah
QueryDict
baru dengan kunci dariiterable
dan stiap nilai setara padavalue
. Sebagai contoh:>>> QueryDict.fromkeys(['a', 'a', 'b'], value='val') <QueryDict: {'a': ['val', 'val'], 'b': ['val']}>
-
QueryDict.
__getitem__
(key)¶ Returns the value for the given key. If the key has more than one value, it returns the last value. Raises
django.utils.datastructures.MultiValueDictKeyError
if the key does not exist. (This is a subclass of Python's standardKeyError
, so you can stick to catchingKeyError
.)
-
QueryDict.
__setitem__
(key, value)¶ Sets the given key to
[value]
(a list whose single element isvalue
). Note that this, as other dictionary functions that have side effects, can only be called on a mutableQueryDict
(such as one that was created viaQueryDict.copy()
).
-
QueryDict.
__contains__
(key)¶ Mengembalikan
True
jika kunci yang diberikan disetel. Ini membuat anda melakukan, misalnyaif "foo" dalam request.GET
.
-
QueryDict.
get
(key, default=None)¶ Menggunakan logika sama seperti
__getitem__()
, dengan kaitan untuk mengembalikan nilai awalan jika kunci tidak ada.
-
QueryDict.
setdefault
(key, default=None)¶ Seperti
dict.setdefault()
, kecuai itu menggunakan__setitem__()
secara internal.
-
QueryDict.
update
(other_dict)¶ Takes either a
QueryDict
or a dictionary. Likedict.update()
, 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
()¶ 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']
Sebagai tambahan, QueryDict
mempunyai metode berikut:
-
QueryDict.
copy
()¶ Mengembalikan salinan dari obyek menggunakan
copy.deepcopy()
. Salinan ini tidak tetap bahkan jika aslinya tidak.
-
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
isNone
. It's guaranteed to return a list unless the default value provided isn't a list.
-
QueryDict.
setlist
(key, list_)¶ Mensetel kunci diberikan pada
list_
(unlike__setitem__()
).
-
QueryDict.
appendlist
(key, item)¶ Menambahkan sebuah barang pada daftar internal terkait dengan kunci.
-
QueryDict.
setlistdefault
(key, default_list=None)¶ Seperti
setdefault()
, kecuali itu mengambil daftar dari nilai-nilai daripada nilai tunggal.
-
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 ofQueryDict
. For every (key, list) pair inQueryDict
,dict
will have (key, item), where item is one element of the list, using the same logic asQueryDict.__getitem__()
:>>> q = QueryDict('a=1&a=3&a=5') >>> q.dict() {'a': '5'}
-
QueryDict.
urlencode
(safe=None)¶ Mengembalikan string dari data dalam bentuk string permintaan. Sebagai contoh:
>>> q = QueryDict('a=2&b=3&b=5') >>> q.urlencode() 'a=2&b=3&b=5'
Menggunakan parameter
safe
untuk melewatkan karakter yang tidak membutuhkan penyandian. Sebagai contoh:>>> q = QueryDict(mutable=True) >>> q['next'] = '/a&b/' >>> q.urlencode(safe='/') 'next=/a%26b/'
Obyek HttpResponse
¶
-
class
HttpResponse
¶
In contrast to HttpRequest
objects, which are created automatically by
Django, HttpResponse
objects are your responsibility. Each view you
write is responsible for instantiating, populating, and returning an
HttpResponse
.
Kelas HttpResponse
berada di modul django.http
Penggunaan¶
Melewatkan string¶
Typical usage is to pass the contents of the page, as a string, bytestring,
or memoryview
, to the HttpResponse
constructor:
>>> 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.'))
Tetapi jika anda ingin menambahkan isi secara menaik, anda dapat menggunakan response
sebagai obyek seperti-berkas:
>>> response = HttpResponse()
>>> response.write("<p>Here's the text of the web page.</p>")
>>> response.write("<p>Here's another paragraph.</p>")
Melewatkan perulangan¶
Finally, you can pass HttpResponse
an iterator rather than strings.
HttpResponse
will consume the iterator immediately, store its content as a
string, and discard it. Objects with a close()
method such as files and
generators are immediately closed.
If you need the response to be streamed from the iterator to the client, you
must use the StreamingHttpResponse
class instead.
Mengatur bidang kepala¶
To set or remove a header field in your response, use
HttpResponse.headers
:
>>> response = HttpResponse()
>>> response.headers['Age'] = 120
>>> del response.headers['Age']
You can also manipulate headers by treating your response like a dictionary:
>>> response = HttpResponse()
>>> response['Age'] = 120
>>> del response['Age']
This proxies to HttpResponse.headers
, and is the original interface offered
by HttpResponse
.
When using this interface, unlike a dictionary, del
doesn't raise
KeyError
if the header field doesn't exist.
You can also set headers on instantiation:
>>> response = HttpResponse(headers={'Age': 120})
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
memberitahu peramban untuk memperlakukan tanggapan sebagai sebuah berkas lampiran¶
To tell the browser to treat the response as a file attachment, set the
Content-Type
and Content-Disposition
headers. For example, this is how
you might return a Microsoft Excel spreadsheet:
>>> response = HttpResponse(my_data, headers={
... 'Content-Type': 'application/vnd.ms-excel',
... '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.
Atribut¶
-
HttpResponse.
content
¶ Sebuah bytestring mewakili isi, disandikan dari string jika dibutuhkan.
-
HttpResponse.
headers
¶ A case insensitive, dict-like object that provides an interface to all HTTP headers on the response. See Mengatur bidang kepala.
-
HttpResponse.
charset
¶ A string denoting the charset in which the response will be encoded. If not given at
HttpResponse
instantiation time, it will be extracted fromcontent_type
and if that is unsuccessful, theDEFAULT_CHARSET
setting will be used.
-
HttpResponse.
status_code
¶ HTTP status code untuk tanggapan.
Unless
reason_phrase
is explicitly set, modifying the value ofstatus_code
outside the constructor will also modify the value ofreason_phrase
.
-
HttpResponse.
reason_phrase
¶ Ungkapan alasan HTTP untuk tanggapan. Itu menggunakan ungkapan tanggapan awalan HTTP standard's.
Meskipun secara tegas mensetel,
reason_phrase
ditentukan oleh nilaistatus_code
.
-
HttpResponse.
streaming
¶ Ini selalu
False
.Atribut ini ada sehingga middleware dapat memperlakukan aliran tanggapan berbeda dari tanggapan biasanya.
-
HttpResponse.
closed
¶ True
jika tanggapan telah ditutup.
Cara¶
-
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 HTTPContent-Type
header. If not specified, it is formed by'text/html'
and theDEFAULT_CHARSET
settings, by default:"text/html; charset=utf-8"
.status
is the HTTP status code for the response. You can use Python'shttp.HTTPStatus
for meaningful aliases, such asHTTPStatus.NO_CONTENT
.reason
adalah ungkapan tanggapan HTTP. Jika tidak disediakan, ungkapan awalan akan digunakan.charset
is the charset in which the response will be encoded. If not given it will be extracted fromcontent_type
, and if that is unsuccessful, theDEFAULT_CHARSET
setting will be used.headers
is adict
of HTTP headers for the response.
-
HttpResponse.
__setitem__
(header, value)¶ Setel nama kepala diberikan pada nilai diberikan. Kedua
header
danvalue
harus berupa string.
-
HttpResponse.
__delitem__
(header)¶ Hapus kepala dengan nama diberikan. Gagal diam jika kepala tidak ada. kasus-tidak-peka.
-
HttpResponse.
__getitem__
(header)¶ Mengembalikan nilai untk nama kepala diberikan. Kasus-tidak-peka.
-
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)¶ Mengembalikan
True
atauFalse
berdasarkan pada pemeriksaan kasus-tidak-peka untuk kepala dengan nama diberikan.
-
HttpResponse.
items
()¶ Acts like
dict.items()
for HTTP headers on the response.
-
HttpResponse.
setdefault
(header, value)¶ Setel sebuah kepala meskipun itu sudah dikirim.
-
HttpResponse.
set_cookie
(key, value='', max_age=None, expires=None, path='/', domain=None, secure=False, httponly=False, samesite=None)¶ Setel sebuah kue. Parameter sama seperti dalam obyek kue
Morsel
dalam pustaka standar Python.max_age
should be atimedelta
object, an integer number of seconds, orNone
(default) if the cookie should last only as long as the client's browser session. Ifexpires
is not specified, it will be calculated.Changed in Django 4.1:Support for
timedelta
objects was added.expires
harus salah satu berupa string dalam bentuk"Wdy, DD-Mon-YY HH:MM:SS GMT"
atau obyekdatetime.datetime
dalam UTC. Jikaexpires
adalah obyekdatetime
,max_age
akan dihitung.Gunakan``domain`` jika anda ingi mensetel kue lintas-ranah. Sebagai contoh,
domain="example.com"
akan mensetel sebuah kue yang dapat dibaca oleh ranah www.example.com, blog.example.com, dll. Sebaliknya, sebuah kue akan hanya dapat dibaca oleh ranah yang mensetel nya.Use
secure=True
if you want the cookie to be only sent to the server when a request is made with thehttps
scheme.Gunakan
httponly=True
jika anda ingin mencegah javaScript sisi-klien dari memiliki akses ke kue.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'
orsamesite='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.
Peringatan
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 withHttpRequest.get_signed_cookie()
. You can use the optionalsalt
argument for added key strength, but you will need to remember to pass it to the correspondingHttpRequest.get_signed_cookie()
call.
-
HttpResponse.
delete_cookie
(key, path='/', domain=None, samesite=None)¶ Menghapus kue dengan kunci yang diberikan. Gagal secara diam jika kunci tidak ada.
Dikarenakan cara kue bekerja,
path
dandomain
harus berupa nilai sama anda gunakan dalamset_cookie()
-- sebaliknya kue mungkin tidak dihapus.
-
HttpResponse.
close
()¶ This method is called at the end of the request directly by the WSGI server.
-
HttpResponse.
write
(content)¶ Metode ini membuat sebuah instance
HttpResponse
sebuah obyek seperti-berkas.
-
HttpResponse.
flush
()¶ Metode ini membuat sebuah instance
HttpResponse
sebuah obyek seperti-berkas.
-
HttpResponse.
tell
()¶ Metode ini membuat sebuah instance
HttpResponse
sebuah obyek seperti-berkas.
-
HttpResponse.
getvalue
()¶ Mengembalikan nilai dari
HttpResponse.content
. Metode ini membuat sebuah instanceHttpResponse
sebuah obyek seperti-aliran.
-
HttpResponse.
readable
()¶ Selalu
False
. Metode ini membuat sebuah instanceHttpResponse
obyek seperti-aliran.
-
HttpResponse.
seekable
()¶ Selalu
False
. Metode ini membuat sebuah instanceHttpResponse
obyek seperti-aliran.
-
HttpResponse.
writable
()¶ Selalu
True
. Metode ini membuat sebuah instanceHttpResponse
obyek seperti-aliran.
-
HttpResponse.
writelines
(lines)¶ Tulis sebuah baris pada tanggapan. Pemisah baris tidak ditambahkan. Metode ini membuat sebuah contoh
HttpResponse
sebuah obyek seperti-aliran.
Subkelas HttpResponse
¶
Django menyertakan sebuah angka dari subkelas-subkelas HttpResponse
yang menangani jenis-jenis berbeda dari tanggapan HTTP. Seperti HttpResponse
, subkelas-subkelas ini tinggal dalam 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. SeeHttpResponse
for other optional constructor arguments. Note that this returns an HTTP status code 302.-
url
¶ Ini atribut hanya-baca mewakili tanggapan URL akan mengalihkan ke (setara pada kepala tanggapan
Location
).
-
-
class
HttpResponsePermanentRedirect
¶ Seperti
HttpResponseRedirect
, tetapi itu mengembalikan pengalihan tetap (kode keadaan HTTP 301) daripada pengalihan "found" (kode keadaan 302).
-
class
HttpResponseNotModified
¶ Pembangun tidak mengambil argumen apapun dan tidak ada isi harus ditambahkan pada tanggapan ini. Gunakan ini untuk merancang bahwa sebuah halaman belum dirubah sejak permintaan terakhir pengguna (kode keadaan 304).
-
class
HttpResponseBadRequest
¶ Bertindak seperti
HttpResponse
tetapi menggunakan kode keadaan 400.
-
class
HttpResponseNotFound
¶ Bertindak seperti
HttpResponse
tetapi menggunakan kode keadaan 404.
-
class
HttpResponseForbidden
¶ Bertindak seperti
HttpResponse
tetapi menggunakan kode keadaan 403.
-
class
HttpResponseNotAllowed
¶ Seperti
HttpResponse
, tetapi menggunakan kode keadaan 405. Argumen pertama pada pembangun adalah dibutuhkan: sebuah daftar metode-metode diizinkan (misalnya['GET', 'POST']
).
-
class
HttpResponseGone
¶ Bertindak seperti
HttpResponse
tetapi menggunakan kode keadaan 410.
-
class
HttpResponseServerError
¶ Bertindak seperti
HttpResponse
tetapi menggunakan kode keadaan 500.
Catatan
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.
Custom response classes¶
If you find yourself needing a response class that Django doesn't provide, you
can create it with the help of http.HTTPStatus
. For example:
from http import HTTPStatus
from django.http import HttpResponse
class HttpResponseNoContent(HttpResponse):
status_code = HTTPStatus.NO_CONTENT
Obyek JsonResponse
¶
-
class
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.Parameter pertama,
data
, harus berupa sebuah contohdict
. Jika parametersafe
disetel menjadiFalse
(lihat dibawah) itu dapat berupa obyek JSON-dapat-diserialisasi apapun.encoder
, yang awalan padadjango.core.serializers.json.DjangoJSONEncoder
, akan digunakan untuk menserialkan data. Lihat JSON serialization untuk rincian lebih tentang penserial ini.Parameter boolean
safe
awalan padaTrue
. Jika itu disetel menjadiFalse
, obyek apapun dapat dilewatkan untuk serialisasi (sebaliknya hanya contohdict
diizinkan). Jikasafe
adalahTrue
dan obyek bukan-dict
dilewatkan sebagai argumen pertama, sebuahTypeError
akan dimunculkan.Parameter
json_dumps_params
adalah sebuah dictionary dari argumen kata kunci untuk dilewatkan ke panggilanjson.dumps()
digunakan untuk membangkitkan tanggapan.
Penggunaan¶
Penggunaan tertentu dapat terlihat seperti:
>>> from django.http import JsonResponse
>>> response = JsonResponse({'foo': 'bar'})
>>> response.content
b'{"foo": "bar"}'
Menserialkan obyek bukan-dictionary¶
Untuk menserialkan obyek selain dari dict
anda harus mensetel parameter safe
menjadi False
:
>>> response = JsonResponse([1, 2, 3], safe=False)
Tanpa melewatkan safe=False
, sebuah TypeError
akan dimunculkan.
Note that an API based on dict
objects is more extensible, flexible, and
makes it easier to maintain forwards compatibility. Therefore, you should avoid
using non-dict objects in JSON-encoded response.
Peringatan
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.
Merubah penyandi JSON awalan¶
Anda butuh menggunakan kelas penyandi JSON berbeda anda dapat lewatkan parameter encoder
ke metode pembangun:
>>> response = JsonResponse(data, encoder=MyJSONEncoder)
Obyek StreamingHttpResponse
¶
-
class
StreamingHttpResponse
¶
Kelas StreamingHttpResponse
digunakan untuk aliran tanggapan dari Django ke peramban. Anda mungkin ingin melakukan ini jika membangkitkan tanggapan terlalu alam atau terlalu banyak menggunakan memori. Sebagai contoh, itu berguna untuk generating large CSV files.
Pertimbangan penampilan
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:
- It should be given an iterator that yields bytestrings as content.
- You cannot access its content, except by iterating the response object itself. This should only occur when the response is returned to the client.
- Itu tidak mempunyai atribut
content
. Sebagai gantinya, itu memiliki atributstreaming_content
. - Anda tidak dapat menggunakan obyek seperti-berkas metode
tell()
atauwrite()
. Melakukan itu akan memunculkan sebuah pengecualian.
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
middleware can't function normally. For example the ETag
and
Content-Length
headers can't be generated for streaming responses.
The HttpResponseBase
base class is common between
HttpResponse
and StreamingHttpResponse
.
Atribut¶
-
StreamingHttpResponse.
streaming_content
¶ An iterator of the response content, bytestring encoded according to
HttpResponse.charset
.
-
StreamingHttpResponse.
status_code
¶ HTTP status code untuk tanggapan.
Unless
reason_phrase
is explicitly set, modifying the value ofstatus_code
outside the constructor will also modify the value ofreason_phrase
.
-
StreamingHttpResponse.
reason_phrase
¶ Ungkapan alasan HTTP untuk tanggapan. Itu menggunakan ungkapan tanggapan awalan HTTP standard's.
Meskipun secara tegas mensetel,
reason_phrase
ditentukan oleh nilaistatus_code
.
-
StreamingHttpResponse.
streaming
¶ Ini selalu
True
.
Obyek FileResponse
¶
-
class
FileResponse
(open_file, as_attachment=False, filename='', **kwargs)¶ FileResponse
is a subclass ofStreamingHttpResponse
optimized for binary files. It uses wsgi.file_wrapper if provided by the wsgi server, otherwise it streams the file out in small chunks.If
as_attachment=True
, theContent-Disposition
header is set toattachment
, which asks the browser to offer the file to the user as a download. Otherwise, aContent-Disposition
header with a value ofinline
(the browser default) will be set only if a filename is available.If
open_file
doesn't have a name or if the name ofopen_file
isn't appropriate, provide a custom file name using thefilename
parameter. Note that if you pass a file-like object likeio.BytesIO
, it's your task toseek()
it before passing it toFileResponse
.The
Content-Length
andContent-Type
headers are automatically set when they can be guessed from contents ofopen_file
.
FileResponse
menerima obyek seperti-berkas apapun dengan isi biner, sebagai contoh sebuah berkas dibuka dalam suasana biner sebagai berikut:
>>> from django.http import FileResponse
>>> response = FileResponse(open('myfile.png', 'rb'))
Berkas akan ditutup otomatis, jadi jangan membuka itu dengan pengelola konteks.
HttpResponseBase
class¶
-
class
HttpResponseBase
¶
The HttpResponseBase
class is common to all Django responses.
It should not be used to create responses directly, but it can be
useful for type-checking.