API documentation

class tri.named_struct.NamedFrozenStruct(*args, **kwargs)

Class extending tri.struct.FrozenStruct to only allow a defined subset of string keys.

__weakref__

list of weak references to the object (if defined)

classmethod get_declared(parameter='members')

Get the OrderedDict value of the parameter collected by the @declarative class decorator. This is the same value that would be submitted to the __init__ invocation in the members argument (or another name if overridden by the parameter specification) @type cls: class @type parameter: str @return OrderedDict

classmethod set_declared(value, parameter='members')

@type cls: class @type value: OrderedDict @type parameter: str

class tri.named_struct.NamedStruct(*args, **kwargs)

Class extending tri.struct.Struct to only allow a defined subset of string keys.

classmethod get_declared(parameter='members')

Get the OrderedDict value of the parameter collected by the @declarative class decorator. This is the same value that would be submitted to the __init__ invocation in the members argument (or another name if overridden by the parameter specification) @type cls: class @type parameter: str @return OrderedDict

classmethod set_declared(value, parameter='members')

@type cls: class @type value: OrderedDict @type parameter: str

class tri.named_struct.NamedStructField(*args, **kwargs)

Field declaration for NamedStruct classes

__ge__(other)

x.__ge__(y) <==> x>=y

__gt__(other)

x.__gt__(y) <==> x>y

__le__(other)

x.__le__(y) <==> x<=y

__weakref__

list of weak references to the object (if defined)

tri.named_struct.named_frozen_struct(field_names, typename='FrozenNamedStruct')

Procedural way to define a FrozenNamedStruct subclass, similar to the named_tuple builtin.

tri.named_struct.named_struct(field_names, typename='NamedStruct')

Procedural way to define a NamedStruct subclass, similar to the named_tuple builtin.