`spec`¶

DependsType¶

Either an absolute identifier (which is treated as a positional-only arg) or a dict mapping as described in _DependsBasic.

Examples

```python def example(positional_only: int, /, another_arg: str) -> None:

return another_arg * positional_only

```

```yaml nodes:

zzz:
type: example depends: - a.value - another_arg: b.value

```

When a dependency is a scalar value passed to the first positional argument, it can be specified with a scalar reference to an absolute identifier. For example, if one wanted to return a scalar value from a return node, specify the dependency like this:

```yaml nodes:

yyy:
type: return depends: a.value

```

and to return the same value wrapped in a list…

```yaml nodes:

yyy:
type: return depends: - a.value

```

alias of list[Annotated[str, AfterValidator(func=_is_signal_slot)] | Annotated[dict[Annotated[str, AfterValidator(func=_is_identifier), AfterValidator(func=_not_reserved)], Annotated[str, AfterValidator(func=_is_signal_slot)]], Len(min_length=1, max_length=1)]] | Annotated[str, AfterValidator(func=_is_signal_slot)]

class NodeInfo[source]¶

Metadata about the completed spec given the combination of a node spec and a node class.

The spec if purely static, the node class is mostly static, but some important properties - notably signals and slots - can be dynamic: i.e. the signals or slots of the node depend on the spec.

This metadata is primarily used in visualization or inspection of tubes, rather than at runtime

node_id: str¶: Node ID whose spec this NodeInfo was computed from

type: str¶: fully-qualified module.object name for the node type

signals: dict[str, Signal]¶: Signals computed from the spec and node class

slots: dict[str, Slot]¶: Slots computed from the spec and node class

pydantic model NodeSpecification[source]¶

Specification for a single processing node within a tube .yaml file.

Config:

extra: str = forbid
serialize_by_alias: bool = True

Fields:

depends (list[str | dict[str, str]] | str | None)
description (str | None)
enabled (bool)
id (str)
params (dict | None)
stateful (bool | None)
type_ (str)

Validators:

slots_unique » depends

field depends: DependsType | None = None¶

Dependency specification for the node.

Can be specified as a simple mapping from this node’s input slots to another node’s output signals passed as kwargs, or as a flat list of node.signal identifiers that are passed as positional args.

Validated by:

slots_unique

field description: str | None = None¶: An optional description of the node

field enabled: bool = True¶: If this flag is False, the node will not be initialized or included in the :meth:.Tube.graph.

field id: PythonIdentifier [Required]¶

The unique identifier of the node

Constraints:

func = <function _not_reserved at 0x77b4ae504cc0>

field params: dict | None = None¶: Static kwargs to pass to this node, parameterized the signature of a function node, or by a TypedDict for a class node.

field stateful: bool | None = None¶: See Node.stateful , explicitly set statefulness on a node, overriding its default. If None , use the default set on the node class.

field type_: AbsoluteIdentifier [Required] (alias 'type')¶

Shortname of the type of node this configuration is for.

Subclasses should override this with a default.

Constraints:

func = <function _is_absolute_identifier at 0x77b4ae504a40>

validator slots_unique » depends[source]¶: Ensure slots are unique in dependency spec: can’t map more than one signal to the same slot

property nodeinfo: NodeInfo¶: Information about the node that this spec is for.

spec¶

`spec`¶