hyperstream.utils package

Submodules

hyperstream.utils.decorators module

hyperstream.utils.decorators.check_input_stream_count(expected_number_of_streams)

Decorator for Tool._execute that checks the number of input streams

Parameters:expected_number_of_streams – The expected number of streams Returns:the decorator

hyperstream.utils.decorators.check_output_format(expected_formats)

Decorator for stream outputs that checks the format of the outputs after modifiers have been applied :param expected_formats: The expected output formats :type expected_formats: tuple, set :return: the decorator

hyperstream.utils.decorators.check_tool_defined(func)

Decorator to check whether a tool stream has been defined before execution :return: the decorator

hyperstream.utils.decorators.timeit(f)

hyperstream.utils.errors module

exception hyperstream.utils.errors.ChannelAlreadyExistsError

Bases: exceptions.Exception

exception hyperstream.utils.errors.ChannelNotFoundError

Bases: exceptions.Exception

exception hyperstream.utils.errors.ConfigurationError

Bases: exceptions.Exception

exception hyperstream.utils.errors.FactorAlreadyExistsError

Bases: exceptions.Exception

message = 'Cannot have duplicate factors - a new factor object should be created'

exception hyperstream.utils.errors.FactorDefinitionError

Bases: exceptions.Exception

exception hyperstream.utils.errors.IncompatiblePlatesError

Bases: exceptions.Exception

exception hyperstream.utils.errors.IncompatibleToolError

Bases: exceptions.Exception

exception hyperstream.utils.errors.LinkageError

Bases: exceptions.Exception

exception hyperstream.utils.errors.MultipleStreamsFoundError

Bases: exceptions.Exception

exception hyperstream.utils.errors.NodeAlreadyExistsError

Bases: exceptions.Exception

message = 'Cannot have duplicate nodes'

exception hyperstream.utils.errors.NodeDefinitionError

Bases: exceptions.Exception

exception hyperstream.utils.errors.PlateDefinitionError

Bases: exceptions.Exception

message = 'Empty values in plate definition and complement=False'

exception hyperstream.utils.errors.PlateEmptyError(plate_id)

Bases: exceptions.Exception

message = 'Plate values for {} empty'

exception hyperstream.utils.errors.PlateNotFoundError

Bases: exceptions.Exception

exception hyperstream.utils.errors.StreamAlreadyExistsError

Bases: exceptions.Exception

exception hyperstream.utils.errors.StreamDataNotAvailableError

Bases: exceptions.Exception

exception hyperstream.utils.errors.StreamNotAvailableError(up_to_timestamp)

Bases: exceptions.Exception

message = 'The stream is not available after {} and cannot be calculated'

exception hyperstream.utils.errors.StreamNotFoundError

Bases: exceptions.Exception

exception hyperstream.utils.errors.ToolExecutionError(required_intervals)

Bases: exceptions.Exception

message = 'Tool execution did not cover the time interval {}.'

exception hyperstream.utils.errors.ToolInitialisationError

Bases: exceptions.Exception

exception hyperstream.utils.errors.ToolNotFoundError

Bases: exceptions.Exception

hyperstream.utils.errors.handle_exception(exc_type, exc_value, exc_traceback)

hyperstream.utils.serialization module

hyperstream.utils.serialization.func_dump(func)

Serialize user defined function. :param func: The function :return: Tuple of code, defaults and closure

hyperstream.utils.serialization.func_load(code, defaults=None, closure=None, globs=None)

Reload a function :param code: The code object :param defaults: Default values :param closure: The closure :param globs: globals :return:

hyperstream.utils.serialization.func_reconstruct_closure(values)

Deserialization helper that reconstructs a closure :param values: The closure values :return: The closure

hyperstream.utils.time_utils module

hyperstream.utils.time_utils.construct_experiment_id(time_interval)

Construct an experiment id from a time interval :return: The experiment id :type time_interval: TimeInterval :rtype: str

hyperstream.utils.time_utils.datetime2unix(dt)

hyperstream.utils.time_utils.duration2str(x)

hyperstream.utils.time_utils.get_timedelta(value)

hyperstream.utils.time_utils.is_naive(dt)

hyperstream.utils.time_utils.json_serial(obj)

JSON serializer for objects not serializable by default json code

hyperstream.utils.time_utils.reconstruct_interval(experiment_id)

Reverse the construct_experiment_id operation :param experiment_id: The experiment id :return: time interval

hyperstream.utils.time_utils.remove_microseconds(ts)

hyperstream.utils.time_utils.unix2datetime(u)

hyperstream.utils.time_utils.utcnow()

Gets the current datetime in UTC format with millisecond precision :return:

hyperstream.utils.utils module

Module contents