colda.pi package

Submodules

colda.pi.api module

class colda.pi.api.PI

Bases: BasePI

Store personal information

Attributes

user_id default_mode root

Methods

logout

property data_storage_root: str: Get the root path of data storage. Default data_storage_root is the path of current file.

Returns

str

property default_mode: str: Get the default mode. default mode is set to ‘auto’ at first

Returns

str

classmethod delete()

classmethod get_instance() → type[pi.pi.PI]: Singleton pattern. Get instance of current class.

Returns

type[PI]

classmethod logout() → None: Handle user logout by deleting instance

Returns

None

property user_id: str: Get the user id.

Returns

str

colda.pi.base module

class colda.pi.base.BasePI

Bases: object

Base class for PI

final placeholder()

colda.pi.pi module

class colda.pi.pi.PI

Bases: BasePI

Store personal information

Attributes

user_id default_mode root

Methods

logout

property data_storage_root: str: Get the root path of data storage. Default data_storage_root is the path of current file.

Returns

str

property default_mode: str: Get the default mode. default mode is set to ‘auto’ at first

Returns

str

classmethod delete()

classmethod get_instance() → type[colda.pi.pi.PI]: Singleton pattern. Get instance of current class.

Returns

type[PI]

classmethod logout() → None: Handle user logout by deleting instance

Returns

None

property user_id: str: Get the user id.

Returns

str

Module contents