AFL.automation.APIServer.Driver#

Functions

ceil(x, /)

Return the ceiling of x as an Integral.

listify(obj)

makeRegistrar()

sqrt(x, /)

Return the square root of x.

Classes

Driver(name[, defaults, overrides, useful_links])

PersistentConfig(path[, defaults, ...])

A dictionary-like class that serializes changes to disk
AFL.automation.APIServer.Driver.makeRegistrar()[source]#
class AFL.automation.APIServer.Driver.Driver(name, defaults=None, overrides=None, useful_links=None)[source]#
unqueued()#
queued()#
quickbar()#
__init__(name, defaults=None, overrides=None, useful_links=None)[source]#
classmethod gather_defaults()[source]#

Gather all inherited static class-level dictionaries called default.

set_config(**kwargs)[source]#
get_config(name, print_console=False)[source]#
get_configs(print_console=False)[source]#
set_sample(sample_name, sample_uuid=None, **kwargs)[source]#
get_sample()[source]#
reset_sample()[source]#
status()[source]#
pre_execute(**kwargs)[source]#

Executed before each call to execute

All of the kwargs passed to execute are also pass to this method. It is expected that this method be overridden by subclasses.

post_execute(**kwargs)[source]#

Executed after each call to execute

All of the kwargs passed to execute are also pass to this method. It is expected that this method be overridden by subclasses.

execute(**kwargs)[source]#
set_object(serialized=True, **kw)[source]#
get_object(name, serialize=True)[source]#
set_data(data: dict)[source]#

Set data in the DataPacket object

Parameters:

  • data (dict) – Dictionary of data to store in the driver object

  • variables (Note! if the keys in data are not system or sample)

:param : :param they will be erased at the end of this function call.:

retrieve_obj(uid, delete=True)[source]#

Retrieve an object from the dropbox

Parameters:

uid (str) – The uuid of the file to retrieve

deposit_obj(obj, uid=None)[source]#

Store an object in the dropbox

Parameters:

  • obj (object) – The object to store in the dropbox

  • uid (str) – The uuid to store the object under