sgn-inspect

Discover and inspect SGN elements and plugins

Resources

• Documentation
• Source Code
• Issue Tracker

Installation

With pip:

pip install sgn-inspect

Quickstart

Display information about all installed elements:

➜ sgn-inspect
SGN elements · 2 plugins · 10 elements ─────────────────────────────────────────

base · 8 elements ──────────────────────────────────────────────────────────────

 Element             Type        Description
 ──────────────────────────────────────────────────────────────────────────────
 DequeSource         source      A source element that has one
                                 double-ended-queue (deque) per source pad.
 IterSource          source      A source element that has one iterable per
                                 source pad.
 NullSource          source      A source that does precisely nothing.
 StatsSource         source      A source element that produces system
                                 statistics.
 CallableTransform   transform   A transform element that takes a mapping of
                                 {(input, combinations) -> callable}, each of
                                 which is mapped to a unique output pad.
 CollectSink         sink        A sink element that has one collection per
                                 sink pad.
 DequeSink           sink        A sink element that has one
                                 double-ended-queue (deque) per sink pad.
 NullSink            sink        A sink that does precisely nothing.

arrakis · 2 elements ───────────────────────────────────────────────────────────

 Element             Type        Description
 ──────────────────────────────────────────────────────────────────────────────
 ArrakisSource       source      Source element that streams channel data from
                                 Arrakis.
 ArrakisSink         sink        Sink element that streams channel data to
                                 Arrakis.

Display information about a particular plugin:

➜ sgn-inspect base
base · plugin ──────────────────────────────────────────────────────────────────

Library      sgn
Package      sgn
Description  A framework to help navigate buffers through a graph. The buffers
             must flow.
Version      0.11.1
License      MPL-2.0
Project URL  https://git.ligo.org/greg/sgn

Elements · 8 ───────────────────────────────────────────────────────────────────

 Element             Type        Module           Description
 ──────────────────────────────────────────────────────────────────────────────
 DequeSource         source      sgn.sources      A source element that has one
                                                  double-ended-queue (deque)
                                                  per source pad.
 IterSource          source      sgn.sources      A source element that has one
                                                  iterable per source pad.
 NullSource          source      sgn.sources      A source that does precisely
                                                  nothing.
 StatsSource         source      sgn.sources      A source element that
                                                  produces system statistics.
 CallableTransform   transform   sgn.transforms   A transform element that
                                                  takes a mapping of {(input,
                                                  combinations) -> callable},
                                                  each of which is mapped to a
                                                  unique output pad.
 CollectSink         sink        sgn.sinks        A sink element that has one
                                                  collection per sink pad.
 DequeSink           sink        sgn.sinks        A sink element that has one
                                                  double-ended-queue (deque)
                                                  per sink pad.
 NullSink            sink        sgn.sinks        A sink that does precisely
                                                  nothing.

Display information about a particular element:

➜ sgn-inspect IterSource
IterSource · source ────────────────────────────────────────────────────────────

Plugin  base
Class   sgn.sources.IterSource

A source element that has one iterable per source pad.

On each call to new one value is pulled from the per-pad
iterator and wrapped in a frame.  When an iterator is exhausted the
next frame produced for that pad has data=None and is_gap=True;
EOS is signaled on that same frame iff eos_on_empty is True for
the pad (the default).

Hierarchy ──────────────────────────────────────────────────────────────────────

sgn.base.SourceElement
└── sgn.sources.IterSource

Pads ───────────────────────────────────────────────────────────────────────────

[ IterSource ] ──▶ N sources

source  on request via source_pad_names

Properties ─────────────────────────────────────────────────────────────────────

 Property        Type                       Default   Description
 ──────────────────────────────────────────────────────────────────────────────
 iters           dict[str, Iterable[Any]]   None      dict[str, Iterable[Any]],
                 | None                               a mapping of source pads
                                                      to iterables, where the
                                                      key is the pad name and
                                                      the value is the
                                                      Iterable. These will be
                                                      coerced to iterators, so
                                                      they can be any iterable
                                                      type.
 eos_on_empty    dict[str, bool] | bool     True      dict[str, bool] | bool,
                                                      default True, a mapping
                                                      of source pads to boolean
                                                      values, where the key is
                                                      the pad name and the
                                                      value is the boolean. If
                                                      a bool is given, the
                                                      value is applied to all
                                                      pads. If True, EOS is
                                                      signaled when the
                                                      iterator is empty.
 frame_factory   Callable                   Frame