moobius.database.json_database

Module-level functions

(No module-level functions)

Class JSONDatabase

JSONDatabase simply stores information as JSON strings in a list of files. Each domain, key combination is stored as one file. Dataclass objects can be seralized as well.

JSONDatabase.get_value

Gets the value (which is a dict). Note: This “key” is different from a key to look up a CachedDict file. Note: This function should not be called directly.

Signature:

• **JSONDatabase.get_value**(self, key)

Parameters:

• __key:__ String-valued key.

Returns:

• The is_sucessful, the_value.

Raises:

• TypeError: If the type of the value is unknown, so we can’t construct the object.

JSONDatabase.set_value

Updates and saves a cached dict,.

Signature:

• **JSONDatabase.set_value**(self, key, value)

Parameters:

• __key:__ String-valued key.

• __value:__ A dict-valued value.

Returns:

• (is_success, the key).

Note: This function should not be called directly.

Raises:

• (this function does not raise any notable errors)

JSONDatabase.delete_key

Deletes a cached dict.

Signature:

• **JSONDatabase.delete_key**(self, key)

Parameters:

• __key:__ Key.

Returns:

• (True, the key)

Note: This function should not be called directly.

Raises:

• (this function does not raise any notable errors)

JSONDatabase.all_keys

Gets all the cached dicts in the database.

Signature:

• **JSONDatabase.all_keys**(self)

Parameters:

• __(this class constructor accepts no arguments):__

Returns:

• The dicts as an iterable which internally uses yield().

Raises:

• (this function does not raise any notable errors)

Class attributes

JSONDatabase.DatabaseInterface

Internals

• Private functions
  • JSONDatabase.__str__
  • JSONDatabase.__repr__
• Private attributes