summaryrefslogtreecommitdiffstats
path: root/src/boost/libs/python/test/pickle1.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/boost/libs/python/test/pickle1.cpp')
-rw-r--r--src/boost/libs/python/test/pickle1.cpp62
1 files changed, 62 insertions, 0 deletions
diff --git a/src/boost/libs/python/test/pickle1.cpp b/src/boost/libs/python/test/pickle1.cpp
new file mode 100644
index 000000000..cc4ad6795
--- /dev/null
+++ b/src/boost/libs/python/test/pickle1.cpp
@@ -0,0 +1,62 @@
+// Copyright Ralf W. Grosse-Kunstleve 2002-2004. Distributed under the Boost
+// Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
+/*
+ This example shows how to make an Extension Class "pickleable".
+
+ The world class below can be fully restored by passing the
+ appropriate argument to the constructor. Therefore it is sufficient
+ to define the pickle interface method __getinitargs__.
+
+ For more information refer to boost/libs/python/doc/pickle.html.
+ */
+
+#include <boost/python/module.hpp>
+#include <boost/python/def.hpp>
+#include <boost/python/class.hpp>
+#include <boost/python/tuple.hpp>
+
+#include <string>
+
+namespace boost_python_test {
+
+ // A friendly class.
+ class world
+ {
+ private:
+ std::string country;
+ public:
+ world(const std::string& _country) {
+ this->country = _country;
+ }
+ std::string greet() const { return "Hello from " + country + "!"; }
+ std::string get_country() const { return country; }
+ };
+
+ struct world_pickle_suite : boost::python::pickle_suite
+ {
+ static
+ boost::python::tuple
+ getinitargs(const world& w)
+ {
+ return boost::python::make_tuple(w.get_country());
+ }
+ };
+
+ // To support test of "pickling not enabled" error message.
+ struct noop {};
+}
+
+BOOST_PYTHON_MODULE(pickle1_ext)
+{
+ using namespace boost::python;
+ using namespace boost_python_test;
+ class_<world>("world", init<const std::string&>())
+ .def("greet", &world::greet)
+ .def_pickle(world_pickle_suite())
+ ;
+
+ // To support test of "pickling not enabled" error message.
+ class_<noop>("noop");
+}