microscope.lights.toptica Namespace Reference

Classes
class	_iBeamConnection
class	TopticaiBeam

Functions
bytes	_get_table_value (bytes table, bytes key)

Variables
	_logger = logging.getLogger(__name__)

Function Documentation

_get_table_value()

bytes microscope.lights.toptica._get_table_value ( bytes table, bytes key )

protected

Get the value for a key in a table/multiline output.

Some commands return something like a table of key/values.  There
may be even empty lines on this table.  This searches for the
first line with a specific key (hopefully there's only one line
with such key) and returns the associated value.

Definition at line 34 of file toptica.py.

def _get_table_value(table: bytes, key: bytes) -> bytes:
    """Get the value for a key in a table/multiline output.
 
    Some commands return something like a table of key/values.  There
    may be even empty lines on this table.  This searches for the
    first line with a specific key (hopefully there's only one line
    with such key) and returns the associated value.
    """
    # Key might be the first line, hence '(?:^|\r\n)'
    match = re.search(b"(?:^|\r\n) *" + key + b": (.*)\r\n", table)
    if match is None:
        raise microscope.DeviceError(
            "failed to find key %s on table: %s" % (key, table)
        )
    return match.group(1)
 
 

Variable Documentation

_logger

microscope.lights.toptica._logger = logging.getLogger(__name__)

protected

Definition at line 31 of file toptica.py.