discover module#

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]#

Bases: object

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]#

Bases: object

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]#
Return type:

Mapping[str, Any]

Parameters:
class DryRunBuilder[source]#

Bases: BaseDesignBuilder

class DesignBuilder(*, spec=None, uri=None, port=None, host=None)[source]#

Bases: BaseDesignBuilder

Overloads:

  • *, spec (str | None) = None

  • *, uri (str)

  • *, port (int), host (str) = 'localhost'

Parameters:

  • spec (str | None)

  • uri (str | None)

  • port (int | None)

  • host (str | None)

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

Mapping[str, Any]

Overrides:

BaseDesignBuilder.build

Parameters: