1758
Comment: Fix code example wiki markup.
|
1977
fixed grammar mistakes and made more readable
|
Deletions are marked like this. | Additions are marked like this. |
Line 3: | Line 3: |
Since Python handles memory allocation and garbage collection automatically, the concept "pointer" is not meaningful within Python. However, many C++ API exposes either raw pointers or shared pointers, and to wrap such APIs one would need to deal with pointers. | Since Python handles memory allocation and garbage collection automatically, the concept of a "pointer" is not meaningful in Python. However, many C++ APIs expose either raw pointers or shared pointers, to wrap these APIs we need to deal with pointers. |
Line 5: | Line 5: |
=== Pointers (raw C++ pointers) === | === Raw C++ Pointers === |
Line 7: | Line 7: |
The life time of C++ objects created by "new A" can be handled by Python's garbage collection by using the {{{manage_new_object}}} storage policy: | The lifetime of C++ objects created by {{{new A}}} can be handled by Python's garbage collection by using the {{{manage_new_object}}} return policy: |
Line 18: | Line 18: |
.def("create",&A::create,return_value_policy<manage_new_object>()) | .def("create",&A::create, return_value_policy<manage_new_object>()) |
Line 34: | Line 34: |
Smart pointers, e.g. boost::shared_ptr<T>, is another common way to give away ownership of objects in C++. Theese kind of smart pointer are automatically handled, if you declare their existence, when declaring the class to boost.python. |
The usage of smart pointers (e.g. {{{boost::shared_ptr<T>}}}) is another common way to give away ownership of objects in C++. These kinds of smart pointer are automatically handled if you declare their existence when declaring the class to boost::python. This is done by including the holding type as a template parameter to {{{class_<>}}}, like in the following example: |
Line 38: | Line 36: |
E.g. | {{{ #include <string> #include <boost/shared_ptr.hpp> #include <boost/python.hpp> |
Line 40: | Line 41: |
{{{#include <boost/shared_ptr.h> | |
Line 42: | Line 42: |
using namespace std; using namespace boost::python; |
|
Line 59: | Line 61: |
Pointers and smart pointers
Since Python handles memory allocation and garbage collection automatically, the concept of a "pointer" is not meaningful in Python. However, many C++ APIs expose either raw pointers or shared pointers, to wrap these APIs we need to deal with pointers.
Raw C++ Pointers
The lifetime of C++ objects created by new A can be handled by Python's garbage collection by using the manage_new_object return policy:
struct A { static A* create () { return new A; } std::string hello () { return "Hello, is there anybody in there?"; } }; BOOST_PYTHON_MODULE(shared_ptr) { class_<A>("A",no_init) .def("create",&A::create, return_value_policy<manage_new_object>()) .staticmethod("create") .def("hello",&A::hello) ; }
A sample python program:
from pointer import * an_A = A.create() print an_A.hello()
Smart pointers
The usage of smart pointers (e.g. boost::shared_ptr<T>) is another common way to give away ownership of objects in C++. These kinds of smart pointer are automatically handled if you declare their existence when declaring the class to boost::python. This is done by including the holding type as a template parameter to class_<>, like in the following example:
#include <string> #include <boost/shared_ptr.hpp> #include <boost/python.hpp> using namespace boost; using namespace std; using namespace boost::python; struct A { static shared_ptr<A> create () { return shared_ptr<A>(new A); } std::string hello () { return "Just nod if you can hear me!"; } }; BOOST_PYTHON_MODULE(shared_ptr) { class_<A, shared_ptr<A> >("A",init<>()) .def("create",&A::create ) .staticmethod("create") .def("hello",&A::hello) ; }
A sample python program:
from shared_ptr import * an_A = A.create() print an_A.hello()