API Documentation

Class List

factoryobject.FactoryObject	Objects identified by name
factoryobject.ObjectList
linkedobject.LinkedObject	links from linked_obj to (obj, attribute) with obj.attribute = linked_obj
persistentobject.PersistentObject
persistentobject.AttributeList	object list class
datarange.DataRange
visibleobject.VisibleObject
visibleobject.VisibleObjectList
visibleobject.VisibleAttributeList
visibleobject.VisibleDataRange
session.SessionHandler	api session handler for multiprocessing sessions

Inheritance Diagram

Visible Objects

class unicum.visibleobject.VisibleObject(*args, **kwargs)

Bases: unicum.factoryobject.FactoryObject, unicum.linkedobject.LinkedObject, unicum.persistentobject.PersistentObject

get_property(property_name, property_item_name=None)

to_serializable(level=0, all_properties_flag=False, recursive=True)

to_json(all_properties_flag=False, property_order=('Name', 'Class', 'Module'), **kwargs)

to_range(all_properties_flag=False)

classmethod from_serializable(item, register_flag=False)

core class method to create visible objects from a dictionary

classmethod from_json(json_str)

classmethod from_range(range_list, register_flag=True)

core class method to create visible objects from a range (nested list)

classmethod create(name=None, register_flag=False, **kwargs)

class unicum.visibleobject.VisibleList

Bases: list

register()

class unicum.visibleobject.VisibleObjectList(iterable=None, object_type=<class 'unicum.visibleobject.VisibleObject'>)

Bases: unicum.factoryobject.ObjectList, unicum.visibleobject.VisibleList

class unicum.visibleobject.VisibleAttributeList(iterable=None, object_type=<class 'unicum.visibleobject.VisibleObject'>, value_types=(<class 'float'>, <class 'int'>, <class 'str'>, <class 'NoneType'>, <class 'unicum.visibleobject.VisibleObject'>))

Bases: unicum.persistentobject.AttributeList, unicum.visibleobject.VisibleList

class unicum.visibleobject.VisibleDataRange(iterable=None, value_types=(<class 'float'>, <class 'int'>, <class 'str'>, <class 'NoneType'>, <class 'unicum.visibleobject.VisibleObject'>), none_alias=(None, ' ', '', 'None'))

Bases: unicum.datarange.DataRange

SessionHandler

class unicum.session.SessionHandler(pkg_name='unicum', cls_name='VisibleObject', cast_types={})

Bases: object

api session handler for multiprocessing sessions

Parameters:

• pkg_name – module containing relevant classes
• cls_name – default class (inherited from unicum.VisibleObject)
• types – additional dict of types to cast arguments

Standard type conversion is following a naming convention. So if an arguments ends with int the value will be casted with the type int given as value to the key int in types.

Same with number, year, month, day and long. Similar we cast float and value to a float, string, str and name to a str as well as bool and flag to bool

Anything ending with variant would be ignored.

And finally, the value of cls will be replaced by an attribute of pkg_name of the same name and the value of self will be replaced by an cls_name instance.

start_session(session_id)

starts a session with given session_id

validate_session(session_id)

checks wether a session with given session id exists

call_session(session_id, func='', kwargs={})

calls the session and makes a function call with kwargs (which will be casted accordingly)

stop_session(session_id)

closes a session with given session_id

Base Objects

Factory Objects

class unicum.factoryobject.FactoryType

Bases: type

classmethod get(key, default=None)

class unicum.factoryobject.FactoryObject(*args, **kwargs)

Bases: object

Objects identified by name

register(*names)

remove()

to_serializable(level=0, all_properties_flag=False, recursive=True)

classmethod from_serializable(item)

classmethod filter(filter_func=None)

classmethod get(key, default=None)

classmethod keys()

classmethod values()

classmethod items()

class unicum.factoryobject.ObjectList(iterable=None, object_type=<class 'unicum.factoryobject.FactoryObject'>)

Bases: list

index(item, start=None, stop=None)

Return first index of value.

Raises ValueError if the value is not present.

get(item, default=None)

append(value)

Append object to the end of the list.

insert(index, value)

Insert object before index.

extend(iterable)

Extend list by appending elements from the iterable.

to_serializable(level=0, all_properties_flag=False, recursive=True)

classmethod from_serializable(item)

Linked Objects

class unicum.linkedobject.WeakAttrLink(obj, attr)

Bases: object

ref_obj

attr

class unicum.linkedobject.LinkedObject

Bases: object

links from linked_obj to (obj, attribute) with obj.attribute = linked_obj

register_link(obj, attr=None)

creates link from obj.attr to self :param obj: object to register link to :param attr: attribute name to register link to

remove_link(obj, attr=None)

removes link from obj.attr

update_link()

redirects all links to self (the new linked object)

clean_up_link_dict()

Persistent Objects

class unicum.persistentobject.PersistentObject(*args, **kwargs)

Bases: object

STARTS_WITH = '_'

ENDS_WITH = '_'

JSON_INDENT = 2

is_modified

classmethod from_serializable(object_dict)

core class method to create visible objects from a dictionary

to_serializable(level=0, all_properties_flag=False, recursive=True)

modify_object(property_name, property_value_variant=None)

api visible method for modifying visible object properties

Parameters:

• property_name (string, list or dict) – property name
• property_value_variant (various or None) – property value, must be None if property_name is of type dict

Returns:

modified object

Return type:

unicum.lfojbect.VisibleObject

class unicum.persistentobject.PersistentList

Bases: list

classmethod from_serializable(item)

to_serializable(level=0, all_properties_flag=False, recursive=True)

class unicum.persistentobject.PersistentDict

Bases: dict

classmethod from_serializable(item)

to_serializable(level=0, all_properties_flag=False, recursive=True)

class unicum.persistentobject.AttributeList(iterable=None, object_type=<class 'unicum.persistentobject.PersistentObject'>, value_types=(<class 'float'>, <class 'int'>, <class 'str'>, <class 'NoneType'>))

Bases: list

object list class

classmethod from_serializable(item)

append(value)

Append object to the end of the list.

index(value, start=None, stop=None)

Return first index of value.

Raises ValueError if the value is not present.

insert(index, value)

Insert object before index.

extend(iterable)

Extend list by appending elements from the iterable.

to_serializable(level=0, all_properties_flag=False, recursive=True)

keys(level=0, all_properties_flag=False)

values(level=0, all_properties_flag=False)

items(level=0, all_properties_flag=False)

DataRange Object

class unicum.datarange.DataRange(iterable=None, value_types=(<class 'float'>, <class 'int'>, <class 'str'>, <class 'NoneType'>), none_alias=(None, ' ', '', 'None'), **kwargs)

Bases: object

update(other)

keys()

values()

items()

get(key, default=None)

pop(key, default=None)

popitem()

row_append(row_key, value_list)

append a new row to a DataRange

Parameters:

• row_key – a string
• value_list – a list

col_append(col_key, value_list)

append a new row to a DataRange

Parameters:

• row_key – a string
• value_list – a list

row_keys()

col_keys()

row(item)

col(item)

item_list

total_list

to_serializable(level=0, all_properties_flag=False, recursive=True)

transpose()

append(key, value)

extend(other)

insert(item, key, value=None)