API Documentation

exception tendril.entities.base.EntityNotFound

Bases: Exception

exception tendril.entities.base.EntityHasNoStructure

Bases: Exception

class tendril.entities.base.EntityBase(vctx=None)

Bases: tendril.validation.base.ValidatableBase

Placeholder class for potentially track-able objects.

Depending on the implementation used, this class should inherit from an external class built for this purpose instead of from object.

define(*args, **kwargs)

property defined

State of the component. The component should be used only when it is fully defined.

This is a read-only property.

property ident

property refdes

property desc

json()

_validate()

class tendril.entities.base.StructuredEntityBase

Bases: tendril.entities.base.EntityBase

property structure

insert(item, *args, **kwargs)

contents()

_validate()

json()

class tendril.entities.base.GenericEntity

Bases: tendril.entities.base.StructuredEntityBase

property domain

property ident

property refdes

property desc

define(**kwargs)

_validate()

class tendril.entities.base.GroupAwareEntity

Bases: tendril.entities.base.GenericEntity

property group_name

define(**kwargs)

_validate()