plynx.db.node

Node DB Object and utils

Module Contents

plynx.db.node._clone_update_in_place(node: 'Node', node_clone_policy: int, override_finished_state: bool, override_node_id: bool = False)

class plynx.db.node._BaseResource

Bases: plynx.db.db_object.DBObject

name :str =

file_type :str

values :List[Any]

is_array :bool = False

min_count :int = 1

class plynx.db.node.Output

Bases: plynx.db.node._BaseResource

Basic Output structure.

thumbnail :Optional[str]

class plynx.db.node.InputReference

Bases: plynx.db.db_object.DBObject

Basic Value of the Input structure.

node_id :ObjectId

output_id :str =

class plynx.db.node.Input

Bases: plynx.db.node._BaseResource

Basic Input structure.

primitive_override :Any

input_references :List[InputReference]

__post_init__(self)

Set default primitive_override if it is not set and file_type is primitive

add_input_reference(self, node_id: ObjectId, output_id: str)

Add input reference to the input

class plynx.db.node.CachedNode

Bases: plynx.db.db_object.DBObject

Values to override Node on display

node_running_status :str

outputs :List[Output]

logs :List[Output]

class plynx.db.node.Node

Bases: plynx.db.db_object.DBObject

Basic Node with db interface.

DB_COLLECTION

_id :ObjectId

_type :str = Node

_cached_node :Optional[CachedNode]

title :str = Title

description :str =

kind :str = dummy

parent_node_id :Optional[ObjectId]

successor_node_id :Optional[ObjectId]

original_node_id :Optional[ObjectId]

template_node_id :Optional[ObjectId]

origin :str

code_hash :str =

code_function_location :Optional[str]

node_running_status :str

node_status :str

cache_url :Optional[str]

x :int = 0

y :int = 0

author :Optional[ObjectId]

starred :bool = False

auto_sync :bool = True

auto_run :bool = True

auto_run_enabled :bool = True

latest_run_id :Optional[ObjectId]

inputs :List[Input]

parameters :List['Parameter']

outputs :List[Output]

logs :List[Output]

static _default_log(name: str)

apply_properties(self, other_node: 'Node')

Apply Properties and Inputs of another Node. This method is used for updating nodes.

Args:

other_node (Node): A node to copy Properties and Inputs from

clone(self, node_clone_policy: int, override_finished_state: bool = True)

Return a cloned copy of a Node

_get_custom_element(self, arr: Union[List[Input], List['Parameter'], List[Output]], name: str, throw: bool, default: Optional[Callable[[str], Union[Input, 'Parameter', Output]]] = None)

get_input_by_name(self, name: str)

Find Input object

get_parameter_by_name(self, name: str)

Find Parameter object

get_parameter_by_name_safe(self, name: str)

Find Parameter object

get_output_by_name(self, name: str)

Find Output object

get_log_by_name(self, name: str)

Find Log object

get_sub_nodes(self)

Get a list of subnodes

class plynx.db.node.ParameterEnum

Bases: plynx.db.db_object.DBObject

Enum value.

values :List[str]

index :int = 0

class plynx.db.node.ParameterCode

Bases: plynx.db.db_object.DBObject

Code value.

value :str =

mode :str = python

class plynx.db.node.ParameterListOfNodes

Bases: plynx.db.db_object.DBObject

List Of Nodes value.

value :List[Node]

plynx.db.node._get_default_by_type(parameter_type: str)

plynx.db.node._value_is_valid(value, parameter_type: str)

class plynx.db.node.Parameter

Bases: plynx.db.db_object.DBObject

Basic Parameter structure.

name :str =

parameter_type :str

value :Any =

mutable_type :bool = True

removable :bool = True

publicable :bool = True

widget :Optional[str]

reference :Optional[str]

__post_init__(self)