rbtools.api.decode¶

API payload decoders.

Module Attributes

Functions

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

Mapping from API format to decoder method.

Type: dict

rbtools.api.decode.DefaultDecoder(payload: bytes | str) → JSONDict[source]¶

Decode API payloads with no supported type.

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.

Parameters:

payload (bytes or str) – The API payload.

Returns:

The decoded API object.

Return type:

dict

rbtools.api.decode.JsonDecoder(payload: bytes | str) → JSONDict[source]¶

Decode an application/json-encoded API response.

Parameters:

payload (bytes or str) – The API payload.

Returns:

The decoded API object.

Return type:

dict

rbtools.api.decode.decode_response(payload: bytes | str, mime_type: str) → JSONDict[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.