API Reference

Exact signatures are imported from the current code using autodoc. For an introduction, start with Your first model.

bytespec.ProtoModel(**kwargs)	The base model class for binary serialization.
bytespec.field([index, flag, default, ...])	Configure a serializable model field.
bytespec.ByteOrder(*values)	The byte order of the model's fixed-width numbers and prefixes.
bytespec.Constructor(encoding)	Model identifier from constructor, validated during decoding.
bytespec.PayloadLength(encoding)	The size of all encoded fields, excluding the entire header.
bytespec.Flags(encoding)	A bitmap indicating the presence of optional fields, computed from their values.
bytespec.codecs.ICodec(*args, **kwargs)	Interface for writing and reading a single value of type T.
bytespec.BytespecError	Common base class for schema, encoding, and decoding errors.

• Models and fields
• Header elements
• Types and specifications
• Codecs
• Extension types
• Exceptions

Library version

bytespec.__version__ = '0.1.0'

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to ‘utf-8’. errors defaults to ‘strict’.