jitx.run package#

Design discovery and execution#

This module provides tools for discovering, building, and executing JITX designs, including communication with the JITX runtime. Normally this module is not used directly, but rather through the jitx command line, or through the VSCode extension.

Warning

The API in this module is still experimental and may change significantly without notice.

class DesignFactory(finder=None, builder=None, *, formatter=None, dump=None)[source]#
Parameters:
by_name(name)[source]#
Parameters:

name (str)

by_file(name)[source]#
Parameters:

name (str)

add_all()[source]#
add(design, *, name=None)[source]#
Parameters:
build()[source]#
list()[source]#
class DesignFinder(roots=None)[source]#
Parameters:

roots (str | Sequence[str] | None)

find_all()[source]#
find_by_name(name)[source]#
Parameters:

name (str)

find_by_module(name)[source]#
Parameters:

name (str)

find_by_file(path)[source]#
Parameters:

path (str)

class BaseDesignBuilder[source]#

Bases: ABC

build(design, *, name=None, dump=None, formatter)[source]#

Build the design. This is a base class, where the design gets sent is determined by the specific subclass implementation.

Parameters:

  • design (type[Design]) – The Design class to build.

  • name (str | None) – Optional name for the design.

  • dump (str | None) – Optional file path to dump the design data.

  • formatter (Formatter) – Function to format and output results.

Return type:

Mapping[str, Any]

class DryRunBuilder[source]#

Bases: BaseDesignBuilder

class DesignBuilder(*, spec: str | None = None)[source]#
class DesignBuilder(*, uri: str)
class DesignBuilder(*, port: int, host: str = 'localhost')

Bases: BaseDesignBuilder

Parameters:

  • spec (str | None)

  • uri (str | None)

  • port (int | None)

  • host (str | None)

build(design, *, name=None, dump=None, formatter)[source]#

Build the design. This is a base class, where the design gets sent is determined by the specific subclass implementation.

Parameters:

  • design (type[Design]) – The Design class to build.

  • name (str | None) – Optional name for the design.

  • dump (str | None) – Optional file path to dump the design data.

  • formatter (Formatter) – Function to format and output results.

Return type:

Mapping[str, Any]

class Formatter(*args, **kwargs)[source]#

Bases: Protocol

json_formatter(ob, file=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)[source]#
text_formatter(ob, file=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>, indent=0)[source]#

Submodules#