Source code for kvlayer._exceptions

'''Exceptions for :mod:kvlayer.

.. This software is released under an MIT/X11 open source license.

'''

class KVLayerError(Exception):
'''Base class for all :mod:kvlayer exceptions.'''
pass

class ConfigurationError(KVLayerError):
'''An invalid value was passed to an object.

The value is probably something user-provided, such as the name of
the storage backend.  This error is raised if the invalid value is
not detected until code is being executed.  If the value can be
detected during the :mod:yakonfig configuration phase, then
:class:yakonfig.ConfigurationError will be raised there instead.

'''
pass

class ProgrammerError(KVLayerError):
'''The API was used incorrectly.'''
pass

class StorageClosed(KVLayerError):
'''A storage object was used after it was explicitly closed.'''
pass

[docs]class DatabaseEmpty(KVLayerError):
pass

"""A key value passed to a kvlayer function was not of the correct form.

Keys must be tuples of a fixed length and with specific types.
The length of the tuple is specified in the initial call to
:meth:kvlayer._abstract_storage.AbstractStorage.setup_namespace.

"""
pass

class SerializationError(KVLayerError):
"""Converting between an item and a serialized form failed."""
pass