DocumentNode

class dsviper.DocumentNode

Bases: object

A class used to represent a node in the tree representation of a value.

Note: Not directly instantiable.

attachment() → Attachment

Return the attachment.

children() → list[DocumentNode]

Return the list of child.

static create_documents(key: ValueKey, attachment_getting: AttachmentGetting) → list[DocumentNode]

Return a list of documents as a hierarchy of DocumentNode.

document() → Value

Return the document.

is_blob_id() → bool

Return True the node is a blob_id.

is_boolean() → bool

Return True the node is a boolean.

is_collection() → bool

Return True the node is a collection.

is_container() → bool

Return True it’s a container.

is_double() → bool

Return True the node is a double.

is_editable() → bool

Return True if it’s editable.

is_enumeration() → bool

Return True the node is an enumeration.

is_expandable() → bool

Return True the node is expandable.

is_float() → bool

Return True the node is a float.

is_int16() → bool

Return True the node is an int16.

is_int32() → bool

Return True the node is an int32.

is_int64() → bool

Return True the node is an int64.

is_int8() → bool

Return True the node is an int8.

is_integer() → bool

Return True the node is an integer.

is_key() → bool

Return True the node is a key.

is_numeric() → bool

Return True the node is a number.

is_primitive() → bool

Return True the node is a primitive.

is_readonly() → bool

Return True if it’s readonly.

is_real() → bool

Return True the node is real.

is_string() → bool

Return True the node is a string.

is_uint16() → bool

Return True the node is an uint16.

is_uint32() → bool

Return True the node is an uint32.

is_uint64() → bool

Return True the node is an uint64.

is_uint8() → bool

Return True the node is an uint8.

is_uuid() → bool

Return True the node is an uuid.

key() → ValueKey

Return the key.

parent() → DocumentNode | None

Return the parent or None.

path() → PathConst

Return the path.

string_component() → str

Return the string component.

string_component_tooltip() → str

Return the string component tooltip.

string_path() → str

Return the string path.

string_type() → str

Return the string type.

string_value() → str

Return the string_value.

string_value_tooltip() → str

Return the string value tooltip.

type() → str

Return the type of node.

uuid() → ValueUUId

Return the uuid.

value() → Value

Return the value.