Multipart reference¶
- class aiohttp.MultipartResponseWrapper(resp, stream)¶
Wrapper around the
MultipartReader
to take care about underlying connection and close it when it needs in.- at_eof()¶
Returns
True
when all response data had been read.- Return type:
bool
- coroutine next()¶
Emits next multipart reader object.
- coroutine release()¶
Releases the connection gracefully, reading all the content to the void.
- class aiohttp.BodyPartReader(boundary, headers, content)[source]¶
Multipart reader for single body part.
- coroutine read(*, decode=False)[source]¶
Reads body part data.
- Parameters:
decode (bool) – Decodes data following by encoding method from
Content-Encoding
header. If it missed data remains untouched- Return type:
bytearray
- coroutine read_chunk(size=chunk_size)[source]¶
Reads body part content chunk of the specified size.
- Parameters:
size (int) – chunk size
- Return type:
bytearray
- coroutine text(*, encoding=None)[source]¶
Like
read()
, but assumes that body part contains text data.- Parameters:
encoding (str) – Custom text encoding. Overrides specified in charset param of
Content-Type
header- Return type:
str
- coroutine json(*, encoding=None)[source]¶
Like
read()
, but assumes that body parts contains JSON data.- Parameters:
encoding (str) – Custom JSON encoding. Overrides specified in charset param of
Content-Type
header
- coroutine form(*, encoding=None)[source]¶
Like
read()
, but assumes that body parts contains form urlencoded data.- Parameters:
encoding (str) – Custom form encoding. Overrides specified in charset param of
Content-Type
header
- decode(data)[source]¶
Decodes data according the specified
Content-Encoding
orContent-Transfer-Encoding
headers value.Supports
gzip
,deflate
andidentity
encodings forContent-Encoding
header.Supports
base64
,quoted-printable
,binary
encodings forContent-Transfer-Encoding
header.- Parameters:
data (bytearray) – Data to decode.
- Raises:
RuntimeError
- if encoding is unknown.- Return type:
bytes
- name¶
A field name specified in
Content-Disposition
header orNone
if missed or header is malformed.Readonly
str
property.
- filename¶
A field filename specified in
Content-Disposition
header orNone
if missed or header is malformed.Readonly
str
property.
- class aiohttp.MultipartReader(headers, content)[source]¶
Multipart body reader.
- classmethod from_response(cls, response)[source]¶
Constructs reader instance from HTTP response.
- Parameters:
response –
ClientResponse
instance
- class aiohttp.MultipartWriter(subtype='mixed', boundary=None, close_boundary=True)[source]¶
Multipart body writer.
boundary
may be an ASCII-only string.- boundary¶
The string (
str
) representation of the boundary.Changed in version 3.0: Property type was changed from
bytes
tostr
.
- size¶
Size of the payload.