Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
gaoqiong
pybind11
Commits
a7ff616d
Commit
a7ff616d
authored
May 04, 2018
by
Tom de Geus
Committed by
Jason Rhinelander
May 06, 2018
Browse files
Simplified example allowing more robust usage, fixed minor spelling issues
parent
f5f66189
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
12 additions
and
14 deletions
+12
-14
docs/advanced/classes.rst
docs/advanced/classes.rst
+12
-14
No files found.
docs/advanced/classes.rst
View file @
a7ff616d
...
@@ -46,11 +46,10 @@ Normally, the binding code for these classes would look as follows:
...
@@ -46,11 +46,10 @@ Normally, the binding code for these classes would look as follows:
.. code-block:: cpp
.. code-block:: cpp
PYBIND11_MODULE(example, m) {
PYBIND11_MODULE(example, m) {
py::class_<Animal> animal(m, "Animal");
py::class_<Animal>(m, "Animal");
animal
.def("go", &Animal::go);
.def("go", &Animal::go);
py::class_<Dog>(m, "Dog"
, animal
)
py::class_<Dog
, Animal
>(m, "Dog")
.def(py::init<>());
.def(py::init<>());
m.def("call_go", &call_go);
m.def("call_go", &call_go);
...
@@ -93,15 +92,14 @@ function have different names, e.g. ``operator()`` vs ``__call__``.
...
@@ -93,15 +92,14 @@ function have different names, e.g. ``operator()`` vs ``__call__``.
The binding code also needs a few minor adaptations (highlighted):
The binding code also needs a few minor adaptations (highlighted):
.. code-block:: cpp
.. code-block:: cpp
:emphasize-lines: 2,
4,5
:emphasize-lines: 2,
3
PYBIND11_MODULE(example, m) {
PYBIND11_MODULE(example, m) {
py::class_<Animal, PyAnimal /* <--- trampoline*/> animal(m, "Animal");
py::class_<Animal, PyAnimal /* <--- trampoline*/>(m, "Animal");
animal
.def(py::init<>())
.def(py::init<>())
.def("go", &Animal::go);
.def("go", &Animal::go);
py::class_<Dog>(m, "Dog"
, animal
)
py::class_<Dog
, Animal
>(m, "Dog")
.def(py::init<>());
.def(py::init<>());
m.def("call_go", &call_go);
m.def("call_go", &call_go);
...
@@ -116,11 +114,11 @@ define a constructor as usual.
...
@@ -116,11 +114,11 @@ define a constructor as usual.
Bindings should be made against the actual class, not the trampoline helper class.
Bindings should be made against the actual class, not the trampoline helper class.
.. code-block:: cpp
.. code-block:: cpp
:emphasize-lines: 3
py::class_<Animal, PyAnimal /* <--- trampoline*/> animal(m, "Animal");
py::class_<Animal, PyAnimal /* <--- trampoline*/>(m, "Animal");
animal
.def(py::init<>())
.def(py::init<>())
.def("go", &PyAnimal::go); /* <--- THIS IS WRONG, use &Animal::go */
.def("go", &PyAnimal::go); /* <--- THIS IS WRONG, use &Animal::go */
Note, however, that the above is sufficient for allowing python classes to
Note, however, that the above is sufficient for allowing python classes to
extend ``Animal``, but not ``Dog``: see :ref:`virtual_and_inheritance` for the
extend ``Animal``, but not ``Dog``: see :ref:`virtual_and_inheritance` for the
...
@@ -157,7 +155,7 @@ Here is an example:
...
@@ -157,7 +155,7 @@ Here is an example:
class Dachschund(Dog):
class Dachschund(Dog):
def __init__(self, name):
def __init__(self, name):
Dog.__init__(self) # Without this, undefind behavior may occur if the C++ portions are referenced.
Dog.__init__(self) # Without this, undefin
e
d behavior may occur if the C++ portions are referenced.
self.name = name
self.name = name
def bark(self):
def bark(self):
return "yap!"
return "yap!"
...
@@ -760,7 +758,7 @@ document)---pybind11 will automatically find out which is which. The only
...
@@ -760,7 +758,7 @@ document)---pybind11 will automatically find out which is which. The only
requirement is that the first template argument is the type to be declared.
requirement is that the first template argument is the type to be declared.
It is also permitted to inherit multiply from exported C++ classes in Python,
It is also permitted to inherit multiply from exported C++ classes in Python,
as well as inheriting from multiple Python and/or pybind-exported classes.
as well as inheriting from multiple Python and/or pybind
11
-exported classes.
There is one caveat regarding the implementation of this feature:
There is one caveat regarding the implementation of this feature:
...
@@ -781,7 +779,7 @@ are listed.
...
@@ -781,7 +779,7 @@ are listed.
Module-local class bindings
Module-local class bindings
===========================
===========================
When creating a binding for a class, pybind by default makes that binding
When creating a binding for a class, pybind
11
by default makes that binding
"global" across modules. What this means is that a type defined in one module
"global" across modules. What this means is that a type defined in one module
can be returned from any module resulting in the same Python type. For
can be returned from any module resulting in the same Python type. For
example, this allows the following:
example, this allows the following:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment