mirror of
https://github.com/RYDE-WORK/pybind11.git
synced 2026-01-23 07:23:23 +08:00
7437c69500
This commit adds a `py::module_local` attribute that lets you confine a
registered type to the module (more technically, the shared object) in
which it is defined, by registering it with:
py::class_<C>(m, "C", py::module_local())
This will allow the same C++ class `C` to be registered in different
modules with independent sets of class definitions. On the Python side,
two such types will be completely distinct; on the C++ side, the C++
type resolves to a different Python type in each module.
This applies `py::module_local` automatically to `stl_bind.h` bindings
when the container value type looks like something global: i.e. when it
is a converting type (for example, when binding a `std::vector<int>`),
or when it is a registered type itself bound with `py::module_local`.
This should help resolve potential future conflicts (e.g. if two
completely unrelated modules both try to bind a `std::vector<int>`.
Users can override the automatic selection by adding a
`py::module_local()` or `py::module_local(false)`.
Note that this does mildly break backwards compatibility: bound stl
containers of basic types like `std::vector<int>` cannot be bound in one
module and returned in a different module. (This can be re-enabled with
`py::module_local(false)` as described above, but with the potential for
eventual load conflicts).
27 lines
838 B
C++
27 lines
838 B
C++
#pragma once
|
|
#include "pybind11_tests.h"
|
|
|
|
/// Simple class used to test py::local:
|
|
template <int> class LocalBase {
|
|
public:
|
|
LocalBase(int i) : i(i) { }
|
|
int i = -1;
|
|
};
|
|
|
|
/// Registered with py::local in both main and secondary modules:
|
|
using LocalType = LocalBase<0>;
|
|
/// Registered without py::local in both modules:
|
|
using NonLocalType = LocalBase<1>;
|
|
/// A second non-local type (for stl_bind tests):
|
|
using NonLocal2 = LocalBase<2>;
|
|
/// Tests within-module, different-compilation-unit local definition conflict:
|
|
using LocalExternal = LocalBase<3>;
|
|
|
|
// Simple bindings (used with the above):
|
|
template <typename T, int Adjust, typename... Args>
|
|
py::class_<T> bind_local(Args && ...args) {
|
|
return py::class_<T>(std::forward<Args>(args)...)
|
|
.def(py::init<int>())
|
|
.def("get", [](T &i) { return i.i + Adjust; });
|
|
};
|