Module Cerealizer :: Class Handler
[show private | hide private]
[frames | no frames]

Type Handler

object --+
         |
        Handler

Known Subclasses:
DictHandler, ListHandler, ObjHandler, TupleHandler

Handler

A customized handler for serialization and deserialization. You can subclass it to extend cerealization support to new object. See also ObjHandler.
Method Summary
  collect(self, obj, dumper)
Handler.collect(obj, dumper) -> bool
  dump_data(self, obj, dumper, s)
Handler.dump_data(obj, dumper, s)
  dump_obj(self, obj, dumper, s)
Handler.dump_obj(obj, dumper, s)
  dump_ref(self, obj, dumper, s)
Handler.dump_ref(obj, dumper, s)
  undump_data(self, obj, dumper, s)
Handler.undump_data(obj, dumper, s)
  undump_obj(self, dumper, s)
Handler.undump_obj(dumper, s)
    Inherited from object
  __init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __repr__(x)
x.__repr__() <==> repr(x)
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Method Details

collect(self, obj, dumper)

Handler.collect(obj, dumper) -> bool

Collects all the objects referenced by OBJ. For each objects ROBJ referenced by OBJ, calls collect method of the Handler for ROBJ's class, i.e._HANDLERS_[ROBJ.__class__].collect(ROBJ, dumper). Returns false if OBJ is already referenced (and thus no collection should occur); else returns true.

dump_data(self, obj, dumper, s)

Handler.dump_data(obj, dumper, s)

Dumps OBJ data in file S.

dump_obj(self, obj, dumper, s)

Handler.dump_obj(obj, dumper, s)

Dumps OBJ classname in file S.

dump_ref(self, obj, dumper, s)

Handler.dump_ref(obj, dumper, s)

Write a reference to OBJ in file S. You should not override dump_ref, since they is no corresponding 'undump_ref' that you can override.

undump_data(self, obj, dumper, s)

Handler.undump_data(obj, dumper, s)

Reads the data for OBJ, from DUMPER and file S. If you override undump_data, you should use DUMPER.undump_ref(S) to read a reference or a basic type (=a string, an int,...).

undump_obj(self, dumper, s)

Handler.undump_obj(dumper, s)

Returns a new uninitialized (=no __init__'ed) instance of the class. If you override undump_obj, DUMPER and file S can be used to read additional data saved by Handler.dump_obj().

Generated by Epydoc 2.1 on Thu Nov 23 23:40:42 2006 http://epydoc.sf.net