labgrid package

Subpackages

• labgrid.autoinstall package
  • Submodules
  • labgrid.autoinstall.main module
• labgrid.driver package
  • Subpackages
    • labgrid.driver.power package
      • Submodules
      • labgrid.driver.power.apc module
      • labgrid.driver.power.digipower module
      • labgrid.driver.power.gude module
      • labgrid.driver.power.gude24 module
      • labgrid.driver.power.gude8316 module
      • labgrid.driver.power.netio module
      • labgrid.driver.power.netio_kshell module
      • labgrid.driver.power.simplerest module
    • labgrid.driver.usbtmc package
      • Submodules
      • labgrid.driver.usbtmc.keysight_dsox2000 module
      • labgrid.driver.usbtmc.tektronix_tds2000 module
  • Submodules
  • labgrid.driver.bareboxdriver module
  • labgrid.driver.commandmixin module
  • labgrid.driver.common module
  • labgrid.driver.consoleexpectmixin module
  • labgrid.driver.exception module
  • labgrid.driver.externalconsoledriver module
  • labgrid.driver.fake module
  • labgrid.driver.fastbootdriver module
  • labgrid.driver.modbusdriver module
  • labgrid.driver.networkusbstoragedriver module
  • labgrid.driver.onewiredriver module
  • labgrid.driver.openocddriver module
  • labgrid.driver.powerdriver module
  • labgrid.driver.qemudriver module
  • labgrid.driver.quartushpsdriver module
  • labgrid.driver.resetdriver module
  • labgrid.driver.serialdigitaloutput module
  • labgrid.driver.serialdriver module
  • labgrid.driver.shelldriver module
  • labgrid.driver.sigrokdriver module
  • labgrid.driver.smallubootdriver module
  • labgrid.driver.sshdriver module
  • labgrid.driver.ubootdriver module
  • labgrid.driver.usbloader module
  • labgrid.driver.usbsdmuxdriver module
  • labgrid.driver.usbstorage module
  • labgrid.driver.usbtmcdriver module
  • labgrid.driver.usbvideodriver module
  • labgrid.driver.xenadriver module
• labgrid.external package
  • Submodules
  • labgrid.external.hawkbit module
  • labgrid.external.usbstick module
• labgrid.protocol package
  • Submodules
  • labgrid.protocol.bootstrapprotocol module
  • labgrid.protocol.commandprotocol module
  • labgrid.protocol.consoleprotocol module
  • labgrid.protocol.digitaloutputprotocol module
  • labgrid.protocol.filesystemprotocol module
  • labgrid.protocol.filetransferprotocol module
  • labgrid.protocol.infoprotocol module
  • labgrid.protocol.linuxbootprotocol module
  • labgrid.protocol.mmioprotocol module
  • labgrid.protocol.powerprotocol module
  • labgrid.protocol.resetprotocol module
• labgrid.provider package
  • Submodules
  • labgrid.provider.fileprovider module
  • labgrid.provider.mediafileprovider module
• labgrid.pytestplugin package
  • Submodules
  • labgrid.pytestplugin.fixtures module
  • labgrid.pytestplugin.hooks module
  • labgrid.pytestplugin.reporter module
• labgrid.remote package
  • Submodules
  • labgrid.remote.authenticator module
  • labgrid.remote.client module
  • labgrid.remote.common module
  • labgrid.remote.config module
  • labgrid.remote.coordinator module
  • labgrid.remote.exporter module
• labgrid.resource package
  • Submodules
  • labgrid.resource.base module
  • labgrid.resource.common module
  • labgrid.resource.ethernetport module
  • labgrid.resource.modbus module
  • labgrid.resource.networkservice module
  • labgrid.resource.onewireport module
  • labgrid.resource.power module
  • labgrid.resource.remote module
  • labgrid.resource.serialport module
  • labgrid.resource.sigrok module
  • labgrid.resource.udev module
  • labgrid.resource.xenamanager module
  • labgrid.resource.ykushpowerport module
• labgrid.strategy package
  • Submodules
  • labgrid.strategy.bareboxstrategy module
  • labgrid.strategy.common module
  • labgrid.strategy.graphstrategy module
  • labgrid.strategy.shellstrategy module
  • labgrid.strategy.ubootstrategy module
• labgrid.util package
  • Subpackages
    • labgrid.util.agents package
      • Submodules
      • labgrid.util.agents.dummy module
  • Submodules
  • labgrid.util.agent module
  • labgrid.util.agentwrapper module
  • labgrid.util.dict module
  • labgrid.util.exceptions module
  • labgrid.util.expect module
  • labgrid.util.helper module
  • labgrid.util.managedfile module
  • labgrid.util.marker module
  • labgrid.util.proxy module
  • labgrid.util.qmp module
  • labgrid.util.ssh module
  • labgrid.util.timeout module
  • labgrid.util.yaml module

Submodules

labgrid.binding module

exception labgrid.binding.StateError(msg)

Bases: Exception

__attrs_attrs__ = (Attribute(name='msg', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False),)

__init__(msg) → None

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'labgrid.binding'

__repr__()

Automatically created by attrs.

__weakref__

list of weak references to the object (if defined)

exception labgrid.binding.BindingError(msg)

Bases: Exception

__attrs_attrs__ = (Attribute(name='msg', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False),)

__init__(msg) → None

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'labgrid.binding'

__repr__()

Automatically created by attrs.

__weakref__

list of weak references to the object (if defined)

class labgrid.binding.BindingState

Bases: enum.Enum

An enumeration.

error = -1

idle = 0

bound = 1

active = 2

__module__ = 'labgrid.binding'

class labgrid.binding.BindingMixin(target, name)

Bases: object

Handles the binding and activation of drivers and their supplying resources and drivers.

One client can be bound to many suppliers, and one supplier can be bound by many clients.

Conflicting access to one supplier can be avoided by deactivating conflicting clients before activation (using the resolve_conflicts callback).

bindings = {}

__attrs_post_init__()

display_name

on_supplier_bound(supplier)

Called by the Target after a new supplier has been bound

on_client_bound(client)

Called by the Target after a new client has been bound

on_activate()

Called by the Target when this object has been activated

on_deactivate()

Called by the Target when this object has been deactivated

resolve_conflicts(client)

Called by the Target to allow this object to deactivate conflicting clients.

classmethod check_active(func)

class NamedBinding(value)

Bases: object

Marks a binding (or binding set) as requiring an explicit name.

__init__(value)

Initialize self. See help(type(self)) for accurate signature.

__repr__()

Return repr(self).

__dict__ = mappingproxy({'__module__': 'labgrid.binding', '__doc__': '\n Marks a binding (or binding set) as requiring an explicit name.\n ', '__init__': <function BindingMixin.NamedBinding.__init__>, '__repr__': <function BindingMixin.NamedBinding.__repr__>, '__dict__': <attribute '__dict__' of 'NamedBinding' objects>, '__weakref__': <attribute '__weakref__' of 'NamedBinding' objects>})

__module__ = 'labgrid.binding'

__weakref__

list of weak references to the object (if defined)

__attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, cmp=True, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False))

__dict__ = mappingproxy({'__module__': 'labgrid.binding', '__doc__': '\n Handles the binding and activation of drivers and their supplying resources\n and drivers.\n\n One client can be bound to many suppliers, and one supplier can be bound by\n many clients.\n\n Conflicting access to one supplier can be avoided by deactivating\n conflicting clients before activation (using the resolve_conflicts\n callback).\n ', 'bindings': {}, '__attrs_post_init__': <function BindingMixin.__attrs_post_init__>, 'display_name': <property object>, 'on_supplier_bound': <function BindingMixin.on_supplier_bound>, 'on_client_bound': <function BindingMixin.on_client_bound>, 'on_activate': <function BindingMixin.on_activate>, 'on_deactivate': <function BindingMixin.on_deactivate>, 'resolve_conflicts': <function BindingMixin.resolve_conflicts>, 'check_active': <classmethod object>, 'NamedBinding': <class 'labgrid.binding.BindingMixin.NamedBinding'>, '__dict__': <attribute '__dict__' of 'BindingMixin' objects>, '__weakref__': <attribute '__weakref__' of 'BindingMixin' objects>, '__attrs_attrs__': (Attribute(name='target', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, cmp=True, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False)), '__repr__': <function BindingMixin.__repr__>, '__init__': <function BindingMixin.__init__>})

__init__(target, name) → None

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'labgrid.binding'

__repr__()

Automatically created by attrs.

__weakref__

list of weak references to the object (if defined)

labgrid.config module

Config convenience class

This class encapsulates access functions to the environment configuration

class labgrid.config.Config(filename)

Bases: object

__attrs_post_init__()

resolve_path(path)

Resolve an absolute path

Parameters:path (str) – path to resolve Returns:the absolute path Return type:str

get_tool(tool)

Retrieve an entry from the tools subkey

Parameters:tool (str) – the tool to retrieve the path for Returns:path to the requested tools Return type:str

get_image_path(kind)

Retrieve an entry from the images subkey

Parameters:kind (str) – the kind of the image to retrieve the path for Returns:path to the image Return type:str Raises:KeyError – if the requested image can not be found in the configuration

get_path(kind)

Retrieve an entry from the paths subkey

Parameters:kind (str) – the type of path to retrieve the path for Returns:path to the path Return type:str Raises:KeyError – if the requested image can not be found in the configuration

get_option(name, default=None)

Retrieve an entry from the options subkey

Parameters:

• name (str) – name of the option
• default (str) – A default parameter in case the option can not be found

Returns:

value of the option or default parameter

Return type:

str

Raises:

KeyError – if the requested image can not be found in the configuration

set_option(name, value)

Set an entry in the options subkey

Parameters:

• name (str) – name of the option
• value (str) – the new value

get_targets()

get_imports()

Helper function that returns the list of all imports

Returns:List of files which should be imported Return type:List

get_paths()

Helper function that returns the subdict of all paths

Returns:Dictionary containing all path definitions Return type:Dict

get_images()

Helper function that returns the subdict of all images

Returns:Dictionary containing all image definitions Return type:Dict

get_features()

__attrs_attrs__ = (Attribute(name='filename', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False),)

__dict__ = mappingproxy({'__module__': 'labgrid.config', '__attrs_post_init__': <function Config.__attrs_post_init__>, 'resolve_path': <function Config.resolve_path>, 'get_tool': <function Config.get_tool>, 'get_image_path': <function Config.get_image_path>, 'get_path': <function Config.get_path>, 'get_option': <function Config.get_option>, 'set_option': <function Config.set_option>, 'get_targets': <function Config.get_targets>, 'get_imports': <function Config.get_imports>, 'get_paths': <function Config.get_paths>, 'get_images': <function Config.get_images>, 'get_features': <function Config.get_features>, '__dict__': <attribute '__dict__' of 'Config' objects>, '__weakref__': <attribute '__weakref__' of 'Config' objects>, '__doc__': None, '__attrs_attrs__': (Attribute(name='filename', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False),), '__repr__': <function Config.__repr__>, '__init__': <function Config.__init__>})

__init__(filename) → None

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'labgrid.config'

__repr__()

Automatically created by attrs.

__weakref__

list of weak references to the object (if defined)

labgrid.consoleloggingreporter module

class labgrid.consoleloggingreporter.ConsoleLoggingReporter(logpath)

Bases: object

ConsoleLoggingReporter - Reporter that writes console log files

Parameters:logpath (str) – path to store the logfiles in

instance = None

classmethod start(path)

starts the ConsoleLoggingReporter

classmethod stop()

stops the ConsoleLoggingReporter

__init__(logpath)

Initialize self. See help(type(self)) for accurate signature.

get_logfile(event)

Returns the correct file handle from cache or creates a new file handle

notify(event)

This is the callback function for steps

__dict__ = mappingproxy({'__module__': 'labgrid.consoleloggingreporter', '__doc__': 'ConsoleLoggingReporter - Reporter that writes console log files\n\n Args:\n logpath (str): path to store the logfiles in\n ', 'instance': None, 'start': <classmethod object>, 'stop': <classmethod object>, '__init__': <function ConsoleLoggingReporter.__init__>, '_stop': <function ConsoleLoggingReporter._stop>, 'get_logfile': <function ConsoleLoggingReporter.get_logfile>, 'notify': <function ConsoleLoggingReporter.notify>, '__dict__': <attribute '__dict__' of 'ConsoleLoggingReporter' objects>, '__weakref__': <attribute '__weakref__' of 'ConsoleLoggingReporter' objects>})

__module__ = 'labgrid.consoleloggingreporter'

__weakref__

list of weak references to the object (if defined)

labgrid.environment module

class labgrid.environment.Environment(config_file='config.yaml', interact=<built-in function input>)

Bases: object

An environment encapsulates targets.

__attrs_post_init__()

get_target(role: str = 'main') → labgrid.target.Target

Returns the specified target or None if not found.

Each target is initialized as needed.

get_features()

get_target_features()

cleanup()

__attrs_attrs__ = (Attribute(name='config_file', default='config.yaml', validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False), Attribute(name='interact', default=<built-in function input>, validator=None, repr=False, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False))

__dict__ = mappingproxy({'__module__': 'labgrid.environment', '__doc__': 'An environment encapsulates targets.', '__attrs_post_init__': <function Environment.__attrs_post_init__>, 'get_target': <function Environment.get_target>, 'get_features': <function Environment.get_features>, 'get_target_features': <function Environment.get_target_features>, 'cleanup': <function Environment.cleanup>, '__dict__': <attribute '__dict__' of 'Environment' objects>, '__weakref__': <attribute '__weakref__' of 'Environment' objects>, '__attrs_attrs__': (Attribute(name='config_file', default='config.yaml', validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False), Attribute(name='interact', default=<built-in function input>, validator=None, repr=False, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False)), '__repr__': <function Environment.__repr__>, '__init__': <function Environment.__init__>})

__init__(config_file='config.yaml', interact=<built-in function input>) → None

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'labgrid.environment'

__repr__()

Automatically created by attrs.

__weakref__

list of weak references to the object (if defined)

labgrid.exceptions module

exception labgrid.exceptions.NoConfigFoundError(msg)

Bases: Exception

__attrs_attrs__ = (Attribute(name='msg', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False),)

__init__(msg) → None

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'labgrid.exceptions'

__repr__()

Automatically created by attrs.

__weakref__

list of weak references to the object (if defined)

exception labgrid.exceptions.NoSupplierFoundError(msg, filter=None)

Bases: Exception

__attrs_attrs__ = (Attribute(name='msg', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False), Attribute(name='filter', default=None, validator=<optional validator for <instance_of validator for type <class 'set'>> or None>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False))

__init__(msg, filter=None) → None

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'labgrid.exceptions'

__repr__()

Automatically created by attrs.

__weakref__

list of weak references to the object (if defined)

exception labgrid.exceptions.InvalidConfigError(msg)

Bases: Exception

__attrs_attrs__ = (Attribute(name='msg', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False),)

__init__(msg) → None

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'labgrid.exceptions'

__repr__()

Automatically created by attrs.

__weakref__

list of weak references to the object (if defined)

exception labgrid.exceptions.NoDriverFoundError(msg, filter=None)

Bases: labgrid.exceptions.NoSupplierFoundError

__attrs_attrs__ = (Attribute(name='msg', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False), Attribute(name='filter', default=None, validator=<optional validator for <instance_of validator for type <class 'set'>> or None>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False))

__init__(msg, filter=None) → None

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'labgrid.exceptions'

__repr__()

Automatically created by attrs.

exception labgrid.exceptions.NoResourceFoundError(msg, filter=None)

Bases: labgrid.exceptions.NoSupplierFoundError

__attrs_attrs__ = (Attribute(name='msg', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False), Attribute(name='filter', default=None, validator=<optional validator for <instance_of validator for type <class 'set'>> or None>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False))

__init__(msg, filter=None) → None

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'labgrid.exceptions'

__repr__()

Automatically created by attrs.

labgrid.factory module

class labgrid.factory.TargetFactory

Bases: object

__init__()

Initialize self. See help(type(self)) for accurate signature.

reg_resource(cls)

Register a resource with the factory.

Returns the class to allow using it as a decorator.

reg_driver(cls)

Register a driver with the factory.

Returns the class to allow using it as a decorator.

static normalize_config(config)

make_resource(target, resource, name, args)

make_driver(target, driver, name, args)

make_target(name, config, *, env=None)

__dict__ = mappingproxy({'__module__': 'labgrid.factory', '__init__': <function TargetFactory.__init__>, 'reg_resource': <function TargetFactory.reg_resource>, 'reg_driver': <function TargetFactory.reg_driver>, '_convert_to_named_list': <staticmethod object>, 'normalize_config': <staticmethod object>, 'make_resource': <function TargetFactory.make_resource>, 'make_driver': <function TargetFactory.make_driver>, 'make_target': <function TargetFactory.make_target>, '__dict__': <attribute '__dict__' of 'TargetFactory' objects>, '__weakref__': <attribute '__weakref__' of 'TargetFactory' objects>, '__doc__': None})

__module__ = 'labgrid.factory'

__weakref__

list of weak references to the object (if defined)

labgrid.factory.target_factory = <labgrid.factory.TargetFactory object>

Global TargetFactory instance

This instance is used to register Resource and Driver classes so that Targets can be created automatically from YAML files.

labgrid.step module

class labgrid.step.Steps

Bases: object

__init__()

Initialize self. See help(type(self)) for accurate signature.

get_current()

get_new(title, tag, source)

push(step)

pop(step)

subscribe(callback)

unsubscribe(callback)

notify(event)

__dict__ = mappingproxy({'__module__': 'labgrid.step', '__init__': <function Steps.__init__>, 'get_current': <function Steps.get_current>, 'get_new': <function Steps.get_new>, 'push': <function Steps.push>, 'pop': <function Steps.pop>, 'subscribe': <function Steps.subscribe>, 'unsubscribe': <function Steps.unsubscribe>, 'notify': <function Steps.notify>, '__dict__': <attribute '__dict__' of 'Steps' objects>, '__weakref__': <attribute '__weakref__' of 'Steps' objects>, '__doc__': None})

__module__ = 'labgrid.step'

__weakref__

list of weak references to the object (if defined)

class labgrid.step.StepEvent(step, data, *, resource=None, stream=False)

Bases: object

__init__(step, data, *, resource=None, stream=False)

Initialize self. See help(type(self)) for accurate signature.

__str__()

Return str(self).

merge(other)

age

__dict__ = mappingproxy({'__module__': 'labgrid.step', '__init__': <function StepEvent.__init__>, '__str__': <function StepEvent.__str__>, '_invalidate': <function StepEvent._invalidate>, 'merge': <function StepEvent.merge>, 'age': <property object>, '__dict__': <attribute '__dict__' of 'StepEvent' objects>, '__weakref__': <attribute '__weakref__' of 'StepEvent' objects>, '__doc__': None})

__module__ = 'labgrid.step'

__weakref__

list of weak references to the object (if defined)

class labgrid.step.Step(title, level, tag, source)

Bases: object

__init__(title, level, tag, source)

Initialize self. See help(type(self)) for accurate signature.

__repr__()

Return repr(self).

__str__()

Return str(self).

duration

status

is_active

is_done

start()

skip(reason)

stop()

__del__()

__dict__ = mappingproxy({'__module__': 'labgrid.step', '__init__': <function Step.__init__>, '__repr__': <function Step.__repr__>, '__str__': <function Step.__str__>, 'duration': <property object>, 'status': <property object>, 'is_active': <property object>, 'is_done': <property object>, '_notify': <function Step._notify>, 'start': <function Step.start>, 'skip': <function Step.skip>, 'stop': <function Step.stop>, '__del__': <function Step.__del__>, '__dict__': <attribute '__dict__' of 'Step' objects>, '__weakref__': <attribute '__weakref__' of 'Step' objects>, '__doc__': None})

__module__ = 'labgrid.step'

__weakref__

list of weak references to the object (if defined)

labgrid.step.step(*, title=None, args=[], result=False, tag=None)

labgrid.stepreporter module

class labgrid.stepreporter.StepReporter

Bases: object

instance = None

classmethod start()

starts the StepReporter

classmethod stop()

stops the StepReporter

__init__()

Initialize self. See help(type(self)) for accurate signature.

static notify(event)

__dict__ = mappingproxy({'__module__': 'labgrid.stepreporter', 'instance': None, 'start': <classmethod object>, 'stop': <classmethod object>, '__init__': <function StepReporter.__init__>, 'notify': <staticmethod object>, '__dict__': <attribute '__dict__' of 'StepReporter' objects>, '__weakref__': <attribute '__weakref__' of 'StepReporter' objects>, '__doc__': None})

__module__ = 'labgrid.stepreporter'

__weakref__

list of weak references to the object (if defined)

labgrid.target module

class labgrid.target.Target(name, env=None)

Bases: object

__attrs_post_init__()

interact(msg)

update_resources()

Iterate over all relevant managers and deactivate any active but unavailable resources.

await_resources(resources, timeout=None, avail=True)

Poll the given resources and wait until they are (un-)available.

Parameters:

• resources (List) – the resources to poll
• timeout (float) – optional timeout
• avail (bool) – optionally wait until the resources are unavailable with avail=False

get_resource(cls, *, name=None, wait_avail=True)

Helper function to get a resource of the target. Returns the first valid resource found, otherwise a NoResourceFoundError is raised.

Arguments: cls – resource-class to return as a resource name – optional name to use as a filter wait_avail – wait for the resource to become available (default True)

get_active_driver(cls, *, name=None)

Helper function to get the active driver of the target. Returns the active driver found, otherwise None.

Arguments: cls – driver-class to return as a resource name – optional name to use as a filter

get_driver(cls, *, name=None, activate=True)

Helper function to get a driver of the target. Returns the first valid driver found, otherwise None.

Arguments: cls – driver-class to return as a resource name – optional name to use as a filter activate – activate the driver (default True)

__getitem__(key)

Syntactic sugar to access drivers by class (optionally filtered by name).

>>> target = Target('main')
>>> console = FakeConsoleDriver(target, 'console')
>>> target.activate(console)
>>> target[FakeConsoleDriver]
FakeConsoleDriver(target=Target(name='main', …), name='console', …)
>>> target[FakeConsoleDriver, 'console']
FakeConsoleDriver(target=Target(name='main', …), name='console', …)

set_binding_map(mapping)

Configure the binding name mapping for the next driver only.

bind_resource(resource)

Bind the resource to this target.

bind_driver(client)

Bind the driver to all suppliers (resources and other drivers).

Currently, we only support binding all suppliers at once.

bind(bindable)

activate(client)

Activate the client by activating all bound suppliers. This may require deactivating other clients.

deactivate(client)

Recursively deactivate the client’s clients and itself.

This is needed to ensure that no client has an inactive supplier.

deactivate_all_drivers()

Deactivates all drivers in reversed order they were activated

cleanup()

Clean up conntected drivers and resources in reversed order

__attrs_attrs__ = (Attribute(name='name', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False), Attribute(name='env', default=None, validator=None, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False))

__dict__ = mappingproxy({'__module__': 'labgrid.target', '__attrs_post_init__': <function Target.__attrs_post_init__>, 'interact': <function Target.interact>, 'update_resources': <function Target.update_resources>, 'await_resources': <function Target.await_resources>, 'get_resource': <function Target.get_resource>, '_get_driver': <function Target._get_driver>, 'get_active_driver': <function Target.get_active_driver>, 'get_driver': <function Target.get_driver>, '__getitem__': <function Target.__getitem__>, 'set_binding_map': <function Target.set_binding_map>, 'bind_resource': <function Target.bind_resource>, 'bind_driver': <function Target.bind_driver>, 'bind': <function Target.bind>, 'activate': <function Target.activate>, 'deactivate': <function Target.deactivate>, 'deactivate_all_drivers': <function Target.deactivate_all_drivers>, 'cleanup': <function Target.cleanup>, '_class_from_string': <function Target._class_from_string>, '__dict__': <attribute '__dict__' of 'Target' objects>, '__weakref__': <attribute '__weakref__' of 'Target' objects>, '__doc__': None, '__attrs_attrs__': (Attribute(name='name', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False), Attribute(name='env', default=None, validator=None, repr=True, cmp=True, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False)), '__repr__': <function Target.__repr__>, '__init__': <function Target.__init__>})

__init__(name, env=None) → None

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'labgrid.target'

__repr__()

Automatically created by attrs.

__weakref__

list of weak references to the object (if defined)