Merge branch 'master' into sh_merge_master

.github/workflows/ci.yml

@@ -271,7 +271,7 @@ jobs:
  - uses: actions/checkout@v4
 
  - name: Setup Python ${{ matrix.python-version }} (deadsnakes)
- uses: deadsnakes/action@v3.1.0
+ uses: deadsnakes/action@v3.2.0
  with:
  python-version: ${{ matrix.python-version }}
  debug: ${{ matrix.python-debug }}

.github/workflows/pip.yml

@@ -103,7 +103,7 @@ jobs:
  - uses: actions/download-artifact@v4
 
  - name: Generate artifact attestation for sdist and wheel
- uses: actions/attest-build-provenance@6149ea5740be74af77f260b9db67e633f6b0a9a1 # v1.4.2
+ uses: actions/attest-build-provenance@1c608d11d69870c2092266b3f9a6f3abbf17002c # v1.4.3
  with:
  subject-path: "*/pybind11*"
 

.pre-commit-config.yaml

@@ -32,15 +32,15 @@ repos:
 
 # Ruff, the Python auto-correcting linter/formatter written in Rust
 - repo: https://github.com/astral-sh/ruff-pre-commit
- rev: v0.5.6
+ rev: v0.6.3
  hooks:
  - id: ruff
  args: ["--fix", "--show-fixes"]
  - id: ruff-format
 
 # Check static types with mypy
 - repo: https://github.com/pre-commit/mirrors-mypy
- rev: "v1.11.1"
+ rev: "v1.11.2"
  hooks:
  - id: mypy
  args: []
@@ -95,7 +95,7 @@ repos:
 
 # Avoid directional quotes
 - repo: https://github.com/sirosen/texthooks
- rev: "0.6.6"
+ rev: "0.6.7"
  hooks:
  - id: fix-ligatures
  - id: fix-smartquotes
@@ -144,14 +144,14 @@ repos:
 
 # PyLint has native support - not always usable, but works for us
 - repo: https://github.com/PyCQA/pylint
- rev: "v3.2.6"
+ rev: "v3.2.7"
  hooks:
  - id: pylint
  files: ^pybind11
 
 # Check schemas on some of our YAML files
 - repo: https://github.com/python-jsonschema/check-jsonschema
- rev: 0.29.1
+ rev: 0.29.2
  hooks:
  - id: check-readthedocs
  - id: check-github-workflows

CMakeLists.txt

@@ -129,6 +129,7 @@ endif()
 set(PYBIND11_HEADERS
  include/pybind11/detail/class.h
  include/pybind11/detail/common.h
+ include/pybind11/detail/cpp_conduit.h
  include/pybind11/detail/descr.h
  include/pybind11/detail/dynamic_raw_ptr_cast_if_possible.h
  include/pybind11/detail/init.h

include/pybind11/detail/cpp_conduit.h

@@ -0,0 +1,77 @@
+// Copyright (c) 2024 The pybind Community.
+
+#pragma once
+
+#include <pybind11/pytypes.h>
+
+#include "common.h"
+#include "internals.h"
+
+#include <typeinfo>
+
+PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE)
+PYBIND11_NAMESPACE_BEGIN(detail)
+
+// Forward declaration needed here: Refactoring opportunity.
+extern "C" inline PyObject *pybind11_object_new(PyTypeObject *type, PyObject *, PyObject *);
+
+inline bool type_is_managed_by_our_internals(PyTypeObject *type_obj) {
+#if defined(PYPY_VERSION)
+ auto &internals = get_internals();
+ return bool(internals.registered_types_py.find(type_obj)
+ != internals.registered_types_py.end());
+#else
+ return bool(type_obj->tp_new == pybind11_object_new);
+#endif
+}
+
+inline bool is_instance_method_of_type(PyTypeObject *type_obj, PyObject *attr_name) {
+ PyObject *descr = _PyType_Lookup(type_obj, attr_name);
+ return bool((descr != nullptr) && PyInstanceMethod_Check(descr));
+}
+
+inline object try_get_cpp_conduit_method(PyObject *obj) {
+ if (PyType_Check(obj)) {
+ return object();
+ }
+ PyTypeObject *type_obj = Py_TYPE(obj);
+ str attr_name("_pybind11_conduit_v1_");
+ bool assumed_to_be_callable = false;
+ if (type_is_managed_by_our_internals(type_obj)) {
+ if (!is_instance_method_of_type(type_obj, attr_name.ptr())) {
+ return object();
+ }
+ assumed_to_be_callable = true;
+ }
+ PyObject *method = PyObject_GetAttr(obj, attr_name.ptr());
+ if (method == nullptr) {
+ PyErr_Clear();
+ return object();
+ }
+ if (!assumed_to_be_callable && PyCallable_Check(method) == 0) {
+ Py_DECREF(method);
+ return object();
+ }
+ return reinterpret_steal<object>(method);
+}
+
+inline void *try_raw_pointer_ephemeral_from_cpp_conduit(handle src,
+ const std::type_info *cpp_type_info) {
+ object method = try_get_cpp_conduit_method(src.ptr());
+ if (method) {
+ capsule cpp_type_info_capsule(const_cast<void *>(static_cast<const void *>(cpp_type_info)),
+ typeid(std::type_info).name());
+ object cpp_conduit = method(bytes(PYBIND11_PLATFORM_ABI_ID),
+ cpp_type_info_capsule,
+ bytes("raw_pointer_ephemeral"));
+ if (isinstance<capsule>(cpp_conduit)) {
+ return reinterpret_borrow<capsule>(cpp_conduit).get_pointer();
+ }
+ }
+ return nullptr;
+}
+
+#define PYBIND11_HAS_CPP_CONDUIT 1
+
+PYBIND11_NAMESPACE_END(detail)
+PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE)

include/pybind11/detail/internals.h

@@ -347,15 +347,17 @@ struct type_info {
 # define PYBIND11_INTERNALS_KIND ""
 #endif
 
+#define PYBIND11_PLATFORM_ABI_ID \
+ PYBIND11_INTERNALS_KIND PYBIND11_COMPILER_TYPE PYBIND11_STDLIB PYBIND11_BUILD_ABI \
+ PYBIND11_BUILD_TYPE
+
 #define PYBIND11_INTERNALS_ID \
  "__pybind11_internals_v" PYBIND11_TOSTRING(PYBIND11_INTERNALS_VERSION) \
- PYBIND11_INTERNALS_KIND PYBIND11_COMPILER_TYPE PYBIND11_STDLIB \
- PYBIND11_BUILD_ABI PYBIND11_BUILD_TYPE "__"
+ PYBIND11_PLATFORM_ABI_ID "__"
 
 #define PYBIND11_MODULE_LOCAL_ID \
  "__pybind11_module_local_v" PYBIND11_TOSTRING(PYBIND11_INTERNALS_VERSION) \
- PYBIND11_INTERNALS_KIND PYBIND11_COMPILER_TYPE PYBIND11_STDLIB \
- PYBIND11_BUILD_ABI PYBIND11_BUILD_TYPE "__"
+ PYBIND11_PLATFORM_ABI_ID "__"
 
 /// Each module locally stores a pointer to the `internals` data. The data
 /// itself is shared among modules with the same `PYBIND11_INTERNALS_ID`.

include/pybind11/detail/type_caster_base.h

@@ -14,6 +14,7 @@
 #include <pybind11/trampoline_self_life_support.h>
 
 #include "common.h"
+#include "cpp_conduit.h"
 #include "descr.h"
 #include "dynamic_raw_ptr_cast_if_possible.h"
 #include "internals.h"
@@ -22,8 +23,10 @@
 #include "value_and_holder.h"
 
 #include <cstdint>
+#include <cstring>
 #include <iterator>
 #include <new>
+#include <stdexcept>
 #include <string>
 #include <type_traits>
 #include <typeindex>
@@ -985,6 +988,13 @@ class type_caster_generic {
  }
  return false;
  }
+ bool try_cpp_conduit(handle src) {
+ value = try_raw_pointer_ephemeral_from_cpp_conduit(src, cpptype);
+ if (value != nullptr) {
+ return true;
+ }
+ return false;
+ }
  void check_holder_compat() {}
 
  PYBIND11_NOINLINE static void *local_load(PyObject *src, const type_info *ti) {
@@ -1116,6 +1126,10 @@ class type_caster_generic {
  return true;
  }
 
+ if (convert && cpptype && this_.try_cpp_conduit(src)) {
+ return true;
+ }
+
  return false;
  }
 
@@ -1143,6 +1157,32 @@ class type_caster_generic {
  void *value = nullptr;
 };
 
+inline object cpp_conduit_method(handle self,
+ const bytes &pybind11_platform_abi_id,
+ const capsule &cpp_type_info_capsule,
+ const bytes &pointer_kind) {
+#ifdef PYBIND11_HAS_STRING_VIEW
+ using cpp_str = std::string_view;
+#else
+ using cpp_str = std::string;
+#endif
+ if (cpp_str(pybind11_platform_abi_id) != PYBIND11_PLATFORM_ABI_ID) {
+ return none();
+ }
+ if (std::strcmp(cpp_type_info_capsule.name(), typeid(std::type_info).name()) != 0) {
+ return none();
+ }
+ if (cpp_str(pointer_kind) != "raw_pointer_ephemeral") {
+ throw std::runtime_error("Invalid pointer_kind: \"" + std::string(pointer_kind) + "\"");
+ }
+ const auto *cpp_type_info = cpp_type_info_capsule.get_pointer<const std::type_info>();
+ type_caster_generic caster(*cpp_type_info);
+ if (!caster.load(self, false)) {
+ return none();
+ }
+ return capsule(caster.value, cpp_type_info->name());
+}
+
 /**
  * Determine suitable casting operator for pointer-or-lvalue-casting type casters. The type caster
  * needs to provide `operator T*()` and `operator T&()` operators.

include/pybind11/pybind11.h

@@ -594,7 +594,8 @@ class cpp_function : public function {
  int index = 0;
  /* Create a nice pydoc rec including all signatures and
  docstrings of the functions in the overload chain */
- if (chain && options::show_function_signatures()) {
+ if (chain && options::show_function_signatures()
+ && std::strcmp(rec->name, "_pybind11_conduit_v1_") != 0) {
  // First a generic signature
  signatures += rec->name;
  signatures += "(*args, **kwargs)\n";
@@ -603,7 +604,8 @@ class cpp_function : public function {
  // Then specific overload signatures
  bool first_user_def = true;
  for (auto *it = chain_start; it != nullptr; it = it->next) {
- if (options::show_function_signatures()) {
+ if (options::show_function_signatures()
+ && std::strcmp(rec->name, "_pybind11_conduit_v1_") != 0) {
  if (index > 0) {
  signatures += '\n';
  }
@@ -1859,6 +1861,7 @@ class class_ : public detail::generic_type {
  = instances[std::type_index(typeid(type))];
  });
  }
+ def("_pybind11_conduit_v1_", cpp_conduit_method);
  }
 
  template <typename Base, detail::enable_if_t<is_base<Base>::value, int> = 0>

tests/CMakeLists.txt

@@ -135,6 +135,7 @@ set(PYBIND11_TEST_FILES
  test_const_name
  test_constants_and_functions
  test_copy_move
+ test_cpp_conduit
  test_custom_type_casters
  test_custom_type_setup
  test_docstring_options
@@ -235,6 +236,8 @@ tests_extra_targets("test_exceptions.py;test_local_bindings.py;test_stl.py;test_
 # And add additional targets for other tests.
 tests_extra_targets("test_exceptions.py" "cross_module_interleaved_error_already_set")
 tests_extra_targets("test_gil_scoped.py" "cross_module_gil_utils")
+tests_extra_targets("test_cpp_conduit.py"
+ "exo_planet_pybind11;exo_planet_c_api;home_planet_very_lonely_traveler")
 
 set(PYBIND11_EIGEN_REPO
  "https://gitlab.com/libeigen/eigen.git"

tests/conftest.py

@@ -136,7 +136,7 @@ def stderr(self):
  return Output(self.err)
 
 
-@pytest.fixture()
+@pytest.fixture
 def capture(capsys):
  """Extended `capsys` with context manager and custom equality operators"""
  return Capture(capsys)
@@ -172,7 +172,7 @@ def _sanitize_docstring(thing):
  return _sanitize_general(s)
 
 
-@pytest.fixture()
+@pytest.fixture
 def doc():
  """Sanitize docstrings and add custom failure explanation"""
  return SanitizedString(_sanitize_docstring)
@@ -184,7 +184,7 @@ def _sanitize_message(thing):
  return _hexadecimal.sub("0", s)
 
 
-@pytest.fixture()
+@pytest.fixture
 def msg():
  """Sanitize messages and add custom failure explanation"""
  return SanitizedString(_sanitize_message)