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)[source]
class plynx.db.node._BaseResource[source]

Bases: plynx.db.db_object.DBObject

name :str =[source]
file_type :str[source]
values :List[Any][source]
is_array :bool = False[source]
min_count :int = 1[source]
class plynx.db.node.Output[source]

Bases: plynx.db.node._BaseResource

Basic Output structure.

thumbnail :Optional[str][source]
class plynx.db.node.InputReference[source]

Bases: plynx.db.db_object.DBObject

Basic Value of the Input structure.

node_id :ObjectId[source]
output_id :str =[source]
class plynx.db.node.Input[source]

Bases: plynx.db.node._BaseResource

Basic Input structure.

primitive_override :Any[source]
input_references :List[InputReference][source]
__post_init__(self)[source]

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

add_input_reference(self, node_id: ObjectId, output_id: str)[source]

Add input reference to the input

class plynx.db.node.CachedNode[source]

Bases: plynx.db.db_object.DBObject

Values to override Node on display

node_running_status :str[source]
outputs :List[Output][source]
logs :List[Output][source]
class plynx.db.node.Node[source]

Bases: plynx.db.db_object.DBObject

Basic Node with db interface.

DB_COLLECTION[source]
_id :ObjectId[source]
_type :str = Node[source]
_cached_node :Optional[CachedNode][source]
title :str = Title[source]
description :str =[source]
kind :str = dummy[source]
parent_node_id :Optional[ObjectId][source]
successor_node_id :Optional[ObjectId][source]
original_node_id :Optional[ObjectId][source]
template_node_id :Optional[ObjectId][source]
origin :str[source]
code_hash :str =[source]
code_function_location :Optional[str][source]
node_running_status :str[source]
node_status :str[source]
cache_url :Optional[str][source]
x :int = 0[source]
y :int = 0[source]
author :Optional[ObjectId][source]
starred :bool = False[source]
auto_sync :bool = True[source]
auto_run :bool = True[source]
auto_run_enabled :bool = True[source]
latest_run_id :Optional[ObjectId][source]
inputs :List[Input][source]
parameters :List['Parameter'][source]
outputs :List[Output][source]
logs :List[Output][source]
static _default_log(name: str)[source]
apply_properties(self, other_node: 'Node')[source]

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)[source]

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)[source]
get_input_by_name(self, name: str)[source]

Find Input object

get_parameter_by_name(self, name: str)[source]

Find Parameter object

get_parameter_by_name_safe(self, name: str)[source]

Find Parameter object

get_output_by_name(self, name: str)[source]

Find Output object

get_log_by_name(self, name: str)[source]

Find Log object

get_sub_nodes(self)[source]

Get a list of subnodes

class plynx.db.node.ParameterEnum[source]

Bases: plynx.db.db_object.DBObject

Enum value.

values :List[str][source]
index :int = 0[source]
class plynx.db.node.ParameterCode[source]

Bases: plynx.db.db_object.DBObject

Code value.

value :str =[source]
mode :str = python[source]
class plynx.db.node.ParameterListOfNodes[source]

Bases: plynx.db.db_object.DBObject

List Of Nodes value.

value :List[Node][source]
plynx.db.node._get_default_by_type(parameter_type: str)[source]
plynx.db.node._value_is_valid(value, parameter_type: str)[source]
class plynx.db.node.Parameter[source]

Bases: plynx.db.db_object.DBObject

Basic Parameter structure.

name :str =[source]
parameter_type :str[source]
value :Any =[source]
mutable_type :bool = True[source]
removable :bool = True[source]
publicable :bool = True[source]
widget :Optional[str][source]
reference :Optional[str][source]
__post_init__(self)[source]