Skip to content

← control_flow package

GraphPlaceholder

A placeholder that can accept a graph or callable function.

This can be used when declaring functions that accept other functions as arguments. This is used, for example, for call-back functions or small ad-hoc functions (like a+b) that are passed into another function. Note that if the graph that you receive itself contains free placeholders which need to be bound downstream in your function in order for the received graph to be runnable, you will have to declare those free placeholders in the "graph [contained free names]" field (or in code, in the graph__signature field). However, this is not always the case, in fact most ad hoc functions do not have any free placeholders, and can instead be called with some number of positional arguments (depending on the intended use case). More Info... Version 1.0.0

Ports/Properties

graph

Received graph.

verbose name
Graph
default value
None
port type
GraphPort
value type
Graph

graph__signature

Signature for the "graph" input. This represents the contained free names for the subgraph that is wired into the "graph" port. This is formatted as in (a,b,c) where a,b,c are names of placeholders that are expected in the subgraph that goes out of the "graph" port. Alternatively, it can also be provided in data structure form as a list of lists, as in: [['a','b','c']].

verbose name
Graph [Contained Free Names]
default value
(~)
port type
Port
value type
object (can be None)

slotname

Name of the placeholder.

verbose name
Name
default value
graph
port type
StringPort
value type
str (can be None)

verbose_name

Optional verbose name for the placeholder. Can be used in function declarations for a more descriptive name.

verbose name
Verbose Name
default value
None
port type
StringPort
value type
str (can be None)

desc

Help text for the placeholder. Only needs to be specified in function declarations. This is typically a single sentence.

verbose name
Desc
default value
port type
StringPort
value type
str (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

verbose name
Set Breakpoint (Debug Only)
default value
False
port type
BoolPort
value type
bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

verbose name
Metadata
default value
{}
port type
DictPort
value type
dict (can be None)