Module pickle :: Class Pickler
[hide private]
[frames] | no frames]

_ClassType Pickler

Instance Methods [hide private]
 
__init__(self, file, protocol=None)
This takes a file-like object for writing a pickle data stream.
 
clear_memo(self)
Clears the pickler's "memo".
 
dump(self, obj)
Write a pickled representation of obj to the open file.
 
memoize(self, obj)
Store an object in the memo.
 
put(self, i, pack=<function pack at 0x404d202c>)
 
get(self, i, pack=<function pack at 0x404d202c>)
 
save(self, obj)
 
persistent_id(self, obj)
 
save_pers(self, pid)
 
save_reduce(self, func, args, state=None, listitems=None, dictitems=None, obj=None)
 
save_none(self, obj)
 
save_bool(self, obj)
 
save_int(self, obj, pack=<function pack at 0x404d202c>)
 
save_long(self, obj, pack=<function pack at 0x404d202c>)
 
save_float(self, obj, pack=<function pack at 0x404d202c>)
 
save_unicode(self, obj, pack=<function pack at 0x404d202c>)
 
save_string(self, obj, pack=<function pack at 0x404d202c>)
 
save_tuple(self, obj)
 
save_empty_tuple(self, obj)
 
save_list(self, obj)
 
_batch_appends(self, items)
 
save_dict(self, obj)
 
_batch_setitems(self, items)
 
save_inst(self, obj)
 
save_global(self, obj, name=None, pack=<function pack at 0x404d202c>)
Class Variables [hide private]
  dispatch = {}
  _BATCHSIZE = 1000
Method Details [hide private]

__init__(self, file, protocol=None)
(Constructor)

 

This takes a file-like object for writing a pickle data stream.

The optional protocol argument tells the pickler to use the given protocol; supported protocols are 0, 1, 2. The default protocol is 0, to be backwards compatible. (Protocol 0 is the only protocol that can be written to a file opened in text mode and read back successfully. When using a protocol higher than 0, make sure the file is opened in binary mode, both when pickling and unpickling.)

Protocol 1 is more efficient than protocol 0; protocol 2 is more efficient than protocol 1.

Specifying a negative protocol version selects the highest protocol version supported. The higher the protocol used, the more recent the version of Python needed to read the pickle produced.

The file parameter must have a write() method that accepts a single string argument. It can thus be an open file object, a StringIO object, or any other custom object that meets this interface.

clear_memo(self)

 

Clears the pickler's "memo".

The memo is the data structure that remembers which objects the pickler has already seen, so that shared or recursive objects are pickled by reference and not by value. This method is useful when re-using picklers.