rminstr.instruments.measurement_functionalities.common_behaviours

Reusable behaviours that can be applied to instrument abstractions.

These behaviours include things like forcing a method to only be callable when the instrument is in a certain state, saving key word arguments of a method to a dictionary defined by a class attribute, and having certain methods change the state of the instrument afer being called.

Functions

log_arguments(→ Callable)

Make function save keyword arguments to a log file.

Module Contents

rminstr.instruments.measurement_functionalities.common_behaviours.log_arguments(name: str, path: str, function: Callable) Callable

Make function save keyword arguments to a log file.

Parameters:
namestr

Name of instrument. Recommend __name__

pathstr

Path to log to. Should end in .log

functionCallable

Function being wrapped.

Returns:
Callable

Wrapped function.