- [bug] Fixed bug which would prevent

OrderingList from being pickleable
[ticket:2454].  Courtesy Jeff Dairiki

diff --git a/CHANGES b/CHANGES
index 2dcceddb6ee1fbbbe487131a34e59608e461ea6b..727e7235f3d6899c3db8767046f8af852baa0cf3 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -24,6 +24,10 @@ CHANGES
     and joins, particularly when using 
     column_property().  [ticket:2453]
 
+  - [bug] Fixed bug which would prevent
+    OrderingList from being pickleable
+    [ticket:2454].  Courtesy Jeff Dairiki
+
 - postgresql
   - [feature] Added new for_update/with_lockmode()
     options for Postgresql: for_update="read"/

diff --git a/lib/sqlalchemy/ext/orderinglist.py b/lib/sqlalchemy/ext/orderinglist.py
index 97be329e98f16a5ae4ee18d02ee755be242a60f6..0a27ee309361106a6a05c307e4a32ec189b3030a 100644 (file)
--- a/lib/sqlalchemy/ext/orderinglist.py
+++ b/lib/sqlalchemy/ext/orderinglist.py
@@ -314,9 +314,23 @@ class OrderingList(list):
         self._reorder()
     # end Py2K
 
+    def __reduce__(self):
+        return _reconstitute, (self.__class__, self.__dict__, list(self))
+
     for func_name, func in locals().items():
         if (util.callable(func) and func.func_name == func_name and
             not func.__doc__ and hasattr(list, func_name)):
             func.__doc__ = getattr(list, func_name).__doc__
     del func_name, func
 
+def _reconstitute(cls, dict_, items):
+    """ Reconstitute an ``OrderingList``.
+
+    This is the adjoint to ``OrderingList.__reduce__()``.  It is used for
+    unpickling ``OrderingList``\\s
+
+    """
+    obj = cls.__new__(cls)
+    obj.__dict__.update(dict_)
+    list.extend(obj, items)
+    return obj

diff --git a/test/ext/test_orderinglist.py b/test/ext/test_orderinglist.py
index dfeac5c3edc30bccb60a87f2968db16aa7138305..0b7d4328ec8814f493e42e7ed7061978b7c9de53 100644 (file)
--- a/test/ext/test_orderinglist.py
+++ b/test/ext/test_orderinglist.py
@@ -1,8 +1,10 @@
-from sqlalchemy import *
-from sqlalchemy.orm import *
-from sqlalchemy.ext.orderinglist import *
+from sqlalchemy import Integer, ForeignKey, String, MetaData
+from sqlalchemy.orm import relationship, mapper, create_session
+from sqlalchemy.ext.orderinglist import ordering_list
 from test.lib.testing import eq_
-from test.lib import *
+from test.lib import fixtures, testing
+from test.lib.schema import Table, Column
+from test.lib.util import picklers
 
 
 metadata = None
@@ -407,3 +409,25 @@ class OrderingListTest(fixtures.TestBase):
             self.assert_(alpha[li].position == pos)
 
 
+    def test_picklability(self):
+        from sqlalchemy.ext.orderinglist import OrderingList
+
+        olist = OrderingList('order', reorder_on_append=True)
+        olist.append(DummyItem())
+
+        for loads, dumps in picklers():
+            pck = dumps(olist)
+            copy = loads(pck)
+
+            self.assert_(copy == olist)
+            self.assert_(copy.__dict__ == olist.__dict__)
+
+class DummyItem(object):
+    def __init__(self, order=None):
+        self.order = order
+
+    def __eq__(self, other):
+        return self.order == other.order
+
+    def __ne__(self, other):
+        return not (self == other)