rbtools.api.decode¶

API payload decoders.

Module Attributes

Mapping from API format to decoder method.

Functions

`DefaultDecoder`(payload)	Default decoder for API payloads.
`JsonDecoder`(payload)	Decode an application/json-encoded API response.
`decode_response`(payload, mime_type)	Decode a Web API response.

rbtools.api.decode.DefaultDecoder(payload: Union[bytes, str]) → Dict[source]¶

Default decoder for API payloads.

The default decoder is used when a decoder is not found in the DECODER_MAP. This will stick the body of the response into the ‘data’ field.

rbtools.api.decode.JsonDecoder(payload: Union[bytes, str]) → Dict[source]¶

Decode an application/json-encoded API response.

rbtools.api.decode.DECODER_MAP = {'application/json': <function JsonDecoder>}[source]¶

Mapping from API format to decoder method.

Type: dict

rbtools.api.decode.decode_response(payload: Union[bytes, str], mime_type: str) → Dict[source]¶

Decode a Web API response.

The body of a Web API response will be decoded into a dictionary, according to the provided mime_type.