8.4.13. pymodaq_utils.utils module

class pymodaq_utils.utils.JsonConverter

Bases: object

Methods

istrusted
json2object
object2json
trusted_types

classmethod istrusted(type_name)

classmethod json2object(jsonstring)

classmethod object2json(obj)

classmethod trusted_types()

class pymodaq_utils.utils.PlotColors(colors=[[255, 255, 255], [255, 0, 0], [0, 255, 0], [0, 0, 255], [14, 207, 189], [207, 14, 166], [207, 204, 14]])

Bases: object

Methods

check_color
check_colors
copy
remove

static check_color(color: Iterable)

check_colors(colors: Iterable)

copy()

remove(item)

class pymodaq_utils.utils.ThreadCommand(command: str, attribute=None, attributes=None, args=(), kwargs: dict | None = None)

Bases: SerializableBase

Generic object to pass info (command) and data (attribute) between thread or objects using signals

Parameters:

• command (str) – The command to be analysed for further action

• attribute (any type) – the attribute related to the command. The actual type and value depend on the command and the situation

• attributes (deprecated, attribute should be used instead)

command

The command to be analysed for further action

Type:

str

attribute

the attribute related to the command. The actual type and value depend on the command and the situation

Type:

any type

args

Type:

some variables in a list

kwargs

Type:

some variables in a dict

Methods

deserialize(bytes_str)	Implements deserialization into self type from bytes
serialize(obj)	Implements self serialization into bytes

static deserialize(bytes_str: bytes) → Tuple[ThreadCommand, bytes]

Implements deserialization into self type from bytes

Parameters:

bytes_str (bytes)

Returns:

• SerializableBase (object to reconstruct)

• bytes (leftover bytes to deserialize)

Notes

The actual deserialization should be done using the SerializableFactory and its method :meth:SerializableFactory.get_apply_deserializer

static serialize(obj: ThreadCommand) → bytes

Implements self serialization into bytes

Parameters:

obj (SerializableBase)

Return type:

bytes

Notes

The actual serialization should be done using the SerializableFactory and its method :meth:SerializableFactory.get_apply_serializer

args: list

attribute: Any

command: str

kwargs: dict

pymodaq_utils.utils.caller_name(skip=2)

Get a name of a caller in the format module.class.method

skip specifies how many levels of stack to skip while getting caller name. skip=1 means “who calls me”, skip=2 “who calls my caller” etc.

An empty string is returned if skipped levels exceed stack height

pymodaq_utils.utils.capitalize(string, Nfirst=1)

Returns same string but with first Nfirst letters upper :param string: :type string: (str) :param Nfirst: :type Nfirst: (int)

Return type:

str

pymodaq_utils.utils.check_vals_in_iterable(iterable1, iterable2)

pymodaq_utils.utils.count_lines(ini_path, count=0, filters=['lextab', 'yacctab', 'pycache', 'pyc'])

pymodaq_utils.utils.elt_as_first_element(elt_list, match_word='Mock')

pymodaq_utils.utils.elt_as_first_element_dicts(elt_list, match_word='Mock', key='name')

pymodaq_utils.utils.ensure_ndarray(data)

Make sure data is returned as a numpy array :param data:

Return type:

ndarray

pymodaq_utils.utils.find_dict_if_matched_key_val(dict_tmp, key, value)

check if a key/value pair match in a given dictionary :param dict_tmp: :type dict_tmp: (dict) the dictionary to be tested :param key: :type key: (str) a key string to look for in dict_tmp :param value: :type value: (object) any python object

Returns:

bool

Return type:

True if the key/value pair has been found in dict_tmp

pymodaq_utils.utils.find_dict_in_list_from_key_val(dicts, key, value, return_index=False)

lookup within a list of dicts. Look for the dict within the list which has the correct key, value pair

Parameters:

• dicts ((list) list of dictionnaries)

• key ((str) specific key to look for in each dict)

• value (value to match)

Returns:

dict

Return type:

if found otherwise returns None

pymodaq_utils.utils.find_keys_from_val(dict_tmp: dict, val: object)

Returns the keys from a dict if its value is matching val

pymodaq_utils.utils.find_object_if_matched_attr_name_val(obj, attr_name, attr_value)

check if an attribute key/value pair match in a given object

Parameters:

• obj (object)

• attr_name (str) – attribute name to look for in the object

• attr_value (object) – value to match

Returns:

bool

Return type:

True if the key/value pair has been found in dict_tmp

pymodaq_utils.utils.find_objects_in_list_from_attr_name_val(objects: List[object], attr_name: str, attr_value: object, return_first=True)

lookup within a list of objects. Look for the objects within the list which has the correct attribute name, value pair

Parameters:

• objects (list) – list of objects

• attr_name (str) – attribute name to look for in the object

• attr_value (object) – value to match

• return_first (bool) – if True return the first objects found in the list else all the objects matching

Returns:

list of tuple(object, int)

Return type:

object and index or list of object and indexes

pymodaq_utils.utils.getLineInfo()

get information about where the Exception has been triggered

pymodaq_utils.utils.get_entrypoints(group='pymodaq.plugins') → List[EntryPoint]

Get the list of modules defined from a group entry point

Because of evolution in the package, one or another of the forms below may be deprecated. We start from the newer way down to the older

Parameters:

group (str) – the name of the group

pymodaq_utils.utils.get_new_file_name(base_path=PosixPath('C:\\Data'), base_name='tttr_data')

pymodaq_utils.utils.get_version(package_name='pymodaq')

Obtain the package version using the importlib metadata module

pymodaq_utils.utils.is_64bits()

pymodaq_utils.utils.recursive_find_expr_in_files(ini_path, exp='make_enum', paths=[], filters=['.git', '.idea', '__pycache__', 'build', 'egg', 'documentation', '.tox'], replace=False, replace_str='')

pymodaq_utils.utils.recursive_find_files(ini_path, exp='make_enum', paths=[], filters=['build'])

pymodaq_utils.utils.recursive_find_files_extension(ini_path, ext, paths=[])

pymodaq_utils.utils.remove_spaces(string)

return a string without any white spaces in it :param string:

pymodaq_utils.utils.rint(x)

almost same as numpy rint function but return an integer :param x: :type x: (float or integer)

Return type:

nearest integer

pymodaq_utils.utils.timer(func)

Print the runtime of the decorated function

pymodaq_utils.utils.uncapitalize(string, Nfirst=1)

pymodaq_utils.utils.zeros_aligned(n, align, dtype=<class 'numpy.uint32'>)

Get aligned memory array wih alignment align. :param n: :type n: (int) length in dtype bytes of memory :param align: :type align: (int) memory alignment :param dtype: :type dtype: (numpy.dtype) type of the stored memory elements