mirror of
https://github.com/pybind/pybind11.git
synced 2024-11-11 08:03:55 +00:00
Add format_descriptor<>
& npy_format_descriptor<>
PyObject *
specializations. (#4674)
* Add `npy_format_descriptor<PyObject *>` to enable `py::array_t<PyObject *>` to/from-python conversions.
* resolve clang-tidy warning
* Use existing constructor instead of adding a static method. Thanks @Skylion007 for pointing out.
* Add `format_descriptor<PyObject *>`
Trivial addition, but still in search for a meaningful test.
* Add test_format_descriptor_format
* Ensure the Eigen `type_caster`s do not segfault when loading arrays with dtype=object
* Use `static_assert()` `!std::is_pointer<>` to replace runtime guards.
* Add comments to explain how to check for ref-count bugs. (NO code changes.)
* Make the "Pointer types ... are not supported" message Eigen-specific, as suggested by @Lalaland. Move to new pybind11/eigen/common.h header.
* Change "format_descriptor_format" implementation as suggested by @Lalaland. Additional tests meant to ensure consistency between py::format_descriptor<>, np.array, np.format_parser turn out to be useful only to highlight long-standing inconsistencies.
* resolve clang-tidy warning
* Account for np.float128, np.complex256 not being available on Windows, in a future-proof way.
* Fully address i|q|l ambiguity (hopefully).
* Remove the new `np.format_parser()`-based test, it's much more distracting than useful.
* Use bi.itemsize to disambiguate "l" or "L"
* Use `py::detail::compare_buffer_info<T>::compare()` to validate the `format_descriptor<T>::format()` strings.
* Add `buffer_info::compare<T>` to make `detail::compare_buffer_info<T>::compare` more visible & accessible.
* silence clang-tidy warning
* pytest-compatible access to np.float128, np.complex256
* Revert "pytest-compatible access to np.float128, np.complex256"
This reverts commit e9a289c50f
.
* Use `sizeof(long double) == sizeof(double)` instead of `std::is_same<>`
* Report skipped `long double` tests.
* Change the name of the new `buffer_info` member function to `item_type_is_equivalent_to`. Add comment defining "equivalent" by example.
* Change `item_type_is_equivalent_to<>()` from `static` function to member function, as suggested by @Lalaland
This commit is contained in:
parent
6e6bcca5b2
commit
8e1f9d5c40
@ -126,6 +126,7 @@ set(PYBIND11_HEADERS
|
|||||||
include/pybind11/complex.h
|
include/pybind11/complex.h
|
||||||
include/pybind11/options.h
|
include/pybind11/options.h
|
||||||
include/pybind11/eigen.h
|
include/pybind11/eigen.h
|
||||||
|
include/pybind11/eigen/common.h
|
||||||
include/pybind11/eigen/matrix.h
|
include/pybind11/eigen/matrix.h
|
||||||
include/pybind11/eigen/tensor.h
|
include/pybind11/eigen/tensor.h
|
||||||
include/pybind11/embed.h
|
include/pybind11/embed.h
|
||||||
|
@ -37,6 +37,9 @@ inline std::vector<ssize_t> f_strides(const std::vector<ssize_t> &shape, ssize_t
|
|||||||
return strides;
|
return strides;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
template <typename T, typename SFINAE = void>
|
||||||
|
struct compare_buffer_info;
|
||||||
|
|
||||||
PYBIND11_NAMESPACE_END(detail)
|
PYBIND11_NAMESPACE_END(detail)
|
||||||
|
|
||||||
/// Information record describing a Python buffer object
|
/// Information record describing a Python buffer object
|
||||||
@ -150,6 +153,17 @@ struct buffer_info {
|
|||||||
Py_buffer *view() const { return m_view; }
|
Py_buffer *view() const { return m_view; }
|
||||||
Py_buffer *&view() { return m_view; }
|
Py_buffer *&view() { return m_view; }
|
||||||
|
|
||||||
|
/* True if the buffer item type is equivalent to `T`. */
|
||||||
|
// To define "equivalent" by example:
|
||||||
|
// `buffer_info::item_type_is_equivalent_to<int>(b)` and
|
||||||
|
// `buffer_info::item_type_is_equivalent_to<long>(b)` may both be true
|
||||||
|
// on some platforms, but `int` and `unsigned` will never be equivalent.
|
||||||
|
// For the ground truth, please inspect `detail::compare_buffer_info<>`.
|
||||||
|
template <typename T>
|
||||||
|
bool item_type_is_equivalent_to() const {
|
||||||
|
return detail::compare_buffer_info<T>::compare(*this);
|
||||||
|
}
|
||||||
|
|
||||||
private:
|
private:
|
||||||
struct private_ctr_tag {};
|
struct private_ctr_tag {};
|
||||||
|
|
||||||
@ -170,9 +184,10 @@ private:
|
|||||||
|
|
||||||
PYBIND11_NAMESPACE_BEGIN(detail)
|
PYBIND11_NAMESPACE_BEGIN(detail)
|
||||||
|
|
||||||
template <typename T, typename SFINAE = void>
|
template <typename T, typename SFINAE>
|
||||||
struct compare_buffer_info {
|
struct compare_buffer_info {
|
||||||
static bool compare(const buffer_info &b) {
|
static bool compare(const buffer_info &b) {
|
||||||
|
// NOLINTNEXTLINE(bugprone-sizeof-expression) Needed for `PyObject *`
|
||||||
return b.format == format_descriptor<T>::format() && b.itemsize == (ssize_t) sizeof(T);
|
return b.format == format_descriptor<T>::format() && b.itemsize == (ssize_t) sizeof(T);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
@ -1025,6 +1025,15 @@ PYBIND11_RUNTIME_EXCEPTION(reference_cast_error, PyExc_RuntimeError) /// Used in
|
|||||||
template <typename T, typename SFINAE = void>
|
template <typename T, typename SFINAE = void>
|
||||||
struct format_descriptor {};
|
struct format_descriptor {};
|
||||||
|
|
||||||
|
template <typename T>
|
||||||
|
struct format_descriptor<
|
||||||
|
T,
|
||||||
|
detail::enable_if_t<detail::is_same_ignoring_cvref<T, PyObject *>::value>> {
|
||||||
|
static constexpr const char c = 'O';
|
||||||
|
static constexpr const char value[2] = {c, '\0'};
|
||||||
|
static std::string format() { return std::string(1, c); }
|
||||||
|
};
|
||||||
|
|
||||||
PYBIND11_NAMESPACE_BEGIN(detail)
|
PYBIND11_NAMESPACE_BEGIN(detail)
|
||||||
// Returns the index of the given type in the type char array below, and in the list in numpy.h
|
// Returns the index of the given type in the type char array below, and in the list in numpy.h
|
||||||
// The order here is: bool; 8 ints ((signed,unsigned)x(8,16,32,64)bits); float,double,long double;
|
// The order here is: bool; 8 ints ((signed,unsigned)x(8,16,32,64)bits); float,double,long double;
|
||||||
|
9
include/pybind11/eigen/common.h
Normal file
9
include/pybind11/eigen/common.h
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
// Copyright (c) 2023 The pybind Community.
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
// Common message for `static_assert()`s, which are useful to easily
|
||||||
|
// preempt much less obvious errors.
|
||||||
|
#define PYBIND11_EIGEN_MESSAGE_POINTER_TYPES_ARE_NOT_SUPPORTED \
|
||||||
|
"Pointer types (in particular `PyObject *`) are not supported as scalar types for Eigen " \
|
||||||
|
"types."
|
@ -10,6 +10,7 @@
|
|||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
#include "../numpy.h"
|
#include "../numpy.h"
|
||||||
|
#include "common.h"
|
||||||
|
|
||||||
/* HINT: To suppress warnings originating from the Eigen headers, use -isystem.
|
/* HINT: To suppress warnings originating from the Eigen headers, use -isystem.
|
||||||
See also:
|
See also:
|
||||||
@ -287,6 +288,8 @@ handle eigen_encapsulate(Type *src) {
|
|||||||
template <typename Type>
|
template <typename Type>
|
||||||
struct type_caster<Type, enable_if_t<is_eigen_dense_plain<Type>::value>> {
|
struct type_caster<Type, enable_if_t<is_eigen_dense_plain<Type>::value>> {
|
||||||
using Scalar = typename Type::Scalar;
|
using Scalar = typename Type::Scalar;
|
||||||
|
static_assert(!std::is_pointer<Scalar>::value,
|
||||||
|
PYBIND11_EIGEN_MESSAGE_POINTER_TYPES_ARE_NOT_SUPPORTED);
|
||||||
using props = EigenProps<Type>;
|
using props = EigenProps<Type>;
|
||||||
|
|
||||||
bool load(handle src, bool convert) {
|
bool load(handle src, bool convert) {
|
||||||
@ -405,6 +408,9 @@ private:
|
|||||||
// Base class for casting reference/map/block/etc. objects back to python.
|
// Base class for casting reference/map/block/etc. objects back to python.
|
||||||
template <typename MapType>
|
template <typename MapType>
|
||||||
struct eigen_map_caster {
|
struct eigen_map_caster {
|
||||||
|
static_assert(!std::is_pointer<typename MapType::Scalar>::value,
|
||||||
|
PYBIND11_EIGEN_MESSAGE_POINTER_TYPES_ARE_NOT_SUPPORTED);
|
||||||
|
|
||||||
private:
|
private:
|
||||||
using props = EigenProps<MapType>;
|
using props = EigenProps<MapType>;
|
||||||
|
|
||||||
@ -457,6 +463,8 @@ private:
|
|||||||
using Type = Eigen::Ref<PlainObjectType, 0, StrideType>;
|
using Type = Eigen::Ref<PlainObjectType, 0, StrideType>;
|
||||||
using props = EigenProps<Type>;
|
using props = EigenProps<Type>;
|
||||||
using Scalar = typename props::Scalar;
|
using Scalar = typename props::Scalar;
|
||||||
|
static_assert(!std::is_pointer<Scalar>::value,
|
||||||
|
PYBIND11_EIGEN_MESSAGE_POINTER_TYPES_ARE_NOT_SUPPORTED);
|
||||||
using MapType = Eigen::Map<PlainObjectType, 0, StrideType>;
|
using MapType = Eigen::Map<PlainObjectType, 0, StrideType>;
|
||||||
using Array
|
using Array
|
||||||
= array_t<Scalar,
|
= array_t<Scalar,
|
||||||
@ -604,6 +612,9 @@ private:
|
|||||||
// regular Eigen::Matrix, then casting that.
|
// regular Eigen::Matrix, then casting that.
|
||||||
template <typename Type>
|
template <typename Type>
|
||||||
struct type_caster<Type, enable_if_t<is_eigen_other<Type>::value>> {
|
struct type_caster<Type, enable_if_t<is_eigen_other<Type>::value>> {
|
||||||
|
static_assert(!std::is_pointer<typename Type::Scalar>::value,
|
||||||
|
PYBIND11_EIGEN_MESSAGE_POINTER_TYPES_ARE_NOT_SUPPORTED);
|
||||||
|
|
||||||
protected:
|
protected:
|
||||||
using Matrix
|
using Matrix
|
||||||
= Eigen::Matrix<typename Type::Scalar, Type::RowsAtCompileTime, Type::ColsAtCompileTime>;
|
= Eigen::Matrix<typename Type::Scalar, Type::RowsAtCompileTime, Type::ColsAtCompileTime>;
|
||||||
@ -632,6 +643,8 @@ public:
|
|||||||
template <typename Type>
|
template <typename Type>
|
||||||
struct type_caster<Type, enable_if_t<is_eigen_sparse<Type>::value>> {
|
struct type_caster<Type, enable_if_t<is_eigen_sparse<Type>::value>> {
|
||||||
using Scalar = typename Type::Scalar;
|
using Scalar = typename Type::Scalar;
|
||||||
|
static_assert(!std::is_pointer<Scalar>::value,
|
||||||
|
PYBIND11_EIGEN_MESSAGE_POINTER_TYPES_ARE_NOT_SUPPORTED);
|
||||||
using StorageIndex = remove_reference_t<decltype(*std::declval<Type>().outerIndexPtr())>;
|
using StorageIndex = remove_reference_t<decltype(*std::declval<Type>().outerIndexPtr())>;
|
||||||
using Index = typename Type::Index;
|
using Index = typename Type::Index;
|
||||||
static constexpr bool rowMajor = Type::IsRowMajor;
|
static constexpr bool rowMajor = Type::IsRowMajor;
|
||||||
|
@ -8,6 +8,7 @@
|
|||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
#include "../numpy.h"
|
#include "../numpy.h"
|
||||||
|
#include "common.h"
|
||||||
|
|
||||||
#if defined(__GNUC__) && !defined(__clang__) && !defined(__INTEL_COMPILER)
|
#if defined(__GNUC__) && !defined(__clang__) && !defined(__INTEL_COMPILER)
|
||||||
static_assert(__GNUC__ > 5, "Eigen Tensor support in pybind11 requires GCC > 5.0");
|
static_assert(__GNUC__ > 5, "Eigen Tensor support in pybind11 requires GCC > 5.0");
|
||||||
@ -164,6 +165,8 @@ PYBIND11_WARNING_POP
|
|||||||
|
|
||||||
template <typename Type>
|
template <typename Type>
|
||||||
struct type_caster<Type, typename eigen_tensor_helper<Type>::ValidType> {
|
struct type_caster<Type, typename eigen_tensor_helper<Type>::ValidType> {
|
||||||
|
static_assert(!std::is_pointer<typename Type::Scalar>::value,
|
||||||
|
PYBIND11_EIGEN_MESSAGE_POINTER_TYPES_ARE_NOT_SUPPORTED);
|
||||||
using Helper = eigen_tensor_helper<Type>;
|
using Helper = eigen_tensor_helper<Type>;
|
||||||
static constexpr auto temp_name = get_tensor_descriptor<Type, false>::value;
|
static constexpr auto temp_name = get_tensor_descriptor<Type, false>::value;
|
||||||
PYBIND11_TYPE_CASTER(Type, temp_name);
|
PYBIND11_TYPE_CASTER(Type, temp_name);
|
||||||
@ -359,6 +362,8 @@ struct get_storage_pointer_type<MapType, void_t<typename MapType::PointerArgType
|
|||||||
template <typename Type, int Options>
|
template <typename Type, int Options>
|
||||||
struct type_caster<Eigen::TensorMap<Type, Options>,
|
struct type_caster<Eigen::TensorMap<Type, Options>,
|
||||||
typename eigen_tensor_helper<remove_cv_t<Type>>::ValidType> {
|
typename eigen_tensor_helper<remove_cv_t<Type>>::ValidType> {
|
||||||
|
static_assert(!std::is_pointer<typename Type::Scalar>::value,
|
||||||
|
PYBIND11_EIGEN_MESSAGE_POINTER_TYPES_ARE_NOT_SUPPORTED);
|
||||||
using MapType = Eigen::TensorMap<Type, Options>;
|
using MapType = Eigen::TensorMap<Type, Options>;
|
||||||
using Helper = eigen_tensor_helper<remove_cv_t<Type>>;
|
using Helper = eigen_tensor_helper<remove_cv_t<Type>>;
|
||||||
|
|
||||||
|
@ -564,6 +564,8 @@ public:
|
|||||||
m_ptr = from_args(args).release().ptr();
|
m_ptr = from_args(args).release().ptr();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Return dtype for the given typenum (one of the NPY_TYPES).
|
||||||
|
/// https://numpy.org/devdocs/reference/c-api/array.html#c.PyArray_DescrFromType
|
||||||
explicit dtype(int typenum)
|
explicit dtype(int typenum)
|
||||||
: object(detail::npy_api::get().PyArray_DescrFromType_(typenum), stolen_t{}) {
|
: object(detail::npy_api::get().PyArray_DescrFromType_(typenum), stolen_t{}) {
|
||||||
if (m_ptr == nullptr) {
|
if (m_ptr == nullptr) {
|
||||||
@ -1283,12 +1285,16 @@ private:
|
|||||||
public:
|
public:
|
||||||
static constexpr int value = values[detail::is_fmt_numeric<T>::index];
|
static constexpr int value = values[detail::is_fmt_numeric<T>::index];
|
||||||
|
|
||||||
static pybind11::dtype dtype() {
|
static pybind11::dtype dtype() { return pybind11::dtype(/*typenum*/ value); }
|
||||||
if (auto *ptr = npy_api::get().PyArray_DescrFromType_(value)) {
|
};
|
||||||
return reinterpret_steal<pybind11::dtype>(ptr);
|
|
||||||
}
|
template <typename T>
|
||||||
pybind11_fail("Unsupported buffer format!");
|
struct npy_format_descriptor<T, enable_if_t<is_same_ignoring_cvref<T, PyObject *>::value>> {
|
||||||
}
|
static constexpr auto name = const_name("object");
|
||||||
|
|
||||||
|
static constexpr int value = npy_api::NPY_OBJECT_;
|
||||||
|
|
||||||
|
static pybind11::dtype dtype() { return pybind11::dtype(/*typenum*/ value); }
|
||||||
};
|
};
|
||||||
|
|
||||||
#define PYBIND11_DECL_CHAR_FMT \
|
#define PYBIND11_DECL_CHAR_FMT \
|
||||||
|
@ -57,6 +57,7 @@ detail_headers = {
|
|||||||
}
|
}
|
||||||
|
|
||||||
eigen_headers = {
|
eigen_headers = {
|
||||||
|
"include/pybind11/eigen/common.h",
|
||||||
"include/pybind11/eigen/matrix.h",
|
"include/pybind11/eigen/matrix.h",
|
||||||
"include/pybind11/eigen/tensor.h",
|
"include/pybind11/eigen/tensor.h",
|
||||||
}
|
}
|
||||||
|
@ -7,12 +7,47 @@
|
|||||||
BSD-style license that can be found in the LICENSE file.
|
BSD-style license that can be found in the LICENSE file.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
#include <pybind11/complex.h>
|
||||||
#include <pybind11/stl.h>
|
#include <pybind11/stl.h>
|
||||||
|
|
||||||
#include "constructor_stats.h"
|
#include "constructor_stats.h"
|
||||||
#include "pybind11_tests.h"
|
#include "pybind11_tests.h"
|
||||||
|
|
||||||
TEST_SUBMODULE(buffers, m) {
|
TEST_SUBMODULE(buffers, m) {
|
||||||
|
m.attr("long_double_and_double_have_same_size") = (sizeof(long double) == sizeof(double));
|
||||||
|
|
||||||
|
m.def("format_descriptor_format_buffer_info_equiv",
|
||||||
|
[](const std::string &cpp_name, const py::buffer &buffer) {
|
||||||
|
// https://google.github.io/styleguide/cppguide.html#Static_and_Global_Variables
|
||||||
|
static auto *format_table = new std::map<std::string, std::string>;
|
||||||
|
static auto *equiv_table
|
||||||
|
= new std::map<std::string, bool (py::buffer_info::*)() const>;
|
||||||
|
if (format_table->empty()) {
|
||||||
|
#define PYBIND11_ASSIGN_HELPER(...) \
|
||||||
|
(*format_table)[#__VA_ARGS__] = py::format_descriptor<__VA_ARGS__>::format(); \
|
||||||
|
(*equiv_table)[#__VA_ARGS__] = &py::buffer_info::item_type_is_equivalent_to<__VA_ARGS__>;
|
||||||
|
PYBIND11_ASSIGN_HELPER(PyObject *)
|
||||||
|
PYBIND11_ASSIGN_HELPER(bool)
|
||||||
|
PYBIND11_ASSIGN_HELPER(std::int8_t)
|
||||||
|
PYBIND11_ASSIGN_HELPER(std::uint8_t)
|
||||||
|
PYBIND11_ASSIGN_HELPER(std::int16_t)
|
||||||
|
PYBIND11_ASSIGN_HELPER(std::uint16_t)
|
||||||
|
PYBIND11_ASSIGN_HELPER(std::int32_t)
|
||||||
|
PYBIND11_ASSIGN_HELPER(std::uint32_t)
|
||||||
|
PYBIND11_ASSIGN_HELPER(std::int64_t)
|
||||||
|
PYBIND11_ASSIGN_HELPER(std::uint64_t)
|
||||||
|
PYBIND11_ASSIGN_HELPER(float)
|
||||||
|
PYBIND11_ASSIGN_HELPER(double)
|
||||||
|
PYBIND11_ASSIGN_HELPER(long double)
|
||||||
|
PYBIND11_ASSIGN_HELPER(std::complex<float>)
|
||||||
|
PYBIND11_ASSIGN_HELPER(std::complex<double>)
|
||||||
|
PYBIND11_ASSIGN_HELPER(std::complex<long double>)
|
||||||
|
#undef PYBIND11_ASSIGN_HELPER
|
||||||
|
}
|
||||||
|
return std::pair<std::string, bool>(
|
||||||
|
(*format_table)[cpp_name], (buffer.request().*((*equiv_table)[cpp_name]))());
|
||||||
|
});
|
||||||
|
|
||||||
// test_from_python / test_to_python:
|
// test_from_python / test_to_python:
|
||||||
class Matrix {
|
class Matrix {
|
||||||
public:
|
public:
|
||||||
|
@ -10,6 +10,63 @@ from pybind11_tests import buffers as m
|
|||||||
|
|
||||||
np = pytest.importorskip("numpy")
|
np = pytest.importorskip("numpy")
|
||||||
|
|
||||||
|
if m.long_double_and_double_have_same_size:
|
||||||
|
# Determined by the compiler used to build the pybind11 tests
|
||||||
|
# (e.g. MSVC gets here, but MinGW might not).
|
||||||
|
np_float128 = None
|
||||||
|
np_complex256 = None
|
||||||
|
else:
|
||||||
|
# Determined by the compiler used to build numpy (e.g. MinGW).
|
||||||
|
np_float128 = getattr(np, *["float128"] * 2)
|
||||||
|
np_complex256 = getattr(np, *["complex256"] * 2)
|
||||||
|
|
||||||
|
CPP_NAME_FORMAT_NP_DTYPE_TABLE = [
|
||||||
|
("PyObject *", "O", object),
|
||||||
|
("bool", "?", np.bool_),
|
||||||
|
("std::int8_t", "b", np.int8),
|
||||||
|
("std::uint8_t", "B", np.uint8),
|
||||||
|
("std::int16_t", "h", np.int16),
|
||||||
|
("std::uint16_t", "H", np.uint16),
|
||||||
|
("std::int32_t", "i", np.int32),
|
||||||
|
("std::uint32_t", "I", np.uint32),
|
||||||
|
("std::int64_t", "q", np.int64),
|
||||||
|
("std::uint64_t", "Q", np.uint64),
|
||||||
|
("float", "f", np.float32),
|
||||||
|
("double", "d", np.float64),
|
||||||
|
("long double", "g", np_float128),
|
||||||
|
("std::complex<float>", "Zf", np.complex64),
|
||||||
|
("std::complex<double>", "Zd", np.complex128),
|
||||||
|
("std::complex<long double>", "Zg", np_complex256),
|
||||||
|
]
|
||||||
|
CPP_NAME_FORMAT_TABLE = [
|
||||||
|
(cpp_name, format)
|
||||||
|
for cpp_name, format, np_dtype in CPP_NAME_FORMAT_NP_DTYPE_TABLE
|
||||||
|
if np_dtype is not None
|
||||||
|
]
|
||||||
|
CPP_NAME_NP_DTYPE_TABLE = [
|
||||||
|
(cpp_name, np_dtype) for cpp_name, _, np_dtype in CPP_NAME_FORMAT_NP_DTYPE_TABLE
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(("cpp_name", "np_dtype"), CPP_NAME_NP_DTYPE_TABLE)
|
||||||
|
def test_format_descriptor_format_buffer_info_equiv(cpp_name, np_dtype):
|
||||||
|
if np_dtype is None:
|
||||||
|
pytest.skip(
|
||||||
|
f"cpp_name=`{cpp_name}`: `long double` and `double` have same size."
|
||||||
|
)
|
||||||
|
if isinstance(np_dtype, str):
|
||||||
|
pytest.skip(f"np.{np_dtype} does not exist.")
|
||||||
|
np_array = np.array([], dtype=np_dtype)
|
||||||
|
for other_cpp_name, expected_format in CPP_NAME_FORMAT_TABLE:
|
||||||
|
format, np_array_is_matching = m.format_descriptor_format_buffer_info_equiv(
|
||||||
|
other_cpp_name, np_array
|
||||||
|
)
|
||||||
|
assert format == expected_format
|
||||||
|
if other_cpp_name == cpp_name:
|
||||||
|
assert np_array_is_matching
|
||||||
|
else:
|
||||||
|
assert not np_array_is_matching
|
||||||
|
|
||||||
|
|
||||||
def test_from_python():
|
def test_from_python():
|
||||||
with pytest.raises(RuntimeError) as excinfo:
|
with pytest.raises(RuntimeError) as excinfo:
|
||||||
|
@ -523,4 +523,30 @@ TEST_SUBMODULE(numpy_array, sm) {
|
|||||||
sm.def("test_fmt_desc_const_double", [](const py::array_t<const double> &) {});
|
sm.def("test_fmt_desc_const_double", [](const py::array_t<const double> &) {});
|
||||||
|
|
||||||
sm.def("round_trip_float", [](double d) { return d; });
|
sm.def("round_trip_float", [](double d) { return d; });
|
||||||
|
|
||||||
|
sm.def("pass_array_pyobject_ptr_return_sum_str_values",
|
||||||
|
[](const py::array_t<PyObject *> &objs) {
|
||||||
|
std::string sum_str_values;
|
||||||
|
for (const auto &obj : objs) {
|
||||||
|
sum_str_values += py::str(obj.attr("value"));
|
||||||
|
}
|
||||||
|
return sum_str_values;
|
||||||
|
});
|
||||||
|
|
||||||
|
sm.def("pass_array_pyobject_ptr_return_as_list",
|
||||||
|
[](const py::array_t<PyObject *> &objs) -> py::list { return objs; });
|
||||||
|
|
||||||
|
sm.def("return_array_pyobject_ptr_cpp_loop", [](const py::list &objs) {
|
||||||
|
py::size_t arr_size = py::len(objs);
|
||||||
|
py::array_t<PyObject *> arr_from_list(static_cast<py::ssize_t>(arr_size));
|
||||||
|
PyObject **data = arr_from_list.mutable_data();
|
||||||
|
for (py::size_t i = 0; i < arr_size; i++) {
|
||||||
|
assert(data[i] == nullptr);
|
||||||
|
data[i] = py::cast<PyObject *>(objs[i].attr("value"));
|
||||||
|
}
|
||||||
|
return arr_from_list;
|
||||||
|
});
|
||||||
|
|
||||||
|
sm.def("return_array_pyobject_ptr_from_list",
|
||||||
|
[](const py::list &objs) -> py::array_t<PyObject *> { return objs; });
|
||||||
}
|
}
|
||||||
|
@ -595,3 +595,74 @@ def test_round_trip_float():
|
|||||||
arr = np.zeros((), np.float64)
|
arr = np.zeros((), np.float64)
|
||||||
arr[()] = 37.2
|
arr[()] = 37.2
|
||||||
assert m.round_trip_float(arr) == 37.2
|
assert m.round_trip_float(arr) == 37.2
|
||||||
|
|
||||||
|
|
||||||
|
# HINT: An easy and robust way (although only manual unfortunately) to check for
|
||||||
|
# ref-count leaks in the test_.*pyobject_ptr.* functions below is to
|
||||||
|
# * temporarily insert `while True:` (one-by-one),
|
||||||
|
# * run this test, and
|
||||||
|
# * run the Linux `top` command in another shell to visually monitor
|
||||||
|
# `RES` for a minute or two.
|
||||||
|
# If there is a leak, it is usually evident in seconds because the `RES`
|
||||||
|
# value increases without bounds. (Don't forget to Ctrl-C the test!)
|
||||||
|
|
||||||
|
|
||||||
|
# For use as a temporary user-defined object, to maximize sensitivity of the tests below:
|
||||||
|
# * Ref-count leaks will be immediately evident.
|
||||||
|
# * Sanitizers are much more likely to detect heap-use-after-free due to
|
||||||
|
# other ref-count bugs.
|
||||||
|
class PyValueHolder:
|
||||||
|
def __init__(self, value):
|
||||||
|
self.value = value
|
||||||
|
|
||||||
|
|
||||||
|
def WrapWithPyValueHolder(*values):
|
||||||
|
return [PyValueHolder(v) for v in values]
|
||||||
|
|
||||||
|
|
||||||
|
def UnwrapPyValueHolder(vhs):
|
||||||
|
return [vh.value for vh in vhs]
|
||||||
|
|
||||||
|
|
||||||
|
def test_pass_array_pyobject_ptr_return_sum_str_values_ndarray():
|
||||||
|
# Intentionally all temporaries, do not change.
|
||||||
|
assert (
|
||||||
|
m.pass_array_pyobject_ptr_return_sum_str_values(
|
||||||
|
np.array(WrapWithPyValueHolder(-3, "four", 5.0), dtype=object)
|
||||||
|
)
|
||||||
|
== "-3four5.0"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_pass_array_pyobject_ptr_return_sum_str_values_list():
|
||||||
|
# Intentionally all temporaries, do not change.
|
||||||
|
assert (
|
||||||
|
m.pass_array_pyobject_ptr_return_sum_str_values(
|
||||||
|
WrapWithPyValueHolder(2, "three", -4.0)
|
||||||
|
)
|
||||||
|
== "2three-4.0"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_pass_array_pyobject_ptr_return_as_list():
|
||||||
|
# Intentionally all temporaries, do not change.
|
||||||
|
assert UnwrapPyValueHolder(
|
||||||
|
m.pass_array_pyobject_ptr_return_as_list(
|
||||||
|
np.array(WrapWithPyValueHolder(-1, "two", 3.0), dtype=object)
|
||||||
|
)
|
||||||
|
) == [-1, "two", 3.0]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("return_array_pyobject_ptr", "unwrap"),
|
||||||
|
[
|
||||||
|
(m.return_array_pyobject_ptr_cpp_loop, list),
|
||||||
|
(m.return_array_pyobject_ptr_from_list, UnwrapPyValueHolder),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_return_array_pyobject_ptr_cpp_loop(return_array_pyobject_ptr, unwrap):
|
||||||
|
# Intentionally all temporaries, do not change.
|
||||||
|
arr_from_list = return_array_pyobject_ptr(WrapWithPyValueHolder(6, "seven", -8.0))
|
||||||
|
assert isinstance(arr_from_list, np.ndarray)
|
||||||
|
assert arr_from_list.dtype == np.dtype("O")
|
||||||
|
assert unwrap(arr_from_list) == [6, "seven", -8.0]
|
||||||
|
Loading…
Reference in New Issue
Block a user