autobahn.flatbuffers.flexbuffers

Implementation of FlexBuffers binary format.

For more info check https://google.github.io/flatbuffers/flexbuffers.html and corresponding C++ implementation at https://github.com/google/flatbuffers/blob/master/include/flatbuffers/flexbuffers.h

Classes

Builder	Helper class to encode structural data into flexbuffers format.
Type	Supported types of encoded data.

Functions

Dumps(obj)	Returns bytearray with the encoded python object.
GetRoot(buf)	Returns root Ref object for the given buffer.
Loads(buf)	Returns python object decoded from the buffer.

Module Contents

class Builder(share_strings=False, share_keys=True, force_min_bit_width=BitWidth.W8)

Helper class to encode structural data into flexbuffers format.

Add(value)

Encodes value of any supported type.

Adder(type_)

Blob(value)

Encodes binary blob value.

Parameters:

value – A byte/bytearray value to encode

Returns:

Offset of the encoded value in underlying the byte buffer.

Bool(value)

Encodes boolean value.

Parameters:

value – A boolean value.

Clear()

Finish()

Finishes encoding process and returns underlying buffer.

FixedTypedVectorFromElements(elements, element_type=None, byte_width=0)

Encodes sequence of elements of the same type as fixed typed vector.

Parameters:

• elements – Sequence of elements, they must be of the same type. Allowed types are Type.INT, Type.UINT, Type.FLOAT. Allowed number of elements are 2, 3, or 4.

• element_type – Suggested element type. Setting it to None means determining correct value automatically based on the given elements.

• byte_width – Number of bytes to use per element. For Type.INT and Type.UINT: 1, 2, 4, or 8. For Type.FLOAT: 4 or 8. Setting it to 0 means determining correct value automatically based on the given elements.

Float(value, byte_width=0)

Encodes floating point value.

Parameters:

• value – A floating point value.

• byte_width – Number of bytes to use: 4 or 8.

IndirectFloat(value, byte_width=0)

Encodes floating point value indirectly.

Parameters:

• value – A floating point value.

• byte_width – Number of bytes to use: 4 or 8.

IndirectInt(value, byte_width=0)

Encodes signed integer value indirectly.

Parameters:

• value – A signed integer value.

• byte_width – Number of bytes to use: 1, 2, 4, or 8.

IndirectUInt(value, byte_width=0)

Encodes unsigned integer value indirectly.

Parameters:

• value – An unsigned integer value.

• byte_width – Number of bytes to use: 1, 2, 4, or 8.

Int(value, byte_width=0)

Encodes signed integer value.

Parameters:

• value – A signed integer value.

• byte_width – Number of bytes to use: 1, 2, 4, or 8.

Key(value)

Encodes key value.

Parameters:

value – A byte/bytearray/str value to encode. Byte object must not contain zero bytes. String object must be convertible to ASCII.

Returns:

Offset of the encoded value in the underlying byte buffer.

property KeyPool

property LastValue

Map(key=None)

MapFromElements(elements)

Null(key=None)

Encodes None value.

ReuseValue(value)

String(value)

Encodes string value.

property StringPool

TypedVector(key=None)

TypedVectorFromElements(elements, element_type=None)

Encodes sequence of elements of the same type as typed vector.

Parameters:

• elements – Sequence of elements, they must be of the same type.

• element_type – Suggested element type. Setting it to None means determining correct value automatically based on the given elements.

UInt(value, byte_width=0)

Encodes unsigned integer value.

Parameters:

• value – An unsigned integer value.

• byte_width – Number of bytes to use: 1, 2, 4, or 8.

Vector(key=None)

VectorFromElements(elements)

Encodes sequence of any elements as a vector.

Parameters:

elements – sequence of elements, they may have different types.

_Align(alignment)

_CreateVector(elements, typed, fixed, keys=None)

Writes vector elements to the underlying buffer.

_EndMap(start)

Finishes map construction by encodung its elements.

_EndVector(start, typed, fixed)

Finishes vector construction by encodung its elements.

_PushIndirect(value, type_, bit_width)

_ReadKey(offset)

_StartMap()

Starts map construction.

_StartVector()

Starts vector construction.

_Write(fmt, value, byte_width)

_WriteAny(value, byte_width)

_WriteBlob(data, append_zero, type_)

_WriteOffset(offset, byte_width)

_WriteScalarVector(element_type, byte_width, elements, fixed)

Writes scalar vector elements to the underlying buffer.

_WriteVector(fmt, values, byte_width)

__len__()

_buf

_finished = False

_force_min_bit_width

_key_pool

_share_keys = True

_share_strings = False

_stack = []

_string_pool

Dumps(obj)

Returns bytearray with the encoded python object.

GetRoot(buf)

Returns root Ref object for the given buffer.

Loads(buf)

Returns python object decoded from the buffer.

class Type

Bases: enum.IntEnum

Supported types of encoded data.

These are used as the upper 6 bits of a type field to indicate the actual type.

BLOB = 25

BOOL = 26

FLOAT = 3

INDIRECT_FLOAT = 8

INDIRECT_INT = 6

INDIRECT_UINT = 7

INT = 1

static IsFixedTypedVector(type_)

static IsFixedTypedVectorElementType(type_)

static IsInline(type_)

static IsTypedVector(type_)

static IsTypedVectorElementType(type_)

KEY = 4

MAP = 9

NULL = 0

static Pack(type_, bit_width)

STRING = 5

static ToFixedTypedVectorElementType(type_)

static ToTypedVector(element_type, fixed_len=0)

Converts element type to corresponding vector type.

Parameters:

• element_type – vector element type

• fixed_len – number of elements: 0 for typed vector; 2, 3, or 4 for fixed typed vector.

Returns:

Typed vector type or fixed typed vector type.

static ToTypedVectorElementType(type_)

UINT = 2

static Unpack(packed_type)

VECTOR = 10

VECTOR_BOOL = 36

VECTOR_FLOAT = 13

VECTOR_FLOAT2 = 18

VECTOR_FLOAT3 = 21

VECTOR_FLOAT4 = 24

VECTOR_INT = 11

VECTOR_INT2 = 16

VECTOR_INT3 = 19

VECTOR_INT4 = 22

VECTOR_KEY = 14

VECTOR_STRING_DEPRECATED = 15

VECTOR_UINT = 12

VECTOR_UINT2 = 17

VECTOR_UINT3 = 20

VECTOR_UINT4 = 23