export module#

The parts-check exporter#

Runs a design under the check lock mode and reports what it found, from the command line:

jitx design export parts-check my_board.MyDesign
jitx design export parts-check my_board.MyDesign --output parts-check.txt
jitx design export parts-check my_board.MyDesign --fail differs

The report goes to stdout unless –output names a file. The export succeeds whatever the report says, unless –fail names categories to fail on.

class FailOn(*values)[source]#

Bases: StrEnum

A report category that fails the export. all is every failing category.

ALL = 'all'#
UNLOCKED = 'unlocked'#
STALE_CHAIN = 'stale-chain'#
REPLAY_FAILED = 'replay-failed'#
UNRESOLVABLE = 'unresolvable'#
DIFFERS = 'differs'#
class PartsCheck[source]#

Bases: Export

Check the design’s parts against a clean resolution and report differences.

The report is written to stdout, or to the file named by –output. The export fails only when the report has an entry in a category named by –fail, which may be repeated; –fail all fails on any of them.

preflight(output=None, fail=None)[source]#

Called before anything is instantiatiated or submitted to the runtime to allow an early out in case arguments are invalid. Raise an exception to prevent the export from proceeding.

Return type:

None

Parameters:
export(design, /, output=None, fail=None)[source]#
Return type:

None

Parameters:
failing_categories(verdict, fail)[source]#

The categories named by fail that verdict has entries in, in report order.

Return type:

list[str]

Parameters:
design_verdict(design)[source]#

The parts verdict of the run that elaborated design.

A design with no deferred parts has an empty verdict.

Return type:

Verdict

Parameters:

design (RuntimeDesign)