Title: Bug in Pickle protocol involving __setstate__
Type: behavior Stage:
Components: Library (Lib) Versions: Python 2.5
Status: closed Resolution: not a bug
Dependencies: Superseder:
Assigned To: Nosy List: QuantumTim, georg.brandl, gpk
Priority: normal Keywords:

Created on 2008-03-15 18:58 by gpk, last changed 2008-03-15 20:16 by georg.brandl. This issue is now closed.

Messages (3)
msg63559 - (view) Author: Greg Kochanski (gpk) Date: 2008-03-15 18:58
If we have a hierarchy of classes, and we use
__getstate__/__setstate__, the wrong class'
__setstate__ gets called.

Possibly, this is a documentation problem, but here goes:

Take two classes, A and B, where B is the child of A.

Construct a B.   Pickle it.   Unpickle it, and you find
that the __setstate__ function for A is called with the result
produced by B.__getstate__().

This is wrong.

An example follows:

import pickle as P

class A(object):
        def __init__(self, a):
                print 'A.__init__'
                self.a = a

        def __getstate__(self):
                print 'A.__getstate'
                return self.a

        def __setstate__(self, upstate):
                print 'A.__setstate', upstate
                self.a = upstate

class B(A):
        def __init__(self, a, b):
                print 'B.__init__'
                A.__init__(self, a)
                self.b = b

        def __getstate__(self):
                print 'B.__getstate'
                return (A.__getstate__(self), self.b)

        def __setstate(self, upstate):
        # This never gets called!
                print 'B.__setstate', upstate
                A.__setstate__(self, upstate[0])
                self.b = upstate[1]

        def __repr__(self):
                return '<B a=%d b=%d>' % (self.a, self.b)

q = B(1,2)
print '---'
r = P.loads(P.dumps(q, 0))
print 'q=', q
print 'r=', r

Now, run it:

$ python
A.__setstate (1, 2)
q= <B a=1 b=2, h=46912504218064>
r= Traceback (most recent call last):
  File "", line 44, in <module>
    print 'r=', r
  File "", line 37, in __repr__
    return '<B a=%d b=%d>' % (self.a, self.b)
AttributeError: 'B' object has no attribute 'b'

Note that this problem doesn't get noticed in the
common case where you simply pass __dict__ around
from __getstate__ to __setstate__.    However, it
exists in many other use cases.
msg63561 - (view) Author: Tim Gordon (QuantumTim) Date: 2008-03-15 19:21
You've missed off the two underscores after the name __setstate__ :p
msg63564 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2008-03-15 20:16
Closing as invalid.
Date User Action Args
2008-03-15 20:16:59georg.brandlsetstatus: open -> closed
nosy: + georg.brandl
resolution: not a bug
messages: + msg63564
2008-03-15 19:21:02QuantumTimsetnosy: + QuantumTim
messages: + msg63561
2008-03-15 18:58:33gpkcreate