spacr.flowview.events

Small, picklable event values emitted by FlowView instrumentation.

Classes

EdgeAdded	Declare a directed relationship between two nodes.
NodeAdded	Declare a node before it starts running.
StageCompleted	Mark a stage as successfully completed.
StageFailed	Mark a stage as failed and retain its formatted traceback.
StageMetric	Attach one scalar metric to a stage.
StageProgress	Report completed and total work for a stage.
StageStarted	Mark a declared or newly observed stage as running.
StageThumbnail	Attach a cached thumbnail path to a stage.

Module Contents

class spacr.flowview.events.EdgeAdded

Declare a directed relationship between two nodes.

Parameters:

edge – directed transfer to add to the displayed flow graph. An equal edge is retained only once.

class spacr.flowview.events.NodeAdded

Declare a node before it starts running.

Parameters:

node – node snapshot to insert by identifier when that identifier is not already declared. A duplicate declaration leaves the existing node unchanged.

class spacr.flowview.events.StageCompleted

Mark a stage as successfully completed.

Parameters:

• node_id – identifier of the existing stage that finished. An unknown identifier is ignored by the collector.

• at – producer timestamp stored as the stage’s end time.

class spacr.flowview.events.StageFailed

Mark a stage as failed and retain its formatted traceback.

Parameters:

• node_id – identifier of the existing stage that failed. An unknown identifier is ignored and does not affect known descendants.

• at – failure timestamp stored as the stage’s end time and assigned to known downstream stages when they are marked skipped.

• error – formatted exception or traceback retained on the failed stage; its known downstream stages are marked skipped.

class spacr.flowview.events.StageMetric

Attach one scalar metric to a stage.

Parameters:

• node_id – identifier of the existing stage that owns the metric. An unknown identifier is ignored by the collector.

• name – metric key; a later event with the same name replaces it.

• value – float, integer, or string retained without coercion in the stage’s detached metrics mapping.

class spacr.flowview.events.StageProgress

Report completed and total work for a stage.

Parameters:

• node_id – identifier of the existing stage to update. An unknown identifier is ignored by the collector.

• current – completed-work count stored verbatim, without clamping.

• total – expected-work count stored verbatim, without validation.

class spacr.flowview.events.StageStarted

Mark a declared or newly observed stage as running.

Parameters:

• node – stage snapshot supplying its identifier, label, kind, and parameters. An absent node is declared; a prior node keeps its state while receiving the new snapshot’s parameters.

• at – producer timestamp stored as the stage’s start time. Starting clears any earlier end time and error.

class spacr.flowview.events.StageThumbnail

Attach a cached thumbnail path to a stage.

Parameters:

• node_id – identifier of the existing stage represented by the image. An unknown identifier is ignored by the collector.

• path – thumbnail path stored without checking that it exists; trace producers normalise path-like values before constructing the event.