mirror of
https://github.com/pybind/pybind11.git
synced 2026-05-12 09:17:42 +00:00
* Adding test_unique_ptr_member (for desired PyCLIF behavior). See also: https://github.com/pybind/pybind11/issues/2583 Does not build with upstream master or https://github.com/pybind/pybind11/pull/2047, but builds with https://github.com/RobotLocomotion/pybind11 and almost runs: ``` Running tests in directory "/usr/local/google/home/rwgk/forked/EricCousineau-TRI/pybind11/tests": ================================================================================= test session starts ================================================================================= platform linux -- Python 3.8.5, pytest-5.4.3, py-1.9.0, pluggy-0.13.1 rootdir: /usr/local/google/home/rwgk/forked/EricCousineau-TRI/pybind11/tests, inifile: pytest.ini collected 2 items test_unique_ptr_member.py .F [100%] ====================================================================================== FAILURES ======================================================================================= _____________________________________________________________________________ test_pointee_and_ptr_owner ______________________________________________________________________________ def test_pointee_and_ptr_owner(): obj = m.pointee() assert obj.get_int() == 213 m.ptr_owner(obj) with pytest.raises(ValueError) as exc_info: > obj.get_int() E Failed: DID NOT RAISE <class 'ValueError'> test_unique_ptr_member.py:17: Failed ============================================================================= 1 failed, 1 passed in 0.06s ============================================================================= ``` * unique_ptr or shared_ptr return * new test_variant_unique_shared with vptr_holder prototype * moving prototype code to pybind11/vptr_holder.h, adding type_caster specialization to make the bindings involving unique_ptr passing compile, but load and cast implementations are missing * disabling GitHub Actions on pull_request (for this PR) * disabling AppVeyor (for this PR) * TRIGGER_SEGSEV macro, annotations for GET_STACK (vptr::get), GET_INT_STACK (pointee) * adding test_promotion_of_disowned_to_shared * Copying tests as-is from xxx_value_ptr_xxx_holder branch. https://github.com/rwgk/pybind11/tree/xxx_value_ptr_xxx_holder Systematically exercising returning and passing unique_ptr<T>, shared_ptr<T> with unique_ptr, shared_ptr holder. Observations: test_holder_unique_ptr: make_unique_pointee OK pass_unique_pointee BUILD_FAIL (as documented) make_shared_pointee Abort free(): double free detected pass_shared_pointee RuntimeError: Unable to load a custom holder type from a default-holder instance test_holder_shared_ptr: make_unique_pointee Segmentation fault (#1138) pass_unique_pointee BUILD_FAIL (as documented) make_shared_pointee OK pass_shared_pointee OK * Copying tests as-is from xxx_value_ptr_xxx_holder branch. https://github.com/rwgk/pybind11/tree/xxx_value_ptr_xxx_holder Systematically exercising casting between shared_ptr<base>, shared_ptr<derived>. * Demonstration of Undefined Behavior in handling of shared_ptr holder. Based on https://godbolt.org/z/4fdjaW by jorgbrown@ (thanks Jorg!). * Additional demonstration of Undefined Behavior in handling of shared_ptr holder. * fixing up-down mixup in comment * Demonstration of Undefined Behavior in handling of polymorphic pointers. (This demo does NOT involve smart pointers at all, unlike the otherwise similar test_smart_ptr_private_first_base.) * minor test_private_first_base.cpp simplification (after discovering that this can be wrapped with Boost.Python, using boost::noncopyable) * pybind11 equivalent of Boost.Python test similar to reproducer under #1333 * Snapshot of WIP, TODO: shared_ptr deleter with on/off switch * Adding vptr_deleter. * Adding from/as unique_ptr<T> and unique_ptr<T, D>. * Adding from_shared_ptr. Some polishing. * New tests/core/smart_holder_poc_test.cpp, using Catch2. * Adding in vptr_deleter_guard_flag. * Improved labeling of TEST_CASEs. * Shuffling existing TEST_CASEs into systematic matrix. * Implementing all [S]uccess tests. * Implementing all [E]xception tests. * Testing of exceptions not covered by the from-as matrix. * Adding top-level comment. * Converting from methods to factory functions (no functional change). * Removing obsolete and very incomplete test (replaced by Catch2-based test). * Removing stray file. * Adding type_caster_bare_interface_demo. * Adding shared_ptr<mpty>, shared_ptr<mpty const> casters. * Adding unique_ptr<mpty>, unique_ptr<mpty const> casters. * Pure copy of `class class_` implementation in pybind11.h (master commit98f1bbb800). * classh.h: renaming of class_ to classh + namespace; forking test_classh_wip from test_type_caster_bare_interface_demo. * Hard-coding smart_holder into classh. * Adding mpty::mtxt string member. * Adding isinstance<mpty> in type_caster::load functions. * Adding rvalue_ref, renaming const_value_ref to lvalue_ref & removing const. * Retrieving smart_holder pointer in type_caster<mpty>::load, and using it cast_op operators. * Factoring out smart_holder_type_caster_load. * Retrieving smart_holder pointer in type_caster<std::shared_ptr<mpty[ const]>>::load, and using it cast_op operators. * Improved error messaging: Cannot disown nullptr (as_unique_ptr). * Retrieving smart_holder pointer in type_caster<std::unique_ptr<mpty[ const]>>::load, and using it cast_op operators. * Pure `clang-format --style=file -i` change. * Pure `clang-format --style=file -i` change, with two `clang-format off` directives. * Fixing oversight (discovered by flake8). * flake8 cleanup * Systematically setting mtxt for all rtrn_mpty_* functions (preparation, the values are not actually used yet). * static cast handle for rtrn_cptr works by simply dropping in code from type_caster_base (marked with comments). * static cast handle for rtrn_cref works by simply dropping in code from type_caster_base (marked with comments). rtrn_mref and rtrn_mptr work via const_cast (to add const). * static cast handle for rtrn_valu works by simply dropping in code from type_caster_base (marked with comments). rtrn_rref raises a RuntimeError, to be investigated. * Copying type_caster_generic::cast into type_caster<mpty> as-is (preparation for handling smart pointers). * Pure clang-format change (applied to original type_caster_generic::cast). * Adding comment re potential use_count data race. * static handle cast implementations for rtrn_shmp, rtrn_shcp. * Adding MISSING comments in operator std::unique_ptr<mpty[ const]>. * static handle cast implementations for rtrn_uqmp, rtrn_uqcp. * Bug fix: vptr_deleter_armed_flag_ptr has to live on the heap. See new bullet point in comment section near the top. The variable was also renamed to reflect its function more accurately. * Fixing bugs discovered by ASAN. The code is now ASAN, MSAN, UBSAN clean. * Making test_type_caster_bare_interface_demo.cpp slightly more realistic, ASAN, MSAN, UBSAN clean. * Calling deregister_instance after disowning via unique_ptr. * Removing enable_shared_from_this stub, simplifying existing code, clang-format. Open question, with respect to the original code:76a160070b/include/pybind11/pybind11.h (L1510)To me it looks like the exact situation marked as `std::shared_ptr<Good> gp1 = not_so_good.getptr();` here: https://en.cppreference.com/w/cpp/memory/enable_shared_from_this The comment there is: `// undefined behavior (until C++17) and std::bad_weak_ptr thrown (since C++17)` Does the existing code have UB pre C++17? I'll leave handling of enable_shared_from_this for later, as the need arises. * Cosmetical change around helper functions. * Using type_caster_base<mpty>::src_and_type directly, removing copy. Also renaming one cast to cast_const_raw_ptr, for clarity. * Fixing clang-format oversight. * Using factored-out make_constructor (PR #2798), removing duplicate code. * Inserting additional assert to ensure a returned unique_ptr is always a new Python instance. * Adding minor comment (change to internals needed to distinguish uninitialized/disowned in error message). * Factoring out find_existing_python_instance(). * Moving factored-out make_constructor to test_classh_wip.cpp, restoring previous version of cast.h. This is currently the most practical approach. See PR #2798 for background. * Copying classh type_casters from test_classh_wip.cpp UNMODIFIED, as a baseline for generalizing the code. * Using pybind11/detail/classh_type_casters.h from test_classh_wip.cpp. * Adding & using PYBIND11_CLASSH_TYPE_CASTERS define. * Adding test_classh_inheritance, currently failing (passes with class_). * Removing .clang-format before git rebase master (where the file was added). * Bringing back .clang-format, the previous rm was a bad idea. * Folding in modified_type_caster_generic_load_impl, just enough to pass test_class_wip. test_classh_inheritance is still failing, but with a different error: [RuntimeError: Incompatible type (as_raw_ptr_unowned).] * Minimal changes needed to pass test_classh_inheritance. * First pass adjusting try_implicit_casts and try_load_foreign_module_local to capture loaded_v_h, but untested and guarded with pybind11_failure("Untested"). This was done mainly to determine general feasibility. Note the TODO in pybind11.h, where type_caster_generic::local_load is currently hard-coded. test_classh_wip and test_classh_inheritance still pass, as before. * Decoupling generic_type from type_caster_generic. * Changes and tests covering classh_type_casters try_implicit_casts. * Minimal test covering classh_type_casters load_impl Case 2b. * Removing stray isinstance<T>(src): it interferes with the py::module_local feature. Adding missing #includes. * Tests for classh py::module_local() feature. * Pure renaming of function names in test_classh_inheritance, similar to the systematic approach used in test_class_wip. NO functional changes. * Pure renaming of function and variable names, for better generalization when convoluting with inheritance. NO functional changes. * Adopting systematic naming scheme from test_classh_wip. NO functional changes. * Moving const after type name, for functions that cover a systematic scheme. NO functional changes. * Adding smart_holder_type_caster_load::loaded_as_shared_ptr, currently bypassing smart_holder shared_ptr tracking completely, but the tests pass and are sanitizer clean. * Removing rtti_held from smart_holder. See updated comment. * Cleaning up loaded_as_raw_ptr_unowned, loaded_as_shared_ptr. * Factoring out convert_type and folding into loaded_as_unique_ptr. * Folding convert_type into lvalue_ref and rvalue_ref paths. Some smart_holder_type_caster_load cleanup. * Using unique_ptr in local_load to replace static variable. Also adding local_load_safety_guard. * Converting test_unique_ptr_member to using classh: fully working, ASAN, MSAN, UBSAN clean. * Removing debugging comments (GET_STACK, GET_INT_STACK). cast.h is identical to current master again, pybind11.h only has the generic_type::initialize(..., &type_caster_generic::local_load) change. * Purging obsolete pybind11/vptr_holder.h and associated test. * Moving several tests to github.com/rwgk/rwgk_tbx/tree/main/pybind11_testsa2c2f88174These tests are from experimenting, and for demonstrating UB in pybind11 multiple inheritance handling ("first_base"), to be fixed later. * Adding py::smart_holder support to py::class_, purging py::classh completely. * Renaming files in include directory, creating pybind11/smart_holder.h. * Renaming all "classh" to "smart_holder" in pybind11/detail/smart_holder_type_casters.h. The user-facing macro is now PYBIND11_SMART_HOLDER_TYPE_CASTERS. * Systematically renaming tests to use "class_sh" in the name. * Renaming test_type_caster_bare_interface_demo to test_type_caster_bare_interface. * Renaming new tests/core subdirectory to tests/pure_cpp. * Adding new tests to CMake config, resetting CI config. * Changing CMake file so that test_class_sh_module_local.py actually runs. * clang-tidy fixes. * 32-bit compatibility. * Reusing type_caster_base make_copy_constructor, make_move_constructor with a trick. * CMake COMPARE NATURAL is not available with older versions. * Adding copyright notices to new header files. * Explicitly define copy/move constructors/assignments. * Adding new header files to tests/extra_python_package/test_files.py. * Adding tests/pure_cpp/CMakeLists.txt. * Making use of the new find_existing_python_instance() function factored out with PR #2822. * Moving define PYBIND11_SMART_HOLDER_TYPE_CASTERS(T) down in the file. NO functional changes. Preparation for follow-up work (to keep that diff smaller). * Reintroducing py::classh, this time as a simple alias for py::class_<U, py::smart_holder>. * Replacing detail::is_smart_holder<H> in cast.h with detail::is_smart_holder_type_caster<T>. Moving get_local_load_function_ptr, init_instance_for_type to smart_holder_type_caster_class_hooks. Expanding static_assert in py::type::handle_of<> to accommodate smart_holder_type_casters. * Fixing oversight. * Adding classu alias for class_<U, std::unique_ptr<U>>. * Giving up on idea to use legacy init_instance only if is_base_of<type_caster_generic, type_caster<T>. There are use cases in the wild that define both a custom type_caster and class_. * Removing test_type_caster_bare_interface, which was moved to the separate PR #2834. * Moving up is_smart_holder_type_caster, to also use in cast_is_temporary_value_reference. * Adding smart_holder_type_casters for unique_ptr with custom deleter. SEVERE CODE DUPLICATION. This commit is to establish a baseline for consolidating the unique_ptr code. * Unification of unique_ptr, unique_ptr_with_deleter code in smart_holder_poc.h. Leads to more fitting error messages. Enables use of unique_ptr<T, D> smart_holder_type_casters also for unique_ptr<T>. * Copying files as-is from branch test_unique_ptr_member (PR #2672). * Adding comment, simplifying naming, cmake addition. * Introducing PYBIND11_USE_SMART_HOLDER_AS_DEFAULT macro (tested only undefined; there are many errors with the macro defined). * Removing test_type_caster_bare_interface, which was moved to the separate PR #2834. * Fixing oversight introduced with commit 95425f13d6c14fcb6ee479b62b602dc8a605ec49. * Setting record.default_holder correctly for PYBIND11_USE_SMART_HOLDER_AS_DEFAULT. With this test_class.cpp builds and even mostly runs, except `test_multiple_instances_with_same_pointer`, which segfaults because it is using a `unique_ptr` holder but `smart_holder` `type_caster`. Also adding `static_assert`s to generate build errors for such situations, but guarding with `#if 0` to first pivot to test_factory_constructors.cpp. * Fixing up cast.h and smart_holder.h after rebase. * Removing detail/smart_holder_type_casters.h in separate commit. * Commenting out const in def_buffer(... const). With this, test_buffers builds and runs with PYBIND11_USE_SMART_HOLDER_AS_DEFAULT. Explanation why the const needs to be removed, or fix elsewhere, is still needed, but left for later. * Adding test_class_sh_factory_constructors, reproducing test_factory_constructors failure. Using py::class_ in this commit, to be changed to py::classh for debugging. * Removing include/pybind11/detail/smart_holder_type_casters.h from CMakeLists.txt, test_files.py (since it does not exist in this branch). * Adding // DANGER ZONE reminders. * Converting as many py::class_ to py::classh as possible, not breaking tests. * Adding initimpl::construct() overloads, resulting in test_class_sh_factory_constructors feature parity for py::class_ and py::classh. * Adding enable_if !is_smart_holder_type_caster to existing initimpl::construct(). With this test_factory_constructors.cpp builds with PYBIND11_USE_SMART_HOLDER_AS_DEFAULT. * Disabling shared_ptr&, shared_ptr* tests when building with PYBIND11_USE_SMART_HOLDER_AS_DEFAULT for now, pending work on smart_holder_type_caster<shared_ptr>. * Factoring out struct and class definitions into anonymous namespace. Preparation for building with PYBIND11_USE_SMART_HOLDER_AS_DEFAULT. * Simplifying from_unique_ptr(): typename D = std::default_delete<T> is not needed. Factoring out is_std_default_delete<T>() for consistentcy between ensure_compatible_rtti_uqp_del() and from_unique_ptr(). * Introducing PYBIND11_SMART_POINTER_HOLDER_TYPE_CASTERS. Using it in test_smart_ptr.cpp. With this test_smart_ptr builds with PYBIND11_USE_SMART_HOLDER_AS_DEFAULT and all but one test run successfully. * Introducing 1. type_caster_for_class_, used in PYBIND11_MAKE_OPAQUE, and 2. default_holder_type, used in stl_bind.h. * Using __VA_ARGS__ in PYBIND11_SMART_POINTER_HOLDER_TYPE_CASTERS. * Replacing condense_for_macro with much simpler approach. * Softening static_assert, to only check specifically that smart_holder is not mixed with type_caster_base, and unique_ptr/shared_ptr holders are not mixed with smart_holder_type_casters. * Adding PYBIND11_SMART_POINTER_HOLDER_TYPE_CASTERS in test_class.cpp (with this all but one test succeed with PYBIND11_USE_SMART_HOLDER_AS_DEFAULT). * Adding remaining PYBIND11_SMART_POINTER_HOLDER_TYPE_CASTERS. static_assert for "necessary conditions" for both types of default holder, static_assert for "strict conditions" guarded by new PYBIND11_STRICT_ASSERTS_CLASS_HOLDER_VS_TYPE_CASTER_MIX. All tests build & run as before with unique_ptr as the default holder, all tests build for smart_holder as the default holder, even with the strict static_assert. * Introducing check_is_smart_holder_type_caster() function for runtime check, and reinterpreting record.default_holder as "uses_unique_ptr_holder". With this test_smart_ptr succeeds. (All 42 tests build, 35 tests succeed, 5 run but have some failures, 2 segfault.) * Bug fix: Adding have_value() to smart_holder_type_caster_load. With this test_builtin_casters succeeds. (All 42 tests build, 36 tests succeed, 5 run but have some failures, 1 segfault.) * Adding unowned_void_ptr_from_direct_conversion to modified_type_caster_generic_load_impl. This fixes the last remaining segfault (test_numpy_dtypes). New stats for all tests combined: 12 failed, 458 passed. * Adding "Lazy allocation for unallocated values" (for old-style __init__) into load_value_and_holder. Deferring destruction of disowned holder until clear_instance, to remain inspectable for "uninitialized" or "disowned" detection. New stats for all tests combined: 5 failed, 465 passed. * Changing std::shared_ptr pointer/reference to const pointer/reference. New stats for all tests combined: 4 failed, 466 passed. * Adding return_value_policy::move to permissible policies for unique_ptr returns. New stats for all tests combined: 3 failed, 467 passed. * Overlooked flake8 fixes. * Manipulating failing ConstructorStats test to pass, to be able to run all tests with ASAN. This version of the code is ASAN clean with unique_ptr or smart_holder as the default. This change needs to be reverted after adopting the existing move-only-if-refcount-is-1 logic used by type_caster_base. * Adding copy constructor and move constructor tracking to atyp. Preparation for a follow-up change in smart_holder_type_caster, to make this test sensitive to the changing behavior. [skip ci] * Removing `operator T&&() &&` from smart_holder_type_caster, for compatibility with the behavior of type_caster_base. Enables reverting 2 of 3 test manipulations applied under commit249df7cbdb. The manipulation in test_factory_constructors.py is NOT reverted in this commit. [skip ci] * Fixing unfortunate editing mishap. This reverts the last remaining test manipulation in commit249df7cbdband makes all existing unit tests pass with smart_holder as default holder. * GitHub CI clang-tidy fixes. * Adding messages to terse `static_assert`s, for pre-C++17 compatibility. * Using @pytest.mark.parametrize to run each assert separately (to see all errors, not just the first). * Systematically removing _atyp from function names, to make the test code simpler. * Using re.match to accommodate variable number of intermediate MvCtor. * Also removing `operator T()` from smart_holder_type_caster, to fix gcc compilation errors. The only loss is pass_rref in test_class_sh_basic. * Systematically replacing `detail::enable_if_t<...smart_holder...>` with `typename std::enable_if<...smart_holder...>::type`. Attempt to work around MSVC 2015 issues, to be tested via GitHub CI. The idea for this change originates from this comment: https://github.com/pybind/pybind11/issues/1616#issuecomment-444536813 * Importing re before pytest after observing a PyPy CI flake when importing pytest first. * Copying MSVC 2015 compatibility change from branch pr2672_use_smart_holder_as_default. * Introducing is_smart_holder_type_caster_base_tag, to keep smart_holder code more disconnected. * Working around MSVC 2015 bug. * Expanding comment for MSVC 2015 workaround. * Systematically changing std::enable_if back to detail::enable_if_t, effectively reverting commit5d4b6890a3. * Removing unused smart_holder_type_caster_load::loaded_as_rvalue_ref (it was an oversight that it was not removed with commit23036a45eb). * Removing py::classu, because it does not seem useful enough. * Reverting commit6349531306by un-commenting `const` in `def_buffer(...)`. To make this possible, `operator T const&` and `operator T const*` in `smart_holder_type_caster` need to be marked as `const` member functions. * Adding construct() overloads for constructing smart_holder from alias unique_ptr, shared_ptr returns. * Adding test_class_sh_factory_constructors.cpp to tests/CMakeLists.txt (fixes oversight, this should have been added long before). * Compatibility with old clang versions (clang 3.6, 3.7 C++11). * Cleaning up changes to existing unit tests. * Systematically adding SMART_HOLDER_WIP tag. Removing minor UNTESTED tags (only the throw are not actually exercised, investing time there has a high cost but very little benefit). * Splitting out smart_holder_type_casters again, into new detail/smart_holder_type_casters_inline_include.h. * Splitting out smart_holder_init_inline_include.h. * Adding additional new include files to CMakeLists.txt, tests/extra_python_package/test_files.py. * clang-format cleanup of most smart_holder code. * Adding source code comments in response to review. * Simple micro-benchmark ("ubench") comparing runtime performance for several holders. Tested using github.com/rwgk/pybind11_scons and Google-internal build system. Sorry, no cmake support at the moment. First results: https://docs.google.com/spreadsheets/d/1InapCYws2Gt-stmFf_Bwl33eOMo3aLE_gc9adveY7RU/edit#gid=0 * Breaking out number_bucket.h, adding hook for also collecting performance data for PyCLIF. * Accounting for ubench in MANIFEST.in (simply prune, for now). * Smarter determination of call_repetitions. [skip ci] * Also scaling performance data to PyCLIF. [skip ci] * Adding ubench/python/number_bucket.clif here for general visibility. * Fix after rebase * Merging detail/smart_holder_init_inline_include.h into detail/init.h. * Renaming detail/is_smart_holder_type_caster.h -> detail/smart_holder_sfinae_hooks_only.h. * Renaming is_smart_holder_type_caster -> type_uses_smart_holder_type_caster for clarity. * Renaming type_caster_type_is_smart_holder_type_caster -> wrapped_type_uses_smart_holder_type_caster for clarity. * Renaming is_smart_holder_type_caster_base_tag -> smart_holder_type_caster_base_tag for simplicity. * Adding copyright notices and minor colateral cleanup. * iwyu cleanup (comprehensive only for cast.h and smart_holder*.h files). * Fixing `git rebase master` accident. * Moving large `pragma warning` block from pybind11.h to detail/common.h. * Fixing another `git rebase master` accident.
1411 lines
57 KiB
C++
1411 lines
57 KiB
C++
// clang-format off
|
|
/*
|
|
pybind11/cast.h: Partial template specializations to cast between
|
|
C++ and Python types
|
|
|
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch>
|
|
|
|
All rights reserved. Use of this source code is governed by a
|
|
BSD-style license that can be found in the LICENSE file.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "pytypes.h"
|
|
#include "detail/common.h"
|
|
#include "detail/descr.h"
|
|
#include "detail/smart_holder_sfinae_hooks_only.h"
|
|
#include "detail/type_caster_base.h"
|
|
#include "detail/typeid.h"
|
|
#include <array>
|
|
#include <cstring>
|
|
#include <functional>
|
|
#include <iosfwd>
|
|
#include <iterator>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <tuple>
|
|
#include <type_traits>
|
|
#include <utility>
|
|
#include <vector>
|
|
|
|
#ifdef PYBIND11_USE_SMART_HOLDER_AS_DEFAULT
|
|
#include "detail/smart_holder_type_casters.h"
|
|
#endif
|
|
|
|
#if defined(PYBIND11_CPP17)
|
|
# if defined(__has_include)
|
|
# if __has_include(<string_view>)
|
|
# define PYBIND11_HAS_STRING_VIEW
|
|
# endif
|
|
# elif defined(_MSC_VER)
|
|
# define PYBIND11_HAS_STRING_VIEW
|
|
# endif
|
|
#endif
|
|
#ifdef PYBIND11_HAS_STRING_VIEW
|
|
#include <string_view>
|
|
#endif
|
|
|
|
#if defined(__cpp_lib_char8_t) && __cpp_lib_char8_t >= 201811L
|
|
# define PYBIND11_HAS_U8STRING
|
|
#endif
|
|
|
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE)
|
|
PYBIND11_NAMESPACE_BEGIN(detail)
|
|
|
|
// clang-format on
|
|
#ifndef PYBIND11_USE_SMART_HOLDER_AS_DEFAULT
|
|
template <typename T>
|
|
class type_caster_for_class_ : public type_caster_base<T> {};
|
|
#endif
|
|
|
|
template <typename type, typename SFINAE = void>
|
|
class type_caster : public type_caster_for_class_<type> {};
|
|
|
|
template <typename type>
|
|
using make_caster = type_caster<intrinsic_t<type>>;
|
|
|
|
template <typename T>
|
|
struct type_uses_smart_holder_type_caster {
|
|
static constexpr bool value
|
|
= std::is_base_of<smart_holder_type_caster_base_tag, make_caster<T>>::value;
|
|
};
|
|
// clang-format off
|
|
|
|
// Shortcut for calling a caster's `cast_op_type` cast operator for casting a type_caster to a T
|
|
template <typename T> typename make_caster<T>::template cast_op_type<T> cast_op(make_caster<T> &caster) {
|
|
return caster.operator typename make_caster<T>::template cast_op_type<T>();
|
|
}
|
|
template <typename T> typename make_caster<T>::template cast_op_type<typename std::add_rvalue_reference<T>::type>
|
|
cast_op(make_caster<T> &&caster) {
|
|
return std::move(caster).operator
|
|
typename make_caster<T>::template cast_op_type<typename std::add_rvalue_reference<T>::type>();
|
|
}
|
|
|
|
template <typename type> class type_caster<std::reference_wrapper<type>> {
|
|
private:
|
|
using caster_t = make_caster<type>;
|
|
caster_t subcaster;
|
|
using reference_t = type&;
|
|
using subcaster_cast_op_type =
|
|
typename caster_t::template cast_op_type<reference_t>;
|
|
|
|
static_assert(std::is_same<typename std::remove_const<type>::type &, subcaster_cast_op_type>::value ||
|
|
std::is_same<reference_t, subcaster_cast_op_type>::value,
|
|
"std::reference_wrapper<T> caster requires T to have a caster with an "
|
|
"`operator T &()` or `operator const T &()`");
|
|
public:
|
|
bool load(handle src, bool convert) { return subcaster.load(src, convert); }
|
|
static constexpr auto name = caster_t::name;
|
|
static handle cast(const std::reference_wrapper<type> &src, return_value_policy policy, handle parent) {
|
|
// It is definitely wrong to take ownership of this pointer, so mask that rvp
|
|
if (policy == return_value_policy::take_ownership || policy == return_value_policy::automatic)
|
|
policy = return_value_policy::automatic_reference;
|
|
return caster_t::cast(&src.get(), policy, parent);
|
|
}
|
|
template <typename T> using cast_op_type = std::reference_wrapper<type>;
|
|
operator std::reference_wrapper<type>() { return cast_op<type &>(subcaster); }
|
|
};
|
|
|
|
#define PYBIND11_TYPE_CASTER(type, py_name) \
|
|
protected: \
|
|
type value; \
|
|
public: \
|
|
static constexpr auto name = py_name; \
|
|
template <typename T_, enable_if_t<std::is_same<type, remove_cv_t<T_>>::value, int> = 0> \
|
|
static handle cast(T_ *src, return_value_policy policy, handle parent) { \
|
|
if (!src) return none().release(); \
|
|
if (policy == return_value_policy::take_ownership) { \
|
|
auto h = cast(std::move(*src), policy, parent); delete src; return h; \
|
|
} else { \
|
|
return cast(*src, policy, parent); \
|
|
} \
|
|
} \
|
|
operator type*() { return &value; } \
|
|
operator type&() { return value; } \
|
|
operator type&&() && { return std::move(value); } \
|
|
template <typename T_> using cast_op_type = pybind11::detail::movable_cast_op_type<T_>
|
|
|
|
|
|
template <typename CharT> using is_std_char_type = any_of<
|
|
std::is_same<CharT, char>, /* std::string */
|
|
#if defined(PYBIND11_HAS_U8STRING)
|
|
std::is_same<CharT, char8_t>, /* std::u8string */
|
|
#endif
|
|
std::is_same<CharT, char16_t>, /* std::u16string */
|
|
std::is_same<CharT, char32_t>, /* std::u32string */
|
|
std::is_same<CharT, wchar_t> /* std::wstring */
|
|
>;
|
|
|
|
|
|
template <typename T>
|
|
struct type_caster<T, enable_if_t<std::is_arithmetic<T>::value && !is_std_char_type<T>::value>> {
|
|
using _py_type_0 = conditional_t<sizeof(T) <= sizeof(long), long, long long>;
|
|
using _py_type_1 = conditional_t<std::is_signed<T>::value, _py_type_0, typename std::make_unsigned<_py_type_0>::type>;
|
|
using py_type = conditional_t<std::is_floating_point<T>::value, double, _py_type_1>;
|
|
public:
|
|
|
|
bool load(handle src, bool convert) {
|
|
py_type py_value;
|
|
|
|
if (!src)
|
|
return false;
|
|
|
|
#if !defined(PYPY_VERSION)
|
|
auto index_check = [](PyObject *o) { return PyIndex_Check(o); };
|
|
#else
|
|
// In PyPy 7.3.3, `PyIndex_Check` is implemented by calling `__index__`,
|
|
// while CPython only considers the existence of `nb_index`/`__index__`.
|
|
auto index_check = [](PyObject *o) { return hasattr(o, "__index__"); };
|
|
#endif
|
|
|
|
if (std::is_floating_point<T>::value) {
|
|
if (convert || PyFloat_Check(src.ptr()))
|
|
py_value = (py_type) PyFloat_AsDouble(src.ptr());
|
|
else
|
|
return false;
|
|
} else if (PyFloat_Check(src.ptr())) {
|
|
return false;
|
|
} else if (!convert && !PYBIND11_LONG_CHECK(src.ptr()) && !index_check(src.ptr())) {
|
|
return false;
|
|
} else {
|
|
handle src_or_index = src;
|
|
#if PY_VERSION_HEX < 0x03080000
|
|
object index;
|
|
if (!PYBIND11_LONG_CHECK(src.ptr())) { // So: index_check(src.ptr())
|
|
index = reinterpret_steal<object>(PyNumber_Index(src.ptr()));
|
|
if (!index) {
|
|
PyErr_Clear();
|
|
if (!convert)
|
|
return false;
|
|
}
|
|
else {
|
|
src_or_index = index;
|
|
}
|
|
}
|
|
#endif
|
|
if (std::is_unsigned<py_type>::value) {
|
|
py_value = as_unsigned<py_type>(src_or_index.ptr());
|
|
} else { // signed integer:
|
|
py_value = sizeof(T) <= sizeof(long)
|
|
? (py_type) PyLong_AsLong(src_or_index.ptr())
|
|
: (py_type) PYBIND11_LONG_AS_LONGLONG(src_or_index.ptr());
|
|
}
|
|
}
|
|
|
|
// Python API reported an error
|
|
bool py_err = py_value == (py_type) -1 && PyErr_Occurred();
|
|
|
|
// Check to see if the conversion is valid (integers should match exactly)
|
|
// Signed/unsigned checks happen elsewhere
|
|
if (py_err || (std::is_integral<T>::value && sizeof(py_type) != sizeof(T) && py_value != (py_type) (T) py_value)) {
|
|
PyErr_Clear();
|
|
if (py_err && convert && PyNumber_Check(src.ptr())) {
|
|
auto tmp = reinterpret_steal<object>(std::is_floating_point<T>::value
|
|
? PyNumber_Float(src.ptr())
|
|
: PyNumber_Long(src.ptr()));
|
|
PyErr_Clear();
|
|
return load(tmp, false);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
value = (T) py_value;
|
|
return true;
|
|
}
|
|
|
|
template<typename U = T>
|
|
static typename std::enable_if<std::is_floating_point<U>::value, handle>::type
|
|
cast(U src, return_value_policy /* policy */, handle /* parent */) {
|
|
return PyFloat_FromDouble((double) src);
|
|
}
|
|
|
|
template<typename U = T>
|
|
static typename std::enable_if<!std::is_floating_point<U>::value && std::is_signed<U>::value && (sizeof(U) <= sizeof(long)), handle>::type
|
|
cast(U src, return_value_policy /* policy */, handle /* parent */) {
|
|
return PYBIND11_LONG_FROM_SIGNED((long) src);
|
|
}
|
|
|
|
template<typename U = T>
|
|
static typename std::enable_if<!std::is_floating_point<U>::value && std::is_unsigned<U>::value && (sizeof(U) <= sizeof(unsigned long)), handle>::type
|
|
cast(U src, return_value_policy /* policy */, handle /* parent */) {
|
|
return PYBIND11_LONG_FROM_UNSIGNED((unsigned long) src);
|
|
}
|
|
|
|
template<typename U = T>
|
|
static typename std::enable_if<!std::is_floating_point<U>::value && std::is_signed<U>::value && (sizeof(U) > sizeof(long)), handle>::type
|
|
cast(U src, return_value_policy /* policy */, handle /* parent */) {
|
|
return PyLong_FromLongLong((long long) src);
|
|
}
|
|
|
|
template<typename U = T>
|
|
static typename std::enable_if<!std::is_floating_point<U>::value && std::is_unsigned<U>::value && (sizeof(U) > sizeof(unsigned long)), handle>::type
|
|
cast(U src, return_value_policy /* policy */, handle /* parent */) {
|
|
return PyLong_FromUnsignedLongLong((unsigned long long) src);
|
|
}
|
|
|
|
PYBIND11_TYPE_CASTER(T, _<std::is_integral<T>::value>("int", "float"));
|
|
};
|
|
|
|
template<typename T> struct void_caster {
|
|
public:
|
|
bool load(handle src, bool) {
|
|
if (src && src.is_none())
|
|
return true;
|
|
return false;
|
|
}
|
|
static handle cast(T, return_value_policy /* policy */, handle /* parent */) {
|
|
return none().inc_ref();
|
|
}
|
|
PYBIND11_TYPE_CASTER(T, _("None"));
|
|
};
|
|
|
|
template <> class type_caster<void_type> : public void_caster<void_type> {};
|
|
|
|
template <> class type_caster<void> : public type_caster<void_type> {
|
|
public:
|
|
using type_caster<void_type>::cast;
|
|
|
|
bool load(handle h, bool) {
|
|
if (!h) {
|
|
return false;
|
|
} else if (h.is_none()) {
|
|
value = nullptr;
|
|
return true;
|
|
}
|
|
|
|
/* Check if this is a capsule */
|
|
if (isinstance<capsule>(h)) {
|
|
value = reinterpret_borrow<capsule>(h);
|
|
return true;
|
|
}
|
|
|
|
/* Check if this is a C++ type */
|
|
auto &bases = all_type_info((PyTypeObject *) type::handle_of(h).ptr());
|
|
if (bases.size() == 1) { // Only allowing loading from a single-value type
|
|
value = values_and_holders(reinterpret_cast<instance *>(h.ptr())).begin()->value_ptr();
|
|
return true;
|
|
}
|
|
|
|
/* Fail */
|
|
return false;
|
|
}
|
|
|
|
static handle cast(const void *ptr, return_value_policy /* policy */, handle /* parent */) {
|
|
if (ptr)
|
|
return capsule(ptr).release();
|
|
else
|
|
return none().inc_ref();
|
|
}
|
|
|
|
template <typename T> using cast_op_type = void*&;
|
|
operator void *&() { return value; }
|
|
static constexpr auto name = _("capsule");
|
|
private:
|
|
void *value = nullptr;
|
|
};
|
|
|
|
template <> class type_caster<std::nullptr_t> : public void_caster<std::nullptr_t> { };
|
|
|
|
template <> class type_caster<bool> {
|
|
public:
|
|
bool load(handle src, bool convert) {
|
|
if (!src) return false;
|
|
else if (src.ptr() == Py_True) { value = true; return true; }
|
|
else if (src.ptr() == Py_False) { value = false; return true; }
|
|
else if (convert || !std::strcmp("numpy.bool_", Py_TYPE(src.ptr())->tp_name)) {
|
|
// (allow non-implicit conversion for numpy booleans)
|
|
|
|
Py_ssize_t res = -1;
|
|
if (src.is_none()) {
|
|
res = 0; // None is implicitly converted to False
|
|
}
|
|
#if defined(PYPY_VERSION)
|
|
// On PyPy, check that "__bool__" (or "__nonzero__" on Python 2.7) attr exists
|
|
else if (hasattr(src, PYBIND11_BOOL_ATTR)) {
|
|
res = PyObject_IsTrue(src.ptr());
|
|
}
|
|
#else
|
|
// Alternate approach for CPython: this does the same as the above, but optimized
|
|
// using the CPython API so as to avoid an unneeded attribute lookup.
|
|
else if (auto tp_as_number = src.ptr()->ob_type->tp_as_number) {
|
|
if (PYBIND11_NB_BOOL(tp_as_number)) {
|
|
res = (*PYBIND11_NB_BOOL(tp_as_number))(src.ptr());
|
|
}
|
|
}
|
|
#endif
|
|
if (res == 0 || res == 1) {
|
|
value = (bool) res;
|
|
return true;
|
|
} else {
|
|
PyErr_Clear();
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
static handle cast(bool src, return_value_policy /* policy */, handle /* parent */) {
|
|
return handle(src ? Py_True : Py_False).inc_ref();
|
|
}
|
|
PYBIND11_TYPE_CASTER(bool, _("bool"));
|
|
};
|
|
|
|
// Helper class for UTF-{8,16,32} C++ stl strings:
|
|
template <typename StringType, bool IsView = false> struct string_caster {
|
|
using CharT = typename StringType::value_type;
|
|
|
|
// Simplify life by being able to assume standard char sizes (the standard only guarantees
|
|
// minimums, but Python requires exact sizes)
|
|
static_assert(!std::is_same<CharT, char>::value || sizeof(CharT) == 1, "Unsupported char size != 1");
|
|
#if defined(PYBIND11_HAS_U8STRING)
|
|
static_assert(!std::is_same<CharT, char8_t>::value || sizeof(CharT) == 1, "Unsupported char8_t size != 1");
|
|
#endif
|
|
static_assert(!std::is_same<CharT, char16_t>::value || sizeof(CharT) == 2, "Unsupported char16_t size != 2");
|
|
static_assert(!std::is_same<CharT, char32_t>::value || sizeof(CharT) == 4, "Unsupported char32_t size != 4");
|
|
// wchar_t can be either 16 bits (Windows) or 32 (everywhere else)
|
|
static_assert(!std::is_same<CharT, wchar_t>::value || sizeof(CharT) == 2 || sizeof(CharT) == 4,
|
|
"Unsupported wchar_t size != 2/4");
|
|
static constexpr size_t UTF_N = 8 * sizeof(CharT);
|
|
|
|
bool load(handle src, bool) {
|
|
#if PY_MAJOR_VERSION < 3
|
|
object temp;
|
|
#endif
|
|
handle load_src = src;
|
|
if (!src) {
|
|
return false;
|
|
} else if (!PyUnicode_Check(load_src.ptr())) {
|
|
#if PY_MAJOR_VERSION >= 3
|
|
return load_bytes(load_src);
|
|
#else
|
|
if (std::is_same<CharT, char>::value) {
|
|
return load_bytes(load_src);
|
|
}
|
|
|
|
// The below is a guaranteed failure in Python 3 when PyUnicode_Check returns false
|
|
if (!PYBIND11_BYTES_CHECK(load_src.ptr()))
|
|
return false;
|
|
|
|
temp = reinterpret_steal<object>(PyUnicode_FromObject(load_src.ptr()));
|
|
if (!temp) { PyErr_Clear(); return false; }
|
|
load_src = temp;
|
|
#endif
|
|
}
|
|
|
|
auto utfNbytes = reinterpret_steal<object>(PyUnicode_AsEncodedString(
|
|
load_src.ptr(), UTF_N == 8 ? "utf-8" : UTF_N == 16 ? "utf-16" : "utf-32", nullptr));
|
|
if (!utfNbytes) { PyErr_Clear(); return false; }
|
|
|
|
const auto *buffer = reinterpret_cast<const CharT *>(PYBIND11_BYTES_AS_STRING(utfNbytes.ptr()));
|
|
size_t length = (size_t) PYBIND11_BYTES_SIZE(utfNbytes.ptr()) / sizeof(CharT);
|
|
if (UTF_N > 8) { buffer++; length--; } // Skip BOM for UTF-16/32
|
|
value = StringType(buffer, length);
|
|
|
|
// If we're loading a string_view we need to keep the encoded Python object alive:
|
|
if (IsView)
|
|
loader_life_support::add_patient(utfNbytes);
|
|
|
|
return true;
|
|
}
|
|
|
|
static handle cast(const StringType &src, return_value_policy /* policy */, handle /* parent */) {
|
|
const char *buffer = reinterpret_cast<const char *>(src.data());
|
|
auto nbytes = ssize_t(src.size() * sizeof(CharT));
|
|
handle s = decode_utfN(buffer, nbytes);
|
|
if (!s) throw error_already_set();
|
|
return s;
|
|
}
|
|
|
|
PYBIND11_TYPE_CASTER(StringType, _(PYBIND11_STRING_NAME));
|
|
|
|
private:
|
|
static handle decode_utfN(const char *buffer, ssize_t nbytes) {
|
|
#if !defined(PYPY_VERSION)
|
|
return
|
|
UTF_N == 8 ? PyUnicode_DecodeUTF8(buffer, nbytes, nullptr) :
|
|
UTF_N == 16 ? PyUnicode_DecodeUTF16(buffer, nbytes, nullptr, nullptr) :
|
|
PyUnicode_DecodeUTF32(buffer, nbytes, nullptr, nullptr);
|
|
#else
|
|
// PyPy segfaults when on PyUnicode_DecodeUTF16 (and possibly on PyUnicode_DecodeUTF32 as well),
|
|
// so bypass the whole thing by just passing the encoding as a string value, which works properly:
|
|
return PyUnicode_Decode(buffer, nbytes, UTF_N == 8 ? "utf-8" : UTF_N == 16 ? "utf-16" : "utf-32", nullptr);
|
|
#endif
|
|
}
|
|
|
|
// When loading into a std::string or char*, accept a bytes object as-is (i.e.
|
|
// without any encoding/decoding attempt). For other C++ char sizes this is a no-op.
|
|
// which supports loading a unicode from a str, doesn't take this path.
|
|
template <typename C = CharT>
|
|
bool load_bytes(enable_if_t<std::is_same<C, char>::value, handle> src) {
|
|
if (PYBIND11_BYTES_CHECK(src.ptr())) {
|
|
// We were passed a Python 3 raw bytes; accept it into a std::string or char*
|
|
// without any encoding attempt.
|
|
const char *bytes = PYBIND11_BYTES_AS_STRING(src.ptr());
|
|
if (bytes) {
|
|
value = StringType(bytes, (size_t) PYBIND11_BYTES_SIZE(src.ptr()));
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
template <typename C = CharT>
|
|
bool load_bytes(enable_if_t<!std::is_same<C, char>::value, handle>) { return false; }
|
|
};
|
|
|
|
template <typename CharT, class Traits, class Allocator>
|
|
struct type_caster<std::basic_string<CharT, Traits, Allocator>, enable_if_t<is_std_char_type<CharT>::value>>
|
|
: string_caster<std::basic_string<CharT, Traits, Allocator>> {};
|
|
|
|
#ifdef PYBIND11_HAS_STRING_VIEW
|
|
template <typename CharT, class Traits>
|
|
struct type_caster<std::basic_string_view<CharT, Traits>, enable_if_t<is_std_char_type<CharT>::value>>
|
|
: string_caster<std::basic_string_view<CharT, Traits>, true> {};
|
|
#endif
|
|
|
|
// Type caster for C-style strings. We basically use a std::string type caster, but also add the
|
|
// ability to use None as a nullptr char* (which the string caster doesn't allow).
|
|
template <typename CharT> struct type_caster<CharT, enable_if_t<is_std_char_type<CharT>::value>> {
|
|
using StringType = std::basic_string<CharT>;
|
|
using StringCaster = type_caster<StringType>;
|
|
StringCaster str_caster;
|
|
bool none = false;
|
|
CharT one_char = 0;
|
|
public:
|
|
bool load(handle src, bool convert) {
|
|
if (!src) return false;
|
|
if (src.is_none()) {
|
|
// Defer accepting None to other overloads (if we aren't in convert mode):
|
|
if (!convert) return false;
|
|
none = true;
|
|
return true;
|
|
}
|
|
return str_caster.load(src, convert);
|
|
}
|
|
|
|
static handle cast(const CharT *src, return_value_policy policy, handle parent) {
|
|
if (src == nullptr) return pybind11::none().inc_ref();
|
|
return StringCaster::cast(StringType(src), policy, parent);
|
|
}
|
|
|
|
static handle cast(CharT src, return_value_policy policy, handle parent) {
|
|
if (std::is_same<char, CharT>::value) {
|
|
handle s = PyUnicode_DecodeLatin1((const char *) &src, 1, nullptr);
|
|
if (!s) throw error_already_set();
|
|
return s;
|
|
}
|
|
return StringCaster::cast(StringType(1, src), policy, parent);
|
|
}
|
|
|
|
operator CharT*() { return none ? nullptr : const_cast<CharT *>(static_cast<StringType &>(str_caster).c_str()); }
|
|
operator CharT&() {
|
|
if (none)
|
|
throw value_error("Cannot convert None to a character");
|
|
|
|
auto &value = static_cast<StringType &>(str_caster);
|
|
size_t str_len = value.size();
|
|
if (str_len == 0)
|
|
throw value_error("Cannot convert empty string to a character");
|
|
|
|
// If we're in UTF-8 mode, we have two possible failures: one for a unicode character that
|
|
// is too high, and one for multiple unicode characters (caught later), so we need to figure
|
|
// out how long the first encoded character is in bytes to distinguish between these two
|
|
// errors. We also allow want to allow unicode characters U+0080 through U+00FF, as those
|
|
// can fit into a single char value.
|
|
if (StringCaster::UTF_N == 8 && str_len > 1 && str_len <= 4) {
|
|
auto v0 = static_cast<unsigned char>(value[0]);
|
|
size_t char0_bytes = !(v0 & 0x80) ? 1 : // low bits only: 0-127
|
|
(v0 & 0xE0) == 0xC0 ? 2 : // 0b110xxxxx - start of 2-byte sequence
|
|
(v0 & 0xF0) == 0xE0 ? 3 : // 0b1110xxxx - start of 3-byte sequence
|
|
4; // 0b11110xxx - start of 4-byte sequence
|
|
|
|
if (char0_bytes == str_len) {
|
|
// If we have a 128-255 value, we can decode it into a single char:
|
|
if (char0_bytes == 2 && (v0 & 0xFC) == 0xC0) { // 0x110000xx 0x10xxxxxx
|
|
one_char = static_cast<CharT>(((v0 & 3) << 6) + (static_cast<unsigned char>(value[1]) & 0x3F));
|
|
return one_char;
|
|
}
|
|
// Otherwise we have a single character, but it's > U+00FF
|
|
throw value_error("Character code point not in range(0x100)");
|
|
}
|
|
}
|
|
|
|
// UTF-16 is much easier: we can only have a surrogate pair for values above U+FFFF, thus a
|
|
// surrogate pair with total length 2 instantly indicates a range error (but not a "your
|
|
// string was too long" error).
|
|
else if (StringCaster::UTF_N == 16 && str_len == 2) {
|
|
one_char = static_cast<CharT>(value[0]);
|
|
if (one_char >= 0xD800 && one_char < 0xE000)
|
|
throw value_error("Character code point not in range(0x10000)");
|
|
}
|
|
|
|
if (str_len != 1)
|
|
throw value_error("Expected a character, but multi-character string found");
|
|
|
|
one_char = value[0];
|
|
return one_char;
|
|
}
|
|
|
|
static constexpr auto name = _(PYBIND11_STRING_NAME);
|
|
template <typename _T> using cast_op_type = pybind11::detail::cast_op_type<_T>;
|
|
};
|
|
|
|
// Base implementation for std::tuple and std::pair
|
|
template <template<typename...> class Tuple, typename... Ts> class tuple_caster {
|
|
using type = Tuple<Ts...>;
|
|
static constexpr auto size = sizeof...(Ts);
|
|
using indices = make_index_sequence<size>;
|
|
public:
|
|
|
|
bool load(handle src, bool convert) {
|
|
if (!isinstance<sequence>(src))
|
|
return false;
|
|
const auto seq = reinterpret_borrow<sequence>(src);
|
|
if (seq.size() != size)
|
|
return false;
|
|
return load_impl(seq, convert, indices{});
|
|
}
|
|
|
|
template <typename T>
|
|
static handle cast(T &&src, return_value_policy policy, handle parent) {
|
|
return cast_impl(std::forward<T>(src), policy, parent, indices{});
|
|
}
|
|
|
|
// copied from the PYBIND11_TYPE_CASTER macro
|
|
template <typename T>
|
|
static handle cast(T *src, return_value_policy policy, handle parent) {
|
|
if (!src) return none().release();
|
|
if (policy == return_value_policy::take_ownership) {
|
|
auto h = cast(std::move(*src), policy, parent); delete src; return h;
|
|
} else {
|
|
return cast(*src, policy, parent);
|
|
}
|
|
}
|
|
|
|
static constexpr auto name = _("Tuple[") + concat(make_caster<Ts>::name...) + _("]");
|
|
|
|
template <typename T> using cast_op_type = type;
|
|
|
|
operator type() & { return implicit_cast(indices{}); }
|
|
operator type() && { return std::move(*this).implicit_cast(indices{}); }
|
|
|
|
protected:
|
|
template <size_t... Is>
|
|
type implicit_cast(index_sequence<Is...>) & { return type(cast_op<Ts>(std::get<Is>(subcasters))...); }
|
|
template <size_t... Is>
|
|
type implicit_cast(index_sequence<Is...>) && { return type(cast_op<Ts>(std::move(std::get<Is>(subcasters)))...); }
|
|
|
|
static constexpr bool load_impl(const sequence &, bool, index_sequence<>) { return true; }
|
|
|
|
template <size_t... Is>
|
|
bool load_impl(const sequence &seq, bool convert, index_sequence<Is...>) {
|
|
#ifdef __cpp_fold_expressions
|
|
if ((... || !std::get<Is>(subcasters).load(seq[Is], convert)))
|
|
return false;
|
|
#else
|
|
for (bool r : {std::get<Is>(subcasters).load(seq[Is], convert)...})
|
|
if (!r)
|
|
return false;
|
|
#endif
|
|
return true;
|
|
}
|
|
|
|
/* Implementation: Convert a C++ tuple into a Python tuple */
|
|
template <typename T, size_t... Is>
|
|
static handle cast_impl(T &&src, return_value_policy policy, handle parent, index_sequence<Is...>) {
|
|
std::array<object, size> entries{{
|
|
reinterpret_steal<object>(make_caster<Ts>::cast(std::get<Is>(std::forward<T>(src)), policy, parent))...
|
|
}};
|
|
for (const auto &entry: entries)
|
|
if (!entry)
|
|
return handle();
|
|
tuple result(size);
|
|
int counter = 0;
|
|
for (auto & entry: entries)
|
|
PyTuple_SET_ITEM(result.ptr(), counter++, entry.release().ptr());
|
|
return result.release();
|
|
}
|
|
|
|
Tuple<make_caster<Ts>...> subcasters;
|
|
};
|
|
|
|
template <typename T1, typename T2> class type_caster<std::pair<T1, T2>>
|
|
: public tuple_caster<std::pair, T1, T2> {};
|
|
|
|
template <typename... Ts> class type_caster<std::tuple<Ts...>>
|
|
: public tuple_caster<std::tuple, Ts...> {};
|
|
|
|
/// Helper class which abstracts away certain actions. Users can provide specializations for
|
|
/// custom holders, but it's only necessary if the type has a non-standard interface.
|
|
template <typename T>
|
|
struct holder_helper {
|
|
static auto get(const T &p) -> decltype(p.get()) { return p.get(); }
|
|
};
|
|
|
|
/// Type caster for holder types like std::shared_ptr, etc.
|
|
/// The SFINAE hook is provided to help work around the current lack of support
|
|
/// for smart-pointer interoperability. Please consider it an implementation
|
|
/// detail that may change in the future, as formal support for smart-pointer
|
|
/// interoperability is added into pybind11.
|
|
template <typename type, typename holder_type, typename SFINAE = void>
|
|
struct copyable_holder_caster : public type_caster_base<type> {
|
|
public:
|
|
using base = type_caster_base<type>;
|
|
static_assert(std::is_base_of<base, type_caster<type>>::value,
|
|
"Holder classes are only supported for custom types");
|
|
using base::base;
|
|
using base::cast;
|
|
using base::typeinfo;
|
|
using base::value;
|
|
|
|
bool load(handle src, bool convert) {
|
|
return base::template load_impl<copyable_holder_caster<type, holder_type>>(src, convert);
|
|
}
|
|
|
|
explicit operator type*() { return this->value; }
|
|
// static_cast works around compiler error with MSVC 17 and CUDA 10.2
|
|
// see issue #2180
|
|
explicit operator type&() { return *(static_cast<type *>(this->value)); }
|
|
explicit operator holder_type*() { return std::addressof(holder); }
|
|
explicit operator holder_type&() { return holder; }
|
|
|
|
static handle cast(const holder_type &src, return_value_policy, handle) {
|
|
const auto *ptr = holder_helper<holder_type>::get(src);
|
|
return type_caster_base<type>::cast_holder(ptr, &src);
|
|
}
|
|
|
|
protected:
|
|
friend class type_caster_generic;
|
|
void check_holder_compat() {
|
|
if (typeinfo->default_holder)
|
|
throw cast_error("Unable to load a custom holder type from a default-holder instance");
|
|
}
|
|
|
|
bool load_value(value_and_holder &&v_h) {
|
|
if (v_h.holder_constructed()) {
|
|
value = v_h.value_ptr();
|
|
holder = v_h.template holder<holder_type>();
|
|
return true;
|
|
} else {
|
|
throw cast_error("Unable to cast from non-held to held instance (T& to Holder<T>) "
|
|
#if defined(NDEBUG)
|
|
"(compile in debug mode for type information)");
|
|
#else
|
|
"of type '" + type_id<holder_type>() + "''");
|
|
#endif
|
|
}
|
|
}
|
|
|
|
template <typename T = holder_type, detail::enable_if_t<!std::is_constructible<T, const T &, type*>::value, int> = 0>
|
|
bool try_implicit_casts(handle, bool) { return false; }
|
|
|
|
template <typename T = holder_type, detail::enable_if_t<std::is_constructible<T, const T &, type*>::value, int> = 0>
|
|
bool try_implicit_casts(handle src, bool convert) {
|
|
for (auto &cast : typeinfo->implicit_casts) {
|
|
copyable_holder_caster sub_caster(*cast.first);
|
|
if (sub_caster.load(src, convert)) {
|
|
value = cast.second(sub_caster.value);
|
|
holder = holder_type(sub_caster.holder, (type *) value);
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
static bool try_direct_conversions(handle) { return false; }
|
|
|
|
|
|
holder_type holder;
|
|
};
|
|
|
|
#ifndef PYBIND11_USE_SMART_HOLDER_AS_DEFAULT
|
|
/// Specialize for the common std::shared_ptr, so users don't need to
|
|
template <typename T>
|
|
class type_caster<std::shared_ptr<T>> : public copyable_holder_caster<T, std::shared_ptr<T>> { };
|
|
#endif
|
|
|
|
/// Type caster for holder types like std::unique_ptr.
|
|
/// Please consider the SFINAE hook an implementation detail, as explained
|
|
/// in the comment for the copyable_holder_caster.
|
|
template <typename type, typename holder_type, typename SFINAE = void>
|
|
struct move_only_holder_caster {
|
|
static_assert(std::is_base_of<type_caster_base<type>, type_caster<type>>::value,
|
|
"Holder classes are only supported for custom types");
|
|
|
|
static handle cast(holder_type &&src, return_value_policy, handle) {
|
|
auto *ptr = holder_helper<holder_type>::get(src);
|
|
return type_caster_base<type>::cast_holder(ptr, std::addressof(src));
|
|
}
|
|
static constexpr auto name = type_caster_base<type>::name;
|
|
};
|
|
|
|
#ifndef PYBIND11_USE_SMART_HOLDER_AS_DEFAULT
|
|
template <typename type, typename deleter>
|
|
class type_caster<std::unique_ptr<type, deleter>>
|
|
: public move_only_holder_caster<type, std::unique_ptr<type, deleter>> { };
|
|
#endif
|
|
|
|
template <typename type, typename holder_type>
|
|
using type_caster_holder = conditional_t<is_copy_constructible<holder_type>::value,
|
|
copyable_holder_caster<type, holder_type>,
|
|
move_only_holder_caster<type, holder_type>>;
|
|
|
|
template <typename T, bool Value = false> struct always_construct_holder { static constexpr bool value = Value; };
|
|
|
|
/// Create a specialization for custom holder types (silently ignores std::shared_ptr)
|
|
#define PYBIND11_DECLARE_HOLDER_TYPE(type, holder_type, ...) \
|
|
namespace pybind11 { namespace detail { \
|
|
template <typename type> \
|
|
struct always_construct_holder<holder_type> : always_construct_holder<void, ##__VA_ARGS__> { }; \
|
|
template <typename type> \
|
|
class type_caster<holder_type, enable_if_t<!is_shared_ptr<holder_type>::value>> \
|
|
: public type_caster_holder<type, holder_type> { }; \
|
|
}}
|
|
|
|
// PYBIND11_DECLARE_HOLDER_TYPE holder types:
|
|
template <typename base, typename holder> struct is_holder_type :
|
|
std::is_base_of<detail::type_caster_holder<base, holder>, detail::type_caster<holder>> {};
|
|
// Specialization for always-supported unique_ptr holders:
|
|
template <typename base, typename deleter> struct is_holder_type<base, std::unique_ptr<base, deleter>> :
|
|
std::true_type {};
|
|
|
|
template <typename T> struct handle_type_name { static constexpr auto name = _<T>(); };
|
|
template <> struct handle_type_name<bytes> { static constexpr auto name = _(PYBIND11_BYTES_NAME); };
|
|
template <> struct handle_type_name<int_> { static constexpr auto name = _("int"); };
|
|
template <> struct handle_type_name<iterable> { static constexpr auto name = _("Iterable"); };
|
|
template <> struct handle_type_name<iterator> { static constexpr auto name = _("Iterator"); };
|
|
template <> struct handle_type_name<none> { static constexpr auto name = _("None"); };
|
|
template <> struct handle_type_name<args> { static constexpr auto name = _("*args"); };
|
|
template <> struct handle_type_name<kwargs> { static constexpr auto name = _("**kwargs"); };
|
|
|
|
template <typename type>
|
|
struct pyobject_caster {
|
|
template <typename T = type, enable_if_t<std::is_same<T, handle>::value, int> = 0>
|
|
bool load(handle src, bool /* convert */) { value = src; return static_cast<bool>(value); }
|
|
|
|
template <typename T = type, enable_if_t<std::is_base_of<object, T>::value, int> = 0>
|
|
bool load(handle src, bool /* convert */) {
|
|
#if PY_MAJOR_VERSION < 3 && !defined(PYBIND11_STR_LEGACY_PERMISSIVE)
|
|
// For Python 2, without this implicit conversion, Python code would
|
|
// need to be cluttered with six.ensure_text() or similar, only to be
|
|
// un-cluttered later after Python 2 support is dropped.
|
|
if (std::is_same<T, str>::value && isinstance<bytes>(src)) {
|
|
PyObject *str_from_bytes = PyUnicode_FromEncodedObject(src.ptr(), "utf-8", nullptr);
|
|
if (!str_from_bytes) throw error_already_set();
|
|
value = reinterpret_steal<type>(str_from_bytes);
|
|
return true;
|
|
}
|
|
#endif
|
|
if (!isinstance<type>(src))
|
|
return false;
|
|
value = reinterpret_borrow<type>(src);
|
|
return true;
|
|
}
|
|
|
|
static handle cast(const handle &src, return_value_policy /* policy */, handle /* parent */) {
|
|
return src.inc_ref();
|
|
}
|
|
PYBIND11_TYPE_CASTER(type, handle_type_name<type>::name);
|
|
};
|
|
|
|
template <typename T>
|
|
class type_caster<T, enable_if_t<is_pyobject<T>::value>> : public pyobject_caster<T> { };
|
|
|
|
// Our conditions for enabling moving are quite restrictive:
|
|
// At compile time:
|
|
// - T needs to be a non-const, non-pointer, non-reference type
|
|
// - type_caster<T>::operator T&() must exist
|
|
// - the type must be move constructible (obviously)
|
|
// At run-time:
|
|
// - if the type is non-copy-constructible, the object must be the sole owner of the type (i.e. it
|
|
// must have ref_count() == 1)h
|
|
// If any of the above are not satisfied, we fall back to copying.
|
|
template <typename T> using move_is_plain_type = satisfies_none_of<T,
|
|
std::is_void, std::is_pointer, std::is_reference, std::is_const
|
|
>;
|
|
template <typename T, typename SFINAE = void> struct move_always : std::false_type {};
|
|
template <typename T> struct move_always<T, enable_if_t<all_of<
|
|
move_is_plain_type<T>,
|
|
negation<is_copy_constructible<T>>,
|
|
std::is_move_constructible<T>,
|
|
std::is_same<decltype(std::declval<make_caster<T>>().operator T&()), T&>
|
|
>::value>> : std::true_type {};
|
|
template <typename T, typename SFINAE = void> struct move_if_unreferenced : std::false_type {};
|
|
template <typename T> struct move_if_unreferenced<T, enable_if_t<all_of<
|
|
move_is_plain_type<T>,
|
|
negation<move_always<T>>,
|
|
std::is_move_constructible<T>,
|
|
std::is_same<decltype(std::declval<make_caster<T>>().operator T&()), T&>
|
|
>::value>> : std::true_type {};
|
|
template <typename T> using move_never = none_of<move_always<T>, move_if_unreferenced<T>>;
|
|
|
|
// Detect whether returning a `type` from a cast on type's type_caster is going to result in a
|
|
// reference or pointer to a local variable of the type_caster. Basically, only
|
|
// non-reference/pointer `type`s and reference/pointers from a type_caster_generic are safe;
|
|
// everything else returns a reference/pointer to a local variable.
|
|
template <typename type> using cast_is_temporary_value_reference = bool_constant<
|
|
(std::is_reference<type>::value || std::is_pointer<type>::value) &&
|
|
!std::is_base_of<type_caster_generic, make_caster<type>>::value &&
|
|
!type_uses_smart_holder_type_caster<intrinsic_t<type>>::value &&
|
|
!std::is_same<intrinsic_t<type>, void>::value
|
|
>;
|
|
|
|
// When a value returned from a C++ function is being cast back to Python, we almost always want to
|
|
// force `policy = move`, regardless of the return value policy the function/method was declared
|
|
// with.
|
|
template <typename Return, typename SFINAE = void> struct return_value_policy_override {
|
|
static return_value_policy policy(return_value_policy p) { return p; }
|
|
};
|
|
|
|
template <typename Return> struct return_value_policy_override<Return,
|
|
detail::enable_if_t<std::is_base_of<type_caster_generic, make_caster<Return>>::value, void>> {
|
|
static return_value_policy policy(return_value_policy p) {
|
|
return !std::is_lvalue_reference<Return>::value &&
|
|
!std::is_pointer<Return>::value
|
|
? return_value_policy::move : p;
|
|
}
|
|
};
|
|
|
|
// Basic python -> C++ casting; throws if casting fails
|
|
template <typename T, typename SFINAE> type_caster<T, SFINAE> &load_type(type_caster<T, SFINAE> &conv, const handle &handle) {
|
|
if (!conv.load(handle, true)) {
|
|
#if defined(NDEBUG)
|
|
throw cast_error("Unable to cast Python instance to C++ type (compile in debug mode for details)");
|
|
#else
|
|
throw cast_error("Unable to cast Python instance of type " +
|
|
(std::string) str(type::handle_of(handle)) + " to C++ type '" + type_id<T>() + "'");
|
|
#endif
|
|
}
|
|
return conv;
|
|
}
|
|
// Wrapper around the above that also constructs and returns a type_caster
|
|
template <typename T> make_caster<T> load_type(const handle &handle) {
|
|
make_caster<T> conv;
|
|
load_type(conv, handle);
|
|
return conv;
|
|
}
|
|
|
|
PYBIND11_NAMESPACE_END(detail)
|
|
|
|
// pytype -> C++ type
|
|
template <typename T, detail::enable_if_t<!detail::is_pyobject<T>::value, int> = 0>
|
|
T cast(const handle &handle) {
|
|
using namespace detail;
|
|
static_assert(!cast_is_temporary_value_reference<T>::value,
|
|
"Unable to cast type to reference: value is local to type caster");
|
|
return cast_op<T>(load_type<T>(handle));
|
|
}
|
|
|
|
// pytype -> pytype (calls converting constructor)
|
|
template <typename T, detail::enable_if_t<detail::is_pyobject<T>::value, int> = 0>
|
|
T cast(const handle &handle) { return T(reinterpret_borrow<object>(handle)); }
|
|
|
|
// C++ type -> py::object
|
|
template <typename T, detail::enable_if_t<!detail::is_pyobject<T>::value, int> = 0>
|
|
object cast(T &&value, return_value_policy policy = return_value_policy::automatic_reference,
|
|
handle parent = handle()) {
|
|
using no_ref_T = typename std::remove_reference<T>::type;
|
|
if (policy == return_value_policy::automatic)
|
|
policy = std::is_pointer<no_ref_T>::value ? return_value_policy::take_ownership :
|
|
std::is_lvalue_reference<T>::value ? return_value_policy::copy : return_value_policy::move;
|
|
else if (policy == return_value_policy::automatic_reference)
|
|
policy = std::is_pointer<no_ref_T>::value ? return_value_policy::reference :
|
|
std::is_lvalue_reference<T>::value ? return_value_policy::copy : return_value_policy::move;
|
|
return reinterpret_steal<object>(detail::make_caster<T>::cast(std::forward<T>(value), policy, parent));
|
|
}
|
|
|
|
template <typename T> T handle::cast() const { return pybind11::cast<T>(*this); }
|
|
template <> inline void handle::cast() const { return; }
|
|
|
|
template <typename T>
|
|
detail::enable_if_t<!detail::move_never<T>::value, T> move(object &&obj) {
|
|
if (obj.ref_count() > 1)
|
|
#if defined(NDEBUG)
|
|
throw cast_error("Unable to cast Python instance to C++ rvalue: instance has multiple references"
|
|
" (compile in debug mode for details)");
|
|
#else
|
|
throw cast_error("Unable to move from Python " + (std::string) str(type::handle_of(obj)) +
|
|
" instance to C++ " + type_id<T>() + " instance: instance has multiple references");
|
|
#endif
|
|
|
|
// Move into a temporary and return that, because the reference may be a local value of `conv`
|
|
T ret = std::move(detail::load_type<T>(obj).operator T&());
|
|
return ret;
|
|
}
|
|
|
|
// Calling cast() on an rvalue calls pybind11::cast with the object rvalue, which does:
|
|
// - If we have to move (because T has no copy constructor), do it. This will fail if the moved
|
|
// object has multiple references, but trying to copy will fail to compile.
|
|
// - If both movable and copyable, check ref count: if 1, move; otherwise copy
|
|
// - Otherwise (not movable), copy.
|
|
template <typename T> detail::enable_if_t<detail::move_always<T>::value, T> cast(object &&object) {
|
|
return move<T>(std::move(object));
|
|
}
|
|
template <typename T> detail::enable_if_t<detail::move_if_unreferenced<T>::value, T> cast(object &&object) {
|
|
if (object.ref_count() > 1)
|
|
return cast<T>(object);
|
|
else
|
|
return move<T>(std::move(object));
|
|
}
|
|
template <typename T> detail::enable_if_t<detail::move_never<T>::value, T> cast(object &&object) {
|
|
return cast<T>(object);
|
|
}
|
|
|
|
template <typename T> T object::cast() const & { return pybind11::cast<T>(*this); }
|
|
template <typename T> T object::cast() && { return pybind11::cast<T>(std::move(*this)); }
|
|
template <> inline void object::cast() const & { return; }
|
|
template <> inline void object::cast() && { return; }
|
|
|
|
PYBIND11_NAMESPACE_BEGIN(detail)
|
|
|
|
// Declared in pytypes.h:
|
|
template <typename T, enable_if_t<!is_pyobject<T>::value, int>>
|
|
object object_or_cast(T &&o) { return pybind11::cast(std::forward<T>(o)); }
|
|
|
|
struct override_unused {}; // Placeholder type for the unneeded (and dead code) static variable in the PYBIND11_OVERRIDE_OVERRIDE macro
|
|
template <typename ret_type> using override_caster_t = conditional_t<
|
|
cast_is_temporary_value_reference<ret_type>::value, make_caster<ret_type>, override_unused>;
|
|
|
|
// Trampoline use: for reference/pointer types to value-converted values, we do a value cast, then
|
|
// store the result in the given variable. For other types, this is a no-op.
|
|
template <typename T> enable_if_t<cast_is_temporary_value_reference<T>::value, T> cast_ref(object &&o, make_caster<T> &caster) {
|
|
return cast_op<T>(load_type(caster, o));
|
|
}
|
|
template <typename T> enable_if_t<!cast_is_temporary_value_reference<T>::value, T> cast_ref(object &&, override_unused &) {
|
|
pybind11_fail("Internal error: cast_ref fallback invoked"); }
|
|
|
|
// Trampoline use: Having a pybind11::cast with an invalid reference type is going to static_assert, even
|
|
// though if it's in dead code, so we provide a "trampoline" to pybind11::cast that only does anything in
|
|
// cases where pybind11::cast is valid.
|
|
template <typename T> enable_if_t<!cast_is_temporary_value_reference<T>::value, T> cast_safe(object &&o) {
|
|
return pybind11::cast<T>(std::move(o)); }
|
|
template <typename T> enable_if_t<cast_is_temporary_value_reference<T>::value, T> cast_safe(object &&) {
|
|
pybind11_fail("Internal error: cast_safe fallback invoked"); }
|
|
template <> inline void cast_safe<void>(object &&) {}
|
|
|
|
PYBIND11_NAMESPACE_END(detail)
|
|
|
|
template <return_value_policy policy = return_value_policy::automatic_reference>
|
|
tuple make_tuple() { return tuple(0); }
|
|
|
|
template <return_value_policy policy = return_value_policy::automatic_reference,
|
|
typename... Args> tuple make_tuple(Args&&... args_) {
|
|
constexpr size_t size = sizeof...(Args);
|
|
std::array<object, size> args {
|
|
{ reinterpret_steal<object>(detail::make_caster<Args>::cast(
|
|
std::forward<Args>(args_), policy, nullptr))... }
|
|
};
|
|
for (size_t i = 0; i < args.size(); i++) {
|
|
if (!args[i]) {
|
|
#if defined(NDEBUG)
|
|
throw cast_error("make_tuple(): unable to convert arguments to Python object (compile in debug mode for details)");
|
|
#else
|
|
std::array<std::string, size> argtypes { {type_id<Args>()...} };
|
|
throw cast_error("make_tuple(): unable to convert argument of type '" +
|
|
argtypes[i] + "' to Python object");
|
|
#endif
|
|
}
|
|
}
|
|
tuple result(size);
|
|
int counter = 0;
|
|
for (auto &arg_value : args)
|
|
PyTuple_SET_ITEM(result.ptr(), counter++, arg_value.release().ptr());
|
|
return result;
|
|
}
|
|
|
|
/// \ingroup annotations
|
|
/// Annotation for arguments
|
|
struct arg {
|
|
/// Constructs an argument with the name of the argument; if null or omitted, this is a positional argument.
|
|
constexpr explicit arg(const char *name = nullptr) : name(name), flag_noconvert(false), flag_none(true) { }
|
|
/// Assign a value to this argument
|
|
template <typename T> arg_v operator=(T &&value) const;
|
|
/// Indicate that the type should not be converted in the type caster
|
|
arg &noconvert(bool flag = true) { flag_noconvert = flag; return *this; }
|
|
/// Indicates that the argument should/shouldn't allow None (e.g. for nullable pointer args)
|
|
arg &none(bool flag = true) { flag_none = flag; return *this; }
|
|
|
|
const char *name; ///< If non-null, this is a named kwargs argument
|
|
bool flag_noconvert : 1; ///< If set, do not allow conversion (requires a supporting type caster!)
|
|
bool flag_none : 1; ///< If set (the default), allow None to be passed to this argument
|
|
};
|
|
|
|
/// \ingroup annotations
|
|
/// Annotation for arguments with values
|
|
struct arg_v : arg {
|
|
private:
|
|
template <typename T>
|
|
arg_v(arg &&base, T &&x, const char *descr = nullptr)
|
|
: arg(base),
|
|
value(reinterpret_steal<object>(
|
|
detail::make_caster<T>::cast(x, return_value_policy::automatic, {})
|
|
)),
|
|
descr(descr)
|
|
#if !defined(NDEBUG)
|
|
, type(type_id<T>())
|
|
#endif
|
|
{
|
|
// Workaround! See:
|
|
// https://github.com/pybind/pybind11/issues/2336
|
|
// https://github.com/pybind/pybind11/pull/2685#issuecomment-731286700
|
|
if (PyErr_Occurred()) {
|
|
PyErr_Clear();
|
|
}
|
|
}
|
|
|
|
public:
|
|
/// Direct construction with name, default, and description
|
|
template <typename T>
|
|
arg_v(const char *name, T &&x, const char *descr = nullptr)
|
|
: arg_v(arg(name), std::forward<T>(x), descr) { }
|
|
|
|
/// Called internally when invoking `py::arg("a") = value`
|
|
template <typename T>
|
|
arg_v(const arg &base, T &&x, const char *descr = nullptr)
|
|
: arg_v(arg(base), std::forward<T>(x), descr) { }
|
|
|
|
/// Same as `arg::noconvert()`, but returns *this as arg_v&, not arg&
|
|
arg_v &noconvert(bool flag = true) { arg::noconvert(flag); return *this; }
|
|
|
|
/// Same as `arg::nonone()`, but returns *this as arg_v&, not arg&
|
|
arg_v &none(bool flag = true) { arg::none(flag); return *this; }
|
|
|
|
/// The default value
|
|
object value;
|
|
/// The (optional) description of the default value
|
|
const char *descr;
|
|
#if !defined(NDEBUG)
|
|
/// The C++ type name of the default value (only available when compiled in debug mode)
|
|
std::string type;
|
|
#endif
|
|
};
|
|
|
|
/// \ingroup annotations
|
|
/// Annotation indicating that all following arguments are keyword-only; the is the equivalent of an
|
|
/// unnamed '*' argument (in Python 3)
|
|
struct kw_only {};
|
|
|
|
/// \ingroup annotations
|
|
/// Annotation indicating that all previous arguments are positional-only; the is the equivalent of an
|
|
/// unnamed '/' argument (in Python 3.8)
|
|
struct pos_only {};
|
|
|
|
template <typename T>
|
|
arg_v arg::operator=(T &&value) const { return {std::move(*this), std::forward<T>(value)}; }
|
|
|
|
/// Alias for backward compatibility -- to be removed in version 2.0
|
|
template <typename /*unused*/> using arg_t = arg_v;
|
|
|
|
inline namespace literals {
|
|
/** \rst
|
|
String literal version of `arg`
|
|
\endrst */
|
|
constexpr arg operator"" _a(const char *name, size_t) { return arg(name); }
|
|
} // namespace literals
|
|
|
|
PYBIND11_NAMESPACE_BEGIN(detail)
|
|
|
|
// forward declaration (definition in attr.h)
|
|
struct function_record;
|
|
|
|
/// Internal data associated with a single function call
|
|
struct function_call {
|
|
function_call(const function_record &f, handle p); // Implementation in attr.h
|
|
|
|
/// The function data:
|
|
const function_record &func;
|
|
|
|
/// Arguments passed to the function:
|
|
std::vector<handle> args;
|
|
|
|
/// The `convert` value the arguments should be loaded with
|
|
std::vector<bool> args_convert;
|
|
|
|
/// Extra references for the optional `py::args` and/or `py::kwargs` arguments (which, if
|
|
/// present, are also in `args` but without a reference).
|
|
object args_ref, kwargs_ref;
|
|
|
|
/// The parent, if any
|
|
handle parent;
|
|
|
|
/// If this is a call to an initializer, this argument contains `self`
|
|
handle init_self;
|
|
};
|
|
|
|
|
|
/// Helper class which loads arguments for C++ functions called from Python
|
|
template <typename... Args>
|
|
class argument_loader {
|
|
using indices = make_index_sequence<sizeof...(Args)>;
|
|
|
|
template <typename Arg> using argument_is_args = std::is_same<intrinsic_t<Arg>, args>;
|
|
template <typename Arg> using argument_is_kwargs = std::is_same<intrinsic_t<Arg>, kwargs>;
|
|
// Get args/kwargs argument positions relative to the end of the argument list:
|
|
static constexpr auto args_pos = constexpr_first<argument_is_args, Args...>() - (int) sizeof...(Args),
|
|
kwargs_pos = constexpr_first<argument_is_kwargs, Args...>() - (int) sizeof...(Args);
|
|
|
|
static constexpr bool args_kwargs_are_last = kwargs_pos >= - 1 && args_pos >= kwargs_pos - 1;
|
|
|
|
static_assert(args_kwargs_are_last, "py::args/py::kwargs are only permitted as the last argument(s) of a function");
|
|
|
|
public:
|
|
static constexpr bool has_kwargs = kwargs_pos < 0;
|
|
static constexpr bool has_args = args_pos < 0;
|
|
|
|
static constexpr auto arg_names = concat(type_descr(make_caster<Args>::name)...);
|
|
|
|
bool load_args(function_call &call) {
|
|
return load_impl_sequence(call, indices{});
|
|
}
|
|
|
|
template <typename Return, typename Guard, typename Func>
|
|
enable_if_t<!std::is_void<Return>::value, Return> call(Func &&f) && {
|
|
return std::move(*this).template call_impl<Return>(std::forward<Func>(f), indices{}, Guard{});
|
|
}
|
|
|
|
template <typename Return, typename Guard, typename Func>
|
|
enable_if_t<std::is_void<Return>::value, void_type> call(Func &&f) && {
|
|
std::move(*this).template call_impl<Return>(std::forward<Func>(f), indices{}, Guard{});
|
|
return void_type();
|
|
}
|
|
|
|
private:
|
|
|
|
static bool load_impl_sequence(function_call &, index_sequence<>) { return true; }
|
|
|
|
template <size_t... Is>
|
|
bool load_impl_sequence(function_call &call, index_sequence<Is...>) {
|
|
#ifdef __cpp_fold_expressions
|
|
if ((... || !std::get<Is>(argcasters).load(call.args[Is], call.args_convert[Is])))
|
|
return false;
|
|
#else
|
|
for (bool r : {std::get<Is>(argcasters).load(call.args[Is], call.args_convert[Is])...})
|
|
if (!r)
|
|
return false;
|
|
#endif
|
|
return true;
|
|
}
|
|
|
|
template <typename Return, typename Func, size_t... Is, typename Guard>
|
|
Return call_impl(Func &&f, index_sequence<Is...>, Guard &&) && {
|
|
return std::forward<Func>(f)(cast_op<Args>(std::move(std::get<Is>(argcasters)))...);
|
|
}
|
|
|
|
std::tuple<make_caster<Args>...> argcasters;
|
|
};
|
|
|
|
/// Helper class which collects only positional arguments for a Python function call.
|
|
/// A fancier version below can collect any argument, but this one is optimal for simple calls.
|
|
template <return_value_policy policy>
|
|
class simple_collector {
|
|
public:
|
|
template <typename... Ts>
|
|
explicit simple_collector(Ts &&...values)
|
|
: m_args(pybind11::make_tuple<policy>(std::forward<Ts>(values)...)) { }
|
|
|
|
const tuple &args() const & { return m_args; }
|
|
dict kwargs() const { return {}; }
|
|
|
|
tuple args() && { return std::move(m_args); }
|
|
|
|
/// Call a Python function and pass the collected arguments
|
|
object call(PyObject *ptr) const {
|
|
PyObject *result = PyObject_CallObject(ptr, m_args.ptr());
|
|
if (!result)
|
|
throw error_already_set();
|
|
return reinterpret_steal<object>(result);
|
|
}
|
|
|
|
private:
|
|
tuple m_args;
|
|
};
|
|
|
|
/// Helper class which collects positional, keyword, * and ** arguments for a Python function call
|
|
template <return_value_policy policy>
|
|
class unpacking_collector {
|
|
public:
|
|
template <typename... Ts>
|
|
explicit unpacking_collector(Ts &&...values) {
|
|
// Tuples aren't (easily) resizable so a list is needed for collection,
|
|
// but the actual function call strictly requires a tuple.
|
|
auto args_list = list();
|
|
int _[] = { 0, (process(args_list, std::forward<Ts>(values)), 0)... };
|
|
ignore_unused(_);
|
|
|
|
m_args = std::move(args_list);
|
|
}
|
|
|
|
const tuple &args() const & { return m_args; }
|
|
const dict &kwargs() const & { return m_kwargs; }
|
|
|
|
tuple args() && { return std::move(m_args); }
|
|
dict kwargs() && { return std::move(m_kwargs); }
|
|
|
|
/// Call a Python function and pass the collected arguments
|
|
object call(PyObject *ptr) const {
|
|
PyObject *result = PyObject_Call(ptr, m_args.ptr(), m_kwargs.ptr());
|
|
if (!result)
|
|
throw error_already_set();
|
|
return reinterpret_steal<object>(result);
|
|
}
|
|
|
|
private:
|
|
template <typename T>
|
|
void process(list &args_list, T &&x) {
|
|
auto o = reinterpret_steal<object>(detail::make_caster<T>::cast(std::forward<T>(x), policy, {}));
|
|
if (!o) {
|
|
#if defined(NDEBUG)
|
|
argument_cast_error();
|
|
#else
|
|
argument_cast_error(std::to_string(args_list.size()), type_id<T>());
|
|
#endif
|
|
}
|
|
args_list.append(o);
|
|
}
|
|
|
|
void process(list &args_list, detail::args_proxy ap) {
|
|
for (auto a : ap)
|
|
args_list.append(a);
|
|
}
|
|
|
|
void process(list &/*args_list*/, arg_v a) {
|
|
if (!a.name)
|
|
#if defined(NDEBUG)
|
|
nameless_argument_error();
|
|
#else
|
|
nameless_argument_error(a.type);
|
|
#endif
|
|
|
|
if (m_kwargs.contains(a.name)) {
|
|
#if defined(NDEBUG)
|
|
multiple_values_error();
|
|
#else
|
|
multiple_values_error(a.name);
|
|
#endif
|
|
}
|
|
if (!a.value) {
|
|
#if defined(NDEBUG)
|
|
argument_cast_error();
|
|
#else
|
|
argument_cast_error(a.name, a.type);
|
|
#endif
|
|
}
|
|
m_kwargs[a.name] = a.value;
|
|
}
|
|
|
|
void process(list &/*args_list*/, detail::kwargs_proxy kp) {
|
|
if (!kp)
|
|
return;
|
|
for (auto k : reinterpret_borrow<dict>(kp)) {
|
|
if (m_kwargs.contains(k.first)) {
|
|
#if defined(NDEBUG)
|
|
multiple_values_error();
|
|
#else
|
|
multiple_values_error(str(k.first));
|
|
#endif
|
|
}
|
|
m_kwargs[k.first] = k.second;
|
|
}
|
|
}
|
|
|
|
[[noreturn]] static void nameless_argument_error() {
|
|
throw type_error("Got kwargs without a name; only named arguments "
|
|
"may be passed via py::arg() to a python function call. "
|
|
"(compile in debug mode for details)");
|
|
}
|
|
[[noreturn]] static void nameless_argument_error(std::string type) {
|
|
throw type_error("Got kwargs without a name of type '" + type + "'; only named "
|
|
"arguments may be passed via py::arg() to a python function call. ");
|
|
}
|
|
[[noreturn]] static void multiple_values_error() {
|
|
throw type_error("Got multiple values for keyword argument "
|
|
"(compile in debug mode for details)");
|
|
}
|
|
|
|
[[noreturn]] static void multiple_values_error(std::string name) {
|
|
throw type_error("Got multiple values for keyword argument '" + name + "'");
|
|
}
|
|
|
|
[[noreturn]] static void argument_cast_error() {
|
|
throw cast_error("Unable to convert call argument to Python object "
|
|
"(compile in debug mode for details)");
|
|
}
|
|
|
|
[[noreturn]] static void argument_cast_error(std::string name, std::string type) {
|
|
throw cast_error("Unable to convert call argument '" + name
|
|
+ "' of type '" + type + "' to Python object");
|
|
}
|
|
|
|
private:
|
|
tuple m_args;
|
|
dict m_kwargs;
|
|
};
|
|
|
|
// [workaround(intel)] Separate function required here
|
|
// We need to put this into a separate function because the Intel compiler
|
|
// fails to compile enable_if_t<!all_of<is_positional<Args>...>::value>
|
|
// (tested with ICC 2021.1 Beta 20200827).
|
|
template <typename... Args>
|
|
constexpr bool args_are_all_positional()
|
|
{
|
|
return all_of<is_positional<Args>...>::value;
|
|
}
|
|
|
|
/// Collect only positional arguments for a Python function call
|
|
template <return_value_policy policy, typename... Args,
|
|
typename = enable_if_t<args_are_all_positional<Args...>()>>
|
|
simple_collector<policy> collect_arguments(Args &&...args) {
|
|
return simple_collector<policy>(std::forward<Args>(args)...);
|
|
}
|
|
|
|
/// Collect all arguments, including keywords and unpacking (only instantiated when needed)
|
|
template <return_value_policy policy, typename... Args,
|
|
typename = enable_if_t<!args_are_all_positional<Args...>()>>
|
|
unpacking_collector<policy> collect_arguments(Args &&...args) {
|
|
// Following argument order rules for generalized unpacking according to PEP 448
|
|
static_assert(
|
|
constexpr_last<is_positional, Args...>() < constexpr_first<is_keyword_or_ds, Args...>()
|
|
&& constexpr_last<is_s_unpacking, Args...>() < constexpr_first<is_ds_unpacking, Args...>(),
|
|
"Invalid function call: positional args must precede keywords and ** unpacking; "
|
|
"* unpacking must precede ** unpacking"
|
|
);
|
|
return unpacking_collector<policy>(std::forward<Args>(args)...);
|
|
}
|
|
|
|
template <typename Derived>
|
|
template <return_value_policy policy, typename... Args>
|
|
object object_api<Derived>::operator()(Args &&...args) const {
|
|
return detail::collect_arguments<policy>(std::forward<Args>(args)...).call(derived().ptr());
|
|
}
|
|
|
|
template <typename Derived>
|
|
template <return_value_policy policy, typename... Args>
|
|
object object_api<Derived>::call(Args &&...args) const {
|
|
return operator()<policy>(std::forward<Args>(args)...);
|
|
}
|
|
|
|
PYBIND11_NAMESPACE_END(detail)
|
|
|
|
|
|
template<typename T>
|
|
handle type::handle_of() {
|
|
static_assert(
|
|
detail::any_of<std::is_base_of<detail::type_caster_generic, detail::make_caster<T>>,
|
|
detail::type_uses_smart_holder_type_caster<T>>::value,
|
|
"py::type::of<T> only supports the case where T is a registered C++ types.");
|
|
|
|
return detail::get_type_handle(typeid(T), true);
|
|
}
|
|
|
|
|
|
#define PYBIND11_MAKE_OPAQUE(...) \
|
|
namespace pybind11 { namespace detail { \
|
|
template<> class type_caster<__VA_ARGS__> : public type_caster_for_class_<__VA_ARGS__> { }; \
|
|
}}
|
|
|
|
/// Lets you pass a type containing a `,` through a macro parameter without needing a separate
|
|
/// typedef, e.g.: `PYBIND11_OVERRIDE(PYBIND11_TYPE(ReturnType<A, B>), PYBIND11_TYPE(Parent<C, D>), f, arg)`
|
|
#define PYBIND11_TYPE(...) __VA_ARGS__
|
|
|
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE)
|