Factor out pybind11/compat/pybind11_conduit_v1.h

Author: rwgk

CMakeLists.txt

@@ -142,6 +142,7 @@ set(PYBIND11_HEADERS
     include/pybind11/cast.h
     include/pybind11/chrono.h
     include/pybind11/common.h
+    include/pybind11/compat/pybind11_conduit_v1.h
     include/pybind11/compat/pybind11_platform_abi_id.h
     include/pybind11/compat/wrap_include_python_h.h
     include/pybind11/complex.h

include/pybind11/compat/pybind11_conduit_v1.h

@@ -0,0 +1,46 @@
+// Copyright (c) 2024 The pybind Community.
+
+// THIS MUST STAY AT THE TOP!
+#include "pybind11_platform_abi_id.h"
+
+#include <Python.h>
+#include <typeinfo>
+
+namespace pybind11_conduit_v1 {
+
+inline void *get_raw_pointer_ephemeral(PyObject *py_obj, const std::type_info *cpp_type_info) {
+    PyObject *cpp_type_info_capsule
+        = PyCapsule_New(const_cast<void *>(static_cast<const void *>(cpp_type_info)),
+                        typeid(std::type_info).name(),
+                        nullptr);
+    if (cpp_type_info_capsule == nullptr) {
+        return nullptr;
+    }
+    PyObject *cpp_conduit = PyObject_CallMethod(py_obj,
+                                                "_pybind11_conduit_v1_",
+                                                "yOy",
+                                                PYBIND11_PLATFORM_ABI_ID,
+                                                cpp_type_info_capsule,
+                                                "raw_pointer_ephemeral");
+    Py_DECREF(cpp_type_info_capsule);
+    if (cpp_conduit == nullptr) {
+        return nullptr;
+    }
+    void *raw_ptr = PyCapsule_GetPointer(cpp_conduit, cpp_type_info->name());
+    Py_DECREF(cpp_conduit);
+    if (PyErr_Occurred()) {
+        return nullptr;
+    }
+    return raw_ptr;
+}
+
+template <typename T>
+T *get_type_pointer_ephemeral(PyObject *py_obj) {
+    void *raw_ptr = get_raw_pointer_ephemeral(py_obj, &typeid(T));
+    if (raw_ptr == nullptr) {
+        return nullptr;
+    }
+    return static_cast<T *>(raw_ptr);
+}
+
+} // namespace pybind11_conduit_v1

tests/exo_planet_c_api.cpp

@@ -1,63 +1,26 @@
 // Copyright (c) 2024 The pybind Community.
 
 // THIS MUST STAY AT THE TOP!
-#include <pybind11/compat/pybind11_platform_abi_id.h>
+#include <pybind11/compat/pybind11_conduit_v1.h> // VERY light-weight dependency.
 
 #include "test_cpp_conduit_traveler_types.h"
 
 #include <Python.h>
-#include <typeinfo>
 
 namespace {
 
-void *get_cpp_conduit_void_ptr(PyObject *py_obj, const std::type_info *cpp_type_info) {
-    PyObject *cpp_type_info_capsule
-        = PyCapsule_New(const_cast<void *>(static_cast<const void *>(cpp_type_info)),
-                        typeid(std::type_info).name(),
-                        nullptr);
-    if (cpp_type_info_capsule == nullptr) {
-        return nullptr;
-    }
-    PyObject *cpp_conduit = PyObject_CallMethod(py_obj,
-                                                "_pybind11_conduit_v1_",
-                                                "yOy",
-                                                PYBIND11_PLATFORM_ABI_ID,
-                                                cpp_type_info_capsule,
-                                                "raw_pointer_ephemeral");
-    Py_DECREF(cpp_type_info_capsule);
-    if (cpp_conduit == nullptr) {
-        return nullptr;
-    }
-    void *void_ptr = PyCapsule_GetPointer(cpp_conduit, cpp_type_info->name());
-    Py_DECREF(cpp_conduit);
-    if (PyErr_Occurred()) {
-        return nullptr;
-    }
-    return void_ptr;
-}
-
-template <typename T>
-T *get_cpp_conduit_type_ptr(PyObject *py_obj) {
-    void *void_ptr = get_cpp_conduit_void_ptr(py_obj, &typeid(T));
-    if (void_ptr == nullptr) {
-        return nullptr;
-    }
-    return static_cast<T *>(void_ptr);
-}
-
 extern "C" PyObject *wrapGetLuggage(PyObject * /*self*/, PyObject *traveler) {
-    const auto *cpp_traveler
-        = get_cpp_conduit_type_ptr<pybind11_tests::test_cpp_conduit::Traveler>(traveler);
+    const auto *cpp_traveler = pybind11_conduit_v1::get_type_pointer_ephemeral<
+        pybind11_tests::test_cpp_conduit::Traveler>(traveler);
     if (cpp_traveler == nullptr) {
         return nullptr;
     }
     return PyUnicode_FromString(cpp_traveler->luggage.c_str());
 }
 
 extern "C" PyObject *wrapGetPoints(PyObject * /*self*/, PyObject *premium_traveler) {
-    const auto *cpp_premium_traveler
-        = get_cpp_conduit_type_ptr<pybind11_tests::test_cpp_conduit::PremiumTraveler>(
-            premium_traveler);
+    const auto *cpp_premium_traveler = pybind11_conduit_v1::get_type_pointer_ephemeral<
+        pybind11_tests::test_cpp_conduit::PremiumTraveler>(premium_traveler);
     if (cpp_premium_traveler == nullptr) {
         return nullptr;
     }

tests/extra_python_package/test_files.py

@@ -51,6 +51,7 @@
 }
 
 compat_headers = {
+    "include/pybind11/compat/pybind11_conduit_v1.h",
     "include/pybind11/compat/pybind11_platform_abi_id.h",
     "include/pybind11/compat/wrap_include_python_h.h",
 }