pybind11/docs/advanced/cast
Jason Rhinelander 7437c69500 Add py::module_local() attribute for module-local type bindings
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).
2017-08-04 10:47:34 -04:00
..
chrono.rst Automate generation of reference docs with doxygen and breathe (#598) 2017-01-31 16:54:08 +01:00
custom.rst add note about custom type casters (fixes #480) 2016-11-04 11:06:22 +01:00
eigen.rst Eigen<->numpy referencing support 2017-02-24 23:19:50 +01:00
functional.rst Replace PYBIND11_PLUGIN with PYBIND11_MODULE 2017-05-29 03:21:19 +02:00
index.rst RFC - Add documentation for strings and Unicode issues (#636) 2017-02-02 13:56:31 +01:00
overview.rst Support std::string_view when compiled under C++17 2017-06-24 03:24:56 -03:00
stl.rst Add py::module_local() attribute for module-local type bindings 2017-08-04 10:47:34 -04:00
strings.rst Fix invalid reference definition in string conversion docs 2017-06-25 17:35:44 +02:00