Skip to content

API Reference

Every name documented here is re-exported from the top-level warptap package (from warptap import ...): this is warptap's own curated public surface, not a flattening of every internal helper. Anything not listed here is an internal implementation detail and may change without notice.

Every exception below subclasses WarptapError:

Shared exception base for warptap (library-quality pass, post-Stage 14). Every one of this project's other error classes (IclEmitError, SibInsertError, FaultflowRetargetError, etc. -- 17 in total, each named for exactly the failure mode it represents) subclasses :class:WarptapError instead of RuntimeError directly, so a caller can catch "anything warptap raises" without enumerating every specific subclass, while every existing except RuntimeError/except <SpecificError> call site keeps working unmodified -- WarptapError IS a RuntimeError, this is a purely additive common ancestor, not a behavior change to any existing exception.

WarptapError

Bases: RuntimeError

Base for every exception this library raises. Catch this to handle any warptap-raised error without enumerating each specific subclass; catch a specific subclass (e.g. :class:~warptap.icl_emit.IclEmitError) when only that one failure mode matters.

Pages

  • Netlist & Ingest: Yosys JSON ingest and re-emission
  • Network Model: the physical shift-topology graph and its node types
  • Insertion: building and inserting a SIB/BSR network
  • PDL: driving the network, PDL text emit/import, read verification
  • ICL: ICL text emit/import
  • BSDL: TAP-only BSDL emit, the file an ICL AccessLink points at
  • Network Integrity: TAP/IJTAG network-integrity patterns and their TDO check
  • IEEE 1500 wrapper: a wrapper and its serial port: model, ICL, PDL, scan operations, integrity program
  • Pattern Export: the shared TAP-transaction IR, SVF/STAPL/STIL emitters
  • Faultflow: retargeting faultflow's own exported patterns