clap.repository

Module Contents

Classes

Repository	Helper class that provides a standard way to create an ABC using
RepositoryFactory
SQLiteRepository	Helper class that provides a standard way to create an ABC using

exception clap.repository.InvalidEntryError(entry)

Bases: RepositoryError

Common base class for all non-exit exceptions.

Initialize self. See help(type(self)) for accurate signature.

class clap.repository.Repository(repository_path, commit_on_close=True, verbosity=0)

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

extension :str =

repository_name :str = AbstractRepository

abstract clear(self)

abstract close(self)

abstract commit(self)

abstract connect(self, table_name)

Parameters

table_name (str) –

Return type

Repository

abstract get(self, key)

Parameters

key (str) –

Return type

Dict[str, dict]

abstract get_all(self)

Return type

Dict[str, dict]

abstract get_multiple(self, key)

Parameters

key (List[str]) –

Return type

dict

abstract keys(self)

Return type

List[str]

abstract open(self, table_name)

Parameters

table_name (str) –

abstract remove(self, key)

Parameters

key (str) –

abstract remove_multiple(self, keys)

Parameters

keys (List[str]) –

abstract update(self, key, update_obj)

Parameters

• key (str) –

• update_obj (dict) –

abstract upsert(self, key, obj)

Parameters

• key (str) –

• obj (dict) –

exception clap.repository.RepositoryError

Bases: Exception

Common base class for all non-exit exceptions.

Initialize self. See help(type(self)) for accurate signature.

class clap.repository.RepositoryFactory

repositories

get_repository(self, name, repository_path, commit_on_close=True, verbosity=0)

Parameters

• name (str) –

• repository_path (str) –

• commit_on_close (bool) –

• verbosity (int) –

Return type

Repository

class clap.repository.SQLiteRepository(repository_path, commit_on_close=True, verbosity=0)

Bases: Repository

Helper class that provides a standard way to create an ABC using inheritance.

extension :str = .db

repository_name :str = sqlite

__repr__(self)

Return repr(self).

clear(self)

close(self)

commit(self)

connect(self, table_name)

Parameters

table_name (str) –

Return type

SQLiteRepository

get(self, key)

Parameters

key (str) –

Return type

dict

get_all(self)

Return type

Dict[str, dict]

get_multiple(self, keys)

Parameters

keys (List[str]) –

Return type

Dict[str, dict]

keys(self)

Return type

List[str]

open(self, table_name)

Parameters

table_name (str) –

remove(self, key)

Parameters

key (str) –

remove_multiple(self, keys)

Parameters

keys (List[str]) –

update(self, key, update_obj)

Parameters

• key (str) –

• update_obj (dict) –

upsert(self, key, obj)

Parameters

• key (str) –

• obj (dict) –