alexapy.aiohttp.payload

Functions

• get_payload(): Undocumented.

alexapy.aiohttp.payload.get_payload(data: Any, *args: Any, **kwargs: Any) → alexapy.aiohttp.payload.Payload

Classes

• payload_type: Undocumented.

• Payload: Helper class that provides a standard way to create an ABC using

• BytesPayload: Helper class that provides a standard way to create an ABC using

• StringPayload: Helper class that provides a standard way to create an ABC using

• IOBasePayload: Helper class that provides a standard way to create an ABC using

• BytesIOPayload: Helper class that provides a standard way to create an ABC using

• BufferedReaderPayload: Helper class that provides a standard way to create an ABC using

• TextIOPayload: Helper class that provides a standard way to create an ABC using

• StringIOPayload: Helper class that provides a standard way to create an ABC using

• JsonPayload: Helper class that provides a standard way to create an ABC using

• AsyncIterablePayload: Helper class that provides a standard way to create an ABC using

class alexapy.aiohttp.payload.payload_type(type: Any, *, order: alexapy.aiohttp.payload.Order = Order.normal)

Inheritance

class alexapy.aiohttp.payload.Payload(value: typing.Any, headers: typing.Optional[typing.Union[multidict._multidict.CIMultiDict, typing.Dict[str, str], typing.Iterable[typing.Tuple[str, str]]]] = None, content_type: typing.Optional[str] = <object object>, filename: typing.Optional[str] = None, encoding: typing.Optional[str] = None, **kwargs: typing.Any)

Inheritance

property content_type: str

Content type

property encoding: Optional[str]

Payload encoding

property filename: Optional[str]

Filename of the payload.

property headers: multidict._multidict.CIMultiDict

Custom item headers

set_content_disposition(disptype: str, quote_fields: bool = True, _charset: str = 'utf-8', **params: Any) → None

Sets Content-Disposition header.

property size: Optional[int]

Size of the payload.

abstract async write(writer: alexapy.aiohttp.abc.AbstractStreamWriter) → None

Write payload.

writer is an AbstractStreamWriter instance:

class alexapy.aiohttp.payload.BytesPayload(value: ByteString, *args: Any, **kwargs: Any)

Inheritance

async write(writer: alexapy.aiohttp.abc.AbstractStreamWriter) → None

Write payload.

writer is an AbstractStreamWriter instance:

class alexapy.aiohttp.payload.StringPayload(value: str, *args: Any, encoding: Optional[str] = None, content_type: Optional[str] = None, **kwargs: Any)

Inheritance

class alexapy.aiohttp.payload.IOBasePayload(value: IO[Any], disposition: str = 'attachment', *args: Any, **kwargs: Any)

Inheritance

async write(writer: alexapy.aiohttp.abc.AbstractStreamWriter) → None

Write payload.

writer is an AbstractStreamWriter instance:

class alexapy.aiohttp.payload.BytesIOPayload(value: IO[Any], disposition: str = 'attachment', *args: Any, **kwargs: Any)

Inheritance

property size: int

Size of the payload.

class alexapy.aiohttp.payload.BufferedReaderPayload(value: IO[Any], disposition: str = 'attachment', *args: Any, **kwargs: Any)

Inheritance

property size: Optional[int]

Size of the payload.

class alexapy.aiohttp.payload.TextIOPayload(value: TextIO, *args: Any, encoding: Optional[str] = None, content_type: Optional[str] = None, **kwargs: Any)

Inheritance

property size: Optional[int]

Size of the payload.

async write(writer: alexapy.aiohttp.abc.AbstractStreamWriter) → None

Write payload.

writer is an AbstractStreamWriter instance:

class alexapy.aiohttp.payload.StringIOPayload(value: IO[str], *args: Any, **kwargs: Any)

Inheritance

class alexapy.aiohttp.payload.JsonPayload(value: typing.Any, encoding: str = 'utf-8', content_type: str = 'application/json', dumps: typing.Callable[[typing.Any], str] = <function dumps>, *args: typing.Any, **kwargs: typing.Any)

Inheritance

class alexapy.aiohttp.payload.AsyncIterablePayload(value: collections.abc.AsyncIterable, *args: Any, **kwargs: Any)

Inheritance

async write(writer: alexapy.aiohttp.abc.AbstractStreamWriter) → None

Write payload.

writer is an AbstractStreamWriter instance:

Variables

• PAYLOAD_REGISTRY

alexapy.aiohttp.payload.PAYLOAD_REGISTRY

Payload registry.

note: we need zope.interface for more efficient adapter search

<alexapy.aiohttp.payload.PayloadRegistry object at 0x10e2973d0>