Package couchable :: Module core :: Class CouchableDoc

Class CouchableDoc

object --+
         |
        CouchableDoc

Base class for types that should be stored as CouchDB documents.

Note: Deriving from this class is optional; classes may also use registerDocType. The only advantage to subclassing this is that registerDocType has already been called for this class.

Instance Methods

preStore(self, cdb)
Basic hook point for adding behavior needed just prior to storage.

source code

postLoad(self, cdb)
Basic hook point for adding behavior needed just after to loading.

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

preStore(self, cdb)

source code

Basic hook point for adding behavior needed just prior to storage.

Defaults to a no-op.

Parameters:

cdb (CouchableDb) - CouchableDb object that this object is about to be stored with.

postLoad(self, cdb)

source code

Basic hook point for adding behavior needed just after to loading.

Defaults to a no-op.

Parameters:

cdb (CouchableDb) - CouchableDb object that this object was just loaded from.