pybind/pybind11
1
0
Fork 0
mirror of https://github.com/pybind/pybind11.git synced 2026-04-22 15:59:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix py::trampoline_self_life_support visibility in docs (#5766)

Browse Source 
C++ classes default inheritance rule is private.
I believe py::trampoline_self_life_support must be public to work correctly.
This commit is contained in:
gentlegiantJGC
2025-07-24 16:33:23 +01:00
committed by GitHub
parent 316273efc8
commit 6aeae9c311
2 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/advanced/classes.rst
View File

@@ -64,7 +64,7 @@ helper class that is defined as follows:
.. code-block:: cpp .. code-block:: cpp
class PyAnimal : public Animal, py::trampoline_self_life_support { class PyAnimal : public Animal, public py::trampoline_self_life_support {
public: public:
/* Inherit the constructors */ /* Inherit the constructors */
using Animal::Animal; using Animal::Animal;
@@ -262,13 +262,13 @@ override the ``name()`` method):
.. code-block:: cpp .. code-block:: cpp
class PyAnimal : public Animal, py::trampoline_self_life_support { class PyAnimal : public Animal, public py::trampoline_self_life_support {
public: public:
using Animal::Animal; // Inherit constructors using Animal::Animal; // Inherit constructors
std::string go(int n_times) override { PYBIND11_OVERRIDE_PURE(std::string, Animal, go, n_times); } std::string go(int n_times) override { PYBIND11_OVERRIDE_PURE(std::string, Animal, go, n_times); }
std::string name() override { PYBIND11_OVERRIDE(std::string, Animal, name, ); } std::string name() override { PYBIND11_OVERRIDE(std::string, Animal, name, ); }
}; };
class PyDog : public Dog, py::trampoline_self_life_support { class PyDog : public Dog, public py::trampoline_self_life_support {
public: public:
using Dog::Dog; // Inherit constructors using Dog::Dog; // Inherit constructors
std::string go(int n_times) override { PYBIND11_OVERRIDE(std::string, Dog, go, n_times); } std::string go(int n_times) override { PYBIND11_OVERRIDE(std::string, Dog, go, n_times); }
@@ -290,7 +290,7 @@ declare or override any virtual methods itself:
.. code-block:: cpp .. code-block:: cpp
class Husky : public Dog {}; class Husky : public Dog {};
class PyHusky : public Husky, py::trampoline_self_life_support { class PyHusky : public Husky, public py::trampoline_self_life_support {
public: public:
using Husky::Husky; // Inherit constructors using Husky::Husky; // Inherit constructors
std::string go(int n_times) override { PYBIND11_OVERRIDE_PURE(std::string, Husky, go, n_times); } std::string go(int n_times) override { PYBIND11_OVERRIDE_PURE(std::string, Husky, go, n_times); }
@@ -306,14 +306,14 @@ follows:
.. code-block:: cpp .. code-block:: cpp
template <class AnimalBase = Animal> template <class AnimalBase = Animal>
class PyAnimal : public AnimalBase, py::trampoline_self_life_support { class PyAnimal : public AnimalBase, public py::trampoline_self_life_support {
public: public:
using AnimalBase::AnimalBase; // Inherit constructors using AnimalBase::AnimalBase; // Inherit constructors
std::string go(int n_times) override { PYBIND11_OVERRIDE_PURE(std::string, AnimalBase, go, n_times); } std::string go(int n_times) override { PYBIND11_OVERRIDE_PURE(std::string, AnimalBase, go, n_times); }
std::string name() override { PYBIND11_OVERRIDE(std::string, AnimalBase, name, ); } std::string name() override { PYBIND11_OVERRIDE(std::string, AnimalBase, name, ); }
}; };
template <class DogBase = Dog> template <class DogBase = Dog>
class PyDog : public PyAnimal<DogBase>, py::trampoline_self_life_support { class PyDog : public PyAnimal<DogBase>, public py::trampoline_self_life_support {
public: public:
using PyAnimal<DogBase>::PyAnimal; // Inherit constructors using PyAnimal<DogBase>::PyAnimal; // Inherit constructors
// Override PyAnimal's pure virtual go() with a non-pure one: // Override PyAnimal's pure virtual go() with a non-pure one:
@@ -564,7 +564,7 @@ an alias:
// ... // ...
virtual ~Example() = default; virtual ~Example() = default;
}; };
class PyExample : public Example, py::trampoline_self_life_support { class PyExample : public Example, public py::trampoline_self_life_support {
public: public:
using Example::Example; using Example::Example;
PyExample(Example &&base) : Example(std::move(base)) {} PyExample(Example &&base) : Example(std::move(base)) {}
@@ -1170,7 +1170,7 @@ described trampoline:
virtual int foo() const { return 42; } virtual int foo() const { return 42; }
}; };
class Trampoline : public A, py::trampoline_self_life_support { class Trampoline : public A, public py::trampoline_self_life_support {
public: public:
int foo() const override { PYBIND11_OVERRIDE(int, A, foo, ); } int foo() const override { PYBIND11_OVERRIDE(int, A, foo, ); }
}; };

2
docs/advanced/misc.rst
View File

@@ -80,7 +80,7 @@ could be realized as follows (important changes highlighted):
.. code-block:: cpp .. code-block:: cpp
:emphasize-lines: 8,30,31 :emphasize-lines: 8,30,31
class PyAnimal : public Animal, py::trampoline_self_life_support { class PyAnimal : public Animal, public py::trampoline_self_life_support {
public: public:
/* Inherit the constructors */ /* Inherit the constructors */
using Animal::Animal; using Animal::Animal;