Merge branch 'master' into stl-typing

Author: timohl

.github/workflows/ci.yml

@@ -30,11 +30,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        runs-on: [ubuntu-20.04, windows-2022, macos-13]
+        runs-on: [ubuntu-22.04, windows-2022, macos-13]
         python:
         - '3.8'
-        - '3.9'
-        - '3.12'
         - '3.13'
         - 'pypy-3.10'
         - 'pypy-3.11'
@@ -47,28 +45,28 @@ jobs:
         # We support an optional key: args, for cmake args
         include:
           # Just add a key
-          - runs-on: ubuntu-20.04
+          - runs-on: ubuntu-22.04
             python: '3.8'
             args: >
               -DPYBIND11_FINDPYTHON=OFF
               -DCMAKE_CXX_FLAGS="-D_=1"
               -DPYBIND11_NUMPY_1_ONLY=ON
             exercise_D_: 1
-          - runs-on: windows-2019
+          - runs-on: windows-2022
             python: '3.8'
             args: >
               -DPYBIND11_FINDPYTHON=OFF
-          # Inject a couple Windows 2019 runs
+          # Inject a Windows 2019 run
           - runs-on: windows-2019
             python: '3.9'
           # Inject a few runs with different runtime libraries
           - runs-on: windows-2022
-            python: '3.9'
+            python: '3.8'
             args: >
               -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded
               -DPYBIND11_NUMPY_1_ONLY=ON
           - runs-on: windows-2022
-            python: '3.10'
+            python: '3.9'
             args: >
               -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreadedDLL
           # This needs a python built with MTd
@@ -77,28 +75,25 @@ jobs:
           #   args: >
           #     -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreadedDebug
           - runs-on: windows-2022
-            python: '3.12'
+            python: '3.13'
             args: >
               -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreadedDebugDLL
-          # Extra ubuntu latest job
-          - runs-on: ubuntu-latest
-            python: '3.11'
           # Run tests with py::smart_holder as the default holder
           # with recent (or ideally latest) released Python version.
           - runs-on: ubuntu-latest
             python: '3.12'
             args: >
               -DCMAKE_CXX_FLAGS="-DPYBIND11_RUN_TESTING_WITH_SMART_HOLDER_AS_DEFAULT_BUT_NEVER_USE_IN_PRODUCTION_PLEASE"
           - runs-on: macos-13
-            python: '3.12'
+            python: '3.11'
             args: >
               -DCMAKE_CXX_FLAGS="-DPYBIND11_RUN_TESTING_WITH_SMART_HOLDER_AS_DEFAULT_BUT_NEVER_USE_IN_PRODUCTION_PLEASE"
           - runs-on: windows-2022
-            python: '3.12'
+            python: '3.10'
             args: >
               -DCMAKE_CXX_FLAGS="/DPYBIND11_RUN_TESTING_WITH_SMART_HOLDER_AS_DEFAULT_BUT_NEVER_USE_IN_PRODUCTION_PLEASE /GR /EHsc"
-          - python: 'graalpy-24.1'
-            runs-on: 'ubuntu-latest'
+          - runs-on: 'ubuntu-latest'
+            python: 'graalpy-24.1'
         exclude:
           # The setup-python action currently doesn't have graalpy for windows
           # See https://github.com/actions/setup-python/pull/880
@@ -182,7 +177,7 @@ jobs:
     # More-or-less randomly adding -DPYBIND11_SIMPLE_GIL_MANAGEMENT=OFF here.
     - name: Configure C++17
       run: >
-        cmake -S . -B build2
+        cmake -S . -B build2 -Werror=dev
         -DPYBIND11_WERROR=ON
         -DPYBIND11_SIMPLE_GIL_MANAGEMENT=OFF
         -DPYBIND11_PYTEST_ARGS=-v
@@ -200,24 +195,6 @@ jobs:
     - name: C++ tests
       run: cmake --build build2 --target cpptest
 
-    # Third build - C++17 mode with unstable ABI
-    - name: Configure (unstable ABI)
-      run: >
-        cmake -S . -B build3
-        -DPYBIND11_WERROR=ON
-        -DPYBIND11_PYTEST_ARGS=-v
-        -DDOWNLOAD_CATCH=ON
-        -DDOWNLOAD_EIGEN=ON
-        -DCMAKE_CXX_STANDARD=17
-        -DPYBIND11_INTERNALS_VERSION=10000000
-        ${{ matrix.args }}
-
-    - name: Build (unstable ABI)
-      run: cmake --build build3 -j 2
-
-    - name: Python tests (unstable ABI)
-      run: cmake --build build3 --target pytest
-
     - name: Interface test
       run: cmake --build build2 --target test_cmake_build
 
@@ -273,7 +250,7 @@ jobs:
           python-debug: false
 
     name: "🐍 ${{ matrix.python-version }}${{ matrix.python-debug && '-dbg' || '' }} (deadsnakes)${{ matrix.valgrind && ' • Valgrind' || '' }} • x64"
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v4
@@ -346,28 +323,16 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        container_suffix:
-          - ""
         include:
           - clang: 5
             std: 14
           - clang: 11
             std: 20
-          - clang: 12
-            std: 20
-          - clang: 13
-            std: 20
           - clang: 14
             std: 20
-          - clang: 15
-            std: 20
-            container_suffix: "-bullseye"
           - clang: 16
             std: 20
             container_suffix: "-bullseye"
-          - clang: 17
-            std: 20
-            container_suffix: "-bookworm"
           - clang: 18
             std: 20
             container_suffix: "-bookworm"
@@ -531,8 +496,6 @@ jobs:
           - { gcc: 9, std: 20 }
           - { gcc: 10, std: 17 }
           - { gcc: 10, std: 20 }
-          - { gcc: 11, std: 20 }
-          - { gcc: 12, std: 20 }
           - { gcc: 13, std: 20 }
 
     name: "🐍 3 • GCC ${{ matrix.gcc }} • C++${{ matrix.std }}• x64"
@@ -831,20 +794,12 @@ jobs:
       matrix:
         python:
         - '3.8'
-        - '3.9'
         - '3.10'
-        - '3.11'
-        - '3.12'
+        - '3.13'
 
         include:
-          - python: '3.12'
-            args: -DCMAKE_CXX_STANDARD=20
-          - python: '3.11'
-            args: -DCMAKE_CXX_STANDARD=20
           - python: '3.10'
             args: -DCMAKE_CXX_STANDARD=20
-          - python: '3.9'
-            args: -DCMAKE_CXX_STANDARD=20
           - python: '3.8'
             args: -DCMAKE_CXX_STANDARD=17
 
@@ -892,10 +847,6 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python:
-        - 3.8
-        - 3.9
-
         include:
           - python: 3.9
             args: -DCMAKE_CXX_STANDARD=20

.github/workflows/configure.yml

@@ -24,38 +24,38 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        runs-on: [ubuntu-20.04, macos-13, windows-latest]
-        arch: [x64]
-        cmake: ["3.26"]
-
         include:
-        - runs-on: ubuntu-20.04
-          arch: x64
+        - runs-on: ubuntu-22.04
           cmake: "3.15"
 
-        - runs-on: ubuntu-20.04
-          arch: x64
+        - runs-on: ubuntu-22.04
+          cmake: "3.26"
+
+        - runs-on: ubuntu-22.04
           cmake: "3.29"
 
         - runs-on: macos-13
-          arch: x64
           cmake: "3.15"
 
+        - runs-on: macos-14
+          cmake: "4.0"
+
         - runs-on: windows-2019
-          arch: x64 # x86 compilers seem to be missing on 2019 image
           cmake: "3.18"
 
-    name: 🐍 3.8 • CMake ${{ matrix.cmake }} • ${{ matrix.runs-on }}
+        - runs-on: windows-latest
+          cmake: "4.0"
+
+    name: 🐍 3.11 • CMake ${{ matrix.cmake }} • ${{ matrix.runs-on }}
     runs-on: ${{ matrix.runs-on }}
 
     steps:
     - uses: actions/checkout@v4
 
-    - name: Setup Python 3.8
+    - name: Setup Python 3.11
       uses: actions/setup-python@v5
       with:
-        python-version: 3.8
-        architecture: ${{ matrix.arch }}
+        python-version: 3.11
 
     - name: Prepare env
       run: python -m pip install -r tests/requirements.txt

.gitignore

@@ -44,3 +44,4 @@ pybind11Targets.cmake
 /docs/_build/*
 .ipynb_checkpoints/
 tests/main.cpp
+CMakeUserPresents.json

.pre-commit-config.yaml

@@ -25,14 +25,14 @@ repos:
 
 # Clang format the codebase automatically
 - repo: https://github.com/pre-commit/mirrors-clang-format
-  rev: "v19.1.7"
+  rev: "v20.1.0"
   hooks:
   - id: clang-format
     types_or: [c++, c, cuda]
 
 # Ruff, the Python auto-correcting linter/formatter written in Rust
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.9.9
+  rev: v0.11.4
   hooks:
   - id: ruff
     args: ["--fix", "--show-fixes"]
@@ -144,14 +144,14 @@ repos:
 
 # PyLint has native support - not always usable, but works for us
 - repo: https://github.com/PyCQA/pylint
-  rev: "v3.3.4"
+  rev: "v3.3.6"
   hooks:
   - id: pylint
     files: ^pybind11
 
 # Check schemas on some of our YAML files
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.31.2
+  rev: 0.32.1
   hooks:
   - id: check-readthedocs
   - id: check-github-workflows

CMakeLists.txt

@@ -129,16 +129,17 @@ set(PYBIND11_HEADERS
     include/pybind11/detail/cpp_conduit.h
     include/pybind11/detail/descr.h
     include/pybind11/detail/dynamic_raw_ptr_cast_if_possible.h
+    include/pybind11/detail/exception_translation.h
     include/pybind11/detail/function_record_pyobject.h
     include/pybind11/detail/init.h
     include/pybind11/detail/internals.h
     include/pybind11/detail/native_enum_data.h
+    include/pybind11/detail/pybind11_namespace_macros.h
     include/pybind11/detail/struct_smart_holder.h
     include/pybind11/detail/type_caster_base.h
     include/pybind11/detail/typeid.h
     include/pybind11/detail/using_smart_holder.h
     include/pybind11/detail/value_and_holder.h
-    include/pybind11/detail/exception_translation.h
     include/pybind11/attr.h
     include/pybind11/buffer_info.h
     include/pybind11/cast.h

docs/advanced/smart_ptrs.rst

@@ -1,3 +1,5 @@
+.. _py_class_holder:
+
 Smart pointers & ``py::class_``
 ###############################
 
@@ -175,59 +177,3 @@ provides ``.get()`` functionality via ``.getPointer()``.
     The file :file:`tests/test_smart_ptr.cpp` contains a complete example
     that demonstrates how to work with custom reference-counting holder types
     in more detail.
-
-
-Be careful not to accidentally undermine automatic lifetime management
-======================================================================
-
-``py::class_``-wrapped objects automatically manage the lifetime of the
-wrapped C++ object, in collaboration with the chosen holder type.
-When wrapping C++ functions involving raw pointers, care needs to be taken
-to not inadvertently transfer ownership, resulting in multiple Python
-objects acting as owners, causing heap-use-after-free or double-free errors.
-For example:
-
-.. code-block:: cpp
-
-    class Child { };
-
-    class Parent {
-    public:
-       Parent() : child(std::make_shared<Child>()) { }
-       Child *get_child() { return child.get(); }  /* DANGER */
-    private:
-        std::shared_ptr<Child> child;
-    };
-
-    PYBIND11_MODULE(example, m) {
-        py::class_<Child, std::shared_ptr<Child>>(m, "Child");
-
-        py::class_<Parent, std::shared_ptr<Parent>>(m, "Parent")
-           .def(py::init<>())
-           .def("get_child", &Parent::get_child);  /* PROBLEM */
-    }
-
-The following Python code leads to undefined behavior, likely resulting in
-a segmentation fault.
-
-.. code-block:: python
-
-   from example import Parent
-
-   print(Parent().get_child())
-
-Part of the ``/* PROBLEM */`` here is that pybind11 falls back to using
-``return_value_policy::take_ownership`` as the default (see
-:ref:`return_value_policies`). The fact that the ``Child`` instance is
-already managed by ``std::shared_ptr<Child>`` is lost. Therefore pybind11
-will create a second independent ``std::shared_ptr<Child>`` that also
-claims ownership of the pointer, eventually leading to heap-use-after-free
-or double-free errors.
-
-There are various ways to resolve this issue, either by changing
-the ``Child`` or ``Parent`` C++ implementations (e.g. using
-``std::enable_shared_from_this<Child>`` as a base class for
-``Child``, or adding a member function to ``Parent`` that returns
-``std::shared_ptr<Child>``), or if that is not feasible, by using
-``return_value_policy::reference_internal``. What is the best approach
-depends on the exact situation.