mvpa.misc.io.hamster

Helper for simple storage facility via cPickle and zlib

The comprehensive API documentation for this module, including all technical details, is available in the Epydoc-generated API reference for mvpa.misc.io.hamster (for developers).

Hamster

class mvpa.misc.io.hamster.Hamster(*args, **kwargs)

Bases: object

Simple container class with basic IO capabilities.

It is capable of storing itself in a file, or loading from a file (using cPickle + zlib tandem). Any serializable object can be bound to a hamster to be stored.

To undig burried hamster use Hamster(filename). Here is an example:

>>> h = Hamster(bla='blai')
>>> h.boo = N.arange(5)
>>> h.dump(filename)
...
>>> h = Hamster(filename)

Since Hamster introduces methods dump, asdict and property ‘registered’, those names cannot be used to assign an attribute, nor provided in among constructor arguments.

Initialize Hamster.

Providing a single parameter string would treat it as a filename from which to undig the data. Otherwise all keyword parameters are assigned into the attributes of the object.

asdict()

Return registered data as dictionary

dump(filename)

Bury the hamster into the file

registered

See also

Derived classes might provide additional methods via their base classes. Please refer to the list of base classes (if it exists) at the begining of the Hamster documentation.

Full API documentation of Hamster in module mvpa.misc.io.hamster.