Support Python overriding of Storable::cloneStorable.

lsst · Nov 5, 2019 · 57e2b73 · 57e2b73
1 parent b3e50ca
commit 57e2b73
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/include/lsst/afw/typehandling/python.h b/include/lsst/afw/typehandling/python.h
@@ -51,7 +51,12 @@ class StorableHelper : public Base {
 public:
     using Base::Base;
 
-    // Can't wrap clone(); PYBIND11_OVERLOAD chokes on unique_ptr return type
+    std::shared_ptr<Storable> cloneStorable() const override {
+        /* __deepcopy__ takes an optional dict, but PYBIND11_OVERLOAD_* doesn't
+         * allow translation between different argument lists in C++ and Python
+         */
+        PYBIND11_OVERLOAD_NAME(std::shared_ptr<Storable>, Base, "__deepcopy__", cloneStorable, );
+    }
 
     std::string toString() const override {
         PYBIND11_OVERLOAD_NAME(std::string, Base, "__repr__", toString, );

diff --git a/tests/testGenericMapLib.cc b/tests/testGenericMapLib.cc
@@ -295,6 +295,14 @@ std::shared_ptr<Storable> keepStaticStorable(std::shared_ptr<Storable> storable
     return longLived;
 }
 
+/**
+ * Copy a Storable in C++.
+ *
+ * @param input The Storable to copy.
+ * @returns An identical but independent Storable.
+ */
+std::shared_ptr<Storable> duplicate(std::shared_ptr<Storable> input) { return input->cloneStorable(); }
+
 }  // namespace
 
 namespace {
@@ -333,6 +341,7 @@ PYBIND11_MODULE(testGenericMapLib, mod) {
     mod.def("makeCppUpdates", &makeCppUpdates, "testmap"_a);
     mod.def("addCppStorable", &addCppStorable, "testmap"_a);
     mod.def("keepStaticStorable", &keepStaticStorable, "storable"_a = nullptr);
+    mod.def("duplicate", &duplicate, "input"_a);
 
     py::class_<CppStorable, PySharedPtr<CppStorable>, Storable, StorableHelper<CppStorable>> cls(
             mod, "CppStorable");

diff --git a/tests/test_Storable.py b/tests/test_Storable.py
@@ -80,9 +80,16 @@ def testCopy(self):
         self.assertIsNot(deep, self.testbed)
         self.assertEqual(deep, self.testbed)
 
+        cpp = cppLib.duplicate(self.testbed)
+        self.assertIsInstance(cpp, Storable)
+        self.assertIsInstance(cpp, DemoStorable)
+        self.assertIsNot(cpp, self.testbed)
+        self.assertEqual(cpp, self.testbed)
+
         self.aList.append(43)
         self.assertEqual(shallow, DemoStorable([42, 43]))
         self.assertEqual(deep, DemoStorable([42]))
+        self.assertEqual(cpp, DemoStorable([42]))
 
     def testStr(self):
         self.assertEqual(str(self.testbed), "value = [42]")