much more informative pickle error messages if pickling is not enabled

Ralf W. Grosse-Kunstleve · Ralf W. Grosse-Kunstleve · commit fe3abeda9f93 · 2006-05-18T15:49:41.000Z
[SVN r34004]
diff --git a/src/object/class.cpp b/src/object/class.cpp
@@ -530,6 +530,10 @@ namespace objects
       if (scope().ptr() != Py_None)
           scope().attr(name) = result;
 
+      // For pickle. Will lead to informative error messages if pickling
+      // is not enabled.
+      result.attr("__reduce__") = object(make_instance_reduce_function());
+
       return result;
     }
   }
@@ -627,7 +631,6 @@ namespace objects
 
   void class_base::enable_pickling_(bool getstate_manages_dict)
   {
-      setattr("__reduce__", object(make_instance_reduce_function()));
       setattr("__safe_for_unpickling__", object(true));
       
       if (getstate_manages_dict)
diff --git a/src/object/pickle_support.cpp b/src/object/pickle_support.cpp
@@ -8,6 +8,7 @@
 #include <boost/python/tuple.hpp>
 #include <boost/python/list.hpp>
 #include <boost/python/dict.hpp>
+#include <boost/python/str.hpp>
 
 namespace boost { namespace python {
 
@@ -19,6 +20,22 @@ namespace {
       object instance_class(instance_obj.attr("__class__"));
       result.append(instance_class);
       object none;
+      if (!getattr(instance_obj, "__safe_for_unpickling__", none))
+      {
+          str type_name(getattr(instance_class, "__name__"));
+          str module_name(getattr(instance_class, "__module__", ""));
+          if (module_name)
+              module_name += ".";
+
+          PyErr_SetObject(
+               PyExc_RuntimeError,
+               ( "Pickling of \"%s\" instances is not enabled"
+                 " (http://www.boost.org/libs/python/doc/v2/pickle.html)"
+                  % (module_name+type_name)).ptr()
+          );
+
+          throw_error_already_set();
+      }
       object getinitargs = getattr(instance_obj, "__getinitargs__", none);
       tuple initargs;
       if (getinitargs.ptr() != none.ptr()) {
diff --git a/test/pickle1.cpp b/test/pickle1.cpp
@@ -45,6 +45,8 @@ namespace {
     }
   };
 
+  // To support test of "pickling not enabled" error message.
+  struct noop {};
 }
 
 BOOST_PYTHON_MODULE(pickle1_ext)
@@ -54,4 +56,7 @@ BOOST_PYTHON_MODULE(pickle1_ext)
       .def("greet", &world::greet)
       .def_pickle(world_pickle_suite())
       ;
+
+  // To support test of "pickling not enabled" error message.
+  class_<noop>("noop");
 }
diff --git a/test/pickle1.py b/test/pickle1.py
@@ -18,6 +18,11 @@
     Hello from California!
     >>> print wl.greet()
     Hello from California!
+
+    >>> noop = pickle1_ext.noop()
+    >>> try: pickle.dumps(noop)
+    ... except RuntimeError, e: print str(e)[:55]
+    Pickling of "pickle1_ext.noop" instances is not enabled
 '''
 
 def run(args = None):

Original file line number	Diff line number	Diff line change
`@@ -530,6 +530,10 @@ namespace objects`
`530`	`530`	`if (scope().ptr() != Py_None)`
`531`	`531`	`scope().attr(name) = result;`
`532`	`532`
	`533`	`+ // For pickle. Will lead to informative error messages if pickling`
	`534`	`+ // is not enabled.`
	`535`	`+ result.attr("__reduce__") = object(make_instance_reduce_function());`
	`536`	`+`
`533`	`537`	`return result;`
`534`	`538`	`}`
`535`	`539`	`}`
`@@ -627,7 +631,6 @@ namespace objects`
`627`	`631`
`628`	`632`	`void class_base::enable_pickling_(bool getstate_manages_dict)`
`629`	`633`	`{`
`630`		`- setattr("__reduce__", object(make_instance_reduce_function()));`
`631`	`634`	`setattr("__safe_for_unpickling__", object(true));`
`632`	`635`
`633`	`636`	`if (getstate_manages_dict)`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,8 @@ namespace {`
`45`	`45`	`}`
`46`	`46`	`};`
`47`	`47`
	`48`	`+ // To support test of "pickling not enabled" error message.`
	`49`	`+ struct noop {};`
`48`	`50`	`}`
`49`	`51`
`50`	`52`	`BOOST_PYTHON_MODULE(pickle1_ext)`
`@@ -54,4 +56,7 @@ BOOST_PYTHON_MODULE(pickle1_ext)`
`54`	`56`	`.def("greet", &world::greet)`
`55`	`57`	`.def_pickle(world_pickle_suite())`
`56`	`58`	`;`
	`59`	`+`
	`60`	`+ // To support test of "pickling not enabled" error message.`
	`61`	`+ class_<noop>("noop");`
`57`	`62`	`}`