Unicum Documentation. Release alpha. Deutsche Postbank AG

Transcription

1 Unicum Documentation Release alpha Deutsche Postbank AG Nov 21, 2017

2

3 Contents 1 About unicum Getting started Installing Requirements User Guide License How to contribute Tutorial First step API Documentation Class List Inheritance Diagram Visible Objects Factory Objects Linked Objects Persistent Objects DataRange Object Singelton Object Releases Release Indices and tables 15 Python Module Index 17 i

4 ii

5 CHAPTER 1 About 1.1 unicum unicum consists of multiple object implementations that implement various factory pattern. All types merge into on type VisibleObject and each type contributes bits and piece. The visible obj focus on robust and simple construction from a dictionary via PersistentObject having values only simple types or containers containers of simple types. These values are translated via FatoryObject into more complex structures which are take from a factory. Or, alternatively, using DataRange into something similar to a data_frame type in R, a table with column and row names as well as common types for each column values. Inheriting from LinkedObject provides functionality to swap or update attributes at runtime Example Usage Using SingletonObject: >>> from unicum import SingletonObject >>> class MySingleton(SingletonObject): pass >>> s1 = MySingleton() >>> s2 = MySingleton() >>> s1 = s2 True Using FactoryObject: 1

6 Unicum Documentation, Release alpha >>> from unicum import FactoryObject >>> class Currency(FactoryObject): factory = dict() >>> class EUR(Currency): pass >>> class USD(Currency): pass >>> EUR().register() # registers USD() instance with class name 'EUR' >>> eur = Currency('EUR') # picks instance with key 'EUR' from currency cache >>> eur == EUR() # picks instance with key given by class name 'EUR' from currency cache, too. True >>> eur2 = eur. class ('EUR') # picks instance with key 'EUR' from currency cache >>> eur == eur2 True >>> usd = USD().register() # registers USD() instance with class name 'USD' >>> usd.register('usd') # registers usd with name 'usd' >>> usd == USD() True >>> eur == eur. class ('USD') False >>> usd == eur. class ('USD') True >>> usd == Currency('usd') True Using LinkedObject: >>> from unicum import LinkedObject Development Version The latest development version can be installed directly from GitHub: $ pip install --upgrade git Contributions Issues and Pull Requests are always welcome License Code and documentation are available according to the Apache Software License (see LICENSE). 2 Chapter 1. About

7 CHAPTER 2 Getting started 2.1 Installing The latest stable version can always be installed or updated via pip: $ pip install unicum If the above fails, please try easy_install instead: $ easy_install unicum 2.2 Requirements View project requirements. 2.3 User Guide Follow our tutorials and study the api documentation. 2.4 License View the open source LICENSE. 2.5 How to contribute Please fork project on GitHub and make pull requests. 3

8 Unicum Documentation, Release alpha 4 Chapter 2. Getting started

9 CHAPTER 3 Tutorial 3.1 First step setup by 5

10 Unicum Documentation, Release alpha 6 Chapter 3. Tutorial

11 CHAPTER 4 API Documentation 4.1 Class List singeltonobject.singeltonobject factoryobject.factorytype 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 7

12 Unicum Documentation, Release alpha 4.2 Inheritance Diagram persistentobject.attributelist visibleobject.visibleattributelist factoryobject.objectlist visibleobject.visibleobjectlist factoryobject.factoryobject linkedobject.linkedobject visibleobject.visibleobject persistentobject.persistentobject datarange.datarange visibleobject.visibledatarange 4.3 Visible Objects class visibleobject.visibleattributelist(iterable=none, object_type=<class visibleobject.visibleobject >, value_types=(<type float >, <type int >, <type str >, <type NoneType >, <class visibleobject.visibleobject >)) Bases: persistentobject.attributelist class visibleobject.visibledatarange(iterable=none, value_types=(<type float >, <type int >, <type str >, <type NoneType >, <class visibleobject.visibleobject >), none_alias=(none,,, None )) Bases: datarange.datarange class visibleobject.visibleobject(*args, **kwargs) Bases: factoryobject.factoryobject, linkedobject.linkedobject, persistentobject.persistentobject classmethod from_serializable(item) to_serializable(level=0, all_properties=false) class visibleobject.visibleobjectlist(iterable=none, object_type=<class visibleobject.visibleobject >) Bases: factoryobject.objectlist 8 Chapter 4. API Documentation

13 Unicum Documentation, Release alpha 4.4 Factory Objects class factoryobject.factoryobject Bases: object Objects identified by name classmethod from_serializable(item) classmethod items() classmethod keys() register(*names) remove() to_serializable(level=0) classmethod values() class factoryobject.factorytype Bases: type class factoryobject.objectlist(iterable=none, object_type=<class factoryobject.factoryobject >) Bases: list append(value) extend(iterable) classmethod from_serializable(item) get(item, default=none) index(item, start=none, stop=none) insert(index, value) to_serializable(level=0) 4.5 Linked Objects class linkedobject.linkedobject Bases: object links from linked_obj to (obj, attribute) with obj.attribute = linked_obj clean_up_link_dict() 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) class linkedobject.weakattrlink(obj, attr) Bases: object 4.4. Factory Objects 9

14 Unicum Documentation, Release alpha attr ref_obj 4.6 Persistent Objects class persistentobject.attributelist(iterable=none, object_type=<class persistentobject.persistentobject >, value_types=(<type float >, <type int >, <type str >, <type NoneType >)) Bases: list object list class append(value) extend(iterable) classmethod from_serializable(item) index(value, start=none, stop=none) insert(index, value) items() keys() to_serializable(level=0) values() class persistentobject.persistentdict Bases: dict classmethod from_serializable(item) to_serializable(level=0) class persistentobject.persistentlist Bases: list classmethod from_serializable(item) to_serializable(level=0) class persistentobject.persistentobject(*args, **kwargs) Bases: object ENDS_WITH = _ JSON_INDENT = 2 STARTS_WITH = _ classmethod from_json(json_str) classmethod from_serializable(object_dict) core class method to create visible objects from a dictionary is_modified modify_object(property_name, property_value=none) api visible method for modifying visible object properties Parameters 10 Chapter 4. API Documentation

15 Unicum Documentation, Release alpha property_name (string, list or dict) property name property_value (various or None) property value, must be None if property_name is of type dict Returns modified object Return type unicum.lfojbect.visibleobject to_json(all_properties=false, dumps=<function dumps>, **kwargs) to_serializable(level=0, all_properties=false) 4.7 DataRange Object class datarange.datarange(iterable=none, value_types=(<type float >, <type int >, <type str >, <type NoneType >), none_alias=(none,,, None ), **kwargs) Bases: dict append(key, value) col(item) col_append(key, value) col_keys() extend(key, value) insert(item, key, value=none) item_list row(item) row_append(key, value) append new row row_keys() to_serializable(level=0) total_list transpose() 4.8 Singelton Object class singletonobject.singletonobject Bases: object Use to create a singleton 4.7. DataRange Object 11

16 Unicum Documentation, Release alpha 12 Chapter 4. API Documentation

17 CHAPTER 5 Releases 5.1 Release 0.1 Release date was July 7th,

18 Unicum Documentation, Release alpha 14 Chapter 5. Releases

19 CHAPTER 6 Indices and tables genindex modindex search 15

20 Unicum Documentation, Release alpha 16 Chapter 6. Indices and tables

21 Python Module Index d datarange, 11 f factoryobject, 9 l linkedobject, 9 p persistentobject, 10 s singletonobject, 11 v visibleobject, 8 17

22 Unicum Documentation, Release alpha 18 Python Module Index

23 Index A append() (datarange.datarange method), 11 append() (factoryobject.objectlist method), 9 append() (persistentobject.attributelist method), 10 attr (linkedobject.weakattrlink attribute), 9 AttributeList (class in persistentobject), 10 C clean_up_link_dict() (linkedobject.linkedobject method), 9 col() (datarange.datarange method), 11 col_append() (datarange.datarange method), 11 col_keys() (datarange.datarange method), 11 D DataRange (class in datarange), 11 datarange (module), 11 E ENDS_WITH (persistentobject.persistentobject attribute), 10 extend() (datarange.datarange method), 11 extend() (factoryobject.objectlist method), 9 extend() (persistentobject.attributelist method), 10 F FactoryObject (class in factoryobject), 9 factoryobject (module), 9 FactoryType (class in factoryobject), 9 from_json() (persistentobject.persistentobject class method), 10 from_serializable() (factoryobject.factoryobject class method), 9 from_serializable() (factoryobject.objectlist class method), 9 from_serializable() (persistentobject.attributelist class method), 10 from_serializable() (persistentobject.persistentdict class method), 10 from_serializable() (persistentobject.persistentlist class method), 10 from_serializable() (persistentobject.persistentobject class method), 10 from_serializable() (visibleobject.visibleobject class method), 8 G get() (factoryobject.objectlist method), 9 I index() (factoryobject.objectlist method), 9 index() (persistentobject.attributelist method), 10 insert() (datarange.datarange method), 11 insert() (factoryobject.objectlist method), 9 insert() (persistentobject.attributelist method), 10 is_modified (persistentobject.persistentobject attribute), 10 item_list (datarange.datarange attribute), 11 items() (factoryobject.factoryobject class method), 9 items() (persistentobject.attributelist method), 10 J JSON_INDENT (persistentobject.persistentobject attribute), 10 K keys() (factoryobject.factoryobject class method), 9 keys() (persistentobject.attributelist method), 10 L LinkedObject (class in linkedobject), 9 linkedobject (module), 9 M modify_object() method), 10 (persistentobject.persistentobject 19

24 Unicum Documentation, Release alpha O ObjectList (class in factoryobject), 9 P PersistentDict (class in persistentobject), 10 PersistentList (class in persistentobject), 10 PersistentObject (class in persistentobject), 10 persistentobject (module), 10 R ref_obj (linkedobject.weakattrlink attribute), 10 register() (factoryobject.factoryobject method), 9 register_link() (linkedobject.linkedobject method), 9 remove() (factoryobject.factoryobject method), 9 remove_link() (linkedobject.linkedobject method), 9 row() (datarange.datarange method), 11 row_append() (datarange.datarange method), 11 row_keys() (datarange.datarange method), 11 S SingletonObject (class in singletonobject), 11 singletonobject (module), 11 STARTS_WITH (persistentobject.persistentobject attribute), 10 T to_json() (persistentobject.persistentobject method), 11 to_serializable() (datarange.datarange method), 11 to_serializable() (factoryobject.factoryobject method), 9 to_serializable() (factoryobject.objectlist method), 9 to_serializable() (persistentobject.attributelist method), 10 to_serializable() (persistentobject.persistentdict method), 10 to_serializable() (persistentobject.persistentlist method), 10 to_serializable() (persistentobject.persistentobject method), 11 to_serializable() (visibleobject.visibleobject method), 8 total_list (datarange.datarange attribute), 11 transpose() (datarange.datarange method), 11 U update_link() (linkedobject.linkedobject method), 9 V values() (factoryobject.factoryobject class method), 9 values() (persistentobject.attributelist method), 10 VisibleAttributeList (class in visibleobject), 8 VisibleDataRange (class in visibleobject), 8 VisibleObject (class in visibleobject), 8 visibleobject (module), 8 VisibleObjectList (class in visibleobject), 8 W WeakAttrLink (class in linkedobject), 9 20 Index