mirror of
https://github.com/pybind/pybind11.git
synced 2024-11-14 09:34:46 +00:00
d65edfb024
* Create a module_internals struct Since we now have two things that are going to be module local, it felt correct to add a struct to manage them. * Add local exception translators These are added via the register_local_exception_translator function and are then applied before the global translators * Add unit tests to show the local exception translator works * Fix a bug in the unit test with the string value of KeyError * Fix a formatting issue * Rename registered_local_types_cpp() Rename it to get_registered_local_types_cpp() to disambiguate from the new member of module_internals * Add additional comments to new local exception code path * Add a register_local_exception function * Add additional unit tests for register_local_exception * Use get_local_internals like get_internals * Update documentation for new local exception feature * Add back a missing space * Clean-up some issues in the docs * Remove the code duplication when translating exceptions Separated out the exception processing into a standalone function in the details namespace. Clean-up some comments as per PR notes as well * Remove the code duplication in register_exception * Cleanup some formatting things caught by clang-format * Remove the templates from exception translators But I added a using declaration to alias the type. * Remove the extra local from local_internals variable names * Add an extra explanatory comment to local_internals * Fix a typo in the code
86 lines
2.7 KiB
C++
86 lines
2.7 KiB
C++
#pragma once
|
|
#include <utility>
|
|
|
|
#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::module_local in both main and secondary modules:
|
|
using LocalType = LocalBase<0>;
|
|
/// Registered without py::module_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>;
|
|
/// Mixed: registered local first, then global
|
|
using MixedLocalGlobal = LocalBase<4>;
|
|
/// Mixed: global first, then local
|
|
using MixedGlobalLocal = LocalBase<5>;
|
|
|
|
/// Registered with py::module_local only in the secondary module:
|
|
using ExternalType1 = LocalBase<6>;
|
|
using ExternalType2 = LocalBase<7>;
|
|
|
|
using LocalVec = std::vector<LocalType>;
|
|
using LocalVec2 = std::vector<NonLocal2>;
|
|
using LocalMap = std::unordered_map<std::string, LocalType>;
|
|
using NonLocalVec = std::vector<NonLocalType>;
|
|
using NonLocalVec2 = std::vector<NonLocal2>;
|
|
using NonLocalMap = std::unordered_map<std::string, NonLocalType>;
|
|
using NonLocalMap2 = std::unordered_map<std::string, uint8_t>;
|
|
|
|
|
|
// Exception that will be caught via the module local translator.
|
|
class LocalException : public std::exception {
|
|
public:
|
|
explicit LocalException(const char * m) : message{m} {}
|
|
const char * what() const noexcept override {return message.c_str();}
|
|
private:
|
|
std::string message = "";
|
|
};
|
|
|
|
// Exception that will be registered with register_local_exception_translator
|
|
class LocalSimpleException : public std::exception {
|
|
public:
|
|
explicit LocalSimpleException(const char * m) : message{m} {}
|
|
const char * what() const noexcept override {return message.c_str();}
|
|
private:
|
|
std::string message = "";
|
|
};
|
|
|
|
PYBIND11_MAKE_OPAQUE(LocalVec);
|
|
PYBIND11_MAKE_OPAQUE(LocalVec2);
|
|
PYBIND11_MAKE_OPAQUE(LocalMap);
|
|
PYBIND11_MAKE_OPAQUE(NonLocalVec);
|
|
//PYBIND11_MAKE_OPAQUE(NonLocalVec2); // same type as LocalVec2
|
|
PYBIND11_MAKE_OPAQUE(NonLocalMap);
|
|
PYBIND11_MAKE_OPAQUE(NonLocalMap2);
|
|
|
|
|
|
// Simple bindings (used with the above):
|
|
template <typename T, int Adjust = 0, 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; });
|
|
};
|
|
|
|
// Simulate a foreign library base class (to match the example in the docs):
|
|
namespace pets {
|
|
class Pet {
|
|
public:
|
|
Pet(std::string name) : name_(std::move(name)) {}
|
|
std::string name_;
|
|
const std::string &name() const { return name_; }
|
|
};
|
|
} // namespace pets
|
|
|
|
struct MixGL { int i; MixGL(int i) : i{i} {} };
|
|
struct MixGL2 { int i; MixGL2(int i) : i{i} {} };
|