djblets.webapi.encoders¶

class WebAPIEncoder[source]¶

Bases: object

Encodes an object into a dictionary of fields and values.

This object is used for both JSON and XML API formats.

Projects can subclass this to provide representations of their objects. To make use of a encoder, add the path to the encoder class to the project’s settings.WEB_API_ENCODERS list.

For example:

WEB_API_ENCODERS = (
    'myproject.webapi.MyEncoder',
)

encode(o, *args, **kwargs)[source]¶

Encodes an object.

This is expected to return either a dictionary or a list. If the object being encoded is not supported, return None, or call the superclass’s encode method.

class BasicAPIEncoder[source]¶

Bases: WebAPIEncoder

A basic encoder that encodes standard types.

This supports encoding of dates, times, QuerySets, Users, and Groups.

encode(o, *args, **kwargs)[source]¶

Encodes an object.

This is expected to return either a dictionary or a list. If the object being encoded is not supported, return None, or call the superclass’s encode method.

__annotations__ = {}¶

class ResourceAPIEncoder[source]¶

Bases: WebAPIEncoder

An encoder that encodes objects based on registered resources.

encode(o, *args, **kwargs)[source]¶

Encodes an object.

This is expected to return either a dictionary or a list. If the object being encoded is not supported, return None, or call the superclass’s encode method.

__annotations__ = {}¶

class JSONEncoderAdapter(encoder, *args, **kwargs)[source]¶

Bases: JSONEncoder

Adapts a WebAPIEncoder to be used with json.

This takes an existing encoder and makes it available to use as a json.JSONEncoder. This is used internally when generating JSON from a WebAPIEncoder, but can be used in other projects for more specific purposes as well.

__init__(encoder, *args, **kwargs)[source]¶

Constructor for JSONEncoder, with sensible defaults.

If skipkeys is false, then it is a TypeError to attempt encoding of keys that are not str, int, float or None. If skipkeys is True, such items are simply skipped.

If ensure_ascii is true, the output is guaranteed to be str objects with all incoming non-ASCII characters escaped. If ensure_ascii is false, the output can contain non-ASCII characters.

If check_circular is true, then lists, dicts, and custom encoded objects will be checked for circular references during encoding to prevent an infinite recursion (which would cause an RecursionError). Otherwise, no such check takes place.

If allow_nan is true, then NaN, Infinity, and -Infinity will be encoded as such. This behavior is not JSON specification compliant, but is consistent with most JavaScript based encoders and decoders. Otherwise, it will be a ValueError to encode such floats.

If sort_keys is true, then the output of dictionaries will be sorted by key; this is useful for regression tests to ensure that JSON serializations can be compared on a day-to-day basis.

If indent is a non-negative integer, then JSON array elements and object members will be pretty-printed with that indent level. An indent level of 0 will only insert newlines. None is the most compact representation.

If specified, separators should be an (item_separator, key_separator) tuple. The default is (’, ‘, ‘: ‘) if indent is None and (‘,’, ‘: ‘) otherwise. To get the most compact JSON representation, you should specify (‘,’, ‘:’) to eliminate whitespace.

If specified, default is a function that gets called for objects that can’t otherwise be serialized. It should return a JSON encodable version of the object or raise a TypeError.

encode(o, *args, **kwargs)[source]¶

Return a JSON string representation of a Python data structure.

>>> from json.encoder import JSONEncoder
>>> JSONEncoder().encode({"foo": ["bar", "baz"]})
'{"foo": ["bar", "baz"]}'

default(o)[source]¶

Encodes an object using the supplied WebAPIEncoder.

If the encoder is unable to encode this object, a TypeError is raised.

__annotations__ = {}¶

class XMLEncoderAdapter(encoder, *args, **kwargs)[source]¶

Bases: object

Adapts a WebAPIEncoder to output XML.

This takes an existing encoder and adapts it to output a simple XML format.

__init__(encoder, *args, **kwargs)[source]¶

encode(o, *args, **kwargs)[source]¶

startElement(name, attrs={})[source]¶

endElement(name)[source]¶

text(value)[source]¶

addIndent()[source]¶

get_registered_encoders()[source]¶

Returns a list of registered Web API encoders.