httpx._multipart.MultipartStream

class documentation

class MultipartStream(SyncByteStream, AsyncByteStream): (source)

View In Hierarchy

Request content as streaming multipart encoded form data.

Async Method __aiter__ Undocumented
Method __init__ Undocumented
Method __iter__ Undocumented
Method get_content_length Return the length of the multipart encoded content, or `None` if any of the files have a length that cannot be determined upfront.
Method get_headers Undocumented
Method iter_chunks Undocumented
Instance Variable boundary Undocumented
Instance Variable content_type Undocumented
Instance Variable fields Undocumented
Method _iter_fields Undocumented

Inherited from SyncByteStream:

Method close Subclasses can override this method to release any network resources after a request/response cycle is complete.

Inherited from AsyncByteStream (via SyncByteStream):

Async Method aclose Undocumented
async def __aiter__(self): (source)
overrides httpx.AsyncByteStream.__aiter__

Undocumented

Returns
typing.AsyncIterator[bytes]Undocumented
def __init__(self, data, files, boundary=None): (source)

Undocumented

Parameters
data:RequestDataUndocumented
files:RequestFilesUndocumented
boundary:typing.Optional[bytes]Undocumented
def __iter__(self): (source)
overrides httpx.SyncByteStream.__iter__

Undocumented

Returns
typing.Iterator[bytes]Undocumented
def get_content_length(self): (source)

Return the length of the multipart encoded content, or `None` if any of the files have a length that cannot be determined upfront.

Returns
typing.Optional[int]Undocumented
def get_headers(self): (source)

Undocumented

Returns
typing.Dict[str, str]Undocumented
def iter_chunks(self): (source)

Undocumented

Returns
typing.Iterator[bytes]Undocumented
boundary = (source)

Undocumented

content_type = (source)

Undocumented

fields = (source)

Undocumented

def _iter_fields(self, data, files): (source)

Undocumented

Parameters
data:RequestDataUndocumented
files:RequestFilesUndocumented
Returns
typing.Iterator[typing.Union[FileField, DataField]]Undocumented