File size: 5,126 Bytes
065fee7 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 |
.. currentmodule:: aiohttp
.. _aiohttp-multipart-reference:
Multipart reference
===================
.. class:: MultipartResponseWrapper(resp, stream)
Wrapper around the :class:`MultipartReader` to take care about
underlying connection and close it when it needs in.
.. method:: at_eof()
Returns ``True`` when all response data had been read.
:rtype: bool
.. method:: next()
:async:
Emits next multipart reader object.
.. method:: release()
:async:
Releases the connection gracefully, reading all the content
to the void.
.. class:: BodyPartReader(boundary, headers, content)
Multipart reader for single body part.
.. method:: read(*, decode=False)
:async:
Reads body part data.
:param bool decode: Decodes data following by encoding method
from ``Content-Encoding`` header. If it
missed data remains untouched
:rtype: bytearray
.. method:: read_chunk(size=chunk_size)
:async:
Reads body part content chunk of the specified size.
:param int size: chunk size
:rtype: bytearray
.. method:: readline()
:async:
Reads body part by line by line.
:rtype: bytearray
.. method:: release()
:async:
Like :meth:`read`, but reads all the data to the void.
:rtype: None
.. method:: text(*, encoding=None)
:async:
Like :meth:`read`, but assumes that body part contains text data.
:param str encoding: Custom text encoding. Overrides specified
in charset param of ``Content-Type`` header
:rtype: str
.. method:: json(*, encoding=None)
:async:
Like :meth:`read`, but assumes that body parts contains JSON data.
:param str encoding: Custom JSON encoding. Overrides specified
in charset param of ``Content-Type`` header
.. method:: form(*, encoding=None)
:async:
Like :meth:`read`, but assumes that body parts contains form
urlencoded data.
:param str encoding: Custom form encoding. Overrides specified
in charset param of ``Content-Type`` header
.. method:: at_eof()
Returns ``True`` if the boundary was reached or ``False`` otherwise.
:rtype: bool
.. method:: decode(data)
Decodes data according the specified ``Content-Encoding``
or ``Content-Transfer-Encoding`` headers value.
Supports ``gzip``, ``deflate`` and ``identity`` encodings for
``Content-Encoding`` header.
Supports ``base64``, ``quoted-printable``, ``binary`` encodings for
``Content-Transfer-Encoding`` header.
:param bytearray data: Data to decode.
:raises: :exc:`RuntimeError` - if encoding is unknown.
:rtype: bytes
.. method:: get_charset(default=None)
Returns charset parameter from ``Content-Type`` header or default.
.. attribute:: name
A field *name* specified in ``Content-Disposition`` header or ``None``
if missed or header is malformed.
Readonly :class:`str` property.
.. attribute:: filename
A field *filename* specified in ``Content-Disposition`` header or ``None``
if missed or header is malformed.
Readonly :class:`str` property.
.. class:: MultipartReader(headers, content)
Multipart body reader.
.. classmethod:: from_response(cls, response)
Constructs reader instance from HTTP response.
:param response: :class:`~aiohttp.ClientResponse` instance
.. method:: at_eof()
Returns ``True`` if the final boundary was reached or
``False`` otherwise.
:rtype: bool
.. method:: next()
:async:
Emits the next multipart body part.
.. method:: release()
:async:
Reads all the body parts to the void till the final boundary.
.. method:: fetch_next_part()
:async:
Returns the next body part reader.
.. class:: MultipartWriter(subtype='mixed', boundary=None, close_boundary=True)
Multipart body writer.
``boundary`` may be an ASCII-only string.
.. attribute:: boundary
The string (:class:`str`) representation of the boundary.
.. versionchanged:: 3.0
Property type was changed from :class:`bytes` to :class:`str`.
.. method:: append(obj, headers=None)
Append an object to writer.
.. method:: append_payload(payload)
Adds a new body part to multipart writer.
.. method:: append_json(obj, headers=None)
Helper to append JSON part.
.. method:: append_form(obj, headers=None)
Helper to append form urlencoded part.
.. attribute:: size
Size of the payload.
.. method:: write(writer, close_boundary=True)
:async:
Write body.
:param bool close_boundary: The (:class:`bool`) that will emit
boundary closing. You may want to disable
when streaming (``multipart/x-mixed-replace``)
.. versionadded:: 3.4
Support ``close_boundary`` argument.
|