From 5b0455fd1ecf00a9020b60e8eeadc9d93154b9cd Mon Sep 17 00:00:00 2001 From: caomengxuan666 <2507560089@qq.com> Date: Sat, 23 Aug 2025 17:55:06 +0800 Subject: [PATCH] feat(plugins): add Python plugin support for MCP - Enable writing MCP tools in Python to lower the barrier for contributors - Allow developers to create and submit plugins using Python scripts - This branch introduces initial Python plugin support via pybind11 and embedded interpreter - Known issues remain, including initialization timing and DLL loading on Windows - Further refactoring and stability fixes are required before production use - We used pybind so that we can easily convert python into shared libraries to use. --- CMakeLists.txt | 20 +- plugins/CMakeLists.txt | 10 +- plugins/official/CMakeLists.txt | 4 +- .../python_example_plugin/CMakeLists.txt | 50 + .../official/python_example_plugin/README.md | 106 + .../python_example_plugin/build_plugin.py | 69 + .../python_example_plugin.py | 82 + .../official/python_example_plugin/tools.json | 32 + plugins/sdk/CMakeLists.txt | 58 +- plugins/sdk/mcp_python_plugin.py | 198 + plugins/sdk/pybind_module.cpp | 191 + plugins/sdk/pybind_module_plugin.cpp | 212 + plugins/sdk/python_plugin_CMakeLists.txt | 50 + src/core/CMakeLists.txt | 2 + tests/test_python_plugin.py | 210 + tests/test_server_manual.py | 4 + third_party/pybind11/.appveyor.yml | 35 + third_party/pybind11/.clang-format | 38 + third_party/pybind11/.clang-tidy | 80 + third_party/pybind11/.cmake-format.yaml | 73 + third_party/pybind11/.codespell-ignore-lines | 35 + third_party/pybind11/.gitattributes | 1 + third_party/pybind11/.github/CODEOWNERS | 9 + third_party/pybind11/.github/CONTRIBUTING.md | 349 ++ .../.github/ISSUE_TEMPLATE/bug-report.yml | 61 + .../.github/ISSUE_TEMPLATE/config.yml | 8 + third_party/pybind11/.github/dependabot.yml | 15 + third_party/pybind11/.github/labeler.yml | 13 + .../pybind11/.github/labeler_merged.yml | 8 + .../pybind11/.github/matchers/pylint.json | 32 + .../pybind11/.github/pull_request_template.md | 15 + third_party/pybind11/.github/workflows/ci.yml | 1279 ++++++ .../pybind11/.github/workflows/configure.yml | 85 + .../pybind11/.github/workflows/docs-link.yml | 41 + .../pybind11/.github/workflows/format.yml | 54 + .../pybind11/.github/workflows/labeler.yml | 25 + .../pybind11/.github/workflows/nightlies.yml | 59 + .../pybind11/.github/workflows/pip.yml | 118 + .../.github/workflows/reusable-standard.yml | 96 + .../pybind11/.github/workflows/tests-cibw.yml | 86 + .../pybind11/.github/workflows/upstream.yml | 116 + third_party/pybind11/.gitignore | 53 + third_party/pybind11/.pre-commit-config.yaml | 149 + third_party/pybind11/.readthedocs.yml | 20 + third_party/pybind11/CMakeLists.txt | 423 ++ third_party/pybind11/CMakePresets.json | 93 + third_party/pybind11/LICENSE | 29 + third_party/pybind11/README.rst | 216 + third_party/pybind11/SECURITY.md | 13 + third_party/pybind11/docs/Doxyfile | 21 + .../pybind11/docs/_static/css/custom.css | 3 + .../pybind11/docs/advanced/cast/chrono.rst | 81 + .../pybind11/docs/advanced/cast/custom.rst | 137 + .../pybind11/docs/advanced/cast/eigen.rst | 310 ++ .../docs/advanced/cast/functional.rst | 109 + .../pybind11/docs/advanced/cast/index.rst | 43 + .../pybind11/docs/advanced/cast/overview.rst | 170 + .../pybind11/docs/advanced/cast/stl.rst | 249 ++ .../pybind11/docs/advanced/cast/strings.rst | 296 ++ .../pybind11/docs/advanced/classes.rst | 1408 +++++++ .../pybind11/docs/advanced/deadlock.md | 391 ++ .../pybind11/docs/advanced/deprecated.rst | 179 + .../pybind11/docs/advanced/embedding.rst | 495 +++ .../pybind11/docs/advanced/exceptions.rst | 422 ++ .../pybind11/docs/advanced/functions.rst | 616 +++ third_party/pybind11/docs/advanced/misc.rst | 615 +++ .../pybind11/docs/advanced/pycpp/index.rst | 13 + .../pybind11/docs/advanced/pycpp/numpy.rst | 493 +++ .../pybind11/docs/advanced/pycpp/object.rst | 286 ++ .../docs/advanced/pycpp/utilities.rst | 155 + .../pybind11/docs/advanced/smart_ptrs.rst | 179 + third_party/pybind11/docs/basics.rst | 314 ++ third_party/pybind11/docs/benchmark.py | 89 + third_party/pybind11/docs/benchmark.rst | 95 + third_party/pybind11/docs/changelog.md | 3234 +++++++++++++++ third_party/pybind11/docs/classes.rst | 652 +++ third_party/pybind11/docs/cmake/index.rst | 8 + third_party/pybind11/docs/compiling.rst | 731 ++++ third_party/pybind11/docs/conf.py | 369 ++ third_party/pybind11/docs/faq.rst | 351 ++ third_party/pybind11/docs/index.rst | 49 + third_party/pybind11/docs/installing.rst | 105 + third_party/pybind11/docs/limitations.rst | 68 + third_party/pybind11/docs/pybind11-logo.png | Bin 0 -> 61034 bytes .../docs/pybind11_vs_boost_python1.png | Bin 0 -> 44653 bytes .../docs/pybind11_vs_boost_python1.svg | 427 ++ .../docs/pybind11_vs_boost_python2.png | Bin 0 -> 41121 bytes .../docs/pybind11_vs_boost_python2.svg | 427 ++ third_party/pybind11/docs/reference.rst | 130 + third_party/pybind11/docs/release.rst | 135 + third_party/pybind11/docs/requirements.in | 7 + third_party/pybind11/docs/requirements.txt | 91 + third_party/pybind11/docs/upgrade.rst | 746 ++++ third_party/pybind11/include/pybind11/attr.h | 722 ++++ .../pybind11/include/pybind11/buffer_info.h | 208 + third_party/pybind11/include/pybind11/cast.h | 2361 +++++++++++ .../pybind11/include/pybind11/chrono.h | 228 ++ .../pybind11/include/pybind11/common.h | 2 + .../pybind11/include/pybind11/complex.h | 74 + .../include/pybind11/conduit/README.txt | 15 + .../pybind11/conduit/pybind11_conduit_v1.h | 116 + .../conduit/pybind11_platform_abi_id.h | 87 + .../pybind11/conduit/wrap_include_python_h.h | 72 + .../include/pybind11/critical_section.h | 56 + .../pybind11/include/pybind11/detail/class.h | 823 ++++ .../pybind11/include/pybind11/detail/common.h | 1348 ++++++ .../include/pybind11/detail/cpp_conduit.h | 75 + .../pybind11/include/pybind11/detail/descr.h | 226 + .../detail/dynamic_raw_ptr_cast_if_possible.h | 39 + .../pybind11/detail/exception_translation.h | 71 + .../detail/function_record_pyobject.h | 191 + .../pybind11/include/pybind11/detail/init.h | 538 +++ .../include/pybind11/detail/internals.h | 799 ++++ .../pybind11/detail/native_enum_data.h | 209 + .../detail/pybind11_namespace_macros.h | 82 + .../pybind11/detail/struct_smart_holder.h | 378 ++ .../pybind11/detail/type_caster_base.h | 1591 +++++++ .../pybind11/include/pybind11/detail/typeid.h | 65 + .../pybind11/detail/using_smart_holder.h | 22 + .../pybind11/detail/value_and_holder.h | 90 + third_party/pybind11/include/pybind11/eigen.h | 12 + .../pybind11/include/pybind11/eigen/common.h | 9 + .../pybind11/include/pybind11/eigen/matrix.h | 723 ++++ .../pybind11/include/pybind11/eigen/tensor.h | 521 +++ third_party/pybind11/include/pybind11/embed.h | 320 ++ third_party/pybind11/include/pybind11/eval.h | 161 + .../pybind11/include/pybind11/functional.h | 147 + third_party/pybind11/include/pybind11/gil.h | 199 + .../include/pybind11/gil_safe_call_once.h | 102 + .../pybind11/include/pybind11/gil_simple.h | 37 + .../pybind11/include/pybind11/iostream.h | 265 ++ .../pybind11/include/pybind11/native_enum.h | 67 + third_party/pybind11/include/pybind11/numpy.h | 2312 +++++++++++ .../pybind11/include/pybind11/operators.h | 202 + .../pybind11/include/pybind11/options.h | 92 + .../pybind11/include/pybind11/pybind11.h | 3645 +++++++++++++++++ .../pybind11/include/pybind11/pytypes.h | 2680 ++++++++++++ third_party/pybind11/include/pybind11/stl.h | 666 +++ .../include/pybind11/stl/filesystem.h | 114 + .../pybind11/include/pybind11/stl_bind.h | 858 ++++ .../include/pybind11/subinterpreter.h | 299 ++ .../pybind11/trampoline_self_life_support.h | 65 + .../pybind11/type_caster_pyobject_ptr.h | 61 + .../pybind11/include/pybind11/typing.h | 298 ++ .../pybind11/include/pybind11/warnings.h | 75 + third_party/pybind11/noxfile.py | 151 + third_party/pybind11/pybind11/__init__.py | 19 + third_party/pybind11/pybind11/__main__.py | 97 + third_party/pybind11/pybind11/_version.py | 34 + third_party/pybind11/pybind11/commands.py | 39 + third_party/pybind11/pybind11/py.typed | 0 .../pybind11/pybind11/setup_helpers.py | 500 +++ third_party/pybind11/pyproject.toml | 184 + third_party/pybind11/tests/CMakeLists.txt | 658 +++ third_party/pybind11/tests/conftest.py | 277 ++ .../pybind11/tests/constructor_stats.h | 330 ++ .../pybind11/tests/cross_module_gil_utils.cpp | 111 + ...s_module_interleaved_error_already_set.cpp | 54 + .../pybind11/tests/custom_exceptions.py | 10 + .../tests/eigen_tensor_avoid_stl_array.cpp | 16 + third_party/pybind11/tests/env.py | 37 + .../pybind11/tests/exo_planet_c_api.cpp | 76 + .../pybind11/tests/exo_planet_pybind11.cpp | 19 + .../tests/extra_python_package/pytest.ini | 0 .../tests/extra_python_package/test_files.py | 383 ++ .../tests/extra_setuptools/pytest.ini | 0 .../extra_setuptools/test_setuphelper.py | 153 + .../home_planet_very_lonely_traveler.cpp | 13 + third_party/pybind11/tests/local_bindings.h | 92 + .../tests/mod_per_interpreter_gil.cpp | 20 + .../tests/mod_shared_interpreter_gil.cpp | 17 + third_party/pybind11/tests/object.h | 205 + .../pybind11/tests/pure_cpp/CMakeLists.txt | 20 + .../tests/pure_cpp/smart_holder_poc.h | 56 + .../tests/pure_cpp/smart_holder_poc_test.cpp | 427 ++ .../tests/pybind11_cross_module_tests.cpp | 149 + third_party/pybind11/tests/pybind11_tests.cpp | 129 + third_party/pybind11/tests/pybind11_tests.h | 119 + third_party/pybind11/tests/pyproject.toml | 38 + third_party/pybind11/tests/pytest.ini | 22 + third_party/pybind11/tests/requirements.txt | 18 + third_party/pybind11/tests/test_async.cpp | 25 + third_party/pybind11/tests/test_async.py | 31 + third_party/pybind11/tests/test_buffers.cpp | 442 ++ third_party/pybind11/tests/test_buffers.py | 401 ++ .../pybind11/tests/test_builtin_casters.cpp | 391 ++ .../pybind11/tests/test_builtin_casters.py | 551 +++ .../pybind11/tests/test_call_policies.cpp | 113 + .../pybind11/tests/test_call_policies.py | 256 ++ third_party/pybind11/tests/test_callbacks.cpp | 302 ++ third_party/pybind11/tests/test_callbacks.py | 247 ++ third_party/pybind11/tests/test_chrono.cpp | 81 + third_party/pybind11/tests/test_chrono.py | 207 + third_party/pybind11/tests/test_class.cpp | 681 +++ third_party/pybind11/tests/test_class.py | 557 +++ ...ss_release_gil_before_calling_cpp_dtor.cpp | 53 + ...ass_release_gil_before_calling_cpp_dtor.py | 21 + .../pybind11/tests/test_class_sh_basic.cpp | 248 ++ .../pybind11/tests/test_class_sh_basic.py | 248 ++ .../tests/test_class_sh_disowning.cpp | 41 + .../pybind11/tests/test_class_sh_disowning.py | 78 + .../tests/test_class_sh_disowning_mi.cpp | 85 + .../tests/test_class_sh_disowning_mi.py | 246 ++ .../test_class_sh_factory_constructors.cpp | 156 + .../test_class_sh_factory_constructors.py | 53 + .../tests/test_class_sh_inheritance.cpp | 90 + .../tests/test_class_sh_inheritance.py | 63 + .../tests/test_class_sh_mi_thunks.cpp | 93 + .../pybind11/tests/test_class_sh_mi_thunks.py | 53 + .../pybind11/tests/test_class_sh_property.cpp | 94 + .../pybind11/tests/test_class_sh_property.py | 166 + .../test_class_sh_property_non_owning.cpp | 63 + .../test_class_sh_property_non_owning.py | 30 + .../test_class_sh_shared_ptr_copy_move.cpp | 103 + .../test_class_sh_shared_ptr_copy_move.py | 41 + .../tests/test_class_sh_trampoline_basic.cpp | 57 + .../tests/test_class_sh_trampoline_basic.py | 35 + ..._class_sh_trampoline_self_life_support.cpp | 86 + ...t_class_sh_trampoline_self_life_support.py | 38 + ...t_class_sh_trampoline_shared_from_this.cpp | 137 + ...st_class_sh_trampoline_shared_from_this.py | 247 ++ ...class_sh_trampoline_shared_ptr_cpp_arg.cpp | 92 + ..._class_sh_trampoline_shared_ptr_cpp_arg.py | 154 + .../test_class_sh_trampoline_unique_ptr.cpp | 63 + .../test_class_sh_trampoline_unique_ptr.py | 31 + ...est_class_sh_unique_ptr_custom_deleter.cpp | 30 + ...test_class_sh_unique_ptr_custom_deleter.py | 8 + .../tests/test_class_sh_unique_ptr_member.cpp | 50 + .../tests/test_class_sh_unique_ptr_member.py | 26 + .../test_class_sh_virtual_py_cpp_mix.cpp | 58 + .../tests/test_class_sh_virtual_py_cpp_mix.py | 66 + .../tests/test_cmake_build/CMakeLists.txt | 91 + .../pybind11/tests/test_cmake_build/embed.cpp | 23 + .../installed_embed/CMakeLists.txt | 19 + .../installed_function/CMakeLists.txt | 29 + .../installed_target/CMakeLists.txt | 37 + .../pybind11/tests/test_cmake_build/main.cpp | 6 + .../subdirectory_embed/CMakeLists.txt | 38 + .../subdirectory_function/CMakeLists.txt | 32 + .../subdirectory_target/CMakeLists.txt | 38 + .../pybind11/tests/test_cmake_build/test.py | 10 + .../pybind11/tests/test_const_name.cpp | 55 + third_party/pybind11/tests/test_const_name.py | 31 + .../tests/test_constants_and_functions.cpp | 158 + .../tests/test_constants_and_functions.py | 58 + third_party/pybind11/tests/test_copy_move.cpp | 546 +++ third_party/pybind11/tests/test_copy_move.py | 144 + .../pybind11/tests/test_cpp_conduit.cpp | 22 + .../pybind11/tests/test_cpp_conduit.py | 183 + .../test_cpp_conduit_traveler_bindings.h | 47 + .../tests/test_cpp_conduit_traveler_types.h | 25 + .../test_cross_module_rtti/CMakeLists.txt | 68 + .../tests/test_cross_module_rtti/bindings.cpp | 20 + .../tests/test_cross_module_rtti/catch.cpp | 22 + .../tests/test_cross_module_rtti/lib.cpp | 13 + .../tests/test_cross_module_rtti/lib.h | 30 + .../test_cross_module_rtti.cpp | 50 + .../tests/test_custom_type_casters.cpp | 217 + .../tests/test_custom_type_casters.py | 126 + .../pybind11/tests/test_custom_type_setup.cpp | 49 + .../pybind11/tests/test_custom_type_setup.py | 50 + .../tests/test_docs_advanced_cast_custom.cpp | 69 + .../tests/test_docs_advanced_cast_custom.py | 40 + .../pybind11/tests/test_docstring_options.cpp | 129 + .../pybind11/tests/test_docstring_options.py | 72 + .../pybind11/tests/test_eigen_matrix.cpp | 447 ++ .../pybind11/tests/test_eigen_matrix.py | 839 ++++ .../pybind11/tests/test_eigen_tensor.cpp | 18 + .../pybind11/tests/test_eigen_tensor.inl | 338 ++ .../pybind11/tests/test_eigen_tensor.py | 316 ++ .../pybind11/tests/test_embed/CMakeLists.txt | 61 + .../pybind11/tests/test_embed/catch.cpp | 43 + .../tests/test_embed/external_module.cpp | 24 + .../tests/test_embed/test_interpreter.cpp | 482 +++ .../tests/test_embed/test_interpreter.py | 16 + .../tests/test_embed/test_subinterpreter.cpp | 442 ++ .../tests/test_embed/test_trampoline.py | 18 + third_party/pybind11/tests/test_enum.cpp | 149 + third_party/pybind11/tests/test_enum.py | 344 ++ third_party/pybind11/tests/test_eval.cpp | 118 + third_party/pybind11/tests/test_eval.py | 52 + third_party/pybind11/tests/test_eval_call.py | 5 + .../pybind11/tests/test_exceptions.cpp | 427 ++ third_party/pybind11/tests/test_exceptions.h | 13 + third_party/pybind11/tests/test_exceptions.py | 439 ++ .../tests/test_factory_constructors.cpp | 430 ++ .../tests/test_factory_constructors.py | 531 +++ .../pybind11/tests/test_gil_scoped.cpp | 144 + third_party/pybind11/tests/test_gil_scoped.py | 285 ++ third_party/pybind11/tests/test_iostream.cpp | 126 + third_party/pybind11/tests/test_iostream.py | 297 ++ .../tests/test_kwargs_and_defaults.cpp | 331 ++ .../tests/test_kwargs_and_defaults.py | 471 +++ .../pybind11/tests/test_local_bindings.cpp | 106 + .../pybind11/tests/test_local_bindings.py | 257 ++ .../tests/test_methods_and_attributes.cpp | 492 +++ .../tests/test_methods_and_attributes.py | 568 +++ third_party/pybind11/tests/test_modules.cpp | 124 + third_party/pybind11/tests/test_modules.py | 146 + .../tests/test_multiple_inheritance.cpp | 341 ++ .../tests/test_multiple_inheritance.py | 500 +++ .../tests/test_multiple_interpreters.py | 200 + .../pybind11/tests/test_native_enum.cpp | 258 ++ .../pybind11/tests/test_native_enum.py | 322 ++ .../pybind11/tests/test_numpy_array.cpp | 598 +++ .../pybind11/tests/test_numpy_array.py | 710 ++++ .../pybind11/tests/test_numpy_dtypes.cpp | 745 ++++ .../pybind11/tests/test_numpy_dtypes.py | 464 +++ .../pybind11/tests/test_numpy_scalars.cpp | 63 + .../pybind11/tests/test_numpy_scalars.py | 54 + .../pybind11/tests/test_numpy_vectorize.cpp | 107 + .../pybind11/tests/test_numpy_vectorize.py | 268 ++ .../pybind11/tests/test_opaque_types.cpp | 77 + .../pybind11/tests/test_opaque_types.py | 64 + .../tests/test_operator_overloading.cpp | 281 ++ .../tests/test_operator_overloading.py | 161 + third_party/pybind11/tests/test_pickling.cpp | 191 + third_party/pybind11/tests/test_pickling.py | 149 + .../test_potentially_slicing_weak_ptr.cpp | 168 + .../test_potentially_slicing_weak_ptr.py | 174 + .../test_python_multiple_inheritance.cpp | 45 + .../tests/test_python_multiple_inheritance.py | 36 + third_party/pybind11/tests/test_pytypes.cpp | 1213 ++++++ third_party/pybind11/tests/test_pytypes.py | 1349 ++++++ .../tests/test_scoped_critical_section.cpp | 275 ++ .../tests/test_scoped_critical_section.py | 30 + .../tests/test_sequences_and_iterators.cpp | 600 +++ .../tests/test_sequences_and_iterators.py | 307 ++ third_party/pybind11/tests/test_smart_ptr.cpp | 587 +++ third_party/pybind11/tests/test_smart_ptr.py | 357 ++ third_party/pybind11/tests/test_stl.cpp | 666 +++ third_party/pybind11/tests/test_stl.py | 735 ++++ .../pybind11/tests/test_stl_binders.cpp | 275 ++ .../pybind11/tests/test_stl_binders.py | 414 ++ .../tests/test_tagbased_polymorphic.cpp | 148 + .../tests/test_tagbased_polymorphic.py | 30 + third_party/pybind11/tests/test_thread.cpp | 72 + third_party/pybind11/tests/test_thread.py | 68 + .../tests/test_type_caster_pyobject_ptr.cpp | 168 + .../tests/test_type_caster_pyobject_ptr.py | 124 + ...pe_caster_std_function_specializations.cpp | 46 + ...ype_caster_std_function_specializations.py | 15 + third_party/pybind11/tests/test_union.cpp | 22 + third_party/pybind11/tests/test_union.py | 10 + .../tests/test_unnamed_namespace_a.cpp | 37 + .../tests/test_unnamed_namespace_a.py | 30 + .../tests/test_unnamed_namespace_b.cpp | 13 + .../tests/test_unnamed_namespace_b.py | 7 + .../tests/test_vector_unique_ptr_member.cpp | 54 + .../tests/test_vector_unique_ptr_member.py | 16 + .../pybind11/tests/test_virtual_functions.cpp | 592 +++ .../pybind11/tests/test_virtual_functions.py | 468 +++ third_party/pybind11/tests/test_warnings.cpp | 46 + third_party/pybind11/tests/test_warnings.py | 68 + .../pybind11/tests/valgrind-numpy-scipy.supp | 140 + .../pybind11/tests/valgrind-python.supp | 117 + third_party/pybind11/tools/FindCatch.cmake | 74 + third_party/pybind11/tools/FindEigen3.cmake | 86 + .../pybind11/tools/FindPythonLibsNew.cmake | 320 ++ third_party/pybind11/tools/JoinPaths.cmake | 23 + third_party/pybind11/tools/check-style.sh | 44 + .../pybind11/tools/cmake_uninstall.cmake.in | 23 + .../codespell_ignore_lines_from_errors.py | 40 + third_party/pybind11/tools/libsize.py | 38 + third_party/pybind11/tools/make_changelog.py | 121 + third_party/pybind11/tools/make_global.py | 33 + third_party/pybind11/tools/pybind11.pc.in | 7 + .../pybind11/tools/pybind11Common.cmake | 447 ++ .../pybind11/tools/pybind11Config.cmake.in | 240 ++ .../tools/pybind11GuessPythonExtSuffix.cmake | 86 + .../pybind11/tools/pybind11NewTools.cmake | 353 ++ .../pybind11/tools/pybind11Tools.cmake | 217 + .../test-pybind11GuessPythonExtSuffix.cmake | 161 + tools/plugin_ctl.cpp | 610 ++- 374 files changed, 85325 insertions(+), 222 deletions(-) create mode 100644 plugins/official/python_example_plugin/CMakeLists.txt create mode 100644 plugins/official/python_example_plugin/README.md create mode 100644 plugins/official/python_example_plugin/build_plugin.py create mode 100644 plugins/official/python_example_plugin/python_example_plugin.py create mode 100644 plugins/official/python_example_plugin/tools.json create mode 100644 plugins/sdk/mcp_python_plugin.py create mode 100644 plugins/sdk/pybind_module.cpp create mode 100644 plugins/sdk/pybind_module_plugin.cpp create mode 100644 plugins/sdk/python_plugin_CMakeLists.txt create mode 100644 tests/test_python_plugin.py create mode 100644 third_party/pybind11/.appveyor.yml create mode 100644 third_party/pybind11/.clang-format create mode 100644 third_party/pybind11/.clang-tidy create mode 100644 third_party/pybind11/.cmake-format.yaml create mode 100644 third_party/pybind11/.codespell-ignore-lines create mode 100644 third_party/pybind11/.gitattributes create mode 100644 third_party/pybind11/.github/CODEOWNERS create mode 100644 third_party/pybind11/.github/CONTRIBUTING.md create mode 100644 third_party/pybind11/.github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 third_party/pybind11/.github/ISSUE_TEMPLATE/config.yml create mode 100644 third_party/pybind11/.github/dependabot.yml create mode 100644 third_party/pybind11/.github/labeler.yml create mode 100644 third_party/pybind11/.github/labeler_merged.yml create mode 100644 third_party/pybind11/.github/matchers/pylint.json create mode 100644 third_party/pybind11/.github/pull_request_template.md create mode 100644 third_party/pybind11/.github/workflows/ci.yml create mode 100644 third_party/pybind11/.github/workflows/configure.yml create mode 100644 third_party/pybind11/.github/workflows/docs-link.yml create mode 100644 third_party/pybind11/.github/workflows/format.yml create mode 100644 third_party/pybind11/.github/workflows/labeler.yml create mode 100644 third_party/pybind11/.github/workflows/nightlies.yml create mode 100644 third_party/pybind11/.github/workflows/pip.yml create mode 100644 third_party/pybind11/.github/workflows/reusable-standard.yml create mode 100644 third_party/pybind11/.github/workflows/tests-cibw.yml create mode 100644 third_party/pybind11/.github/workflows/upstream.yml create mode 100644 third_party/pybind11/.gitignore create mode 100644 third_party/pybind11/.pre-commit-config.yaml create mode 100644 third_party/pybind11/.readthedocs.yml create mode 100644 third_party/pybind11/CMakeLists.txt create mode 100644 third_party/pybind11/CMakePresets.json create mode 100644 third_party/pybind11/LICENSE create mode 100644 third_party/pybind11/README.rst create mode 100644 third_party/pybind11/SECURITY.md create mode 100644 third_party/pybind11/docs/Doxyfile create mode 100644 third_party/pybind11/docs/_static/css/custom.css create mode 100644 third_party/pybind11/docs/advanced/cast/chrono.rst create mode 100644 third_party/pybind11/docs/advanced/cast/custom.rst create mode 100644 third_party/pybind11/docs/advanced/cast/eigen.rst create mode 100644 third_party/pybind11/docs/advanced/cast/functional.rst create mode 100644 third_party/pybind11/docs/advanced/cast/index.rst create mode 100644 third_party/pybind11/docs/advanced/cast/overview.rst create mode 100644 third_party/pybind11/docs/advanced/cast/stl.rst create mode 100644 third_party/pybind11/docs/advanced/cast/strings.rst create mode 100644 third_party/pybind11/docs/advanced/classes.rst create mode 100644 third_party/pybind11/docs/advanced/deadlock.md create mode 100644 third_party/pybind11/docs/advanced/deprecated.rst create mode 100644 third_party/pybind11/docs/advanced/embedding.rst create mode 100644 third_party/pybind11/docs/advanced/exceptions.rst create mode 100644 third_party/pybind11/docs/advanced/functions.rst create mode 100644 third_party/pybind11/docs/advanced/misc.rst create mode 100644 third_party/pybind11/docs/advanced/pycpp/index.rst create mode 100644 third_party/pybind11/docs/advanced/pycpp/numpy.rst create mode 100644 third_party/pybind11/docs/advanced/pycpp/object.rst create mode 100644 third_party/pybind11/docs/advanced/pycpp/utilities.rst create mode 100644 third_party/pybind11/docs/advanced/smart_ptrs.rst create mode 100644 third_party/pybind11/docs/basics.rst create mode 100644 third_party/pybind11/docs/benchmark.py create mode 100644 third_party/pybind11/docs/benchmark.rst create mode 100644 third_party/pybind11/docs/changelog.md create mode 100644 third_party/pybind11/docs/classes.rst create mode 100644 third_party/pybind11/docs/cmake/index.rst create mode 100644 third_party/pybind11/docs/compiling.rst create mode 100644 third_party/pybind11/docs/conf.py create mode 100644 third_party/pybind11/docs/faq.rst create mode 100644 third_party/pybind11/docs/index.rst create mode 100644 third_party/pybind11/docs/installing.rst create mode 100644 third_party/pybind11/docs/limitations.rst create mode 100644 third_party/pybind11/docs/pybind11-logo.png create mode 100644 third_party/pybind11/docs/pybind11_vs_boost_python1.png create mode 100644 third_party/pybind11/docs/pybind11_vs_boost_python1.svg create mode 100644 third_party/pybind11/docs/pybind11_vs_boost_python2.png create mode 100644 third_party/pybind11/docs/pybind11_vs_boost_python2.svg create mode 100644 third_party/pybind11/docs/reference.rst create mode 100644 third_party/pybind11/docs/release.rst create mode 100644 third_party/pybind11/docs/requirements.in create mode 100644 third_party/pybind11/docs/requirements.txt create mode 100644 third_party/pybind11/docs/upgrade.rst create mode 100644 third_party/pybind11/include/pybind11/attr.h create mode 100644 third_party/pybind11/include/pybind11/buffer_info.h create mode 100644 third_party/pybind11/include/pybind11/cast.h create mode 100644 third_party/pybind11/include/pybind11/chrono.h create mode 100644 third_party/pybind11/include/pybind11/common.h create mode 100644 third_party/pybind11/include/pybind11/complex.h create mode 100644 third_party/pybind11/include/pybind11/conduit/README.txt create mode 100644 third_party/pybind11/include/pybind11/conduit/pybind11_conduit_v1.h create mode 100644 third_party/pybind11/include/pybind11/conduit/pybind11_platform_abi_id.h create mode 100644 third_party/pybind11/include/pybind11/conduit/wrap_include_python_h.h create mode 100644 third_party/pybind11/include/pybind11/critical_section.h create mode 100644 third_party/pybind11/include/pybind11/detail/class.h create mode 100644 third_party/pybind11/include/pybind11/detail/common.h create mode 100644 third_party/pybind11/include/pybind11/detail/cpp_conduit.h create mode 100644 third_party/pybind11/include/pybind11/detail/descr.h create mode 100644 third_party/pybind11/include/pybind11/detail/dynamic_raw_ptr_cast_if_possible.h create mode 100644 third_party/pybind11/include/pybind11/detail/exception_translation.h create mode 100644 third_party/pybind11/include/pybind11/detail/function_record_pyobject.h create mode 100644 third_party/pybind11/include/pybind11/detail/init.h create mode 100644 third_party/pybind11/include/pybind11/detail/internals.h create mode 100644 third_party/pybind11/include/pybind11/detail/native_enum_data.h create mode 100644 third_party/pybind11/include/pybind11/detail/pybind11_namespace_macros.h create mode 100644 third_party/pybind11/include/pybind11/detail/struct_smart_holder.h create mode 100644 third_party/pybind11/include/pybind11/detail/type_caster_base.h create mode 100644 third_party/pybind11/include/pybind11/detail/typeid.h create mode 100644 third_party/pybind11/include/pybind11/detail/using_smart_holder.h create mode 100644 third_party/pybind11/include/pybind11/detail/value_and_holder.h create mode 100644 third_party/pybind11/include/pybind11/eigen.h create mode 100644 third_party/pybind11/include/pybind11/eigen/common.h create mode 100644 third_party/pybind11/include/pybind11/eigen/matrix.h create mode 100644 third_party/pybind11/include/pybind11/eigen/tensor.h create mode 100644 third_party/pybind11/include/pybind11/embed.h create mode 100644 third_party/pybind11/include/pybind11/eval.h create mode 100644 third_party/pybind11/include/pybind11/functional.h create mode 100644 third_party/pybind11/include/pybind11/gil.h create mode 100644 third_party/pybind11/include/pybind11/gil_safe_call_once.h create mode 100644 third_party/pybind11/include/pybind11/gil_simple.h create mode 100644 third_party/pybind11/include/pybind11/iostream.h create mode 100644 third_party/pybind11/include/pybind11/native_enum.h create mode 100644 third_party/pybind11/include/pybind11/numpy.h create mode 100644 third_party/pybind11/include/pybind11/operators.h create mode 100644 third_party/pybind11/include/pybind11/options.h create mode 100644 third_party/pybind11/include/pybind11/pybind11.h create mode 100644 third_party/pybind11/include/pybind11/pytypes.h create mode 100644 third_party/pybind11/include/pybind11/stl.h create mode 100644 third_party/pybind11/include/pybind11/stl/filesystem.h create mode 100644 third_party/pybind11/include/pybind11/stl_bind.h create mode 100644 third_party/pybind11/include/pybind11/subinterpreter.h create mode 100644 third_party/pybind11/include/pybind11/trampoline_self_life_support.h create mode 100644 third_party/pybind11/include/pybind11/type_caster_pyobject_ptr.h create mode 100644 third_party/pybind11/include/pybind11/typing.h create mode 100644 third_party/pybind11/include/pybind11/warnings.h create mode 100644 third_party/pybind11/noxfile.py create mode 100644 third_party/pybind11/pybind11/__init__.py create mode 100644 third_party/pybind11/pybind11/__main__.py create mode 100644 third_party/pybind11/pybind11/_version.py create mode 100644 third_party/pybind11/pybind11/commands.py create mode 100644 third_party/pybind11/pybind11/py.typed create mode 100644 third_party/pybind11/pybind11/setup_helpers.py create mode 100644 third_party/pybind11/pyproject.toml create mode 100644 third_party/pybind11/tests/CMakeLists.txt create mode 100644 third_party/pybind11/tests/conftest.py create mode 100644 third_party/pybind11/tests/constructor_stats.h create mode 100644 third_party/pybind11/tests/cross_module_gil_utils.cpp create mode 100644 third_party/pybind11/tests/cross_module_interleaved_error_already_set.cpp create mode 100644 third_party/pybind11/tests/custom_exceptions.py create mode 100644 third_party/pybind11/tests/eigen_tensor_avoid_stl_array.cpp create mode 100644 third_party/pybind11/tests/env.py create mode 100644 third_party/pybind11/tests/exo_planet_c_api.cpp create mode 100644 third_party/pybind11/tests/exo_planet_pybind11.cpp create mode 100644 third_party/pybind11/tests/extra_python_package/pytest.ini create mode 100644 third_party/pybind11/tests/extra_python_package/test_files.py create mode 100644 third_party/pybind11/tests/extra_setuptools/pytest.ini create mode 100644 third_party/pybind11/tests/extra_setuptools/test_setuphelper.py create mode 100644 third_party/pybind11/tests/home_planet_very_lonely_traveler.cpp create mode 100644 third_party/pybind11/tests/local_bindings.h create mode 100644 third_party/pybind11/tests/mod_per_interpreter_gil.cpp create mode 100644 third_party/pybind11/tests/mod_shared_interpreter_gil.cpp create mode 100644 third_party/pybind11/tests/object.h create mode 100644 third_party/pybind11/tests/pure_cpp/CMakeLists.txt create mode 100644 third_party/pybind11/tests/pure_cpp/smart_holder_poc.h create mode 100644 third_party/pybind11/tests/pure_cpp/smart_holder_poc_test.cpp create mode 100644 third_party/pybind11/tests/pybind11_cross_module_tests.cpp create mode 100644 third_party/pybind11/tests/pybind11_tests.cpp create mode 100644 third_party/pybind11/tests/pybind11_tests.h create mode 100644 third_party/pybind11/tests/pyproject.toml create mode 100644 third_party/pybind11/tests/pytest.ini create mode 100644 third_party/pybind11/tests/requirements.txt create mode 100644 third_party/pybind11/tests/test_async.cpp create mode 100644 third_party/pybind11/tests/test_async.py create mode 100644 third_party/pybind11/tests/test_buffers.cpp create mode 100644 third_party/pybind11/tests/test_buffers.py create mode 100644 third_party/pybind11/tests/test_builtin_casters.cpp create mode 100644 third_party/pybind11/tests/test_builtin_casters.py create mode 100644 third_party/pybind11/tests/test_call_policies.cpp create mode 100644 third_party/pybind11/tests/test_call_policies.py create mode 100644 third_party/pybind11/tests/test_callbacks.cpp create mode 100644 third_party/pybind11/tests/test_callbacks.py create mode 100644 third_party/pybind11/tests/test_chrono.cpp create mode 100644 third_party/pybind11/tests/test_chrono.py create mode 100644 third_party/pybind11/tests/test_class.cpp create mode 100644 third_party/pybind11/tests/test_class.py create mode 100644 third_party/pybind11/tests/test_class_release_gil_before_calling_cpp_dtor.cpp create mode 100644 third_party/pybind11/tests/test_class_release_gil_before_calling_cpp_dtor.py create mode 100644 third_party/pybind11/tests/test_class_sh_basic.cpp create mode 100644 third_party/pybind11/tests/test_class_sh_basic.py create mode 100644 third_party/pybind11/tests/test_class_sh_disowning.cpp create mode 100644 third_party/pybind11/tests/test_class_sh_disowning.py create mode 100644 third_party/pybind11/tests/test_class_sh_disowning_mi.cpp create mode 100644 third_party/pybind11/tests/test_class_sh_disowning_mi.py create mode 100644 third_party/pybind11/tests/test_class_sh_factory_constructors.cpp create mode 100644 third_party/pybind11/tests/test_class_sh_factory_constructors.py create mode 100644 third_party/pybind11/tests/test_class_sh_inheritance.cpp create mode 100644 third_party/pybind11/tests/test_class_sh_inheritance.py create mode 100644 third_party/pybind11/tests/test_class_sh_mi_thunks.cpp create mode 100644 third_party/pybind11/tests/test_class_sh_mi_thunks.py create mode 100644 third_party/pybind11/tests/test_class_sh_property.cpp create mode 100644 third_party/pybind11/tests/test_class_sh_property.py create mode 100644 third_party/pybind11/tests/test_class_sh_property_non_owning.cpp create mode 100644 third_party/pybind11/tests/test_class_sh_property_non_owning.py create mode 100644 third_party/pybind11/tests/test_class_sh_shared_ptr_copy_move.cpp create mode 100644 third_party/pybind11/tests/test_class_sh_shared_ptr_copy_move.py create mode 100644 third_party/pybind11/tests/test_class_sh_trampoline_basic.cpp create mode 100644 third_party/pybind11/tests/test_class_sh_trampoline_basic.py create mode 100644 third_party/pybind11/tests/test_class_sh_trampoline_self_life_support.cpp create mode 100644 third_party/pybind11/tests/test_class_sh_trampoline_self_life_support.py create mode 100644 third_party/pybind11/tests/test_class_sh_trampoline_shared_from_this.cpp create mode 100644 third_party/pybind11/tests/test_class_sh_trampoline_shared_from_this.py create mode 100644 third_party/pybind11/tests/test_class_sh_trampoline_shared_ptr_cpp_arg.cpp create mode 100644 third_party/pybind11/tests/test_class_sh_trampoline_shared_ptr_cpp_arg.py create mode 100644 third_party/pybind11/tests/test_class_sh_trampoline_unique_ptr.cpp create mode 100644 third_party/pybind11/tests/test_class_sh_trampoline_unique_ptr.py create mode 100644 third_party/pybind11/tests/test_class_sh_unique_ptr_custom_deleter.cpp create mode 100644 third_party/pybind11/tests/test_class_sh_unique_ptr_custom_deleter.py create mode 100644 third_party/pybind11/tests/test_class_sh_unique_ptr_member.cpp create mode 100644 third_party/pybind11/tests/test_class_sh_unique_ptr_member.py create mode 100644 third_party/pybind11/tests/test_class_sh_virtual_py_cpp_mix.cpp create mode 100644 third_party/pybind11/tests/test_class_sh_virtual_py_cpp_mix.py create mode 100644 third_party/pybind11/tests/test_cmake_build/CMakeLists.txt create mode 100644 third_party/pybind11/tests/test_cmake_build/embed.cpp create mode 100644 third_party/pybind11/tests/test_cmake_build/installed_embed/CMakeLists.txt create mode 100644 third_party/pybind11/tests/test_cmake_build/installed_function/CMakeLists.txt create mode 100644 third_party/pybind11/tests/test_cmake_build/installed_target/CMakeLists.txt create mode 100644 third_party/pybind11/tests/test_cmake_build/main.cpp create mode 100644 third_party/pybind11/tests/test_cmake_build/subdirectory_embed/CMakeLists.txt create mode 100644 third_party/pybind11/tests/test_cmake_build/subdirectory_function/CMakeLists.txt create mode 100644 third_party/pybind11/tests/test_cmake_build/subdirectory_target/CMakeLists.txt create mode 100644 third_party/pybind11/tests/test_cmake_build/test.py create mode 100644 third_party/pybind11/tests/test_const_name.cpp create mode 100644 third_party/pybind11/tests/test_const_name.py create mode 100644 third_party/pybind11/tests/test_constants_and_functions.cpp create mode 100644 third_party/pybind11/tests/test_constants_and_functions.py create mode 100644 third_party/pybind11/tests/test_copy_move.cpp create mode 100644 third_party/pybind11/tests/test_copy_move.py create mode 100644 third_party/pybind11/tests/test_cpp_conduit.cpp create mode 100644 third_party/pybind11/tests/test_cpp_conduit.py create mode 100644 third_party/pybind11/tests/test_cpp_conduit_traveler_bindings.h create mode 100644 third_party/pybind11/tests/test_cpp_conduit_traveler_types.h create mode 100644 third_party/pybind11/tests/test_cross_module_rtti/CMakeLists.txt create mode 100644 third_party/pybind11/tests/test_cross_module_rtti/bindings.cpp create mode 100644 third_party/pybind11/tests/test_cross_module_rtti/catch.cpp create mode 100644 third_party/pybind11/tests/test_cross_module_rtti/lib.cpp create mode 100644 third_party/pybind11/tests/test_cross_module_rtti/lib.h create mode 100644 third_party/pybind11/tests/test_cross_module_rtti/test_cross_module_rtti.cpp create mode 100644 third_party/pybind11/tests/test_custom_type_casters.cpp create mode 100644 third_party/pybind11/tests/test_custom_type_casters.py create mode 100644 third_party/pybind11/tests/test_custom_type_setup.cpp create mode 100644 third_party/pybind11/tests/test_custom_type_setup.py create mode 100644 third_party/pybind11/tests/test_docs_advanced_cast_custom.cpp create mode 100644 third_party/pybind11/tests/test_docs_advanced_cast_custom.py create mode 100644 third_party/pybind11/tests/test_docstring_options.cpp create mode 100644 third_party/pybind11/tests/test_docstring_options.py create mode 100644 third_party/pybind11/tests/test_eigen_matrix.cpp create mode 100644 third_party/pybind11/tests/test_eigen_matrix.py create mode 100644 third_party/pybind11/tests/test_eigen_tensor.cpp create mode 100644 third_party/pybind11/tests/test_eigen_tensor.inl create mode 100644 third_party/pybind11/tests/test_eigen_tensor.py create mode 100644 third_party/pybind11/tests/test_embed/CMakeLists.txt create mode 100644 third_party/pybind11/tests/test_embed/catch.cpp create mode 100644 third_party/pybind11/tests/test_embed/external_module.cpp create mode 100644 third_party/pybind11/tests/test_embed/test_interpreter.cpp create mode 100644 third_party/pybind11/tests/test_embed/test_interpreter.py create mode 100644 third_party/pybind11/tests/test_embed/test_subinterpreter.cpp create mode 100644 third_party/pybind11/tests/test_embed/test_trampoline.py create mode 100644 third_party/pybind11/tests/test_enum.cpp create mode 100644 third_party/pybind11/tests/test_enum.py create mode 100644 third_party/pybind11/tests/test_eval.cpp create mode 100644 third_party/pybind11/tests/test_eval.py create mode 100644 third_party/pybind11/tests/test_eval_call.py create mode 100644 third_party/pybind11/tests/test_exceptions.cpp create mode 100644 third_party/pybind11/tests/test_exceptions.h create mode 100644 third_party/pybind11/tests/test_exceptions.py create mode 100644 third_party/pybind11/tests/test_factory_constructors.cpp create mode 100644 third_party/pybind11/tests/test_factory_constructors.py create mode 100644 third_party/pybind11/tests/test_gil_scoped.cpp create mode 100644 third_party/pybind11/tests/test_gil_scoped.py create mode 100644 third_party/pybind11/tests/test_iostream.cpp create mode 100644 third_party/pybind11/tests/test_iostream.py create mode 100644 third_party/pybind11/tests/test_kwargs_and_defaults.cpp create mode 100644 third_party/pybind11/tests/test_kwargs_and_defaults.py create mode 100644 third_party/pybind11/tests/test_local_bindings.cpp create mode 100644 third_party/pybind11/tests/test_local_bindings.py create mode 100644 third_party/pybind11/tests/test_methods_and_attributes.cpp create mode 100644 third_party/pybind11/tests/test_methods_and_attributes.py create mode 100644 third_party/pybind11/tests/test_modules.cpp create mode 100644 third_party/pybind11/tests/test_modules.py create mode 100644 third_party/pybind11/tests/test_multiple_inheritance.cpp create mode 100644 third_party/pybind11/tests/test_multiple_inheritance.py create mode 100644 third_party/pybind11/tests/test_multiple_interpreters.py create mode 100644 third_party/pybind11/tests/test_native_enum.cpp create mode 100644 third_party/pybind11/tests/test_native_enum.py create mode 100644 third_party/pybind11/tests/test_numpy_array.cpp create mode 100644 third_party/pybind11/tests/test_numpy_array.py create mode 100644 third_party/pybind11/tests/test_numpy_dtypes.cpp create mode 100644 third_party/pybind11/tests/test_numpy_dtypes.py create mode 100644 third_party/pybind11/tests/test_numpy_scalars.cpp create mode 100644 third_party/pybind11/tests/test_numpy_scalars.py create mode 100644 third_party/pybind11/tests/test_numpy_vectorize.cpp create mode 100644 third_party/pybind11/tests/test_numpy_vectorize.py create mode 100644 third_party/pybind11/tests/test_opaque_types.cpp create mode 100644 third_party/pybind11/tests/test_opaque_types.py create mode 100644 third_party/pybind11/tests/test_operator_overloading.cpp create mode 100644 third_party/pybind11/tests/test_operator_overloading.py create mode 100644 third_party/pybind11/tests/test_pickling.cpp create mode 100644 third_party/pybind11/tests/test_pickling.py create mode 100644 third_party/pybind11/tests/test_potentially_slicing_weak_ptr.cpp create mode 100644 third_party/pybind11/tests/test_potentially_slicing_weak_ptr.py create mode 100644 third_party/pybind11/tests/test_python_multiple_inheritance.cpp create mode 100644 third_party/pybind11/tests/test_python_multiple_inheritance.py create mode 100644 third_party/pybind11/tests/test_pytypes.cpp create mode 100644 third_party/pybind11/tests/test_pytypes.py create mode 100644 third_party/pybind11/tests/test_scoped_critical_section.cpp create mode 100644 third_party/pybind11/tests/test_scoped_critical_section.py create mode 100644 third_party/pybind11/tests/test_sequences_and_iterators.cpp create mode 100644 third_party/pybind11/tests/test_sequences_and_iterators.py create mode 100644 third_party/pybind11/tests/test_smart_ptr.cpp create mode 100644 third_party/pybind11/tests/test_smart_ptr.py create mode 100644 third_party/pybind11/tests/test_stl.cpp create mode 100644 third_party/pybind11/tests/test_stl.py create mode 100644 third_party/pybind11/tests/test_stl_binders.cpp create mode 100644 third_party/pybind11/tests/test_stl_binders.py create mode 100644 third_party/pybind11/tests/test_tagbased_polymorphic.cpp create mode 100644 third_party/pybind11/tests/test_tagbased_polymorphic.py create mode 100644 third_party/pybind11/tests/test_thread.cpp create mode 100644 third_party/pybind11/tests/test_thread.py create mode 100644 third_party/pybind11/tests/test_type_caster_pyobject_ptr.cpp create mode 100644 third_party/pybind11/tests/test_type_caster_pyobject_ptr.py create mode 100644 third_party/pybind11/tests/test_type_caster_std_function_specializations.cpp create mode 100644 third_party/pybind11/tests/test_type_caster_std_function_specializations.py create mode 100644 third_party/pybind11/tests/test_union.cpp create mode 100644 third_party/pybind11/tests/test_union.py create mode 100644 third_party/pybind11/tests/test_unnamed_namespace_a.cpp create mode 100644 third_party/pybind11/tests/test_unnamed_namespace_a.py create mode 100644 third_party/pybind11/tests/test_unnamed_namespace_b.cpp create mode 100644 third_party/pybind11/tests/test_unnamed_namespace_b.py create mode 100644 third_party/pybind11/tests/test_vector_unique_ptr_member.cpp create mode 100644 third_party/pybind11/tests/test_vector_unique_ptr_member.py create mode 100644 third_party/pybind11/tests/test_virtual_functions.cpp create mode 100644 third_party/pybind11/tests/test_virtual_functions.py create mode 100644 third_party/pybind11/tests/test_warnings.cpp create mode 100644 third_party/pybind11/tests/test_warnings.py create mode 100644 third_party/pybind11/tests/valgrind-numpy-scipy.supp create mode 100644 third_party/pybind11/tests/valgrind-python.supp create mode 100644 third_party/pybind11/tools/FindCatch.cmake create mode 100644 third_party/pybind11/tools/FindEigen3.cmake create mode 100644 third_party/pybind11/tools/FindPythonLibsNew.cmake create mode 100644 third_party/pybind11/tools/JoinPaths.cmake create mode 100644 third_party/pybind11/tools/check-style.sh create mode 100644 third_party/pybind11/tools/cmake_uninstall.cmake.in create mode 100644 third_party/pybind11/tools/codespell_ignore_lines_from_errors.py create mode 100644 third_party/pybind11/tools/libsize.py create mode 100644 third_party/pybind11/tools/make_changelog.py create mode 100644 third_party/pybind11/tools/make_global.py create mode 100644 third_party/pybind11/tools/pybind11.pc.in create mode 100644 third_party/pybind11/tools/pybind11Common.cmake create mode 100644 third_party/pybind11/tools/pybind11Config.cmake.in create mode 100644 third_party/pybind11/tools/pybind11GuessPythonExtSuffix.cmake create mode 100644 third_party/pybind11/tools/pybind11NewTools.cmake create mode 100644 third_party/pybind11/tools/pybind11Tools.cmake create mode 100644 third_party/pybind11/tools/test-pybind11GuessPythonExtSuffix.cmake diff --git a/CMakeLists.txt b/CMakeLists.txt index f5f355b..9116f45 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,6 +1,9 @@ cmake_minimum_required(VERSION 3.22) project(MCPServer.cpp LANGUAGES CXX C VERSION 1.0.5.0) +# Add option for Python support +option(ENABLE_PYTHON_PLUGINS "Enable Python plugin support" ON) + if(UNIX AND NOT APPLE) set(CMAKE_CXX_VISIBILITY_PRESET default) set(CMAKE_POSITION_INDEPENDENT_CODE ON) @@ -89,11 +92,26 @@ add_subdirectory(src/metrics) add_subdirectory(plugins) add_subdirectory(tools) add_subdirectory(third_party/miniz) +add_subdirectory(third_party/pybind11) add_subdirectory(utils) add_subdirectory(src/Resources) add_subdirectory(src/routers) add_subdirectory(src/Prompts) +# Conditionally add Python support +if(ENABLE_PYTHON_PLUGINS) + find_package(Python COMPONENTS Interpreter Development) + if(Python_FOUND) + message(STATUS "Python found: ${Python_VERSION}") + message(STATUS "Python executable: ${Python_EXECUTABLE}") + message(STATUS "Python include dirs: ${Python_INCLUDE_DIRS}") + message(STATUS "Python libraries: ${Python_LIBRARIES}") + else() + message(WARNING "Python not found. Disabling Python plugin support.") + set(ENABLE_PYTHON_PLUGINS OFF) + endif() +endif() + # turn off mimalloc tests and examples set(MI_BUILD_TESTS OFF CACHE BOOL "Build mimalloc tests" FORCE) set(MI_BUILD_EXAMPLES OFF CACHE BOOL "Build mimalloc examples" FORCE) @@ -234,4 +252,4 @@ endif() set_target_properties(generate_cert PROPERTIES COMPILE_DEFINITIONS "OPENSSL_SUPPRESS_DEPRECATED" -) +) \ No newline at end of file diff --git a/plugins/CMakeLists.txt b/plugins/CMakeLists.txt index 0f078ff..9bd1499 100644 --- a/plugins/CMakeLists.txt +++ b/plugins/CMakeLists.txt @@ -1,3 +1,9 @@ -add_subdirectory(official) +# plugins/CMakeLists.txt + +# Add subdirectories + +add_subdirectory(pluginhub) add_subdirectory(sdk) -add_subdirectory(pluginhub) \ No newline at end of file + +# Add official plugins +add_subdirectory(official) \ No newline at end of file diff --git a/plugins/official/CMakeLists.txt b/plugins/official/CMakeLists.txt index f1aabe5..5383755 100644 --- a/plugins/official/CMakeLists.txt +++ b/plugins/official/CMakeLists.txt @@ -4,4 +4,6 @@ add_subdirectory(http_plugin) add_subdirectory(safe_system_plugin) -add_subdirectory(example_stream_plugin) \ No newline at end of file +add_subdirectory(example_stream_plugin) + +add_subdirectory(python_example_plugin) \ No newline at end of file diff --git a/plugins/official/python_example_plugin/CMakeLists.txt b/plugins/official/python_example_plugin/CMakeLists.txt new file mode 100644 index 0000000..afb81f0 --- /dev/null +++ b/plugins/official/python_example_plugin/CMakeLists.txt @@ -0,0 +1,50 @@ +# CMakeLists.txt for Python Example Plugin +cmake_minimum_required(VERSION 3.23) +project(python_example_plugin) + +# Set C++ standard +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED ON) + +# Set the path to MCPServer++ root directory +set(MCP_SERVER_ROOT "${CMAKE_CURRENT_SOURCE_DIR}/../../.." CACHE STRING "Path to MCPServer++ root directory") + +# Find required packages +find_package(Python COMPONENTS Interpreter Development REQUIRED) + +# Add the plugin library +add_library(${PROJECT_NAME} SHARED + # The pybind wrapper that exposes Python functions as C interface + ${MCP_SERVER_ROOT}/plugins/sdk/pybind_module_plugin.cpp +) + + +# Include directories +target_include_directories(${PROJECT_NAME} PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR} + # MCPServer++ include directories + ${MCP_SERVER_ROOT}/plugins/sdk + ${MCP_SERVER_ROOT}/include + ${MCP_SERVER_ROOT}/third_party/nlohmann + ${MCP_SERVER_ROOT}/third_party/pybind11/include +) + +# Add preprocessor definition for DLL export +target_compile_definitions(${PROJECT_NAME} PRIVATE MCPSERVER_API_EXPORTS) + +# Link libraries +target_link_libraries(${PROJECT_NAME} PRIVATE + pybind11::embed +) + +# Ensure the Python plugin file is available +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/python_example_plugin.py + ${CMAKE_CURRENT_BINARY_DIR}/python_example_plugin.py + COPYONLY) + +# Copy the Python file to the output directory after build +add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD + COMMAND ${CMAKE_COMMAND} -E copy + ${CMAKE_CURRENT_SOURCE_DIR}/python_example_plugin.py + $/python_example_plugin.py +) \ No newline at end of file diff --git a/plugins/official/python_example_plugin/README.md b/plugins/official/python_example_plugin/README.md new file mode 100644 index 0000000..171cbe3 --- /dev/null +++ b/plugins/official/python_example_plugin/README.md @@ -0,0 +1,106 @@ +# Python Plugin for MCPServer++ + +This is an example Python plugin for MCPServer++. It demonstrates how to create a Python plugin that can be compiled into a DLL and loaded by MCPServer++. + +## How it works + +Python plugins work by creating a DLL that wraps the Python code with a C interface. The DLL contains the standard MCP plugin functions (`get_tools`, `call_tool`, `free_result`) which interact with the Python code through pybind11. + +## Building the Plugin + +1. Make sure you have the required dependencies installed: + - Python (3.6 or higher) + - CMake (3.23 or higher) + - A C++ compiler with C++17 support + - pybind11 + +2. Copy [python_plugin_CMakeLists.txt](file:///d:/codespace/MCPServer%2B%2B/plugins/sdk/python_plugin_CMakeLists.txt) from the SDK directory to this directory and rename it to `CMakeLists.txt`: + ```bash + cp ../../sdk/python_plugin_CMakeLists.txt CMakeLists.txt + ``` + +3. Edit `CMakeLists.txt` and set the correct path to your MCPServer++ root directory: + ```cmake + set(MCP_SERVER_ROOT "/path/to/mcpserver++") + ``` + +4. Create a build directory and build the plugin: + ```bash + mkdir build + cd build + cmake .. + cmake --build . --config Release + ``` + +5. The resulting DLL file can be placed in the plugins directory of your MCPServer++ installation. + +## Plugin Structure + +- `python_example_plugin.py` - The main Python plugin code +- `CMakeLists.txt` - Build configuration (copied from the SDK) + +## Customizing the Plugin + +To create your own Python plugin: + +1. Copy this example directory and rename it +2. Modify `python_example_plugin.py` to implement your tools +3. Update the `get_tools()` function to return information about your tools +4. Update the `call_tool()` function to implement the functionality of your tools +5. Build the plugin following the steps above + +## API Reference + +### ToolInfo Class + +The `ToolInfo` class represents a tool provided by the plugin: + +```python +class ToolInfo: + def __init__(self, name, description, parameters, is_streaming=False): + self.name = name # Tool name + self.description = description # Tool description + self.parameters = parameters # JSON Schema string describing the parameters + self.is_streaming = is_streaming # Whether the tool is streaming +``` + +### get_tools() Function + +This function should return a list of `ToolInfo` objects describing the tools provided by the plugin: + +```python +def get_tools(): + return [ + ToolInfo( + name="tool_name", + description="Tool description", + parameters='{"type": "object", "properties": {...}}' + ) + ] +``` + +### call_tool() Function + +This function is called when one of the plugin's tools is invoked: + +```python +def call_tool(name, args_json): + # Parse the arguments + args = json.loads(args_json) + + # Implement tool functionality + if name == "tool_name": + # Process the tool call + result = {"result": "tool result"} + return json.dumps(result) + + # Handle unknown tools + return json.dumps({"error": {"type": "unknown_tool", "message": f"Unknown tool: {name}"}}) +``` + +## Notes + +- The plugin must be compiled into a DLL to be loaded by MCPServer++ +- The Python interpreter is embedded in the DLL, so the plugin can run without an external Python installation +- All data exchange between the C++ host and Python code happens through JSON strings +- Error handling should be done carefully to prevent crashes \ No newline at end of file diff --git a/plugins/official/python_example_plugin/build_plugin.py b/plugins/official/python_example_plugin/build_plugin.py new file mode 100644 index 0000000..da40b16 --- /dev/null +++ b/plugins/official/python_example_plugin/build_plugin.py @@ -0,0 +1,69 @@ +#!/usr/bin/env python3 +""" +Build script for Python plugins +This script simplifies the process of building Python plugins into DLLs +""" + +import os +import sys +import subprocess +import argparse +from pathlib import Path + +def build_plugin(plugin_dir, build_dir="build"): + """ + Build a Python plugin into a DLL + + Args: + plugin_dir (str): Path to the plugin directory + build_dir (str): Name of the build directory + """ + + plugin_path = Path(plugin_dir).absolute() + build_path = plugin_path / build_dir + + # Create build directory + build_path.mkdir(exist_ok=True) + + # Change to build directory + os.chdir(build_path) + + # Run CMake configuration + print("Configuring with CMake...") + cmake_config_cmd = [ + "cmake", + "..", + f"-DMCP_SERVER_ROOT={Path(__file__).parent.parent.parent.absolute()}" + ] + + result = subprocess.run(cmake_config_cmd) + if result.returncode != 0: + print("CMake configuration failed!") + return False + + # Build the plugin + print("Building plugin...") + cmake_build_cmd = ["cmake", "--build", ".", "--config", "Release"] + result = subprocess.run(cmake_build_cmd) + if result.returncode != 0: + print("Build failed!") + return False + + print("Build completed successfully!") + return True + +def main(): + parser = argparse.ArgumentParser(description="Build Python plugin for MCPServer++") + parser.add_argument("--plugin-dir", default=".", help="Path to plugin directory (default: current directory)") + parser.add_argument("--build-dir", default="build", help="Build directory name (default: build)") + + args = parser.parse_args() + + if build_plugin(args.plugin_dir, args.build_dir): + print("Plugin built successfully!") + else: + print("Failed to build plugin!") + sys.exit(1) + +if __name__ == "__main__": + main() \ No newline at end of file diff --git a/plugins/official/python_example_plugin/python_example_plugin.py b/plugins/official/python_example_plugin/python_example_plugin.py new file mode 100644 index 0000000..94b8a88 --- /dev/null +++ b/plugins/official/python_example_plugin/python_example_plugin.py @@ -0,0 +1,82 @@ +""" +Example Python Plugin for MCPServer++ + +This plugin demonstrates how to create a Python plugin that can be compiled into +a DLL and loaded by MCPServer++. + +To compile this plugin into a DLL: +1. Copy the python_plugin_CMakeLists.txt to this directory and rename it to CMakeLists.txt +2. Modify the MCP_SERVER_ROOT path in CMakeLists.txt +3. Build using CMake as described in the CMakeLists.txt file +""" + +class ToolInfo: + """Tool information structure""" + def __init__(self, name, description, parameters, is_streaming=False): + self.name = name + self.description = description + self.parameters = parameters # JSON Schema string + self.is_streaming = is_streaming + +def get_tools(): + """ + Get the list of tools provided by this plugin + This function will be called by the C++ wrapper + """ + return [ + ToolInfo( + name="python_echo", + description="Echo back the input text", + parameters='{"type": "object", "properties": {"text": {"type": "string", "description": "Text to echo"}}, "required": ["text"]}' + ), + ToolInfo( + name="python_calculate", + description="Perform a simple calculation", + parameters='{"type": "object", "properties": {"expression": {"type": "string", "description": "Mathematical expression to evaluate"}}, "required": ["expression"]}' + ) + ] + +def call_tool(name, args_json): + """ + Call a specific tool with arguments + This function will be called by the C++ wrapper + + Args: + name: Tool name + args_json: JSON string with tool arguments + + Returns: + JSON string with tool result + """ + import json + + try: + args = json.loads(args_json) if args_json else {} + except json.JSONDecodeError: + return json.dumps({"error": {"type": "invalid_json", "message": "Invalid JSON in arguments"}}) + + if name == "python_echo": + text = args.get("text", "") + return json.dumps({"result": text}) + + elif name == "python_calculate": + expression = args.get("expression", "") + try: + result = eval(expression, {"__builtins__": {}}, {}) + return json.dumps({"result": result}) + except Exception as e: + return json.dumps({"error": {"type": "calculation_error", "message": str(e)}}) + + else: + return json.dumps({"error": {"type": "unknown_tool", "message": f"Unknown tool: {name}"}}) + +# For testing purposes when running the script directly +if __name__ == "__main__": + # This section is for testing the plugin directly + print("Tools:", [tool.name for tool in get_tools()]) + + result = call_tool("python_echo", '{"text": "Hello from Python!"}') + print("Echo result:", result) + + result = call_tool("python_calculate", '{"expression": "2+2"}') + print("Calculation result:", result) \ No newline at end of file diff --git a/plugins/official/python_example_plugin/tools.json b/plugins/official/python_example_plugin/tools.json new file mode 100644 index 0000000..96b2cd1 --- /dev/null +++ b/plugins/official/python_example_plugin/tools.json @@ -0,0 +1,32 @@ +{ + "tools": [ + { + "name": "python_echo", + "description": "Echo back the input text", + "parameters": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "Text to echo" + } + }, + "required": ["text"] + } + }, + { + "name": "python_calculate", + "description": "Perform a simple calculation", + "parameters": { + "type": "object", + "properties": { + "expression": { + "type": "string", + "description": "Mathematical expression to evaluate" + } + }, + "required": ["expression"] + } + } + ] +} \ No newline at end of file diff --git a/plugins/sdk/CMakeLists.txt b/plugins/sdk/CMakeLists.txt index d5891f1..653fada 100644 --- a/plugins/sdk/CMakeLists.txt +++ b/plugins/sdk/CMakeLists.txt @@ -1,48 +1,52 @@ -# plugins/sdk/CMakeLists.txt +set(TARGET_NAME mcp_plugin_sdk) + +# Source files set(SDK_SOURCES tool_info_parser.cpp tool_info_parser.h ) -add_library(mcp_plugin_sdk ${SDK_SOURCES}) - -target_include_directories(mcp_plugin_sdk PUBLIC - $ - $ - $ - $ - $ - $ +set(HEADERS + mcp_plugin.h + tool_info_parser.h ) -target_compile_features(mcp_plugin_sdk PUBLIC cxx_std_20) +add_library(${TARGET_NAME} ${SDK_SOURCES} ${HEADERS}) + -if(WIN32) - if(MSVC) - target_compile_options(mcp_plugin_sdk PRIVATE /W4 /permissive-) - endif() -else() - target_compile_options(mcp_plugin_sdk PRIVATE -Wall -Wextra) -endif() +target_include_directories(${TARGET_NAME} + PUBLIC + $ + $ + PRIVATE + $ + $ + $ + $ +) + +target_compile_features(${TARGET_NAME} PRIVATE cxx_std_17) -# Link required libraries for the SDK -target_link_libraries(mcp_plugin_sdk PRIVATE - mcp_core - mcp_protocol +# Link required libraries +target_link_libraries(${TARGET_NAME} + PUBLIC + mcp_core + mcp_protocol ) +target_compile_definitions(${TARGET_NAME} PUBLIC MCPSERVER_API_EXPORTS) + # Conditionally install the library and headers if(CPACK_INCLUDE_LIBS) - install(TARGETS mcp_plugin_sdk + install(TARGETS ${TARGET_NAME} EXPORT MCPServer++Targets LIBRARY DESTINATION lib ARCHIVE DESTINATION lib RUNTIME DESTINATION bin + INCLUDES DESTINATION include ) - - install(FILES - mcp_plugin.h - tool_info_parser.h + + install(FILES ${HEADERS} DESTINATION include/mcp/plugin_sdk ) endif() \ No newline at end of file diff --git a/plugins/sdk/mcp_python_plugin.py b/plugins/sdk/mcp_python_plugin.py new file mode 100644 index 0000000..df29fbb --- /dev/null +++ b/plugins/sdk/mcp_python_plugin.py @@ -0,0 +1,198 @@ +""" +MCPServer++ Python Plugin SDK + +This module provides the base classes and utilities for creating Python plugins +that can be loaded by the MCPServer++. + +Example usage: +```python +from mcp_python_plugin import MCPPlugin, ToolInfo + +class MyPlugin(MCPPlugin): + def get_tools(self): + return [ + ToolInfo( + name="hello_world", + description="A simple hello world tool", + parameters='{"type": "object", "properties": {}}' + ) + ] + + def call_tool(self, name, args_json): + if name == "hello_world": + return '{"result": "Hello, World!"}' + else: + raise ValueError(f"Unknown tool: {name}") + +# Create plugin instance +plugin = MyPlugin() + +# Export required functions +get_tools = plugin.get_tools_wrapper +call_tool = plugin.call_tool_wrapper +free_result = plugin.free_result_wrapper +``` +""" + +import json +import ctypes +from typing import List, Optional, Any +from dataclasses import dataclass +from abc import ABC, abstractmethod + +@dataclass +class ToolInfo: + """Tool information structure""" + name: str + description: str + parameters: str # JSON Schema string + is_streaming: bool = False + +@dataclass +class MCPError: + """Error information structure""" + code: int = 0 + message: str = "" + details: str = "" + source: str = "" + +class MCPPlugin(ABC): + """ + Base class for MCP Python plugins + """ + + def __init__(self): + self._results = {} # Store results to prevent garbage collection + self._result_counter = 0 + + @abstractmethod + def get_tools(self) -> List[ToolInfo]: + """ + Get the list of tools provided by this plugin + """ + pass + + @abstractmethod + def call_tool(self, name: str, args_json: str) -> str: + """ + Call a specific tool with arguments + + Args: + name: Tool name + args_json: JSON string with tool arguments + + Returns: + JSON string with tool result + """ + pass + + def get_tools_wrapper(self, count) -> ctypes.POINTER(ToolInfo): + """ + Wrapper for the get_tools function to be exported + """ + try: + tools = self.get_tools() + count.contents.value = len(tools) + + # Convert to ctypes array + ToolInfoArray = ToolInfo * len(tools) + self._tools_array = ToolInfoArray(*tools) + return ctypes.cast(self._tools_array, ctypes.POINTER(ToolInfo)) + except Exception as e: + count.contents.value = 0 + return None + + def call_tool_wrapper(self, name: ctypes.c_char_p, args_json: ctypes.c_char_p, error: ctypes.POINTER(MCPError)) -> ctypes.c_char_p: + """ + Wrapper for the call_tool function to be exported + """ + try: + name_str = name.decode('utf-8') if name else "" + args_str = args_json.decode('utf-8') if args_json else "{}" + + result = self.call_tool(name_str, args_str) + + # Store result to prevent garbage collection + self._result_counter += 1 + result_key = self._result_counter + self._results[result_key] = result + + # Return as c_char_p + return ctypes.c_char_p(result.encode('utf-8')) + except Exception as e: + if error: + error.contents.code = -1 + error.contents.message = str(e) + return None + + def free_result_wrapper(self, result: ctypes.c_char_p): + """ + Wrapper for the free_result function to be exported + """ + # In Python, we don't need to manually free memory, + # but we can remove it from our tracking dict + try: + if result: + # Find and remove the result from our tracking dict + result_str = ctypes.cast(result, ctypes.c_char_p).value + if result_str: + # Find the key for this result and remove it + keys_to_remove = [] + for key, value in self._results.items(): + if value.encode('utf-8') == result_str: + keys_to_remove.append(key) + + for key in keys_to_remove: + del self._results[key] + except Exception: + pass # Ignore errors in cleanup + +# Example plugin implementation +class ExamplePlugin(MCPPlugin): + """ + Example plugin implementation showing how to create a Python plugin + """ + + def get_tools(self) -> List[ToolInfo]: + return [ + ToolInfo( + name="python_echo", + description="Echo back the input text", + parameters='{"type": "object", "properties": {"text": {"type": "string", "description": "Text to echo"}}, "required": ["text"]}' + ), + ToolInfo( + name="python_calculate", + description="Perform a simple calculation", + parameters='{"type": "object", "properties": {"expression": {"type": "string", "description": "Mathematical expression to evaluate"}}, "required": ["expression"]}' + ) + ] + + def call_tool(self, name: str, args_json: str) -> str: + args = json.loads(args_json) if args_json else {} + + if name == "python_echo": + text = args.get("text", "") + return json.dumps({"result": text}) + + elif name == "python_calculate": + expression = args.get("expression", "") + try: + result = eval(expression) + return json.dumps({"result": result}) + except Exception as e: + return json.dumps({"error": {"type": "calculation_error", "message": str(e)}}) + + else: + raise ValueError(f"Unknown tool: {name}") + +# For testing purposes +if __name__ == "__main__": + # This section is for testing the plugin directly + plugin = ExamplePlugin() + print("Tools:", plugin.get_tools()) + + result = plugin.call_tool("python_echo", '{"text": "Hello from Python!"}') + print("Echo result:", result) + + result = plugin.call_tool("python_calculate", '{"expression": "2+2"}') + print("Calculation result:", result) \ No newline at end of file diff --git a/plugins/sdk/pybind_module.cpp b/plugins/sdk/pybind_module.cpp new file mode 100644 index 0000000..34c172a --- /dev/null +++ b/plugins/sdk/pybind_module.cpp @@ -0,0 +1,191 @@ +/* +#include +#include +#include +#include +#include +#include +#include +#include +#include "mcp_plugin.h" +#include "../src/core/mcpserver_api.h" +namespace py = pybind11; +namespace fs = std::filesystem; + +// Global variables to hold the Python interpreter and module +static std::unique_ptr g_interpreter; +static py::module_ g_plugin_module; +static std::vector g_tools_cache; + +// Initialize Python and load the plugin module +static bool initialize_python_plugin(const std::string& plugin_dir) { + try { + // Initialize the Python interpreter if not already done + if (!g_interpreter) { + g_interpreter = std::make_unique(); + } + + // Add the plugin directory to Python path + py::module_ sys = py::module_::import("sys"); + sys.attr("path").attr("append")(plugin_dir); + + return true; + } catch (const std::exception& e) { + std::cerr << "Failed to initialize Python: " << e.what() << std::endl; + return false; + } +} + +// Load the plugin module +static bool load_plugin_module(const std::string& module_name) { + try { + g_plugin_module = py::module_::import(module_name.c_str()); + return true; + } catch (const std::exception& e) { + std::cerr << "Failed to load plugin module '" << module_name << "': " << e.what() << std::endl; + return false; + } +} + +extern "C" { + // Get tools function + MCP_API ToolInfo* get_tools(int* count) { + try { + // Clear the cache + for (auto& tool : g_tools_cache) { + // Clean up previous allocations + delete[] const_cast(tool.name); + delete[] const_cast(tool.description); + delete[] const_cast(tool.parameters); + } + g_tools_cache.clear(); + + // Call Python function + py::object get_tools_func = g_plugin_module.attr("get_tools"); + py::list tools_list = get_tools_func(); + + *count = static_cast(py::len(tools_list)); + g_tools_cache.reserve(*count); + + // Convert Python objects to ToolInfo structures + for (const auto& tool_obj : tools_list) { + ToolInfo tool{}; + + // Extract string fields and make copies + std::string name = py::str(tool_obj.attr("name")).cast(); + std::string description = py::str(tool_obj.attr("description")).cast(); + std::string parameters = py::str(tool_obj.attr("parameters")).cast(); + + // Allocate memory for strings (will be freed by the server or when cache is cleared) + tool.name = new char[name.length() + 1]; + tool.description = new char[description.length() + 1]; + tool.parameters = new char[parameters.length() + 1]; + + std::strcpy(const_cast(tool.name), name.c_str()); + std::strcpy(const_cast(tool.description), description.c_str()); + std::strcpy(const_cast(tool.parameters), parameters.c_str()); + + tool.is_streaming = tool_obj.attr("is_streaming").cast(); + + g_tools_cache.push_back(tool); + } + + return g_tools_cache.data(); + } catch (const std::exception& e) { + std::cerr << "Error in get_tools: " << e.what() << std::endl; + *count = 0; + return nullptr; + } + } + + // Call tool function + MCP_API const char* call_tool(const char* name, const char* args_json, MCPError* error) { + try { + py::object call_tool_func = g_plugin_module.attr("call_tool"); + py::object result = call_tool_func(std::string(name), std::string(args_json)); + std::string result_str = py::str(result).cast(); + + // Allocate memory for the result (will be freed by free_result) + char* result_cstr = new char[result_str.length() + 1]; + std::strcpy(result_cstr, result_str.c_str()); + + return result_cstr; + } catch (const std::exception& e) { + if (error) { + error->code = -1; + error->message = strdup(e.what()); + } + return nullptr; + } + } + + // Free result function + MCP_API void free_result(const char* result) { + if (result) { + delete[] result; + } + } + + // Initialize plugin function - this should be called by the plugin system + // before any other functions + MCP_API bool initialize_plugin() { + try { + // Get the directory of the current DLL + std::string plugin_dir = "."; // Default to current directory + + // Try to initialize Python environment + if (!initialize_python_plugin(plugin_dir)) { + std::cerr << "Failed to initialize Python environment" << std::endl; + return false; + } + + // Try to load the Python plugin module + if (!load_plugin_module("python_example_plugin")) { + std::cerr << "Failed to load Python plugin module" << std::endl; + return false; + } + + return true; + } catch (const std::exception& e) { + std::cerr << "Failed to initialize plugin: " << e.what() << std::endl; + return false; + } + } + + // Constructor function that is called when the DLL is loaded + #ifdef _WIN32 + #include + + // Use proper Windows API decoration + BOOL APIENTRY DllMain(HMODULE hModule, DWORD ul_reason_for_call, LPVOID lpReserved) { + switch (ul_reason_for_call) { + case DLL_PROCESS_ATTACH: + // Initialize the plugin when the DLL is loaded + if (!initialize_plugin()) { + // If initialization fails, we could log an error or take other actions + std::cerr << "Plugin initialization failed during DLL_PROCESS_ATTACH" << std::endl; + // Note: Returning FALSE would prevent the DLL from loading + // return FALSE; + } + break; + case DLL_THREAD_ATTACH: + case DLL_THREAD_DETACH: + case DLL_PROCESS_DETACH: + break; + } + return TRUE; + } + #endif +} + +// PYBIND11_MODULE definition with proper export - allows the DLL to also be imported as a Python module +#define PYBIND11_EXPORTS // Ensure proper symbol exports +PYBIND11_MODULE(mcp_python_plugin, m) { + m.doc() = "MCPServer++ Python Plugin Support Module"; + + // This is just for testing that the module can be imported + m.def("test_initialization", []() { + return "Python plugin support module loaded"; + }); +} + */ \ No newline at end of file diff --git a/plugins/sdk/pybind_module_plugin.cpp b/plugins/sdk/pybind_module_plugin.cpp new file mode 100644 index 0000000..441f12a --- /dev/null +++ b/plugins/sdk/pybind_module_plugin.cpp @@ -0,0 +1,212 @@ +#include +#include +#include +#include +#include +#include +#include +#include +#include "mcp_plugin.h" +#include "../src/core/mcpserver_api.h" + +#ifdef _WIN32 +#include +#endif + +namespace py = pybind11; +namespace fs = std::filesystem; + +// Global variables to hold the Python interpreter and module +static std::unique_ptr g_interpreter; +static py::module_ g_plugin_module; +static std::vector g_tools_cache; +static bool g_initialized = false; + +// Initialize Python and load the plugin module +static bool initialize_python_plugin(const std::string& plugin_dir) { + try { + std::cerr << "[PLUGIN] Initializing Python interpreter in directory: " << plugin_dir << std::endl; + + // Initialize the Python interpreter if not already done + if (!g_interpreter) { + g_interpreter = std::make_unique(); + std::cerr << "[PLUGIN] Python interpreter initialized successfully" << std::endl; + } + + // Add the plugin directory to Python path + py::module_ sys = py::module_::import("sys"); + sys.attr("path").attr("append")(plugin_dir); + + return true; + } catch (const std::exception& e) { + std::cerr << "Failed to initialize Python: " << e.what() << std::endl; + return false; + } +} + +// Load the plugin module +static bool load_plugin_module(const std::string& module_name) { + try { + std::cerr << "[PLUGIN] Loading module: " << module_name << std::endl; + g_plugin_module = py::module_::import(module_name.c_str()); + std::cerr << "[PLUGIN] Module loaded successfully" << std::endl; + return true; + } catch (const std::exception& e) { + std::cerr << "Failed to load plugin module '" << module_name << "': " << e.what() << std::endl; + return false; + } +} + +extern "C" { + // Get tools function + MCP_API ToolInfo* get_tools(int* count) { + if (!g_initialized) { + std::cerr << "[PLUGIN] Error: Plugin not initialized before calling get_tools" << std::endl; + *count = 0; + return nullptr; + } + + try { + // Clear the cache + for (auto& tool : g_tools_cache) { + // Clean up previous allocations + delete[] const_cast(tool.name); + delete[] const_cast(tool.description); + delete[] const_cast(tool.parameters); + } + g_tools_cache.clear(); + + // Call Python function + py::object get_tools_func = g_plugin_module.attr("get_tools"); + py::list tools_list = get_tools_func(); + + *count = static_cast(py::len(tools_list)); + g_tools_cache.reserve(*count); + + // Convert Python objects to ToolInfo structures + for (const auto& tool_obj : tools_list) { + ToolInfo tool{}; + + // Extract string fields and make copies + std::string name = py::str(tool_obj.attr("name")).cast(); + std::string description = py::str(tool_obj.attr("description")).cast(); + std::string parameters = py::str(tool_obj.attr("parameters")).cast(); + + // Allocate memory for strings (will be freed by the server or when cache is cleared) + tool.name = new char[name.length() + 1]; + tool.description = new char[description.length() + 1]; + tool.parameters = new char[parameters.length() + 1]; + + std::strcpy(const_cast(tool.name), name.c_str()); + std::strcpy(const_cast(tool.description), description.c_str()); + std::strcpy(const_cast(tool.parameters), parameters.c_str()); + + tool.is_streaming = tool_obj.attr("is_streaming").cast(); + + g_tools_cache.push_back(tool); + } + + return g_tools_cache.data(); + } catch (const std::exception& e) { + std::cerr << "Error in get_tools: " << e.what() << std::endl; + *count = 0; + return nullptr; + } + } + + // Call tool function + MCP_API const char* call_tool(const char* name, const char* args_json, MCPError* error) { + if (!g_initialized) { + std::cerr << "[PLUGIN] Error: Plugin not initialized before calling call_tool" << std::endl; + if (error) { + error->code = -1; + std::string error_msg = "Plugin not initialized"; + error->message = new char[error_msg.length() + 1]; + std::strcpy(const_cast(error->message), error_msg.c_str()); + } + return nullptr; + } + + try { + std::cerr << "[PLUGIN] Calling tool: " << name << std::endl; + py::object call_tool_func = g_plugin_module.attr("call_tool"); + py::object result = call_tool_func(py::str(name), py::str(args_json)); + + // Use Python's built-in string conversion to ensure proper encoding + py::str result_str_obj = py::str(result); + std::string result_str = result_str_obj.cast(); + + // Allocate memory for the result (will be freed by free_result) + char* result_cstr = new char[result_str.length() + 1]; + std::strcpy(result_cstr, result_str.c_str()); + + return result_cstr; + } catch (const std::exception& e) { + if (error) { + error->code = -1; + // Make a copy of the error message + std::string error_msg = e.what(); + error->message = new char[error_msg.length() + 1]; + std::strcpy(const_cast(error->message), error_msg.c_str()); + } + return nullptr; + } + } + + // Free result function + MCP_API void free_result(const char* result) { + delete[] result; + } + + // Free error function + MCP_API void free_error(MCPError* error) { + if (error && error->message) { + delete[] error->message; + } + } + + // Initialize plugin function + MCP_API bool initialize_plugin(const char* plugin_path) { + try { + std::string plugin_path_str(plugin_path); + fs::path path(plugin_path_str); + + // Extract directory and module name + std::string plugin_dir = path.parent_path().string(); + std::string module_name = path.stem().string(); + + std::cerr << "[PLUGIN] initialize_plugin called with path: " << plugin_path_str << std::endl; + std::cerr << "[PLUGIN] plugin_dir: " << plugin_dir << ", module_name: " << module_name << std::endl; + + // Initialize Python + if (!initialize_python_plugin(plugin_dir)) { + std::cerr << "[PLUGIN] Failed to initialize Python plugin" << std::endl; + return false; + } + + // Load the plugin module + if (!load_plugin_module(module_name)) { + std::cerr << "[PLUGIN] Failed to load plugin module" << std::endl; + return false; + } + + g_initialized = true; + std::cerr << "[PLUGIN] Plugin initialized successfully" << std::endl; + return true; + } catch (const std::exception& e) { + std::cerr << "Error initializing plugin: " << e.what() << std::endl; + return false; + } + } +} + +// PYBIND11_MODULE definition with proper export - allows the DLL to also be imported as a Python module +#define PYBIND11_EXPORTS // Ensure proper symbol exports +PYBIND11_MODULE(mcp_python_plugin, m) { + m.doc() = "MCPServer++ Python Plugin Support Module"; + + // This is just for testing that the module can be imported + m.def("test_initialization", []() { + return "Python plugin support module loaded"; + }); +} \ No newline at end of file diff --git a/plugins/sdk/python_plugin_CMakeLists.txt b/plugins/sdk/python_plugin_CMakeLists.txt new file mode 100644 index 0000000..57edee5 --- /dev/null +++ b/plugins/sdk/python_plugin_CMakeLists.txt @@ -0,0 +1,50 @@ +# CMakeLists.txt template for building Python plugins as DLLs for MCPServer++ +# Copy this file to your plugin directory and modify as needed + +cmake_minimum_required(VERSION 3.23) +project(PYTHON_PLUGIN_NAME) + +# Set C++ standard +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED ON) + +# Set the path to MCPServer++ root directory +set(MCP_SERVER_ROOT "path/to/mcpserver++" CACHE STRING "Path to MCPServer++ root directory") + +# Find required packages +find_package(Python COMPONENTS Interpreter Development REQUIRED) +# Add the plugin library +add_library(${PROJECT_NAME} SHARED + # Add your plugin source files here + # ${MCP_SERVER_ROOT}/plugins/sdk/pybind_module.cpp +) + +# Include directories +target_include_directories(${PROJECT_NAME} PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR} + ${pybind11_INCLUDE_DIRS} + # MCPServer++ include directories + ${MCP_SERVER_ROOT}/plugins/sdk + ${MCP_SERVER_ROOT}/include + ${MCP_SERVER_ROOT}/third_party/nlohmann +) + +# Link libraries +target_link_libraries(${PROJECT_NAME} PRIVATE + pybind11::embed +) + +# Platform-specific settings +if(WIN32) + # Windows-specific settings + target_compile_definitions(${PROJECT_NAME} PRIVATE MCP_API=__declspec(dllexport)) +else() + # Unix-specific settings + target_compile_definitions(${PROJECT_NAME} PRIVATE MCP_API=) +endif() + +# Example usage: +# mkdir build +# cd build +# cmake .. -DMCP_SERVER_ROOT=/path/to/mcpserver++ +# cmake --build . --config Release \ No newline at end of file diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt index b7b4c46..d0e2c7a 100644 --- a/src/core/CMakeLists.txt +++ b/src/core/CMakeLists.txt @@ -6,6 +6,8 @@ add_library(mcp_core ${CORE_SOURCES}) target_include_directories(mcp_core PUBLIC $ + $ + $ $ $ $ diff --git a/tests/test_python_plugin.py b/tests/test_python_plugin.py new file mode 100644 index 0000000..e310102 --- /dev/null +++ b/tests/test_python_plugin.py @@ -0,0 +1,210 @@ +""" +MCP HTTP Server Tester for Python Plugin +""" + +import asyncio +import json +import aiohttp +from typing import Dict, Any + +class MCPHTTPTester: + """MCP Server HTTP Tester""" + + def __init__(self, server_url: str = "http://127.0.0.1:6666/mcp"): + self.server_url = server_url + self.session = None + self.headers = { + "Content-Type": "application/json", + "Connection": "keep-alive" # Keep connection alive + } + + async def connect(self): + """Establish HTTP persistent session""" + self.session = aiohttp.ClientSession( + connector=aiohttp.TCPConnector(force_close=False), + headers=self.headers + ) + print("🚀 HTTP persistent session established") + + async def send_request(self, request: Dict[str, Any]) -> Dict[str, Any]: + """Send JSON-RPC request via HTTP""" + if not self.session: + raise RuntimeError("Please call connect() to establish session first") + + try: + async with self.session.post( + self.server_url, + data=json.dumps(request) + ) as response: + if response.status not in (200, 202): + raise RuntimeError(f"HTTP request failed: Status code {response.status}") + + response_data = await response.text() + return json.loads(response_data) if response_data else {} + + except Exception as e: + print(f"Request sending failed: {str(e)}") + raise + + async def test_initialize(self): + """Test initialization request""" + print("\n🔍 Testing initialization...") + + request = { + "jsonrpc": "2.0", + "id": 1, + "method": "initialize", + "params": { + "protocolVersion": "2024-11-05", + "capabilities": { + "tools": {"listChanged": True}, + "resources": {"subscribe": True, "listChanged": True}, + "prompts": {"listChanged": True} + }, + "clientInfo": { + "name": "MCP Test Client", + "version": "1.0.0" + } + } + } + + response = await self.send_request(request) + print(f"Response: {json.dumps(response, indent=2, ensure_ascii=False)}") + + assert response.get("jsonrpc") == "2.0", "Invalid JSON-RPC version" + assert "id" in response and response["id"] == 1, "Response ID mismatch" + assert "result" in response, "Response missing result field" + assert "capabilities" in response["result"], "Response missing capabilities field" + print("√ Initialization test passed") + return response + + async def test_initialized_notification(self): + print("\n🔍 Testing initialized notification...") + + request = { + "jsonrpc": "2.0", + "method": "notifications/initialized", + "params": {} + } + + try: + async with asyncio.timeout(5): + async with self.session.post( + self.server_url, + data=json.dumps(request) + ) as response: + assert response.status == 202, f"Notification status error: {response.status}" + except asyncio.TimeoutError: + print("× Notification request timeout") + raise + except Exception as e: + print(f"× Notification sending error: {str(e)}") + raise + + print("√ initialized notification test completed") + + async def test_list_tools(self): + """Test tool list request""" + print("\n🔍 Testing tool list...") + + request = { + "jsonrpc": "2.0", + "id": 2, + "method": "tools/list", + "params": {} + } + + response = await self.send_request(request) + print(f"Response: {json.dumps(response, indent=2, ensure_ascii=False)}") + + assert response.get("jsonrpc") == "2.0" + assert "id" in response and response["id"] == 2 + assert "result" in response + assert "tools" in response["result"], "Response missing tool list" + print(f"√ Tool list test passed (found {len(response['result']['tools'])} tools)") + # Return tool list for subsequent tests + return response["result"]["tools"] + + async def test_tool_invoke(self, tool_name: str, params: Dict[str, Any], request_id: int): + """Test invoking tool""" + print(f"\n🔍 Testing tool invocation: {tool_name}...") + + request = { + "jsonrpc": "2.0", + "id": request_id, + "method": "tools/call", + "params": { + "name": tool_name, + "arguments": params + } + } + + response = await self.send_request(request) + print(f"Response: {json.dumps(response, indent=2, ensure_ascii=False)}") + + assert response.get("jsonrpc") == "2.0" + assert "id" in response and response["id"] == request_id + assert "error" not in response, f"Tool invocation error: {response.get('error', {}).get('message')}" + print(f"√ {tool_name} tool test passed") + return response + + async def close(self): + """Close session""" + if self.session: + await self.session.close() + print("🛑 HTTP session closed") + + async def run_python_plugin_tests(self): + """Run Python plugin tests""" + try: + await self.connect() + + # Test sequence: initialize -> send initialized notification -> test tools + await self.test_initialize() + await asyncio.sleep(0.5) # Give server time to process + + await self.test_initialized_notification() + await asyncio.sleep(0.5) + + # Get tool list for subsequent tests + tools = await self.test_list_tools() + await asyncio.sleep(0.5) + + # Extract available tool names + available_tools = [tool["name"] for tool in tools] + print(f"\n📋 Available tools: {available_tools}") + + # Test Python plugin tools + python_test_cases = [ + ("python_echo", {"text": "Hello from Python!"}, 10), + ("python_calculate", {"expression": "2+2"}, 11), + ("python_calculate", {"expression": "3*4"}, 12), + ("python_calculate", {"expression": "10/2"}, 13), + ("python_calculate", {"expression": "2**3"}, 14), + ] + + # Run tests only for available tools + for tool_name, params, req_id in python_test_cases: + if tool_name in available_tools: + await self.test_tool_invoke(tool_name, params, req_id) + await asyncio.sleep(0.5) + else: + print(f" Skipping unregistered tool: {tool_name}") + + print("\n🎉 All Python plugin tests passed!") + + except AssertionError as e: + print(f"\n× Test assertion failed: {e}") + except Exception as e: + print(f"\n× Test failed: {e}") + finally: + await self.close() + +async def main(): + """Main function""" + server_url = "http://127.0.0.1:6666/mcp" # Match your server address + tester = MCPHTTPTester(server_url) + await tester.run_python_plugin_tests() + +if __name__ == "__main__": + asyncio.run(main()) \ No newline at end of file diff --git a/tests/test_server_manual.py b/tests/test_server_manual.py index 35cda3e..4262fb6 100644 --- a/tests/test_server_manual.py +++ b/tests/test_server_manual.py @@ -186,6 +186,10 @@ async def run_all_tests(self): ("http_get", {"url": "http://httpbin.org/get"}, 7), # International test site ("http_get", {"url": "http://baidu.com"}, 8), # Chinese site for domestic users ("list_files", {"path": "."}, 9), # Test current directory + + # Test Python plugin tools + ("python_echo", {"text": "Hello from Python!"}, 10), + ("python_calculate", {"expression": "2+2"}, 11), ] # Run tests only for available tools diff --git a/third_party/pybind11/.appveyor.yml b/third_party/pybind11/.appveyor.yml new file mode 100644 index 0000000..391cf10 --- /dev/null +++ b/third_party/pybind11/.appveyor.yml @@ -0,0 +1,35 @@ +version: 1.0.{build} +image: +- Visual Studio 2017 +test: off +skip_branch_with_pr: true +build: + parallel: true +platform: +- x86 +environment: + matrix: + - PYTHON: 38 + CONFIG: Debug +install: +- ps: | + $env:CMAKE_GENERATOR = "Visual Studio 15 2017" + if ($env:PLATFORM -eq "x64") { $env:PYTHON = "$env:PYTHON-x64" } + $env:PATH = "C:\Python$env:PYTHON\;C:\Python$env:PYTHON\Scripts\;$env:PATH" + python -W ignore -m pip install --upgrade pip wheel + python -W ignore -m pip install pytest numpy --no-warn-script-location pytest-timeout +- ps: | + Start-FileDownload 'https://gitlab.com/libeigen/eigen/-/archive/3.3.7/eigen-3.3.7.zip' + 7z x eigen-3.3.7.zip -y > $null + $env:CMAKE_INCLUDE_PATH = "eigen-3.3.7;$env:CMAKE_INCLUDE_PATH" +build_script: +- cmake -G "%CMAKE_GENERATOR%" -A "%CMAKE_ARCH%" + -DCMAKE_CXX_STANDARD=14 + -DPYBIND11_WERROR=ON + -DDOWNLOAD_CATCH=ON + -DCMAKE_SUPPRESS_REGENERATION=1 + . +- set MSBuildLogger="C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll" +- cmake --build . --config %CONFIG% --target pytest -- /m /v:m /logger:%MSBuildLogger% +- cmake --build . --config %CONFIG% --target cpptest -- /m /v:m /logger:%MSBuildLogger% +on_failure: if exist "tests\test_cmake_build" type tests\test_cmake_build\*.log* diff --git a/third_party/pybind11/.clang-format b/third_party/pybind11/.clang-format new file mode 100644 index 0000000..b477a16 --- /dev/null +++ b/third_party/pybind11/.clang-format @@ -0,0 +1,38 @@ +--- +# See all possible options and defaults with: +# clang-format --style=llvm --dump-config +BasedOnStyle: LLVM +AccessModifierOffset: -4 +AllowShortLambdasOnASingleLine: true +AlwaysBreakTemplateDeclarations: Yes +BinPackArguments: false +BinPackParameters: false +BreakBeforeBinaryOperators: All +BreakConstructorInitializers: BeforeColon +ColumnLimit: 99 +CommentPragmas: 'NOLINT:.*|^ IWYU pragma:' +IncludeBlocks: Regroup +IndentCaseLabels: true +IndentPPDirectives: AfterHash +IndentWidth: 4 +Language: Cpp +SpaceAfterCStyleCast: true +Standard: Cpp11 +StatementMacros: ['PyObject_HEAD'] +TabWidth: 4 +IncludeCategories: + - Regex: '' + Priority: 4 + - Regex: '.*' + Priority: 5 +... diff --git a/third_party/pybind11/.clang-tidy b/third_party/pybind11/.clang-tidy new file mode 100644 index 0000000..3a1995c --- /dev/null +++ b/third_party/pybind11/.clang-tidy @@ -0,0 +1,80 @@ +FormatStyle: file + +Checks: | + *bugprone*, + *performance*, + clang-analyzer-optin.cplusplus.VirtualCall, + clang-analyzer-optin.performance.Padding, + cppcoreguidelines-init-variables, + cppcoreguidelines-prefer-member-initializer, + cppcoreguidelines-pro-type-static-cast-downcast, + cppcoreguidelines-slicing, + google-explicit-constructor, + llvm-namespace-comment, + misc-definitions-in-headers, + misc-misplaced-const, + misc-non-copyable-objects, + misc-static-assert, + misc-throw-by-value-catch-by-reference, + misc-uniqueptr-reset-release, + misc-unused-parameters, + modernize-avoid-bind, + modernize-loop-convert, + modernize-make-shared, + modernize-redundant-void-arg, + modernize-replace-auto-ptr, + modernize-replace-disallow-copy-and-assign-macro, + modernize-replace-random-shuffle, + modernize-shrink-to-fit, + modernize-use-auto, + modernize-use-bool-literals, + modernize-use-default-member-init, + modernize-use-emplace, + modernize-use-equals-default, + modernize-use-equals-delete, + modernize-use-noexcept, + modernize-use-nullptr, + modernize-use-override, + modernize-use-using, + readability-avoid-const-params-in-decls, + readability-braces-around-statements, + readability-const-return-type, + readability-container-size-empty, + readability-delete-null-pointer, + readability-else-after-return, + readability-implicit-bool-conversion, + readability-inconsistent-declaration-parameter-name, + readability-make-member-function-const, + readability-misplaced-array-index, + readability-non-const-parameter, + readability-qualified-auto, + readability-redundant-function-ptr-dereference, + readability-redundant-smartptr-get, + readability-redundant-string-cstr, + readability-simplify-subscript-expr, + readability-static-accessed-through-instance, + readability-static-definition-in-anonymous-namespace, + readability-string-compare, + readability-suspicious-call-argument, + readability-uniqueptr-delete-release, + -bugprone-chained-comparison, + -bugprone-easily-swappable-parameters, + -bugprone-exception-escape, + -bugprone-reserved-identifier, + -bugprone-unused-raii, + -performance-enum-size, + -performance-inefficient-string-concatenation, + +CheckOptions: +- key: modernize-use-equals-default.IgnoreMacros + value: false +- key: performance-for-range-copy.WarnOnAllAutoCopies + value: true +- key: performance-inefficient-string-concatenation.StrictMode + value: true +- key: performance-unnecessary-value-param.AllowedTypes + value: 'exception_ptr$;' +- key: readability-implicit-bool-conversion.AllowPointerConditions + value: true + +HeaderFilterRegex: 'pybind11/.*h' diff --git a/third_party/pybind11/.cmake-format.yaml b/third_party/pybind11/.cmake-format.yaml new file mode 100644 index 0000000..a2a69f3 --- /dev/null +++ b/third_party/pybind11/.cmake-format.yaml @@ -0,0 +1,73 @@ +parse: + additional_commands: + pybind11_add_module: + flags: + - THIN_LTO + - MODULE + - SHARED + - NO_EXTRAS + - EXCLUDE_FROM_ALL + - SYSTEM + +format: + line_width: 99 + tab_size: 2 + + # If an argument group contains more than this many sub-groups + # (parg or kwarg groups) then force it to a vertical layout. + max_subgroups_hwrap: 2 + + # If a positional argument group contains more than this many + # arguments, then force it to a vertical layout. + max_pargs_hwrap: 6 + + # If a cmdline positional group consumes more than this many + # lines without nesting, then invalidate the layout (and nest) + max_rows_cmdline: 2 + separate_ctrl_name_with_space: false + separate_fn_name_with_space: false + dangle_parens: false + + # If the trailing parenthesis must be 'dangled' on its on + # 'line, then align it to this reference: `prefix`: the start' + # 'of the statement, `prefix-indent`: the start of the' + # 'statement, plus one indentation level, `child`: align to' + # the column of the arguments + dangle_align: prefix + # If the statement spelling length (including space and + # parenthesis) is smaller than this amount, then force reject + # nested layouts. + min_prefix_chars: 4 + + # If the statement spelling length (including space and + # parenthesis) is larger than the tab width by more than this + # amount, then force reject un-nested layouts. + max_prefix_chars: 10 + + # If a candidate layout is wrapped horizontally but it exceeds + # this many lines, then reject the layout. + max_lines_hwrap: 2 + + line_ending: unix + + # Format command names consistently as 'lower' or 'upper' case + command_case: canonical + + # Format keywords consistently as 'lower' or 'upper' case + # unchanged is valid too + keyword_case: 'upper' + + # A list of command names which should always be wrapped + always_wrap: [] + + # If true, the argument lists which are known to be sortable + # will be sorted lexicographically + enable_sort: true + + # If true, the parsers may infer whether or not an argument + # list is sortable (without annotation). + autosort: false + +# Causes a few issues - can be solved later, possibly. +markup: + enable_markup: false diff --git a/third_party/pybind11/.codespell-ignore-lines b/third_party/pybind11/.codespell-ignore-lines new file mode 100644 index 0000000..e8cbf31 --- /dev/null +++ b/third_party/pybind11/.codespell-ignore-lines @@ -0,0 +1,35 @@ +template + template + auto &this_ = static_cast(*this); + if (load_impl(temp, false)) { + ssize_t nd = 0; + auto trivial = broadcast(buffers, nd, shape); + auto ndim = (size_t) nd; + int nd; + ssize_t ndim() const { return detail::array_proxy(m_ptr)->nd; } + using op = op_impl; +template + template + class_ &def(const detail::op_ &op, const Extra &...extra) { + class_ &def_cast(const detail::op_ &op, const Extra &...extra) { + int valu; + explicit movable_int(int v) : valu{v} {} + movable_int(movable_int &&other) noexcept : valu(other.valu) { other.valu = 91; } + explicit indestructible_int(int v) : valu{v} {} + REQUIRE(hld.as_raw_ptr_unowned()->valu == 19); + REQUIRE(othr.valu == 19); + REQUIRE(orig.valu == 91); + (m.pass_valu, "Valu", "pass_valu:Valu(_MvCtor)*_CpCtor"), +atyp_valu rtrn_valu() { atyp_valu obj{"Valu"}; return obj; } + assert m.atyp_valu().get_mtxt() == "Valu" +// valu(e), ref(erence), ptr or p (pointer), r = rvalue, m = mutable, c = const, +@pytest.mark.parametrize("access", ["ro", "rw", "static_ro", "static_rw"]) +struct IntStruct { + explicit IntStruct(int v) : value(v){}; + ~IntStruct() { value = -value; } + IntStruct(const IntStruct &) = default; + IntStruct &operator=(const IntStruct &) = default; + py::class_(m, "IntStruct").def(py::init([](const int i) { return IntStruct(i); })); + py::implicitly_convertible(); + m.def("test", [](int expected, const IntStruct &in) { + [](int expected, const IntStruct &in) { diff --git a/third_party/pybind11/.gitattributes b/third_party/pybind11/.gitattributes new file mode 100644 index 0000000..d611e14 --- /dev/null +++ b/third_party/pybind11/.gitattributes @@ -0,0 +1 @@ +docs/*.svg binary diff --git a/third_party/pybind11/.github/CODEOWNERS b/third_party/pybind11/.github/CODEOWNERS new file mode 100644 index 0000000..4e2c669 --- /dev/null +++ b/third_party/pybind11/.github/CODEOWNERS @@ -0,0 +1,9 @@ +*.cmake @henryiii +CMakeLists.txt @henryiii +*.yml @henryiii +*.yaml @henryiii +/tools/ @henryiii +/pybind11/ @henryiii +noxfile.py @henryiii +.clang-format @henryiii +.clang-tidy @henryiii diff --git a/third_party/pybind11/.github/CONTRIBUTING.md b/third_party/pybind11/.github/CONTRIBUTING.md new file mode 100644 index 0000000..fbdf075 --- /dev/null +++ b/third_party/pybind11/.github/CONTRIBUTING.md @@ -0,0 +1,349 @@ +Thank you for your interest in this project! Please refer to the following +sections on how to contribute code and bug reports. + +### Reporting bugs + +Before submitting a question or bug report, please take a moment of your time +and ensure that your issue isn't already discussed in the project documentation +provided at [pybind11.readthedocs.org][] or in the [issue tracker][]. You can +also check [gitter][] to see if it came up before. + +Assuming that you have identified a previously unknown problem or an important +question, it's essential that you submit a self-contained and minimal piece of +code that reproduces the problem. In other words: no external dependencies, +isolate the function(s) that cause breakage, submit matched and complete C++ +and Python snippets that can be easily compiled and run in isolation; or +ideally make a small PR with a failing test case that can be used as a starting +point. + +## Pull requests + +Contributions are submitted, reviewed, and accepted using GitHub pull requests. +Please refer to [this article][using pull requests] for details and adhere to +the following rules to make the process as smooth as possible: + +* Make a new branch for every feature you're working on. +* Make small and clean pull requests that are easy to review but make sure they + do add value by themselves. +* Add tests for any new functionality and run the test suite (`cmake --workflow + venv`) to ensure that no existing features break. +* Please run [`pre-commit`][pre-commit] to check your code matches the + project style. (Note that `gawk` is required.) Use `pre-commit run + --all-files` before committing (or use installed-mode, check pre-commit docs) + to verify your code passes before pushing to save time. +* This project has a strong focus on providing general solutions using a + minimal amount of code, thus small pull requests are greatly preferred. + +### Licensing of contributions + +pybind11 is provided under a BSD-style license that can be found in the +``LICENSE`` file. By using, distributing, or contributing to this project, you +agree to the terms and conditions of this license. + +You are under no obligation whatsoever to provide any bug fixes, patches, or +upgrades to the features, functionality or performance of the source code +("Enhancements") to anyone; however, if you choose to make your Enhancements +available either publicly, or directly to the author of this software, without +imposing a separate written license agreement for such Enhancements, then you +hereby grant the following license: a non-exclusive, royalty-free perpetual +license to install, use, modify, prepare derivative works, incorporate into +other computer software, distribute, and sublicense such enhancements or +derivative works thereof, in binary and source code form. + + +## Development of pybind11 + +### Quick setup + +To setup a quick development environment, use [`nox`](https://nox.thea.codes). +This will allow you to do some common tasks with minimal setup effort, but will +take more time to run and be less flexible than a full development environment. +If you use [`pipx run nox`](https://pipx.pypa.io), you don't even need to +install `nox`. Examples: + +```bash +# List all available sessions +nox -l + +# Run linters +nox -s lint + +# Run tests on Python 3.9 +nox -s tests-3.9 + +# Build and preview docs +nox -s docs -- serve + +# Build SDists and wheels +nox -s build +``` + +### Full setup + +To setup an ideal development environment, run the following commands on a +system with CMake 3.15+: + +```bash +python3 -m venv .venv +source .venv/bin/activate +pip install -r tests/requirements.txt +cmake -S . -B build -DDOWNLOAD_CATCH=ON -DDOWNLOAD_EIGEN=ON +cmake --build build -j4 +``` + +Tips: + +* You can use `virtualenv` (faster, from PyPI) instead of `venv`. +* You can select any name for your environment folder; if it contains "env" it + will be ignored by git. +* If you don't have CMake 3.15+, just add "cmake" to the pip install command. +* You can use `-DPYBIND11_FINDPYTHON=ON` to use FindPython. +* For a specific Python, you can use `-DPython_ROOT_DIR=/path/to` or + `-DPython_EXECUTABLE=/path/to/python`. + +## CMake presets + +We also support CMake presets. If you have [uv](https://docs.astral.sh/uv/), +you can use: + +```bash +cmake --workflow venv +``` + +to setup a venv and run all tests. You can break this up into components +if you want to use a specific version of Python (or any other config option) or +build only one of the valid targets (listed below). + +```bash +cmake --preset venv -DPYBIND11_CREATE_WITH_UV=3.13t +cmake --build --preset venv +cmake --build --preset venv -t cpptest +``` + +The `default` preset will use an existing venv or Python install. If you'd like +to run pytest yourself, say to easily control the options: + +```bash +cd build +source .venv/bin/activate +cd tests +python -m pytest +``` + +The `.so` file is not installed into the venv, so you need to run from this +directory, the local directory is included with `python -m`. + +## Configuration options + +In CMake, configuration options are given with "-D". Options are stored in the +build directory, in the `CMakeCache.txt` file, so they are remembered for each +build directory. Two selections are special - the generator, given with `-G`, +and the compiler, which is selected based on environment variables `CXX` and +similar, or `-DCMAKE_CXX_COMPILER=`. Unlike the others, these cannot be changed +after the initial run. + +The valid options are: + +* `-DCMAKE_BUILD_TYPE`: Release, Debug, MinSizeRel, RelWithDebInfo +* `-DPYBIND11_FINDPYTHON=ON`: Use CMake 3.12+'s FindPython instead of the + classic, deprecated, custom FindPythonLibs +* `-DPYBIND11_NOPYTHON=ON`: Disable all Python searching (disables tests) +* `-DBUILD_TESTING=ON`: Enable the tests +* `-DDOWNLOAD_CATCH=ON`: Download catch to build the C++ tests +* `-DDOWNLOAD_EIGEN=ON`: Download Eigen for the NumPy tests +* `-DPYBIND11_INSTALL=ON/OFF`: Enable the install target (on by default for the + master project) +* `-DUSE_PYTHON_INSTALL_DIR=ON`: Try to install into the python dir + + +
A few standard CMake tricks: (click to expand)

+ +* Use `cmake --build build -v` to see the commands used to build the files. +* Use `cmake build -LH` to list the CMake options with help. +* Use `ccmake` if available to see a curses (terminal) gui, or `cmake-gui` for + a completely graphical interface (not present in the PyPI package). +* Use `cmake --build build -j12` to build with 12 cores (for example). +* Use `-G` and the name of a generator to use something different. `cmake + --help` lists the generators available. + - On Unix, setting `CMAKE_GENERATER=Ninja` in your environment will give + you automatic multithreading on all your CMake projects! +* Open the `CMakeLists.txt` with QtCreator to generate for that IDE. +* You can use `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` to generate the `.json` file + that some tools expect. + +

+ + +To run the tests, you can "build" the check target: + +```bash +cmake --build build --target check +``` + +`--target` can be spelled `-t`. You can also run individual tests with these +targets: + +* `pytest`: Python tests only, using the +[pytest](https://docs.pytest.org/en/stable/) framework +* `cpptest`: C++ tests only +* `test_cmake_build`: Install / subdirectory tests + +If you want to build just a subset of tests, use +`-DPYBIND11_TEST_OVERRIDE="test_callbacks;test_pickling"`. If this is +empty, all tests will be built. Tests are specified without an extension if they need both a .py and +.cpp file. + +You may also pass flags to the `pytest` target by editing `tests/pytest.ini` or +by using the `PYTEST_ADDOPTS` environment variable +(see [`pytest` docs](https://docs.pytest.org/en/2.7.3/customize.html#adding-default-options)). As an example: + +```bash +env PYTEST_ADDOPTS="--capture=no --exitfirst" \ + cmake --build build --target pytest +# Or using abbreviated flags +env PYTEST_ADDOPTS="-s -x" cmake --build build --target pytest +``` + +### Formatting + +All formatting is handled by pre-commit. + +Install with brew (macOS) or pip (any OS): + +```bash +# Any OS +python3 -m pip install pre-commit + +# OR macOS with homebrew: +brew install pre-commit +``` + +Then, you can run it on the items you've added to your staging area, or all +files: + +```bash +pre-commit run +# OR +pre-commit run --all-files +``` + +And, if you want to always use it, you can install it as a git hook (hence the +name, pre-commit): + +```bash +pre-commit install +``` + +### Clang-Format + +As of v2.6.2, pybind11 ships with a [`clang-format`][clang-format] +configuration file at the top level of the repo (the filename is +`.clang-format`). Currently, formatting is NOT applied automatically, but +manually using `clang-format` for newly developed files is highly encouraged. +To check if a file needs formatting: + +```bash +clang-format -style=file --dry-run some.cpp +``` + +The output will show things to be fixed, if any. To actually format the file: + +```bash +clang-format -style=file -i some.cpp +``` + +Note that the `-style-file` option searches the parent directories for the +`.clang-format` file, i.e. the commands above can be run in any subdirectory +of the pybind11 repo. + +### Clang-Tidy + +[`clang-tidy`][clang-tidy] performs deeper static code analyses and is +more complex to run, compared to `clang-format`, but support for `clang-tidy` +is built into the pybind11 CMake configuration. To run `clang-tidy`, the +following recipe should work. Run the `docker` command from the top-level +directory inside your pybind11 git clone. + +```bash +docker run --rm -v $PWD:/pybind11 -w /pybind11 -it silkeh/clang:20 +apt-get update && apt-get install -y git python3-dev python3-pytest ninja-build +cmake --preset tidy +cmake --build --preset tidy +``` + +You can add `--fix` to the options list in the preset if you want to apply fixes +(remember `-j1` to run only one thread). + +### Include what you use + +To run include what you use, install (`brew install include-what-you-use` on +macOS), then run: + +```bash +cmake -S . -B build-iwyu -DCMAKE_CXX_INCLUDE_WHAT_YOU_USE=$(which include-what-you-use) +cmake --build build-iwyu +``` + +The report is sent to stderr; you can pipe it into a file if you wish. + +### Build recipes + +This builds with the Intel compiler (assuming it is in your path, along with a +recent CMake and Python): + +```bash +python3 -m venv venv +. venv/bin/activate +pip install pytest +cmake -S . -B build-intel -DCMAKE_CXX_COMPILER=$(which icpc) -DDOWNLOAD_CATCH=ON -DDOWNLOAD_EIGEN=ON -DPYBIND11_WERROR=ON +``` + +This will test the PGI compilers: + +```bash +docker run --rm -it -v $PWD:/pybind11 nvcr.io/hpc/pgi-compilers:ce +apt-get update && apt-get install -y python3-dev python3-pip python3-pytest +wget -qO- "https://cmake.org/files/v3.18/cmake-3.18.2-Linux-x86_64.tar.gz" | tar --strip-components=1 -xz -C /usr/local +cmake -S pybind11/ -B build +cmake --build build +``` + +### Explanation of the SDist/wheel building design + +> These details below are _only_ for packaging the Python sources from git. The +> SDists and wheels created do not have any extra requirements at all and are +> completely normal. + +The main objective of the packaging system is to create SDists (Python's source +distribution packages) and wheels (Python's binary distribution packages) that +include everything that is needed to work with pybind11, and which can be +installed without any additional dependencies. This is more complex than it +appears: in order to support CMake as a first class language even when using +the PyPI package, they must include the _generated_ CMake files (so as not to +require CMake when installing the `pybind11` package itself). They should also +provide the option to install to the "standard" location +(`/include/pybind11` and `/share/cmake/pybind11`) so they are +easy to find with CMake, but this can cause problems if you are not an +environment or using ``pyproject.toml`` requirements. This was solved by having +two packages; the "nice" pybind11 package that stores the includes and CMake +files inside the package, that you get access to via functions in the package, +and a `pybind11-global` package that can be included via `pybind11[global]` if +you want the more invasive but discoverable file locations. + +If you want to package the GitHub source for the "global" package, you need +to use nox. Normal packaging will only make the normal package. + + +```bash +nox -s build +nox -s build_global +``` + + +[pre-commit]: https://pre-commit.com +[clang-format]: https://clang.llvm.org/docs/ClangFormat.html +[clang-tidy]: https://clang.llvm.org/extra/clang-tidy/ +[pybind11.readthedocs.org]: http://pybind11.readthedocs.org/en/latest +[issue tracker]: https://github.com/pybind/pybind11/issues +[gitter]: https://gitter.im/pybind/Lobby +[using pull requests]: https://help.github.com/articles/using-pull-requests diff --git a/third_party/pybind11/.github/ISSUE_TEMPLATE/bug-report.yml b/third_party/pybind11/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..4f1e78f --- /dev/null +++ b/third_party/pybind11/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,61 @@ +name: Bug Report +description: File an issue about a bug +title: "[BUG]: " +labels: [triage] +body: + - type: markdown + attributes: + value: | + Please do your best to make the issue as easy to act on as possible, and only submit here if there is clearly a problem with pybind11 (ask first if unsure). **Note that a reproducer in a PR is much more likely to get immediate attention.** + + - type: checkboxes + id: steps + attributes: + label: Required prerequisites + description: Make sure you've completed the following steps before submitting your issue -- thank you! + options: + - label: Make sure you've read the [documentation](https://pybind11.readthedocs.io). Your issue may be addressed there. + required: true + - label: Search the [issue tracker](https://github.com/pybind/pybind11/issues) and [Discussions](https:/pybind/pybind11/discussions) to verify that this hasn't already been reported. +1 or comment there if it has. + required: true + - label: Consider asking first in the [Gitter chat room](https://gitter.im/pybind/Lobby) or in a [Discussion](https:/pybind/pybind11/discussions/new). + required: false + + - type: input + id: version + attributes: + label: What version (or hash if on master) of pybind11 are you using? + validations: + required: true + + - type: textarea + id: description + attributes: + label: Problem description + placeholder: >- + Provide a short description, state the expected behavior and what + actually happens. Include relevant information like what version of + pybind11 you are using, what system you are on, and any useful commands + / output. + validations: + required: true + + - type: textarea + id: code + attributes: + label: Reproducible example code + placeholder: >- + The code should be minimal, have no external dependencies, isolate the + function(s) that cause breakage. Submit matched and complete C++ and + Python snippets that can be easily compiled and run to diagnose the + issue. — Note that a reproducer in a PR is much more likely to get + immediate attention: failing tests in the pybind11 CI are the best + starting point for working out fixes. + render: text + + - type: input + id: regression + attributes: + label: Is this a regression? Put the last known working version here if it is. + description: Put the last known working version here if this is a regression. + value: Not a regression diff --git a/third_party/pybind11/.github/ISSUE_TEMPLATE/config.yml b/third_party/pybind11/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..27f9a80 --- /dev/null +++ b/third_party/pybind11/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://github.com/pybind/pybind11/discussions/new + about: Please ask and answer questions here, or propose new ideas. + - name: Gitter room + url: https://gitter.im/pybind/Lobby + about: A room for discussing pybind11 with an active community diff --git a/third_party/pybind11/.github/dependabot.yml b/third_party/pybind11/.github/dependabot.yml new file mode 100644 index 0000000..22c34bd --- /dev/null +++ b/third_party/pybind11/.github/dependabot.yml @@ -0,0 +1,15 @@ +version: 2 +updates: + # Maintain dependencies for GitHub Actions + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + groups: + actions: + patterns: + - "*" + ignore: + - dependency-name: actions/checkout + versions: + - "<5" diff --git a/third_party/pybind11/.github/labeler.yml b/third_party/pybind11/.github/labeler.yml new file mode 100644 index 0000000..0509339 --- /dev/null +++ b/third_party/pybind11/.github/labeler.yml @@ -0,0 +1,13 @@ +docs: + all: + - changed-files: + - all-globs-to-all-files: + - '!docs/changelog.md' + - '!docs/upgrade.rst' + - base-branch: "^(?!dependabot).*" + - base-branch: "^(?!pre-commit-ci).*" + +ci: + - changed-files: + - any-glob-to-any-file: + - '.github/workflows/*.yml' diff --git a/third_party/pybind11/.github/labeler_merged.yml b/third_party/pybind11/.github/labeler_merged.yml new file mode 100644 index 0000000..479530d --- /dev/null +++ b/third_party/pybind11/.github/labeler_merged.yml @@ -0,0 +1,8 @@ +# Add 'needs changelog` label to any change to code files as long as the `CHANGELOG` hasn't changed +# Skip dependabot and pre-commit-ci PRs +needs changelog: + - all: + - changed-files: + - all-globs-to-all-files: "!docs/changelog.md" + - base-branch: "^(?!dependabot).*" + - base-branch: "^(?!pre-commit-ci).*" diff --git a/third_party/pybind11/.github/matchers/pylint.json b/third_party/pybind11/.github/matchers/pylint.json new file mode 100644 index 0000000..e3a6bd1 --- /dev/null +++ b/third_party/pybind11/.github/matchers/pylint.json @@ -0,0 +1,32 @@ +{ + "problemMatcher": [ + { + "severity": "warning", + "pattern": [ + { + "regexp": "^([^:]+):(\\d+):(\\d+): ([A-DF-Z]\\d+): \\033\\[[\\d;]+m([^\\033]+).*$", + "file": 1, + "line": 2, + "column": 3, + "code": 4, + "message": 5 + } + ], + "owner": "pylint-warning" + }, + { + "severity": "error", + "pattern": [ + { + "regexp": "^([^:]+):(\\d+):(\\d+): (E\\d+): \\033\\[[\\d;]+m([^\\033]+).*$", + "file": 1, + "line": 2, + "column": 3, + "code": 4, + "message": 5 + } + ], + "owner": "pylint-error" + } + ] +} diff --git a/third_party/pybind11/.github/pull_request_template.md b/third_party/pybind11/.github/pull_request_template.md new file mode 100644 index 0000000..34c9863 --- /dev/null +++ b/third_party/pybind11/.github/pull_request_template.md @@ -0,0 +1,15 @@ + +## Description + + + + +## Suggested changelog entry: + + + +* Placeholder. diff --git a/third_party/pybind11/.github/workflows/ci.yml b/third_party/pybind11/.github/workflows/ci.yml new file mode 100644 index 0000000..0985b5c --- /dev/null +++ b/third_party/pybind11/.github/workflows/ci.yml @@ -0,0 +1,1279 @@ +name: CI + +on: + workflow_dispatch: + pull_request: + types: + - opened + - synchronize + - reopened + - ready_for_review + +permissions: read-all + +concurrency: + group: test-${{ github.ref }} + cancel-in-progress: true + +env: + PYTHONDEVMODE: 1 + PIP_BREAK_SYSTEM_PACKAGES: 1 + PIP_ONLY_BINARY: numpy + FORCE_COLOR: 3 + PYTEST_TIMEOUT: 300 + # For cmake: + VERBOSE: 1 + CMAKE_COLOR_DIAGNOSTICS: 1 + +jobs: + # This is the "main" test suite, which tests a large number of different + # versions of default compilers and Python versions in GitHub Actions. + # It is in two parts: one that always runs, and one that runs on non-draft + standard-small: + if: github.event.action != 'ready_for_review' + strategy: + fail-fast: false + matrix: + include: + - runs-on: ubuntu-22.04 + python-version: '3.8' + cmake-args: -DPYBIND11_FINDPYTHON=OFF -DPYBIND11_NUMPY_1_ONLY=ON + - runs-on: ubuntu-latest + python-version: '3.13' + cmake-args: -DCMAKE_CXX_STANDARD=23 -DPYBIND11_SIMPLE_GIL_MANAGEMENT=ON + - runs-on: ubuntu-latest + python-version: '3.14t' + cmake-args: -DCMAKE_CXX_STANDARD=17 -DPYBIND11_TEST_SMART_HOLDER=ON + - runs-on: ubuntu-latest + python-version: 'pypy3.11' + cmake-args: -DCMAKE_CXX_STANDARD=17 + - runs-on: ubuntu-latest + python-version: 'graalpy-24.2' + cmake-args: -DCMAKE_CXX_STANDARD=20 + - runs-on: macos-latest + python-version: '3.14' + cmake-args: -DCMAKE_CXX_STANDARD=14 + - runs-on: windows-2022 + python-version: '3.8' + cmake-args: -DPYBIND11_FINDPYTHON=OFF + + + name: 🐍 + uses: ./.github/workflows/reusable-standard.yml + with: + runs-on: ${{ matrix.runs-on }} + python-version: ${{ matrix.python-version }} + cmake-args: ${{ matrix.cmake-args }} + + standard-large: + if: github.event.pull_request.draft == false + strategy: + fail-fast: false + matrix: + include: + - runs-on: ubuntu-latest + python-version: '3.8' + cmake-args: -DPYBIND11_FINDPYTHON=ON -DCMAKE_CXX_STANDARD=17 + - runs-on: ubuntu-latest + python-version: '3.10' + cmake-args: -DCMAKE_CXX_STANDARD=20 + - runs-on: ubuntu-latest + python-version: '3.11' + cmake-args: -DPYBIND11_TEST_SMART_HOLDER=ON -DCMAKE_CXX_STANDARD=17 + - runs-on: ubuntu-latest + python-version: '3.12' + cmake-args: -DPYBIND11_TEST_SMART_HOLDER=ON -DPYBIND11_SIMPLE_GIL_MANAGEMENT=ON + - runs-on: ubuntu-latest + python-version: '3.13t' + cmake-args: -DCMAKE_CXX_STANDARD=20 -DPYBIND11_DISABLE_HANDLE_TYPE_NAME_DEFAULT_IMPLEMENTATION=ON + - runs-on: ubuntu-latest + python-version: '3.14' + cmake-args: -DCMAKE_CXX_STANDARD=14 -DCMAKE_CXX_FLAGS="-DPYBIND11_HAS_SUBINTERPRETER_SUPPORT=0" + - runs-on: ubuntu-latest + python-version: 'pypy-3.10' + cmake-args: -DCMAKE_CXX_STANDARD=14 + - runs-on: ubuntu-latest + python-version: 'graalpy-24.1' + + # No SciPy for macOS ARM + - runs-on: macos-13 + python-version: '3.8' + cmake-args: -DCMAKE_CXX_STANDARD=14 + - runs-on: macos-13 + python-version: '3.11' + cmake-args: -DPYBIND11_TEST_SMART_HOLDER=ON + - runs-on: macos-latest + python-version: '3.12' + cmake-args: -DCMAKE_CXX_STANDARD=17 -DPYBIND11_DISABLE_HANDLE_TYPE_NAME_DEFAULT_IMPLEMENTATION=ON + - runs-on: macos-13 + python-version: '3.13t' + cmake-args: -DCMAKE_CXX_STANDARD=11 + - runs-on: macos-latest + python-version: '3.14t' + cmake-args: -DCMAKE_CXX_STANDARD=20 + - runs-on: macos-13 + python-version: 'pypy-3.10' + cmake-args: -DCMAKE_CXX_STANDARD=17 + - runs-on: macos-latest + python-version: 'pypy-3.11' + - runs-on: macos-latest + python-version: 'graalpy-24.2' + + - runs-on: windows-latest + python-version: '3.9' + cmake-args: -DPYBIND11_TEST_SMART_HOLDER=ON + - runs-on: windows-2022 + python-version: '3.8' + cmake-args: -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded -DPYBIND11_NUMPY_1_ONLY=ON + - runs-on: windows-2022 + python-version: '3.9' + cmake-args: -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreadedDLL -DCMAKE_CXX_STANDARD=14 + # This needs a python built with MTd + # - runs-on: windows-2022 + # python-version: '3.11' + # cmake-args: -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreadedDebug + - runs-on: windows-2022 + python-version: '3.10' + cmake-args: -DPYBIND11_TEST_SMART_HOLDER=ON -DCMAKE_CXX_FLAGS="/GR /EHsc" + - runs-on: windows-2022 + python-version: '3.13' + cmake-args: -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreadedDebugDLL + - runs-on: windows-latest + python-version: '3.13t' + cmake-args: -DCMAKE_CXX_STANDARD=17 + - runs-on: windows-latest + python-version: '3.14' + cmake-args: -DCMAKE_CXX_STANDARD=20 + - runs-on: windows-latest + python-version: '3.14t' + cmake-args: -DCMAKE_CXX_STANDARD=23 + - runs-on: windows-latest + python-version: 'pypy-3.10' + cmake-args: -DCMAKE_CXX_STANDARD=17 + - runs-on: windows-latest + python-version: 'pypy3.11' + cmake-args: -DCMAKE_CXX_STANDARD=20 + # The setup-python action currently doesn't have graalpy for windows + # See https://github.com/actions/setup-python/pull/880 + + name: 🐍 + uses: ./.github/workflows/reusable-standard.yml + with: + runs-on: ${{ matrix.runs-on }} + python-version: ${{ matrix.python-version }} + cmake-args: ${{ matrix.cmake-args }} + + # This checks inplace builds with C++11 + inplace: + if: github.event.pull_request.draft == false + strategy: + fail-fast: false + matrix: + include: + - runs-on: ubuntu-latest + python-version: '3.9' + - runs-on: macos-latest + python-version: '3.12' + - runs-on: windows-latest + python-version: '3.11' + + name: "🐍 ${{ matrix.python-version }} • ${{ matrix.runs-on }} • x64 inplace C++14" + runs-on: ${{ matrix.runs-on }} + + steps: + - uses: actions/checkout@v4 + + - name: Setup Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + allow-prereleases: true + + - name: Install uv + uses: astral-sh/setup-uv@v6 + with: + enable-cache: true + + - name: Prepare env + run: uv pip install --python=python --system -r tests/requirements.txt + + # TODO Resolve Windows Ninja shared object issue on Python 3.8+ + - name: Use Ninja except on Windows + if: runner.os != 'Windows' + run: echo "CMAKE_GENERATOR=Ninja" >> "$GITHUB_ENV" + + # More-or-less randomly adding a few extra flags here + - name: Configure + run: > + cmake -S. -B. + -DPYBIND11_WERROR=ON + -DPYBIND11_SIMPLE_GIL_MANAGEMENT=ON + -DPYBIND11_PYTEST_ARGS=-v + -DDOWNLOAD_CATCH=ON + -DDOWNLOAD_EIGEN=ON + -DCMAKE_CXX_STANDARD=14 + + # Checks to makes sure defining `_` is allowed + # Triggers EHsc missing error on Windows + - name: Add underscore check + if: runner.os != 'Windows' + run: cmake -S. -B. -DCMAKE_CXX_FLAGS="-D_=1" + + - name: Build + run: cmake --build . + + - name: Python tests + run: cmake --build . --target pytest + + - name: Compiled tests + run: cmake --build . --target cpptest + + - name: Interface test + run: cmake --build . --target test_cmake_build + + - name: Visibility test + run: cmake --build . --target test_cross_module_rtti + + + manylinux: + name: Manylinux on 🐍 3.13t • GIL + if: github.event.pull_request.draft == false + runs-on: ubuntu-latest + timeout-minutes: 40 + container: quay.io/pypa/musllinux_1_2_x86_64:latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Prepare uv's path + run: echo "$HOME/.local/bin" >> $GITHUB_PATH + + - name: Install ninja + run: uv tool install ninja + + - name: Configure via preset + run: cmake --preset venv -DPYBIND11_CREATE_WITH_UV=python3.13t + + - name: Build C++11 + run: cmake --build --preset venv + + - name: Python tests C++11 + run: cmake --build --preset testsvenv -t pytest + + deadsnakes: + if: github.event.pull_request.draft == false + strategy: + fail-fast: false + matrix: + include: + # TODO: Fails on 3.10, investigate + # JOB DISABLED (NEEDS WORK): https://github.com/pybind/pybind11/issues/4889 + # - python-version: "3.9" + # python-debug: true + # valgrind: true + - python-version: "3.11" + python-debug: false + + name: "🐍 ${{ matrix.python-version }}${{ matrix.python-debug && '-dbg' || '' }} (deadsnakes)${{ matrix.valgrind && ' • Valgrind' || '' }} • x64" + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Setup Python ${{ matrix.python-version }} (deadsnakes) + uses: deadsnakes/action@v3.2.0 + with: + python-version: ${{ matrix.python-version }} + debug: ${{ matrix.python-debug }} + + - name: Update CMake + uses: jwlawson/actions-setup-cmake@v2.0 + + - name: Valgrind cache + if: matrix.valgrind + uses: actions/cache@v4 + id: cache-valgrind + with: + path: valgrind + key: 3.16.1 # Valgrind version + + - name: Compile Valgrind + if: matrix.valgrind && steps.cache-valgrind.outputs.cache-hit != 'true' + run: | + VALGRIND_VERSION=3.16.1 + curl https://sourceware.org/pub/valgrind/valgrind-$VALGRIND_VERSION.tar.bz2 -o - | tar xj + mv valgrind-$VALGRIND_VERSION valgrind + cd valgrind + ./configure + make -j 2 > /dev/null + + - name: Install Valgrind + if: matrix.valgrind + working-directory: valgrind + run: | + sudo make install + sudo apt-get update + sudo apt-get install ninja-build libc6-dbg + + - name: Prepare env + run: | + python -m pip install -r tests/requirements.txt + + - name: Configure + run: cmake --preset default -DCMAKE_CXX_STANDARD=17 + + - name: Build + run: cmake --build --preset default + + - name: Python tests + run: cmake --build --preset default --target pytest + + - name: C++ tests + run: cmake --build --preset default --target cpptest + + - name: Visibility test + run: cmake --build --preset default --target test_cross_module_rtti + + - name: Run Valgrind on Python tests + if: matrix.valgrind + run: cmake --build --preset default --target memcheck + + + # Testing on clang using the excellent silkeh clang docker images + clang: + if: github.event.pull_request.draft == false + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + include: + - clang: 5 + std: 14 + - clang: 11 + std: 20 + - clang: 14 + std: 20 + - clang: 16 + std: 20 + container_suffix: "-bullseye" + - clang: 18 + std: 20 + cxx_flags: "-Werror -Wall -Wextra -Wwrite-strings -Wunreachable-code -Wpointer-arith -Wredundant-decls" + container_suffix: "-bookworm" + + name: "🐍 3 • Clang ${{ matrix.clang }} • C++${{ matrix.std }} • x64${{ matrix.cxx_flags && ' • cxx_flags' || '' }}" + container: "silkeh/clang:${{ matrix.clang }}${{ matrix.container_suffix }}" + + steps: + - uses: actions/checkout@v4 + + - name: Add wget and python3 + run: apt-get update && apt-get install -y python3-dev python3-numpy python3-pytest libeigen3-dev + + - name: Configure + shell: bash + run: > + cmake -S . -B build + -DPYBIND11_WERROR=ON + -DDOWNLOAD_CATCH=ON + -DCMAKE_CXX_STANDARD=${{ matrix.std }} + -DCMAKE_CXX_FLAGS="${{ matrix.cxx_flags }}" + -DPYTHON_EXECUTABLE=$(python3 -c "import sys; print(sys.executable)") + + - name: Build + run: cmake --build build -j 2 + + - name: Python tests + run: cmake --build build --target pytest + + - name: C++ tests + run: cmake --build build --target cpptest + + - name: Interface test + run: cmake --build build --target test_cmake_build + + - name: Visibility test + run: cmake --build build --target test_cross_module_rtti + + # Testing NVCC; forces sources to behave like .cu files + cuda: + runs-on: ubuntu-latest + name: "🐍 3.10 • CUDA 12.2 • Ubuntu 22.04" + container: nvidia/cuda:12.2.0-devel-ubuntu22.04 + + steps: + - uses: actions/checkout@v4 + + # tzdata will try to ask for the timezone, so set the DEBIAN_FRONTEND + - name: Install 🐍 3 + run: apt-get update && DEBIAN_FRONTEND="noninteractive" apt-get install -y cmake git python3-dev python3-pytest python3-numpy + + - name: Configure + run: cmake -S . -B build -DPYBIND11_CUDA_TESTS=ON -DPYBIND11_WERROR=ON -DDOWNLOAD_CATCH=ON + + - name: Build + run: cmake --build build -j2 --verbose + + - name: Python tests + run: cmake --build build --target pytest + + +# TODO: Internal compiler error - report to NVidia +# # Testing CentOS 8 + PGI compilers +# centos-nvhpc8: +# runs-on: ubuntu-latest +# name: "🐍 3 • CentOS8 / PGI 20.11 • x64" +# container: centos:8 +# +# steps: +# - uses: actions/checkout@v4 +# +# - name: Add Python 3 and a few requirements +# run: yum update -y && yum install -y git python3-devel python3-numpy python3-pytest make environment-modules +# +# - name: Install CMake with pip +# run: | +# python3 -m pip install --upgrade pip +# python3 -m pip install cmake --prefer-binary +# +# - name: Install NVidia HPC SDK +# run: > +# yum -y install +# https://developer.download.nvidia.com/hpc-sdk/20.11/nvhpc-20-11-20.11-1.x86_64.rpm +# https://developer.download.nvidia.com/hpc-sdk/20.11/nvhpc-2020-20.11-1.x86_64.rpm +# +# - name: Configure +# shell: bash +# run: | +# source /etc/profile.d/modules.sh +# module load /opt/nvidia/hpc_sdk/modulefiles/nvhpc/20.11 +# cmake -S . -B build -DDOWNLOAD_CATCH=ON -DCMAKE_CXX_STANDARD=14 -DPYTHON_EXECUTABLE=$(python3 -c "import sys; print(sys.executable)") +# +# - name: Build +# run: cmake --build build -j 2 --verbose +# +# - name: Python tests +# run: cmake --build build --target pytest +# +# - name: C++ tests +# run: cmake --build build --target cpptest +# +# - name: Interface test +# run: cmake --build build --target test_cmake_build + + + # Testing on Ubuntu + NVHPC (previous PGI) compilers, which seems to require more workarounds + ubuntu-nvhpc7: + if: github.event.pull_request.draft == false + runs-on: ubuntu-22.04 + name: "🐍 3 • NVHPC 23.5 • C++17 • x64" + + env: + # tzdata will try to ask for the timezone, so set the DEBIAN_FRONTEND + DEBIAN_FRONTEND: 'noninteractive' + steps: + - uses: actions/checkout@v4 + + - name: Add NVHPC Repo + run: | + echo 'deb [trusted=yes] https://developer.download.nvidia.com/hpc-sdk/ubuntu/amd64 /' | \ + sudo tee /etc/apt/sources.list.d/nvhpc.list + + - name: Install 🐍 3 & NVHPC + run: | + sudo apt-get update -y && \ + sudo apt-get install -y cmake environment-modules git python3-dev python3-pip python3-numpy && \ + sudo apt-get install -y --no-install-recommends nvhpc-23-5 && \ + sudo rm -rf /var/lib/apt/lists/* + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade pytest + + # On some systems, you many need further workarounds: + # https://github.com/pybind/pybind11/pull/2475 + - name: Configure + shell: bash + run: | + source /etc/profile.d/modules.sh + module load /opt/nvidia/hpc_sdk/modulefiles/nvhpc/23.5 + cmake -S . -B build -DDOWNLOAD_CATCH=ON \ + -DCMAKE_CXX_STANDARD=17 \ + -DPYTHON_EXECUTABLE=$(python3 -c "import sys; print(sys.executable)") \ + -DCMAKE_CXX_FLAGS="-Wc,--pending_instantiations=0" \ + -DPYBIND11_TEST_FILTER="test_smart_ptr.cpp" + + - name: Build + run: cmake --build build -j 2 --verbose + + - name: Python tests + run: cmake --build build --target pytest + + - name: C++ tests + run: cmake --build build --target cpptest + + - name: Interface test + run: cmake --build build --target test_cmake_build + + - name: Visibility test + run: cmake --build build --target test_cross_module_rtti + + # Testing on GCC using the GCC docker images (only recent images supported) + gcc: + if: github.event.pull_request.draft == false + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + include: + - { gcc: 9, std: 20 } + - { gcc: 10, std: 17 } + - { gcc: 10, std: 20 } + - { gcc: 13, std: 20, cxx_flags: "-Wall -Wextra -Wwrite-strings -Wunreachable-code -Wpointer-arith -Wredundant-decls" } + + name: "🐍 3 • GCC ${{ matrix.gcc }} • C++${{ matrix.std }} • x64${{ matrix.cxx_flags && ' • cxx_flags' || '' }}" + container: "gcc:${{ matrix.gcc }}" + + steps: + - uses: actions/checkout@v4 + + - name: Add Python 3 + run: apt-get update; apt-get install -y python3-dev python3-numpy python3-pytest python3-pip libeigen3-dev + + - name: Update pip + run: python3 -m pip install --upgrade pip + + - name: Update CMake + uses: jwlawson/actions-setup-cmake@v2.0 + + - name: Configure + shell: bash + run: > + cmake -S . -B build + -DPYBIND11_WERROR=ON + -DDOWNLOAD_CATCH=ON + -DCMAKE_CXX_STANDARD=${{ matrix.std }} + -DCMAKE_CXX_FLAGS="${{ matrix.cxx_flags }}" + -DPYTHON_EXECUTABLE=$(python3 -c "import sys; print(sys.executable)") + + - name: Build + run: cmake --build build -j 2 + + - name: Python tests + run: cmake --build build --target pytest + + - name: C++ tests + run: cmake --build build --target cpptest + + - name: Interface test + run: cmake --build build --target test_cmake_build + + - name: Visibility test + run: cmake --build build --target test_cross_module_rtti + + - name: Configure - Exercise cmake -DPYBIND11_TEST_OVERRIDE + if: matrix.gcc == '12' + shell: bash + run: > + cmake -S . -B build_partial + -DPYBIND11_WERROR=ON + -DDOWNLOAD_CATCH=ON + -DCMAKE_CXX_STANDARD=${{ matrix.std }} + -DPYTHON_EXECUTABLE=$(python3 -c "import sys; print(sys.executable)") + "-DPYBIND11_TEST_OVERRIDE=test_call_policies.cpp;test_gil_scoped.cpp;test_thread.cpp" + + - name: Build - Exercise cmake -DPYBIND11_TEST_OVERRIDE + if: matrix.gcc == '12' + run: cmake --build build_partial -j 2 + + - name: Python tests - Exercise cmake -DPYBIND11_TEST_OVERRIDE + if: matrix.gcc == '12' + run: cmake --build build_partial --target pytest + + # Testing on ICC using the oneAPI apt repo + icc: + if: github.event.pull_request.draft == false + runs-on: ubuntu-22.04 + + name: "🐍 3 • ICC latest • x64" + + steps: + - uses: actions/checkout@v4 + + - name: Add apt repo + run: | + sudo apt-get update + sudo apt-get install -y wget build-essential pkg-config cmake ca-certificates gnupg + wget https://apt.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS-2023.PUB + sudo apt-key add GPG-PUB-KEY-INTEL-SW-PRODUCTS-2023.PUB + echo "deb https://apt.repos.intel.com/oneapi all main" | sudo tee /etc/apt/sources.list.d/oneAPI.list + + - name: Add ICC & Python 3 + run: sudo apt-get update; sudo apt-get install -y intel-oneapi-compiler-dpcpp-cpp-and-cpp-classic cmake python3-dev python3-numpy python3-pytest python3-pip + + - name: Update pip + run: | + set +e; source /opt/intel/oneapi/setvars.sh; set -e + python3 -m pip install --upgrade pip + + - name: Install dependencies + run: | + set +e; source /opt/intel/oneapi/setvars.sh; set -e + python3 -m pip install -r tests/requirements.txt + + - name: Configure C++11 + run: | + set +e; source /opt/intel/oneapi/setvars.sh; set -e + cmake -S . -B build-11 \ + -DPYBIND11_WERROR=ON \ + -DDOWNLOAD_CATCH=ON \ + -DDOWNLOAD_EIGEN=OFF \ + -DCMAKE_CXX_STANDARD=11 \ + -DCMAKE_CXX_COMPILER=$(which icpc) \ + -DPYTHON_EXECUTABLE=$(python3 -c "import sys; print(sys.executable)") + + - name: Build C++11 + run: | + set +e; source /opt/intel/oneapi/setvars.sh; set -e + cmake --build build-11 -j 2 -v + + - name: Python tests C++11 + run: | + set +e; source /opt/intel/oneapi/setvars.sh; set -e + sudo service apport stop + cmake --build build-11 --target check + + - name: C++ tests C++11 + run: | + set +e; source /opt/intel/oneapi/setvars.sh; set -e + cmake --build build-11 --target cpptest + + - name: Interface test C++11 + run: | + set +e; source /opt/intel/oneapi/setvars.sh; set -e + cmake --build build-11 --target test_cmake_build + + - name: Visibility test + run: | + set +e; source /opt/intel/oneapi/setvars.sh; set -e + cmake --build build-11 --target test_cross_module_rtti + + - name: Configure C++17 + run: | + set +e; source /opt/intel/oneapi/setvars.sh; set -e + cmake -S . -B build-17 \ + -DPYBIND11_WERROR=ON \ + -DDOWNLOAD_CATCH=ON \ + -DDOWNLOAD_EIGEN=OFF \ + -DCMAKE_CXX_STANDARD=17 \ + -DCMAKE_CXX_COMPILER=$(which icpc) \ + -DPYTHON_EXECUTABLE=$(python3 -c "import sys; print(sys.executable)") + + - name: Build C++17 + run: | + set +e; source /opt/intel/oneapi/setvars.sh; set -e + cmake --build build-17 -j 2 -v + + - name: Python tests C++17 + run: | + set +e; source /opt/intel/oneapi/setvars.sh; set -e + sudo service apport stop + cmake --build build-17 --target check + + - name: C++ tests C++17 + run: | + set +e; source /opt/intel/oneapi/setvars.sh; set -e + cmake --build build-17 --target cpptest + + - name: Interface test C++17 + run: | + set +e; source /opt/intel/oneapi/setvars.sh; set -e + cmake --build build-17 --target test_cmake_build + + - name: Visibility test + run: | + set +e; source /opt/intel/oneapi/setvars.sh; set -e + cmake --build build-17 --target test_cross_module_rtti + + # Testing on CentOS (manylinux uses a centos base). + centos: + if: github.event.pull_request.draft == false + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + container: + - "almalinux:8" + - "almalinux:9" + + name: "🐍 3 • ${{ matrix.container }} • x64" + container: "${{ matrix.container }}" + + steps: + - name: Latest actions/checkout + uses: actions/checkout@v4 + + - name: Add Python 3.8 + if: matrix.container == 'almalinux:8' + run: dnf update -y && dnf install -y python38-devel gcc-c++ make git + + - name: Add Python 3 (default) + if: matrix.container != 'almalinux:8' + run: dnf update -y && dnf install -y python3-devel gcc-c++ make git + + - name: Update pip + run: python3 -m pip install --upgrade pip + + - name: Install dependencies + run: | + python3 -m pip install cmake -r tests/requirements.txt + + - name: Ensure NumPy 2 is used (required Python >= 3.9) + if: matrix.container == 'almalinux:9' + run: | + python3 -m pip install 'numpy>=2.0.0b1' 'scipy>=1.13.0rc1' + + - name: Configure + shell: bash + run: > + cmake -S . -B build + -DCMAKE_BUILD_TYPE=MinSizeRel + -DPYBIND11_WERROR=ON + -DDOWNLOAD_CATCH=ON + -DDOWNLOAD_EIGEN=ON + -DCMAKE_CXX_STANDARD=11 + -DPYTHON_EXECUTABLE=$(python3 -c "import sys; print(sys.executable)") + + - name: Build + run: cmake --build build -j 2 + + - name: Python tests + run: cmake --build build --target pytest + + - name: C++ tests + run: cmake --build build --target cpptest + + - name: Interface test + run: cmake --build build --target test_cmake_build + + - name: Visibility test + run: cmake --build build --target test_cross_module_rtti + + + # This tests an "install" with the CMake tools + install-classic: + if: github.event.pull_request.draft == false + name: "🐍 3.9 • Debian • x86 • Install" + runs-on: ubuntu-latest + container: i386/debian:bullseye + + steps: + - uses: actions/checkout@v1 # v1 is required to run inside docker + + - name: Install requirements + run: | + apt-get update + apt-get install -y git make cmake g++ libeigen3-dev python3-dev python3-pip + pip3 install "pytest==6.*" + + - name: Configure for install + run: > + cmake . + -DPYBIND11_INSTALL=1 -DPYBIND11_TEST=0 + -DPYTHON_EXECUTABLE=$(python3 -c "import sys; print(sys.executable)") + + - name: Make and install + run: make install + + - name: Copy tests to new directory + run: cp -a tests /pybind11-tests + + - name: Make a new test directory + run: mkdir /build-tests + + - name: Configure tests + run: > + cmake ../pybind11-tests + -DDOWNLOAD_CATCH=ON + -DPYBIND11_WERROR=ON + -DPYTHON_EXECUTABLE=$(python3 -c "import sys; print(sys.executable)") + working-directory: /build-tests + + - name: Python tests + run: make pytest -j 2 + working-directory: /build-tests + + + # This verifies that the documentation is not horribly broken, and does a + # basic validation check on the SDist. + doxygen: + if: github.event.pull_request.draft == false + name: "Documentation build test" + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 + with: + python-version: "3.x" + + - name: Install Doxygen + run: sudo apt-get install -y doxygen librsvg2-bin # Changed to rsvg-convert in 20.04 + + - name: Build docs + run: pipx run nox -s docs + + - name: Make SDist + run: pipx run nox -s build -- --sdist + + - run: git status --ignored + + - name: Check local include dir + run: > + ls pybind11; + python3 -c "import pybind11, pathlib; assert (a := pybind11.get_include()) == (b := str(pathlib.Path('include').resolve())), f'{a} != {b}'" + + - name: Compare Dists (headers only) + working-directory: include + run: | + python3 -m pip install --user -U ../dist/*.tar.gz + installed=$(python3 -c "import pybind11; print(pybind11.get_include() + '/pybind11')") + diff -rq $installed ./pybind11 + + win32: + if: github.event.pull_request.draft == false + strategy: + fail-fast: false + matrix: + include: + - python: '3.8' + args: -DCMAKE_CXX_STANDARD=17 + - python: '3.10' + args: -DCMAKE_CXX_STANDARD=20 + - python: '3.13' + + + name: "🐍 ${{ matrix.python }} • MSVC 2022 • x86 ${{ matrix.args }}" + runs-on: windows-2022 + + steps: + - uses: actions/checkout@v4 + + - name: Setup Python ${{ matrix.python }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python }} + architecture: x86 + # Python 3.13.4 broken on Windows + check-latest: >- + ${{ matrix.python == '3.13' && runner.os == 'Windows' }} + + - name: Update CMake + uses: jwlawson/actions-setup-cmake@v2.0 + + - name: Prepare MSVC + uses: ilammy/msvc-dev-cmd@v1.13.0 + with: + arch: x86 + + - name: Prepare env + run: | + python -m pip install -r tests/requirements.txt + + - name: Configure ${{ matrix.args }} + run: > + cmake -S . -B build + -G "Visual Studio 17 2022" -A Win32 + -DPYBIND11_WERROR=ON + -DDOWNLOAD_CATCH=ON + -DDOWNLOAD_EIGEN=ON + ${{ matrix.args }} + - name: Build C++11 + run: cmake --build build -j 2 + + - name: Python tests + run: cmake --build build -t pytest + + win32-debug: + if: github.event.pull_request.draft == false + strategy: + fail-fast: false + matrix: + include: + - python: 3.9 + args: -DCMAKE_CXX_STANDARD=20 + - python: 3.8 + args: -DCMAKE_CXX_STANDARD=17 + + name: "🐍 ${{ matrix.python }} • MSVC 2022 (Debug) • x86 ${{ matrix.args }}" + runs-on: windows-2022 + + steps: + - uses: actions/checkout@v4 + + - name: Setup Python ${{ matrix.python }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python }} + architecture: x86 + + - name: Update CMake + uses: jwlawson/actions-setup-cmake@v2.0 + + - name: Prepare MSVC + uses: ilammy/msvc-dev-cmd@v1.13.0 + with: + arch: x86 + + - name: Prepare env + run: | + python -m pip install -r tests/requirements.txt + + - name: Configure ${{ matrix.args }} + run: > + cmake -S . -B build + -G "Visual Studio 17 2022" -A Win32 + -DCMAKE_BUILD_TYPE=Debug + -DPYBIND11_WERROR=ON + -DDOWNLOAD_CATCH=ON + -DDOWNLOAD_EIGEN=ON + ${{ matrix.args }} + - name: Build C++11 + run: cmake --build build --config Debug -j 2 + + - name: Python tests + run: cmake --build build --config Debug -t pytest + + + windows-2022: + if: github.event.pull_request.draft == false + strategy: + fail-fast: false + matrix: + python: + - 3.9 + + name: "🐍 ${{ matrix.python }} • MSVC 2022 C++20 • x64" + runs-on: windows-2022 + + steps: + - uses: actions/checkout@v4 + + - name: Setup Python ${{ matrix.python }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python }} + + - name: Prepare env + run: python3 -m pip install -r tests/requirements.txt + + - name: Update CMake + uses: jwlawson/actions-setup-cmake@v2.0 + + - name: Configure C++20 + run: > + cmake -S . -B build + -DPYBIND11_WERROR=ON + -DDOWNLOAD_CATCH=ON + -DDOWNLOAD_EIGEN=ON + -DCMAKE_CXX_STANDARD=20 + + - name: Build C++20 + run: cmake --build build -j 2 + + - name: Python tests + run: cmake --build build --target pytest + + - name: C++20 tests + run: cmake --build build --target cpptest -j 2 + + - name: Interface test C++20 + run: cmake --build build --target test_cmake_build + + - name: Visibility test + run: cmake --build build --target test_cross_module_rtti + + - name: Configure C++20 - Exercise cmake -DPYBIND11_TEST_OVERRIDE + run: > + cmake -S . -B build_partial + -DPYBIND11_WERROR=ON + -DDOWNLOAD_CATCH=ON + -DDOWNLOAD_EIGEN=ON + -DCMAKE_CXX_STANDARD=20 + "-DPYBIND11_TEST_OVERRIDE=test_call_policies.cpp;test_gil_scoped.cpp;test_thread.cpp" + + - name: Build C++20 - Exercise cmake -DPYBIND11_TEST_OVERRIDE + run: cmake --build build_partial -j 2 + + - name: Python tests - Exercise cmake -DPYBIND11_TEST_OVERRIDE + run: cmake --build build_partial --target pytest + + mingw: + if: github.event.pull_request.draft == false + name: "🐍 3 • windows-latest • ${{ matrix.sys }}" + runs-on: windows-latest + defaults: + run: + shell: msys2 {0} + strategy: + fail-fast: false + matrix: + include: + - { sys: mingw64, env: x86_64 } + - { sys: mingw32, env: i686 } + steps: + - uses: msys2/setup-msys2@v2 + with: + msystem: ${{matrix.sys}} + install: >- + git + mingw-w64-${{matrix.env}}-gcc + mingw-w64-${{matrix.env}}-python-pip + mingw-w64-${{matrix.env}}-cmake + mingw-w64-${{matrix.env}}-make + mingw-w64-${{matrix.env}}-python-pytest + mingw-w64-${{matrix.env}}-boost + mingw-w64-${{matrix.env}}-catch + + - uses: msys2/setup-msys2@v2 + if: matrix.sys == 'mingw64' + with: + msystem: ${{matrix.sys}} + install: >- + mingw-w64-${{matrix.env}}-python-numpy + mingw-w64-${{matrix.env}}-python-scipy + mingw-w64-${{matrix.env}}-eigen3 + + - uses: actions/checkout@v4 + + - name: Configure C++11 + # LTO leads to many undefined reference like + # `pybind11::detail::function_call::function_call(pybind11::detail::function_call&&) + run: >- + cmake -G "MinGW Makefiles" -DCMAKE_CXX_STANDARD=11 -DPYBIND11_WERROR=ON -DDOWNLOAD_CATCH=ON + -DPYTHON_EXECUTABLE=$(python -c "import sys; print(sys.executable)") + -S . -B build + + - name: Build C++11 + run: cmake --build build -j 2 + + - name: Python tests C++11 + run: cmake --build build --target pytest -j 2 + + - name: C++11 tests + run: PYTHONHOME=/${{matrix.sys}} PYTHONPATH=/${{matrix.sys}} cmake --build build --target cpptest -j 2 + + - name: Interface test C++11 + run: PYTHONHOME=/${{matrix.sys}} PYTHONPATH=/${{matrix.sys}} cmake --build build --target test_cmake_build + + - name: Visibility test + run: PYTHONHOME=/${{matrix.sys}} PYTHONPATH=/${{matrix.sys}} cmake --build build --target test_cross_module_rtti + + - name: Clean directory + run: git clean -fdx + + - name: Configure C++14 + run: >- + cmake -G "MinGW Makefiles" -DCMAKE_CXX_STANDARD=14 -DPYBIND11_WERROR=ON -DDOWNLOAD_CATCH=ON + -DPYTHON_EXECUTABLE=$(python -c "import sys; print(sys.executable)") + -S . -B build2 + + - name: Build C++14 + run: cmake --build build2 -j 2 + + - name: Python tests C++14 + run: cmake --build build2 --target pytest -j 2 + + - name: C++14 tests + run: PYTHONHOME=/${{matrix.sys}} PYTHONPATH=/${{matrix.sys}} cmake --build build2 --target cpptest -j 2 + + - name: Interface test C++14 + run: PYTHONHOME=/${{matrix.sys}} PYTHONPATH=/${{matrix.sys}} cmake --build build2 --target test_cmake_build + + - name: Visibility test + run: PYTHONHOME=/${{matrix.sys}} PYTHONPATH=/${{matrix.sys}} cmake --build build2 --target test_cross_module_rtti + + - name: Clean directory + run: git clean -fdx + + - name: Configure C++17 + run: >- + cmake -G "MinGW Makefiles" -DCMAKE_CXX_STANDARD=17 -DPYBIND11_WERROR=ON -DDOWNLOAD_CATCH=ON + -DPYTHON_EXECUTABLE=$(python -c "import sys; print(sys.executable)") + -S . -B build3 + + - name: Build C++17 + run: cmake --build build3 -j 2 + + - name: Python tests C++17 + run: cmake --build build3 --target pytest -j 2 + + - name: C++17 tests + run: PYTHONHOME=/${{matrix.sys}} PYTHONPATH=/${{matrix.sys}} cmake --build build3 --target cpptest -j 2 + + - name: Interface test C++17 + run: PYTHONHOME=/${{matrix.sys}} PYTHONPATH=/${{matrix.sys}} cmake --build build3 --target test_cmake_build + + - name: Visibility test + run: PYTHONHOME=/${{matrix.sys}} PYTHONPATH=/${{matrix.sys}} cmake --build build3 --target test_cross_module_rtti + + windows_clang: + if: github.event.pull_request.draft == false + + strategy: + matrix: + os: [windows-latest] + python: ['3.10'] + + runs-on: "${{ matrix.os }}" + + name: "🐍 ${{ matrix.python }} • ${{ matrix.os }} • clang-latest" + + steps: + - name: Show env + run: env + + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Clang + uses: egor-tensin/setup-clang@v1 + + - name: Setup Python ${{ matrix.python }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python }} + + - name: Update CMake + uses: jwlawson/actions-setup-cmake@v2.0 + + - name: Install ninja-build tool + uses: seanmiddleditch/gha-setup-ninja@v6 + + - name: Run pip installs + run: | + python -m pip install --upgrade pip + python -m pip install -r tests/requirements.txt + + - name: Show Clang++ version + run: clang++ --version + + - name: Show CMake version + run: cmake --version + + # TODO: WERROR=ON + - name: Configure Clang + run: > + cmake -G Ninja -S . -B . + -DPYBIND11_WERROR=OFF + -DPYBIND11_SIMPLE_GIL_MANAGEMENT=OFF + -DDOWNLOAD_CATCH=ON + -DDOWNLOAD_EIGEN=ON + -DCMAKE_CXX_COMPILER=clang++ + -DCMAKE_CXX_STANDARD=17 + + - name: Build + run: cmake --build . -j 2 + + - name: Python tests + run: cmake --build . --target pytest -j 2 + + - name: C++ tests + run: cmake --build . --target cpptest -j 2 + + - name: Interface test + run: cmake --build . --target test_cmake_build -j 2 + + - name: Visibility test + run: cmake --build . --target test_cross_module_rtti -j 2 + + - name: Clean directory + run: git clean -fdx + + macos_brew_install_llvm: + if: github.event.pull_request.draft == false + name: "macos-13 • brew install llvm" + runs-on: macos-13 + + env: + # https://apple.stackexchange.com/questions/227026/how-to-install-recent-clang-with-homebrew + LDFLAGS: '-L/usr/local/opt/llvm/lib -Wl,-rpath,/usr/local/opt/llvm/lib' + + steps: + - name: Update PATH + run: echo "/usr/local/opt/llvm/bin" >> $GITHUB_PATH + + - name: Show env + run: env + + - name: Checkout + uses: actions/checkout@v4 + + - name: Show Clang++ version before brew install llvm + run: clang++ --version + + - name: brew install llvm + run: brew install llvm + + - name: Show Clang++ version after brew install llvm + run: clang++ --version + + - name: Update CMake + uses: jwlawson/actions-setup-cmake@v2.0 + + - name: Run pip installs + run: | + python3 -m pip install --upgrade pip + python3 -m pip install -r tests/requirements.txt + python3 -m pip install numpy + python3 -m pip install scipy + + - name: Show CMake version + run: cmake --version + + - name: CMake Configure + run: > + cmake -S . -B . + -DPYBIND11_WERROR=ON + -DPYBIND11_SIMPLE_GIL_MANAGEMENT=OFF + -DDOWNLOAD_CATCH=ON + -DDOWNLOAD_EIGEN=ON + -DCMAKE_CXX_COMPILER=clang++ + -DCMAKE_CXX_STANDARD=17 + -DPYTHON_EXECUTABLE=$(python3 -c "import sys; print(sys.executable)") + + - name: Build + run: cmake --build . -j 2 + + - name: Python tests + run: cmake --build . --target pytest -j 2 + + - name: C++ tests + run: cmake --build . --target cpptest -j 2 + + - name: Interface test + run: cmake --build . --target test_cmake_build -j 2 + + - name: Visibility test + run: cmake --build . --target test_cross_module_rtti -j 2 + + - name: CMake Configure - Exercise cmake -DPYBIND11_TEST_OVERRIDE + run: > + cmake -S . -B build_partial + -DPYBIND11_WERROR=ON + -DPYBIND11_SIMPLE_GIL_MANAGEMENT=OFF + -DDOWNLOAD_CATCH=ON + -DDOWNLOAD_EIGEN=ON + -DCMAKE_CXX_COMPILER=clang++ + -DCMAKE_CXX_STANDARD=17 + -DPYTHON_EXECUTABLE=$(python3 -c "import sys; print(sys.executable)") + "-DPYBIND11_TEST_OVERRIDE=test_call_policies.cpp;test_gil_scoped.cpp;test_thread.cpp" + + - name: Build - Exercise cmake -DPYBIND11_TEST_OVERRIDE + run: cmake --build build_partial -j 2 + + - name: Python tests - Exercise cmake -DPYBIND11_TEST_OVERRIDE + run: cmake --build build_partial --target pytest -j 2 + + - name: Clean directory + run: git clean -fdx diff --git a/third_party/pybind11/.github/workflows/configure.yml b/third_party/pybind11/.github/workflows/configure.yml new file mode 100644 index 0000000..6a3b365 --- /dev/null +++ b/third_party/pybind11/.github/workflows/configure.yml @@ -0,0 +1,85 @@ +name: Config + +on: + workflow_dispatch: + pull_request: + types: + - opened + - synchronize + - reopened + - ready_for_review + push: + branches: + - master + - stable + - v* + +permissions: + contents: read + +jobs: + # This tests various versions of CMake in various combinations, to make sure + # the configure step passes. + cmake: + if: github.event.pull_request.draft == false + strategy: + fail-fast: false + matrix: + include: + - runs-on: ubuntu-22.04 + cmake: "3.15" + + - runs-on: ubuntu-24.04 + cmake: "3.26" + + - runs-on: ubuntu-24.04 + cmake: "3.29" + + - runs-on: macos-13 + cmake: "3.15" + + - runs-on: macos-14 + cmake: "4.0" + + - 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.11 + uses: actions/setup-python@v5 + with: + python-version: 3.11 + + - name: Install uv + uses: astral-sh/setup-uv@v6 + + - name: Prepare env + run: uv pip install --python=python --system -r tests/requirements.txt + + # An action for adding a specific version of CMake: + # https://github.com/jwlawson/actions-setup-cmake + - name: Setup CMake ${{ matrix.cmake }} + uses: jwlawson/actions-setup-cmake@v2.0 + with: + cmake-version: ${{ matrix.cmake }} + + # These steps use a directory with a space in it intentionally + - name: Configure + shell: bash + run: cmake -S. -B"build dir" -DPYBIND11_WERROR=ON -DDOWNLOAD_CATCH=ON + + # Only build and test if this was manually triggered in the GitHub UI + - name: Build + working-directory: build dir + if: github.event_name == 'workflow_dispatch' + run: cmake --build . --config Release + + - name: Test + working-directory: build dir + if: github.event_name == 'workflow_dispatch' + run: cmake --build . --config Release --target check diff --git a/third_party/pybind11/.github/workflows/docs-link.yml b/third_party/pybind11/.github/workflows/docs-link.yml new file mode 100644 index 0000000..d1f1a17 --- /dev/null +++ b/third_party/pybind11/.github/workflows/docs-link.yml @@ -0,0 +1,41 @@ +name: Read the Docs PR preview + +on: + pull_request_target: + types: + - opened + - synchronize + +permissions: + contents: read + pull-requests: write + +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} + cancel-in-progress: true + +jobs: + documentation-links: + runs-on: ubuntu-latest + if: github.event.repository.fork == false + steps: + - uses: actions/checkout@v4 + + - name: Check for docs changes + id: docs_changes + run: | + # Fetch the PR head + git fetch origin pull/${{ github.event.pull_request.number }}/head:pr-head + + # Show diff between base (current checkout) and PR head + if git diff --name-only HEAD pr-head | grep -q '^docs/'; then + echo "docs_changed=true" >> "$GITHUB_OUTPUT" + else + echo "docs_changed=false" >> "$GITHUB_OUTPUT" + fi + + - uses: readthedocs/actions/preview@v1 + if: steps.docs_changes.outputs.docs_changed == 'true' + with: + project-slug: "pybind11" + single-version: "true" diff --git a/third_party/pybind11/.github/workflows/format.yml b/third_party/pybind11/.github/workflows/format.yml new file mode 100644 index 0000000..9258e27 --- /dev/null +++ b/third_party/pybind11/.github/workflows/format.yml @@ -0,0 +1,54 @@ +# This is a format job. Pre-commit has a first-party GitHub action, so we use +# that: https://github.com/pre-commit/action + +name: Format + +on: + workflow_dispatch: + pull_request: + push: + branches: + - master + - stable + - "v*" + +permissions: + contents: read + +env: + FORCE_COLOR: 3 + # For cmake: + VERBOSE: 1 + +jobs: + pre-commit: + name: Format + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: "3.x" + - name: Add matchers + run: echo "::add-matcher::$GITHUB_WORKSPACE/.github/matchers/pylint.json" + - uses: pre-commit/action@v3.0.1 + + clang-tidy: + # When making changes here, please also review the "Clang-Tidy" section + # in .github/CONTRIBUTING.md and update as needed. + name: Clang-Tidy + runs-on: ubuntu-latest + container: silkeh/clang:20 + steps: + - uses: actions/checkout@v4 + + - name: Install requirements + run: apt-get update && apt-get install -y git python3-dev python3-pytest ninja-build + + - name: Configure + run: cmake --preset tidy + - name: Build + run: cmake --build --preset tidy + + - name: Embedded + run: cmake --build --preset tidy -t cpptest diff --git a/third_party/pybind11/.github/workflows/labeler.yml b/third_party/pybind11/.github/workflows/labeler.yml new file mode 100644 index 0000000..2152abb --- /dev/null +++ b/third_party/pybind11/.github/workflows/labeler.yml @@ -0,0 +1,25 @@ +name: Labeler +on: + pull_request_target: + types: [closed] + +permissions: {} + +jobs: + label: + name: Labeler + runs-on: ubuntu-latest + permissions: + contents: read + pull-requests: write + steps: + + - uses: actions/labeler@v5 + if: > + github.event.pull_request.merged == true && + !startsWith(github.event.pull_request.title, 'chore(deps):') && + !startsWith(github.event.pull_request.title, 'ci(fix):') && + !startsWith(github.event.pull_request.title, 'docs(changelog):') + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + configuration-path: .github/labeler_merged.yml diff --git a/third_party/pybind11/.github/workflows/nightlies.yml b/third_party/pybind11/.github/workflows/nightlies.yml new file mode 100644 index 0000000..788f0cd --- /dev/null +++ b/third_party/pybind11/.github/workflows/nightlies.yml @@ -0,0 +1,59 @@ +name: Upload nightly wheels to Anaconda Cloud + +on: + # Run daily at 2:34 UTC to upload nightly wheels to Anaconda Cloud + schedule: + - cron: "34 2 * * *" + # Run on demand with workflow dispatch + workflow_dispatch: + +permissions: + actions: read + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + build_wheel: + name: Build and upload wheel + if: github.repository_owner == 'pybind' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Install uv + uses: astral-sh/setup-uv@v6 + + - name: Build SDist and wheels + run: | + uv tool install nox + nox -s build + nox -s build_global + + - uses: actions/upload-artifact@v4 + with: + name: Packages + path: dist/* + + upload_nightly_wheels: + name: Upload nightly wheels to Anaconda Cloud + if: github.repository_owner == 'pybind' + needs: [build_wheel] + runs-on: ubuntu-latest + steps: + - uses: actions/download-artifact@v5 + with: + name: Packages + path: dist + + - name: List wheel to be deployed + run: ls -lha dist/*.whl + + - name: Upload wheel to Anaconda Cloud as nightly + uses: scientific-python/upload-nightly-action@b36e8c0c10dbcfd2e05bf95f17ef8c14fd708dbf # 0.6.2 + with: + artifacts_path: dist + anaconda_nightly_upload_token: ${{ secrets.ANACONDA_ORG_UPLOAD_TOKEN }} diff --git a/third_party/pybind11/.github/workflows/pip.yml b/third_party/pybind11/.github/workflows/pip.yml new file mode 100644 index 0000000..9b6a9dc --- /dev/null +++ b/third_party/pybind11/.github/workflows/pip.yml @@ -0,0 +1,118 @@ +name: Pip + +on: + workflow_dispatch: + pull_request: + push: + branches: + - master + - stable + - v* + release: + types: + - published + +permissions: + contents: read + +jobs: + # This builds the sdists and wheels and makes sure the files are exactly as + # expected. + test-packaging: + name: 🐍 3.8 • 📦 tests • windows-latest + runs-on: windows-latest + + steps: + - uses: actions/checkout@v4 + + - name: Setup 🐍 3.8 + uses: actions/setup-python@v5 + with: + python-version: 3.8 + + - name: Install uv + uses: astral-sh/setup-uv@v6 + + - name: Prepare env + run: uv pip install --system -r tests/requirements.txt + + - name: Python Packaging tests + run: pytest tests/extra_python_package/ + + + # This runs the packaging tests and also builds and saves the packages as + # artifacts. + packaging: + name: 🐍 3.8 • 📦 & 📦 tests • ubuntu-latest + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Setup 🐍 3.8 + uses: actions/setup-python@v5 + with: + python-version: 3.8 + + - name: Install uv + uses: astral-sh/setup-uv@v6 + + - name: Prepare env + run: uv pip install --system -r tests/requirements.txt twine nox + + - name: Python Packaging tests + run: pytest tests/extra_python_package/ + + - name: Build SDist and wheels + run: | + nox -s build + nox -s build_global + + - name: Check metadata + run: twine check dist/* + + - name: Save standard package + uses: actions/upload-artifact@v4 + with: + name: standard + path: dist/pybind11-* + + - name: Save global package + uses: actions/upload-artifact@v4 + with: + name: global + path: dist/*global-* + + + + # When a GitHub release is made, upload the artifacts to PyPI + upload: + name: Upload to PyPI + runs-on: ubuntu-latest + if: github.event_name == 'release' && github.event.action == 'published' + needs: [packaging] + environment: + name: pypi + url: https://pypi.org/p/pybind11 + permissions: + id-token: write + attestations: write + + steps: + # Downloads all to directories matching the artifact names + - uses: actions/download-artifact@v5 + + - name: Generate artifact attestation for sdist and wheel + uses: actions/attest-build-provenance@v2 + with: + subject-path: "*/pybind11*" + + - name: Publish standard package + uses: pypa/gh-action-pypi-publish@release/v1 + with: + packages-dir: standard/ + + - name: Publish global package + uses: pypa/gh-action-pypi-publish@release/v1 + with: + packages-dir: global/ diff --git a/third_party/pybind11/.github/workflows/reusable-standard.yml b/third_party/pybind11/.github/workflows/reusable-standard.yml new file mode 100644 index 0000000..5e258e7 --- /dev/null +++ b/third_party/pybind11/.github/workflows/reusable-standard.yml @@ -0,0 +1,96 @@ +name: Reusable Standard Test + +on: + workflow_call: + inputs: + python-version: + required: true + type: string + cmake-args: + required: false + type: string + default: '' + runs-on: + required: true + type: string + +env: + PYTHONDEVMODE: 1 + PIP_BREAK_SYSTEM_PACKAGES: 1 + PIP_ONLY_BINARY: numpy + FORCE_COLOR: 3 + PYTEST_TIMEOUT: 300 + # For cmake: + VERBOSE: 1 + CMAKE_COLOR_DIAGNOSTICS: 1 + +jobs: + standard: + name: 🧪 + runs-on: ${{ inputs.runs-on }} + + steps: + - uses: actions/checkout@v4 + + - name: Setup Python ${{ inputs.python-version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ inputs.python-version }} + allow-prereleases: true + # Python 3.13.4 broken on Windows + check-latest: >- + ${{ inputs.python-version == '3.13' && runner.os == 'Windows' }} + + - name: Setup Boost (Linux) + if: runner.os == 'Linux' + run: sudo apt-get install libboost-dev + + - name: Setup Boost (macOS) + if: runner.os == 'macOS' + run: brew install boost + + - name: Install uv + uses: astral-sh/setup-uv@v6 + with: + enable-cache: true + + - name: Prepare env + run: uv pip install --python=python --system -r tests/requirements.txt + + - name: Setup annotations on Linux + if: runner.os == 'Linux' + run: uv pip install --python=python --system pytest-github-actions-annotate-failures + + # TODO Resolve Windows Ninja shared object issue on Python 3.8+ + - name: Use Ninja except on Windows + if: runner.os != 'Windows' + run: echo "CMAKE_GENERATOR=Ninja" >> "$GITHUB_ENV" + + - name: Configure + run: > + cmake -S. -Bbuild -Werror=dev + -DPYBIND11_WERROR=ON + -DPYBIND11_PYTEST_ARGS=-v + -DDOWNLOAD_CATCH=ON + -DDOWNLOAD_EIGEN=ON + ${{ inputs.cmake-args }} + + - name: Build + run: cmake --build build + + - name: Python tests + run: cmake --build build --target pytest + + - name: C++ tests + run: cmake --build build --target cpptest + + - name: Interface test + run: cmake --build build --target test_cmake_build + + - name: Visibility test + run: cmake --build build --target test_cross_module_rtti + + - name: Setuptools helpers test + run: | + uv pip install --python=python --system setuptools + pytest tests/extra_setuptools diff --git a/third_party/pybind11/.github/workflows/tests-cibw.yml b/third_party/pybind11/.github/workflows/tests-cibw.yml new file mode 100644 index 0000000..0abddd0 --- /dev/null +++ b/third_party/pybind11/.github/workflows/tests-cibw.yml @@ -0,0 +1,86 @@ +name: CIBW + +on: + workflow_dispatch: + pull_request: + branches: + - master + - stable + - v* + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + build-wasm-emscripten: + name: Pyodide wheel + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + submodules: true + fetch-depth: 0 + + - uses: pypa/cibuildwheel@v3.1 + env: + PYODIDE_BUILD_EXPORTS: whole_archive + with: + package-dir: tests + only: cp312-pyodide_wasm32 + + build-ios: + name: iOS wheel ${{ matrix.runs-on }} + runs-on: ${{ matrix.runs-on }} + strategy: + fail-fast: false + matrix: + runs-on: [macos-14, macos-13] + steps: + - uses: actions/checkout@v4 + with: + submodules: true + fetch-depth: 0 + + - run: brew upgrade cmake + + - uses: pypa/cibuildwheel@v3.1 + env: + CIBW_PLATFORM: ios + CIBW_SKIP: cp314-* # https://github.com/pypa/cibuildwheel/issues/2494 + with: + package-dir: tests + + build-android: + name: Android wheel ${{ matrix.runs-on }} + runs-on: ${{ matrix.runs-on }} + strategy: + fail-fast: false + matrix: + runs-on: [macos-latest, macos-13, ubuntu-latest] + steps: + - uses: actions/checkout@v4 + with: + submodules: true + fetch-depth: 0 + + # GitHub Actions can't currently run the Android emulator on macOS. + - name: Skip Android tests on macOS + if: contains(matrix.runs-on, 'macos') + run: echo "CIBW_TEST_COMMAND=" >> "$GITHUB_ENV" + + # https://github.blog/changelog/2024-04-02-github-actions-hardware-accelerated-android-virtualization-now-available/ + - name: Enable KVM for Android emulator + if: contains(matrix.runs-on, 'ubuntu') + run: | + echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules + sudo udevadm control --reload-rules + sudo udevadm trigger --name-match=kvm + + - run: pipx install patchelf + + - uses: pypa/cibuildwheel@v3.1 + env: + CIBW_PLATFORM: android + with: + package-dir: tests diff --git a/third_party/pybind11/.github/workflows/upstream.yml b/third_party/pybind11/.github/workflows/upstream.yml new file mode 100644 index 0000000..3892600 --- /dev/null +++ b/third_party/pybind11/.github/workflows/upstream.yml @@ -0,0 +1,116 @@ +name: Upstream + +on: + workflow_dispatch: + pull_request: + +permissions: + contents: read + +concurrency: + group: upstream-${{ github.ref }} + cancel-in-progress: true + +env: + PIP_BREAK_SYSTEM_PACKAGES: 1 + # For cmake: + VERBOSE: 1 + +jobs: + standard: + name: "🐍 3.13 latest • ubuntu-latest • x64" + runs-on: ubuntu-latest + # Only runs when the 'python dev' label is selected + if: "contains(github.event.pull_request.labels.*.name, 'python dev')" + + steps: + - uses: actions/checkout@v4 + + - name: Setup Python 3.13 + uses: actions/setup-python@v5 + with: + python-version: "3.13" + allow-prereleases: true + + - name: Setup Boost + run: sudo apt-get install libboost-dev + + - name: Update CMake + uses: jwlawson/actions-setup-cmake@v2.0 + + - name: Run pip installs + run: | + python -m pip install --upgrade pip + python -m pip install -r tests/requirements.txt + + - name: Show platform info + run: | + python -m platform + cmake --version + pip list + + # First build - C++11 mode and inplace + - name: Configure C++11 + run: > + cmake -S . -B build11 + -DPYBIND11_WERROR=ON + -DDOWNLOAD_CATCH=ON + -DDOWNLOAD_EIGEN=ON + -DCMAKE_CXX_STANDARD=11 + -DCMAKE_BUILD_TYPE=Debug + + - name: Build C++11 + run: cmake --build build11 -j 2 + + - name: Python tests C++11 + run: cmake --build build11 --target pytest -j 2 + + - name: C++11 tests + run: cmake --build build11 --target cpptest -j 2 + + - name: Interface test C++11 + run: cmake --build build11 --target test_cmake_build + + # Second build - C++17 mode and in a build directory + - name: Configure C++17 + run: > + cmake -S . -B build17 + -DPYBIND11_WERROR=ON + -DDOWNLOAD_CATCH=ON + -DDOWNLOAD_EIGEN=ON + -DCMAKE_CXX_STANDARD=17 + + - name: Build C++17 + run: cmake --build build17 -j 2 + + - name: Python tests C++17 + run: cmake --build build17 --target pytest + + - name: C++17 tests + run: cmake --build build17 --target cpptest + + # Third build - C++17 mode with unstable ABI + - name: Configure (unstable ABI) + run: > + cmake -S . -B build17max + -DPYBIND11_WERROR=ON + -DDOWNLOAD_CATCH=ON + -DDOWNLOAD_EIGEN=ON + -DCMAKE_CXX_STANDARD=17 + -DPYBIND11_INTERNALS_VERSION=10000000 + + - name: Build (unstable ABI) + run: cmake --build build17max -j 2 + + - name: Python tests (unstable ABI) + run: cmake --build build17max --target pytest + + - name: Interface test (unstable ABI) + run: cmake --build build17max --target test_cmake_build + + # This makes sure the setup_helpers module can build packages using + # setuptools + - name: Setuptools helpers test + run: | + pip install setuptools + pytest tests/extra_setuptools diff --git a/third_party/pybind11/.gitignore b/third_party/pybind11/.gitignore new file mode 100644 index 0000000..5875be3 --- /dev/null +++ b/third_party/pybind11/.gitignore @@ -0,0 +1,53 @@ +CMakeCache.txt +CMakeFiles +Makefile +cmake_install.cmake +cmake_uninstall.cmake +.DS_Store +*.so +*.pyd +*.dll +*.sln +*.sdf +*.opensdf +*.vcxproj +*.vcxproj.user +*.filters +example.dir +Win32 +x64 +Release +Debug +.vs +CTestTestfile.cmake +Testing +autogen +MANIFEST +/.ninja_* +/*.ninja +/docs/.build +*.py[co] +*.egg-info +*~ +.*.swp +.DS_Store +/dist +/*build* +.cache/ +sosize-*.txt +pybind11Config*.cmake +pybind11Targets.cmake +/*env* +/.vscode +/pybind11/include/* +/pybind11/share/* +/docs/_build/* +.ipynb_checkpoints/ +tests/main.cpp +CMakeUserPresents.json + +/Python +/tmp* +.ruby-version +.*cache*/ +*.lock diff --git a/third_party/pybind11/.pre-commit-config.yaml b/third_party/pybind11/.pre-commit-config.yaml new file mode 100644 index 0000000..8435fba --- /dev/null +++ b/third_party/pybind11/.pre-commit-config.yaml @@ -0,0 +1,149 @@ +# To use: +# +# pre-commit run -a +# +# Or: +# +# pre-commit install # (runs every time you commit in git) +# +# To update this file: +# +# pre-commit autoupdate +# +# See https://github.com/pre-commit/pre-commit + + +ci: + autoupdate_commit_msg: "chore(deps): update pre-commit hooks" + autofix_commit_msg: "style: pre-commit fixes" + autoupdate_schedule: monthly + +# third-party content +exclude: ^tools/JoinPaths.cmake$ + +repos: + +# Clang format the codebase automatically +- repo: https://github.com/pre-commit/mirrors-clang-format + rev: "v20.1.8" + 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.12.7 + hooks: + - id: ruff-check + args: ["--fix", "--show-fixes"] + - id: ruff-format + +# Check static types with mypy +- repo: https://github.com/pre-commit/mirrors-mypy + rev: "v1.17.1" + hooks: + - id: mypy + args: [] + exclude: ^(tests|docs)/ + additional_dependencies: + - markdown-it-py + - nox + - rich + - types-setuptools + +# CMake formatting +- repo: https://github.com/cheshirekow/cmake-format-precommit + rev: "v0.6.13" + hooks: + - id: cmake-format + additional_dependencies: [pyyaml] + types: [file] + files: (\.cmake|CMakeLists.txt)(.in)?$ + +# Standard hooks +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: "v5.0.0" + hooks: + - id: check-added-large-files + - id: check-case-conflict + - id: check-docstring-first + - id: check-merge-conflict + - id: check-symlinks + - id: check-toml + - id: check-yaml + - id: debug-statements + - id: end-of-file-fixer + - id: mixed-line-ending + - id: requirements-txt-fixer + - id: trailing-whitespace + exclude: \.patch?$ + +# Also code format the docs +- repo: https://github.com/adamchainz/blacken-docs + rev: "1.19.1" + hooks: + - id: blacken-docs + additional_dependencies: + - black==23.* + +# Changes tabs to spaces +- repo: https://github.com/Lucas-C/pre-commit-hooks + rev: "v1.5.5" + hooks: + - id: remove-tabs + exclude: (^docs/.*|\.patch)?$ + +# Avoid directional quotes +- repo: https://github.com/sirosen/texthooks + rev: "0.7.1" + hooks: + - id: fix-ligatures + - id: fix-smartquotes + +# Checking for common mistakes +- repo: https://github.com/pre-commit/pygrep-hooks + rev: "v1.10.0" + hooks: + - id: rst-backticks + - id: rst-directive-colons + - id: rst-inline-touching-normal + +# Check for spelling +# Use tools/codespell_ignore_lines_from_errors.py +# to rebuild .codespell-ignore-lines +- repo: https://github.com/codespell-project/codespell + rev: "v2.4.1" + hooks: + - id: codespell + exclude: ".supp$" + args: ["-x.codespell-ignore-lines", "-Lccompiler,intstruct"] + +# Check for common shell mistakes +- repo: https://github.com/shellcheck-py/shellcheck-py + rev: "v0.10.0.1" + hooks: + - id: shellcheck + +# Disallow some common capitalization mistakes +- repo: local + hooks: + - id: disallow-caps + name: Disallow improper capitalization + language: pygrep + entry: PyBind|\bNumpy\b|Cmake|CCache|PyTest + exclude: ^\.pre-commit-config.yaml$ + +# PyLint has native support - not always usable, but works for us +- repo: https://github.com/PyCQA/pylint + rev: "v3.3.7" + hooks: + - id: pylint + files: ^pybind11 + +# Check schemas on some of our YAML files +- repo: https://github.com/python-jsonschema/check-jsonschema + rev: 0.33.2 + hooks: + - id: check-readthedocs + - id: check-github-workflows + - id: check-dependabot diff --git a/third_party/pybind11/.readthedocs.yml b/third_party/pybind11/.readthedocs.yml new file mode 100644 index 0000000..a2b802f --- /dev/null +++ b/third_party/pybind11/.readthedocs.yml @@ -0,0 +1,20 @@ +# https://blog.readthedocs.com/migrate-configuration-v2/ + +version: 2 + +build: + os: ubuntu-22.04 + apt_packages: + - librsvg2-bin + tools: + python: "3.11" + +sphinx: + configuration: docs/conf.py + +python: + install: + - requirements: docs/requirements.txt + +formats: + - pdf diff --git a/third_party/pybind11/CMakeLists.txt b/third_party/pybind11/CMakeLists.txt new file mode 100644 index 0000000..ba5f665 --- /dev/null +++ b/third_party/pybind11/CMakeLists.txt @@ -0,0 +1,423 @@ +# CMakeLists.txt -- Build system for the pybind11 modules +# +# Copyright (c) 2015 Wenzel Jakob +# +# All rights reserved. Use of this source code is governed by a +# BSD-style license that can be found in the LICENSE file. + +# Propagate this policy (FindPythonInterp removal) so it can be detected later +if(NOT CMAKE_VERSION VERSION_LESS "3.27") + cmake_policy(GET CMP0148 _pybind11_cmp0148) +endif() + +cmake_minimum_required(VERSION 3.15...4.0) + +if(_pybind11_cmp0148) + cmake_policy(SET CMP0148 ${_pybind11_cmp0148}) + unset(_pybind11_cmp0148) +endif() + +# Avoid infinite recursion if tests include this as a subdirectory +include_guard(GLOBAL) + +# Extract project version from source +file(STRINGS "${CMAKE_CURRENT_SOURCE_DIR}/include/pybind11/detail/common.h" + pybind11_version_defines REGEX "#define PYBIND11_VERSION_(MAJOR|MINOR|PATCH) ") + +foreach(ver ${pybind11_version_defines}) + if(ver MATCHES [[#define PYBIND11_VERSION_(MAJOR|MINOR|PATCH) +([^ ]+)$]]) + set(PYBIND11_VERSION_${CMAKE_MATCH_1} "${CMAKE_MATCH_2}") + endif() +endforeach() + +if(PYBIND11_VERSION_PATCH MATCHES [[\.([a-zA-Z0-9]+)$]]) + set(pybind11_VERSION_TYPE "${CMAKE_MATCH_1}") +endif() +string(REGEX MATCH "^[0-9]+" PYBIND11_VERSION_PATCH "${PYBIND11_VERSION_PATCH}") + +project( + pybind11 + LANGUAGES CXX + VERSION "${PYBIND11_VERSION_MAJOR}.${PYBIND11_VERSION_MINOR}.${PYBIND11_VERSION_PATCH}") + +# Standard includes +include(GNUInstallDirs) +include(CMakePackageConfigHelpers) +include(CMakeDependentOption) + +if(NOT pybind11_FIND_QUIETLY) + message(STATUS "pybind11 v${pybind11_VERSION} ${pybind11_VERSION_TYPE}") +endif() + +# Check if pybind11 is being used directly or via add_subdirectory +if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR) + ### Warn if not an out-of-source builds + if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_CURRENT_BINARY_DIR) + set(lines + "You are building in-place. If that is not what you intended to " + "do, you can clean the source directory with:\n" + "rm -r CMakeCache.txt CMakeFiles/ cmake_uninstall.cmake pybind11Config.cmake " + "pybind11ConfigVersion.cmake tests/CMakeFiles/\n") + message(AUTHOR_WARNING ${lines}) + endif() + + set(PYBIND11_MASTER_PROJECT ON) + + message(STATUS "CMake ${CMAKE_VERSION}") + + if(DEFINED SKBUILD AND DEFINED ENV{PYBIND11_GLOBAL_SDIST}) + message( + FATAL_ERROR + "PYBIND11_GLOBAL_SDIST is not supported, use nox -s build_global or a pybind11-global SDist instead." + ) + endif() + + if(CMAKE_CXX_STANDARD) + set(CMAKE_CXX_EXTENSIONS OFF) + set(CMAKE_CXX_STANDARD_REQUIRED ON) + endif() + + set(pybind11_system "") + + set_property(GLOBAL PROPERTY USE_FOLDERS ON) + if(CMAKE_VERSION VERSION_LESS "3.18") + set(_pybind11_findpython_default OFF) + else() + set(_pybind11_findpython_default ON) + endif() +else() + set(PYBIND11_MASTER_PROJECT OFF) + set(pybind11_system SYSTEM) + set(_pybind11_findpython_default COMPAT) +endif() + +# Options +option(PYBIND11_INSTALL "Install pybind11 header files?" ${PYBIND11_MASTER_PROJECT}) +option(PYBIND11_TEST "Build pybind11 test suite?" ${PYBIND11_MASTER_PROJECT}) +option(PYBIND11_NOPYTHON "Disable search for Python" OFF) +option(PYBIND11_DISABLE_HANDLE_TYPE_NAME_DEFAULT_IMPLEMENTATION + "To enforce that a handle_type_name<> specialization exists" OFF) +option(PYBIND11_SIMPLE_GIL_MANAGEMENT + "Use simpler GIL management logic that does not support disassociation" OFF) +set(PYBIND11_INTERNALS_VERSION + "" + CACHE STRING "Override the ABI version, may be used to enable the unstable ABI.") +option(PYBIND11_USE_CROSSCOMPILING "Respect CMAKE_CROSSCOMPILING" OFF) + +if(PYBIND11_DISABLE_HANDLE_TYPE_NAME_DEFAULT_IMPLEMENTATION) + add_compile_definitions(PYBIND11_DISABLE_HANDLE_TYPE_NAME_DEFAULT_IMPLEMENTATION) +endif() +if(PYBIND11_SIMPLE_GIL_MANAGEMENT) + add_compile_definitions(PYBIND11_SIMPLE_GIL_MANAGEMENT) +endif() + +cmake_dependent_option( + USE_PYTHON_INCLUDE_DIR + "Install pybind11 headers in Python include directory instead of default installation prefix" + OFF "PYBIND11_INSTALL" OFF) + +set(PYBIND11_FINDPYTHON + ${_pybind11_findpython_default} + CACHE STRING "Force new FindPython - NEW, OLD, COMPAT") + +if(PYBIND11_MASTER_PROJECT) + + # Allow PYTHON_EXECUTABLE if in FINDPYTHON mode and building pybind11's tests + # (makes transition easier while we support both modes). + if(PYBIND11_FINDPYTHON + AND DEFINED PYTHON_EXECUTABLE + AND NOT DEFINED Python_EXECUTABLE) + set(Python_EXECUTABLE "${PYTHON_EXECUTABLE}") + endif() + + # This is a shortcut that is primarily for the venv cmake preset, + # but can be used to quickly setup tests manually, too + set(PYBIND11_CREATE_WITH_UV + "" + CACHE STRING "Create a virtualenv if it doesn't exist") + + if(NOT PYBIND11_CREATE_WITH_UV STREQUAL "") + set(Python_ROOT_DIR "${CMAKE_CURRENT_BINARY_DIR}/.venv") + if(EXISTS "${Python_ROOT_DIR}") + if(EXISTS "${CMAKE_BINARY_DIR}/CMakeCache.txt") + message(STATUS "Using existing venv at ${Python_ROOT_DIR}, remove or --fresh to recreate") + else() + # --fresh used to remove the cache + file(REMOVE_RECURSE "${CMAKE_CURRENT_BINARY_DIR}/.venv") + endif() + endif() + if(NOT EXISTS "${Python_ROOT_DIR}") + find_program(UV uv REQUIRED) + # CMake 3.19+ would be able to use COMMAND_ERROR_IS_FATAL + message( + STATUS "Creating venv with ${UV} venv -p ${PYBIND11_CREATE_WITH_UV} '${Python_ROOT_DIR}'") + execute_process(COMMAND ${UV} venv -p ${PYBIND11_CREATE_WITH_UV} "${Python_ROOT_DIR}" + RESULT_VARIABLE _venv_result) + if(_venv_result AND NOT _venv_result EQUAL 0) + message(FATAL_ERROR "uv venv failed with '${_venv_result}'") + endif() + message( + STATUS + "Installing deps with ${UV} pip install -p '${Python_ROOT_DIR}' -r tests/requirements.txt" + ) + execute_process( + COMMAND ${UV} pip install -p "${Python_ROOT_DIR}" -r + "${CMAKE_CURRENT_SOURCE_DIR}/tests/requirements.txt" RESULT_VARIABLE _pip_result) + if(_pip_result AND NOT _pip_result EQUAL 0) + message(FATAL_ERROR "uv pip install failed with '${_pip_result}'") + endif() + endif() + else() + if(NOT DEFINED Python3_EXECUTABLE + AND NOT DEFINED Python_EXECUTABLE + AND NOT DEFINED Python_ROOT_DIR + AND NOT DEFINED ENV{VIRTUALENV} + AND EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/.venv") + message(STATUS "Autodetecting Python in virtual environment") + set(Python_ROOT_DIR "${CMAKE_CURRENT_SOURCE_DIR}/.venv") + endif() + endif() +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/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/attr.h + include/pybind11/buffer_info.h + include/pybind11/cast.h + include/pybind11/chrono.h + include/pybind11/common.h + include/pybind11/complex.h + include/pybind11/conduit/pybind11_conduit_v1.h + include/pybind11/conduit/pybind11_platform_abi_id.h + include/pybind11/conduit/wrap_include_python_h.h + include/pybind11/critical_section.h + include/pybind11/options.h + include/pybind11/eigen.h + include/pybind11/eigen/common.h + include/pybind11/eigen/matrix.h + include/pybind11/eigen/tensor.h + include/pybind11/embed.h + include/pybind11/eval.h + include/pybind11/gil.h + include/pybind11/gil_safe_call_once.h + include/pybind11/gil_simple.h + include/pybind11/iostream.h + include/pybind11/functional.h + include/pybind11/native_enum.h + include/pybind11/numpy.h + include/pybind11/operators.h + include/pybind11/pybind11.h + include/pybind11/pytypes.h + include/pybind11/subinterpreter.h + include/pybind11/stl.h + include/pybind11/stl_bind.h + include/pybind11/stl/filesystem.h + include/pybind11/trampoline_self_life_support.h + include/pybind11/type_caster_pyobject_ptr.h + include/pybind11/typing.h + include/pybind11/warnings.h) + +# Compare with grep and warn if mismatched +if(PYBIND11_MASTER_PROJECT) + file( + GLOB_RECURSE _pybind11_header_check + LIST_DIRECTORIES false + RELATIVE "${CMAKE_CURRENT_SOURCE_DIR}" + CONFIGURE_DEPENDS "include/pybind11/*.h") + set(_pybind11_here_only ${PYBIND11_HEADERS}) + set(_pybind11_disk_only ${_pybind11_header_check}) + list(REMOVE_ITEM _pybind11_here_only ${_pybind11_header_check}) + list(REMOVE_ITEM _pybind11_disk_only ${PYBIND11_HEADERS}) + if(_pybind11_here_only) + message(AUTHOR_WARNING "PYBIND11_HEADERS has extra files:" ${_pybind11_here_only}) + endif() + if(_pybind11_disk_only) + message(AUTHOR_WARNING "PYBIND11_HEADERS is missing files:" ${_pybind11_disk_only}) + endif() +endif() + +list(TRANSFORM PYBIND11_HEADERS PREPEND "${CMAKE_CURRENT_SOURCE_DIR}/") + +# Cache variable so this can be used in parent projects +set(pybind11_INCLUDE_DIR + "${CMAKE_CURRENT_LIST_DIR}/include" + CACHE INTERNAL "Directory where pybind11 headers are located") + +# Backward compatible variable for add_subdirectory mode +if(NOT PYBIND11_MASTER_PROJECT) + set(PYBIND11_INCLUDE_DIR + "${pybind11_INCLUDE_DIR}" + CACHE INTERNAL "") +endif() + +# Note: when creating targets, you cannot use if statements at configure time - +# you need generator expressions, because those will be placed in the target file. +# You can also place ifs *in* the Config.in, but not here. + +# This section builds targets, but does *not* touch Python +# Non-IMPORT targets cannot be defined twice +if(NOT TARGET pybind11_headers) + # Build the headers-only target (no Python included): + # (long name used here to keep this from clashing in subdirectory mode) + add_library(pybind11_headers INTERFACE) + add_library(pybind11::pybind11_headers ALIAS pybind11_headers) # to match exported target + add_library(pybind11::headers ALIAS pybind11_headers) # easier to use/remember + + target_include_directories( + pybind11_headers ${pybind11_system} INTERFACE $ + $) + + target_compile_features(pybind11_headers INTERFACE cxx_inheriting_constructors cxx_user_literals + cxx_right_angle_brackets) + if(NOT "${PYBIND11_INTERNALS_VERSION}" STREQUAL "") + target_compile_definitions( + pybind11_headers INTERFACE "PYBIND11_INTERNALS_VERSION=${PYBIND11_INTERNALS_VERSION}") + endif() +else() + # It is invalid to install a target twice, too. + set(PYBIND11_INSTALL OFF) +endif() + +include("${CMAKE_CURRENT_SOURCE_DIR}/tools/pybind11Common.cmake") +# https://github.com/jtojnar/cmake-snips/#concatenating-paths-when-building-pkg-config-files +# TODO: cmake 3.20 adds the cmake_path() function, which obsoletes this snippet +include("${CMAKE_CURRENT_SOURCE_DIR}/tools/JoinPaths.cmake") + +# Relative directory setting +if(USE_PYTHON_INCLUDE_DIR AND DEFINED Python_INCLUDE_DIRS) + file(RELATIVE_PATH CMAKE_INSTALL_INCLUDEDIR ${CMAKE_INSTALL_PREFIX} ${Python_INCLUDE_DIRS}) +elseif(USE_PYTHON_INCLUDE_DIR AND DEFINED PYTHON_INCLUDE_DIR) + file(RELATIVE_PATH CMAKE_INSTALL_INCLUDEDIR ${CMAKE_INSTALL_PREFIX} ${PYTHON_INCLUDE_DIRS}) +endif() + +if(PYBIND11_INSTALL) + if(DEFINED SKBUILD_PROJECT_NAME AND SKBUILD_PROJECT_NAME STREQUAL "pybind11_global") + install(DIRECTORY ${pybind11_INCLUDE_DIR}/pybind11 DESTINATION "${SKBUILD_HEADERS_DIR}") + endif() + install(DIRECTORY ${pybind11_INCLUDE_DIR}/pybind11 DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) + set(PYBIND11_CMAKECONFIG_INSTALL_DIR + "${CMAKE_INSTALL_DATAROOTDIR}/cmake/${PROJECT_NAME}" + CACHE STRING "install path for pybind11Config.cmake") + + if(IS_ABSOLUTE "${CMAKE_INSTALL_INCLUDEDIR}") + set(pybind11_INCLUDEDIR "${CMAKE_INSTALL_FULL_INCLUDEDIR}") + else() + set(pybind11_INCLUDEDIR "\$\{PACKAGE_PREFIX_DIR\}/${CMAKE_INSTALL_INCLUDEDIR}") + endif() + + configure_package_config_file( + tools/${PROJECT_NAME}Config.cmake.in "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake" + INSTALL_DESTINATION ${PYBIND11_CMAKECONFIG_INSTALL_DIR}) + + # CMake natively supports header-only libraries + write_basic_package_version_file( + ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake + VERSION ${PROJECT_VERSION} + COMPATIBILITY AnyNewerVersion ARCH_INDEPENDENT) + + install( + FILES ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake + ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake + tools/FindPythonLibsNew.cmake + tools/pybind11Common.cmake + tools/pybind11Tools.cmake + tools/pybind11NewTools.cmake + tools/pybind11GuessPythonExtSuffix.cmake + DESTINATION ${PYBIND11_CMAKECONFIG_INSTALL_DIR}) + + if(NOT PYBIND11_EXPORT_NAME) + set(PYBIND11_EXPORT_NAME "${PROJECT_NAME}Targets") + endif() + + install(TARGETS pybind11_headers EXPORT "${PYBIND11_EXPORT_NAME}") + + install( + EXPORT "${PYBIND11_EXPORT_NAME}" + NAMESPACE "pybind11::" + DESTINATION ${PYBIND11_CMAKECONFIG_INSTALL_DIR}) + + # pkg-config support + if(NOT prefix_for_pc_file) + if(IS_ABSOLUTE "${CMAKE_INSTALL_DATAROOTDIR}") + set(prefix_for_pc_file "${CMAKE_INSTALL_PREFIX}") + else() + set(pc_datarootdir "${CMAKE_INSTALL_DATAROOTDIR}") + if(CMAKE_VERSION VERSION_LESS 3.20) + set(prefix_for_pc_file "\${pcfiledir}/..") + while(pc_datarootdir) + get_filename_component(pc_datarootdir "${pc_datarootdir}" DIRECTORY) + string(APPEND prefix_for_pc_file "/..") + endwhile() + else() + cmake_path(RELATIVE_PATH CMAKE_INSTALL_PREFIX BASE_DIRECTORY CMAKE_INSTALL_DATAROOTDIR + OUTPUT_VARIABLE prefix_for_pc_file) + endif() + endif() + endif() + join_paths(includedir_for_pc_file "\${prefix}" "${CMAKE_INSTALL_INCLUDEDIR}") + configure_file("${CMAKE_CURRENT_SOURCE_DIR}/tools/pybind11.pc.in" + "${CMAKE_CURRENT_BINARY_DIR}/pybind11.pc" @ONLY) + install(FILES "${CMAKE_CURRENT_BINARY_DIR}/pybind11.pc" + DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/pkgconfig/") + + # When building a wheel, include __init__.py's for modules + # (see https://github.com/pybind/pybind11/pull/5552) + if(DEFINED SKBUILD_PROJECT_NAME AND SKBUILD_PROJECT_NAME STREQUAL "pybind11") + file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/empty") + file(TOUCH "${CMAKE_CURRENT_BINARY_DIR}/empty/__init__.py") + install(FILES "${CMAKE_CURRENT_BINARY_DIR}/empty/__init__.py" + DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/") + install(FILES "${CMAKE_CURRENT_BINARY_DIR}/empty/__init__.py" + DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/pkgconfig/") + endif() + + # Uninstall target + if(PYBIND11_MASTER_PROJECT) + configure_file("${CMAKE_CURRENT_SOURCE_DIR}/tools/cmake_uninstall.cmake.in" + "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake" IMMEDIATE @ONLY) + + add_custom_target(uninstall COMMAND ${CMAKE_COMMAND} -P + ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake) + endif() +endif() + +# BUILD_TESTING takes priority, but only if this is the master project +if(PYBIND11_MASTER_PROJECT AND DEFINED BUILD_TESTING) + if(BUILD_TESTING) + if(_pybind11_nopython) + message(FATAL_ERROR "Cannot activate tests in NOPYTHON mode") + else() + add_subdirectory(tests) + endif() + endif() +else() + if(PYBIND11_TEST) + if(_pybind11_nopython) + message(FATAL_ERROR "Cannot activate tests in NOPYTHON mode") + else() + add_subdirectory(tests) + endif() + endif() +endif() + +# Better symmetry with find_package(pybind11 CONFIG) mode. +if(NOT PYBIND11_MASTER_PROJECT) + set(pybind11_FOUND + TRUE + CACHE INTERNAL "True if pybind11 and all required components found on the system") +endif() diff --git a/third_party/pybind11/CMakePresets.json b/third_party/pybind11/CMakePresets.json new file mode 100644 index 0000000..42bf3ad --- /dev/null +++ b/third_party/pybind11/CMakePresets.json @@ -0,0 +1,93 @@ +{ + "version": 6, + "configurePresets": [ + { + "name": "default", + "displayName": "Default", + "binaryDir": "build", + "generator": "Ninja", + "errors": { + "dev": true, + "deprecated": true + }, + "cacheVariables": { + "CMAKE_BUILD_TYPE": "Debug", + "CMAKE_EXPORT_COMPILE_COMMANDS": true, + "DOWNLOAD_CATCH": true, + "DOWNLOAD_EIGEN": true, + "PYBIND11_FINDPYTHON": "NEW", + "PYBIND11_WERROR": true, + "CMAKE_COLOR_DIAGNOSTICS": true + } + }, + { + "name": "venv", + "displayName": "Venv", + "inherits": "default", + "cacheVariables": { + "PYBIND11_CREATE_WITH_UV": "python3", + "Python_ROOT_DIR": ".venv" + } + }, + { + "name": "tidy", + "displayName": "Clang-tidy", + "inherits": "default", + "binaryDir": "build-tidy", + "cacheVariables": { + "CMAKE_CXX_CLANG_TIDY": "clang-tidy;--use-color;--warnings-as-errors=*", + "CMAKE_CXX_STANDARD": "17" + } + } + ], + "buildPresets": [ + { + "name": "default", + "displayName": "Default Build", + "configurePreset": "default" + }, + { + "name": "venv", + "displayName": "Venv Build", + "configurePreset": "venv" + }, + { + "name": "tidy", + "displayName": "Clang-tidy Build", + "configurePreset": "tidy", + "nativeToolOptions": ["-k0"] + }, + { + "name": "tests", + "displayName": "Tests (for workflow)", + "configurePreset": "default", + "targets": ["pytest", "cpptest", "test_cmake_build", "test_cross_module_rtti"] + }, + { + "name": "testsvenv", + "displayName": "Tests Venv (for workflow)", + "configurePreset": "venv", + "targets": ["pytest", "cpptest", "test_cmake_build", "test_cross_module_rtti"] + } + ], + "workflowPresets": [ + { + "name": "default", + "displayName": "Default Workflow", + "steps": [ + { "type": "configure", "name": "default" }, + { "type": "build", "name": "default" }, + { "type": "build", "name": "tests" } + ] + }, + { + "name": "venv", + "displayName": "Default Workflow", + "steps": [ + { "type": "configure", "name": "venv" }, + { "type": "build", "name": "venv" }, + { "type": "build", "name": "testsvenv" } + ] + } + ] +} diff --git a/third_party/pybind11/LICENSE b/third_party/pybind11/LICENSE new file mode 100644 index 0000000..e466b0d --- /dev/null +++ b/third_party/pybind11/LICENSE @@ -0,0 +1,29 @@ +Copyright (c) 2016 Wenzel Jakob , All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +Please also refer to the file .github/CONTRIBUTING.md, which clarifies licensing of +external contributions to this project including patches, pull requests, etc. diff --git a/third_party/pybind11/README.rst b/third_party/pybind11/README.rst new file mode 100644 index 0000000..f30fd61 --- /dev/null +++ b/third_party/pybind11/README.rst @@ -0,0 +1,216 @@ +.. figure:: https://github.com/pybind/pybind11/raw/master/docs/pybind11-logo.png + :alt: pybind11 logo + +**pybind11 (v3) — Seamless interoperability between C++ and Python** + +|Latest Documentation Status| |Stable Documentation Status| |Gitter chat| |GitHub Discussions| + +|CI| |Build status| |SPEC 4 — Using and Creating Nightly Wheels| + +|Repology| |PyPI package| |Conda-forge| |Python Versions| + +`Setuptools example `_ +• `Scikit-build example `_ +• `CMake example `_ + +.. start + + +**pybind11** is a lightweight header-only library that exposes C++ types +in Python and vice versa, mainly to create Python bindings of existing +C++ code. Its goals and syntax are similar to the excellent +`Boost.Python `_ +library by David Abrahams: to minimize boilerplate code in traditional +extension modules by inferring type information using compile-time +introspection. + +The main issue with Boost.Python—and the reason for creating such a +similar project—is Boost. Boost is an enormously large and complex suite +of utility libraries that works with almost every C++ compiler in +existence. This compatibility has its cost: arcane template tricks and +workarounds are necessary to support the oldest and buggiest of compiler +specimens. Now that C++11-compatible compilers are widely available, +this heavy machinery has become an excessively large and unnecessary +dependency. + +Think of this library as a tiny self-contained version of Boost.Python +with everything stripped away that isn't relevant for binding +generation. Without comments, the core header files only require ~4K +lines of code and depend on Python (CPython 3.8+, PyPy, or GraalPy) and the C++ +standard library. This compact implementation was possible thanks to some C++11 +language features (specifically: tuples, lambda functions and variadic +templates). Since its creation, this library has grown beyond Boost.Python in +many ways, leading to dramatically simpler binding code in many common +situations. + +Tutorial and reference documentation is provided at +`pybind11.readthedocs.io `_. +A PDF version of the manual is available +`here `_. +And the source code is always available at +`github.com/pybind/pybind11 `_. + + +Core features +------------- + + +pybind11 can map the following core C++ features to Python: + +- Functions accepting and returning custom data structures per value, + reference, or pointer +- Instance methods and static methods +- Overloaded functions +- Instance attributes and static attributes +- Arbitrary exception types +- Enumerations +- Callbacks +- Iterators and ranges +- Custom operators +- Single and multiple inheritance +- STL data structures +- Smart pointers with reference counting like ``std::shared_ptr`` +- Internal references with correct reference counting +- C++ classes with virtual (and pure virtual) methods can be extended + in Python +- Integrated NumPy support (NumPy 2 requires pybind11 2.12+) + +Goodies +------- + +In addition to the core functionality, pybind11 provides some extra +goodies: + +- CPython 3.8+, PyPy3 7.3.17+, and GraalPy 24.1+ are supported with an + implementation-agnostic interface (see older versions for older CPython + and PyPy versions). + +- It is possible to bind C++11 lambda functions with captured + variables. The lambda capture data is stored inside the resulting + Python function object. + +- pybind11 uses C++11 move constructors and move assignment operators + whenever possible to efficiently transfer custom data types. + +- It's easy to expose the internal storage of custom data types through + Pythons' buffer protocols. This is handy e.g. for fast conversion + between C++ matrix classes like Eigen and NumPy without expensive + copy operations. + +- pybind11 can automatically vectorize functions so that they are + transparently applied to all entries of one or more NumPy array + arguments. + +- Python's slice-based access and assignment operations can be + supported with just a few lines of code. + +- Everything is contained in just a few header files; there is no need + to link against any additional libraries. + +- Binaries are generally smaller by a factor of at least 2 compared to + equivalent bindings generated by Boost.Python. A recent pybind11 + conversion of PyRosetta, an enormous Boost.Python binding project, + `reported `_ + a binary size reduction of **5.4x** and compile time reduction by + **5.8x**. + +- Function signatures are precomputed at compile time (using + ``constexpr``), leading to smaller binaries. + +- With little extra effort, C++ types can be pickled and unpickled + similar to regular Python objects. + +Supported compilers +------------------- + +1. Clang/LLVM 3.3 or newer (for Apple Xcode's clang, this is 5.0.0 or + newer) +2. GCC 4.8 or newer +3. Microsoft Visual Studio 2022 or newer (2019 probably works, but was dropped in CI) +4. Intel classic C++ compiler 18 or newer (ICC 20.2 tested in CI) +5. Cygwin/GCC (previously tested on 2.5.1) +6. NVCC (CUDA 11.0 tested in CI) +7. NVIDIA PGI (20.9 tested in CI) + +Supported Platforms +------------------- + +* Windows, Linux, macOS, and iOS +* CPython 3.8+, Pyodide, PyPy, and GraalPy +* C++11, C++14, C++17, C++20, and C++23 + +About +----- + +This project was created by `Wenzel +Jakob `_. Significant features and/or +improvements to the code were contributed by +Jonas Adler, +Lori A. Burns, +Sylvain Corlay, +Eric Cousineau, +Aaron Gokaslan, +Ralf Grosse-Kunstleve, +Trent Houliston, +Axel Huebl, +@hulucc, +Yannick Jadoul, +Sergey Lyskov, +Johan Mabille, +Tomasz Miąsko, +Dean Moldovan, +Ben Pritchard, +Jason Rhinelander, +Boris Schäling, +Pim Schellart, +Henry Schreiner, +Ivan Smirnov, +Dustin Spicuzza, +Boris Staletic, +Ethan Steinberg, +Patrick Stewart, +Ivor Wanders, +and +Xiaofei Wang. + +We thank Google for a generous financial contribution to the continuous +integration infrastructure used by this project. + + +Contributing +~~~~~~~~~~~~ + +See the `contributing +guide `_ +for information on building and contributing to pybind11. + +License +~~~~~~~ + +pybind11 is provided under a BSD-style license that can be found in the +`LICENSE `_ +file. By using, distributing, or contributing to this project, you agree +to the terms and conditions of this license. + +.. |Latest Documentation Status| image:: https://readthedocs.org/projects/pybind11/badge?version=latest + :target: http://pybind11.readthedocs.org/en/latest +.. |Stable Documentation Status| image:: https://img.shields.io/badge/docs-stable-blue.svg + :target: http://pybind11.readthedocs.org/en/stable +.. |Gitter chat| image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg + :target: https://gitter.im/pybind/Lobby +.. |CI| image:: https://github.com/pybind/pybind11/workflows/CI/badge.svg + :target: https://github.com/pybind/pybind11/actions +.. |Build status| image:: https://ci.appveyor.com/api/projects/status/riaj54pn4h08xy40?svg=true + :target: https://ci.appveyor.com/project/wjakob/pybind11 +.. |PyPI package| image:: https://img.shields.io/pypi/v/pybind11.svg + :target: https://pypi.org/project/pybind11/ +.. |Conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/pybind11.svg + :target: https://github.com/conda-forge/pybind11-feedstock +.. |Repology| image:: https://repology.org/badge/latest-versions/python:pybind11.svg + :target: https://repology.org/project/python:pybind11/versions +.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/pybind11.svg + :target: https://pypi.org/project/pybind11/ +.. |GitHub Discussions| image:: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github + :target: https://github.com/pybind/pybind11/discussions +.. |SPEC 4 — Using and Creating Nightly Wheels| image:: https://img.shields.io/badge/SPEC-4-green?labelColor=%23004811&color=%235CA038 + :target: https://scientific-python.org/specs/spec-0004/ diff --git a/third_party/pybind11/SECURITY.md b/third_party/pybind11/SECURITY.md new file mode 100644 index 0000000..3d74611 --- /dev/null +++ b/third_party/pybind11/SECURITY.md @@ -0,0 +1,13 @@ +# Security Policy + +## Supported Versions + +Security updates are applied only to the latest release. + +## Reporting a Vulnerability + +If you have discovered a security vulnerability in this project, please report it privately. **Do not disclose it as a public issue.** This gives us time to work with you to fix the issue before public exposure, reducing the chance that the exploit will be used before a patch is released. + +Please disclose it at [security advisory](https://github.com/pybind/pybind11/security/advisories/new). + +This project is maintained by a team of volunteers on a reasonable-effort basis. As such, please give us at least 90 days to work on a fix before public exposure. diff --git a/third_party/pybind11/docs/Doxyfile b/third_party/pybind11/docs/Doxyfile new file mode 100644 index 0000000..09138db --- /dev/null +++ b/third_party/pybind11/docs/Doxyfile @@ -0,0 +1,21 @@ +PROJECT_NAME = pybind11 +INPUT = ../include/pybind11/ +RECURSIVE = YES + +GENERATE_HTML = NO +GENERATE_LATEX = NO +GENERATE_XML = YES +XML_OUTPUT = .build/doxygenxml +XML_PROGRAMLISTING = YES + +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES +EXPAND_AS_DEFINED = PYBIND11_RUNTIME_EXCEPTION + +ALIASES = "rst=\verbatim embed:rst" +ALIASES += "endrst=\endverbatim" + +QUIET = YES +WARNINGS = YES +WARN_IF_UNDOCUMENTED = NO +PREDEFINED = PYBIND11_NOINLINE diff --git a/third_party/pybind11/docs/_static/css/custom.css b/third_party/pybind11/docs/_static/css/custom.css new file mode 100644 index 0000000..7a49a6a --- /dev/null +++ b/third_party/pybind11/docs/_static/css/custom.css @@ -0,0 +1,3 @@ +.highlight .go { + color: #707070; +} diff --git a/third_party/pybind11/docs/advanced/cast/chrono.rst b/third_party/pybind11/docs/advanced/cast/chrono.rst new file mode 100644 index 0000000..fbd4605 --- /dev/null +++ b/third_party/pybind11/docs/advanced/cast/chrono.rst @@ -0,0 +1,81 @@ +Chrono +====== + +When including the additional header file :file:`pybind11/chrono.h` conversions +from C++11 chrono datatypes to python datetime objects are automatically enabled. +This header also enables conversions of python floats (often from sources such +as ``time.monotonic()``, ``time.perf_counter()`` and ``time.process_time()``) +into durations. + +An overview of clocks in C++11 +------------------------------ + +A point of confusion when using these conversions is the differences between +clocks provided in C++11. There are three clock types defined by the C++11 +standard and users can define their own if needed. Each of these clocks have +different properties and when converting to and from python will give different +results. + +The first clock defined by the standard is ``std::chrono::system_clock``. This +clock measures the current date and time. However, this clock changes with to +updates to the operating system time. For example, if your time is synchronised +with a time server this clock will change. This makes this clock a poor choice +for timing purposes but good for measuring the wall time. + +The second clock defined in the standard is ``std::chrono::steady_clock``. +This clock ticks at a steady rate and is never adjusted. This makes it excellent +for timing purposes, however the value in this clock does not correspond to the +current date and time. Often this clock will be the amount of time your system +has been on, although it does not have to be. This clock will never be the same +clock as the system clock as the system clock can change but steady clocks +cannot. + +The third clock defined in the standard is ``std::chrono::high_resolution_clock``. +This clock is the clock that has the highest resolution out of the clocks in the +system. It is normally a typedef to either the system clock or the steady clock +but can be its own independent clock. This is important as when using these +conversions as the types you get in python for this clock might be different +depending on the system. +If it is a typedef of the system clock, python will get datetime objects, but if +it is a different clock they will be timedelta objects. + +Provided conversions +-------------------- + +.. rubric:: C++ to Python + +- ``std::chrono::system_clock::time_point`` → ``datetime.datetime`` + System clock times are converted to python datetime instances. They are + in the local timezone, but do not have any timezone information attached + to them (they are naive datetime objects). + +- ``std::chrono::duration`` → ``datetime.timedelta`` + Durations are converted to timedeltas, any precision in the duration + greater than microseconds is lost by rounding towards zero. + +- ``std::chrono::[other_clocks]::time_point`` → ``datetime.timedelta`` + Any clock time that is not the system clock is converted to a time delta. + This timedelta measures the time from the clocks epoch to now. + +.. rubric:: Python to C++ + +- ``datetime.datetime`` or ``datetime.date`` or ``datetime.time`` → ``std::chrono::system_clock::time_point`` + Date/time objects are converted into system clock timepoints. Any + timezone information is ignored and the type is treated as a naive + object. + +- ``datetime.timedelta`` → ``std::chrono::duration`` + Time delta are converted into durations with microsecond precision. + +- ``datetime.timedelta`` → ``std::chrono::[other_clocks]::time_point`` + Time deltas that are converted into clock timepoints are treated as + the amount of time from the start of the clocks epoch. + +- ``float`` → ``std::chrono::duration`` + Floats that are passed to C++ as durations be interpreted as a number of + seconds. These will be converted to the duration using ``duration_cast`` + from the float. + +- ``float`` → ``std::chrono::[other_clocks]::time_point`` + Floats that are passed to C++ as time points will be interpreted as the + number of seconds from the start of the clocks epoch. diff --git a/third_party/pybind11/docs/advanced/cast/custom.rst b/third_party/pybind11/docs/advanced/cast/custom.rst new file mode 100644 index 0000000..786192b --- /dev/null +++ b/third_party/pybind11/docs/advanced/cast/custom.rst @@ -0,0 +1,137 @@ +.. _custom_type_caster: + +Custom type casters +=================== + +Some applications may prefer custom type casters that convert between existing +Python types and C++ types, similar to the ``list`` ↔ ``std::vector`` +and ``dict`` ↔ ``std::map`` conversions which are built into pybind11. +Implementing custom type casters is fairly advanced usage. +While it is recommended to use the pybind11 API as much as possible, more complex examples may +require familiarity with the intricacies of the Python C API. +You can refer to the `Python/C API Reference Manual `_ +for more information. + +The following snippets demonstrate how this works for a very simple ``Point2D`` type. +We want this type to be convertible to C++ from Python types implementing the +``Sequence`` protocol and having two elements of type ``float``. +When returned from C++ to Python, it should be converted to a Python ``tuple[float, float]``. +For this type we could provide Python bindings for different arithmetic functions implemented +in C++ (here demonstrated by a simple ``negate`` function). + +.. + PLEASE KEEP THE CODE BLOCKS IN SYNC WITH + tests/test_docs_advanced_cast_custom.cpp + tests/test_docs_advanced_cast_custom.py + Ideally, change the test, run pre-commit (incl. clang-format), + then copy the changed code back here. + Also use TEST_SUBMODULE in tests, but PYBIND11_MODULE in docs. + +.. code-block:: cpp + + namespace user_space { + + struct Point2D { + double x; + double y; + }; + + Point2D negate(const Point2D &point) { return Point2D{-point.x, -point.y}; } + + } // namespace user_space + + +The following Python snippet demonstrates the intended usage of ``negate`` from the Python side: + +.. code-block:: python + + from my_math_module import docs_advanced_cast_custom as m + + point1 = [1.0, -1.0] + point2 = m.negate(point1) + assert point2 == (-1.0, 1.0) + +To register the necessary conversion routines, it is necessary to add an +instantiation of the ``pybind11::detail::type_caster`` template. +Although this is an implementation detail, adding an instantiation of this +type is explicitly allowed. + +.. code-block:: cpp + + namespace pybind11 { + namespace detail { + + template <> + struct type_caster { + // This macro inserts a lot of boilerplate code and sets the type hint. + // `io_name` is used to specify different type hints for arguments and return values. + // The signature of our negate function would then look like: + // `negate(Sequence[float]) -> tuple[float, float]` + PYBIND11_TYPE_CASTER(user_space::Point2D, io_name("Sequence[float]", "tuple[float, float]")); + + // C++ -> Python: convert `Point2D` to `tuple[float, float]`. The second and third arguments + // are used to indicate the return value policy and parent object (for + // return_value_policy::reference_internal) and are often ignored by custom casters. + // The return value should reflect the type hint specified by the second argument of `io_name`. + static handle + cast(const user_space::Point2D &number, return_value_policy /*policy*/, handle /*parent*/) { + return py::make_tuple(number.x, number.y).release(); + } + + // Python -> C++: convert a `PyObject` into a `Point2D` and return false upon failure. The + // second argument indicates whether implicit conversions should be allowed. + // The accepted types should reflect the type hint specified by the first argument of + // `io_name`. + bool load(handle src, bool /*convert*/) { + // Check if handle is a Sequence + if (!py::isinstance(src)) { + return false; + } + auto seq = py::reinterpret_borrow(src); + // Check if exactly two values are in the Sequence + if (seq.size() != 2) { + return false; + } + // Check if each element is either a float or an int + for (auto item : seq) { + if (!py::isinstance(item) && !py::isinstance(item)) { + return false; + } + } + value.x = seq[0].cast(); + value.y = seq[1].cast(); + return true; + } + }; + + } // namespace detail + } // namespace pybind11 + + // Bind the negate function + PYBIND11_MODULE(docs_advanced_cast_custom, m, py::mod_gil_not_used()) { m.def("negate", user_space::negate); } + +.. note:: + + A ``type_caster`` defined with ``PYBIND11_TYPE_CASTER(T, ...)`` requires + that ``T`` is default-constructible (``value`` is first default constructed + and then ``load()`` assigns to it). + +.. note:: + For further information on the ``return_value_policy`` argument of ``cast`` refer to :ref:`return_value_policies`. + To learn about the ``convert`` argument of ``load`` see :ref:`nonconverting_arguments`. + +.. warning:: + + When using custom type casters, it's important to declare them consistently + in every compilation unit of the Python extension module to satisfy the C++ One Definition Rule + (`ODR `_). Otherwise, + undefined behavior can ensue. + +.. note:: + + Using the type hint ``Sequence[float]`` signals to static type checkers, that not only tuples may be + passed, but any type implementing the Sequence protocol, e.g., ``list[float]``. + Unfortunately, that loses the length information ``tuple[float, float]`` provides. + One way of still providing some length information in type hints is using ``typing.Annotated``, e.g., + ``Annotated[Sequence[float], 2]``, or further add libraries like + `annotated-types `_. diff --git a/third_party/pybind11/docs/advanced/cast/eigen.rst b/third_party/pybind11/docs/advanced/cast/eigen.rst new file mode 100644 index 0000000..894ce97 --- /dev/null +++ b/third_party/pybind11/docs/advanced/cast/eigen.rst @@ -0,0 +1,310 @@ +Eigen +##### + +`Eigen `_ is C++ header-based library for dense and +sparse linear algebra. Due to its popularity and widespread adoption, pybind11 +provides transparent conversion and limited mapping support between Eigen and +Scientific Python linear algebra data types. + +To enable the built-in Eigen support you must include the optional header file +:file:`pybind11/eigen.h`. + +Pass-by-value +============= + +When binding a function with ordinary Eigen dense object arguments (for +example, ``Eigen::MatrixXd``), pybind11 will accept any input value that is +already (or convertible to) a ``numpy.ndarray`` with dimensions compatible with +the Eigen type, copy its values into a temporary Eigen variable of the +appropriate type, then call the function with this temporary variable. + +Sparse matrices are similarly copied to or from +``scipy.sparse.csr_matrix``/``scipy.sparse.csc_matrix`` objects. + +Pass-by-reference +================= + +One major limitation of the above is that every data conversion implicitly +involves a copy, which can be both expensive (for large matrices) and disallows +binding functions that change their (Matrix) arguments. Pybind11 allows you to +work around this by using Eigen's ``Eigen::Ref`` class much as you +would when writing a function taking a generic type in Eigen itself (subject to +some limitations discussed below). + +When calling a bound function accepting a ``Eigen::Ref`` +type, pybind11 will attempt to avoid copying by using an ``Eigen::Map`` object +that maps into the source ``numpy.ndarray`` data: this requires both that the +data types are the same (e.g. ``dtype='float64'`` and ``MatrixType::Scalar`` is +``double``); and that the storage is layout compatible. The latter limitation +is discussed in detail in the section below, and requires careful +consideration: by default, numpy matrices and Eigen matrices are *not* storage +compatible. + +If the numpy matrix cannot be used as is (either because its types differ, e.g. +passing an array of integers to an Eigen parameter requiring doubles, or +because the storage is incompatible), pybind11 makes a temporary copy and +passes the copy instead. + +When a bound function parameter is instead ``Eigen::Ref`` (note the +lack of ``const``), pybind11 will only allow the function to be called if it +can be mapped *and* if the numpy array is writeable (that is +``a.flags.writeable`` is true). Any access (including modification) made to +the passed variable will be transparently carried out directly on the +``numpy.ndarray``. + +This means you can write code such as the following and have it work as +expected: + +.. code-block:: cpp + + void scale_by_2(Eigen::Ref v) { + v *= 2; + } + +Note, however, that you will likely run into limitations due to numpy and +Eigen's difference default storage order for data; see the below section on +:ref:`storage_orders` for details on how to bind code that won't run into such +limitations. + +.. note:: + + Passing by reference is not supported for sparse types. + +Returning values to Python +========================== + +When returning an ordinary dense Eigen matrix type to numpy (e.g. +``Eigen::MatrixXd`` or ``Eigen::RowVectorXf``) pybind11 keeps the matrix and +returns a numpy array that directly references the Eigen matrix: no copy of the +data is performed. The numpy array will have ``array.flags.owndata`` set to +``False`` to indicate that it does not own the data, and the lifetime of the +stored Eigen matrix will be tied to the returned ``array``. + +If you bind a function with a non-reference, ``const`` return type (e.g. +``const Eigen::MatrixXd``), the same thing happens except that pybind11 also +sets the numpy array's ``writeable`` flag to false. + +If you return an lvalue reference or pointer, the usual pybind11 rules apply, +as dictated by the binding function's return value policy (see the +documentation on :ref:`return_value_policies` for full details). That means, +without an explicit return value policy, lvalue references will be copied and +pointers will be managed by pybind11. In order to avoid copying, you should +explicitly specify an appropriate return value policy, as in the following +example: + +.. code-block:: cpp + + class MyClass { + Eigen::MatrixXd big_mat = Eigen::MatrixXd::Zero(10000, 10000); + public: + Eigen::MatrixXd &getMatrix() { return big_mat; } + const Eigen::MatrixXd &viewMatrix() { return big_mat; } + }; + + // Later, in binding code: + py::class_(m, "MyClass") + .def(py::init<>()) + .def("copy_matrix", &MyClass::getMatrix) // Makes a copy! + .def("get_matrix", &MyClass::getMatrix, py::return_value_policy::reference_internal) + .def("view_matrix", &MyClass::viewMatrix, py::return_value_policy::reference_internal) + ; + +.. code-block:: python + + a = MyClass() + m = a.get_matrix() # flags.writeable = True, flags.owndata = False + v = a.view_matrix() # flags.writeable = False, flags.owndata = False + c = a.copy_matrix() # flags.writeable = True, flags.owndata = True + # m[5,6] and v[5,6] refer to the same element, c[5,6] does not. + +Note in this example that ``py::return_value_policy::reference_internal`` is +used to tie the life of the MyClass object to the life of the returned arrays. + +You may also return an ``Eigen::Ref``, ``Eigen::Map`` or other map-like Eigen +object (for example, the return value of ``matrix.block()`` and related +methods) that map into a dense Eigen type. When doing so, the default +behaviour of pybind11 is to simply reference the returned data: you must take +care to ensure that this data remains valid! You may ask pybind11 to +explicitly *copy* such a return value by using the +``py::return_value_policy::copy`` policy when binding the function. You may +also use ``py::return_value_policy::reference_internal`` or a +``py::keep_alive`` to ensure the data stays valid as long as the returned numpy +array does. + +When returning such a reference of map, pybind11 additionally respects the +readonly-status of the returned value, marking the numpy array as non-writeable +if the reference or map was itself read-only. + +.. note:: + + Sparse types are always copied when returned. + +.. _storage_orders: + +Storage orders +============== + +Passing arguments via ``Eigen::Ref`` has some limitations that you must be +aware of in order to effectively pass matrices by reference. First and +foremost is that the default ``Eigen::Ref`` class requires +contiguous storage along columns (for column-major types, the default in Eigen) +or rows if ``MatrixType`` is specifically an ``Eigen::RowMajor`` storage type. +The former, Eigen's default, is incompatible with ``numpy``'s default row-major +storage, and so you will not be able to pass numpy arrays to Eigen by reference +without making one of two changes. + +(Note that this does not apply to vectors (or column or row matrices): for such +types the "row-major" and "column-major" distinction is meaningless). + +The first approach is to change the use of ``Eigen::Ref`` to the +more general ``Eigen::Ref>`` (or similar type with a fully dynamic stride type in the +third template argument). Since this is a rather cumbersome type, pybind11 +provides a ``py::EigenDRef`` type alias for your convenience (along +with EigenDMap for the equivalent Map, and EigenDStride for just the stride +type). + +This type allows Eigen to map into any arbitrary storage order. This is not +the default in Eigen for performance reasons: contiguous storage allows +vectorization that cannot be done when storage is not known to be contiguous at +compile time. The default ``Eigen::Ref`` stride type allows non-contiguous +storage along the outer dimension (that is, the rows of a column-major matrix +or columns of a row-major matrix), but not along the inner dimension. + +This type, however, has the added benefit of also being able to map numpy array +slices. For example, the following (contrived) example uses Eigen with a numpy +slice to multiply by 2 all coefficients that are both on even rows (0, 2, 4, +...) and in columns 2, 5, or 8: + +.. code-block:: cpp + + m.def("scale", [](py::EigenDRef m, double c) { m *= c; }); + +.. code-block:: python + + # a = np.array(...) + scale_by_2(myarray[0::2, 2:9:3]) + +The second approach to avoid copying is more intrusive: rearranging the +underlying data types to not run into the non-contiguous storage problem in the +first place. In particular, that means using matrices with ``Eigen::RowMajor`` +storage, where appropriate, such as: + +.. code-block:: cpp + + using RowMatrixXd = Eigen::Matrix; + // Use RowMatrixXd instead of MatrixXd + +Now bound functions accepting ``Eigen::Ref`` arguments will be +callable with numpy's (default) arrays without involving a copying. + +You can, alternatively, change the storage order that numpy arrays use by +adding the ``order='F'`` option when creating an array: + +.. code-block:: python + + myarray = np.array(source, order="F") + +Such an object will be passable to a bound function accepting an +``Eigen::Ref`` (or similar column-major Eigen type). + +One major caveat with this approach, however, is that it is not entirely as +easy as simply flipping all Eigen or numpy usage from one to the other: some +operations may alter the storage order of a numpy array. For example, ``a2 = +array.transpose()`` results in ``a2`` being a view of ``array`` that references +the same data, but in the opposite storage order! + +While this approach allows fully optimized vectorized calculations in Eigen, it +cannot be used with array slices, unlike the first approach. + +When *returning* a matrix to Python (either a regular matrix, a reference via +``Eigen::Ref<>``, or a map/block into a matrix), no special storage +consideration is required: the created numpy array will have the required +stride that allows numpy to properly interpret the array, whatever its storage +order. + +Failing rather than copying +=========================== + +The default behaviour when binding ``Eigen::Ref`` Eigen +references is to copy matrix values when passed a numpy array that does not +conform to the element type of ``MatrixType`` or does not have a compatible +stride layout. If you want to explicitly avoid copying in such a case, you +should bind arguments using the ``py::arg().noconvert()`` annotation (as +described in the :ref:`nonconverting_arguments` documentation). + +The following example shows an example of arguments that don't allow data +copying to take place: + +.. code-block:: cpp + + // The method and function to be bound: + class MyClass { + // ... + double some_method(const Eigen::Ref &matrix) { /* ... */ } + }; + float some_function(const Eigen::Ref &big, + const Eigen::Ref &small) { + // ... + } + + // The associated binding code: + using namespace pybind11::literals; // for "arg"_a + py::class_(m, "MyClass") + // ... other class definitions + .def("some_method", &MyClass::some_method, py::arg().noconvert()); + + m.def("some_function", &some_function, + "big"_a.noconvert(), // <- Don't allow copying for this arg + "small"_a // <- This one can be copied if needed + ); + +With the above binding code, attempting to call the ``some_method(m)`` +method on a ``MyClass`` object, or attempting to call ``some_function(m, m2)`` +will raise a ``RuntimeError`` rather than making a temporary copy of the array. +It will, however, allow the ``m2`` argument to be copied into a temporary if +necessary. + +Note that explicitly specifying ``.noconvert()`` is not required for *mutable* +Eigen references (e.g. ``Eigen::Ref`` without ``const`` on the +``MatrixXd``): mutable references will never be called with a temporary copy. + +Vectors versus column/row matrices +================================== + +Eigen and numpy have fundamentally different notions of a vector. In Eigen, a +vector is simply a matrix with the number of columns or rows set to 1 at +compile time (for a column vector or row vector, respectively). NumPy, in +contrast, has comparable 2-dimensional 1xN and Nx1 arrays, but *also* has +1-dimensional arrays of size N. + +When passing a 2-dimensional 1xN or Nx1 array to Eigen, the Eigen type must +have matching dimensions: That is, you cannot pass a 2-dimensional Nx1 numpy +array to an Eigen value expecting a row vector, or a 1xN numpy array as a +column vector argument. + +On the other hand, pybind11 allows you to pass 1-dimensional arrays of length N +as Eigen parameters. If the Eigen type can hold a column vector of length N it +will be passed as such a column vector. If not, but the Eigen type constraints +will accept a row vector, it will be passed as a row vector. (The column +vector takes precedence when both are supported, for example, when passing a +1D numpy array to a MatrixXd argument). Note that the type need not be +explicitly a vector: it is permitted to pass a 1D numpy array of size 5 to an +Eigen ``Matrix``: you would end up with a 1x5 Eigen matrix. +Passing the same to an ``Eigen::MatrixXd`` would result in a 5x1 Eigen matrix. + +When returning an Eigen vector to numpy, the conversion is ambiguous: a row +vector of length 4 could be returned as either a 1D array of length 4, or as a +2D array of size 1x4. When encountering such a situation, pybind11 compromises +by considering the returned Eigen type: if it is a compile-time vector--that +is, the type has either the number of rows or columns set to 1 at compile +time--pybind11 converts to a 1D numpy array when returning the value. For +instances that are a vector only at run-time (e.g. ``MatrixXd``, +``Matrix``), pybind11 returns the vector as a 2D array to +numpy. If this isn't want you want, you can use ``array.reshape(...)`` to get +a view of the same data in the desired dimensions. + +.. seealso:: + + The file :file:`tests/test_eigen.cpp` contains a complete example that + shows how to pass Eigen sparse and dense data types in more detail. diff --git a/third_party/pybind11/docs/advanced/cast/functional.rst b/third_party/pybind11/docs/advanced/cast/functional.rst new file mode 100644 index 0000000..c95aa07 --- /dev/null +++ b/third_party/pybind11/docs/advanced/cast/functional.rst @@ -0,0 +1,109 @@ +Functional +########## + +The following features must be enabled by including :file:`pybind11/functional.h`. + + +Callbacks and passing anonymous functions +========================================= + +The C++11 standard brought lambda functions and the generic polymorphic +function wrapper ``std::function<>`` to the C++ programming language, which +enable powerful new ways of working with functions. Lambda functions come in +two flavors: stateless lambda function resemble classic function pointers that +link to an anonymous piece of code, while stateful lambda functions +additionally depend on captured variables that are stored in an anonymous +*lambda closure object*. + +Here is a simple example of a C++ function that takes an arbitrary function +(stateful or stateless) with signature ``int -> int`` as an argument and runs +it with the value 10. + +.. code-block:: cpp + + int func_arg(const std::function &f) { + return f(10); + } + +The example below is more involved: it takes a function of signature ``int -> int`` +and returns another function of the same kind. The return value is a stateful +lambda function, which stores the value ``f`` in the capture object and adds 1 to +its return value upon execution. + +.. code-block:: cpp + + std::function func_ret(const std::function &f) { + return [f](int i) { + return f(i) + 1; + }; + } + +This example demonstrates using python named parameters in C++ callbacks which +requires using ``py::cpp_function`` as a wrapper. Usage is similar to defining +methods of classes: + +.. code-block:: cpp + + py::cpp_function func_cpp() { + return py::cpp_function([](int i) { return i+1; }, + py::arg("number")); + } + +After including the extra header file :file:`pybind11/functional.h`, it is almost +trivial to generate binding code for all of these functions. + +.. code-block:: cpp + + #include + + PYBIND11_MODULE(example, m, py::mod_gil_not_used()) { + m.def("func_arg", &func_arg); + m.def("func_ret", &func_ret); + m.def("func_cpp", &func_cpp); + } + +The following interactive session shows how to call them from Python. + +.. code-block:: pycon + + $ python + >>> import example + >>> def square(i): + ... return i * i + ... + >>> example.func_arg(square) + 100L + >>> square_plus_1 = example.func_ret(square) + >>> square_plus_1(4) + 17L + >>> plus_1 = func_cpp() + >>> plus_1(number=43) + 44L + +.. warning:: + + Keep in mind that passing a function from C++ to Python (or vice versa) + will instantiate a piece of wrapper code that translates function + invocations between the two languages. Naturally, this translation + increases the computational cost of each function call somewhat. A + problematic situation can arise when a function is copied back and forth + between Python and C++ many times in a row, in which case the underlying + wrappers will accumulate correspondingly. The resulting long sequence of + C++ -> Python -> C++ -> ... roundtrips can significantly decrease + performance. + + There is one exception: pybind11 detects case where a stateless function + (i.e. a function pointer or a lambda function without captured variables) + is passed as an argument to another C++ function exposed in Python. In this + case, there is no overhead. Pybind11 will extract the underlying C++ + function pointer from the wrapped function to sidestep a potential C++ -> + Python -> C++ roundtrip. This is demonstrated in :file:`tests/test_callbacks.cpp`. + +.. note:: + + This functionality is very useful when generating bindings for callbacks in + C++ libraries (e.g. GUI libraries, asynchronous networking libraries, etc.). + + The file :file:`tests/test_callbacks.cpp` contains a complete example + that demonstrates how to work with callbacks and anonymous functions in + more detail. diff --git a/third_party/pybind11/docs/advanced/cast/index.rst b/third_party/pybind11/docs/advanced/cast/index.rst new file mode 100644 index 0000000..3ce9ea0 --- /dev/null +++ b/third_party/pybind11/docs/advanced/cast/index.rst @@ -0,0 +1,43 @@ +.. _type-conversions: + +Type conversions +################ + +Apart from enabling cross-language function calls, a fundamental problem +that a binding tool like pybind11 must address is to provide access to +native Python types in C++ and vice versa. There are three fundamentally +different ways to do this—which approach is preferable for a particular type +depends on the situation at hand. + +1. Use a native C++ type everywhere. In this case, the type must be wrapped + using pybind11-generated bindings so that Python can interact with it. + +2. Use a native Python type everywhere. It will need to be wrapped so that + C++ functions can interact with it. + +3. Use a native C++ type on the C++ side and a native Python type on the + Python side. pybind11 refers to this as a *type conversion*. + + Type conversions are the most "natural" option in the sense that native + (non-wrapped) types are used everywhere. The main downside is that a copy + of the data must be made on every Python ↔ C++ transition: this is + needed since the C++ and Python versions of the same type generally won't + have the same memory layout. + + pybind11 can perform many kinds of conversions automatically. An overview + is provided in the table ":ref:`conversion_table`". + +The following subsections discuss the differences between these options in more +detail. The main focus in this section is on type conversions, which represent +the last case of the above list. + +.. toctree:: + :maxdepth: 1 + + overview + strings + stl + functional + chrono + eigen + custom diff --git a/third_party/pybind11/docs/advanced/cast/overview.rst b/third_party/pybind11/docs/advanced/cast/overview.rst new file mode 100644 index 0000000..d5a34ef --- /dev/null +++ b/third_party/pybind11/docs/advanced/cast/overview.rst @@ -0,0 +1,170 @@ +Overview +######## + +.. rubric:: 1. Native type in C++, wrapper in Python + +Exposing a custom C++ type using :class:`py::class_` was covered in detail +in the :doc:`/classes` section. There, the underlying data structure is +always the original C++ class while the :class:`py::class_` wrapper provides +a Python interface. Internally, when an object like this is sent from C++ to +Python, pybind11 will just add the outer wrapper layer over the native C++ +object. Getting it back from Python is just a matter of peeling off the +wrapper. + +.. rubric:: 2. Wrapper in C++, native type in Python + +This is the exact opposite situation. Now, we have a type which is native to +Python, like a ``tuple`` or a ``list``. One way to get this data into C++ is +with the :class:`py::object` family of wrappers. These are explained in more +detail in the :doc:`/advanced/pycpp/object` section. We'll just give a quick +example here: + +.. code-block:: cpp + + void print_list(py::list my_list) { + for (auto item : my_list) + std::cout << item << " "; + } + +.. code-block:: pycon + + >>> print_list([1, 2, 3]) + 1 2 3 + +The Python ``list`` is not converted in any way -- it's just wrapped in a C++ +:class:`py::list` class. At its core it's still a Python object. Copying a +:class:`py::list` will do the usual reference-counting like in Python. +Returning the object to Python will just remove the thin wrapper. + +.. rubric:: 3. Converting between native C++ and Python types + +In the previous two cases we had a native type in one language and a wrapper in +the other. Now, we have native types on both sides and we convert between them. + +.. code-block:: cpp + + void print_vector(const std::vector &v) { + for (auto item : v) + std::cout << item << "\n"; + } + +.. code-block:: pycon + + >>> print_vector([1, 2, 3]) + 1 2 3 + +In this case, pybind11 will construct a new ``std::vector`` and copy each +element from the Python ``list``. The newly constructed object will be passed +to ``print_vector``. The same thing happens in the other direction: a new +``list`` is made to match the value returned from C++. + +Lots of these conversions are supported out of the box, as shown in the table +below. They are very convenient, but keep in mind that these conversions are +fundamentally based on copying data. This is perfectly fine for small immutable +types but it may become quite expensive for large data structures. This can be +avoided by overriding the automatic conversion with a custom wrapper (i.e. the +above-mentioned approach 1). This requires some manual effort and more details +are available in the :ref:`opaque` section. + +.. _conversion_table: + +List of all builtin conversions +------------------------------- + +The following basic data types are supported out of the box (some may require +an additional extension header to be included). To pass other data structures +as arguments and return values, refer to the section on binding :ref:`classes`. + ++------------------------------------+---------------------------+-----------------------------------+ +| Data type | Description | Header file | ++====================================+===========================+===================================+ +| ``int8_t``, ``uint8_t`` | 8-bit integers | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``int16_t``, ``uint16_t`` | 16-bit integers | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``int32_t``, ``uint32_t`` | 32-bit integers | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``int64_t``, ``uint64_t`` | 64-bit integers | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``ssize_t``, ``size_t`` | Platform-dependent size | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``float``, ``double`` | Floating point types | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``bool`` | Two-state Boolean type | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``char`` | Character literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``char16_t`` | UTF-16 character literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``char32_t`` | UTF-32 character literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``wchar_t`` | Wide character literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``const char *`` | UTF-8 string literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``const char16_t *`` | UTF-16 string literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``const char32_t *`` | UTF-32 string literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``const wchar_t *`` | Wide string literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::string`` | STL dynamic UTF-8 string | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::u16string`` | STL dynamic UTF-16 string | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::u32string`` | STL dynamic UTF-32 string | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::wstring`` | STL dynamic wide string | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::string_view``, | STL C++17 string views | :file:`pybind11/pybind11.h` | +| ``std::u16string_view``, etc. | | | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::pair`` | Pair of two custom types | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::tuple<...>`` | Arbitrary tuple of types | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::reference_wrapper<...>`` | Reference type wrapper | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::complex`` | Complex numbers | :file:`pybind11/complex.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::array`` | STL static array | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::vector`` | STL dynamic array | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::deque`` | STL double-ended queue | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::valarray`` | STL value array | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::list`` | STL linked list | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::map`` | STL ordered map | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::unordered_map`` | STL unordered map | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::set`` | STL ordered set | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::unordered_set`` | STL unordered set | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::optional`` | STL optional type (C++17) | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::experimental::optional`` | STL optional type (exp.) | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::variant<...>`` | Type-safe union (C++17) | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::filesystem::path`` | STL path (C++17) [#]_ | :file:`pybind11/stl/filesystem.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::function<...>`` | STL polymorphic function | :file:`pybind11/functional.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::chrono::duration<...>`` | STL time duration | :file:`pybind11/chrono.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``std::chrono::time_point<...>`` | STL date/time | :file:`pybind11/chrono.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``Eigen::Matrix<...>`` | Eigen: dense matrix | :file:`pybind11/eigen.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``Eigen::Map<...>`` | Eigen: mapped memory | :file:`pybind11/eigen.h` | ++------------------------------------+---------------------------+-----------------------------------+ +| ``Eigen::SparseMatrix<...>`` | Eigen: sparse matrix | :file:`pybind11/eigen.h` | ++------------------------------------+---------------------------+-----------------------------------+ + +.. [#] ``std::filesystem::path`` is converted to ``pathlib.Path`` and + can be loaded from ``os.PathLike``, ``str``, and ``bytes``. diff --git a/third_party/pybind11/docs/advanced/cast/stl.rst b/third_party/pybind11/docs/advanced/cast/stl.rst new file mode 100644 index 0000000..1e17bc3 --- /dev/null +++ b/third_party/pybind11/docs/advanced/cast/stl.rst @@ -0,0 +1,249 @@ +STL containers +############## + +Automatic conversion +==================== + +When including the additional header file :file:`pybind11/stl.h`, conversions +between ``std::vector<>``/``std::deque<>``/``std::list<>``/``std::array<>``/``std::valarray<>``, +``std::set<>``/``std::unordered_set<>``, and +``std::map<>``/``std::unordered_map<>`` and the Python ``list``, ``set`` and +``dict`` data structures are automatically enabled. The types ``std::pair<>`` +and ``std::tuple<>`` are already supported out of the box with just the core +:file:`pybind11/pybind11.h` header. + +The major downside of these implicit conversions is that containers must be +converted (i.e. copied) on every Python->C++ and C++->Python transition, which +can have implications on the program semantics and performance. Please read the +next sections for more details and alternative approaches that avoid this. + +.. note:: + + Arbitrary nesting of any of these types is possible. + +.. seealso:: + + The file :file:`tests/test_stl.cpp` contains a complete + example that demonstrates how to pass STL data types in more detail. + +.. _cpp17_container_casters: + +C++17 library containers +======================== + +The :file:`pybind11/stl.h` header also includes support for ``std::optional<>`` +and ``std::variant<>``. These require a C++17 compiler and standard library. +In C++14 mode, ``std::experimental::optional<>`` is supported if available. + +Various versions of these containers also exist for C++11 (e.g. in Boost). +pybind11 provides an easy way to specialize the ``type_caster`` for such +types: + +.. code-block:: cpp + + // `boost::optional` as an example -- can be any `std::optional`-like container + namespace PYBIND11_NAMESPACE { namespace detail { + template + struct type_caster> : optional_caster> {}; + }} + +The above should be placed in a header file and included in all translation units +where automatic conversion is needed. Similarly, a specialization can be provided +for custom variant types: + +.. code-block:: cpp + + // `boost::variant` as an example -- can be any `std::variant`-like container + namespace PYBIND11_NAMESPACE { namespace detail { + template + struct type_caster> : variant_caster> {}; + + // Specifies the function used to visit the variant -- `apply_visitor` instead of `visit` + template <> + struct visit_helper { + template + static auto call(Args &&...args) -> decltype(boost::apply_visitor(args...)) { + return boost::apply_visitor(args...); + } + }; + }} // namespace PYBIND11_NAMESPACE::detail + +The ``visit_helper`` specialization is not required if your ``name::variant`` provides +a ``name::visit()`` function. For any other function name, the specialization must be +included to tell pybind11 how to visit the variant. + +.. warning:: + + When converting a ``variant`` type, pybind11 follows the same rules as when + determining which function overload to call (:ref:`overload_resolution`), and + so the same caveats hold. In particular, the order in which the ``variant``'s + alternatives are listed is important, since pybind11 will try conversions in + this order. This means that, for example, when converting ``variant``, + the ``bool`` variant will never be selected, as any Python ``bool`` is already + an ``int`` and is convertible to a C++ ``int``. Changing the order of alternatives + (and using ``variant``, in this example) provides a solution. + +.. note:: + + pybind11 only supports the modern implementation of ``boost::variant`` + which makes use of variadic templates. This requires Boost 1.56 or newer. + +.. _opaque: + +Making opaque types +=================== + +pybind11 heavily relies on a template matching mechanism to convert parameters +and return values that are constructed from STL data types such as vectors, +linked lists, hash tables, etc. This even works in a recursive manner, for +instance to deal with lists of hash maps of pairs of elementary and custom +types, etc. + +However, a fundamental limitation of this approach is that internal conversions +between Python and C++ types involve a copy operation that prevents +pass-by-reference semantics. What does this mean? + +Suppose we bind the following function + +.. code-block:: cpp + + void append_1(std::vector &v) { + v.push_back(1); + } + +and call it from Python, the following happens: + +.. code-block:: pycon + + >>> v = [5, 6] + >>> append_1(v) + >>> print(v) + [5, 6] + +As you can see, when passing STL data structures by reference, modifications +are not propagated back the Python side. A similar situation arises when +exposing STL data structures using the ``def_readwrite`` or ``def_readonly`` +functions: + +.. code-block:: cpp + + /* ... definition ... */ + + class MyClass { + std::vector contents; + }; + + /* ... binding code ... */ + + py::class_(m, "MyClass") + .def(py::init<>()) + .def_readwrite("contents", &MyClass::contents); + +In this case, properties can be read and written in their entirety. However, an +``append`` operation involving such a list type has no effect: + +.. code-block:: pycon + + >>> m = MyClass() + >>> m.contents = [5, 6] + >>> print(m.contents) + [5, 6] + >>> m.contents.append(7) + >>> print(m.contents) + [5, 6] + +Finally, the involved copy operations can be costly when dealing with very +large lists. To deal with all of the above situations, pybind11 provides a +macro named ``PYBIND11_MAKE_OPAQUE(T)`` that disables the template-based +conversion machinery of types, thus rendering them *opaque*. The contents of +opaque objects are never inspected or extracted, hence they *can* be passed by +reference. For instance, to turn ``std::vector`` into an opaque type, add +the declaration + +.. code-block:: cpp + + PYBIND11_MAKE_OPAQUE(std::vector) + +before any binding code (e.g. invocations to ``class_::def()``, etc.). This +macro must be specified at the top level (and outside of any namespaces), since +it adds a template instantiation of ``type_caster``. If your binding code consists of +multiple compilation units, it must be present in every file (typically via a +common header) preceding any usage of ``std::vector``. Opaque types must +also have a corresponding ``py::class_`` declaration to associate them with a +name in Python, and to define a set of available operations, e.g.: + +.. code-block:: cpp + + py::class_>(m, "IntVector") + .def(py::init<>()) + .def("clear", &std::vector::clear) + .def("pop_back", &std::vector::pop_back) + .def("__len__", [](const std::vector &v) { return v.size(); }) + .def("__iter__", [](std::vector &v) { + return py::make_iterator(v.begin(), v.end()); + }, py::keep_alive<0, 1>()) /* Keep vector alive while iterator is used */ + // .... + +.. seealso:: + + The file :file:`tests/test_opaque_types.cpp` contains a complete + example that demonstrates how to create and expose opaque types using + pybind11 in more detail. + +.. _stl_bind: + +Binding STL containers +====================== + +The ability to expose STL containers as native Python objects is a fairly +common request, hence pybind11 also provides an optional header file named +:file:`pybind11/stl_bind.h` that does exactly this. The mapped containers try +to match the behavior of their native Python counterparts as much as possible. + +The following example showcases usage of :file:`pybind11/stl_bind.h`: + +.. code-block:: cpp + + // Don't forget this + #include + + PYBIND11_MAKE_OPAQUE(std::vector) + PYBIND11_MAKE_OPAQUE(std::map) + + // ... + + // later in binding code: + py::bind_vector>(m, "VectorInt"); + py::bind_map>(m, "MapStringDouble"); + +When binding STL containers pybind11 considers the types of the container's +elements to decide whether the container should be confined to the local module +(via the :ref:`module_local` feature). If the container element types are +anything other than already-bound custom types bound without +``py::module_local()`` the container binding will have ``py::module_local()`` +applied. This includes converting types such as numeric types, strings, Eigen +types; and types that have not yet been bound at the time of the stl container +binding. This module-local binding is designed to avoid potential conflicts +between module bindings (for example, from two separate modules each attempting +to bind ``std::vector`` as a python type). + +It is possible to override this behavior to force a definition to be either +module-local or global. To do so, you can pass the attributes +``py::module_local()`` (to make the binding module-local) or +``py::module_local(false)`` (to make the binding global) into the +``py::bind_vector`` or ``py::bind_map`` arguments: + +.. code-block:: cpp + + py::bind_vector>(m, "VectorInt", py::module_local(false)); + +Note, however, that such a global binding would make it impossible to load this +module at the same time as any other pybind module that also attempts to bind +the same container type (``std::vector`` in the above example). + +See :ref:`module_local` for more details on module-local bindings. + +.. seealso:: + + The file :file:`tests/test_stl_binders.cpp` shows how to use the + convenience STL container wrappers. diff --git a/third_party/pybind11/docs/advanced/cast/strings.rst b/third_party/pybind11/docs/advanced/cast/strings.rst new file mode 100644 index 0000000..271716b --- /dev/null +++ b/third_party/pybind11/docs/advanced/cast/strings.rst @@ -0,0 +1,296 @@ +Strings, bytes and Unicode conversions +###################################### + +Passing Python strings to C++ +============================= + +When a Python ``str`` is passed from Python to a C++ function that accepts +``std::string`` or ``char *`` as arguments, pybind11 will encode the Python +string to UTF-8. All Python ``str`` can be encoded in UTF-8, so this operation +does not fail. + +The C++ language is encoding agnostic. It is the responsibility of the +programmer to track encodings. It's often easiest to simply `use UTF-8 +everywhere `_. + +.. code-block:: c++ + + m.def("utf8_test", + [](const std::string &s) { + cout << "utf-8 is icing on the cake.\n"; + cout << s; + } + ); + m.def("utf8_charptr", + [](const char *s) { + cout << "My favorite food is\n"; + cout << s; + } + ); + +.. code-block:: pycon + + >>> utf8_test("🎂") + utf-8 is icing on the cake. + 🎂 + + >>> utf8_charptr("🍕") + My favorite food is + 🍕 + +.. note:: + + Some terminal emulators do not support UTF-8 or emoji fonts and may not + display the example above correctly. + +The results are the same whether the C++ function accepts arguments by value or +reference, and whether or not ``const`` is used. + +Passing bytes to C++ +-------------------- + +A Python ``bytes`` object will be passed to C++ functions that accept +``std::string`` or ``char*`` *without* conversion. In order to make a function +*only* accept ``bytes`` (and not ``str``), declare it as taking a ``py::bytes`` +argument. + + +Returning C++ strings to Python +=============================== + +When a C++ function returns a ``std::string`` or ``char*`` to a Python caller, +**pybind11 will assume that the string is valid UTF-8** and will decode it to a +native Python ``str``, using the same API as Python uses to perform +``bytes.decode('utf-8')``. If this implicit conversion fails, pybind11 will +raise a ``UnicodeDecodeError``. + +.. code-block:: c++ + + m.def("std_string_return", + []() { + return std::string("This string needs to be UTF-8 encoded"); + } + ); + +.. code-block:: pycon + + >>> isinstance(example.std_string_return(), str) + True + + +Because UTF-8 is inclusive of pure ASCII, there is never any issue with +returning a pure ASCII string to Python. If there is any possibility that the +string is not pure ASCII, it is necessary to ensure the encoding is valid +UTF-8. + +.. warning:: + + Implicit conversion assumes that a returned ``char *`` is null-terminated. + If there is no null terminator a buffer overrun will occur. + +Explicit conversions +-------------------- + +If some C++ code constructs a ``std::string`` that is not a UTF-8 string, one +can perform a explicit conversion and return a ``py::str`` object. Explicit +conversion has the same overhead as implicit conversion. + +.. code-block:: c++ + + // This uses the Python C API to convert Latin-1 to Unicode + m.def("str_output", + []() { + std::string s = "Send your r\xe9sum\xe9 to Alice in HR"; // Latin-1 + py::handle py_s = PyUnicode_DecodeLatin1(s.data(), s.length(), nullptr); + if (!py_s) { + throw py::error_already_set(); + } + return py::reinterpret_steal(py_s); + } + ); + +.. code-block:: pycon + + >>> str_output() + 'Send your résumé to Alice in HR' + +The `Python C API +`_ provides +several built-in codecs. Note that these all return *new* references, so +use :cpp:func:`reinterpret_steal` when converting them to a :cpp:class:`str`. + + +One could also use a third party encoding library such as libiconv to transcode +to UTF-8. + +Return C++ strings without conversion +------------------------------------- + +If the data in a C++ ``std::string`` does not represent text and should be +returned to Python as ``bytes``, then one can return the data as a +``py::bytes`` object. + +.. code-block:: c++ + + m.def("return_bytes", + []() { + std::string s("\xba\xd0\xba\xd0"); // Not valid UTF-8 + return py::bytes(s); // Return the data without transcoding + } + ); + +.. code-block:: pycon + + >>> example.return_bytes() + b'\xba\xd0\xba\xd0' + + +Note the asymmetry: pybind11 will convert ``bytes`` to ``std::string`` without +encoding, but cannot convert ``std::string`` back to ``bytes`` implicitly. + +.. code-block:: c++ + + m.def("asymmetry", + [](std::string s) { // Accepts str or bytes from Python + return s; // Looks harmless, but implicitly converts to str + } + ); + +.. code-block:: pycon + + >>> isinstance(example.asymmetry(b"have some bytes"), str) + True + + >>> example.asymmetry(b"\xba\xd0\xba\xd0") # invalid utf-8 as bytes + UnicodeDecodeError: 'utf-8' codec can't decode byte 0xba in position 0: invalid start byte + + +Wide character strings +====================== + +When a Python ``str`` is passed to a C++ function expecting ``std::wstring``, +``wchar_t*``, ``std::u16string`` or ``std::u32string``, the ``str`` will be +encoded to UTF-16 or UTF-32 depending on how the C++ compiler implements each +type, in the platform's native endianness. When strings of these types are +returned, they are assumed to contain valid UTF-16 or UTF-32, and will be +decoded to Python ``str``. + +.. code-block:: c++ + + #define UNICODE + #include + + m.def("set_window_text", + [](HWND hwnd, std::wstring s) { + // Call SetWindowText with null-terminated UTF-16 string + ::SetWindowText(hwnd, s.c_str()); + } + ); + m.def("get_window_text", + [](HWND hwnd) { + const int buffer_size = ::GetWindowTextLength(hwnd) + 1; + auto buffer = std::make_unique< wchar_t[] >(buffer_size); + + ::GetWindowText(hwnd, buffer.data(), buffer_size); + + std::wstring text(buffer.get()); + + // wstring will be converted to Python str + return text; + } + ); + +Strings in multibyte encodings such as Shift-JIS must transcoded to a +UTF-8/16/32 before being returned to Python. + + +Character literals +================== + +C++ functions that accept character literals as input will receive the first +character of a Python ``str`` as their input. If the string is longer than one +Unicode character, trailing characters will be ignored. + +When a character literal is returned from C++ (such as a ``char`` or a +``wchar_t``), it will be converted to a ``str`` that represents the single +character. + +.. code-block:: c++ + + m.def("pass_char", [](char c) { return c; }); + m.def("pass_wchar", [](wchar_t w) { return w; }); + +.. code-block:: pycon + + >>> example.pass_char("A") + 'A' + +While C++ will cast integers to character types (``char c = 0x65;``), pybind11 +does not convert Python integers to characters implicitly. The Python function +``chr()`` can be used to convert integers to characters. + +.. code-block:: pycon + + >>> example.pass_char(0x65) + TypeError + + >>> example.pass_char(chr(0x65)) + 'A' + +If the desire is to work with an 8-bit integer, use ``int8_t`` or ``uint8_t`` +as the argument type. + +Grapheme clusters +----------------- + +A single grapheme may be represented by two or more Unicode characters. For +example 'é' is usually represented as U+00E9 but can also be expressed as the +combining character sequence U+0065 U+0301 (that is, the letter 'e' followed by +a combining acute accent). The combining character will be lost if the +two-character sequence is passed as an argument, even though it renders as a +single grapheme. + +.. code-block:: pycon + + >>> example.pass_wchar("é") + 'é' + + >>> combining_e_acute = "e" + "\u0301" + + >>> combining_e_acute + 'é' + + >>> combining_e_acute == "é" + False + + >>> example.pass_wchar(combining_e_acute) + 'e' + +Normalizing combining characters before passing the character literal to C++ +may resolve *some* of these issues: + +.. code-block:: pycon + + >>> example.pass_wchar(unicodedata.normalize("NFC", combining_e_acute)) + 'é' + +In some languages (Thai for example), there are `graphemes that cannot be +expressed as a single Unicode code point +`_, so there is +no way to capture them in a C++ character type. + + +C++17 string views +================== + +C++17 string views are automatically supported when compiling in C++17 mode. +They follow the same rules for encoding and decoding as the corresponding STL +string type (for example, a ``std::u16string_view`` argument will be passed +UTF-16-encoded data, and a returned ``std::string_view`` will be decoded as +UTF-8). + +References +========== + +* `The Absolute Minimum Every Software Developer Absolutely, Positively Must Know About Unicode and Character Sets (No Excuses!) `_ +* `C++ - Using STL Strings at Win32 API Boundaries `_ diff --git a/third_party/pybind11/docs/advanced/classes.rst b/third_party/pybind11/docs/advanced/classes.rst new file mode 100644 index 0000000..14bfc0b --- /dev/null +++ b/third_party/pybind11/docs/advanced/classes.rst @@ -0,0 +1,1408 @@ +Classes +####### + +This section presents advanced binding code for classes and it is assumed +that you are already familiar with the basics from :doc:`/classes`. + +.. _overriding_virtuals: + +Overriding virtual functions in Python +====================================== + +Suppose that a C++ class or interface has a virtual function that we'd like +to override from within Python (we'll focus on the class ``Animal``; ``Dog`` is +given as a specific example of how one would do this with traditional C++ +code). + +.. code-block:: cpp + + class Animal { + public: + virtual ~Animal() { } + virtual std::string go(int n_times) = 0; + }; + + class Dog : public Animal { + public: + std::string go(int n_times) override { + std::string result; + for (int i=0; igo(3); + } + +Normally, the binding code for these classes would look as follows: + +.. code-block:: cpp + + PYBIND11_MODULE(example, m, py::mod_gil_not_used()) { + py::class_(m, "Animal") + .def("go", &Animal::go); + + py::class_(m, "Dog") + .def(py::init<>()); + + m.def("call_go", &call_go); + } + +However, these bindings are impossible to extend: ``Animal`` is not +constructible, and we clearly require some kind of "trampoline" that +redirects virtual calls back to Python. + +Defining a new type of ``Animal`` from within Python is possible but requires a +helper class that is defined as follows: + +.. code-block:: cpp + + class PyAnimal : public Animal, public py::trampoline_self_life_support { + public: + /* Inherit the constructors */ + using Animal::Animal; + + /* Trampoline (need one for each virtual function) */ + std::string go(int n_times) override { + PYBIND11_OVERRIDE_PURE( + std::string, /* Return type */ + Animal, /* Parent class */ + go, /* Name of function in C++ (must match Python name) */ + n_times /* Argument(s) */ + ); + } + }; + +The ``py::trampoline_self_life_support`` base class is needed to ensure +that a ``std::unique_ptr`` can safely be passed between Python and C++. To +help you steer clear of notorious pitfalls (e.g. inheritance slicing), +pybind11 enforces that trampoline classes inherit from +``py::trampoline_self_life_support`` if used in in combination with +``py::smart_holder``. + +.. note:: + For completeness, the base class has no effect if a holder other than + ``py::smart_holder`` used, including the default ``std::unique_ptr``. + To avoid confusion, pybind11 will fail to compile bindings that combine + ``py::trampoline_self_life_support`` with a holder other than + ``py::smart_holder``. + + Please think twice, though, before deciding to not use the safer + ``py::smart_holder``. The pitfalls associated with avoiding it are very + real, and the overhead for using it is very likely in the noise. + +The macro :c:macro:`PYBIND11_OVERRIDE_PURE` should be used for pure virtual +functions, and :c:macro:`PYBIND11_OVERRIDE` should be used for functions which have +a default implementation. There are also two alternate macros +:c:macro:`PYBIND11_OVERRIDE_PURE_NAME` and :c:macro:`PYBIND11_OVERRIDE_NAME` which +take a string-valued name argument between the *Parent class* and *Name of the +function* slots, which defines the name of function in Python. This is required +when the C++ and Python versions of the +function have different names, e.g. ``operator()`` vs ``__call__``. + +The binding code also needs a few minor adaptations (highlighted): + +.. code-block:: cpp + :emphasize-lines: 2,3 + + PYBIND11_MODULE(example, m, py::mod_gil_not_used()) { + py::class_(m, "Animal") + .def(py::init<>()) + .def("go", &Animal::go); + + py::class_(m, "Dog") + .def(py::init<>()); + + m.def("call_go", &call_go); + } + +Importantly, pybind11 is made aware of the trampoline helper class by +specifying it as an extra template argument to ``py::class_``. (This can also +be combined with other template arguments such as a custom holder type; the +order of template types does not matter). Following this, we are able to +define a constructor as usual. + +Bindings should be made against the actual class, not the trampoline helper class. + +.. code-block:: cpp + :emphasize-lines: 3 + + py::class_(m, "Animal"); + .def(py::init<>()) + .def("go", &Animal::go); /* <--- DO NOT USE &PyAnimal::go HERE */ + +Note, however, that the above is sufficient for allowing python classes to +extend ``Animal``, but not ``Dog``: see :ref:`virtual_and_inheritance` for the +necessary steps required to providing proper overriding support for inherited +classes. + +The Python session below shows how to override ``Animal::go`` and invoke it via +a virtual method call. + +.. code-block:: pycon + + >>> from example import * + >>> d = Dog() + >>> call_go(d) + 'woof! woof! woof! ' + >>> class Cat(Animal): + ... def go(self, n_times): + ... return "meow! " * n_times + ... + >>> c = Cat() + >>> call_go(c) + 'meow! meow! meow! ' + +If you are defining a custom constructor in a derived Python class, you *must* +ensure that you explicitly call the bound C++ constructor using ``__init__``, +*regardless* of whether it is a default constructor or not. Otherwise, the +memory for the C++ portion of the instance will be left uninitialized, which +will generally leave the C++ instance in an invalid state and cause undefined +behavior if the C++ instance is subsequently used. + +.. versionchanged:: 2.6 + The default pybind11 metaclass will throw a ``TypeError`` when it detects + that ``__init__`` was not called by a derived class. + +Here is an example: + +.. code-block:: python + + class Dachshund(Dog): + def __init__(self, name): + Dog.__init__(self) # Without this, a TypeError is raised. + self.name = name + + def bark(self): + return "yap!" + +Note that a direct ``__init__`` constructor *should be called*, and ``super()`` +should not be used. For simple cases of linear inheritance, ``super()`` +may work, but once you begin mixing Python and C++ multiple inheritance, +things will fall apart due to differences between Python's MRO and C++'s +mechanisms. + +Please take a look at the :ref:`macro_notes` before using this feature. + +.. note:: + + When the overridden type returns a reference or pointer to a type that + pybind11 converts from Python (for example, numeric values, std::string, + and other built-in value-converting types), there are some limitations to + be aware of: + + - because in these cases there is no C++ variable to reference (the value + is stored in the referenced Python variable), pybind11 provides one in + the PYBIND11_OVERRIDE macros (when needed) with static storage duration. + Note that this means that invoking the overridden method on *any* + instance will change the referenced value stored in *all* instances of + that type. + + - Attempts to modify a non-const reference will not have the desired + effect: it will change only the static cache variable, but this change + will not propagate to underlying Python instance, and the change will be + replaced the next time the override is invoked. + +.. warning:: + + The :c:macro:`PYBIND11_OVERRIDE` and accompanying macros used to be called + ``PYBIND11_OVERLOAD`` up until pybind11 v2.5.0, and :func:`get_override` + used to be called ``get_overload``. This naming was corrected and the older + macro and function names may soon be deprecated, in order to reduce + confusion with overloaded functions and methods and ``py::overload_cast`` + (see :ref:`classes`). + +.. seealso:: + + The file :file:`tests/test_virtual_functions.cpp` contains a complete + example that demonstrates how to override virtual functions using pybind11 + in more detail. + +.. _virtual_and_inheritance: + +Combining virtual functions and inheritance +=========================================== + +When combining virtual methods with inheritance, you need to be sure to provide +an override for each method for which you want to allow overrides from derived +python classes. For example, suppose we extend the above ``Animal``/``Dog`` +example as follows: + +.. code-block:: cpp + + class Animal { + public: + virtual std::string go(int n_times) = 0; + virtual std::string name() { return "unknown"; } + }; + class Dog : public Animal { + public: + std::string go(int n_times) override { + std::string result; + for (int i=0; i + class PyAnimal : public AnimalBase, public py::trampoline_self_life_support { + public: + using AnimalBase::AnimalBase; // Inherit constructors + std::string go(int n_times) override { PYBIND11_OVERRIDE_PURE(std::string, AnimalBase, go, n_times); } + std::string name() override { PYBIND11_OVERRIDE(std::string, AnimalBase, name, ); } + }; + template + class PyDog : public PyAnimal, public py::trampoline_self_life_support { + public: + using PyAnimal::PyAnimal; // Inherit constructors + // Override PyAnimal's pure virtual go() with a non-pure one: + std::string go(int n_times) override { PYBIND11_OVERRIDE(std::string, DogBase, go, n_times); } + std::string bark() override { PYBIND11_OVERRIDE(std::string, DogBase, bark, ); } + }; + +This technique has the advantage of requiring just one trampoline method to be +declared per virtual method and pure virtual method override. It does, +however, require the compiler to generate at least as many methods (and +possibly more, if both pure virtual and overridden pure virtual methods are +exposed, as above). + +The classes are then registered with pybind11 using: + +.. code-block:: cpp + + py::class_, py::smart_holder> animal(m, "Animal"); + py::class_, py::smart_holder> dog(m, "Dog"); + py::class_, py::smart_holder> husky(m, "Husky"); + // ... add animal, dog, husky definitions + +Note that ``Husky`` did not require a dedicated trampoline template class at +all, since it neither declares any new virtual methods nor provides any pure +virtual method implementations. + +With either the repeated-virtuals or templated trampoline methods in place, you +can now create a python class that inherits from ``Dog``: + +.. code-block:: python + + class ShihTzu(Dog): + def bark(self): + return "yip!" + +.. seealso:: + + See the file :file:`tests/test_virtual_functions.cpp` for complete examples + using both the duplication and templated trampoline approaches. + +.. _extended_aliases: + +Extended trampoline class functionality +======================================= + +.. _extended_class_functionality_forced_trampoline: + +Forced trampoline class initialisation +-------------------------------------- +The trampoline classes described in the previous sections are, by default, only +initialized when needed. More specifically, they are initialized when a python +class actually inherits from a registered type (instead of merely creating an +instance of the registered type), or when a registered constructor is only +valid for the trampoline class but not the registered class. This is primarily +for performance reasons: when the trampoline class is not needed for anything +except virtual method dispatching, not initializing the trampoline class +improves performance by avoiding needing to do a run-time check to see if the +inheriting python instance has an overridden method. + +Sometimes, however, it is useful to always initialize a trampoline class as an +intermediate class that does more than just handle virtual method dispatching. +For example, such a class might perform extra class initialization, extra +destruction operations, and might define new members and methods to enable a +more python-like interface to a class. + +In order to tell pybind11 that it should *always* initialize the trampoline +class when creating new instances of a type, the class constructors should be +declared using ``py::init_alias()`` instead of the usual +``py::init()``. This forces construction via the trampoline class, +ensuring member initialization and (eventual) destruction. + +.. seealso:: + + See the file :file:`tests/test_virtual_functions.cpp` for complete examples + showing both normal and forced trampoline instantiation. + +Different method signatures +--------------------------- +The macro's introduced in :ref:`overriding_virtuals` cover most of the standard +use cases when exposing C++ classes to Python. Sometimes it is hard or unwieldy +to create a direct one-on-one mapping between the arguments and method return +type. + +An example would be when the C++ signature contains output arguments using +references (See also :ref:`faq_reference_arguments`). Another way of solving +this is to use the method body of the trampoline class to do conversions to the +input and return of the Python method. + +The main building block to do so is the :func:`get_override`, this function +allows retrieving a method implemented in Python from within the trampoline's +methods. Consider for example a C++ method which has the signature +``bool myMethod(int32_t& value)``, where the return indicates whether +something should be done with the ``value``. This can be made convenient on the +Python side by allowing the Python function to return ``None`` or an ``int``: + +.. code-block:: cpp + + bool MyClass::myMethod(int32_t& value) + { + pybind11::gil_scoped_acquire gil; // Acquire the GIL while in this scope. + // Try to look up the overridden method on the Python side. + pybind11::function override = pybind11::get_override(this, "myMethod"); + if (override) { // method is found + auto obj = override(value); // Call the Python function. + if (py::isinstance(obj)) { // check if it returned a Python integer type + value = obj.cast(); // Cast it and assign it to the value. + return true; // Return true; value should be used. + } else { + return false; // Python returned none, return false. + } + } + return false; // Alternatively return MyClass::myMethod(value); + } + +Avoiding Inheritance Slicing and ``std::weak_ptr`` surprises +------------------------------------------------------------ + +When working with classes that use virtual functions and are subclassed +in Python, special care must be taken when converting Python objects to +``std::shared_ptr``. Depending on whether the class uses a plain +``std::shared_ptr`` holder or ``py::smart_holder``, the resulting +``shared_ptr`` may either allow inheritance slicing or lead to potentially +surprising behavior when constructing ``std::weak_ptr`` instances. + +This section explains how ``std::shared_ptr`` and ``py::smart_holder`` manage +object lifetimes differently, how these differences affect trampoline-derived +objects, and what options are available to achieve the situation-specific +desired behavior. + +When using ``std::shared_ptr`` as the holder type, converting a Python object +to a ``std::shared_ptr`` (e.g., ``obj.cast>()``, or simply +passing the Python object as an argument to a ``.def()``-ed function) returns +a ``shared_ptr`` that shares ownership with the original ``class_`` holder, +usually preserving object lifetime. However, for Python classes that derive from +a trampoline, if the Python object is destroyed, only the base C++ object may +remain alive, leading to inheritance slicing +(see `#1333 `_). + +In contrast, with ``py::smart_holder``, converting a Python object to +a ``std::shared_ptr`` returns a new ``shared_ptr`` with an independent +control block that keeps the derived Python object alive. This avoids +inheritance slicing but can lead to unintended behavior when creating +``std::weak_ptr`` instances +(see `#5623 `_). + +If it is necessary to obtain a ``std::weak_ptr`` that shares the control block +with the ``smart_holder``—at the cost of reintroducing potential inheritance +slicing—you can use ``py::potentially_slicing_weak_ptr(obj)``. + +When precise lifetime management of derived Python objects is important, +using a Python-side ``weakref`` is the most reliable approach, as it avoids +both inheritance slicing and unintended interactions with ``std::weak_ptr`` +semantics in C++. + +.. seealso:: + + * :func:`potentially_slicing_weak_ptr` C++ documentation + * :file:`tests/test_potentially_slicing_weak_ptr.cpp` + + +.. _custom_constructors: + +Custom constructors +=================== + +The syntax for binding constructors was previously introduced, but it only +works when a constructor of the appropriate arguments actually exists on the +C++ side. To extend this to more general cases, pybind11 makes it possible +to bind factory functions as constructors. For example, suppose you have a +class like this: + +.. code-block:: cpp + + class Example { + private: + Example(int); // private constructor + public: + // Factory function: + static Example create(int a) { return Example(a); } + }; + + py::class_(m, "Example") + .def(py::init(&Example::create)); + +While it is possible to create a straightforward binding of the static +``create`` method, it may sometimes be preferable to expose it as a constructor +on the Python side. This can be accomplished by calling ``.def(py::init(...))`` +with the function reference returning the new instance passed as an argument. +It is also possible to use this approach to bind a function returning a new +instance by raw pointer or by the holder (e.g. ``std::unique_ptr``). + +The following example shows the different approaches: + +.. code-block:: cpp + + class Example { + private: + Example(int); // private constructor + public: + // Factory function - returned by value: + static Example create(int a) { return Example(a); } + + // These constructors are publicly callable: + Example(double); + Example(int, int); + Example(std::string); + }; + + py::class_(m, "Example") + // Bind the factory function as a constructor: + .def(py::init(&Example::create)) + // Bind a lambda function returning a pointer wrapped in a holder: + .def(py::init([](std::string arg) { + return std::unique_ptr(new Example(arg)); + })) + // Return a raw pointer: + .def(py::init([](int a, int b) { return new Example(a, b); })) + // You can mix the above with regular C++ constructor bindings as well: + .def(py::init()) + ; + +When the constructor is invoked from Python, pybind11 will call the factory +function and store the resulting C++ instance in the Python instance. + +When combining factory functions constructors with :ref:`virtual function +trampolines ` there are two approaches. The first is to +add a constructor to the alias class that takes a base value by +rvalue-reference. If such a constructor is available, it will be used to +construct an alias instance from the value returned by the factory function. +The second option is to provide two factory functions to ``py::init()``: the +first will be invoked when no alias class is required (i.e. when the class is +being used but not inherited from in Python), and the second will be invoked +when an alias is required. + +You can also specify a single factory function that always returns an alias +instance: this will result in behaviour similar to ``py::init_alias<...>()``, +as described in the :ref:`extended trampoline class documentation +`. + +The following example shows the different factory approaches for a class with +an alias: + +.. code-block:: cpp + + #include + class Example { + public: + // ... + virtual ~Example() = default; + }; + class PyExample : public Example, public py::trampoline_self_life_support { + public: + using Example::Example; + PyExample(Example &&base) : Example(std::move(base)) {} + }; + py::class_(m, "Example") + // Returns an Example pointer. If a PyExample is needed, the Example + // instance will be moved via the extra constructor in PyExample, above. + .def(py::init([]() { return new Example(); })) + // Two callbacks: + .def(py::init([]() { return new Example(); } /* no alias needed */, + []() { return new PyExample(); } /* alias needed */)) + // *Always* returns an alias instance (like py::init_alias<>()) + .def(py::init([]() { return new PyExample(); })) + ; + +Brace initialization +-------------------- + +``pybind11::init<>`` internally uses C++11 brace initialization to call the +constructor of the target class. This means that it can be used to bind +*implicit* constructors as well: + +.. code-block:: cpp + + struct Aggregate { + int a; + std::string b; + }; + + py::class_(m, "Aggregate") + .def(py::init()); + +.. note:: + + Note that brace initialization preferentially invokes constructor overloads + taking a ``std::initializer_list``. In the rare event that this causes an + issue, you can work around it by using ``py::init(...)`` with a lambda + function that constructs the new object as desired. + +.. _classes_with_non_public_destructors: + +Non-public destructors +====================== + +If a class has a private or protected destructor (as might e.g. be the case in +a singleton pattern), a compile error will occur when creating bindings via +pybind11. The underlying issue is that the ``std::unique_ptr`` holder type that +is responsible for managing the lifetime of instances will reference the +destructor even if no deallocations ever take place. In order to expose classes +with private or protected destructors, it is possible to override the holder +type via a holder type argument to ``py::class_``. Pybind11 provides a helper +class ``py::nodelete`` that disables any destructor invocations. In this case, +it is crucial that instances are deallocated on the C++ side to avoid memory +leaks. + +.. code-block:: cpp + + /* ... definition ... */ + + class MyClass { + private: + ~MyClass() { } + }; + + /* ... binding code ... */ + + py::class_>(m, "MyClass") + .def(py::init<>()) + +.. _destructors_that_call_python: + +Destructors that call Python +============================ + +If a Python function is invoked from a C++ destructor, an exception may be thrown +of type :class:`error_already_set`. If this error is thrown out of a class destructor, +``std::terminate()`` will be called, terminating the process. Class destructors +must catch all exceptions of type :class:`error_already_set` to discard the Python +exception using :func:`error_already_set::discard_as_unraisable`. + +Every Python function should be treated as *possibly throwing*. When a Python generator +stops yielding items, Python will throw a ``StopIteration`` exception, which can pass +though C++ destructors if the generator's stack frame holds the last reference to C++ +objects. + +For more information, see :ref:`the documentation on exceptions `. + +.. code-block:: cpp + + class MyClass { + public: + ~MyClass() { + try { + py::print("Even printing is dangerous in a destructor"); + py::exec("raise ValueError('This is an unraisable exception')"); + } catch (py::error_already_set &e) { + // error_context should be information about where/why the occurred, + // e.g. use __func__ to get the name of the current function + e.discard_as_unraisable(__func__); + } + } + }; + +.. note:: + + pybind11 does not support C++ destructors marked ``noexcept(false)``. + +.. versionadded:: 2.6 + +.. _implicit_conversions: + +Implicit conversions +==================== + +Suppose that instances of two types ``A`` and ``B`` are used in a project, and +that an ``A`` can easily be converted into an instance of type ``B`` (examples of this +could be a fixed and an arbitrary precision number type). + +.. code-block:: cpp + + py::class_(m, "A") + /// ... members ... + + py::class_(m, "B") + .def(py::init()) + /// ... members ... + + m.def("func", + [](const B &) { /* .... */ } + ); + +To invoke the function ``func`` using a variable ``a`` containing an ``A`` +instance, we'd have to write ``func(B(a))`` in Python. On the other hand, C++ +will automatically apply an implicit type conversion, which makes it possible +to directly write ``func(a)``. + +In this situation (i.e. where ``B`` has a constructor that converts from +``A``), the following statement enables similar implicit conversions on the +Python side: + +.. code-block:: cpp + + py::implicitly_convertible(); + +.. note:: + + Implicit conversions from ``A`` to ``B`` only work when ``B`` is a custom + data type that is exposed to Python via pybind11. + + To prevent runaway recursion, implicit conversions are non-reentrant: an + implicit conversion invoked as part of another implicit conversion of the + same type (i.e. from ``A`` to ``B``) will fail. + +.. _static_properties: + +Static properties +================= + +The section on :ref:`properties` discussed the creation of instance properties +that are implemented in terms of C++ getters and setters. + +Static properties can also be created in a similar way to expose getters and +setters of static class attributes. Note that the implicit ``self`` argument +also exists in this case and is used to pass the Python ``type`` subclass +instance. This parameter will often not be needed by the C++ side, and the +following example illustrates how to instantiate a lambda getter function +that ignores it: + +.. code-block:: cpp + + py::class_(m, "Foo") + .def_property_readonly_static("foo", [](py::object /* self */) { return Foo(); }); + +Operator overloading +==================== + +Suppose that we're given the following ``Vector2`` class with a vector addition +and scalar multiplication operation, all implemented using overloaded operators +in C++. + +.. code-block:: cpp + + class Vector2 { + public: + Vector2(float x, float y) : x(x), y(y) { } + + Vector2 operator+(const Vector2 &v) const { return Vector2(x + v.x, y + v.y); } + Vector2 operator*(float value) const { return Vector2(x * value, y * value); } + Vector2& operator+=(const Vector2 &v) { x += v.x; y += v.y; return *this; } + Vector2& operator*=(float v) { x *= v; y *= v; return *this; } + + friend Vector2 operator*(float f, const Vector2 &v) { + return Vector2(f * v.x, f * v.y); + } + + std::string toString() const { + return "[" + std::to_string(x) + ", " + std::to_string(y) + "]"; + } + private: + float x, y; + }; + +The following snippet shows how the above operators can be conveniently exposed +to Python. + +.. code-block:: cpp + + #include + + PYBIND11_MODULE(example, m, py::mod_gil_not_used()) { + py::class_(m, "Vector2") + .def(py::init()) + .def(py::self + py::self) + .def(py::self += py::self) + .def(py::self *= float()) + .def(float() * py::self) + .def(py::self * float()) + .def(-py::self) + .def("__repr__", &Vector2::toString); + } + +Note that a line like + +.. code-block:: cpp + + .def(py::self * float()) + +is really just short hand notation for + +.. code-block:: cpp + + .def("__mul__", [](const Vector2 &a, float b) { + return a * b; + }, py::is_operator()) + +This can be useful for exposing additional operators that don't exist on the +C++ side, or to perform other types of customization. The ``py::is_operator`` +flag marker is needed to inform pybind11 that this is an operator, which +returns ``NotImplemented`` when invoked with incompatible arguments rather than +throwing a type error. + +.. note:: + + To use the more convenient ``py::self`` notation, the additional + header file :file:`pybind11/operators.h` must be included. + +.. seealso:: + + The file :file:`tests/test_operator_overloading.cpp` contains a + complete example that demonstrates how to work with overloaded operators in + more detail. + +.. _pickling: + +Pickling support +================ + +Python's ``pickle`` module provides a powerful facility to serialize and +de-serialize a Python object graph into a binary data stream. To pickle and +unpickle C++ classes using pybind11, a ``py::pickle()`` definition must be +provided. Suppose the class in question has the following signature: + +.. code-block:: cpp + + class Pickleable { + public: + Pickleable(const std::string &value) : m_value(value) { } + const std::string &value() const { return m_value; } + + void setExtra(int extra) { m_extra = extra; } + int extra() const { return m_extra; } + private: + std::string m_value; + int m_extra = 0; + }; + +Pickling support in Python is enabled by defining the ``__setstate__`` and +``__getstate__`` methods [#f3]_. For pybind11 classes, use ``py::pickle()`` +to bind these two functions: + +.. code-block:: cpp + + py::class_(m, "Pickleable") + .def(py::init()) + .def("value", &Pickleable::value) + .def("extra", &Pickleable::extra) + .def("setExtra", &Pickleable::setExtra) + .def(py::pickle( + [](const Pickleable &p) { // __getstate__ + /* Return a tuple that fully encodes the state of the object */ + return py::make_tuple(p.value(), p.extra()); + }, + [](py::tuple t) { // __setstate__ + if (t.size() != 2) + throw std::runtime_error("Invalid state!"); + + /* Create a new C++ instance */ + Pickleable p(t[0].cast()); + + /* Assign any additional state */ + p.setExtra(t[1].cast()); + + return p; + } + )); + +The ``__setstate__`` part of the ``py::pickle()`` definition follows the same +rules as the single-argument version of ``py::init()``. The return type can be +a value, pointer or holder type. See :ref:`custom_constructors` for details. + +An instance can now be pickled as follows: + +.. code-block:: python + + import pickle + + p = Pickleable("test_value") + p.setExtra(15) + data = pickle.dumps(p) + + +.. note:: + If given, the second argument to ``dumps`` must be 2 or larger - 0 and 1 are + not supported. Newer versions are also fine; for instance, specify ``-1`` to + always use the latest available version. Beware: failure to follow these + instructions will cause important pybind11 memory allocation routines to be + skipped during unpickling, which will likely lead to memory corruption + and/or segmentation faults. + +.. seealso:: + + The file :file:`tests/test_pickling.cpp` contains a complete example + that demonstrates how to pickle and unpickle types using pybind11 in more + detail. + +.. [#f3] http://docs.python.org/3/library/pickle.html#pickling-class-instances + +Deepcopy support +================ + +Python normally uses references in assignments. Sometimes a real copy is needed +to prevent changing all copies. The ``copy`` module [#f5]_ provides these +capabilities. + +A class with pickle support is automatically also (deep)copy +compatible. However, performance can be improved by adding custom +``__copy__`` and ``__deepcopy__`` methods. + +For simple classes (deep)copy can be enabled by using the copy constructor, +which should look as follows: + +.. code-block:: cpp + + py::class_(m, "Copyable") + .def("__copy__", [](const Copyable &self) { + return Copyable(self); + }) + .def("__deepcopy__", [](const Copyable &self, py::dict) { + return Copyable(self); + }, "memo"_a); + +.. note:: + + Dynamic attributes will not be copied in this example. + +.. [#f5] https://docs.python.org/3/library/copy.html + +Multiple Inheritance +==================== + +pybind11 can create bindings for types that derive from multiple base types +(aka. *multiple inheritance*). To do so, specify all bases in the template +arguments of the ``py::class_`` declaration: + +.. code-block:: cpp + + py::class_(m, "MyType") + ... + +The base types can be specified in arbitrary order, and they can even be +interspersed with alias types and holder types (discussed earlier in this +document)---pybind11 will automatically find out which is which. The only +requirement is that the first template argument is the type to be declared. + +It is also permitted to inherit multiply from exported C++ classes in Python, +as well as inheriting from multiple Python and/or pybind11-exported classes. + +There is one caveat regarding the implementation of this feature: + +When only one base type is specified for a C++ type that actually has multiple +bases, pybind11 will assume that it does not participate in multiple +inheritance, which can lead to undefined behavior. In such cases, add the tag +``multiple_inheritance`` to the class constructor: + +.. code-block:: cpp + + py::class_(m, "MyType", py::multiple_inheritance()); + +The tag is redundant and does not need to be specified when multiple base types +are listed. + +.. _module_local: + +Module-local class bindings +=========================== + +When creating a binding for a class, pybind11 by default makes that binding +"global" across modules. What this means is that a type defined in one module +can be returned from any module resulting in the same Python type. For +example, this allows the following: + +.. code-block:: cpp + + // In the module1.cpp binding code for module1: + py::class_(m, "Pet") + .def(py::init()) + .def_readonly("name", &Pet::name); + +.. code-block:: cpp + + // In the module2.cpp binding code for module2: + m.def("create_pet", [](std::string name) { return new Pet(name); }); + +.. code-block:: pycon + + >>> from module1 import Pet + >>> from module2 import create_pet + >>> pet1 = Pet("Kitty") + >>> pet2 = create_pet("Doggy") + >>> pet2.name() + 'Doggy' + +When writing binding code for a library, this is usually desirable: this +allows, for example, splitting up a complex library into multiple Python +modules. + +In some cases, however, this can cause conflicts. For example, suppose two +unrelated modules make use of an external C++ library and each provide custom +bindings for one of that library's classes. This will result in an error when +a Python program attempts to import both modules (directly or indirectly) +because of conflicting definitions on the external type: + +.. code-block:: cpp + + // dogs.cpp + + // Binding for external library class: + py::class_(m, "Pet") + .def("name", &pets::Pet::name); + + // Binding for local extension class: + py::class_(m, "Dog") + .def(py::init()); + +.. code-block:: cpp + + // cats.cpp, in a completely separate project from the above dogs.cpp. + + // Binding for external library class: + py::class_(m, "Pet") + .def("get_name", &pets::Pet::name); + + // Binding for local extending class: + py::class_(m, "Cat") + .def(py::init()); + +.. code-block:: pycon + + >>> import cats + >>> import dogs + Traceback (most recent call last): + File "", line 1, in + ImportError: generic_type: type "Pet" is already registered! + +To get around this, you can tell pybind11 to keep the external class binding +localized to the module by passing the ``py::module_local()`` attribute into +the ``py::class_`` constructor: + +.. code-block:: cpp + + // Pet binding in dogs.cpp: + py::class_(m, "Pet", py::module_local()) + .def("name", &pets::Pet::name); + +.. code-block:: cpp + + // Pet binding in cats.cpp: + py::class_(m, "Pet", py::module_local()) + .def("get_name", &pets::Pet::name); + +This makes the Python-side ``dogs.Pet`` and ``cats.Pet`` into distinct classes, +avoiding the conflict and allowing both modules to be loaded. C++ code in the +``dogs`` module that casts or returns a ``Pet`` instance will result in a +``dogs.Pet`` Python instance, while C++ code in the ``cats`` module will result +in a ``cats.Pet`` Python instance. + +This does come with two caveats, however: First, external modules cannot return +or cast a ``Pet`` instance to Python (unless they also provide their own local +bindings). Second, from the Python point of view they are two distinct classes. + +Note that the locality only applies in the C++ -> Python direction. When +passing such a ``py::module_local`` type into a C++ function, the module-local +classes are still considered. This means that if the following function is +added to any module (including but not limited to the ``cats`` and ``dogs`` +modules above) it will be callable with either a ``dogs.Pet`` or ``cats.Pet`` +argument: + +.. code-block:: cpp + + m.def("pet_name", [](const pets::Pet &pet) { return pet.name(); }); + +For example, suppose the above function is added to each of ``cats.cpp``, +``dogs.cpp`` and ``frogs.cpp`` (where ``frogs.cpp`` is some other module that +does *not* bind ``Pets`` at all). + +.. code-block:: pycon + + >>> import cats, dogs, frogs # No error because of the added py::module_local() + >>> mycat, mydog = cats.Cat("Fluffy"), dogs.Dog("Rover") + >>> (cats.pet_name(mycat), dogs.pet_name(mydog)) + ('Fluffy', 'Rover') + >>> (cats.pet_name(mydog), dogs.pet_name(mycat), frogs.pet_name(mycat)) + ('Rover', 'Fluffy', 'Fluffy') + +It is possible to use ``py::module_local()`` registrations in one module even +if another module registers the same type globally: within the module with the +module-local definition, all C++ instances will be cast to the associated bound +Python type. In other modules any such values are converted to the global +Python type created elsewhere. + +.. note:: + + STL bindings (as provided via the optional :file:`pybind11/stl_bind.h` + header) apply ``py::module_local`` by default when the bound type might + conflict with other modules; see :ref:`stl_bind` for details. + +.. note:: + + The localization of the bound types is actually tied to the shared object + or binary generated by the compiler/linker. For typical modules created + with ``PYBIND11_MODULE()``, this distinction is not significant. It is + possible, however, when :ref:`embedding` to embed multiple modules in the + same binary (see :ref:`embedding_modules`). In such a case, the + localization will apply across all embedded modules within the same binary. + +.. seealso:: + + The file :file:`tests/test_local_bindings.cpp` contains additional examples + that demonstrate how ``py::module_local()`` works. + +Binding protected member functions +================================== + +It's normally not possible to expose ``protected`` member functions to Python: + +.. code-block:: cpp + + class A { + protected: + int foo() const { return 42; } + }; + + py::class_(m, "A") + .def("foo", &A::foo); // error: 'foo' is a protected member of 'A' + +On one hand, this is good because non-``public`` members aren't meant to be +accessed from the outside. But we may want to make use of ``protected`` +functions in derived Python classes. + +The following pattern makes this possible: + +.. code-block:: cpp + + class A { + protected: + int foo() const { return 42; } + }; + + class Publicist : public A { // helper type for exposing protected functions + public: + using A::foo; // inherited with different access modifier + }; + + py::class_(m, "A") // bind the primary class + .def("foo", &Publicist::foo); // expose protected methods via the publicist + +This works because ``&Publicist::foo`` is exactly the same function as +``&A::foo`` (same signature and address), just with a different access +modifier. The only purpose of the ``Publicist`` helper class is to make +the function name ``public``. + +If the intent is to expose ``protected`` ``virtual`` functions which can be +overridden in Python, the publicist pattern can be combined with the previously +described trampoline: + +.. code-block:: cpp + + class A { + public: + virtual ~A() = default; + + protected: + virtual int foo() const { return 42; } + }; + + class Trampoline : public A, public py::trampoline_self_life_support { + public: + int foo() const override { PYBIND11_OVERRIDE(int, A, foo, ); } + }; + + class Publicist : public A { + public: + using A::foo; + }; + + py::class_(m, "A") // <-- `Trampoline` here + .def("foo", &Publicist::foo); // <-- `Publicist` here, not `Trampoline`! + +Binding final classes +===================== + +Some classes may not be appropriate to inherit from. In C++11, classes can +use the ``final`` specifier to ensure that a class cannot be inherited from. +The ``py::is_final`` attribute can be used to ensure that Python classes +cannot inherit from a specified type. The underlying C++ type does not need +to be declared final. + +.. code-block:: cpp + + class IsFinal final {}; + + py::class_(m, "IsFinal", py::is_final()); + +When you try to inherit from such a class in Python, you will now get this +error: + +.. code-block:: pycon + + >>> class PyFinalChild(IsFinal): + ... pass + ... + TypeError: type 'IsFinal' is not an acceptable base type + +.. note:: This attribute is currently ignored on PyPy + +.. versionadded:: 2.6 + +Binding classes with template parameters +======================================== + +pybind11 can also wrap classes that have template parameters. Consider these classes: + +.. code-block:: cpp + + struct Cat {}; + struct Dog {}; + + template + struct Cage { + Cage(PetType& pet); + PetType& get(); + }; + +C++ templates may only be instantiated at compile time, so pybind11 can only +wrap instantiated templated classes. You cannot wrap a non-instantiated template: + +.. code-block:: cpp + + // BROKEN (this will not compile) + py::class_(m, "Cage"); + .def("get", &Cage::get); + +You must explicitly specify each template/type combination that you want to +wrap separately. + +.. code-block:: cpp + + // ok + py::class_>(m, "CatCage") + .def("get", &Cage::get); + + // ok + py::class_>(m, "DogCage") + .def("get", &Cage::get); + +If your class methods have template parameters you can wrap those as well, +but once again each instantiation must be explicitly specified: + +.. code-block:: cpp + + typename + struct MyClass { + template + T fn(V v); + }; + + py::class_>(m, "MyClassT") + .def("fn", &MyClass::fn); + +Custom automatic downcasters +============================ + +As explained in :ref:`inheritance`, pybind11 comes with built-in +understanding of the dynamic type of polymorphic objects in C++; that +is, returning a Pet to Python produces a Python object that knows it's +wrapping a Dog, if Pet has virtual methods and pybind11 knows about +Dog and this Pet is in fact a Dog. Sometimes, you might want to +provide this automatic downcasting behavior when creating bindings for +a class hierarchy that does not use standard C++ polymorphism, such as +LLVM [#f4]_. As long as there's some way to determine at runtime +whether a downcast is safe, you can proceed by specializing the +``pybind11::polymorphic_type_hook`` template: + +.. code-block:: cpp + + enum class PetKind { Cat, Dog, Zebra }; + struct Pet { // Not polymorphic: has no virtual methods + const PetKind kind; + int age = 0; + protected: + Pet(PetKind _kind) : kind(_kind) {} + }; + struct Dog : Pet { + Dog() : Pet(PetKind::Dog) {} + std::string sound = "woof!"; + std::string bark() const { return sound; } + }; + + namespace PYBIND11_NAMESPACE { + template<> struct polymorphic_type_hook { + static const void *get(const Pet *src, const std::type_info*& type) { + // note that src may be nullptr + if (src && src->kind == PetKind::Dog) { + type = &typeid(Dog); + return static_cast(src); + } + return src; + } + }; + } // namespace PYBIND11_NAMESPACE + +When pybind11 wants to convert a C++ pointer of type ``Base*`` to a +Python object, it calls ``polymorphic_type_hook::get()`` to +determine if a downcast is possible. The ``get()`` function should use +whatever runtime information is available to determine if its ``src`` +parameter is in fact an instance of some class ``Derived`` that +inherits from ``Base``. If it finds such a ``Derived``, it sets ``type += &typeid(Derived)`` and returns a pointer to the ``Derived`` object +that contains ``src``. Otherwise, it just returns ``src``, leaving +``type`` at its default value of nullptr. If you set ``type`` to a +type that pybind11 doesn't know about, no downcasting will occur, and +the original ``src`` pointer will be used with its static type +``Base*``. + +It is critical that the returned pointer and ``type`` argument of +``get()`` agree with each other: if ``type`` is set to something +non-null, the returned pointer must point to the start of an object +whose type is ``type``. If the hierarchy being exposed uses only +single inheritance, a simple ``return src;`` will achieve this just +fine, but in the general case, you must cast ``src`` to the +appropriate derived-class pointer (e.g. using +``static_cast(src)``) before allowing it to be returned as a +``void*``. + +.. [#f4] https://llvm.org/docs/HowToSetUpLLVMStyleRTTI.html + +.. note:: + + pybind11's standard support for downcasting objects whose types + have virtual methods is implemented using + ``polymorphic_type_hook`` too, using the standard C++ ability to + determine the most-derived type of a polymorphic object using + ``typeid()`` and to cast a base pointer to that most-derived type + (even if you don't know what it is) using ``dynamic_cast``. + +.. seealso:: + + The file :file:`tests/test_tagbased_polymorphic.cpp` contains a + more complete example, including a demonstration of how to provide + automatic downcasting for an entire class hierarchy without + writing one get() function for each class. + +Accessing the type object +========================= + +You can get the type object from a C++ class that has already been registered using: + +.. code-block:: cpp + + py::type T_py = py::type::of(); + +You can directly use ``py::type::of(ob)`` to get the type object from any python +object, just like ``type(ob)`` in Python. + +.. note:: + + Other types, like ``py::type::of()``, do not work, see :ref:`type-conversions`. + +.. versionadded:: 2.6 + +Custom type setup +================= + +For advanced use cases, such as enabling garbage collection support, you may +wish to directly manipulate the ``PyHeapTypeObject`` corresponding to a +``py::class_`` definition. + +You can do that using ``py::custom_type_setup``: + +.. code-block:: cpp + + struct OwnsPythonObjects { + py::object value = py::none(); + }; + py::class_ cls( + m, "OwnsPythonObjects", py::custom_type_setup([](PyHeapTypeObject *heap_type) { + auto *type = &heap_type->ht_type; + type->tp_flags |= Py_TPFLAGS_HAVE_GC; + type->tp_traverse = [](PyObject *self_base, visitproc visit, void *arg) { + // https://docs.python.org/3/c-api/typeobj.html#c.PyTypeObject.tp_traverse + #if PY_VERSION_HEX >= 0x03090000 + Py_VISIT(Py_TYPE(self_base)); + #endif + if (py::detail::is_holder_constructed(self_base)) { + auto &self = py::cast(py::handle(self_base)); + Py_VISIT(self.value.ptr()); + } + return 0; + }; + type->tp_clear = [](PyObject *self_base) { + if (py::detail::is_holder_constructed(self_base)) { + auto &self = py::cast(py::handle(self_base)); + self.value = py::none(); + } + return 0; + }; + })); + cls.def(py::init<>()); + cls.def_readwrite("value", &OwnsPythonObjects::value); + +.. versionadded:: 2.8 diff --git a/third_party/pybind11/docs/advanced/deadlock.md b/third_party/pybind11/docs/advanced/deadlock.md new file mode 100644 index 0000000..f1bab5b --- /dev/null +++ b/third_party/pybind11/docs/advanced/deadlock.md @@ -0,0 +1,391 @@ +# Double locking, deadlocking, GIL + +[TOC] + +## Introduction + +### Overview + +In concurrent programming with locks, *deadlocks* can arise when more than one +mutex is locked at the same time, and careful attention has to be paid to lock +ordering to avoid this. Here we will look at a common situation that occurs in +native extensions for CPython written in C++. + +### Deadlocks + +A deadlock can occur when more than one thread attempts to lock more than one +mutex, and two of the threads lock two of the mutexes in different orders. For +example, consider mutexes `mu1` and `mu2`, and threads T1 and T2, executing: + +| | T1 | T2 | +|--- | ------------------- | -------------------| +|1 | `mu1.lock()`{.good} | `mu2.lock()`{.good}| +|2 | `mu2.lock()`{.bad} | `mu1.lock()`{.bad} | +|3 | `/* work */` | `/* work */` | +|4 | `mu2.unlock()` | `mu1.unlock()` | +|5 | `mu1.unlock()` | `mu2.unlock()` | + +Now if T1 manages to lock `mu1` and T2 manages to lock `mu2` (as indicated in +green), then both threads will block while trying to lock the respective other +mutex (as indicated in red), but they are also unable to release the mutex that +they have locked (step 5). + +**The problem** is that it is possible for one thread to attempt to lock `mu1` +and then `mu2`, and for another thread to attempt to lock `mu2` and then `mu1`. +Note that it does not matter if either mutex is unlocked at any intermediate +point; what matters is only the order of any attempt to *lock* the mutexes. For +example, the following, more complex series of operations is just as prone to +deadlock: + +| | T1 | T2 | +|--- | ------------------- | -------------------| +|1 | `mu1.lock()`{.good} | `mu1.lock()`{.good}| +|2 | waiting for T2 | `mu2.lock()`{.good}| +|3 | waiting for T2 | `/* work */` | +|3 | waiting for T2 | `mu1.unlock()` | +|3 | `mu2.lock()`{.bad} | `/* work */` | +|3 | `/* work */` | `mu1.lock()`{.bad} | +|3 | `/* work */` | `/* work */` | +|4 | `mu2.unlock()` | `mu1.unlock()` | +|5 | `mu1.unlock()` | `mu2.unlock()` | + +When the mutexes involved in a locking sequence are known at compile-time, then +avoiding deadlocks is “merely” a matter of arranging the lock +operations carefully so as to only occur in one single, fixed order. However, it +is also possible for mutexes to only be determined at runtime. A typical example +of this is a database where each row has its own mutex. An operation that +modifies two rows in a single transaction (e.g. “transferring an amount +from one account to another”) must lock two row mutexes, but the locking +order cannot be established at compile time. In this case, a dynamic +“deadlock avoidance algorithm” is needed. (In C++, `std::lock` +provides such an algorithm. An algorithm might use a non-blocking `try_lock` +operation on a mutex, which can either succeed or fail to lock the mutex, but +returns without blocking.) + +Conceptually, one could also consider it a deadlock if _the same_ thread +attempts to lock a mutex that it has already locked (e.g. when some locked +operation accidentally recurses into itself): `mu.lock();`{.good} +`mu.lock();`{.bad} However, this is a slightly separate issue: Typical mutexes +are either of _recursive_ or _non-recursive_ kind. A recursive mutex allows +repeated locking and requires balanced unlocking. A non-recursive mutex can be +implemented more efficiently, and/but for efficiency reasons does not actually +guarantee a deadlock on second lock. Instead, the API simply forbids such use, +making it a precondition that the thread not already hold the mutex, with +undefined behaviour on violation. + +### “Once” initialization + +A common programming problem is to have an operation happen precisely once, even +if requested concurrently. While it is clear that we need to track in some +shared state somewhere whether the operation has already happened, it is worth +noting that this state only ever transitions, once, from `false` to `true`. This +is considerably simpler than a general shared state that can change values +arbitrarily. Next, we also need a mechanism for all but one thread to block +until the initialization has completed, which we can provide with a mutex. The +simplest solution just always locks the mutex: + +```c++ +// The "once" mechanism: +constinit absl::Mutex mu(absl::kConstInit); +constinit bool init_done = false; + +// The operation of interest: +void f(); + +void InitOnceNaive() { + absl::MutexLock lock(&mu); + if (!init_done) { + f(); + init_done = true; + } +} +``` + +This works, but the efficiency-minded reader will observe that once the +operation has completed, all future lock contention on the mutex is +unnecessary. This leads to the (in)famous “double-locking” +algorithm, which was historically hard to write correctly. The idea is to check +the boolean *before* locking the mutex, and avoid locking if the operation has +already completed. However, accessing shared state concurrently when at least +one access is a write is prone to causing a data race and needs to be done +according to an appropriate concurrent programming model. In C++ we use atomic +variables: + +```c++ +// The "once" mechanism: +constinit absl::Mutex mu(absl::kConstInit); +constinit std::atomic init_done = false; + +// The operation of interest: +void f(); + +void InitOnceWithFastPath() { + if (!init_done.load(std::memory_order_acquire)) { + absl::MutexLock lock(&mu); + if (!init_done.load(std::memory_order_relaxed)) { + f(); + init_done.store(true, std::memory_order_release); + } + } +} +``` + +Checking the flag now happens without holding the mutex lock, and if the +operation has already completed, we return immediately. After locking the mutex, +we need to check the flag again, since multiple threads can reach this point. + +*Atomic details.* Since the atomic flag variable is accessed concurrently, we +have to think about the memory order of the accesses. There are two separate +cases: The first, outer check outside the mutex lock, and the second, inner +check under the lock. The outer check and the flag update form an +acquire/release pair: *if* the load sees the value `true` (which must have been +written by the store operation), then it also sees everything that happened +before the store, namely the operation `f()`. By contrast, the inner check can +use relaxed memory ordering, since in that case the mutex operations provide the +necessary ordering: if the inner load sees the value `true`, it happened after +the `lock()`, which happened after the `unlock()`, which happened after the +store. + +The C++ standard library, and Abseil, provide a ready-made solution of this +algorithm called `std::call_once`/`absl::call_once`. (The interface is the same, +but the Abseil implementation is possibly better.) + +```c++ +// The "once" mechanism: +constinit absl::once_flag init_flag; + +// The operation of interest: +void f(); + +void InitOnceWithCallOnce() { + absl::call_once(once_flag, f); +} +``` + +Even though conceptually this is performing the same algorithm, this +implementation has some considerable advantages: The `once_flag` type is a small +and trivial, integer-like type and is trivially destructible. Not only does it +take up less space than a mutex, it also generates less code since it does not +have to run a destructor, which would need to be added to the program's global +destructor list. + +The final clou comes with the C++ semantics of a `static` variable declared at +block scope: According to [[stmt.dcl]](https://eel.is/c++draft/stmt.dcl#3): + +> Dynamic initialization of a block variable with static storage duration or +> thread storage duration is performed the first time control passes through its +> declaration; such a variable is considered initialized upon the completion of +> its initialization. [...] If control enters the declaration concurrently while +> the variable is being initialized, the concurrent execution shall wait for +> completion of the initialization. + +This is saying that the initialization of a local, `static` variable precisely +has the “once” semantics that we have been discussing. We can +therefore write the above example as follows: + +```c++ +// The operation of interest: +void f(); + +void InitOnceWithStatic() { + static int unused = (f(), 0); +} +``` + +This approach is by far the simplest and easiest, but the big difference is that +the mutex (or mutex-like object) in this implementation is no longer visible or +in the user’s control. This is perfectly fine if the initializer is +simple, but if the initializer itself attempts to lock any other mutex +(including by initializing another static variable!), then we have no control +over the lock ordering! + +Finally, you may have noticed the `constinit`s around the earlier code. Both +`constinit` and `constexpr` specifiers on a declaration mean that the variable +is *constant-initialized*, which means that no initialization is performed at +runtime (the initial value is already known at compile time). This in turn means +that a static variable guard mutex may not be needed, and static initialization +never blocks. The difference between the two is that a `constexpr`-specified +variable is also `const`, and a variable cannot be `constexpr` if it has a +non-trivial destructor. Such a destructor also means that the guard mutex is +needed after all, since the destructor must be registered to run at exit, +conditionally on initialization having happened. + +## Python, CPython, GIL + +With CPython, a Python program can call into native code. To this end, the +native code registers callback functions with the Python runtime via the CPython +API. In order to ensure that the internal state of the Python runtime remains +consistent, there is a single, shared mutex called the “global interpreter +lock”, or GIL for short. Upon entry of one of the user-provided callback +functions, the GIL is locked (or “held”), so that no other mutations +of the Python runtime state can occur until the native callback returns. + +Many native extensions do not interact with the Python runtime for at least some +part of them, and so it is common for native extensions to _release_ the GIL, do +some work, and then reacquire the GIL before returning. Similarly, when code is +generally not holding the GIL but needs to interact with the runtime briefly, it +will first reacquire the GIL. The GIL is reentrant, and constructions to acquire +and subsequently release the GIL are common, and often don't worry about whether +the GIL is already held. + +If the native code is written in C++ and contains local, `static` variables, +then we are now dealing with at least _two_ mutexes: the static variable guard +mutex, and the GIL from CPython. + +A common problem in such code is an operation with “only once” +semantics that also ends up requiring the GIL to be held at some point. As per +the above description of “once”-style techniques, one might find a +static variable: + +```c++ +// CPython callback, assumes that the GIL is held on entry. +PyObject* InvokeWidget(PyObject* self) { + static PyObject* impl = CreateWidget(); + return PyObject_CallOneArg(impl, self); +} +``` + +This seems reasonable, but bear in mind that there are two mutexes (the "guard +mutex" and "the GIL"), and we must think about the lock order. Otherwise, if the +callback is called from multiple threads, a deadlock may ensue. + +Let us consider what we can see here: On entry, the GIL is already locked, and +we are locking the guard mutex. This is one lock order. Inside the initializer +`CreateWidget`, with both mutexes already locked, the function can freely access +the Python runtime. + +However, it is entirely possible that `CreateWidget` will want to release the +GIL at one point and reacquire it later: + +```c++ +// Assumes that the GIL is held on entry. +// Ensures that the GIL is held on exit. +PyObject* CreateWidget() { + // ... + Py_BEGIN_ALLOW_THREADS // releases GIL + // expensive work, not accessing the Python runtime + Py_END_ALLOW_THREADS // acquires GIL, #! + // ... + return result; +} +``` + +Now we have a second lock order: the guard mutex is locked, and then the GIL is +locked (at `#!`). To see how this deadlocks, consider threads T1 and T2 both +having the runtime attempt to call `InvokeWidget`. T1 locks the GIL and +proceeds, locking the guard mutex and calling `CreateWidget`; T2 is blocked +waiting for the GIL. Then T1 releases the GIL to do “expensive +work”, and T2 awakes and locks the GIL. Now T2 is blocked trying to +acquire the guard mutex, but T1 is blocked reacquiring the GIL (at `#!`). + +In other words: if we want to support “once-called” functions that +can arbitrarily release and reacquire the GIL, as is very common, then the only +lock order that we can ensure is: guard mutex first, GIL second. + +To implement this, we must rewrite our code. Naively, we could always release +the GIL before a `static` variable with blocking initializer: + +```c++ +// CPython callback, assumes that the GIL is held on entry. +PyObject* InvokeWidget(PyObject* self) { + Py_BEGIN_ALLOW_THREADS // releases GIL + static PyObject* impl = CreateWidget(); + Py_END_ALLOW_THREADS // acquires GIL + + return PyObject_CallOneArg(impl, self); +} +``` + +But similar to the `InitOnceNaive` example above, this code cycles the GIL +(possibly descheduling the thread) even when the static variable has already +been initialized. If we want to avoid this, we need to abandon the use of a +static variable, since we do not control the guard mutex well enough. Instead, +we use an operation whose mutex locking is under our control, such as +`call_once`. For example: + +```c++ +// CPython callback, assumes that the GIL is held on entry. +PyObject* InvokeWidget(PyObject* self) { + static constinit PyObject* impl = nullptr; + static constinit std::atomic init_done = false; + static constinit absl::once_flag init_flag; + + if (!init_done.load(std::memory_order_acquire)) { + Py_BEGIN_ALLOW_THREADS // releases GIL + absl::call_once(init_flag, [&]() { + PyGILState_STATE s = PyGILState_Ensure(); // acquires GIL + impl = CreateWidget(); + PyGILState_Release(s); // releases GIL + init_done.store(true, std::memory_order_release); + }); + Py_END_ALLOW_THREADS // acquires GIL + } + + return PyObject_CallOneArg(impl, self); +} +``` + +The lock order is now always guard mutex first, GIL second. Unfortunately we +have to duplicate the “double-checked done flag”, effectively +leading to triple checking, because the flag state inside the `absl::once_flag` +is not accessible to the user. In other words, we cannot ask `init_flag` whether +it has been used yet. + +However, we can perform one last, minor optimisation: since we assume that the +GIL is held on entry, and again when the initializing operation returns, the GIL +actually serializes access to our done flag variable, which therefore does not +need to be atomic. (The difference to the previous, atomic code may be small, +depending on the architecture. For example, on x86-64, acquire/release on a bool +is nearly free ([demo](https://godbolt.org/z/P9vYWf4fE)).) + +```c++ +// CPython callback, assumes that the GIL is held on entry, and indeed anywhere +// directly in this function (i.e. the GIL can be released inside CreateWidget, +// but must be reaqcuired when that call returns). +PyObject* InvokeWidget(PyObject* self) { + static constinit PyObject* impl = nullptr; + static constinit bool init_done = false; // guarded by GIL + static constinit absl::once_flag init_flag; + + if (!init_done) { + Py_BEGIN_ALLOW_THREADS // releases GIL + // (multiple threads may enter here) + absl::call_once(init_flag, [&]() { + // (only one thread enters here) + PyGILState_STATE s = PyGILState_Ensure(); // acquires GIL + impl = CreateWidget(); + init_done = true; // (GIL is held) + PyGILState_Release(s); // releases GIL + }); + + Py_END_ALLOW_THREADS // acquires GIL + } + + return PyObject_CallOneArg(impl, self); +} +``` + +## Debugging tips + +* Build with symbols. +* Ctrl-C sends `SIGINT`, Ctrl-\\ + sends `SIGQUIT`. Both have their uses. +* Useful `gdb` commands: + * `py-bt` prints a Python backtrace if you are in a Python frame. + * `thread apply all bt 10` prints the top-10 frames for each thread. A + full backtrace can be prohibitively expensive, and the top few frames + are often good enough. + * `p PyGILState_Check()` shows whether a thread is holding the GIL. For + all threads, run `thread apply all p PyGILState_Check()` to find out + which thread is holding the GIL. + * The `static` variable guard mutex is accessed with functions like + `cxa_guard_acquire` (though this depends on ABI details and can vary). + The guard mutex itself contains information about which thread is + currently holding it. + +## Links + +* Article on + [double-checked locking](https://preshing.com/20130930/double-checked-locking-is-fixed-in-cpp11/) +* [The Deadlock Empire](https://deadlockempire.github.io/), hands-on exercises + to construct deadlocks diff --git a/third_party/pybind11/docs/advanced/deprecated.rst b/third_party/pybind11/docs/advanced/deprecated.rst new file mode 100644 index 0000000..dc07a77 --- /dev/null +++ b/third_party/pybind11/docs/advanced/deprecated.rst @@ -0,0 +1,179 @@ +.. _deprecated: + +Deprecated +########## + +Support for Python 3.8 is deprecated and will be removed in 3.1. + +Support for C++11 is deprecated and will be removed in a future version. Please +use at least C++14. + +Support for FindPythonLibs (not available in CMake 3.26+ mode) is deprecated +and will be removed in a future version. The default mode is also going to +change to ``"new"`` from ``"compat"`` in the future. + +The following features were deprecated before pybind11 3.0, and may be removed +in minor releases of pybind11 3.x. + +.. list-table:: Deprecated Features + :header-rows: 1 + :widths: 30 15 10 + + * - Feature + - Deprecated Version + - Year + * - ``py::metaclass()`` + - 2.1 + - 2017 + * - ``PYBIND11_PLUGIN`` + - 2.2 + - 2017 + * - ``py::set_error()`` replacing ``operator()`` + - 2.12 + - 2024 + * - ``get_type_overload`` + - 2.6 + - 2020 + * - ``call()`` + - 2.0 + - 2016 + * - ``.str()`` + - ? + - + * - ``.get_type()`` + - 2.6 + - + * - ``==`` and ``!=`` + - 2.2 + - 2017 + * - ``.check()`` + - ? + - + * - ``object(handle, bool)`` + - ? + - + * - ``error_already_set.clear()`` + - 2.2 + - 2017 + * - ``obj.attr(…)`` as ``bool`` + - ? + - + * - ``.contains`` + - ? (maybe 2.4) + - + * - ``py::capsule`` two-argument with destructor + - ? + - + + + +.. _deprecated_enum: + +``py::enum_`` +============= + +This is the original documentation for ``py::enum_``, which is deprecated +because it is not `PEP 435 compatible `_ +(see also `#2332 `_). +Please prefer ``py::native_enum`` (added with pybind11v3) when writing +new bindings. See :ref:`native_enum` for more information. + +Let's suppose that we have an example class that contains internal types +like enumerations, e.g.: + +.. code-block:: cpp + + struct Pet { + enum Kind { + Dog = 0, + Cat + }; + + struct Attributes { + float age = 0; + }; + + Pet(const std::string &name, Kind type) : name(name), type(type) { } + + std::string name; + Kind type; + Attributes attr; + }; + +The binding code for this example looks as follows: + +.. code-block:: cpp + + py::class_ pet(m, "Pet"); + + pet.def(py::init()) + .def_readwrite("name", &Pet::name) + .def_readwrite("type", &Pet::type) + .def_readwrite("attr", &Pet::attr); + + py::enum_(pet, "Kind") + .value("Dog", Pet::Kind::Dog) + .value("Cat", Pet::Kind::Cat) + .export_values(); + + py::class_(pet, "Attributes") + .def(py::init<>()) + .def_readwrite("age", &Pet::Attributes::age); + + +To ensure that the nested types ``Kind`` and ``Attributes`` are created within the scope of ``Pet``, the +``pet`` ``py::class_`` instance must be supplied to the :class:`enum_` and ``py::class_`` +constructor. The :func:`enum_::export_values` function exports the enum entries +into the parent scope, which should be skipped for newer C++11-style strongly +typed enums. + +.. code-block:: pycon + + >>> p = Pet("Lucy", Pet.Cat) + >>> p.type + Kind.Cat + >>> int(p.type) + 1L + +The entries defined by the enumeration type are exposed in the ``__members__`` property: + +.. code-block:: pycon + + >>> Pet.Kind.__members__ + {'Dog': Kind.Dog, 'Cat': Kind.Cat} + +The ``name`` property returns the name of the enum value as a unicode string. + +.. note:: + + It is also possible to use ``str(enum)``, however these accomplish different + goals. The following shows how these two approaches differ. + + .. code-block:: pycon + + >>> p = Pet("Lucy", Pet.Cat) + >>> pet_type = p.type + >>> pet_type + Pet.Cat + >>> str(pet_type) + 'Pet.Cat' + >>> pet_type.name + 'Cat' + +.. note:: + + When the special tag ``py::arithmetic()`` is specified to the ``enum_`` + constructor, pybind11 creates an enumeration that also supports rudimentary + arithmetic and bit-level operations like comparisons, and, or, xor, negation, + etc. + + .. code-block:: cpp + + py::enum_(pet, "Kind", py::arithmetic()) + ... + + By default, these are omitted to conserve space. + +.. warning:: + + Contrary to Python customs, enum values from the wrappers should not be compared using ``is``, but with ``==`` (see `#1177 `_ for background). diff --git a/third_party/pybind11/docs/advanced/embedding.rst b/third_party/pybind11/docs/advanced/embedding.rst new file mode 100644 index 0000000..3ac0579 --- /dev/null +++ b/third_party/pybind11/docs/advanced/embedding.rst @@ -0,0 +1,495 @@ +.. _embedding: + +Embedding the interpreter +######################### + +While pybind11 is mainly focused on extending Python using C++, it's also +possible to do the reverse: embed the Python interpreter into a C++ program. +All of the other documentation pages still apply here, so refer to them for +general pybind11 usage. This section will cover a few extra things required +for embedding. + +Getting started +=============== + +A basic executable with an embedded interpreter can be created with just a few +lines of CMake and the ``pybind11::embed`` target, as shown below. For more +information, see :doc:`/compiling`. + +.. code-block:: cmake + + cmake_minimum_required(VERSION 3.15...4.0) + project(example) + + find_package(pybind11 REQUIRED) # or `add_subdirectory(pybind11)` + + add_executable(example main.cpp) + target_link_libraries(example PRIVATE pybind11::embed) + +The essential structure of the ``main.cpp`` file looks like this: + +.. code-block:: cpp + + #include // everything needed for embedding + namespace py = pybind11; + + int main() { + py::scoped_interpreter guard{}; // start the interpreter and keep it alive + + py::print("Hello, World!"); // use the Python API + } + +The interpreter must be initialized before using any Python API, which includes +all the functions and classes in pybind11. The RAII guard class ``scoped_interpreter`` +takes care of the interpreter lifetime. After the guard is destroyed, the interpreter +shuts down and clears its memory. No Python functions can be called after this. + +Executing Python code +===================== + +There are a few different ways to run Python code. One option is to use ``eval``, +``exec`` or ``eval_file``, as explained in :ref:`eval`. Here is a quick example in +the context of an executable with an embedded interpreter: + +.. code-block:: cpp + + #include + namespace py = pybind11; + + int main() { + py::scoped_interpreter guard{}; + + py::exec(R"( + kwargs = dict(name="World", number=42) + message = "Hello, {name}! The answer is {number}".format(**kwargs) + print(message) + )"); + } + +Alternatively, similar results can be achieved using pybind11's API (see +:doc:`/advanced/pycpp/index` for more details). + +.. code-block:: cpp + + #include + namespace py = pybind11; + using namespace py::literals; + + int main() { + py::scoped_interpreter guard{}; + + auto kwargs = py::dict("name"_a="World", "number"_a=42); + auto message = "Hello, {name}! The answer is {number}"_s.format(**kwargs); + py::print(message); + } + +The two approaches can also be combined: + +.. code-block:: cpp + + #include + #include + + namespace py = pybind11; + using namespace py::literals; + + int main() { + py::scoped_interpreter guard{}; + + auto locals = py::dict("name"_a="World", "number"_a=42); + py::exec(R"( + message = "Hello, {name}! The answer is {number}".format(**locals()) + )", py::globals(), locals); + + auto message = locals["message"].cast(); + std::cout << message; + } + +Importing modules +================= + +Python modules can be imported using ``module_::import()``: + +.. code-block:: cpp + + py::module_ sys = py::module_::import("sys"); + py::print(sys.attr("path")); + +For convenience, the current working directory is included in ``sys.path`` when +embedding the interpreter. This makes it easy to import local Python files: + +.. code-block:: python + + """calc.py located in the working directory""" + + + def add(i, j): + return i + j + + +.. code-block:: cpp + + py::module_ calc = py::module_::import("calc"); + py::object result = calc.attr("add")(1, 2); + int n = result.cast(); + assert(n == 3); + +Modules can be reloaded using ``module_::reload()`` if the source is modified e.g. +by an external process. This can be useful in scenarios where the application +imports a user defined data processing script which needs to be updated after +changes by the user. Note that this function does not reload modules recursively. + +.. _embedding_modules: + +Adding embedded modules +======================= + +Embedded binary modules can be added using the ``PYBIND11_EMBEDDED_MODULE`` macro. +Note that the definition must be placed at global scope. They can be imported +like any other module. + +.. code-block:: cpp + + #include + namespace py = pybind11; + + PYBIND11_EMBEDDED_MODULE(fast_calc, m) { + // `m` is a `py::module_` which is used to bind functions and classes + m.def("add", [](int i, int j) { + return i + j; + }); + } + + int main() { + py::scoped_interpreter guard{}; + + auto fast_calc = py::module_::import("fast_calc"); + auto result = fast_calc.attr("add")(1, 2).cast(); + assert(result == 3); + } + +Unlike extension modules where only a single binary module can be created, on +the embedded side an unlimited number of modules can be added using multiple +``PYBIND11_EMBEDDED_MODULE`` definitions (as long as they have unique names). + +These modules are added to Python's list of builtins, so they can also be +imported in pure Python files loaded by the interpreter. Everything interacts +naturally: + +.. code-block:: python + + """py_module.py located in the working directory""" + import cpp_module + + a = cpp_module.a + b = a + 1 + + +.. code-block:: cpp + + #include + namespace py = pybind11; + + PYBIND11_EMBEDDED_MODULE(cpp_module, m) { + m.attr("a") = 1; + } + + int main() { + py::scoped_interpreter guard{}; + + auto py_module = py::module_::import("py_module"); + + auto locals = py::dict("fmt"_a="{} + {} = {}", **py_module.attr("__dict__")); + assert(locals["a"].cast() == 1); + assert(locals["b"].cast() == 2); + + py::exec(R"( + c = a + b + message = fmt.format(a, b, c) + )", py::globals(), locals); + + assert(locals["c"].cast() == 3); + assert(locals["message"].cast() == "1 + 2 = 3"); + } + +``PYBIND11_EMBEDDED_MODULE`` also accepts +:func:`py::mod_gil_not_used()`, +:func:`py::multiple_interpreters::per_interpreter_gil()`, and +:func:`py::multiple_interpreters::shared_gil()` tags just like ``PYBIND11_MODULE``. +See :ref:`misc_subinterp` and :ref:`misc_free_threading` for more information. + +Interpreter lifetime +==================== + +The Python interpreter shuts down when ``scoped_interpreter`` is destroyed. After +this, creating a new instance will restart the interpreter. Alternatively, the +``initialize_interpreter`` / ``finalize_interpreter`` pair of functions can be used +to directly set the state at any time. + +Modules created with pybind11 can be safely re-initialized after the interpreter +has been restarted. However, this may not apply to third-party extension modules. +The issue is that Python itself cannot completely unload extension modules and +there are several caveats with regard to interpreter restarting. In short, not +all memory may be freed, either due to Python reference cycles or user-created +global data. All the details can be found in the CPython documentation. + +.. warning:: + + Creating two concurrent ``scoped_interpreter`` guards is a fatal error. So is + calling ``initialize_interpreter`` for a second time after the interpreter + has already been initialized. Use :class:`scoped_subinterpreter` to create + a sub-interpreter. See :ref:`subinterp` for important details on sub-interpreters. + + Do not use the raw CPython API functions ``Py_Initialize`` and + ``Py_Finalize`` as these do not properly handle the lifetime of + pybind11's internal data. + + +.. _subinterp: + +Embedding Sub-interpreters +========================== + +A sub-interpreter is a separate interpreter instance which provides a +separate, isolated interpreter environment within the same process as the main +interpreter. Sub-interpreters are created and managed with a separate API from +the main interpreter. Beginning in Python 3.12, sub-interpreters each have +their own Global Interpreter Lock (GIL), which means that running a +sub-interpreter in a separate thread from the main interpreter can achieve true +concurrency. + +pybind11's sub-interpreter API can be found in ``pybind11/subinterpreter.h``. + +pybind11 :class:`subinterpreter` instances can be safely moved and shared between +threads as needed. However, managing multiple threads and the lifetimes of multiple +interpreters and their GILs can be challenging. +Proceed with caution (and lots of testing)! + +The main interpreter must be initialized before creating a sub-interpreter, and +the main interpreter must outlive all sub-interpreters. Sub-interpreters are +managed through a different API than the main interpreter. + +The :class:`subinterpreter` class manages the lifetime of sub-interpreters. +Instances are movable, but not copyable. Default constructing this class does +*not* create a sub-interpreter (it creates an empty holder). To create a +sub-interpreter, call :func:`subinterpreter::create()`. + +.. warning:: + + Sub-interpreter creation acquires (and subsequently releases) the main + interpreter GIL. If another thread holds the main GIL, the function will + block until the main GIL can be acquired. + + Sub-interpreter destruction temporarily activates the sub-interpreter. The + sub-interpreter must not be active (on any threads) at the time the + :class:`subinterpreter` destructor is called. + + Both actions will re-acquire any interpreter's GIL that was held prior to + the call before returning (or return to no active interpreter if none was + active at the time of the call). + +Each sub-interpreter will import a separate copy of each ``PYBIND11_EMBEDDED_MODULE`` +when those modules specify a ``multiple_interpreters`` tag. If a module does not +specify a ``multiple_interpreters`` tag, then Python will report an ``ImportError`` +if it is imported in a sub-interpreter. + +pybind11 also has a :class:`scoped_subinterpreter` class, which creates and +activates a sub-interpreter when it is constructed, and deactivates and deletes +it when it goes out of scope. + +Activating a Sub-interpreter +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Once a sub-interpreter is created, you can "activate" it on a thread (and +acquire its GIL) by creating a :class:`subinterpreter_scoped_activate` +instance and passing it the sub-intepreter to be activated. The function +will acquire the sub-interpreter's GIL and make the sub-interpreter the +current active interpreter on the current thread for the lifetime of the +instance. When the :class:`subinterpreter_scoped_activate` instance goes out +of scope, the sub-interpreter GIL is released and the prior interpreter that +was active on the thread (if any) is reactivated and it's GIL is re-acquired. + +When using ``subinterpreter_scoped_activate``: + +1. If the thread holds any interpreter's GIL: + - That GIL is released +2. The new sub-interpreter's GIL is acquired +3. The new sub-interpreter is made active. +4. When the scope ends: + - The sub-interpreter's GIL is released + - If there was a previous interpreter: + - The old interpreter's GIL is re-acquired + - The old interpreter is made active + - Otherwise, no interpreter is currently active and no GIL is held. + +Example: + +.. code-block:: cpp + + py::initialize_interpreter(); + // Main GIL is held + { + py::subinterpreter sub = py::subinterpreter::create(); + // Main interpreter is still active, main GIL re-acquired + { + py::subinterpreter_scoped_activate guard(sub); + // Sub-interpreter active, thread holds sub's GIL + { + py::subinterpreter_scoped_activate main_guard(py); + // Sub's GIL was automatically released + // Main interpreter active, thread holds main's GIL + } + // Back to sub-interpreter, thread holds sub's GIL again + } + // Main interpreter is active, main's GIL is held + } + + +GIL API for sub-interpreters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:class:`gil_scoped_release` and :class:`gil_scoped_acquire` can be used to +manage the GIL of a sub-interpreter just as they do for the main interpreter. +They both manage the GIL of the currently active interpreter, without the +programmer having to do anything special or different. There is one important +caveat: + +.. note:: + + When no interpreter is active through a + :class:`subinterpreter_scoped_activate` instance (such as on a new thread), + :class:`gil_scoped_acquire` will acquire the **main** GIL and + activate the **main** interpreter. + + +Full Sub-interpreter example +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Here is an example showing how to create and activate sub-interpreters: + +.. code-block:: cpp + + #include + #include + #include + + namespace py = pybind11; + + PYBIND11_EMBEDDED_MODULE(printer, m, py::multiple_interpreters::per_interpreter_gil()) { + m.def("which", [](const std::string& when) { + std::cout << when << "; Current Interpreter is " + << py::subinterpreter::current().id() + << std::endl; + }); + } + + int main() { + py::scoped_interpreter main_interp; + + py::module_::import("printer").attr("which")("First init"); + + { + py::subinterpreter sub = py::subinterpreter::create(); + + py::module_::import("printer").attr("which")("Created sub"); + + { + py::subinterpreter_scoped_activate guard(sub); + try { + py::module_::import("printer").attr("which")("Activated sub"); + } + catch (py::error_already_set &e) { + std::cerr << "EXCEPTION " << e.what() << std::endl; + return 1; + } + } + + py::module_::import("printer").attr("which")("Deactivated sub"); + + { + py::gil_scoped_release nogil; + { + py::subinterpreter_scoped_activate guard(sub); + try { + { + py::subinterpreter_scoped_activate main_guard(py::subinterpreter::main()); + try { + py::module_::import("printer").attr("which")("Main within sub"); + } + catch (py::error_already_set &e) { + std::cerr << "EXCEPTION " << e.what() << std::endl; + return 1; + } + } + py::module_::import("printer").attr("which")("After Main, still within sub"); + } + catch (py::error_already_set &e) { + std::cerr << "EXCEPTION " << e.what() << std::endl; + return 1; + } + } + } + } + + py::module_::import("printer").attr("which")("At end"); + + return 0; + } + +Expected output: + +.. code-block:: text + + First init; Current Interpreter is 0 + Created sub; Current Interpreter is 0 + Activated sub; Current Interpreter is 1 + Deactivated sub; Current Interpreter is 0 + Main within sub; Current Interpreter is 0 + After Main, still within sub; Current Interpreter is 1 + At end; Current Interpreter is 0 + +.. warning:: + + In Python 3.12 sub-interpreters must be destroyed in the same OS thread + that created them. Failure to follow this rule may result in deadlocks + or crashes when destroying the sub-interpreter on the wrong thread. + + This constraint is not present in Python 3.13+. + + +Best Practices for sub-interpreter safety +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +- Never share Python objects across different interpreters. + +- :class:`error_already_set` objects contain a reference to the Python exception type, + and :func:`error_already_set::what()` acquires the GIL. So Python exceptions must + **never** be allowed to propagate past the enclosing + :class:`subinterpreter_scoped_activate` instance! + (So your try/catch should be *just inside* the scope covered by the + :class:`subinterpreter_scoped_activate`.) + +- Avoid global/static state whenever possible. Instead, keep state within each interpreter, + such as within the interpreter state dict, which can be accessed via + ``subinterpreter::current().state_dict()``, or within instance members and tied to + Python objects. + +- Avoid trying to "cache" Python objects in C++ variables across function calls (this is an easy + way to accidentally introduce sub-interpreter bugs). In the code example above, note that we + did not save the result of :func:`module_::import`, in order to avoid accidentally using the + resulting Python object when the wrong interpreter was active. + +- Avoid moving or disarming RAII objects managing GIL and sub-interpreter lifetimes. Doing so can + lead to confusion about lifetimes. (For example, accidentally extending a + :class:`subinterpreter_scoped_activate` past the lifetime of it's :class:`subinterpreter`.) + +- While sub-interpreters each have their own GIL, there can now be multiple independent GILs in one + program so you need to consider the possibility of deadlocks caused by multiple GILs and/or the + interactions of the GIL(s) and your C++ code's own locking. + +- When using multiple threads to run independent sub-interpreters, the independent GILs allow + concurrent calls from different interpreters into the same C++ code from different threads. + So you must still consider the thread safety of your C++ code. Remember, in Python 3.12 + sub-interpreters must be destroyed on the same thread that they were created on. + +- Familiarize yourself with :ref:`misc_concurrency`. diff --git a/third_party/pybind11/docs/advanced/exceptions.rst b/third_party/pybind11/docs/advanced/exceptions.rst new file mode 100644 index 0000000..921b436 --- /dev/null +++ b/third_party/pybind11/docs/advanced/exceptions.rst @@ -0,0 +1,422 @@ +Exceptions +########## + +Built-in C++ to Python exception translation +============================================ + +When Python calls C++ code through pybind11, pybind11 provides a C++ exception handler +that will trap C++ exceptions, translate them to the corresponding Python exception, +and raise them so that Python code can handle them. + +pybind11 defines translations for ``std::exception`` and its standard +subclasses, and several special exception classes that translate to specific +Python exceptions. Note that these are not actually Python exceptions, so they +cannot be examined using the Python C API. Instead, they are pure C++ objects +that pybind11 will translate the corresponding Python exception when they arrive +at its exception handler. + +.. tabularcolumns:: |p{0.5\textwidth}|p{0.45\textwidth}| + ++--------------------------------------+--------------------------------------+ +| Exception thrown by C++ | Translated to Python exception type | ++======================================+======================================+ +| :class:`std::exception` | ``RuntimeError`` | ++--------------------------------------+--------------------------------------+ +| :class:`std::bad_alloc` | ``MemoryError`` | ++--------------------------------------+--------------------------------------+ +| :class:`std::domain_error` | ``ValueError`` | ++--------------------------------------+--------------------------------------+ +| :class:`std::invalid_argument` | ``ValueError`` | ++--------------------------------------+--------------------------------------+ +| :class:`std::length_error` | ``ValueError`` | ++--------------------------------------+--------------------------------------+ +| :class:`std::out_of_range` | ``IndexError`` | ++--------------------------------------+--------------------------------------+ +| :class:`std::range_error` | ``ValueError`` | ++--------------------------------------+--------------------------------------+ +| :class:`std::overflow_error` | ``OverflowError`` | ++--------------------------------------+--------------------------------------+ +| :class:`pybind11::stop_iteration` | ``StopIteration`` (used to implement | +| | custom iterators) | ++--------------------------------------+--------------------------------------+ +| :class:`pybind11::index_error` | ``IndexError`` (used to indicate out | +| | of bounds access in ``__getitem__``, | +| | ``__setitem__``, etc.) | ++--------------------------------------+--------------------------------------+ +| :class:`pybind11::key_error` | ``KeyError`` (used to indicate out | +| | of bounds access in ``__getitem__``, | +| | ``__setitem__`` in dict-like | +| | objects, etc.) | ++--------------------------------------+--------------------------------------+ +| :class:`pybind11::value_error` | ``ValueError`` (used to indicate | +| | wrong value passed in | +| | ``container.remove(...)``) | ++--------------------------------------+--------------------------------------+ +| :class:`pybind11::type_error` | ``TypeError`` | ++--------------------------------------+--------------------------------------+ +| :class:`pybind11::buffer_error` | ``BufferError`` | ++--------------------------------------+--------------------------------------+ +| :class:`pybind11::import_error` | ``ImportError`` | ++--------------------------------------+--------------------------------------+ +| :class:`pybind11::attribute_error` | ``AttributeError`` | ++--------------------------------------+--------------------------------------+ +| Any other exception | ``RuntimeError`` | ++--------------------------------------+--------------------------------------+ + +Exception translation is not bidirectional. That is, *catching* the C++ +exceptions defined above will not trap exceptions that originate from +Python. For that, catch :class:`pybind11::error_already_set`. See :ref:`below +` for further details. + +There is also a special exception :class:`cast_error` that is thrown by +:func:`handle::call` when the input arguments cannot be converted to Python +objects. + +Registering custom translators +============================== + +If the default exception conversion policy described above is insufficient, +pybind11 also provides support for registering custom exception translators. +Similar to pybind11 classes, exception translators can be local to the module +they are defined in or global to the entire python session. To register a simple +exception conversion that translates a C++ exception into a new Python exception +using the C++ exception's ``what()`` method, a helper function is available: + +.. code-block:: cpp + + py::register_exception(module, "PyExp"); + +This call creates a Python exception class with the name ``PyExp`` in the given +module and automatically converts any encountered exceptions of type ``CppExp`` +into Python exceptions of type ``PyExp``. + +A matching function is available for registering a local exception translator: + +.. code-block:: cpp + + py::register_local_exception(module, "PyExp"); + + +It is possible to specify base class for the exception using the third +parameter, a ``handle``: + +.. code-block:: cpp + + py::register_exception(module, "PyExp", PyExc_RuntimeError); + py::register_local_exception(module, "PyExp", PyExc_RuntimeError); + +Then ``PyExp`` can be caught both as ``PyExp`` and ``RuntimeError``. + +The class objects of the built-in Python exceptions are listed in the Python +documentation on `Standard Exceptions `_. +The default base class is ``PyExc_Exception``. + +When more advanced exception translation is needed, the functions +``py::register_exception_translator(translator)`` and +``py::register_local_exception_translator(translator)`` can be used to register +functions that can translate arbitrary exception types (and which may include +additional logic to do so). The functions takes a stateless callable (e.g. a +function pointer or a lambda function without captured variables) with the call +signature ``void(std::exception_ptr)``. + +When a C++ exception is thrown, the registered exception translators are tried +in reverse order of registration (i.e. the last registered translator gets the +first shot at handling the exception). All local translators will be tried +before a global translator is tried. + +Inside the translator, ``std::rethrow_exception`` should be used within +a try block to re-throw the exception. One or more catch clauses to catch +the appropriate exceptions should then be used with each clause using +``py::set_error()`` (see below). + +To declare a custom Python exception type, declare a ``py::exception`` variable +and use this in the associated exception translator (note: it is often useful +to make this a static declaration when using it inside a lambda expression +without requiring capturing). + +The following example demonstrates this for a hypothetical exception classes +``MyCustomException`` and ``OtherException``: the first is translated to a +custom python exception ``MyCustomError``, while the second is translated to a +standard python RuntimeError: + +.. code-block:: cpp + + PYBIND11_CONSTINIT static py::gil_safe_call_once_and_store exc_storage; + exc_storage.call_once_and_store_result( + [&]() { return py::exception(m, "MyCustomError"); }); + py::register_exception_translator([](std::exception_ptr p) { + try { + if (p) std::rethrow_exception(p); + } catch (const MyCustomException &e) { + py::set_error(exc_storage.get_stored(), e.what()); + } catch (const OtherException &e) { + py::set_error(PyExc_RuntimeError, e.what()); + } + }); + +Multiple exceptions can be handled by a single translator, as shown in the +example above. If the exception is not caught by the current translator, the +previously registered one gets a chance. + +If none of the registered exception translators is able to handle the +exception, it is handled by the default converter as described in the previous +section. + +.. seealso:: + + The file :file:`tests/test_exceptions.cpp` contains examples + of various custom exception translators and custom exception types. + +.. note:: + + Call ``py::set_error()`` for every exception caught in a custom exception + translator. Failure to do so will cause Python to crash with ``SystemError: + error return without exception set``. + + Exceptions that you do not plan to handle should simply not be caught, or + may be explicitly (re-)thrown to delegate it to the other, + previously-declared existing exception translators. + + Note that ``libc++`` and ``libstdc++`` `behave differently under macOS + `_ + with ``-fvisibility=hidden``. Therefore exceptions that are used across ABI + boundaries need to be explicitly exported, as exercised in + ``tests/test_exceptions.h``. See also: + "Problems with C++ exceptions" under `GCC Wiki `_. + + +Local vs Global Exception Translators +===================================== + +When a global exception translator is registered, it will be applied across all +modules in the reverse order of registration. This can create behavior where the +order of module import influences how exceptions are translated. + +If module1 has the following translator: + +.. code-block:: cpp + + py::register_exception_translator([](std::exception_ptr p) { + try { + if (p) std::rethrow_exception(p); + } catch (const std::invalid_argument &e) { + py::set_error(PyExc_ArgumentError, "module1 handled this"); + } + } + +and module2 has the following similar translator: + +.. code-block:: cpp + + py::register_exception_translator([](std::exception_ptr p) { + try { + if (p) std::rethrow_exception(p); + } catch (const std::invalid_argument &e) { + py::set_error(PyExc_ArgumentError, "module2 handled this"); + } + } + +then which translator handles the invalid_argument will be determined by the +order that module1 and module2 are imported. Since exception translators are +applied in the reverse order of registration, which ever module was imported +last will "win" and that translator will be applied. + +If there are multiple pybind11 modules that share exception types (either +standard built-in or custom) loaded into a single python instance and +consistent error handling behavior is needed, then local translators should be +used. + +Changing the previous example to use ``register_local_exception_translator`` +would mean that when invalid_argument is thrown in the module2 code, the +module2 translator will always handle it, while in module1, the module1 +translator will do the same. + +.. _handling_python_exceptions_cpp: + +Handling exceptions from Python in C++ +====================================== + +When C++ calls Python functions, such as in a callback function or when +manipulating Python objects, and Python raises an ``Exception``, pybind11 +converts the Python exception into a C++ exception of type +:class:`pybind11::error_already_set` whose payload contains a C++ string textual +summary and the actual Python exception. ``error_already_set`` is used to +propagate Python exception back to Python (or possibly, handle them in C++). + +.. tabularcolumns:: |p{0.5\textwidth}|p{0.45\textwidth}| + ++--------------------------------------+--------------------------------------+ +| Exception raised in Python | Thrown as C++ exception type | ++======================================+======================================+ +| Any Python ``Exception`` | :class:`pybind11::error_already_set` | ++--------------------------------------+--------------------------------------+ + +For example: + +.. code-block:: cpp + + try { + // open("missing.txt", "r") + auto file = py::module_::import("io").attr("open")("missing.txt", "r"); + auto text = file.attr("read")(); + file.attr("close")(); + } catch (py::error_already_set &e) { + if (e.matches(PyExc_FileNotFoundError)) { + py::print("missing.txt not found"); + } else if (e.matches(PyExc_PermissionError)) { + py::print("missing.txt found but not accessible"); + } else { + throw; + } + } + +Note that C++ to Python exception translation does not apply here, since that is +a method for translating C++ exceptions to Python, not vice versa. The error raised +from Python is always ``error_already_set``. + +This example illustrates this behavior: + +.. code-block:: cpp + + try { + py::eval("raise ValueError('The Ring')"); + } catch (py::value_error &boromir) { + // Boromir never gets the ring + assert(false); + } catch (py::error_already_set &frodo) { + // Frodo gets the ring + py::print("I will take the ring"); + } + + try { + // py::value_error is a request for pybind11 to raise a Python exception + throw py::value_error("The ball"); + } catch (py::error_already_set &cat) { + // cat won't catch the ball since + // py::value_error is not a Python exception + assert(false); + } catch (py::value_error &dog) { + // dog will catch the ball + py::print("Run Spot run"); + throw; // Throw it again (pybind11 will raise ValueError) + } + +Handling errors from the Python C API +===================================== + +Where possible, use :ref:`pybind11 wrappers ` instead of calling +the Python C API directly. When calling the Python C API directly, in +addition to manually managing reference counts, one must follow the pybind11 +error protocol, which is outlined here. + +After calling the Python C API, if Python returns an error, +``throw py::error_already_set();``, which allows pybind11 to deal with the +exception and pass it back to the Python interpreter. This includes calls to +the error setting functions such as ``py::set_error()``. + +.. code-block:: cpp + + py::set_error(PyExc_TypeError, "C API type error demo"); + throw py::error_already_set(); + + // But it would be easier to simply... + throw py::type_error("pybind11 wrapper type error"); + +Alternately, to ignore the error, call `PyErr_Clear +`_. + +Any Python error must be thrown or cleared, or Python/pybind11 will be left in +an invalid state. + +Handling warnings from the Python C API +======================================= + +Wrappers for handling Python warnings are provided in ``pybind11/warnings.h``. +This header must be included explicitly; it is not transitively included via +``pybind11/pybind11.h``. + +Warnings can be raised with the ``warn`` function: + +.. code-block:: cpp + + py::warnings::warn("This is a warning!", PyExc_Warning); + + // Optionally, a `stack_level` can be specified. + py::warnings::warn("Another one!", PyExc_DeprecationWarning, 3); + +New warning types can be registered at the module level using ``new_warning_type``: + +.. code-block:: cpp + + py::warnings::new_warning_type(m, "CustomWarning", PyExc_RuntimeWarning); + +Chaining exceptions ('raise from') +================================== + +Python has a mechanism for indicating that exceptions were caused by other +exceptions: + +.. code-block:: py + + try: + print(1 / 0) + except Exception as exc: + raise RuntimeError("could not divide by zero") from exc + +To do a similar thing in pybind11, you can use the ``py::raise_from`` function. It +sets the current python error indicator, so to continue propagating the exception +you should ``throw py::error_already_set()``. + +.. code-block:: cpp + + try { + py::eval("print(1 / 0")); + } catch (py::error_already_set &e) { + py::raise_from(e, PyExc_RuntimeError, "could not divide by zero"); + throw py::error_already_set(); + } + +.. versionadded:: 2.8 + +.. _unraisable_exceptions: + +Handling unraisable exceptions +============================== + +If a Python function invoked from a C++ destructor or any function marked +``noexcept(true)`` (collectively, "noexcept functions") throws an exception, there +is no way to propagate the exception, as such functions may not throw. +Should they throw or fail to catch any exceptions in their call graph, +the C++ runtime calls ``std::terminate()`` to abort immediately. + +Similarly, Python exceptions raised in a class's ``__del__`` method do not +propagate, but ``sys.unraisablehook()`` `is triggered +`_ +and an auditing event is logged. + +Any noexcept function should have a try-catch block that traps +class:`error_already_set` (or any other exception that can occur). Note that +pybind11 wrappers around Python exceptions such as +:class:`pybind11::value_error` are *not* Python exceptions; they are C++ +exceptions that pybind11 catches and converts to Python exceptions. Noexcept +functions cannot propagate these exceptions either. A useful approach is to +convert them to Python exceptions and then ``discard_as_unraisable`` as shown +below. + +.. code-block:: cpp + + void nonthrowing_func() noexcept(true) { + try { + // ... + } catch (py::error_already_set &eas) { + // Discard the Python error using Python APIs, using the C++ magic + // variable __func__. Python already knows the type and value and of the + // exception object. + eas.discard_as_unraisable(__func__); + } catch (const std::exception &e) { + // Log and discard C++ exceptions. + third_party::log(e); + } + } + +.. versionadded:: 2.6 diff --git a/third_party/pybind11/docs/advanced/functions.rst b/third_party/pybind11/docs/advanced/functions.rst new file mode 100644 index 0000000..ff00c9c --- /dev/null +++ b/third_party/pybind11/docs/advanced/functions.rst @@ -0,0 +1,616 @@ +Functions +######### + +Before proceeding with this section, make sure that you are already familiar +with the basics of binding functions and classes, as explained in :doc:`/basics` +and :doc:`/classes`. The following guide is applicable to both free and member +functions, i.e. *methods* in Python. + +.. _return_value_policies: + +Return value policies +===================== + +Python and C++ use fundamentally different ways of managing the memory and +lifetime of objects managed by them. This can lead to issues when creating +bindings for functions that return a non-trivial type. Just by looking at the +type information, it is not clear whether Python should take charge of the +returned value and eventually free its resources, or if this is handled on the +C++ side. For this reason, pybind11 provides several *return value policy* +annotations that can be passed to the :func:`module_::def` and +:func:`class_::def` functions. The default policy is +:enum:`return_value_policy::automatic`. + +Return value policies are tricky, and it's very important to get them right. +Just to illustrate what can go wrong, consider the following simple example: + +.. code-block:: cpp + + /* Function declaration */ + Data *get_data() { return _data; /* (pointer to a static data structure) */ } + ... + + /* Binding code */ + m.def("get_data", &get_data); // <-- KABOOM, will cause crash when called from Python + +What's going on here? When ``get_data()`` is called from Python, the return +value (a native C++ type) must be wrapped to turn it into a usable Python type. +In this case, the default return value policy (:enum:`return_value_policy::automatic`) +causes pybind11 to assume ownership of the static ``_data`` instance. + +When Python's garbage collector eventually deletes the Python +wrapper, pybind11 will also attempt to delete the C++ instance (via ``operator +delete()``) due to the implied ownership. At this point, the entire application +will come crashing down, though errors could also be more subtle and involve +silent data corruption. + +In the above example, the policy :enum:`return_value_policy::reference` should have +been specified so that the global data instance is only *referenced* without any +implied transfer of ownership, i.e.: + +.. code-block:: cpp + + m.def("get_data", &get_data, py::return_value_policy::reference); + +On the other hand, this is not the right policy for many other situations, +where ignoring ownership could lead to resource leaks. +As a developer using pybind11, it's important to be familiar with the different +return value policies, including which situation calls for which one of them. +The following table provides an overview of available policies: + +.. tabularcolumns:: |p{0.5\textwidth}|p{0.45\textwidth}| + ++--------------------------------------------------+----------------------------------------------------------------------------+ +| Return value policy | Description | ++==================================================+============================================================================+ +| :enum:`return_value_policy::take_ownership` | Reference an existing object (i.e. do not create a new copy) and take | +| | ownership. Python will call the destructor and delete operator when the | +| | object's reference count reaches zero. Undefined behavior ensues when the | +| | C++ side does the same, or when the data was not dynamically allocated. | ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::copy` | Create a new copy of the returned object, which will be owned by Python. | +| | This policy is comparably safe because the lifetimes of the two instances | +| | are decoupled. | ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::move` | Use ``std::move`` to move the return value contents into a new instance | +| | that will be owned by Python. This policy is comparably safe because the | +| | lifetimes of the two instances (move source and destination) are decoupled.| ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::reference` | Reference an existing object, but do not take ownership. The C++ side is | +| | responsible for managing the object's lifetime and deallocating it when | +| | it is no longer used. Warning: undefined behavior will ensue when the C++ | +| | side deletes an object that is still referenced and used by Python. | ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::reference_internal` | If the return value is an lvalue reference or a pointer, the parent object | +| | (the implicit ``this``, or ``self`` argument of the called method or | +| | property) is kept alive for at least the lifespan of the return value. | +| | **Otherwise this policy falls back to :enum:`return_value_policy::move` | +| | (see #5528).** Internally, this policy works just like | +| | :enum:`return_value_policy::reference` but additionally applies a | +| | ``keep_alive<0, 1>`` *call policy* (described in the next section) that | +| | prevents the parent object from being garbage collected as long as the | +| | return value is referenced by Python. This is the default policy for | +| | property getters created via ``def_property``, ``def_readwrite``, etc. | ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::automatic` | This policy falls back to the policy | +| | :enum:`return_value_policy::take_ownership` when the return value is a | +| | pointer. Otherwise, it uses :enum:`return_value_policy::move` or | +| | :enum:`return_value_policy::copy` for rvalue and lvalue references, | +| | respectively. See above for a description of what all of these different | +| | policies do. This is the default policy for ``py::class_``-wrapped types. | ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::automatic_reference` | As above, but use policy :enum:`return_value_policy::reference` when the | +| | return value is a pointer. This is the default conversion policy for | +| | function arguments when calling Python functions manually from C++ code | +| | (i.e. via ``handle::operator()``) and the casters in ``pybind11/stl.h``. | +| | You probably won't need to use this explicitly. | ++--------------------------------------------------+----------------------------------------------------------------------------+ + +Return value policies can also be applied to properties: + +.. code-block:: cpp + + class_(m, "MyClass") + .def_property("data", &MyClass::getData, &MyClass::setData, + py::return_value_policy::copy); + +Technically, the code above applies the policy to both the getter and the +setter function, however, the setter doesn't really care about *return* +value policies which makes this a convenient terse syntax. Alternatively, +targeted arguments can be passed through the :class:`cpp_function` constructor: + +.. code-block:: cpp + + class_(m, "MyClass") + .def_property("data", + py::cpp_function(&MyClass::getData, py::return_value_policy::copy), + py::cpp_function(&MyClass::setData) + ); + +.. warning:: + + Code with invalid return value policies might access uninitialized memory or + free data structures multiple times, which can lead to hard-to-debug + non-determinism and segmentation faults, hence it is worth spending the + time to understand all the different options in the table above. + +.. note:: + + One important aspect of the above policies is that they only apply to + instances which pybind11 has *not* seen before, in which case the policy + clarifies essential questions about the return value's lifetime and + ownership. When pybind11 knows the instance already (as identified by its + type and address in memory), it will return the existing Python object + wrapper rather than creating a new copy. + +.. note:: + + The next section on :ref:`call_policies` discusses *call policies* that can be + specified *in addition* to a return value policy from the list above. Call + policies indicate reference relationships that can involve both return values + and parameters of functions. + +.. note:: + + As an alternative to elaborate call policies and lifetime management logic, + consider using smart pointers (see the section on :ref:`smart_pointers` for + details). Smart pointers can tell whether an object is still referenced from + C++ or Python, which generally eliminates the kinds of inconsistencies that + can lead to crashes or undefined behavior. For functions returning smart + pointers, it is not necessary to specify a return value policy. + +.. _call_policies: + +Additional call policies +======================== + +In addition to the above return value policies, further *call policies* can be +specified to indicate dependencies between parameters or ensure a certain state +for the function call. + +Keep alive +---------- + +In general, this policy is required when the C++ object is any kind of container +and another object is being added to the container. ``keep_alive`` +indicates that the argument with index ``Patient`` should be kept alive at least +until the argument with index ``Nurse`` is freed by the garbage collector. Argument +indices start at one, while zero refers to the return value. For methods, index +``1`` refers to the implicit ``this`` pointer, while regular arguments begin at +index ``2``. Arbitrarily many call policies can be specified. When a ``Nurse`` +with value ``None`` is detected at runtime, the call policy does nothing. + +When the nurse is not a pybind11-registered type, the implementation internally +relies on the ability to create a *weak reference* to the nurse object. When +the nurse object is not a pybind11-registered type and does not support weak +references, an exception will be thrown. + +If you use an incorrect argument index, you will get a ``RuntimeError`` saying +``Could not activate keep_alive!``. You should review the indices you're using. + +Consider the following example: here, the binding code for a list append +operation ties the lifetime of the newly added element to the underlying +container: + +.. code-block:: cpp + + py::class_(m, "List") + .def("append", &List::append, py::keep_alive<1, 2>()); + +For consistency, the argument indexing is identical for constructors. Index +``1`` still refers to the implicit ``this`` pointer, i.e. the object which is +being constructed. Index ``0`` refers to the return type which is presumed to +be ``void`` when a constructor is viewed like a function. The following example +ties the lifetime of the constructor element to the constructed object: + +.. code-block:: cpp + + py::class_(m, "Nurse") + .def(py::init(), py::keep_alive<1, 2>()); + +.. note:: + + ``keep_alive`` is analogous to the ``with_custodian_and_ward`` (if Nurse, + Patient != 0) and ``with_custodian_and_ward_postcall`` (if Nurse/Patient == + 0) policies from Boost.Python. + +Call guard +---------- + +The ``call_guard`` policy allows any scope guard type ``T`` to be placed +around the function call. For example, this definition: + +.. code-block:: cpp + + m.def("foo", foo, py::call_guard()); + +is equivalent to the following pseudocode: + +.. code-block:: cpp + + m.def("foo", [](args...) { + T scope_guard; + return foo(args...); // forwarded arguments + }); + +The only requirement is that ``T`` is default-constructible, but otherwise any +scope guard will work. This is very useful in combination with ``gil_scoped_release``. +See :ref:`gil`. + +Multiple guards can also be specified as ``py::call_guard``. The +constructor order is left to right and destruction happens in reverse. + +.. seealso:: + + The file :file:`tests/test_call_policies.cpp` contains a complete example + that demonstrates using `keep_alive` and `call_guard` in more detail. + +.. _python_objects_as_args: + +Python objects as arguments +=========================== + +pybind11 exposes all major Python types using thin C++ wrapper classes. These +wrapper classes can also be used as parameters of functions in bindings, which +makes it possible to directly work with native Python types on the C++ side. +For instance, the following statement iterates over a Python ``dict``: + +.. code-block:: cpp + + void print_dict(const py::dict& dict) { + /* Easily interact with Python types */ + for (auto item : dict) + std::cout << "key=" << std::string(py::str(item.first)) << ", " + << "value=" << std::string(py::str(item.second)) << std::endl; + } + +It can be exported: + +.. code-block:: cpp + + m.def("print_dict", &print_dict); + +And used in Python as usual: + +.. code-block:: pycon + + >>> print_dict({"foo": 123, "bar": "hello"}) + key=foo, value=123 + key=bar, value=hello + +For more information on using Python objects in C++, see :doc:`/advanced/pycpp/index`. + +Accepting \*args and \*\*kwargs +=============================== + +Python provides a useful mechanism to define functions that accept arbitrary +numbers of arguments and keyword arguments: + +.. code-block:: python + + def generic(*args, **kwargs): + ... # do something with args and kwargs + +Such functions can also be created using pybind11: + +.. code-block:: cpp + + void generic(py::args args, const py::kwargs& kwargs) { + /// .. do something with args + if (kwargs) + /// .. do something with kwargs + } + + /// Binding code + m.def("generic", &generic); + +The class ``py::args`` derives from ``py::tuple`` and ``py::kwargs`` derives +from ``py::dict``. + +You may also use just one or the other, and may combine these with other +arguments. Note, however, that ``py::kwargs`` must always be the last argument +of the function, and ``py::args`` implies that any further arguments are +keyword-only (see :ref:`keyword_only_arguments`). + +Please refer to the other examples for details on how to iterate over these, +and on how to cast their entries into C++ objects. A demonstration is also +available in ``tests/test_kwargs_and_defaults.cpp``. + +.. note:: + + When combining \*args or \*\*kwargs with :ref:`keyword_args` you should + *not* include ``py::arg`` tags for the ``py::args`` and ``py::kwargs`` + arguments. + +Default arguments revisited +=========================== + +The section on :ref:`default_args` previously discussed basic usage of default +arguments using pybind11. One noteworthy aspect of their implementation is that +default arguments are converted to Python objects right at declaration time. +Consider the following example: + +.. code-block:: cpp + + py::class_("MyClass") + .def("myFunction", py::arg("arg") = SomeType(123)); + +In this case, pybind11 must already be set up to deal with values of the type +``SomeType`` (via a prior instantiation of ``py::class_``), or an +exception will be thrown. + +Another aspect worth highlighting is that the "preview" of the default argument +in the function signature is generated using the object's ``__repr__`` method. +If not available, the signature may not be very helpful, e.g.: + +.. code-block:: pycon + + FUNCTIONS + ... + | myFunction(...) + | Signature : (MyClass, arg : SomeType = ) -> NoneType + ... + +The first way of addressing this is by defining ``SomeType.__repr__``. +Alternatively, it is possible to specify the human-readable preview of the +default argument manually using the ``arg_v`` notation: + +.. code-block:: cpp + + py::class_("MyClass") + .def("myFunction", py::arg_v("arg", SomeType(123), "SomeType(123)")); + +Sometimes it may be necessary to pass a null pointer value as a default +argument. In this case, remember to cast it to the underlying type in question, +like so: + +.. code-block:: cpp + + py::class_("MyClass") + .def("myFunction", py::arg("arg") = static_cast(nullptr)); + +.. _keyword_only_arguments: + +Keyword-only arguments +====================== + +Python implements keyword-only arguments by specifying an unnamed ``*`` +argument in a function definition: + +.. code-block:: python + + def f(a, *, b): # a can be positional or via keyword; b must be via keyword + pass + + + f(a=1, b=2) # good + f(b=2, a=1) # good + f(1, b=2) # good + f(1, 2) # TypeError: f() takes 1 positional argument but 2 were given + +Pybind11 provides a ``py::kw_only`` object that allows you to implement +the same behaviour by specifying the object between positional and keyword-only +argument annotations when registering the function: + +.. code-block:: cpp + + m.def("f", [](int a, int b) { /* ... */ }, + py::arg("a"), py::kw_only(), py::arg("b")); + +.. versionadded:: 2.6 + +A ``py::args`` argument implies that any following arguments are keyword-only, +as if ``py::kw_only()`` had been specified in the same relative location of the +argument list as the ``py::args`` argument. The ``py::kw_only()`` may be +included to be explicit about this, but is not required. + +.. versionchanged:: 2.9 + This can now be combined with ``py::args``. Before, ``py::args`` could only + occur at the end of the argument list, or immediately before a ``py::kwargs`` + argument at the end. + + +Positional-only arguments +========================= + +Python 3.8 introduced a new positional-only argument syntax, using ``/`` in the +function definition (note that this has been a convention for CPython +positional arguments, such as in ``pow()``, since Python 2). You can +do the same thing in any version of Python using ``py::pos_only()``: + +.. code-block:: cpp + + m.def("f", [](int a, int b) { /* ... */ }, + py::arg("a"), py::pos_only(), py::arg("b")); + +You now cannot give argument ``a`` by keyword. This can be combined with +keyword-only arguments, as well. + +.. versionadded:: 2.6 + +.. _nonconverting_arguments: + +Non-converting arguments +======================== + +Certain argument types may support conversion from one type to another. Some +examples of conversions are: + +* :ref:`implicit_conversions` declared using ``py::implicitly_convertible()`` +* Calling a method accepting a double with an integer argument +* Calling a ``std::complex`` argument with a non-complex python type + (for example, with a float). (Requires the optional ``pybind11/complex.h`` + header). +* Calling a function taking an Eigen matrix reference with a numpy array of the + wrong type or of an incompatible data layout. (Requires the optional + ``pybind11/eigen.h`` header). + +This behaviour is sometimes undesirable: the binding code may prefer to raise +an error rather than convert the argument. This behaviour can be obtained +through ``py::arg`` by calling the ``.noconvert()`` method of the ``py::arg`` +object, such as: + +.. code-block:: cpp + + m.def("floats_only", [](double f) { return 0.5 * f; }, py::arg("f").noconvert()); + m.def("floats_preferred", [](double f) { return 0.5 * f; }, py::arg("f")); + +Attempting the call the second function (the one without ``.noconvert()``) with +an integer will succeed, but attempting to call the ``.noconvert()`` version +will fail with a ``TypeError``: + +.. code-block:: pycon + + >>> floats_preferred(4) + 2.0 + >>> floats_only(4) + Traceback (most recent call last): + File "", line 1, in + TypeError: floats_only(): incompatible function arguments. The following argument types are supported: + 1. (f: float) -> float + + Invoked with: 4 + +You may, of course, combine this with the :var:`_a` shorthand notation (see +:ref:`keyword_args`) and/or :ref:`default_args`. It is also permitted to omit +the argument name by using the ``py::arg()`` constructor without an argument +name, i.e. by specifying ``py::arg().noconvert()``. + +.. note:: + + When specifying ``py::arg`` options it is necessary to provide the same + number of options as the bound function has arguments. Thus if you want to + enable no-convert behaviour for just one of several arguments, you will + need to specify a ``py::arg()`` annotation for each argument with the + no-convert argument modified to ``py::arg().noconvert()``. + +.. _none_arguments: + +Allow/Prohibiting None arguments +================================ + +When a C++ type registered with :class:`py::class_` is passed as an argument to +a function taking the instance as pointer or shared holder (e.g. ``shared_ptr`` +or a custom, copyable holder as described in :ref:`smart_pointers`), pybind +allows ``None`` to be passed from Python which results in calling the C++ +function with ``nullptr`` (or an empty holder) for the argument. + +To explicitly enable or disable this behaviour, using the +``.none`` method of the :class:`py::arg` object: + +.. code-block:: cpp + + py::class_(m, "Dog").def(py::init<>()); + py::class_(m, "Cat").def(py::init<>()); + m.def("bark", [](Dog *dog) -> std::string { + if (dog) return "woof!"; /* Called with a Dog instance */ + else return "(no dog)"; /* Called with None, dog == nullptr */ + }, py::arg("dog").none(true)); + m.def("meow", [](Cat *cat) -> std::string { + // Can't be called with None argument + return "meow"; + }, py::arg("cat").none(false)); + +With the above, the Python call ``bark(None)`` will return the string ``"(no +dog)"``, while attempting to call ``meow(None)`` will raise a ``TypeError``: + +.. code-block:: pycon + + >>> from animals import Dog, Cat, bark, meow + >>> bark(Dog()) + 'woof!' + >>> meow(Cat()) + 'meow' + >>> bark(None) + '(no dog)' + >>> meow(None) + Traceback (most recent call last): + File "", line 1, in + TypeError: meow(): incompatible function arguments. The following argument types are supported: + 1. (cat: animals.Cat) -> str + + Invoked with: None + +The default behaviour when the tag is unspecified is to allow ``None``. + +.. note:: + + Even when ``.none(true)`` is specified for an argument, ``None`` will be converted to a + ``nullptr`` *only* for custom and :ref:`opaque ` types. Pointers to built-in types + (``double *``, ``int *``, ...) and STL types (``std::vector *``, ...; if ``pybind11/stl.h`` + is included) are copied when converted to C++ (see :doc:`/advanced/cast/overview`) and will + not allow ``None`` as argument. To pass optional argument of these copied types consider + using ``std::optional`` + +.. _overload_resolution: + +Overload resolution order +========================= + +When a function or method with multiple overloads is called from Python, +pybind11 determines which overload to call in two passes. The first pass +attempts to call each overload without allowing argument conversion (as if +every argument had been specified as ``py::arg().noconvert()`` as described +above). + +If no overload succeeds in the no-conversion first pass, a second pass is +attempted in which argument conversion is allowed (except where prohibited via +an explicit ``py::arg().noconvert()`` attribute in the function definition). + +If the second pass also fails a ``TypeError`` is raised. + +Within each pass, overloads are tried in the order they were registered with +pybind11. If the ``py::prepend()`` tag is added to the definition, a function +can be placed at the beginning of the overload sequence instead, allowing user +overloads to proceed built in functions. + +What this means in practice is that pybind11 will prefer any overload that does +not require conversion of arguments to an overload that does, but otherwise +prefers earlier-defined overloads to later-defined ones. + +.. note:: + + pybind11 does *not* further prioritize based on the number/pattern of + overloaded arguments. That is, pybind11 does not prioritize a function + requiring one conversion over one requiring three, but only prioritizes + overloads requiring no conversion at all to overloads that require + conversion of at least one argument. + +.. versionadded:: 2.6 + + The ``py::prepend()`` tag. + +Binding functions with template parameters +========================================== + +You can bind functions that have template parameters. Here's a function: + +.. code-block:: cpp + + template + void set(T t); + +C++ templates cannot be instantiated at runtime, so you cannot bind the +non-instantiated function: + +.. code-block:: cpp + + // BROKEN (this will not compile) + m.def("set", &set); + +You must bind each instantiated function template separately. You may bind +each instantiation with the same name, which will be treated the same as +an overloaded function: + +.. code-block:: cpp + + m.def("set", &set); + m.def("set", &set); + +Sometimes it's more clear to bind them with separate names, which is also +an option: + +.. code-block:: cpp + + m.def("setInt", &set); + m.def("setString", &set); diff --git a/third_party/pybind11/docs/advanced/misc.rst b/third_party/pybind11/docs/advanced/misc.rst new file mode 100644 index 0000000..1902ba2 --- /dev/null +++ b/third_party/pybind11/docs/advanced/misc.rst @@ -0,0 +1,615 @@ +Miscellaneous +############# + +.. _macro_notes: + +General notes regarding convenience macros +========================================== + +pybind11 provides a few convenience macros such as +:func:`PYBIND11_DECLARE_HOLDER_TYPE` and ``PYBIND11_OVERRIDE_*``. Since these +are "just" macros that are evaluated in the preprocessor (which has no concept +of types), they *will* get confused by commas in a template argument; for +example, consider: + +.. code-block:: cpp + + PYBIND11_OVERRIDE(MyReturnType, Class, func) + +The limitation of the C preprocessor interprets this as five arguments (with new +arguments beginning after each comma) rather than three. To get around this, +there are two alternatives: you can use a type alias, or you can wrap the type +using the ``PYBIND11_TYPE`` macro: + +.. code-block:: cpp + + // Version 1: using a type alias + using ReturnType = MyReturnType; + using ClassType = Class; + PYBIND11_OVERRIDE(ReturnType, ClassType, func); + + // Version 2: using the PYBIND11_TYPE macro: + PYBIND11_OVERRIDE(PYBIND11_TYPE(MyReturnType), + PYBIND11_TYPE(Class), func) + +The ``PYBIND11_MAKE_OPAQUE`` macro does *not* require the above workarounds. + +.. _gil: + +Global Interpreter Lock (GIL) +============================= + +The Python C API dictates that the Global Interpreter Lock (GIL) must always +be held by the current thread to safely access Python objects. As a result, +when Python calls into C++ via pybind11 the GIL must be held, and pybind11 +will never implicitly release the GIL. + +.. code-block:: cpp + + void my_function() { + /* GIL is held when this function is called from Python */ + } + + PYBIND11_MODULE(example, m) { + m.def("my_function", &my_function); + } + +pybind11 will ensure that the GIL is held when it knows that it is calling +Python code. For example, if a Python callback is passed to C++ code via +``std::function``, when C++ code calls the function the built-in wrapper +will acquire the GIL before calling the Python callback. Similarly, the +``PYBIND11_OVERRIDE`` family of macros will acquire the GIL before calling +back into Python. + +When writing C++ code that is called from other C++ code, if that code accesses +Python state, it must explicitly acquire and release the GIL. A separate +document on deadlocks [#f8]_ elaborates on a particularly subtle interaction +with C++'s block-scope static variable initializer guard mutexes. + +.. [#f8] See docs/advanced/deadlock.md + +The classes :class:`gil_scoped_release` and :class:`gil_scoped_acquire` can be +used to acquire and release the global interpreter lock in the body of a C++ +function call. In this way, long-running C++ code can be parallelized using +multiple Python threads, **but great care must be taken** when any +:class:`gil_scoped_release` appear: if there is any way that the C++ code +can access Python objects, :class:`gil_scoped_acquire` should be used to +reacquire the GIL. Taking :ref:`overriding_virtuals` as an example, this +could be realized as follows (important changes highlighted): + +.. code-block:: cpp + :emphasize-lines: 8,30,31 + + class PyAnimal : public Animal, public py::trampoline_self_life_support { + public: + /* Inherit the constructors */ + using Animal::Animal; + + /* Trampoline (need one for each virtual function) */ + std::string go(int n_times) { + /* PYBIND11_OVERRIDE_PURE will acquire the GIL before accessing Python state */ + PYBIND11_OVERRIDE_PURE( + std::string, /* Return type */ + Animal, /* Parent class */ + go, /* Name of function */ + n_times /* Argument(s) */ + ); + } + }; + + PYBIND11_MODULE(example, m) { + py::class_ animal(m, "Animal"); + animal + .def(py::init<>()) + .def("go", &Animal::go); + + py::class_(m, "Dog", animal) + .def(py::init<>()); + + m.def("call_go", [](Animal *animal) -> std::string { + // GIL is held when called from Python code. Release GIL before + // calling into (potentially long-running) C++ code + py::gil_scoped_release release; + return call_go(animal); + }); + } + +The ``call_go`` wrapper can also be simplified using the ``call_guard`` policy +(see :ref:`call_policies`) which yields the same result: + +.. code-block:: cpp + + m.def("call_go", &call_go, py::call_guard()); + + +.. _commongilproblems: + +Common Sources Of Global Interpreter Lock Errors +================================================================== + +Failing to properly hold the Global Interpreter Lock (GIL) is one of the +more common sources of bugs within code that uses pybind11. If you are +running into GIL related errors, we highly recommend you consult the +following checklist. + +- Do you have any global variables that are pybind11 objects or invoke + pybind11 functions in either their constructor or destructor? You are generally + not allowed to invoke any Python function in a global static context. We recommend + using lazy initialization and then intentionally leaking at the end of the program. + +- Do you have any pybind11 objects that are members of other C++ structures? One + commonly overlooked requirement is that pybind11 objects have to increase their reference count + whenever their copy constructor is called. Thus, you need to be holding the GIL to invoke + the copy constructor of any C++ class that has a pybind11 member. This can sometimes be very + tricky to track for complicated programs Think carefully when you make a pybind11 object + a member in another struct. + +- C++ destructors that invoke Python functions can be particularly troublesome as + destructors can sometimes get invoked in weird and unexpected circumstances as a result + of exceptions. + +- C++ static block-scope variable initialization that calls back into Python can + cause deadlocks; see [#f8]_ for a detailed discussion. + +- You should try running your code in a debug build. That will enable additional assertions + within pybind11 that will throw exceptions on certain GIL handling errors + (reference counting operations). + +.. _misc_free_threading: + +Free-threading support +================================================================== + +pybind11 supports the experimental free-threaded builds of Python versions 3.13+. +pybind11's internal data structures are thread safe. To enable your modules to be used with +free-threading, pass the :class:`mod_gil_not_used` tag as the third argument to +``PYBIND11_MODULE``. + +For example: + +.. code-block:: cpp + :emphasize-lines: 1 + + PYBIND11_MODULE(example, m, py::mod_gil_not_used()) { + py::class_ animal(m, "Animal"); + // etc + } + +Importantly, enabling your module to be used with free-threading is also your promise that +your code is thread safe. Modules must still be built against the Python free-threading branch to +enable free-threading, even if they specify this tag. Adding this tag does not break +compatibility with non-free-threaded Python. + +.. _misc_subinterp: + +Sub-interpreter support +================================================================== + +pybind11 supports isolated sub-interpreters, which are stable in Python 3.12+. pybind11's +internal data structures are sub-interpreter safe. To enable your modules to be imported in +isolated sub-interpreters, pass the :func:`multiple_interpreters::per_interpreter_gil()` +tag as the third or later argument to ``PYBIND11_MODULE``. + +For example: + +.. code-block:: cpp + :emphasize-lines: 1 + + PYBIND11_MODULE(example, m, py::multiple_interpreters::per_interpreter_gil()) { + py::class_ animal(m, "Animal"); + // etc + } + +Best Practices for Sub-interpreter Safety: + +- Your initialization function will run for each interpreter that imports your module. + +- Never share Python objects across different sub-interpreters. + +- Avoid global/static state whenever possible. Instead, keep state within each interpreter, + such as in instance members tied to Python objects, :func:`globals()`, and the interpreter + state dict. + +- Modules without any global/static state in their C++ code may already be sub-interpreter safe + without any additional work! + +- Avoid trying to "cache" Python objects in C++ variables across function calls (this is an easy + way to accidentally introduce sub-interpreter bugs). + +- While sub-interpreters each have their own GIL, there can now be multiple independent GILs in one + program, so concurrent calls into a module from two different sub-interpreters are still + possible. Therefore, your module still needs to consider thread safety. + +pybind11 also supports "legacy" sub-interpreters which shared a single global GIL. You can enable +legacy-only behavior by using the :func:`multiple_interpreters::shared_gil()` tag in +``PYBIND11_MODULE``. + +You can explicitly disable sub-interpreter support in your module by using the +:func:`multiple_interpreters::not_supported()` tag. This is the default behavior if you do not +specify a multiple_interpreters tag. + +.. _misc_concurrency: + +Concurrency and Parallelism in Python with pybind11 +=================================================== + +Sub-interpreter support does not imply free-threading support or vice versa. Free-threading safe +modules can still have global/static state (as long as access to them is thread-safe), but +sub-interpreter safe modules cannot. Likewise, sub-interpreter safe modules can still rely on the +GIL, but free-threading safe modules cannot. + +Here is a simple example module which has a function that calculates a value and returns the result +of the previous calculation. + +.. code-block:: cpp + + PYBIND11_MODULE(example, m) { + static size_t seed = 0; + m.def("calc_next", []() { + auto old = seed; + seed = (seed + 1) * 10; + return old; + }); + +This module is not free-threading safe because there is no synchronization on the number variable. +It is relatively easy to make this free-threading safe. One way is by using atomics, like this: + +.. code-block:: cpp + :emphasize-lines: 1,2 + + PYBIND11_MODULE(example, m, py::mod_gil_not_used()) { + static std::atomic seed(0); + m.def("calc_next", []() { + size_t old, next; + do { + old = seed.load(); + next = (old + 1) * 10; + } while (!seed.compare_exchange_weak(old, next)); + return old; + }); + } + +The atomic variable and the compare-exchange guarantee a consistent behavior from this function even +when called currently from multiple threads at the same time. + +However, the global/static integer is not sub-interpreter safe, because the calls in one +sub-interpreter will change what is seen in another. To fix it, the state needs to be specific to +each interpreter. One way to do that is by storing the state on another Python object, such as a +member of a class. For this simple example, we will store it in :func:`globals`. + +.. code-block:: cpp + :emphasize-lines: 1,6 + + PYBIND11_MODULE(example, m, py::multiple_interpreters::per_interpreter_gil()) { + m.def("calc_next", []() { + if (!py::globals().contains("myseed")) + py::globals()["myseed"] = 0; + size_t old = py::globals()["myseed"]; + py::globals()["myseed"] = (old + 1) * 10; + return old; + }); + } + +This module is sub-interpreter safe, for both ``shared_gil`` ("legacy") and +``per_interpreter_gil`` ("default") varieties. Multiple sub-interpreters could each call this same +function concurrently from different threads. This is safe because each sub-interpreter's GIL +protects it's own Python objects from concurrent access. + +However, the module is no longer free-threading safe, for the same reason as +before, because the calculation is not synchronized. We can synchronize it +using a Python critical section. This will do nothing if not in free-threaded +Python. You can have it lock one or two Python objects. You cannot nest it. + +.. warning:: + + When using a ``py::scoped_critical_section``, make sure it is not nested and + that no other synchronization primitives (such as a ``std::mutex``) are + held, which could lead to deadlocks. In 3.13, taking the same lock causes it + to release then reacquire, which means you can't use it to, for example, read + and write to a dictionary, because the dictionary uses a critical section + internally in CPython. Use a ``std::mutex`` instead if you need this on + Python 3.13. In 3.14, taking a lock on a locked object no longer releases + and relocks as an optimization, which also fixes this case. + +.. code-block:: cpp + :emphasize-lines: 1,4,8 + + #include + // ... + + PYBIND11_MODULE(example, m, py::multiple_interpreters::per_interpreter_gil(), py::mod_gil_not_used()) { + m.def("calc_next", []() { + size_t old; + py::dict g = py::globals(); + py::scoped_critical_section guard(g); + if (!g.contains("myseed")) + g["myseed"] = 0; + old = g["myseed"]; + g["myseed"] = (old + 1) * 10; + return old; + }); + } + +The module is now both sub-interpreter safe and free-threading safe. + +Binding sequence data types, iterators, the slicing protocol, etc. +================================================================== + +Please refer to the supplemental example for details. + +.. seealso:: + + The file :file:`tests/test_sequences_and_iterators.cpp` contains a + complete example that shows how to bind a sequence data type, including + length queries (``__len__``), iterators (``__iter__``), the slicing + protocol and other kinds of useful operations. + + +Partitioning code over multiple extension modules +================================================= + +It's straightforward to split binding code over multiple extension modules, +while referencing types that are declared elsewhere. Everything "just" works +without any special precautions. One exception to this rule occurs when +extending a type declared in another extension module. Recall the basic example +from Section :ref:`inheritance`. + +.. code-block:: cpp + + py::class_ pet(m, "Pet"); + pet.def(py::init()) + .def_readwrite("name", &Pet::name); + + py::class_(m, "Dog", pet /* <- specify parent */) + .def(py::init()) + .def("bark", &Dog::bark); + +Suppose now that ``Pet`` bindings are defined in a module named ``basic``, +whereas the ``Dog`` bindings are defined somewhere else. The challenge is of +course that the variable ``pet`` is not available anymore though it is needed +to indicate the inheritance relationship to the constructor of ``py::class_``. +However, it can be acquired as follows: + +.. code-block:: cpp + + py::object pet = (py::object) py::module_::import("basic").attr("Pet"); + + py::class_(m, "Dog", pet) + .def(py::init()) + .def("bark", &Dog::bark); + +Alternatively, you can specify the base class as a template parameter option to +``py::class_``, which performs an automated lookup of the corresponding Python +type. Like the above code, however, this also requires invoking the ``import`` +function once to ensure that the pybind11 binding code of the module ``basic`` +has been executed: + +.. code-block:: cpp + + py::module_::import("basic"); + + py::class_(m, "Dog") + .def(py::init()) + .def("bark", &Dog::bark); + +Naturally, both methods will fail when there are cyclic dependencies. + +Note that pybind11 code compiled with hidden-by-default symbol visibility (e.g. +via the command line flag ``-fvisibility=hidden`` on GCC/Clang), which is +required for proper pybind11 functionality, can interfere with the ability to +access types defined in another extension module. Working around this requires +manually exporting types that are accessed by multiple extension modules; +pybind11 provides a macro to do just this: + +.. code-block:: cpp + + class PYBIND11_EXPORT Dog : public Animal { + ... + }; + +Note also that it is possible (although would rarely be required) to share arbitrary +C++ objects between extension modules at runtime. Internal library data is shared +between modules using capsule machinery [#f6]_ which can be also utilized for +storing, modifying and accessing user-defined data. Note that an extension module +will "see" other extensions' data if and only if they were built with the same +pybind11 version. Consider the following example: + +.. code-block:: cpp + + auto data = reinterpret_cast(py::get_shared_data("mydata")); + if (!data) + data = static_cast(py::set_shared_data("mydata", new MyData(42))); + +If the above snippet was used in several separately compiled extension modules, +the first one to be imported would create a ``MyData`` instance and associate +a ``"mydata"`` key with a pointer to it. Extensions that are imported later +would be then able to access the data behind the same pointer. + +.. [#f6] https://docs.python.org/3/extending/extending.html#using-capsules + +Module Destructors +================== + +pybind11 does not provide an explicit mechanism to invoke cleanup code at +module destruction time. In rare cases where such functionality is required, it +is possible to emulate it using Python capsules or weak references with a +destruction callback. + +.. code-block:: cpp + + auto cleanup_callback = []() { + // perform cleanup here -- this function is called with the GIL held + }; + + m.add_object("_cleanup", py::capsule(cleanup_callback)); + +This approach has the potential downside that instances of classes exposed +within the module may still be alive when the cleanup callback is invoked +(whether this is acceptable will generally depend on the application). + +Alternatively, the capsule may also be stashed within a type object, which +ensures that it not called before all instances of that type have been +collected: + +.. code-block:: cpp + + auto cleanup_callback = []() { /* ... */ }; + m.attr("BaseClass").attr("_cleanup") = py::capsule(cleanup_callback); + +Both approaches also expose a potentially dangerous ``_cleanup`` attribute in +Python, which may be undesirable from an API standpoint (a premature explicit +call from Python might lead to undefined behavior). Yet another approach that +avoids this issue involves weak reference with a cleanup callback: + +.. code-block:: cpp + + // Register a callback function that is invoked when the BaseClass object is collected + py::cpp_function cleanup_callback( + [](py::handle weakref) { + // perform cleanup here -- this function is called with the GIL held + + weakref.dec_ref(); // release weak reference + } + ); + + // Create a weak reference with a cleanup callback and initially leak it + (void) py::weakref(m.attr("BaseClass"), cleanup_callback).release(); + +.. note:: + + PyPy does not garbage collect objects when the interpreter exits. An alternative + approach (which also works on CPython) is to use the :py:mod:`atexit` module [#f7]_, + for example: + + .. code-block:: cpp + + auto atexit = py::module_::import("atexit"); + atexit.attr("register")(py::cpp_function([]() { + // perform cleanup here -- this function is called with the GIL held + })); + + .. [#f7] https://docs.python.org/3/library/atexit.html + + +Generating documentation using Sphinx +===================================== + +Sphinx [#f4]_ has the ability to inspect the signatures and documentation +strings in pybind11-based extension modules to automatically generate beautiful +documentation in a variety formats. The python_example repository [#f5]_ contains a +simple example repository which uses this approach. + +There are two potential gotchas when using this approach: first, make sure that +the resulting strings do not contain any :kbd:`TAB` characters, which break the +docstring parsing routines. You may want to use C++11 raw string literals, +which are convenient for multi-line comments. Conveniently, any excess +indentation will be automatically be removed by Sphinx. However, for this to +work, it is important that all lines are indented consistently, i.e.: + +.. code-block:: cpp + + // ok + m.def("foo", &foo, R"mydelimiter( + The foo function + + Parameters + ---------- + )mydelimiter"); + + // *not ok* + m.def("foo", &foo, R"mydelimiter(The foo function + + Parameters + ---------- + )mydelimiter"); + +By default, pybind11 automatically generates and prepends a signature to the docstring of a function +registered with ``module_::def()`` and ``class_::def()``. Sometimes this +behavior is not desirable, because you want to provide your own signature or remove +the docstring completely to exclude the function from the Sphinx documentation. +The class ``options`` allows you to selectively suppress auto-generated signatures: + +.. code-block:: cpp + + PYBIND11_MODULE(example, m) { + py::options options; + options.disable_function_signatures(); + + m.def("add", [](int a, int b) { return a + b; }, "A function which adds two numbers"); + } + +pybind11 also appends all members of an enum to the resulting enum docstring. +This default behavior can be disabled by using the ``disable_enum_members_docstring()`` +function of the ``options`` class. + +With ``disable_user_defined_docstrings()`` all user defined docstrings of +``module_::def()``, ``class_::def()`` and ``enum_()`` are disabled, but the +function signatures and enum members are included in the docstring, unless they +are disabled separately. + +Note that changes to the settings affect only function bindings created during the +lifetime of the ``options`` instance. When it goes out of scope at the end of the module's init function, +the default settings are restored to prevent unwanted side effects. + +.. [#f4] http://www.sphinx-doc.org +.. [#f5] http://github.com/pybind/python_example + +.. _avoiding-cpp-types-in-docstrings: + +Avoiding C++ types in docstrings +================================ + +Docstrings are generated at the time of the declaration, e.g. when ``.def(...)`` is called. +At this point parameter and return types should be known to pybind11. +If a custom type is not exposed yet through a ``py::class_`` constructor or a custom type caster, +its C++ type name will be used instead to generate the signature in the docstring: + +.. code-block:: text + + | __init__(...) + | __init__(self: example.Foo, arg0: ns::Bar) -> None + ^^^^^^^ + + +This limitation can be circumvented by ensuring that C++ classes are registered with pybind11 +before they are used as a parameter or return type of a function: + +.. code-block:: cpp + + PYBIND11_MODULE(example, m) { + + auto pyFoo = py::class_(m, "Foo"); + auto pyBar = py::class_(m, "Bar"); + + pyFoo.def(py::init()); + pyBar.def(py::init()); + } + +Setting inner type hints in docstrings +====================================== + +When you use pybind11 wrappers for ``list``, ``dict``, and other generic python +types, the docstring will just display the generic type. You can convey the +inner types in the docstring by using a special 'typed' version of the generic +type. + +.. code-block:: cpp + + PYBIND11_MODULE(example, m) { + m.def("pass_list_of_str", [](py::typing::List arg) { + // arg can be used just like py::list + )); + } + +The resulting docstring will be ``pass_list_of_str(arg0: list[str]) -> None``. + +The following special types are available in ``pybind11/typing.h``: + +* ``py::Tuple`` +* ``py::Dict`` +* ``py::List`` +* ``py::Set`` +* ``py::Callable`` + +.. warning:: Just like in python, these are merely hints. They don't actually + enforce the types of their contents at runtime or compile time. diff --git a/third_party/pybind11/docs/advanced/pycpp/index.rst b/third_party/pybind11/docs/advanced/pycpp/index.rst new file mode 100644 index 0000000..6885bdc --- /dev/null +++ b/third_party/pybind11/docs/advanced/pycpp/index.rst @@ -0,0 +1,13 @@ +Python C++ interface +#################### + +pybind11 exposes Python types and functions using thin C++ wrappers, which +makes it possible to conveniently call Python code from C++ without resorting +to Python's C API. + +.. toctree:: + :maxdepth: 2 + + object + numpy + utilities diff --git a/third_party/pybind11/docs/advanced/pycpp/numpy.rst b/third_party/pybind11/docs/advanced/pycpp/numpy.rst new file mode 100644 index 0000000..e0b9ff4 --- /dev/null +++ b/third_party/pybind11/docs/advanced/pycpp/numpy.rst @@ -0,0 +1,493 @@ +.. _numpy: + +NumPy +##### + +Buffer protocol +=============== + +Python supports an extremely general and convenient approach for exchanging +data between plugin libraries. Types can expose a buffer view [#f2]_, which +provides fast direct access to the raw internal data representation. Suppose we +want to bind the following simplistic Matrix class: + +.. code-block:: cpp + + class Matrix { + public: + Matrix(size_t rows, size_t cols) : m_rows(rows), m_cols(cols) { + m_data = new float[rows*cols]; + } + float *data() { return m_data; } + size_t rows() const { return m_rows; } + size_t cols() const { return m_cols; } + private: + size_t m_rows, m_cols; + float *m_data; + }; + +The following binding code exposes the ``Matrix`` contents as a buffer object, +making it possible to cast Matrices into NumPy arrays. It is even possible to +completely avoid copy operations with Python expressions like +``np.array(matrix_instance, copy = False)``. + +.. code-block:: cpp + + py::class_(m, "Matrix", py::buffer_protocol()) + .def_buffer([](Matrix &m) -> py::buffer_info { + return py::buffer_info( + m.data(), /* Pointer to buffer */ + sizeof(float), /* Size of one scalar */ + py::format_descriptor::format(), /* Python struct-style format descriptor */ + 2, /* Number of dimensions */ + { m.rows(), m.cols() }, /* Buffer dimensions */ + { sizeof(float) * m.cols(), /* Strides (in bytes) for each index */ + sizeof(float) } + ); + }); + +Supporting the buffer protocol in a new type involves specifying the special +``py::buffer_protocol()`` tag in the ``py::class_`` constructor and calling the +``def_buffer()`` method with a lambda function that creates a +``py::buffer_info`` description record on demand describing a given matrix +instance. The contents of ``py::buffer_info`` mirror the Python buffer protocol +specification. + +.. code-block:: cpp + + struct buffer_info { + void *ptr; + py::ssize_t itemsize; + std::string format; + py::ssize_t ndim; + std::vector shape; + std::vector strides; + }; + +To create a C++ function that can take a Python buffer object as an argument, +simply use the type ``py::buffer`` as one of its arguments. Buffers can exist +in a great variety of configurations, hence some safety checks are usually +necessary in the function body. Below, you can see a basic example on how to +define a custom constructor for the Eigen double precision matrix +(``Eigen::MatrixXd``) type, which supports initialization from compatible +buffer objects (e.g. a NumPy matrix). + +.. code-block:: cpp + + /* Bind MatrixXd (or some other Eigen type) to Python */ + typedef Eigen::MatrixXd Matrix; + + typedef Matrix::Scalar Scalar; + constexpr bool rowMajor = Matrix::Flags & Eigen::RowMajorBit; + + py::class_(m, "Matrix", py::buffer_protocol()) + .def(py::init([](py::buffer b) { + typedef Eigen::Stride Strides; + + /* Request a buffer descriptor from Python */ + py::buffer_info info = b.request(); + + /* Some basic validation checks ... */ + if (!info.item_type_is_equivalent_to()) + throw std::runtime_error("Incompatible format: expected a double array!"); + + if (info.ndim != 2) + throw std::runtime_error("Incompatible buffer dimension!"); + + auto strides = Strides( + info.strides[rowMajor ? 0 : 1] / (py::ssize_t)sizeof(Scalar), + info.strides[rowMajor ? 1 : 0] / (py::ssize_t)sizeof(Scalar)); + + auto map = Eigen::Map( + static_cast(info.ptr), info.shape[0], info.shape[1], strides); + + return Matrix(map); + })); + +For reference, the ``def_buffer()`` call for this Eigen data type should look +as follows: + +.. code-block:: cpp + + .def_buffer([](Matrix &m) -> py::buffer_info { + return py::buffer_info( + m.data(), /* Pointer to buffer */ + sizeof(Scalar), /* Size of one scalar */ + py::format_descriptor::format(), /* Python struct-style format descriptor */ + 2, /* Number of dimensions */ + { m.rows(), m.cols() }, /* Buffer dimensions */ + { sizeof(Scalar) * (rowMajor ? m.cols() : 1), + sizeof(Scalar) * (rowMajor ? 1 : m.rows()) } + /* Strides (in bytes) for each index */ + ); + }) + +For a much easier approach of binding Eigen types (although with some +limitations), refer to the section on :doc:`/advanced/cast/eigen`. + +.. seealso:: + + The file :file:`tests/test_buffers.cpp` contains a complete example + that demonstrates using the buffer protocol with pybind11 in more detail. + +.. [#f2] http://docs.python.org/3/c-api/buffer.html + +Arrays +====== + +By exchanging ``py::buffer`` with ``py::array`` in the above snippet, we can +restrict the function so that it only accepts NumPy arrays (rather than any +type of Python object satisfying the buffer protocol). + +In many situations, we want to define a function which only accepts a NumPy +array of a certain data type. This is possible via the ``py::array_t`` +template. For instance, the following function requires the argument to be a +NumPy array containing double precision values. + +.. code-block:: cpp + + void f(py::array_t array); + +When it is invoked with a different type (e.g. an integer or a list of +integers), the binding code will attempt to cast the input into a NumPy array +of the requested type. This feature requires the :file:`pybind11/numpy.h` +header to be included. Note that :file:`pybind11/numpy.h` does not depend on +the NumPy headers, and thus can be used without declaring a build-time +dependency on NumPy; NumPy>=1.7.0 is a runtime dependency. + +Data in NumPy arrays is not guaranteed to packed in a dense manner; +furthermore, entries can be separated by arbitrary column and row strides. +Sometimes, it can be useful to require a function to only accept dense arrays +using either the C (row-major) or Fortran (column-major) ordering. This can be +accomplished via a second template argument with values ``py::array::c_style`` +or ``py::array::f_style``. + +.. code-block:: cpp + + void f(py::array_t array); + +The ``py::array::forcecast`` argument is the default value of the second +template parameter, and it ensures that non-conforming arguments are converted +into an array satisfying the specified requirements instead of trying the next +function overload. + +There are several methods on arrays; the methods listed below under references +work, as well as the following functions based on the NumPy API: + +- ``.dtype()`` returns the type of the contained values. + +- ``.strides()`` returns a pointer to the strides of the array (optionally pass + an integer axis to get a number). + +- ``.flags()`` returns the flag settings. ``.writable()`` and ``.owndata()`` + are directly available. + +- ``.offset_at()`` returns the offset (optionally pass indices). + +- ``.squeeze()`` returns a view with length-1 axes removed. + +- ``.view(dtype)`` returns a view of the array with a different dtype. + +- ``.reshape({i, j, ...})`` returns a view of the array with a different shape. + ``.resize({...})`` is also available. + +- ``.index_at(i, j, ...)`` gets the count from the beginning to a given index. + + +There are also several methods for getting references (described below). + +Structured types +================ + +In order for ``py::array_t`` to work with structured (record) types, we first +need to register the memory layout of the type. This can be done via +``PYBIND11_NUMPY_DTYPE`` macro, called in the plugin definition code, which +expects the type followed by field names: + +.. code-block:: cpp + + struct A { + int x; + double y; + }; + + struct B { + int z; + A a; + }; + + // ... + PYBIND11_MODULE(test, m, py::mod_gil_not_used()) { + // ... + + PYBIND11_NUMPY_DTYPE(A, x, y); + PYBIND11_NUMPY_DTYPE(B, z, a); + /* now both A and B can be used as template arguments to py::array_t */ + } + +The structure should consist of fundamental arithmetic types, ``std::complex``, +previously registered substructures, and arrays of any of the above. Both C++ +arrays and ``std::array`` are supported. While there is a static assertion to +prevent many types of unsupported structures, it is still the user's +responsibility to use only "plain" structures that can be safely manipulated as +raw memory without violating invariants. + +Scalar types +============ + +In some cases we may want to accept or return NumPy scalar values such as +``np.float32`` or ``np.float64``. We hope to be able to handle single-precision +and double-precision on the C-side. However, both are bound to Python's +double-precision builtin float by default, so they cannot be processed separately. +We used the ``py::buffer`` trick to implement the previous approach, which +will cause the readability of the code to drop significantly. + +Luckily, there's a helper type for this occasion - ``py::numpy_scalar``: + +.. code-block:: cpp + + m.def("add", [](py::numpy_scalar a, py::numpy_scalar b) { + return py::make_scalar(a + b); + }); + m.def("add", [](py::numpy_scalar a, py::numpy_scalar b) { + return py::make_scalar(a + b); + }); + +This type is trivially convertible to and from the type it wraps; currently +supported scalar types are NumPy arithmetic types: ``bool_``, ``int8``, +``int16``, ``int32``, ``int64``, ``uint8``, ``uint16``, ``uint32``, +``uint64``, ``float32``, ``float64``, ``complex64``, ``complex128``, all of +them mapping to respective C++ counterparts. + +.. note:: + + ``py::numpy_scalar`` strictly matches NumPy scalar types. For example, + ``py::numpy_scalar`` will accept ``np.int64(123)``, + but **not** a regular Python ``int`` like ``123``. + +.. note:: + + Native C types are mapped to NumPy types in a platform specific way: for + instance, ``char`` may be mapped to either ``np.int8`` or ``np.uint8`` + and ``long`` may use 4 or 8 bytes depending on the platform. Unless you + clearly understand the difference and your needs, please use ````. + +Vectorizing functions +===================== + +Suppose we want to bind a function with the following signature to Python so +that it can process arbitrary NumPy array arguments (vectors, matrices, general +N-D arrays) in addition to its normal arguments: + +.. code-block:: cpp + + double my_func(int x, float y, double z); + +After including the ``pybind11/numpy.h`` header, this is extremely simple: + +.. code-block:: cpp + + m.def("vectorized_func", py::vectorize(my_func)); + +Invoking the function like below causes 4 calls to be made to ``my_func`` with +each of the array elements. The significant advantage of this compared to +solutions like ``numpy.vectorize()`` is that the loop over the elements runs +entirely on the C++ side and can be crunched down into a tight, optimized loop +by the compiler. The result is returned as a NumPy array of type +``numpy.dtype.float64``. + +.. code-block:: pycon + + >>> x = np.array([[1, 3], [5, 7]]) + >>> y = np.array([[2, 4], [6, 8]]) + >>> z = 3 + >>> result = vectorized_func(x, y, z) + +The scalar argument ``z`` is transparently replicated 4 times. The input +arrays ``x`` and ``y`` are automatically converted into the right types (they +are of type ``numpy.dtype.int64`` but need to be ``numpy.dtype.int32`` and +``numpy.dtype.float32``, respectively). + +.. note:: + + Only arithmetic, complex, and POD types passed by value or by ``const &`` + reference are vectorized; all other arguments are passed through as-is. + Functions taking rvalue reference arguments cannot be vectorized. + +In cases where the computation is too complicated to be reduced to +``vectorize``, it will be necessary to create and access the buffer contents +manually. The following snippet contains a complete example that shows how this +works (the code is somewhat contrived, since it could have been done more +simply using ``vectorize``). + +.. code-block:: cpp + + #include + #include + + namespace py = pybind11; + + py::array_t add_arrays(py::array_t input1, py::array_t input2) { + py::buffer_info buf1 = input1.request(), buf2 = input2.request(); + + if (buf1.ndim != 1 || buf2.ndim != 1) + throw std::runtime_error("Number of dimensions must be one"); + + if (buf1.size != buf2.size) + throw std::runtime_error("Input shapes must match"); + + /* No pointer is passed, so NumPy will allocate the buffer */ + auto result = py::array_t(buf1.size); + + py::buffer_info buf3 = result.request(); + + double *ptr1 = static_cast(buf1.ptr); + double *ptr2 = static_cast(buf2.ptr); + double *ptr3 = static_cast(buf3.ptr); + + for (size_t idx = 0; idx < buf1.shape[0]; idx++) + ptr3[idx] = ptr1[idx] + ptr2[idx]; + + return result; + } + + PYBIND11_MODULE(test, m, py::mod_gil_not_used()) { + m.def("add_arrays", &add_arrays, "Add two NumPy arrays"); + } + +.. seealso:: + + The file :file:`tests/test_numpy_vectorize.cpp` contains a complete + example that demonstrates using :func:`vectorize` in more detail. + +Direct access +============= + +For performance reasons, particularly when dealing with very large arrays, it +is often desirable to directly access array elements without internal checking +of dimensions and bounds on every access when indices are known to be already +valid. To avoid such checks, the ``array`` class and ``array_t`` template +class offer an unchecked proxy object that can be used for this unchecked +access through the ``unchecked`` and ``mutable_unchecked`` methods, +where ``N`` gives the required dimensionality of the array: + +.. code-block:: cpp + + m.def("sum_3d", [](py::array_t x) { + auto r = x.unchecked<3>(); // x must have ndim = 3; can be non-writeable + double sum = 0; + for (py::ssize_t i = 0; i < r.shape(0); i++) + for (py::ssize_t j = 0; j < r.shape(1); j++) + for (py::ssize_t k = 0; k < r.shape(2); k++) + sum += r(i, j, k); + return sum; + }); + m.def("increment_3d", [](py::array_t x) { + auto r = x.mutable_unchecked<3>(); // Will throw if ndim != 3 or flags.writeable is false + for (py::ssize_t i = 0; i < r.shape(0); i++) + for (py::ssize_t j = 0; j < r.shape(1); j++) + for (py::ssize_t k = 0; k < r.shape(2); k++) + r(i, j, k) += 1.0; + }, py::arg().noconvert()); + +To obtain the proxy from an ``array`` object, you must specify both the data +type and number of dimensions as template arguments, such as ``auto r = +myarray.mutable_unchecked()``. + +If the number of dimensions is not known at compile time, you can omit the +dimensions template parameter (i.e. calling ``arr_t.unchecked()`` or +``arr.unchecked()``. This will give you a proxy object that works in the +same way, but results in less optimizable code and thus a small efficiency +loss in tight loops. + +Note that the returned proxy object directly references the array's data, and +only reads its shape, strides, and writeable flag when constructed. You must +take care to ensure that the referenced array is not destroyed or reshaped for +the duration of the returned object, typically by limiting the scope of the +returned instance. + +The returned proxy object supports some of the same methods as ``py::array`` so +that it can be used as a drop-in replacement for some existing, index-checked +uses of ``py::array``: + +- ``.ndim()`` returns the number of dimensions + +- ``.data(1, 2, ...)`` and ``r.mutable_data(1, 2, ...)``` returns a pointer to + the ``const T`` or ``T`` data, respectively, at the given indices. The + latter is only available to proxies obtained via ``a.mutable_unchecked()``. + +- ``.itemsize()`` returns the size of an item in bytes, i.e. ``sizeof(T)``. + +- ``.shape(n)`` returns the size of dimension ``n`` + +- ``.size()`` returns the total number of elements (i.e. the product of the shapes). + +- ``.nbytes()`` returns the number of bytes used by the referenced elements + (i.e. ``itemsize()`` times ``size()``). + +.. seealso:: + + The file :file:`tests/test_numpy_array.cpp` contains additional examples + demonstrating the use of this feature. + +Ellipsis +======== + +Python provides a convenient ``...`` ellipsis notation that is often used to +slice multidimensional arrays. For instance, the following snippet extracts the +middle dimensions of a tensor with the first and last index set to zero. + +.. code-block:: python + + a = ... # a NumPy array + b = a[0, ..., 0] + +The function ``py::ellipsis()`` function can be used to perform the same +operation on the C++ side: + +.. code-block:: cpp + + py::array a = /* A NumPy array */; + py::array b = a[py::make_tuple(0, py::ellipsis(), 0)]; + + +Memory view +=========== + +For a case when we simply want to provide a direct accessor to C/C++ buffer +without a concrete class object, we can return a ``memoryview`` object. Suppose +we wish to expose a ``memoryview`` for 2x4 uint8_t array, we can do the +following: + +.. code-block:: cpp + + const uint8_t buffer[] = { + 0, 1, 2, 3, + 4, 5, 6, 7 + }; + m.def("get_memoryview2d", []() { + return py::memoryview::from_buffer( + buffer, // buffer pointer + { 2, 4 }, // shape (rows, cols) + { sizeof(uint8_t) * 4, sizeof(uint8_t) } // strides in bytes + ); + }); + +This approach is meant for providing a ``memoryview`` for a C/C++ buffer not +managed by Python. The user is responsible for managing the lifetime of the +buffer. Using a ``memoryview`` created in this way after deleting the buffer in +C++ side results in undefined behavior. + +We can also use ``memoryview::from_memory`` for a simple 1D contiguous buffer: + +.. code-block:: cpp + + m.def("get_memoryview1d", []() { + return py::memoryview::from_memory( + buffer, // buffer pointer + sizeof(uint8_t) * 8 // buffer size + ); + }); + +.. versionchanged:: 2.6 + ``memoryview::from_memory`` added. diff --git a/third_party/pybind11/docs/advanced/pycpp/object.rst b/third_party/pybind11/docs/advanced/pycpp/object.rst new file mode 100644 index 0000000..93e1a94 --- /dev/null +++ b/third_party/pybind11/docs/advanced/pycpp/object.rst @@ -0,0 +1,286 @@ +Python types +############ + +.. _wrappers: + +Available wrappers +================== + +All major Python types are available as thin C++ wrapper classes. These +can also be used as function parameters -- see :ref:`python_objects_as_args`. + +Available types include :class:`handle`, :class:`object`, :class:`bool_`, +:class:`int_`, :class:`float_`, :class:`str`, :class:`bytes`, :class:`tuple`, +:class:`list`, :class:`dict`, :class:`slice`, :class:`none`, :class:`capsule`, +:class:`iterable`, :class:`iterator`, :class:`function`, :class:`buffer`, +:class:`array`, and :class:`array_t`. + +.. warning:: + + Be sure to review the :ref:`pytypes_gotchas` before using this heavily in + your C++ API. + +.. _instantiating_compound_types: + +Instantiating compound Python types from C++ +============================================ + +Dictionaries can be initialized in the :class:`dict` constructor: + +.. code-block:: cpp + + using namespace pybind11::literals; // to bring in the `_a` literal + py::dict d("spam"_a=py::none(), "eggs"_a=42); + +A tuple of python objects can be instantiated using :func:`py::make_tuple`: + +.. code-block:: cpp + + py::tuple tup = py::make_tuple(42, py::none(), "spam"); + +Each element is converted to a supported Python type. + +A `simple namespace`_ can be instantiated using + +.. code-block:: cpp + + using namespace pybind11::literals; // to bring in the `_a` literal + py::object SimpleNamespace = py::module_::import("types").attr("SimpleNamespace"); + py::object ns = SimpleNamespace("spam"_a=py::none(), "eggs"_a=42); + +Attributes on a namespace can be modified with the :func:`py::delattr`, +:func:`py::getattr`, and :func:`py::setattr` functions. Simple namespaces can +be useful as lightweight stand-ins for class instances. + +.. _simple namespace: https://docs.python.org/3/library/types.html#types.SimpleNamespace + +.. _casting_back_and_forth: + +Casting back and forth +====================== + +In this kind of mixed code, it is often necessary to convert arbitrary C++ +types to Python, which can be done using :func:`py::cast`: + +.. code-block:: cpp + + MyClass *cls = ...; + py::object obj = py::cast(cls); + +The reverse direction uses the following syntax: + +.. code-block:: cpp + + py::object obj = ...; + MyClass *cls = obj.cast(); + +When conversion fails, both directions throw the exception :class:`cast_error`. + +.. _python_libs: + +Accessing Python libraries from C++ +=================================== + +It is also possible to import objects defined in the Python standard +library or available in the current Python environment (``sys.path``) and work +with these in C++. + +This example obtains a reference to the Python ``Decimal`` class. + +.. code-block:: cpp + + // Equivalent to "from decimal import Decimal" + py::object Decimal = py::module_::import("decimal").attr("Decimal"); + +.. code-block:: cpp + + // Try to import scipy + py::object scipy = py::module_::import("scipy"); + return scipy.attr("__version__"); + + +.. _calling_python_functions: + +Calling Python functions +======================== + +It is also possible to call Python classes, functions and methods +via ``operator()``. + +.. code-block:: cpp + + // Construct a Python object of class Decimal + py::object pi = Decimal("3.14159"); + +.. code-block:: cpp + + // Use Python to make our directories + py::object os = py::module_::import("os"); + py::object makedirs = os.attr("makedirs"); + makedirs("/tmp/path/to/somewhere"); + +One can convert the result obtained from Python to a pure C++ version +if a ``py::class_`` or type conversion is defined. + +.. code-block:: cpp + + py::function f = <...>; + py::object result_py = f(1234, "hello", some_instance); + MyClass &result = result_py.cast(); + +.. _calling_python_methods: + +Calling Python methods +======================== + +To call an object's method, one can again use ``.attr`` to obtain access to the +Python method. + +.. code-block:: cpp + + // Calculate e^π in decimal + py::object exp_pi = pi.attr("exp")(); + py::print(py::str(exp_pi)); + +In the example above ``pi.attr("exp")`` is a *bound method*: it will always call +the method for that same instance of the class. Alternately one can create an +*unbound method* via the Python class (instead of instance) and pass the ``self`` +object explicitly, followed by other arguments. + +.. code-block:: cpp + + py::object decimal_exp = Decimal.attr("exp"); + + // Compute the e^n for n=0..4 + for (int n = 0; n < 5; n++) { + py::print(decimal_exp(Decimal(n)); + } + +Keyword arguments +================= + +Keyword arguments are also supported. In Python, there is the usual call syntax: + +.. code-block:: python + + def f(number, say, to): + ... # function code + + + f(1234, say="hello", to=some_instance) # keyword call in Python + +In C++, the same call can be made using: + +.. code-block:: cpp + + using namespace pybind11::literals; // to bring in the `_a` literal + f(1234, "say"_a="hello", "to"_a=some_instance); // keyword call in C++ + +Unpacking arguments +=================== + +Unpacking of ``*args`` and ``**kwargs`` is also possible and can be mixed with +other arguments: + +.. code-block:: cpp + + // * unpacking + py::tuple args = py::make_tuple(1234, "hello", some_instance); + f(*args); + + // ** unpacking + py::dict kwargs = py::dict("number"_a=1234, "say"_a="hello", "to"_a=some_instance); + f(**kwargs); + + // mixed keywords, * and ** unpacking + py::tuple args = py::make_tuple(1234); + py::dict kwargs = py::dict("to"_a=some_instance); + f(*args, "say"_a="hello", **kwargs); + +Generalized unpacking according to PEP448_ is also supported: + +.. code-block:: cpp + + py::dict kwargs1 = py::dict("number"_a=1234); + py::dict kwargs2 = py::dict("to"_a=some_instance); + f(**kwargs1, "say"_a="hello", **kwargs2); + +.. seealso:: + + The file :file:`tests/test_pytypes.cpp` contains a complete + example that demonstrates passing native Python types in more detail. The + file :file:`tests/test_callbacks.cpp` presents a few examples of calling + Python functions from C++, including keywords arguments and unpacking. + +.. _PEP448: https://www.python.org/dev/peps/pep-0448/ + +.. _implicit_casting: + +Implicit casting +================ + +When using the C++ interface for Python types, or calling Python functions, +objects of type :class:`object` are returned. It is possible to invoke implicit +conversions to subclasses like :class:`dict`. The same holds for the proxy objects +returned by ``operator[]`` or ``obj.attr()``. +Casting to subtypes improves code readability and allows values to be passed to +C++ functions that require a specific subtype rather than a generic :class:`object`. + +.. code-block:: cpp + + #include + using namespace pybind11::literals; + + py::module_ os = py::module_::import("os"); + py::module_ path = py::module_::import("os.path"); // like 'import os.path as path' + py::module_ np = py::module_::import("numpy"); // like 'import numpy as np' + + py::str curdir_abs = path.attr("abspath")(path.attr("curdir")); + py::print(py::str("Current directory: ") + curdir_abs); + py::dict environ = os.attr("environ"); + py::print(environ["HOME"]); + py::array_t arr = np.attr("ones")(3, "dtype"_a="float32"); + py::print(py::repr(arr + py::int_(1))); + +These implicit conversions are available for subclasses of :class:`object`; there +is no need to call ``obj.cast()`` explicitly as for custom classes, see +:ref:`casting_back_and_forth`. + +.. note:: + If a trivial conversion via move constructor is not possible, both implicit and + explicit casting (calling ``obj.cast()``) will attempt a "rich" conversion. + For instance, ``py::list env = os.attr("environ");`` will succeed and is + equivalent to the Python code ``env = list(os.environ)`` that produces a + list of the dict keys. + +.. TODO: Adapt text once PR #2349 has landed + +Handling exceptions +=================== + +Python exceptions from wrapper classes will be thrown as a ``py::error_already_set``. +See :ref:`Handling exceptions from Python in C++ +` for more information on handling exceptions +raised when calling C++ wrapper classes. + +.. _pytypes_gotchas: + +Gotchas +======= + +Default-Constructed Wrappers +---------------------------- + +When a wrapper type is default-constructed, it is **not** a valid Python object (i.e. it is not ``py::none()``). It is simply the same as +``PyObject*`` null pointer. To check for this, use +``static_cast(my_wrapper)``. + +Assigning py::none() to wrappers +-------------------------------- + +You may be tempted to use types like ``py::str`` and ``py::dict`` in C++ +signatures (either pure C++, or in bound signatures), and assign them default +values of ``py::none()``. However, in a best case scenario, it will fail fast +because ``None`` is not convertible to that type (e.g. ``py::dict``), or in a +worse case scenario, it will silently work but corrupt the types you want to +work with (e.g. ``py::str(py::none())`` will yield ``"None"`` in Python). diff --git a/third_party/pybind11/docs/advanced/pycpp/utilities.rst b/third_party/pybind11/docs/advanced/pycpp/utilities.rst new file mode 100644 index 0000000..af0f9cb --- /dev/null +++ b/third_party/pybind11/docs/advanced/pycpp/utilities.rst @@ -0,0 +1,155 @@ +Utilities +######### + +Using Python's print function in C++ +==================================== + +The usual way to write output in C++ is using ``std::cout`` while in Python one +would use ``print``. Since these methods use different buffers, mixing them can +lead to output order issues. To resolve this, pybind11 modules can use the +:func:`py::print` function which writes to Python's ``sys.stdout`` for consistency. + +Python's ``print`` function is replicated in the C++ API including optional +keyword arguments ``sep``, ``end``, ``file``, ``flush``. Everything works as +expected in Python: + +.. code-block:: cpp + + py::print(1, 2.0, "three"); // 1 2.0 three + py::print(1, 2.0, "three", "sep"_a="-"); // 1-2.0-three + + auto args = py::make_tuple("unpacked", true); + py::print("->", *args, "end"_a="<-"); // -> unpacked True <- + +.. _ostream_redirect: + +Capturing standard output from ostream +====================================== + +Often, a library will use the streams ``std::cout`` and ``std::cerr`` to print, +but this does not play well with Python's standard ``sys.stdout`` and ``sys.stderr`` +redirection. Replacing a library's printing with ``py::print `` may not +be feasible. This can be fixed using a guard around the library function that +redirects output to the corresponding Python streams: + +.. code-block:: cpp + + #include + + ... + + // Add a scoped redirect for your noisy code + m.def("noisy_func", []() { + py::scoped_ostream_redirect stream( + std::cout, // std::ostream& + py::module_::import("sys").attr("stdout") // Python output + ); + call_noisy_func(); + }); + +.. warning:: + + The implementation in ``pybind11/iostream.h`` is NOT thread safe. Multiple + threads writing to a redirected ostream concurrently cause data races + and potentially buffer overflows. Therefore it is currently a requirement + that all (possibly) concurrent redirected ostream writes are protected by + a mutex. #HelpAppreciated: Work on iostream.h thread safety. For more + background see the discussions under + `PR #2982 `_ and + `PR #2995 `_. + +This method respects flushes on the output streams and will flush if needed +when the scoped guard is destroyed. This allows the output to be redirected in +real time, such as to a Jupyter notebook. The two arguments, the C++ stream and +the Python output, are optional, and default to standard output if not given. An +extra type, ``py::scoped_estream_redirect ``, is identical +except for defaulting to ``std::cerr`` and ``sys.stderr``; this can be useful with +``py::call_guard``, which allows multiple items, but uses the default constructor: + +.. code-block:: cpp + + // Alternative: Call single function using call guard + m.def("noisy_func", &call_noisy_function, + py::call_guard()); + +The redirection can also be done in Python with the addition of a context +manager, using the ``py::add_ostream_redirect() `` function: + +.. code-block:: cpp + + py::add_ostream_redirect(m, "ostream_redirect"); + +The name in Python defaults to ``ostream_redirect`` if no name is passed. This +creates the following context manager in Python: + +.. code-block:: python + + with ostream_redirect(stdout=True, stderr=True): + noisy_function() + +It defaults to redirecting both streams, though you can use the keyword +arguments to disable one of the streams if needed. + +.. note:: + + The above methods will not redirect C-level output to file descriptors, such + as ``fprintf``. For those cases, you'll need to redirect the file + descriptors either directly in C or with Python's ``os.dup2`` function + in an operating-system dependent way. + +.. _eval: + +Evaluating Python expressions from strings and files +==================================================== + +pybind11 provides the ``eval``, ``exec`` and ``eval_file`` functions to evaluate +Python expressions and statements. The following example illustrates how they +can be used. + +.. code-block:: cpp + + // At beginning of file + #include + + ... + + // Evaluate in scope of main module + py::object scope = py::module_::import("__main__").attr("__dict__"); + + // Evaluate an isolated expression + int result = py::eval("my_variable + 10", scope).cast(); + + // Evaluate a sequence of statements + py::exec( + "print('Hello')\n" + "print('world!');", + scope); + + // Evaluate the statements in an separate Python file on disk + py::eval_file("script.py", scope); + +C++11 raw string literals are also supported and quite handy for this purpose. +The only requirement is that the first statement must be on a new line following +the raw string delimiter ``R"(``, ensuring all lines have common leading indent: + +.. code-block:: cpp + + py::exec(R"( + x = get_answer() + if x == 42: + print('Hello World!') + else: + print('Bye!') + )", scope + ); + +.. note:: + + `eval` and `eval_file` accept a template parameter that describes how the + string/file should be interpreted. Possible choices include ``eval_expr`` + (isolated expression), ``eval_single_statement`` (a single statement, return + value is always ``none``), and ``eval_statements`` (sequence of statements, + return value is always ``none``). `eval` defaults to ``eval_expr``, + `eval_file` defaults to ``eval_statements`` and `exec` is just a shortcut + for ``eval``. diff --git a/third_party/pybind11/docs/advanced/smart_ptrs.rst b/third_party/pybind11/docs/advanced/smart_ptrs.rst new file mode 100644 index 0000000..aeb98de --- /dev/null +++ b/third_party/pybind11/docs/advanced/smart_ptrs.rst @@ -0,0 +1,179 @@ +.. _py_class_holder: + +Smart pointers & ``py::class_`` +############################### + +The binding generator for classes, ``py::class_``, can be passed a template +type that denotes a special *holder* type that is used to manage references to +the object. If no such holder type template argument is given, the default for +a type ``T`` is ``std::unique_ptr``. + +.. note:: + + A ``py::class_`` for a given C++ type ``T`` — and all its derived types — + can only use a single holder type. + + +.. _smart_holder: + +``py::smart_holder`` +==================== + +Starting with pybind11v3, ``py::smart_holder`` is built into pybind11. It is +the recommended ``py::class_`` holder for most situations. However, for +backward compatibility it is **not** the default holder, and there are no +plans to make it the default holder in the future. + +It is extremely easy to use the safer and more versatile ``py::smart_holder``: +simply add ``py::smart_holder`` to ``py::class_``: + +* ``py::class_`` to + +* ``py::class_``. + +.. note:: + + A shorthand, ``py::classh``, is provided for + ``py::class_``. The ``h`` in ``py::classh`` stands + for **smart_holder** but is shortened for brevity, ensuring it has the + same number of characters as ``py::class_``. This design choice facilitates + easy experimentation with ``py::smart_holder`` without introducing + distracting whitespace noise in diffs. + +The ``py::smart_holder`` functionality includes the following: + +* Support for **two-way** Python/C++ conversions for both + ``std::unique_ptr`` and ``std::shared_ptr`` **simultaneously**. + +* Passing a Python object back to C++ via ``std::unique_ptr``, safely + **disowning** the Python object. + +* Safely passing "trampoline" objects (objects with C++ virtual function + overrides implemented in Python, see :ref:`overriding_virtuals`) via + ``std::unique_ptr`` or ``std::shared_ptr`` back to C++: + associated Python objects are automatically kept alive for the lifetime + of the smart-pointer. + +* Full support for ``std::enable_shared_from_this`` (`cppreference + `_). + + +``std::unique_ptr`` +=================== + +This is the default ``py::class_`` holder and works as expected in +most situations. However, handling base-and-derived classes involves a +``reinterpret_cast``, which is, strictly speaking, undefined behavior. +Also note that the ``std::unique_ptr`` holder only supports passing a +``std::unique_ptr`` from C++ to Python, but not the other way around. +For example, the following code works as expected with ``py::class_``: + +.. code-block:: cpp + + std::unique_ptr create_example() { return std::unique_ptr(new Example()); } + +.. code-block:: cpp + + m.def("create_example", &create_example); + +However, this will fail with ``py::class_`` (but works with +``py::class_``): + +.. code-block:: cpp + + void do_something_with_example(std::unique_ptr ex) { ... } + +.. note:: + + The ``reinterpret_cast`` mentioned above is `here + `_. + For completeness: The same cast is also applied to ``py::smart_holder``, + but that is safe, because ``py::smart_holder`` is not templated. + + +``std::shared_ptr`` +=================== + +It is possible to use ``std::shared_ptr`` as the holder, for example: + +.. code-block:: cpp + + py::class_ /* <- holder type */>(m, "Example"); + +Compared to using ``py::class_``, there are two noteworthy disadvantages: + +* Because a ``py::class_`` for a given C++ type ``T`` can only use a + single holder type, ``std::unique_ptr`` cannot even be passed from C++ + to Python. This will become apparent only at runtime, often through a + segmentation fault. + +* Similar to the ``std::unique_ptr`` holder, the handling of base-and-derived + classes involves a ``reinterpret_cast`` that has strictly speaking undefined + behavior, although it works as expected in most situations. + + +.. _smart_pointers: + +Custom smart pointers +===================== + +For custom smart pointers (e.g. ``c10::intrusive_ptr`` in pytorch), transparent +conversions can be enabled using a macro invocation similar to the following. +It must be declared at the top namespace level before any binding code: + +.. code-block:: cpp + + PYBIND11_DECLARE_HOLDER_TYPE(T, SmartPtr) + +The first argument of :func:`PYBIND11_DECLARE_HOLDER_TYPE` should be a +placeholder name that is used as a template parameter of the second argument. +Thus, feel free to use any identifier, but use it consistently on both sides; +also, don't use the name of a type that already exists in your codebase. + +The macro also accepts a third optional boolean parameter that is set to false +by default. Specify + +.. code-block:: cpp + + PYBIND11_DECLARE_HOLDER_TYPE(T, SmartPtr, true) + +if ``SmartPtr`` can always be initialized from a ``T*`` pointer without the +risk of inconsistencies (such as multiple independent ``SmartPtr`` instances +believing that they are the sole owner of the ``T*`` pointer). A common +situation where ``true`` should be passed is when the ``T`` instances use +*intrusive* reference counting. + +Please take a look at the :ref:`macro_notes` before using this feature. + +By default, pybind11 assumes that your custom smart pointer has a standard +interface, i.e. provides a ``.get()`` member function to access the underlying +raw pointer. If this is not the case, pybind11's ``holder_helper`` must be +specialized: + +.. code-block:: cpp + + // Always needed for custom holder types + PYBIND11_DECLARE_HOLDER_TYPE(T, SmartPtr) + + // Only needed if the type's `.get()` goes by another name + namespace PYBIND11_NAMESPACE { namespace detail { + template + struct holder_helper> { // <-- specialization + static const T *get(const SmartPtr &p) { return p.getPointer(); } + }; + }} + +The above specialization informs pybind11 that the custom ``SmartPtr`` class +provides ``.get()`` functionality via ``.getPointer()``. + +.. note:: + + The two noteworthy disadvantages mentioned under the ``std::shared_ptr`` + section apply similarly to custom smart pointer holders, but there is no + established safe alternative in this case. + +.. seealso:: + + 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. diff --git a/third_party/pybind11/docs/basics.rst b/third_party/pybind11/docs/basics.rst new file mode 100644 index 0000000..1e68869 --- /dev/null +++ b/third_party/pybind11/docs/basics.rst @@ -0,0 +1,314 @@ +.. _basics: + +First steps +########### + +This sections demonstrates the basic features of pybind11. Before getting +started, make sure that development environment is set up to compile the +included set of test cases. + + +Compiling the test cases +======================== + +Linux/macOS +----------- + +On Linux you'll need to install the **python-dev** or **python3-dev** packages as +well as **cmake**. On macOS, the included python version works out of the box, +but **cmake** must still be installed. + +After installing the prerequisites, run + +.. code-block:: bash + + mkdir build + cd build + cmake .. + make check -j 4 + +The last line will both compile and run the tests. + +Windows +------- + +On Windows, only **Visual Studio 2017** and newer are supported. + +.. Note:: + + To use the C++17 in Visual Studio 2017 (MSVC 14.1), pybind11 requires the flag + ``/permissive-`` to be passed to the compiler `to enforce standard conformance`_. When + building with Visual Studio 2019, this is not strictly necessary, but still advised. + +.. _`to enforce standard conformance`: https://docs.microsoft.com/en-us/cpp/build/reference/permissive-standards-conformance?view=vs-2017 + +To compile and run the tests: + +.. code-block:: batch + + mkdir build + cd build + cmake .. + cmake --build . --config Release --target check + +This will create a Visual Studio project, compile and run the target, all from the +command line. + +.. Note:: + + If all tests fail, make sure that the Python binary and the testcases are compiled + for the same processor type and bitness (i.e. either **i386** or **x86_64**). You + can specify **x86_64** as the target architecture for the generated Visual Studio + project using ``cmake -A x64 ..``. + +.. seealso:: + + Advanced users who are already familiar with Boost.Python may want to skip + the tutorial and look at the test cases in the :file:`tests` directory, + which exercise all features of pybind11. + +Header and namespace conventions +================================ + +For brevity, all code examples assume that the following two lines are present: + +.. code-block:: cpp + + #include + + namespace py = pybind11; + +.. note:: + + ``pybind11/pybind11.h`` includes ``Python.h``, as such it must be the first file + included in any source file or header for `the same reasons as Python.h`_. + +.. _`the same reasons as Python.h`: https://docs.python.org/3/extending/extending.html#a-simple-example + +Some features may require additional headers, but those will be specified as needed. + +.. _simple_example: + +Creating bindings for a simple function +======================================= + +Let's start by creating Python bindings for an extremely simple function, which +adds two numbers and returns their result: + +.. code-block:: cpp + + int add(int i, int j) { + return i + j; + } + +For simplicity [#f1]_, we'll put both this function and the binding code into +a file named :file:`example.cpp` with the following contents: + +.. code-block:: cpp + + #include + + int add(int i, int j) { + return i + j; + } + + PYBIND11_MODULE(example, m, py::mod_gil_not_used()) { + m.doc() = "pybind11 example plugin"; // optional module docstring + + m.def("add", &add, "A function that adds two numbers"); + } + +.. [#f1] In practice, implementation and binding code will generally be located + in separate files. + +The :func:`PYBIND11_MODULE` macro creates a function that will be called when an +``import`` statement is issued from within Python. The module name (``example``) +is given as the first macro argument (it should not be in quotes). The second +argument (``m``) defines a variable of type :class:`py::module_ ` which +is the main interface for creating bindings. The method :func:`module_::def` +generates binding code that exposes the ``add()`` function to Python. + +.. note:: + + Notice how little code was needed to expose our function to Python: all + details regarding the function's parameters and return value were + automatically inferred using template metaprogramming. This overall + approach and the used syntax are borrowed from Boost.Python, though the + underlying implementation is very different. + +pybind11 is a header-only library, hence it is not necessary to link against +any special libraries and there are no intermediate (magic) translation steps. +On Linux, the above example can be compiled using the following command: + +.. code-block:: bash + + $ c++ -O3 -Wall -shared -std=c++11 -fPIC $(python3 -m pybind11 --includes) example.cpp -o example$(python3 -m pybind11 --extension-suffix) + +.. note:: + + If you used :ref:`include_as_a_submodule` to get the pybind11 source, then + use ``$(python3-config --includes) -Iextern/pybind11/include`` instead of + ``$(python3 -m pybind11 --includes)`` in the above compilation, as + explained in :ref:`building_manually`. + +For more details on the required compiler flags on Linux and macOS, see +:ref:`building_manually`. For complete cross-platform compilation instructions, +refer to the :ref:`compiling` page. + +The `python_example`_ and `cmake_example`_ repositories are also a good place +to start. They are both complete project examples with cross-platform build +systems. The only difference between the two is that `python_example`_ uses +Python's ``setuptools`` to build the module, while `cmake_example`_ uses CMake +(which may be preferable for existing C++ projects). + +.. _python_example: https://github.com/pybind/python_example +.. _cmake_example: https://github.com/pybind/cmake_example + +Building the above C++ code will produce a binary module file that can be +imported to Python. Assuming that the compiled module is located in the +current directory, the following interactive Python session shows how to +load and execute the example: + +.. code-block:: pycon + + $ python + Python 3.9.10 (main, Jan 15 2022, 11:48:04) + [Clang 13.0.0 (clang-1300.0.29.3)] on darwin + Type "help", "copyright", "credits" or "license" for more information. + >>> import example + >>> example.add(1, 2) + 3 + >>> + +.. _keyword_args: + +Keyword arguments +================= + +With a simple code modification, it is possible to inform Python about the +names of the arguments ("i" and "j" in this case). + +.. code-block:: cpp + + m.def("add", &add, "A function which adds two numbers", + py::arg("i"), py::arg("j")); + +:class:`arg` is one of several special tag classes which can be used to pass +metadata into :func:`module_::def`. With this modified binding code, we can now +call the function using keyword arguments, which is a more readable alternative +particularly for functions taking many parameters: + +.. code-block:: pycon + + >>> import example + >>> example.add(i=1, j=2) + 3L + +The keyword names also appear in the function signatures within the documentation. + +.. code-block:: pycon + + >>> help(example) + + .... + + FUNCTIONS + add(...) + Signature : (i: int, j: int) -> int + + A function which adds two numbers + +A shorter notation for named arguments is also available: + +.. code-block:: cpp + + // regular notation + m.def("add1", &add, py::arg("i"), py::arg("j")); + // shorthand + using namespace pybind11::literals; + m.def("add2", &add, "i"_a, "j"_a); + +The :var:`_a` suffix forms a C++11 literal which is equivalent to :class:`arg`. +Note that the literal operator must first be made visible with the directive +``using namespace pybind11::literals``. This does not bring in anything else +from the ``pybind11`` namespace except for literals. + +.. _default_args: + +Default arguments +================= + +Suppose now that the function to be bound has default arguments, e.g.: + +.. code-block:: cpp + + int add(int i = 1, int j = 2) { + return i + j; + } + +Unfortunately, pybind11 cannot automatically extract these parameters, since they +are not part of the function's type information. However, they are simple to specify +using an extension of :class:`arg`: + +.. code-block:: cpp + + m.def("add", &add, "A function which adds two numbers", + py::arg("i") = 1, py::arg("j") = 2); + +The default values also appear within the documentation. + +.. code-block:: pycon + + >>> help(example) + + .... + + FUNCTIONS + add(...) + Signature : (i: int = 1, j: int = 2) -> int + + A function which adds two numbers + +The shorthand notation is also available for default arguments: + +.. code-block:: cpp + + // regular notation + m.def("add1", &add, py::arg("i") = 1, py::arg("j") = 2); + // shorthand + m.def("add2", &add, "i"_a=1, "j"_a=2); + +Exporting variables +=================== + +To expose a value from C++, use the ``attr`` function to register it in a +module as shown below. Built-in types and general objects (more on that later) +are automatically converted when assigned as attributes, and can be explicitly +converted using the function ``py::cast``. + +.. code-block:: cpp + + PYBIND11_MODULE(example, m, py::mod_gil_not_used()) { + m.attr("the_answer") = 42; + py::object world = py::cast("World"); + m.attr("what") = world; + } + +These are then accessible from Python: + +.. code-block:: pycon + + >>> import example + >>> example.the_answer + 42 + >>> example.what + 'World' + +.. _supported_types: + +Supported data types +==================== + +A large number of data types are supported out of the box and can be used +seamlessly as functions arguments, return values or with ``py::cast`` in general. +For a full overview, see the :doc:`advanced/cast/index` section. diff --git a/third_party/pybind11/docs/benchmark.py b/third_party/pybind11/docs/benchmark.py new file mode 100644 index 0000000..0b9d08f --- /dev/null +++ b/third_party/pybind11/docs/benchmark.py @@ -0,0 +1,89 @@ +from __future__ import annotations + +import datetime as dt +import os +import random + +nfns = 4 # Functions per class +nargs = 4 # Arguments per function + + +def generate_dummy_code_pybind11(nclasses=10): + decl = "" + bindings = "" + + for cl in range(nclasses): + decl += f"class cl{cl:03};\n" + decl += "\n" + + for cl in range(nclasses): + decl += f"class {cl:03} {{\n" + decl += "public:\n" + bindings += f' py::class_(m, "cl{cl:03}")\n' + for fn in range(nfns): + ret = random.randint(0, nclasses - 1) + params = [random.randint(0, nclasses - 1) for i in range(nargs)] + decl += f" cl{ret:03} *fn_{fn:03}(" + decl += ", ".join(f"cl{p:03} *" for p in params) + decl += ");\n" + bindings += f' .def("fn_{fn:03}", &cl{cl:03}::fn_{fn:03})\n' + decl += "};\n\n" + bindings += " ;\n" + + result = "#include \n\n" + result += "namespace py = pybind11;\n\n" + result += decl + "\n" + result += "PYBIND11_MODULE(example, m, py::mod_gil_not_used()) {\n" + result += bindings + result += "}" + return result + + +def generate_dummy_code_boost(nclasses=10): + decl = "" + bindings = "" + + for cl in range(nclasses): + decl += f"class cl{cl:03};\n" + decl += "\n" + + for cl in range(nclasses): + decl += f"class cl{cl:03} {{\n" + decl += "public:\n" + bindings += f' py::class_("cl{cl:03}")\n' + for fn in range(nfns): + ret = random.randint(0, nclasses - 1) + params = [random.randint(0, nclasses - 1) for i in range(nargs)] + decl += f" cl{ret:03} *fn_{fn:03}(" + decl += ", ".join(f"cl{p:03} *" for p in params) + decl += ");\n" + bindings += f' .def("fn_{fn:03}", &cl{cl:03}::fn_{fn:03}, py::return_value_policy())\n' + decl += "};\n\n" + bindings += " ;\n" + + result = "#include \n\n" + result += "namespace py = boost::python;\n\n" + result += decl + "\n" + result += "BOOST_PYTHON_MODULE(example) {\n" + result += bindings + result += "}" + return result + + +for codegen in [generate_dummy_code_pybind11, generate_dummy_code_boost]: + print("{") + for i in range(10): + nclasses = 2**i + with open("test.cpp", "w") as f: + f.write(codegen(nclasses)) + n1 = dt.datetime.now() + os.system( + "g++ -Os -shared -rdynamic -undefined dynamic_lookup " + "-fvisibility=hidden -std=c++14 test.cpp -I include " + "-I /System/Library/Frameworks/Python.framework/Headers -o test.so" + ) + n2 = dt.datetime.now() + elapsed = (n2 - n1).total_seconds() + size = os.stat("test.so").st_size + print(f" {{{nclasses * nfns}, {elapsed:.6f}, {size}}},") + print("}") diff --git a/third_party/pybind11/docs/benchmark.rst b/third_party/pybind11/docs/benchmark.rst new file mode 100644 index 0000000..f1bf321 --- /dev/null +++ b/third_party/pybind11/docs/benchmark.rst @@ -0,0 +1,95 @@ +Benchmark +========= + +The following is the result of a synthetic benchmark comparing both compilation +time and module size of pybind11 against Boost.Python. A detailed report about a +Boost.Python to pybind11 conversion of a real project is available here: [#f1]_. + +.. [#f1] http://graylab.jhu.edu/RosettaCon2016/PyRosetta-4.pdf + +Setup +----- + +A python script (see the ``docs/benchmark.py`` file) was used to generate a set +of files with dummy classes whose count increases for each successive benchmark +(between 1 and 2048 classes in powers of two). Each class has four methods with +a randomly generated signature with a return value and four arguments. (There +was no particular reason for this setup other than the desire to generate many +unique function signatures whose count could be controlled in a simple way.) + +Here is an example of the binding code for one class: + +.. code-block:: cpp + + ... + class cl034 { + public: + cl279 *fn_000(cl084 *, cl057 *, cl065 *, cl042 *); + cl025 *fn_001(cl098 *, cl262 *, cl414 *, cl121 *); + cl085 *fn_002(cl445 *, cl297 *, cl145 *, cl421 *); + cl470 *fn_003(cl200 *, cl323 *, cl332 *, cl492 *); + }; + ... + + PYBIND11_MODULE(example, m, py::mod_gil_not_used()) { + ... + py::class_(m, "cl034") + .def("fn_000", &cl034::fn_000) + .def("fn_001", &cl034::fn_001) + .def("fn_002", &cl034::fn_002) + .def("fn_003", &cl034::fn_003) + ... + } + +The Boost.Python version looks almost identical except that a return value +policy had to be specified as an argument to ``def()``. For both libraries, +compilation was done with + +.. code-block:: bash + + Apple LLVM version 7.0.2 (clang-700.1.81) + +and the following compilation flags + +.. code-block:: bash + + g++ -Os -shared -rdynamic -undefined dynamic_lookup -fvisibility=hidden -std=c++14 + +Compilation time +---------------- + +The following log-log plot shows how the compilation time grows for an +increasing number of class and function declarations. pybind11 includes many +fewer headers, which initially leads to shorter compilation times, but the +performance is ultimately fairly similar (pybind11 is 19.8 seconds faster for +the largest largest file with 2048 classes and a total of 8192 methods -- a +modest **1.2x** speedup relative to Boost.Python, which required 116.35 +seconds). + +.. only:: not latex + + .. image:: pybind11_vs_boost_python1.svg + +.. only:: latex + + .. image:: pybind11_vs_boost_python1.png + +Module size +----------- + +Differences between the two libraries become much more pronounced when +considering the file size of the generated Python plugin: for the largest file, +the binary generated by Boost.Python required 16.8 MiB, which was **2.17 +times** / **9.1 megabytes** larger than the output generated by pybind11. For +very small inputs, Boost.Python has an edge in the plot below -- however, note +that it stores many definitions in an external library, whose size was not +included here, hence the comparison is slightly shifted in Boost.Python's +favor. + +.. only:: not latex + + .. image:: pybind11_vs_boost_python2.svg + +.. only:: latex + + .. image:: pybind11_vs_boost_python2.png diff --git a/third_party/pybind11/docs/changelog.md b/third_party/pybind11/docs/changelog.md new file mode 100644 index 0000000..c8d6318 --- /dev/null +++ b/third_party/pybind11/docs/changelog.md @@ -0,0 +1,3234 @@ +# Changelog + + + +Starting with version 1.8.0, pybind11 releases use a [semantic +versioning](http://semver.org) policy. + +Changes will be added here periodically from the "Suggested changelog +entry" block in pull request descriptions. + + +## Version 3.0.1 (August 22, 2025) + +Bug fixes: + +- Fixed compilation error in `type_caster_enum_type` when casting + pointer-to-enum types. Added pointer overload to handle dereferencing before + enum conversion. + [#5776](https://github.com/pybind/pybind11/pull/5776) + +- Implement binary version of `make_index_sequence` to reduce template depth + requirements for functions with many parameters. + [#5751](https://github.com/pybind/pybind11/pull/5751) + +- Subinterpreter-specific exception handling code was removed to resolve segfaults. + [#5795](https://github.com/pybind/pybind11/pull/5795) + +- Fixed issue that caused ``PYBIND11_MODULE`` code to run again if the module + was re-imported after being deleted from ``sys.modules``. + [#5782](https://github.com/pybind/pybind11/pull/5782) + +- Prevent concurrent creation of sub-interpreters as a workaround for stdlib + concurrency issues in Python 3.12. + [#5779](https://github.com/pybind/pybind11/pull/5779) + +- Fixed potential crash when using `cpp_function` objects with sub-interpreters. + [#5771](https://github.com/pybind/pybind11/pull/5771) + +- Fixed non-entrant check in `implicitly_convertible()`. + [#5777](https://github.com/pybind/pybind11/pull/5777) + +- Support C++20 on platforms that have older c++ runtimes. + [#5761](https://github.com/pybind/pybind11/pull/5761) + +- Fix compilation with clang on msys2. + [#5757](https://github.com/pybind/pybind11/pull/5757) + +- Avoid `nullptr` dereference warning with GCC 13.3.0 and python 3.11.13. + [#5756](https://github.com/pybind/pybind11/pull/5756) + +- Fix potential warning about number of threads being too large. + [#5807](https://github.com/pybind/pybind11/pull/5807) + + + + +- Fix gcc 11.4+ warning about serial compilation using CMake. + [#5791](https://github.com/pybind/pybind11/pull/5791) + + +Documentation: + +- Improve `buffer_info` type checking in numpy docs. + [#5805](https://github.com/pybind/pybind11/pull/5805) + +- Replace `robotpy-build` with `semiwrap` in the binding tool list. + [#5804](https://github.com/pybind/pybind11/pull/5804) + +- Show nogil in most examples. + [#5770](https://github.com/pybind/pybind11/pull/5770) + +- Fix `py::trampoline_self_life_support` visibility in docs. + [#5766](https://github.com/pybind/pybind11/pull/5766) + + +Tests: + +- Avoid a spurious warning about `DOWNLOAD_CATCH` being manually specified. + [#5803](https://github.com/pybind/pybind11/pull/5803) + +- Fix an IsolatedConfig test. + [#5768](https://github.com/pybind/pybind11/pull/5768) + + +CI: + +- Add CI testing for Android. + [#5714](https://github.com/pybind/pybind11/pull/5714) + + +Internal: + +- Rename internal variables to avoid the word `slots` (reads better). + [#5793](https://github.com/pybind/pybind11/pull/5793) + + +## Version 3.0.0 (July 10, 2025) + +Pybind11 3.0 includes an ABI bump, the first required bump in many years +on Unix (Windows has had required bumps more often). This release contains +the smart-holder branch, multi-phase init and subinterpreter support, +`py::native_enum`, an interface to warnings, typing improvements, and more. +CMake now defaults to FindPython mode. Please check our upgrade guide for +more info on upgrading! + +Support for Python 3.14, 3.14t, GraalPy, and PyPy 3.11 has been added, while +legacy support for Python 3.7, PyPy 3.8/3.9, and CMake \<3.15 has been removed. +Most deprecated features have been kept for this release, but anything +producing a warning in 3.0 may be removed in a future 3.x version. We also now +have a deprecation page. + +New Features: + +- The `smart_holder` branch has been merged, enabling + `py::class_`, which handles two-way conversion + with `std::unique_ptr` and `std::shared_ptr` (simultaneously), + disowning a Python object being passed to `std::unique_ptr`, + trampoline objects, and `std::enable_shared_from_this`. + [#5542](https://github.com/pybind/pybind11/pull/5542) + + - Added support for `std::shared_ptr` in `py::init()` when using + `py::smart_holder`, complementing existing support for + `std::unique_ptr`. + [#5731](https://github.com/pybind/pybind11/pull/5731) + + - Support const-only smart pointers. + [#5718](https://github.com/pybind/pybind11/pull/5718) + + - Eliminate cross-DSO RTTI reliance from `trampoline_self_life_support` functionality, `smart_holder` deleter detection, and other + `smart_holder` bookkeeping. Resolves platform-specific issues on macOS related to cross-DSO `dynamic_cast` and `typeid` mismatches. + [#5728](https://github.com/pybind/pybind11/pull/5728) (replaces [#5700](https://github.com/pybind/pybind11/pull/5700)) + +- Changed `PYBIND11_MODULE` macro implementation to perform multi-phase + module initialization (PEP 489) behind the scenes. + [#5574](https://github.com/pybind/pybind11/pull/5574) and avoid destruction + [#5688](https://github.com/pybind/pybind11/pull/5688) + +- Support for sub-interpreters (both isolated (with separate GILs) and + legacy (with a global GIL). Add the + `py::multiple_interpreters::per_interpreter_gil()` tag (or, + `py::multiple_interpreters::shared_gil()` for legacy interpreter + support) to `PYBIND11_MODULE` calls (as the third parameter) to + indicate that a module supports running with sub-interpreters. + [#5564](https://github.com/pybind/pybind11/pull/5564) + + - Rename macro `PYBIND11_SUBINTERPRETER_SUPPORT` -> `PYBIND11_HAS_SUBINTERPRETER_SUPPORT` to meet naming convention. + [#5682](https://github.com/pybind/pybind11/pull/5682) + + - Allow subinterpreter support to be disabled if defined to 0. This is mostly an emergency workaround, and is not exposed in CMake. + [#5708](https://github.com/pybind/pybind11/pull/5708) and [#5710](https://github.com/pybind/pybind11/pull/5710) + + - Modify internals pointer-to-pointer implementation to not use `thread_local` (better iOS support). + [#5709](https://github.com/pybind/pybind11/pull/5709) + + - Support implementations without subinterpreter support. + [#5732](https://github.com/pybind/pybind11/pull/5732) + +- Changed `PYBIND11_EMBEDDED_MODULE` macro implementation to perform + multi-phase module initialization (PEP 489) behind the scenes and to + support `py::mod_gil_not_used()`, + `py::multiple_interpreters::per_interpreter_gil()` and + `py::multiple_interpreters::shared_gil()`. + [#5665](https://github.com/pybind/pybind11/pull/5665) and consolidate code + [#5670](https://github.com/pybind/pybind11/pull/5670). + +- Added API in `pybind11/subinterpreter.h` for embedding sub-intepreters (requires Python 3.12+). + [#5666](https://github.com/pybind/pybind11/pull/5666) + +- `py::native_enum` was added, for conversions between Python's native + (stdlib) enum types and C++ enums. + [#5555](https://github.com/pybind/pybind11/pull/5555) + + - Add class doc string to `py::native_enum`. + [#5617](https://github.com/pybind/pybind11/pull/5617). + + - Fix signature for functions with a `native_enum` in the signature. + [#5619](https://github.com/pybind/pybind11/pull/5619) + +- Support `py::numpy_scalar<>` / `py::make_scalar()` for NumPy types. + [#5726](https://github.com/pybind/pybind11/pull/5726) + +- A `py::release_gil_before_calling_cpp_dtor` option (for `py::class_`) + was added to resolve the long-standing issue \#1446. + [#5522](https://github.com/pybind/pybind11/pull/5522) + +- Add `dtype::normalized_num` and `dtype::num_of`. + [#5429](https://github.com/pybind/pybind11/pull/5429) + +- Add support for `array_t` and `array_t`. + [#5427](https://github.com/pybind/pybind11/pull/5427) + +- Added `py::warnings` namespace with `py::warnings::warn` and + `py::warnings::new_warning_type` that provides the interface for + Python warnings. + [#5291](https://github.com/pybind/pybind11/pull/5291) + +- `stl.h` `list|set|map_caster` were made more user friendly: it is no + longer necessary to explicitly convert Python iterables to `tuple()`, + `set()`, or `map()` in many common situations. + [#4686](https://github.com/pybind/pybind11/pull/4686) + +- The `array_caster` in pybind11/stl.h was enhanced to support value + types that are not default-constructible. + [#5305](https://github.com/pybind/pybind11/pull/5305) + +- `pybind11/conduit/pybind11_platform_abi_id.h` was factored out, to + maximize reusability of `PYBIND11_PLATFORM_ABI_ID` (for other + Python/C++ binding systems). Separately, a note was added to explain + that the conduit feature only covers from-Python-to-C++ conversions. + [#5375](https://github.com/pybind/pybind11/pull/5375) \| + [#5740](https://github.com/pybind/pybind11/pull/5740) + +- Added support for finding pybind11 using pkgconf distributed on pypi. + [#5552](https://github.com/pybind/pybind11/pull/5552) + +- Support `--extension-suffix` on the pybind11 command. + [#5360](https://github.com/pybind/pybind11/pull/5360) + +- Add semi-public API: `pybind11::detail::is_holder_constructed` and + update example for `pybind11::custom_type_setup` in documentation. + [#5669](https://github.com/pybind/pybind11/pull/5669) + +- Added `py::scoped_critical_section` to support free-threaded mode. + [#5684](https://github.com/pybind/pybind11/pull/5684) \| + [#5706](https://github.com/pybind/pybind11/pull/5706) + +New Features / fixes (typing): + +- Added option for different arg/return type hints to `type_caster`. + Updated `stl/filesystem` to use correct arg/return type hints. Updated + `pybind11::typing` to use correct arg/return type hints for nested + types. [#5450](https://github.com/pybind/pybind11/pull/5450) +- Updated type hint for `py::capsule` to `type.CapsuleType`. + [#5567](https://github.com/pybind/pybind11/pull/5567) +- Adds support for `typing.SupportsInt` and `typing.SupportsFloat`. + Update `Final` to be narrower type hint. Make `std::function` match + `Callable` type. Fix `io_name` bug in `attr_with_type_hint`. + [#5540](https://github.com/pybind/pybind11/pull/5540) +- Rework of arg/return type hints to support `.noconvert()`. + [#5486](https://github.com/pybind/pybind11/pull/5486) +- Add `attr_with_type` for declaring attribute types and `Final`, + `ClassVar` type annotations. + [#5460](https://github.com/pybind/pybind11/pull/5460) +- Allow annotate methods with `py::pos_only` when only have the `self` + argument. Make arguments for auto-generated dunder methods + positional-only. + [#5403](https://github.com/pybind/pybind11/pull/5403) +- Added `py::Args` and `py::KWArgs` to enable custom type hinting of + `*args` and `**kwargs` (see PEP 484). + [#5357](https://github.com/pybind/pybind11/pull/5357) +- Switched to `numpy.typing.NDArray` and `numpy.typing.ArrayLike`. + [#5212](https://github.com/pybind/pybind11/pull/5212) +- Use `numpy.object_` instead of `object`. + [#5571](https://github.com/pybind/pybind11/pull/5571) +- Fix module type hint. + [#5469](https://github.com/pybind/pybind11/pull/5469) +- Fix Buffer type hint. + [#5662](https://github.com/pybind/pybind11/pull/5662) +- Added support for `collections.abc` in type hints and convertible + checks of STL casters and `py::buffer`. + [#5566](https://github.com/pybind/pybind11/pull/5566) +- Fix `typing` and `collections.abc` type hint ambiguity. + [#5663](https://github.com/pybind/pybind11/pull/5663) +- Add `typing_extensions` alternatives for all types that need them. + [#5693](https://github.com/pybind/pybind11/pull/5693) + +Removals: + +- Remove support for pybind11 v2 internals versions (4, 5, 6). (The + internals version number has been bumped for pybind11 v3.) + [#5512](https://github.com/pybind/pybind11/pull/5512) \| + [#5530](https://github.com/pybind/pybind11/pull/5530) +- Remove `make_simple_namespace` (added in 2.8.0, deprecated in 2.8.1). + [#5597](https://github.com/pybind/pybind11/pull/5597) +- Legacy-mode option `PYBIND11_NUMPY_1_ONLY` has been removed. + [#5595](https://github.com/pybind/pybind11/pull/5595) +- Add a deprecation warning to `.get_type` (deprecated in pybind11 2.6 + in 2020). [#5596](https://github.com/pybind/pybind11/pull/5596) + +Bug fixes: + +- Set `__file__` on submodules. + [#5584](https://github.com/pybind/pybind11/pull/5584). Except on + embedded modules. + [#5650](https://github.com/pybind/pybind11/pull/5650) +- pybind11-bound functions are now pickleable. + [#5580](https://github.com/pybind/pybind11/pull/5580) +- Fix bug in `attr_with_type_hint` to allow objects to be in + `attr_with_type_hint`. + [#5576](https://github.com/pybind/pybind11/pull/5576) +- A `-Wmaybe-uninitialized` warning suppression was added in + `pybind11/eigen/matrix.h`. + [#5516](https://github.com/pybind/pybind11/pull/5516) +- `PYBIND11_WARNING_POP` was incorrectly defined as + `PYBIND11_PRAGMA(clang diagnostic push)`. + [#5448](https://github.com/pybind/pybind11/pull/5448) +- `PYBIND11_PLATFORM_ABI_ID` (which is used in composing + `PYBIND11_INTERNALS_ID`) was modernized to reflect actual ABI + compatibility more accurately. + [#4953](https://github.com/pybind/pybind11/pull/4953) \| + [#5439](https://github.com/pybind/pybind11/pull/5439) +- Fix buffer protocol implementation. + [#5407](https://github.com/pybind/pybind11/pull/5407) +- Fix iterator increment operator does not skip first item. + [#5400](https://github.com/pybind/pybind11/pull/5400) +- When getting or deleting an element in a container bound by + `bind_map`, print the key in `KeyError` if it does not exist. + [#5397](https://github.com/pybind/pybind11/pull/5397) +- `pybind11::builtin_exception` is now explicitly exported when linked + to libc++. [#5390](https://github.com/pybind/pybind11/pull/5390) +- Allow subclasses of `py::args` and `py::kwargs`. + [#5381](https://github.com/pybind/pybind11/pull/5381) +- Disable false-positive GCC 12 Bound Check warning. + [#5355](https://github.com/pybind/pybind11/pull/5355) +- Update the dict when restoring pickles, instead of assigning a + replacement dict. + [#5658](https://github.com/pybind/pybind11/pull/5658) +- Properly define `_DEBUG` macro to `1` instead of defining it without + value. [#5639](https://github.com/pybind/pybind11/pull/5639) +- Fix a missing time cast causing a compile error for newer ICC. + [#5621](https://github.com/pybind/pybind11/pull/5621) +- Change the behavior of the default constructor of `py::slice` to be + equivalent to `::` in Python. + [#5620](https://github.com/pybind/pybind11/pull/5620) + +Bug fixes and features (CMake): + +- Enable FindPython mode by default, with a `COMPAT` mode that + sets some of the old variables to ease transition. + [#5553](https://github.com/pybind/pybind11/pull/5553) +- Add an author warning that auto-calculated `PYTHON_MODULE_EXTENSION` + may not respect `SETUPTOOLS_EXT_SUFFIX` during cross-compilation. + [#5495](https://github.com/pybind/pybind11/pull/5495) +- Don't strip with `CMAKE_BUILD_TYPE` None. + [#5392](https://github.com/pybind/pybind11/pull/5392) +- Fix an issue with `NO_EXTRAS` adding `pybind11::windows_extras` + anyway. [#5378](https://github.com/pybind/pybind11/pull/5378) +- Fix issue with NEW/OLD message showing up. + [#5656](https://github.com/pybind/pybind11/pull/5656) +- Use CMake's warnings as errors if available (CMake 3.24+). + [#5612](https://github.com/pybind/pybind11/pull/5612) +- Add support for running pybind11's tests via presets in CMake 3.25+. + [#5655](https://github.com/pybind/pybind11/pull/5655) and support `--fresh`. + [#5668](https://github.com/pybind/pybind11/pull/5668) +- Experimental CMake support for Android. + [#5733](https://github.com/pybind/pybind11/pull/5733) +- Presets now generate `compile_commands.json`. + [#5685](https://github.com/pybind/pybind11/pull/5685) + +Bug fixes (free-threading): + +- Fix data race in free threaded CPython when accessing a shared static + variable. [#5494](https://github.com/pybind/pybind11/pull/5494) +- A free-threading data race in `all_type_info()` was fixed. + [#5419](https://github.com/pybind/pybind11/pull/5419) +- Added exception translator specific mutex used with + `try_translate_exceptions` in the free-threaded build for internal + locking. [#5362](https://github.com/pybind/pybind11/pull/5362) + +Internals: + +- Consolidated all `PYBIND11_HAS_...` feature macros into + `pybind11/detail/common.h` to streamline backward compatibility checks and + simplify internal refactoring. This change ensures consistent macro + availability regardless of header inclusion order. + [#5647](https://github.com/pybind/pybind11/pull/5647) + +- `pybind11/gil_simple.h` was factored out from `pybind11/gil.h`, so + that it can easily be reused. + [#5614](https://github.com/pybind/pybind11/pull/5614) + +- Use CPython macros to construct `PYBIND11_VERSION_HEX`. + [#5683](https://github.com/pybind/pybind11/pull/5683) + +Documentation: + +- Improved `reference_internal` policy documentation. + [#5528](https://github.com/pybind/pybind11/pull/5528) + +- A new "Double locking, deadlocking, GIL" document was added. + [#5394](https://github.com/pybind/pybind11/pull/5394) + +- Add documenting for free-threading and subinterpreters. + [#5659](https://github.com/pybind/pybind11/pull/5659) + +Tests: + +- Download the final Catch2 2.x release if Catch download is requested. + [#5568](https://github.com/pybind/pybind11/pull/5568) + +- Explicitly used `signed char` for two numpy dtype tests. As seen when + compiling using `clang` on Linux with the `-funsigned-char` flag. + [#5545](https://github.com/pybind/pybind11/pull/5545) + +- CI testing now includes + `-Wwrite-strings -Wunreachable-code -Wpointer-arith -Wredundant-decls` + in some jobs. + [#5523](https://github.com/pybind/pybind11/pull/5523) + +- Add nightly wheels to scientific-python's nightly wheelhouse. + [#5675](https://github.com/pybind/pybind11/pull/5675) + +- Expect free-threaded warning when loading a non-free-threaded module. + [#5680](https://github.com/pybind/pybind11/pull/5680) + +- Run pytest under Python devmode. + [#5715](https://github.com/pybind/pybind11/pull/5715) + +New and removed platforms: + +- Support Python 3.14 (beta 1+). + [#5646](https://github.com/pybind/pybind11/pull/5646) + +- Added support for GraalPy Python implementation + (). + [#5380](https://github.com/pybind/pybind11/pull/5380) + +- Support and test iOS in CI. + [#5705](https://github.com/pybind/pybind11/pull/5705) + +- Support for PyPy 3.11 added. + [#5508](https://github.com/pybind/pybind11/pull/5508) + And test in ci. + [#5534](https://github.com/pybind/pybind11/pull/5534) + +- Support for PyPy 3.8 and 3.9 was dropped. + [#5578](https://github.com/pybind/pybind11/pull/5578) + +- Support for Python 3.7 was removed. (Official end-of-life: + 2023-06-27). + [#5191](https://github.com/pybind/pybind11/pull/5191) + +- Support for CMake older than 3.15 removed. CMake 3.15-4.0 supported. + [#5304](https://github.com/pybind/pybind11/pull/5304) and fix regression [#5691](https://github.com/pybind/pybind11/pull/5691). + +- Use scikit-build-core for the build backend for the PyPI `pybind11`. + The CMake generation has been moved to the sdist-\>wheel step. + `PYBIND11_GLOBAL_SDIST` has been removed. + [#5598](https://github.com/pybind/pybind11/pull/5598) and updated + docs/ci. [#5676](https://github.com/pybind/pybind11/pull/5676) + +- clang 20 tested and used for clang-tidy. + [#5692](https://github.com/pybind/pybind11/pull/5692) + +- Drop testing on MSVC 2019 (as it is being removed from GitHub). + [#5712](https://github.com/pybind/pybind11/pull/5712) + +- Support Windows C++20 and Linux C++23 in tests. + [#5707](https://github.com/pybind/pybind11/pull/5707) + +## Version 2.13.6 (September 13, 2024) + +New Features: + +- A new `self._pybind11_conduit_v1_()` method is automatically added to + all `py::class_`-wrapped types, to enable type-safe interoperability + between different independent Python/C++ bindings systems, including + pybind11 versions with different `PYBIND11_INTERNALS_VERSION`'s. + Supported on pybind11 2.11.2, 2.12.1, and 2.13.6+. + [#5296](https://github.com/pybind/pybind11/pull/5296) + +Bug fixes: + +- Using `__cpp_nontype_template_args` instead of + `__cpp_nontype_template_parameter_class`. + [#5330](https://github.com/pybind/pybind11/pull/5330) +- Properly translate C++ exception to Python exception when creating + Python buffer from wrapped object. + [#5324](https://github.com/pybind/pybind11/pull/5324) + +Documentation: + +- Adds an answer (FAQ) for "What is a highly conclusive and simple way + to find memory leaks?". + [#5340](https://github.com/pybind/pybind11/pull/5340) + +## Version 2.13.5 (August 22, 2024) + +Bug fixes: + +- Fix includes when using Windows long paths (`\\?\` prefix). + [#5321](https://github.com/pybind/pybind11/pull/5321) +- Support `-Wpedantic` in C++20 mode. + [#5322](https://github.com/pybind/pybind11/pull/5322) +- Fix and test `` support for `py::tuple` and `py::list`. + [#5314](https://github.com/pybind/pybind11/pull/5314) + +## Version 2.13.4 (August 14, 2024) + +Bug fixes: + +- Fix paths with spaces, including on Windows. (Replaces regression from + [#5302](https://github.com/pybind/pybind11/pull/5302)) + [#4874](https://github.com/pybind/pybind11/pull/4874) + +Documentation: + +- Remove repetitive words. + [#5308](https://github.com/pybind/pybind11/pull/5308) + +## Version 2.13.3 (August 13, 2024) + +Bug fixes: + +- Quote paths from pybind11-config + [#5302](https://github.com/pybind/pybind11/pull/5302) +- Fix typo in Emscripten support when in config mode (CMake) + [#5301](https://github.com/pybind/pybind11/pull/5301) + +## Version 2.13.2 (August 13, 2024) + +New Features: + +- A `pybind11::detail::type_caster_std_function_specializations` feature + was added, to support specializations for `std::function`'s with + return types that require custom to-Python conversion behavior (to + primary use case is to catch and convert exceptions). + [#4597](https://github.com/pybind/pybind11/pull/4597) + +Changes: + +- Use `PyMutex` instead of `std::mutex` for internal locking in the + free-threaded build. + [#5219](https://github.com/pybind/pybind11/pull/5219) +- Add a special type annotation for C++ empty tuple. + [#5214](https://github.com/pybind/pybind11/pull/5214) +- When compiling for WebAssembly, add the required exception flags + (CMake 3.13+). [#5298](https://github.com/pybind/pybind11/pull/5298) + +Bug fixes: + +- Make `gil_safe_call_once_and_store` thread-safe in free-threaded + CPython. [#5246](https://github.com/pybind/pybind11/pull/5246) +- A missing `#include ` in pybind11/typing.h was added to fix + build errors (in case user code does not already depend on that + include). [#5208](https://github.com/pybind/pybind11/pull/5208) +- Fix regression introduced in \#5201 for GCC\<10.3 in C++20 mode. + [#5205](https://github.com/pybind/pybind11/pull/5205) + + + +- Remove extra = when assigning flto value in the case for Clang in + CMake. [#5207](https://github.com/pybind/pybind11/pull/5207) + +Tests: + +- Adding WASM testing to our CI (Pyodide / Emscripten via + scikit-build-core). + [#4745](https://github.com/pybind/pybind11/pull/4745) +- clang-tidy (in GitHub Actions) was updated from clang 15 to clang 18. + [#5272](https://github.com/pybind/pybind11/pull/5272) + +## Version 2.13.1 (June 26, 2024) + +New Features: + +- Add support for `Typing.Callable[..., T]`. + [#5202](https://github.com/pybind/pybind11/pull/5202) + +Bug fixes: + +- Avoid aligned allocation in free-threaded build in order to support + macOS versions before 10.14. + [#5200](https://github.com/pybind/pybind11/pull/5200) + +## Version 2.13.0 (June 25, 2024) + +New Features: + +- Support free-threaded CPython (3.13t). Add `py::mod_gil_not_used()` + tag to indicate if a module supports running with the GIL disabled. + [#5148](https://github.com/pybind/pybind11/pull/5148) +- Support for Python 3.6 was removed. (Official end-of-life: + 2021-12-23). [#5177](https://github.com/pybind/pybind11/pull/5177) +- `py::list` gained a `.clear()` method. + [#5153](https://github.com/pybind/pybind11/pull/5153) + + + +- Support for `Union`, `Optional`, `type[T]`, `typing.TypeGuard`, + `typing.TypeIs`, `typing.Never`, `typing.NoReturn` and + `typing.Literal` was added to `pybind11/typing.h`. + [#5166](https://github.com/pybind/pybind11/pull/5166) + [#5165](https://github.com/pybind/pybind11/pull/5165) + [#5194](https://github.com/pybind/pybind11/pull/5194) + [#5193](https://github.com/pybind/pybind11/pull/5193) + [#5192](https://github.com/pybind/pybind11/pull/5192) + + + +- In CMake, if `PYBIND11_USE_CROSSCOMPILING` is enabled, then + `CMAKE_CROSSCOMPILING` will be respected and will keep pybind11 from + accessing the interpreter during configuration. Several CMake + variables will be required in this case, but can be deduced from the + environment variable `SETUPTOOLS_EXT_SUFFIX`. The default (currently + `OFF`) may be changed in the future. + [#5083](https://github.com/pybind/pybind11/pull/5083) + +Bug fixes: + +- A refcount bug (leading to heap-use-after-free) involving trampoline + functions with `PyObject *` return type was fixed. + [#5156](https://github.com/pybind/pybind11/pull/5156) +- Return `py::ssize_t` from `.ref_count()` instead of `int`. + [#5139](https://github.com/pybind/pybind11/pull/5139) +- A subtle bug involving C++ types with unusual `operator&` overrides + was fixed. [#5189](https://github.com/pybind/pybind11/pull/5189) +- Support Python 3.13 with minor fix, add to CI. + [#5127](https://github.com/pybind/pybind11/pull/5127) + + + +- Fix mistake affecting old cmake and old boost. + [#5149](https://github.com/pybind/pybind11/pull/5149) + +Documentation: + +- Build docs updated to feature scikit-build-core and meson-python, and + updated setuptools instructions. + [#5168](https://github.com/pybind/pybind11/pull/5168) + +Tests: + +- Avoid immortal objects in tests. + [#5150](https://github.com/pybind/pybind11/pull/5150) + +CI: + +- Compile against Python 3.13t in CI. +- Use `macos-13` (Intel) for CI jobs for now (will drop Python 3.7 + soon). [#5109](https://github.com/pybind/pybind11/pull/5109) +- Releases now have artifact attestations, visible at + . + [#5196](https://github.com/pybind/pybind11/pull/5196) + +Other: + +- Some cleanup in preparation for 3.13 support. + [#5137](https://github.com/pybind/pybind11/pull/5137) +- Avoid a warning by ensuring an iterator end check is included in + release mode. [#5129](https://github.com/pybind/pybind11/pull/5129) +- Bump max cmake to 3.29. + [#5075](https://github.com/pybind/pybind11/pull/5075) +- Update docs and noxfile. + [#5071](https://github.com/pybind/pybind11/pull/5071) + +## Version 2.12.1 (September 13, 2024) + +New Features: + +- A new `self._pybind11_conduit_v1_()` method is automatically added to + all `py::class_`-wrapped types, to enable type-safe interoperability + between different independent Python/C++ bindings systems, including + pybind11 versions with different `PYBIND11_INTERNALS_VERSION`'s. + Supported on pybind11 2.11.2, 2.12.1, and 2.13.6+. + [#5296](https://github.com/pybind/pybind11/pull/5296) + +## Version 2.12.0 (March 27, 2024) + +New Features: + +- `pybind11` now supports compiling for [NumPy + 2](https://numpy.org/devdocs/numpy_2_0_migration_guide.html). Most + code shouldn't change (see `upgrade-guide-2.12` for details). However, + if you experience issues you can define `PYBIND11_NUMPY_1_ONLY` to + disable the new support for now, but this will be removed in the + future. [#5050](https://github.com/pybind/pybind11/pull/5050) +- `pybind11/gil_safe_call_once.h` was added (it needs to be included + explicitly). The primary use case is GIL-safe initialization of C++ + `static` variables. + [#4877](https://github.com/pybind/pybind11/pull/4877) +- Support move-only iterators in `py::make_iterator`, + `py::make_key_iterator`, `py::make_value_iterator`. + [#4834](https://github.com/pybind/pybind11/pull/4834) +- Two simple `py::set_error()` functions were added and the + documentation was updated accordingly. In particular, + `py::exception<>::operator()` was deprecated (use one of the new + functions instead). The documentation for `py::exception<>` was + further updated to not suggest code that may result in undefined + behavior. [#4772](https://github.com/pybind/pybind11/pull/4772) + +Bug fixes: + +- Removes potential for Undefined Behavior during process teardown. + [#4897](https://github.com/pybind/pybind11/pull/4897) +- Improve compatibility with the nvcc compiler (especially CUDA + 12.1/12.2). [#4893](https://github.com/pybind/pybind11/pull/4893) +- `pybind11/numpy.h` now imports NumPy's `multiarray` and `_internal` + submodules with paths depending on the installed version of NumPy (for + compatibility with NumPy 2). + [#4857](https://github.com/pybind/pybind11/pull/4857) +- Builtins collections names in docstrings are now consistently rendered + in lowercase (list, set, dict, tuple), in accordance with PEP 585. + [#4833](https://github.com/pybind/pybind11/pull/4833) +- Added `py::typing::Iterator`, `py::typing::Iterable`. + [#4832](https://github.com/pybind/pybind11/pull/4832) +- Render `py::function` as `Callable` in docstring. + [#4829](https://github.com/pybind/pybind11/pull/4829) +- Also bump `PYBIND11_INTERNALS_VERSION` for MSVC, which unlocks two new + features without creating additional incompatibilities. + [#4819](https://github.com/pybind/pybind11/pull/4819) +- Guard against crashes/corruptions caused by modules built with + different MSVC versions. + [#4779](https://github.com/pybind/pybind11/pull/4779) +- A long-standing bug in the handling of Python multiple inheritance was + fixed. See PR \#4762 for the rather complex details. + [#4762](https://github.com/pybind/pybind11/pull/4762) +- Fix `bind_map` with `using` declarations. + [#4952](https://github.com/pybind/pybind11/pull/4952) +- Qualify `py::detail::concat` usage to avoid ADL selecting one from + somewhere else, such as modernjson's concat. + [#4955](https://github.com/pybind/pybind11/pull/4955) +- Use new PyCode API on Python 3.12+. + [#4916](https://github.com/pybind/pybind11/pull/4916) +- Minor cleanup from warnings reported by Clazy. + [#4988](https://github.com/pybind/pybind11/pull/4988) +- Remove typing and duplicate `class_` for + `KeysView`/`ValuesView`/`ItemsView`. + [#4985](https://github.com/pybind/pybind11/pull/4985) +- Use `PyObject_VisitManagedDict()` and `PyObject_ClearManagedDict()` on + Python 3.13 and newer. + [#4973](https://github.com/pybind/pybind11/pull/4973) +- Update `make_static_property_type()` to make it compatible with Python + 3.13. [#4971](https://github.com/pybind/pybind11/pull/4971) + + + +- Render typed iterators for `make_iterator`, `make_key_iterator`, + `make_value_iterator`. + [#4876](https://github.com/pybind/pybind11/pull/4876) +- Add several missing type name specializations. + [#5073](https://github.com/pybind/pybind11/pull/5073) +- Change docstring render for `py::buffer`, `py::sequence` and + `py::handle` (to `Buffer`, `Sequence`, `Any`). + [#4831](https://github.com/pybind/pybind11/pull/4831) +- Fixed `base_enum.__str__` docstring. + [#4827](https://github.com/pybind/pybind11/pull/4827) +- Enforce single line docstring signatures. + [#4735](https://github.com/pybind/pybind11/pull/4735) +- Special 'typed' wrappers now available in `typing.h` to annotate + tuple, dict, list, set, and function. + [#4259](https://github.com/pybind/pybind11/pull/4259) +- Create `handle_type_name` specialization to type-hint variable length + tuples. [#5051](https://github.com/pybind/pybind11/pull/5051) + + + +- Setting `PYBIND11_FINDPYTHON` to OFF will force the old FindPythonLibs + mechanism to be used. + [#5042](https://github.com/pybind/pybind11/pull/5042) +- Skip empty `PYBIND11_PYTHON_EXECUTABLE_LAST` for the first cmake run. + [#4856](https://github.com/pybind/pybind11/pull/4856) +- Fix FindPython mode exports & avoid `pkg_resources` if + `importlib.metadata` available. + [#4941](https://github.com/pybind/pybind11/pull/4941) +- `Python_ADDITIONAL_VERSIONS` (classic search) now includes 3.12. + [#4909](https://github.com/pybind/pybind11/pull/4909) +- `pybind11.pc` is now relocatable by default as long as install + destinations are not absolute paths. + [#4830](https://github.com/pybind/pybind11/pull/4830) +- Correctly detect CMake FindPython removal when used as a subdirectory. + [#4806](https://github.com/pybind/pybind11/pull/4806) +- Don't require the libs component on CMake 3.18+ when using + PYBIND11_FINDPYTHON (fixes manylinux builds). + [#4805](https://github.com/pybind/pybind11/pull/4805) +- `pybind11_strip` is no longer automatically applied when + `CMAKE_BUILD_TYPE` is unset. + [#4780](https://github.com/pybind/pybind11/pull/4780) +- Support `DEBUG_POSFIX` correctly for debug builds. + [#4761](https://github.com/pybind/pybind11/pull/4761) +- Hardcode lto/thin lto for Emscripten cross-compiles. + [#4642](https://github.com/pybind/pybind11/pull/4642) +- Upgrade maximum supported CMake version to 3.27 to fix CMP0148 + warnings. [#4786](https://github.com/pybind/pybind11/pull/4786) + +Documentation: + +- Small fix to grammar in `functions.rst`. + [#4791](https://github.com/pybind/pybind11/pull/4791) +- Remove upper bound in example pyproject.toml for setuptools. + [#4774](https://github.com/pybind/pybind11/pull/4774) + +CI: + +- CI: Update NVHPC to 23.5 and Ubuntu 20.04. + [#4764](https://github.com/pybind/pybind11/pull/4764) +- Test on PyPy 3.10. + [#4714](https://github.com/pybind/pybind11/pull/4714) + +Other: + +- Use Ruff formatter instead of Black. + [#4912](https://github.com/pybind/pybind11/pull/4912) +- An `assert()` was added to help Coverty avoid generating a false + positive. [#4817](https://github.com/pybind/pybind11/pull/4817) + +## Version 2.11.2 (September 13, 2024) + +New Features: + +- A new `self._pybind11_conduit_v1_()` method is automatically added to + all `py::class_`-wrapped types, to enable type-safe interoperability + between different independent Python/C++ bindings systems, including + pybind11 versions with different `PYBIND11_INTERNALS_VERSION`'s. + Supported on pybind11 2.11.2, 2.12.1, and 2.13.6+. + [#5296](https://github.com/pybind/pybind11/pull/5296) + +## Version 2.11.1 (July 17, 2023) + +Changes: + +- `PYBIND11_NO_ASSERT_GIL_HELD_INCREF_DECREF` is now provided as an + option for disabling the default-on `PyGILState_Check()`'s in + `pybind11::handle`'s `inc_ref()` & `dec_ref()`. + [#4753](https://github.com/pybind/pybind11/pull/4753) +- `PYBIND11_ASSERT_GIL_HELD_INCREF_DECREF` was disabled for PyPy in + general (not just PyPy Windows). + [#4751](https://github.com/pybind/pybind11/pull/4751) + +## Version 2.11.0 (July 14, 2023) + +New features: + +- The newly added `pybind11::detail::is_move_constructible` trait can be + specialized for cases in which `std::is_move_constructible` does not + work as needed. This is very similar to the long-established + `pybind11::detail::is_copy_constructible`. + [#4631](https://github.com/pybind/pybind11/pull/4631) +- Introduce `recursive_container_traits`. + [#4623](https://github.com/pybind/pybind11/pull/4623) +- `pybind11/type_caster_pyobject_ptr.h` was added to support automatic + wrapping of APIs that make use of `PyObject *`. This header needs to + included explicitly (i.e. it is not included implicitly with + `pybind/pybind11.h`). + [#4601](https://github.com/pybind/pybind11/pull/4601) +- `format_descriptor<>` & `npy_format_descriptor<>` `PyObject *` + specializations were added. The latter enables + `py::array_t` to/from-python conversions. + [#4674](https://github.com/pybind/pybind11/pull/4674) +- `buffer_info` gained an `item_type_is_equivalent_to()` member + function. [#4674](https://github.com/pybind/pybind11/pull/4674) +- The `capsule` API gained a user-friendly constructor + (`py::capsule(ptr, "name", dtor)`). + [#4720](https://github.com/pybind/pybind11/pull/4720) + +Changes: + +- `PyGILState_Check()`'s in `pybind11::handle`'s `inc_ref()` & + `dec_ref()` are now enabled by default again. + [#4246](https://github.com/pybind/pybind11/pull/4246) +- `py::initialize_interpreter()` using `PyConfig_InitPythonConfig()` + instead of `PyConfig_InitIsolatedConfig()`, to obtain complete + `sys.path`. [#4473](https://github.com/pybind/pybind11/pull/4473) +- Cast errors now always include Python type information, even if + `PYBIND11_DETAILED_ERROR_MESSAGES` is not defined. This increases + binary sizes slightly (~1.5%) but the error messages are much more + informative. [#4463](https://github.com/pybind/pybind11/pull/4463) +- The docstring generation for the `std::array`-list caster was fixed. + Previously, signatures included the size of the list in a + non-standard, non-spec compliant way. The new format conforms to + PEP 593. **Tooling for processing the docstrings may need to be + updated accordingly.** + [#4679](https://github.com/pybind/pybind11/pull/4679) +- Setter return values (which are inaccessible for all practical + purposes) are no longer converted to Python (only to be discarded). + [#4621](https://github.com/pybind/pybind11/pull/4621) +- Allow lambda specified to function definition to be `noexcept(true)` + in C++17. [#4593](https://github.com/pybind/pybind11/pull/4593) +- Get rid of recursive template instantiations for concatenating type + signatures on C++17 and higher. + [#4587](https://github.com/pybind/pybind11/pull/4587) +- Compatibility with Python 3.12 (beta). Note that the minimum pybind11 + ABI version for Python 3.12 is version 5. (The default ABI version for + Python versions up to and including 3.11 is still version 4.). + [#4570](https://github.com/pybind/pybind11/pull/4570) +- With `PYBIND11_INTERNALS_VERSION 5` (default for Python 3.12+), MSVC + builds use `std::hash` and + `std::equal_to` instead of string-based type + comparisons. This resolves issues when binding types defined in the + unnamed namespace. + [#4319](https://github.com/pybind/pybind11/pull/4319) +- Python exception `__notes__` (introduced with Python 3.11) are now + added to the `error_already_set::what()` output. + [#4678](https://github.com/pybind/pybind11/pull/4678) + +Build system improvements: + +- CMake 3.27 support was added, CMake 3.4 support was dropped. + FindPython will be used if `FindPythonInterp` is not present. + [#4719](https://github.com/pybind/pybind11/pull/4719) +- Update clang-tidy to 15 in CI. + [#4387](https://github.com/pybind/pybind11/pull/4387) +- Moved the linting framework over to Ruff. + [#4483](https://github.com/pybind/pybind11/pull/4483) +- Skip `lto` checks and target generation when + `CMAKE_INTERPROCEDURAL_OPTIMIZATION` is defined. + [#4643](https://github.com/pybind/pybind11/pull/4643) +- No longer inject `-stdlib=libc++`, not needed for modern Pythons + (macOS 10.9+). [#4639](https://github.com/pybind/pybind11/pull/4639) +- PyPy 3.10 support was added, PyPy 3.7 support was dropped. + [#4728](https://github.com/pybind/pybind11/pull/4728) +- Testing with Python 3.12 beta releases was added. + [#4713](https://github.com/pybind/pybind11/pull/4713) + +## Version 2.10.4 (Mar 16, 2023) + +Changes: + +- `python3 -m pybind11` gained a `--version` option (prints the version + and exits). [#4526](https://github.com/pybind/pybind11/pull/4526) + +Bug Fixes: + +- Fix a warning when pydebug is enabled on Python 3.11. + [#4461](https://github.com/pybind/pybind11/pull/4461) +- Ensure `gil_scoped_release` RAII is non-copyable. + [#4490](https://github.com/pybind/pybind11/pull/4490) +- Ensure the tests dir does not show up with new versions of setuptools. + [#4510](https://github.com/pybind/pybind11/pull/4510) +- Better stacklevel for a warning in setuptools helpers. + [#4516](https://github.com/pybind/pybind11/pull/4516) + +## Version 2.10.3 (Jan 3, 2023) + +Changes: + +- Temporarily made our GIL status assertions (added in 2.10.2) disabled + by default (re-enable manually by defining + `PYBIND11_ASSERT_GIL_HELD_INCREF_DECREF`, will be enabled in 2.11). + [#4432](https://github.com/pybind/pybind11/pull/4432) +- Improved error messages when `inc_ref`/`dec_ref` are called with an + invalid GIL state. + [#4427](https://github.com/pybind/pybind11/pull/4427) + [#4436](https://github.com/pybind/pybind11/pull/4436) + +Bug Fixes: + +- Some minor touchups found by static analyzers. + [#4440](https://github.com/pybind/pybind11/pull/4440) + +## Version 2.10.2 (Dec 20, 2022) + +Changes: + +- `scoped_interpreter` constructor taking `PyConfig`. + [#4330](https://github.com/pybind/pybind11/pull/4330) +- `pybind11/eigen/tensor.h` adds converters to and from `Eigen::Tensor` + and `Eigen::TensorMap`. + [#4201](https://github.com/pybind/pybind11/pull/4201) +- `PyGILState_Check()`'s were integrated to `pybind11::handle` + `inc_ref()` & `dec_ref()`. The added GIL checks are guarded by + `PYBIND11_ASSERT_GIL_HELD_INCREF_DECREF`, which is the default only if + `NDEBUG` is not defined. (Made non-default in 2.10.3, will be active + in 2.11) [#4246](https://github.com/pybind/pybind11/pull/4246) +- Add option for enable/disable enum members in docstring. + [#2768](https://github.com/pybind/pybind11/pull/2768) +- Fixed typing of `KeysView`, `ValuesView` and `ItemsView` in + `bind_map`. [#4353](https://github.com/pybind/pybind11/pull/4353) + +Bug fixes: + +- Bug fix affecting only Python 3.6 under very specific, uncommon + conditions: move `PyEval_InitThreads()` call to the correct location. + [#4350](https://github.com/pybind/pybind11/pull/4350) +- Fix segfault bug when passing foreign native functions to + functional.h. [#4254](https://github.com/pybind/pybind11/pull/4254) + +Build system improvements: + +- Support setting PYTHON_LIBRARIES manually for Windows ARM + cross-compilation (classic mode). + [#4406](https://github.com/pybind/pybind11/pull/4406) +- Extend IPO/LTO detection for ICX (a.k.a IntelLLVM) compiler. + [#4402](https://github.com/pybind/pybind11/pull/4402) +- Allow calling `find_package(pybind11 CONFIG)` multiple times from + separate directories in the same CMake project and properly link + Python (new mode). + [#4401](https://github.com/pybind/pybind11/pull/4401) +- `multiprocessing_set_spawn` in pytest fixture for added safety. + [#4377](https://github.com/pybind/pybind11/pull/4377) +- Fixed a bug in two pybind11/tools cmake scripts causing "Unknown + arguments specified" errors. + [#4327](https://github.com/pybind/pybind11/pull/4327) + +## Version 2.10.1 (Oct 31, 2022) + +This is the first version to fully support embedding the newly released +Python 3.11. + +Changes: + +- Allow `pybind11::capsule` constructor to take null destructor + pointers. [#4221](https://github.com/pybind/pybind11/pull/4221) +- `embed.h` was changed so that `PYTHONPATH` is used also with Python + 3.11 (established behavior). + [#4119](https://github.com/pybind/pybind11/pull/4119) +- A `PYBIND11_SIMPLE_GIL_MANAGEMENT` option was added (cmake, C++ + define), along with many additional tests in `test_gil_scoped.py`. The + option may be useful to try when debugging GIL-related issues, to + determine if the more complex default implementation is or is not to + blame. See \#4216 for background. WARNING: Please be careful to not + create ODR violations when using the option: everything that is linked + together with mutual symbol visibility needs to be rebuilt. + [#4216](https://github.com/pybind/pybind11/pull/4216) +- `PYBIND11_EXPORT_EXCEPTION` was made non-empty only under macOS. This + makes Linux builds safer, and enables the removal of warning + suppression pragmas for Windows. + [#4298](https://github.com/pybind/pybind11/pull/4298) + +Bug fixes: + +- Fixed a bug where `UnicodeDecodeError` was not propagated from various + `py::str` ctors when decoding surrogate utf characters. + [#4294](https://github.com/pybind/pybind11/pull/4294) +- Revert perfect forwarding for `make_iterator`. This broke at least one + valid use case. May revisit later. + [#4234](https://github.com/pybind/pybind11/pull/4234) +- Fix support for safe casts to `void*` (regression in 2.10.0). + [#4275](https://github.com/pybind/pybind11/pull/4275) +- Fix `char8_t` support (regression in 2.9). + [#4278](https://github.com/pybind/pybind11/pull/4278) +- Unicode surrogate character in Python exception message leads to + process termination in `error_already_set::what()`. + [#4297](https://github.com/pybind/pybind11/pull/4297) +- Fix MSVC 2019 v.1924 & C++14 mode error for `overload_cast`. + [#4188](https://github.com/pybind/pybind11/pull/4188) +- Make augmented assignment operators non-const for the object-api. + Behavior was previously broken for augmented assignment operators. + [#4065](https://github.com/pybind/pybind11/pull/4065) +- Add proper error checking to C++ bindings for Python list append and + insert. [#4208](https://github.com/pybind/pybind11/pull/4208) +- Work-around for Nvidia's CUDA nvcc compiler in versions 11.4.0 - + 11.8.0. [#4220](https://github.com/pybind/pybind11/pull/4220) +- A workaround for PyPy was added in the `py::error_already_set` + implementation, related to PR + [#1895](https://github.com/pybind/pybind11/pull/1895) released with + v2.10.0. [#4079](https://github.com/pybind/pybind11/pull/4079) +- Fixed compiler errors when C++23 `std::forward_like` is available. + [#4136](https://github.com/pybind/pybind11/pull/4136) +- Properly raise exceptions in contains methods (like when an object in + unhashable). [#4209](https://github.com/pybind/pybind11/pull/4209) +- Further improve another error in exception handling. + [#4232](https://github.com/pybind/pybind11/pull/4232) +- `get_local_internals()` was made compatible with + `finalize_interpreter()`, fixing potential freezes during interpreter + finalization. [#4192](https://github.com/pybind/pybind11/pull/4192) + +Performance and style: + +- Reserve space in set and STL map casters if possible. This will + prevent unnecessary rehashing / resizing by knowing the number of keys + ahead of time for Python to C++ casting. This improvement will greatly + speed up the casting of large unordered maps and sets. + [#4194](https://github.com/pybind/pybind11/pull/4194) +- GIL RAII scopes are non-copyable to avoid potential bugs. + [#4183](https://github.com/pybind/pybind11/pull/4183) +- Explicitly default all relevant ctors for pytypes in the + `PYBIND11_OBJECT` macros and enforce the clang-tidy checks + `modernize-use-equals-default` in macros as well. + [#4017](https://github.com/pybind/pybind11/pull/4017) +- Optimize iterator advancement in C++ bindings. + [#4237](https://github.com/pybind/pybind11/pull/4237) +- Use the modern `PyObject_GenericGetDict` and `PyObject_GenericSetDict` + for handling dynamic attribute dictionaries. + [#4106](https://github.com/pybind/pybind11/pull/4106) +- Document that users should use `PYBIND11_NAMESPACE` instead of using + `pybind11` when opening namespaces. Using namespace declarations and + namespace qualification remain the same as `pybind11`. This is done to + ensure consistent symbol visibility. + [#4098](https://github.com/pybind/pybind11/pull/4098) +- Mark `detail::forward_like` as constexpr. + [#4147](https://github.com/pybind/pybind11/pull/4147) +- Optimize unpacking_collector when processing `arg_v` arguments. + [#4219](https://github.com/pybind/pybind11/pull/4219) +- Optimize casting C++ object to `None`. + [#4269](https://github.com/pybind/pybind11/pull/4269) + +Build system improvements: + +- CMake: revert overwrite behavior, now opt-in with + `PYBIND11_PYTHONLIBS_OVERRWRITE OFF`. + [#4195](https://github.com/pybind/pybind11/pull/4195) +- Include a pkg-config file when installing pybind11, such as in the + Python package. [#4077](https://github.com/pybind/pybind11/pull/4077) +- Avoid stripping debug symbols when `CMAKE_BUILD_TYPE` is set to + `DEBUG` instead of `Debug`. + [#4078](https://github.com/pybind/pybind11/pull/4078) +- Followup to [#3948](https://github.com/pybind/pybind11/pull/3948), + fixing vcpkg again. + [#4123](https://github.com/pybind/pybind11/pull/4123) + +## Version 2.10.0 (Jul 15, 2022) + +Removed support for Python 2.7, Python 3.5, and MSVC 2015. Support for +MSVC 2017 is limited due to availability of CI runners; we highly +recommend MSVC 2019 or 2022 be used. Initial support added for Python +3.11. + +New features: + +- `py::anyset` & `py::frozenset` were added, with copying (cast) to + `std::set` (similar to `set`). + [#3901](https://github.com/pybind/pybind11/pull/3901) +- Support bytearray casting to string. + [#3707](https://github.com/pybind/pybind11/pull/3707) +- `type_caster` was added. `std::monostate` is a tag + type that allows `std::variant` to act as an optional, or allows + default construction of a `std::variant` holding a non-default + constructible type. + [#3818](https://github.com/pybind/pybind11/pull/3818) +- `pybind11::capsule::set_name` added to mutate the name of the capsule + instance. [#3866](https://github.com/pybind/pybind11/pull/3866) +- NumPy: dtype constructor from type number added, accessors + corresponding to Python API `dtype.num`, `dtype.byteorder`, + `dtype.flags` and `dtype.alignment` added. + [#3868](https://github.com/pybind/pybind11/pull/3868) + +Changes: + +- Python 3.6 is now the minimum supported version. + [#3688](https://github.com/pybind/pybind11/pull/3688) + [#3719](https://github.com/pybind/pybind11/pull/3719) +- The minimum version for MSVC is now 2017. + [#3722](https://github.com/pybind/pybind11/pull/3722) +- Fix issues with CPython 3.11 betas and add to supported test matrix. + [#3923](https://github.com/pybind/pybind11/pull/3923) +- `error_already_set` is now safer and more performant, especially for + exceptions with long tracebacks, by delaying computation. + [#1895](https://github.com/pybind/pybind11/pull/1895) +- Improve exception handling in python `str` bindings. + [#3826](https://github.com/pybind/pybind11/pull/3826) +- The bindings for capsules now have more consistent exception handling. + [#3825](https://github.com/pybind/pybind11/pull/3825) +- `PYBIND11_OBJECT_CVT` and `PYBIND11_OBJECT_CVT_DEFAULT` macro can now + be used to define classes in namespaces other than pybind11. + [#3797](https://github.com/pybind/pybind11/pull/3797) +- Error printing code now uses `PYBIND11_DETAILED_ERROR_MESSAGES` + instead of requiring `NDEBUG`, allowing use with release builds if + desired. [#3913](https://github.com/pybind/pybind11/pull/3913) +- Implicit conversion of the literal `0` to `pybind11::handle` is now + disabled. [#4008](https://github.com/pybind/pybind11/pull/4008) + +Bug fixes: + +- Fix exception handling when `pybind11::weakref()` fails. + [#3739](https://github.com/pybind/pybind11/pull/3739) +- `module_::def_submodule` was missing proper error handling. This is + fixed now. [#3973](https://github.com/pybind/pybind11/pull/3973) +- The behavior or `error_already_set` was made safer and the highly + opaque "Unknown internal error occurred" message was replaced with a + more helpful message. + [#3982](https://github.com/pybind/pybind11/pull/3982) +- `error_already_set::what()` now handles non-normalized exceptions + correctly. [#3971](https://github.com/pybind/pybind11/pull/3971) +- Support older C++ compilers where filesystem is not yet part of the + standard library and is instead included in + `std::experimental::filesystem`. + [#3840](https://github.com/pybind/pybind11/pull/3840) +- Fix `-Wfree-nonheap-object` warnings produced by GCC by avoiding + returning pointers to static objects with + `return_value_policy::take_ownership`. + [#3946](https://github.com/pybind/pybind11/pull/3946) +- Fix cast from pytype rvalue to another pytype. + [#3949](https://github.com/pybind/pybind11/pull/3949) +- Ensure proper behavior when garbage collecting classes with dynamic + attributes in Python \>=3.9. + [#4051](https://github.com/pybind/pybind11/pull/4051) +- A couple long-standing `PYBIND11_NAMESPACE` + `__attribute__((visibility("hidden")))` inconsistencies are now fixed + (affects only unusual environments). + [#4043](https://github.com/pybind/pybind11/pull/4043) +- `pybind11::detail::get_internals()` is now resilient to in-flight + Python exceptions. + [#3981](https://github.com/pybind/pybind11/pull/3981) +- Arrays with a dimension of size 0 are now properly converted to + dynamic Eigen matrices (more common in NumPy 1.23). + [#4038](https://github.com/pybind/pybind11/pull/4038) +- Avoid catching unrelated errors when importing NumPy. + [#3974](https://github.com/pybind/pybind11/pull/3974) + +Performance and style: + +- Added an accessor overload of `(object &&key)` to reference steal the + object when using python types as keys. This prevents unnecessary + reference count overhead for attr, dictionary, tuple, and sequence + look ups. Added additional regression tests. Fixed a performance bug + the caused accessor assignments to potentially perform unnecessary + copies. [#3970](https://github.com/pybind/pybind11/pull/3970) +- Perfect forward all args of `make_iterator`. + [#3980](https://github.com/pybind/pybind11/pull/3980) +- Avoid potential bug in pycapsule destructor by adding an `error_guard` + to one of the dtors. + [#3958](https://github.com/pybind/pybind11/pull/3958) +- Optimize dictionary access in `strip_padding` for numpy. + [#3994](https://github.com/pybind/pybind11/pull/3994) +- `stl_bind.h` bindings now take slice args as a const-ref. + [#3852](https://github.com/pybind/pybind11/pull/3852) +- Made slice constructor more consistent, and improve performance of + some casters by allowing reference stealing. + [#3845](https://github.com/pybind/pybind11/pull/3845) +- Change numpy dtype from_args method to use const ref. + [#3878](https://github.com/pybind/pybind11/pull/3878) +- Follow rule of three to ensure `PyErr_Restore` is called only once. + [#3872](https://github.com/pybind/pybind11/pull/3872) +- Added missing perfect forwarding for `make_iterator` functions. + [#3860](https://github.com/pybind/pybind11/pull/3860) +- Optimize c++ to python function casting by using the rvalue caster. + [#3966](https://github.com/pybind/pybind11/pull/3966) +- Optimize Eigen sparse matrix casting by removing unnecessary + temporary. [#4064](https://github.com/pybind/pybind11/pull/4064) +- Avoid potential implicit copy/assignment constructors causing double + free in `strdup_gaurd`. + [#3905](https://github.com/pybind/pybind11/pull/3905) +- Enable clang-tidy checks `misc-definitions-in-headers`, + `modernize-loop-convert`, and `modernize-use-nullptr`. + [#3881](https://github.com/pybind/pybind11/pull/3881) + [#3988](https://github.com/pybind/pybind11/pull/3988) + +Build system improvements: + +- CMake: Fix file extension on Windows with cp36 and cp37 using + FindPython. [#3919](https://github.com/pybind/pybind11/pull/3919) +- CMake: Support multiple Python targets (such as on vcpkg). + [#3948](https://github.com/pybind/pybind11/pull/3948) +- CMake: Fix issue with NVCC on Windows. + [#3947](https://github.com/pybind/pybind11/pull/3947) +- CMake: Drop the bitness check on cross compiles (like targeting + WebAssembly via Emscripten). + [#3959](https://github.com/pybind/pybind11/pull/3959) +- Add MSVC builds in debug mode to CI. + [#3784](https://github.com/pybind/pybind11/pull/3784) +- MSVC 2022 C++20 coverage was added to GitHub Actions, including Eigen. + [#3732](https://github.com/pybind/pybind11/pull/3732), + [#3741](https://github.com/pybind/pybind11/pull/3741) + +Backend and tidying up: + +- New theme for the documentation. + [#3109](https://github.com/pybind/pybind11/pull/3109) +- Remove idioms in code comments. Use more inclusive language. + [#3809](https://github.com/pybind/pybind11/pull/3809) +- `#include ` was removed from the `pybind11/stl.h` header. + Your project may break if it has a transitive dependency on this + include. The fix is to "Include What You Use". + [#3928](https://github.com/pybind/pybind11/pull/3928) +- Avoid `setup.py ` usage in internal tests. + [#3734](https://github.com/pybind/pybind11/pull/3734) + +## Version 2.9.2 (Mar 29, 2022) + +Changes: + +- Enum now has an `__index__` method on Python \<3.8 too. + [#3700](https://github.com/pybind/pybind11/pull/3700) +- Local internals are now cleared after finalizing the interpreter. + [#3744](https://github.com/pybind/pybind11/pull/3744) + +Bug fixes: + +- Better support for Python 3.11 alphas. + [#3694](https://github.com/pybind/pybind11/pull/3694) +- `PYBIND11_TYPE_CASTER` now uses fully qualified symbols, so it can be + used outside of `pybind11::detail`. + [#3758](https://github.com/pybind/pybind11/pull/3758) +- Some fixes for PyPy 3.9. + [#3768](https://github.com/pybind/pybind11/pull/3768) +- Fixed a potential memleak in PyPy in `get_type_override`. + [#3774](https://github.com/pybind/pybind11/pull/3774) +- Fix usage of `VISIBILITY_INLINES_HIDDEN`. + [#3721](https://github.com/pybind/pybind11/pull/3721) + +Build system improvements: + +- Uses `sysconfig` module to determine installation locations on Python + \>= 3.10, instead of `distutils` which has been deprecated. + [#3764](https://github.com/pybind/pybind11/pull/3764) +- Support Catch 2.13.5+ (supporting GLIBC 2.34+). + [#3679](https://github.com/pybind/pybind11/pull/3679) +- Fix test failures with numpy 1.22 by ignoring whitespace when + comparing `str()` of dtypes. + [#3682](https://github.com/pybind/pybind11/pull/3682) + +Backend and tidying up: + +- clang-tidy: added `readability-qualified-auto`, + `readability-braces-around-statements`, + `cppcoreguidelines-prefer-member-initializer`, + `clang-analyzer-optin.performance.Padding`, + `cppcoreguidelines-pro-type-static-cast-downcast`, and + `readability-inconsistent-declaration-parameter-name`. + [#3702](https://github.com/pybind/pybind11/pull/3702), + [#3699](https://github.com/pybind/pybind11/pull/3699), + [#3716](https://github.com/pybind/pybind11/pull/3716), + [#3709](https://github.com/pybind/pybind11/pull/3709) +- clang-format was added to the pre-commit actions, and the entire code + base automatically reformatted (after several iterations preparing for + this leap). [#3713](https://github.com/pybind/pybind11/pull/3713) + +## Version 2.9.1 (Feb 2, 2022) + +Changes: + +- If possible, attach Python exception with `py::raise_from` to + `TypeError` when casting from C++ to Python. This will give additional + info if Python exceptions occur in the caster. Adds a test case of + trying to convert a set from C++ to Python when the hash function is + not defined in Python. + [#3605](https://github.com/pybind/pybind11/pull/3605) +- Add a mapping of C++11 nested exceptions to their Python exception + equivalent using `py::raise_from`. This attaches the nested exceptions + in Python using the `__cause__` field. + [#3608](https://github.com/pybind/pybind11/pull/3608) +- Propagate Python exception traceback using `raise_from` if a pybind11 + function runs out of overloads. + [#3671](https://github.com/pybind/pybind11/pull/3671) +- `py::multiple_inheritance` is now only needed when C++ bases are + hidden from pybind11. + [#3650](https://github.com/pybind/pybind11/pull/3650) and + [#3659](https://github.com/pybind/pybind11/pull/3659) + +Bug fixes: + +- Remove a boolean cast in `numpy.h` that causes MSVC C4800 warnings + when compiling against Python 3.10 or newer. + [#3669](https://github.com/pybind/pybind11/pull/3669) +- Render `py::bool_` and `py::float_` as `bool` and `float` + respectively. [#3622](https://github.com/pybind/pybind11/pull/3622) + +Build system improvements: + +- Fix CMake extension suffix computation on Python 3.10+. + [#3663](https://github.com/pybind/pybind11/pull/3663) +- Allow `CMAKE_ARGS` to override CMake args in pybind11's own + `setup.py`. [#3577](https://github.com/pybind/pybind11/pull/3577) +- Remove a few deprecated c-headers. + [#3610](https://github.com/pybind/pybind11/pull/3610) +- More uniform handling of test targets. + [#3590](https://github.com/pybind/pybind11/pull/3590) +- Add clang-tidy readability check to catch potentially swapped function + args. [#3611](https://github.com/pybind/pybind11/pull/3611) + +## Version 2.9.0 (Dec 28, 2021) + +This is the last version to support Python 2.7 and 3.5. + +New Features: + +- Allow `py::args` to be followed by other arguments; the remaining + arguments are implicitly keyword-only, as if a `py::kw_only{}` + annotation had been used. + [#3402](https://github.com/pybind/pybind11/pull/3402) + +Changes: + +- Make str/bytes/memoryview more interoperable with `std::string_view`. + [#3521](https://github.com/pybind/pybind11/pull/3521) +- Replace `_` with `const_name` in internals, avoid defining `pybind::_` + if `_` defined as macro (common gettext usage) + [#3423](https://github.com/pybind/pybind11/pull/3423) + +Bug fixes: + +- Fix a rare warning about extra copy in an Eigen constructor. + [#3486](https://github.com/pybind/pybind11/pull/3486) +- Fix caching of the C++ overrides. + [#3465](https://github.com/pybind/pybind11/pull/3465) +- Add missing `std::forward` calls to some `cpp_function` overloads. + [#3443](https://github.com/pybind/pybind11/pull/3443) +- Support PyPy 7.3.7 and the PyPy3.8 beta. Test python-3.11 on PRs with + the `python dev` label. + [#3419](https://github.com/pybind/pybind11/pull/3419) +- Replace usage of deprecated `Eigen::MappedSparseMatrix` with + `Eigen::Map>` for Eigen 3.3+. + [#3499](https://github.com/pybind/pybind11/pull/3499) +- Tweaks to support Microsoft Visual Studio 2022. + [#3497](https://github.com/pybind/pybind11/pull/3497) + +Build system improvements: + +- Nicer CMake printout and IDE organisation for pybind11's own tests. + [#3479](https://github.com/pybind/pybind11/pull/3479) +- CMake: report version type as part of the version string to avoid a + spurious space in the package status message. + [#3472](https://github.com/pybind/pybind11/pull/3472) +- Flags starting with `-g` in `$CFLAGS` and `$CPPFLAGS` are no longer + overridden by `.Pybind11Extension`. + [#3436](https://github.com/pybind/pybind11/pull/3436) +- Ensure ThreadPool is closed in `setup_helpers`. + [#3548](https://github.com/pybind/pybind11/pull/3548) +- Avoid LTS on `mips64` and `ppc64le` (reported broken). + [#3557](https://github.com/pybind/pybind11/pull/3557) + +## v2.8.1 (Oct 27, 2021) + +Changes and additions: + +- The simple namespace creation shortcut added in 2.8.0 was deprecated + due to usage of CPython internal API, and will be removed soon. Use + `py::module_::import("types").attr("SimpleNamespace")`. + [#3374](https://github.com/pybinyyd/pybind11/pull/3374) +- Add C++ Exception type to throw and catch `AttributeError`. Useful for + defining custom `__setattr__` and `__getattr__` methods. + [#3387](https://github.com/pybind/pybind11/pull/3387) + +Fixes: + +- Fixed the potential for dangling references when using properties with + `std::optional` types. + [#3376](https://github.com/pybind/pybind11/pull/3376) +- Modernize usage of `PyCodeObject` on Python 3.9+ (moving toward + support for Python 3.11a1) + [#3368](https://github.com/pybind/pybind11/pull/3368) +- A long-standing bug in `eigen.h` was fixed (originally PR \#3343). The + bug was unmasked by newly added `static_assert`'s in the Eigen 3.4.0 + release. [#3352](https://github.com/pybind/pybind11/pull/3352) +- Support multiple raw inclusion of CMake helper files (Conan.io does + this for multi-config generators). + [#3420](https://github.com/pybind/pybind11/pull/3420) +- Fix harmless warning on upcoming CMake 3.22. + [#3368](https://github.com/pybind/pybind11/pull/3368) +- Fix 2.8.0 regression with MSVC 2017 + C++17 mode + Python 3. + [#3407](https://github.com/pybind/pybind11/pull/3407) +- Fix 2.8.0 regression that caused undefined behavior (typically + segfaults) in `make_key_iterator`/`make_value_iterator` if + dereferencing the iterator returned a temporary value instead of a + reference. [#3348](https://github.com/pybind/pybind11/pull/3348) + +## v2.8.0 (Oct 4, 2021) + +New features: + +- Added `py::raise_from` to enable chaining exceptions. + [#3215](https://github.com/pybind/pybind11/pull/3215) +- Allow exception translators to be optionally registered local to a + module instead of applying globally across all pybind11 modules. Use + `register_local_exception_translator(ExceptionTranslator&& translator)` + instead of + `register_exception_translator(ExceptionTranslator&& translator)` to + keep your exception remapping code local to the module. + [#2650](https://github.com/pybinyyd/pybind11/pull/2650) +- Add `make_simple_namespace` function for instantiating Python + `SimpleNamespace` objects. **Deprecated in 2.8.1.** + [#2840](https://github.com/pybind/pybind11/pull/2840) +- `pybind11::scoped_interpreter` and `initialize_interpreter` have new + arguments to allow `sys.argv` initialization. + [#2341](https://github.com/pybind/pybind11/pull/2341) +- Allow Python builtins to be used as callbacks in CPython. + [#1413](https://github.com/pybind/pybind11/pull/1413) +- Added `view` to view arrays with a different datatype. + [#987](https://github.com/pybind/pybind11/pull/987) +- Implemented `reshape` on arrays. + [#984](https://github.com/pybind/pybind11/pull/984) +- Enable defining custom `__new__` methods on classes by fixing bug + preventing overriding methods if they have non-pybind11 siblings. + [#3265](https://github.com/pybind/pybind11/pull/3265) +- Add `make_value_iterator()`, and fix `make_key_iterator()` to return + references instead of copies. + [#3293](https://github.com/pybind/pybind11/pull/3293) +- Improve the classes generated by `bind_map`: + [#3310](https://github.com/pybind/pybind11/pull/3310) + - Change `.items` from an iterator to a dictionary view. + - Add `.keys` and `.values` (both dictionary views). + - Allow `__contains__` to take any object. +- `pybind11::custom_type_setup` was added, for customizing the + `PyHeapTypeObject` corresponding to a class, which may be useful for + enabling garbage collection support, among other things. + [#3287](https://github.com/pybind/pybind11/pull/3287) + +Changes: + +- Set `__file__` constant when running `eval_file` in an embedded + interpreter. [#3233](https://github.com/pybind/pybind11/pull/3233) +- Python objects and (C++17) `std::optional` now accepted in `py::slice` + constructor. [#1101](https://github.com/pybind/pybind11/pull/1101) +- The pybind11 proxy types `str`, `bytes`, `bytearray`, `tuple`, `list` + now consistently support passing `ssize_t` values for sizes and + indexes. Previously, only `size_t` was accepted in several interfaces. + [#3219](https://github.com/pybind/pybind11/pull/3219) +- Avoid evaluating `PYBIND11_TLS_REPLACE_VALUE` arguments more than + once. [#3290](https://github.com/pybind/pybind11/pull/3290) + +Fixes: + +- Bug fix: enum value's `__int__` returning non-int when underlying type + is bool or of char type. + [#1334](https://github.com/pybind/pybind11/pull/1334) +- Fixes bug in setting error state in Capsule's pointer methods. + [#3261](https://github.com/pybind/pybind11/pull/3261) +- A long-standing memory leak in `py::cpp_function::initialize` was + fixed. [#3229](https://github.com/pybind/pybind11/pull/3229) +- Fixes thread safety for some `pybind11::type_caster` which require + lifetime extension, such as for `std::string_view`. + [#3237](https://github.com/pybind/pybind11/pull/3237) +- Restore compatibility with gcc 4.8.4 as distributed by ubuntu-trusty, + linuxmint-17. [#3270](https://github.com/pybind/pybind11/pull/3270) + +Build system improvements: + +- Fix regression in CMake Python package config: improper use of + absolute path. [#3144](https://github.com/pybind/pybind11/pull/3144) +- Cached Python version information could become stale when CMake was + re-run with a different Python version. The build system now detects + this and updates this information. + [#3299](https://github.com/pybind/pybind11/pull/3299) +- Specified UTF8-encoding in setup.py calls of open(). + [#3137](https://github.com/pybind/pybind11/pull/3137) +- Fix a harmless warning from CMake 3.21 with the classic Python + discovery. [#3220](https://github.com/pybind/pybind11/pull/3220) +- Eigen repo and version can now be specified as cmake options. + [#3324](https://github.com/pybind/pybind11/pull/3324) + +Backend and tidying up: + +- Reduced thread-local storage required for keeping alive temporary data + for type conversion to one key per ABI version, rather than one key + per extension module. This makes the total thread-local storage + required by pybind11 2 keys per ABI version. + [#3275](https://github.com/pybind/pybind11/pull/3275) +- Optimize NumPy array construction with additional moves. + [#3183](https://github.com/pybind/pybind11/pull/3183) +- Conversion to `std::string` and `std::string_view` now avoids making + an extra copy of the data on Python \>= 3.3. + [#3257](https://github.com/pybind/pybind11/pull/3257) +- Remove const modifier from certain C++ methods on Python collections + (`list`, `set`, `dict`) such as (`clear()`, `append()`, `insert()`, + etc...) and annotated them with `py-non-const`. +- Enable readability `clang-tidy-const-return` and remove useless + consts. [#3254](https://github.com/pybind/pybind11/pull/3254) + [#3194](https://github.com/pybind/pybind11/pull/3194) +- The clang-tidy `google-explicit-constructor` option was enabled. + [#3250](https://github.com/pybind/pybind11/pull/3250) +- Mark a pytype move constructor as noexcept (perf). + [#3236](https://github.com/pybind/pybind11/pull/3236) +- Enable clang-tidy check to guard against inheritance slicing. + [#3210](https://github.com/pybind/pybind11/pull/3210) +- Legacy warning suppression pragma were removed from eigen.h. On Unix + platforms, please use -isystem for Eigen include directories, to + suppress compiler warnings originating from Eigen headers. Note that + CMake does this by default. No adjustments are needed for Windows. + [#3198](https://github.com/pybind/pybind11/pull/3198) +- Format pybind11 with isort consistent ordering of imports + [#3195](https://github.com/pybind/pybind11/pull/3195) +- The warnings-suppression "pragma clamp" at the top/bottom of pybind11 + was removed, clearing the path to refactoring and IWYU cleanup. + [#3186](https://github.com/pybind/pybind11/pull/3186) +- Enable most bugprone checks in clang-tidy and fix the found potential + bugs and poor coding styles. + [#3166](https://github.com/pybind/pybind11/pull/3166) +- Add `clang-tidy-readability` rules to make boolean casts explicit + improving code readability. Also enabled other misc and readability + clang-tidy checks. + [#3148](https://github.com/pybind/pybind11/pull/3148) +- Move object in `.pop()` for list. + [#3116](https://github.com/pybind/pybind11/pull/3116) + +## v2.7.1 (Aug 3, 2021) + +Minor missing functionality added: + +- Allow Python builtins to be used as callbacks in CPython. + [#1413](https://github.com/pybind/pybind11/pull/1413) + +Bug fixes: + +- Fix regression in CMake Python package config: improper use of + absolute path. [#3144](https://github.com/pybind/pybind11/pull/3144) +- Fix Mingw64 and add to the CI testing matrix. + [#3132](https://github.com/pybind/pybind11/pull/3132) +- Specified UTF8-encoding in setup.py calls of open(). + [#3137](https://github.com/pybind/pybind11/pull/3137) +- Add clang-tidy-readability rules to make boolean casts explicit + improving code readability. Also enabled other misc and readability + clang-tidy checks. + [#3148](https://github.com/pybind/pybind11/pull/3148) +- Move object in `.pop()` for list. + [#3116](https://github.com/pybind/pybind11/pull/3116) + +Backend and tidying up: + +- Removed and fixed warning suppressions. + [#3127](https://github.com/pybind/pybind11/pull/3127) + [#3129](https://github.com/pybind/pybind11/pull/3129) + [#3135](https://github.com/pybind/pybind11/pull/3135) + [#3141](https://github.com/pybind/pybind11/pull/3141) + [#3142](https://github.com/pybind/pybind11/pull/3142) + [#3150](https://github.com/pybind/pybind11/pull/3150) + [#3152](https://github.com/pybind/pybind11/pull/3152) + [#3160](https://github.com/pybind/pybind11/pull/3160) + [#3161](https://github.com/pybind/pybind11/pull/3161) + +## v2.7.0 (Jul 16, 2021) + +New features: + +- Enable `py::implicitly_convertible` for + `py::class_`-wrapped types. + [#3059](https://github.com/pybind/pybind11/pull/3059) +- Allow function pointer extraction from overloaded functions. + [#2944](https://github.com/pybind/pybind11/pull/2944) +- NumPy: added `.char_()` to type which gives the NumPy public `char` + result, which also distinguishes types by bit length (unlike + `.kind()`). [#2864](https://github.com/pybind/pybind11/pull/2864) +- Add `pybind11::bytearray` to manipulate `bytearray` similar to + `bytes`. [#2799](https://github.com/pybind/pybind11/pull/2799) +- `pybind11/stl/filesystem.h` registers a type caster that, on + C++17/Python 3.6+, converts `std::filesystem::path` to `pathlib.Path` + and any `os.PathLike` to `std::filesystem::path`. + [#2730](https://github.com/pybind/pybind11/pull/2730) +- A `PYBIND11_VERSION_HEX` define was added, similar to + `PY_VERSION_HEX`. + [#3120](https://github.com/pybind/pybind11/pull/3120) + +Changes: + +- `py::str` changed to exclusively hold `PyUnicodeObject`. Previously + `py::str` could also hold `bytes`, which is probably surprising, was + never documented, and can mask bugs (e.g. accidental use of `py::str` + instead of `py::bytes`). + [#2409](https://github.com/pybind/pybind11/pull/2409) +- Add a safety guard to ensure that the Python GIL is held when C++ + calls back into Python via `object_api<>::operator()` (e.g. + `py::function` `__call__`). (This feature is available for Python 3.6+ + only.) [#2919](https://github.com/pybind/pybind11/pull/2919) +- Catch a missing `self` argument in calls to `__init__()`. + [#2914](https://github.com/pybind/pybind11/pull/2914) +- Use `std::string_view` if available to avoid a copy when passing an + object to a `std::ostream`. + [#3042](https://github.com/pybind/pybind11/pull/3042) +- An important warning about thread safety was added to the `iostream.h` + documentation; attempts to make `py::scoped_ostream_redirect` thread + safe have been removed, as it was only partially effective. + [#2995](https://github.com/pybind/pybind11/pull/2995) + +Fixes: + +- Performance: avoid unnecessary strlen calls. + [#3058](https://github.com/pybind/pybind11/pull/3058) +- Fix auto-generated documentation string when using `const T` in + `pyarray_t`. [#3020](https://github.com/pybind/pybind11/pull/3020) +- Unify error messages thrown by + `simple_collector`/`unpacking_collector`. + [#3013](https://github.com/pybind/pybind11/pull/3013) +- `pybind11::builtin_exception` is now explicitly exported, which means + the types included/defined in different modules are identical, and + exceptions raised in different modules can be caught correctly. The + documentation was updated to explain that custom exceptions that are + used across module boundaries need to be explicitly exported as well. + [#2999](https://github.com/pybind/pybind11/pull/2999) +- Fixed exception when printing UTF-8 to a `scoped_ostream_redirect`. + [#2982](https://github.com/pybind/pybind11/pull/2982) +- Pickle support enhancement: `setstate` implementation will attempt to + `setattr` `__dict__` only if the unpickled `dict` object is not empty, + to not force use of `py::dynamic_attr()` unnecessarily. + [#2972](https://github.com/pybind/pybind11/pull/2972) +- Allow negative timedelta values to roundtrip. + [#2870](https://github.com/pybind/pybind11/pull/2870) +- Fix unchecked errors could potentially swallow signals/other + exceptions. [#2863](https://github.com/pybind/pybind11/pull/2863) +- Add null pointer check with `std::localtime`. + [#2846](https://github.com/pybind/pybind11/pull/2846) +- Fix the `weakref` constructor from `py::object` to create a new + `weakref` on conversion. + [#2832](https://github.com/pybind/pybind11/pull/2832) +- Avoid relying on exceptions in C++17 when getting a `shared_ptr` + holder from a `shared_from_this` class. + [#2819](https://github.com/pybind/pybind11/pull/2819) +- Allow the codec's exception to be raised instead of `RuntimeError` + when casting from `py::str` to `std::string`. + [#2903](https://github.com/pybind/pybind11/pull/2903) + +Build system improvements: + +- In `setup_helpers.py`, test for platforms that have some + multiprocessing features but lack semaphores, which `ParallelCompile` + requires. [#3043](https://github.com/pybind/pybind11/pull/3043) +- Fix `pybind11_INCLUDE_DIR` in case `CMAKE_INSTALL_INCLUDEDIR` is + absolute. [#3005](https://github.com/pybind/pybind11/pull/3005) +- Fix bug not respecting `WITH_SOABI` or `WITHOUT_SOABI` to CMake. + [#2938](https://github.com/pybind/pybind11/pull/2938) +- Fix the default `Pybind11Extension` compilation flags with a Mingw64 + python. [#2921](https://github.com/pybind/pybind11/pull/2921) +- Clang on Windows: do not pass `/MP` (ignored flag). + [#2824](https://github.com/pybind/pybind11/pull/2824) +- `pybind11.setup_helpers.intree_extensions` can be used to generate + `Pybind11Extension` instances from cpp files placed in the Python + package source tree. + [#2831](https://github.com/pybind/pybind11/pull/2831) + +Backend and tidying up: + +- Enable clang-tidy performance, readability, and modernization checks + throughout the codebase to enforce best coding practices. + [#3046](https://github.com/pybind/pybind11/pull/3046), + [#3049](https://github.com/pybind/pybind11/pull/3049), + [#3051](https://github.com/pybind/pybind11/pull/3051), + [#3052](https://github.com/pybind/pybind11/pull/3052), + [#3080](https://github.com/pybind/pybind11/pull/3080), and + [#3094](https://github.com/pybind/pybind11/pull/3094) +- Checks for common misspellings were added to the pre-commit hooks. + [#3076](https://github.com/pybind/pybind11/pull/3076) +- Changed `Werror` to stricter `Werror-all` for Intel compiler and fixed + minor issues. [#2948](https://github.com/pybind/pybind11/pull/2948) +- Fixed compilation with GCC \< 5 when the user defines + `_GLIBCXX_USE_CXX11_ABI`. + [#2956](https://github.com/pybind/pybind11/pull/2956) +- Added nox support for easier local testing and linting of + contributions. [#3101](https://github.com/pybind/pybind11/pull/3101) + and [#3121](https://github.com/pybind/pybind11/pull/3121) +- Avoid RTD style issue with docutils 0.17+. + [#3119](https://github.com/pybind/pybind11/pull/3119) +- Support pipx run, such as `pipx run pybind11 --include` for a quick + compile. [#3117](https://github.com/pybind/pybind11/pull/3117) + +## v2.6.2 (Jan 26, 2021) + +Minor missing functionality added: + +- enum: add missing Enum.value property. + [#2739](https://github.com/pybind/pybind11/pull/2739) +- Allow thread termination to be avoided during shutdown for CPython + 3.7+ via `.disarm` for `gil_scoped_acquire`/`gil_scoped_release`. + [#2657](https://github.com/pybind/pybind11/pull/2657) + +Fixed or improved behavior in a few special cases: + +- Fix bug where the constructor of `object` subclasses would not throw + on being passed a Python object of the wrong type. + [#2701](https://github.com/pybind/pybind11/pull/2701) +- The `type_caster` for integers does not convert Python objects with + `__int__` anymore with `noconvert` or during the first round of trying + overloads. [#2698](https://github.com/pybind/pybind11/pull/2698) +- When casting to a C++ integer, `__index__` is always called and not + considered as conversion, consistent with Python 3.8+. + [#2801](https://github.com/pybind/pybind11/pull/2801) + +Build improvements: + +- Setup helpers: `extra_compile_args` and `extra_link_args` + automatically set by Pybind11Extension are now prepended, which allows + them to be overridden by user-set `extra_compile_args` and + `extra_link_args`. + [#2808](https://github.com/pybind/pybind11/pull/2808) +- Setup helpers: Don't trigger unused parameter warning. + [#2735](https://github.com/pybind/pybind11/pull/2735) +- CMake: Support running with `--warn-uninitialized` active. + [#2806](https://github.com/pybind/pybind11/pull/2806) +- CMake: Avoid error if included from two submodule directories. + [#2804](https://github.com/pybind/pybind11/pull/2804) +- CMake: Fix `STATIC` / `SHARED` being ignored in FindPython mode. + [#2796](https://github.com/pybind/pybind11/pull/2796) +- CMake: Respect the setting for `CMAKE_CXX_VISIBILITY_PRESET` if + defined. [#2793](https://github.com/pybind/pybind11/pull/2793) +- CMake: Fix issue with FindPython2/FindPython3 not working with + `pybind11::embed`. + [#2662](https://github.com/pybind/pybind11/pull/2662) +- CMake: mixing local and installed pybind11's would prioritize the + installed one over the local one (regression in 2.6.0). + [#2716](https://github.com/pybind/pybind11/pull/2716) + +Bug fixes: + +- Fixed segfault in multithreaded environments when using + `scoped_ostream_redirect`. + [#2675](https://github.com/pybind/pybind11/pull/2675) +- Leave docstring unset when all docstring-related options are disabled, + rather than set an empty string. + [#2745](https://github.com/pybind/pybind11/pull/2745) +- The module key in builtins that pybind11 uses to store its internals + changed from std::string to a python str type (more natural on Python + 2, no change on Python 3). + [#2814](https://github.com/pybind/pybind11/pull/2814) +- Fixed assertion error related to unhandled (later overwritten) + exception in CPython 3.8 and 3.9 debug builds. + [#2685](https://github.com/pybind/pybind11/pull/2685) +- Fix `py::gil_scoped_acquire` assert with CPython 3.9 debug build. + [#2683](https://github.com/pybind/pybind11/pull/2683) +- Fix issue with a test failing on pytest 6.2. + [#2741](https://github.com/pybind/pybind11/pull/2741) + +Warning fixes: + +- Fix warning modifying constructor parameter 'flag' that shadows a + field of 'set_flag' `[-Wshadow-field-in-constructor-modified]`. + [#2780](https://github.com/pybind/pybind11/pull/2780) +- Suppressed some deprecation warnings about old-style + `__init__`/`__setstate__` in the tests. + [#2759](https://github.com/pybind/pybind11/pull/2759) + +Valgrind work: + +- Fix invalid access when calling a pybind11 `__init__` on a + non-pybind11 class instance. + [#2755](https://github.com/pybind/pybind11/pull/2755) +- Fixed various minor memory leaks in pybind11's test suite. + [#2758](https://github.com/pybind/pybind11/pull/2758) +- Resolved memory leak in cpp_function initialization when exceptions + occurred. [#2756](https://github.com/pybind/pybind11/pull/2756) +- Added a Valgrind build, checking for leaks and memory-related UB, + to CI. [#2746](https://github.com/pybind/pybind11/pull/2746) + +Compiler support: + +- Intel compiler was not activating C++14 support due to a broken + define. [#2679](https://github.com/pybind/pybind11/pull/2679) +- Support ICC and NVIDIA HPC SDK in C++17 mode. + [#2729](https://github.com/pybind/pybind11/pull/2729) +- Support Intel OneAPI compiler (ICC 20.2) and add to CI. + [#2573](https://github.com/pybind/pybind11/pull/2573) + +## v2.6.1 (Nov 11, 2020) + +- `py::exec`, `py::eval`, and `py::eval_file` now add the builtins + module as `"__builtins__"` to their `globals` argument, better + matching `exec` and `eval` in pure Python. + [#2616](https://github.com/pybind/pybind11/pull/2616) +- `setup_helpers` will no longer set a minimum macOS version higher than + the current version. + [#2622](https://github.com/pybind/pybind11/pull/2622) +- Allow deleting static properties. + [#2629](https://github.com/pybind/pybind11/pull/2629) +- Seal a leak in `def_buffer`, cleaning up the `capture` object after + the `class_` object goes out of scope. + [#2634](https://github.com/pybind/pybind11/pull/2634) +- `pybind11_INCLUDE_DIRS` was incorrect, potentially causing a + regression if it was expected to include `PYTHON_INCLUDE_DIRS` (please + use targets instead). + [#2636](https://github.com/pybind/pybind11/pull/2636) +- Added parameter names to the `py::enum_` constructor and methods, + avoiding `arg0` in the generated docstrings. + [#2637](https://github.com/pybind/pybind11/pull/2637) +- Added `needs_recompile` optional function to the `ParallelCompiler` + helper, to allow a recompile to be skipped based on a user-defined + function. [#2643](https://github.com/pybind/pybind11/pull/2643) + +## v2.6.0 (Oct 21, 2020) + +See `upgrade-guide-2.6` for help upgrading to the new version. + +New features: + +- Keyword-only arguments supported in Python 2 or 3 with + `py::kw_only()`. + [#2100](https://github.com/pybind/pybind11/pull/2100) +- Positional-only arguments supported in Python 2 or 3 with + `py::pos_only()`. + [#2459](https://github.com/pybind/pybind11/pull/2459) +- `py::is_final()` class modifier to block subclassing (CPython only). + [#2151](https://github.com/pybind/pybind11/pull/2151) +- Added `py::prepend()`, allowing a function to be placed at the + beginning of the overload chain. + [#1131](https://github.com/pybind/pybind11/pull/1131) +- Access to the type object now provided with `py::type::of()` and + `py::type::of(h)`. + [#2364](https://github.com/pybind/pybind11/pull/2364) +- Perfect forwarding support for methods. + [#2048](https://github.com/pybind/pybind11/pull/2048) +- Added `py::error_already_set::discard_as_unraisable()`. + [#2372](https://github.com/pybind/pybind11/pull/2372) +- `py::hash` is now public. + [#2217](https://github.com/pybind/pybind11/pull/2217) +- `py::class_` is now supported. Note that writing to one + data member of the union and reading another (type punning) is UB in + C++. Thus pybind11-bound enums should never be used for such + conversions. [#2320](https://github.com/pybind/pybind11/pull/2320). +- Classes now check local scope when registering members, allowing a + subclass to have a member with the same name as a parent (such as an + enum). [#2335](https://github.com/pybind/pybind11/pull/2335) + +Code correctness features: + +- Error now thrown when `__init__` is forgotten on subclasses. + [#2152](https://github.com/pybind/pybind11/pull/2152) +- Throw error if conversion to a pybind11 type if the Python object + isn't a valid instance of that type, such as `py::bytes(o)` when + `py::object o` isn't a bytes instance. + [#2349](https://github.com/pybind/pybind11/pull/2349) +- Throw if conversion to `str` fails. + [#2477](https://github.com/pybind/pybind11/pull/2477) + +API changes: + +- `py::module` was renamed `py::module_` to avoid issues with C++20 when + used unqualified, but an alias `py::module` is provided for backward + compatibility. [#2489](https://github.com/pybind/pybind11/pull/2489) +- Public constructors for `py::module_` have been deprecated; please use + `pybind11::module_::create_extension_module` if you were using the + public constructor (fairly rare after `PYBIND11_MODULE` was + introduced). [#2552](https://github.com/pybind/pybind11/pull/2552) +- `PYBIND11_OVERLOAD*` macros and `get_overload` function replaced by + correctly-named `PYBIND11_OVERRIDE*` and `get_override`, fixing + inconsistencies in the presence of a closing `;` in these macros. + `get_type_overload` is deprecated. + [#2325](https://github.com/pybind/pybind11/pull/2325) + +Packaging / building improvements: + +- The Python package was reworked to be more powerful and useful. + [#2433](https://github.com/pybind/pybind11/pull/2433) + - `build-setuptools` is easier thanks to a new + `pybind11.setup_helpers` module, which provides utilities to use + setuptools with pybind11. It can be used via PEP 518, + `setup_requires`, or by directly importing or copying + `setup_helpers.py` into your project. + - CMake configuration files are now included in the Python package. + Use `pybind11.get_cmake_dir()` or `python -m pybind11 --cmakedir` to + get the directory with the CMake configuration files, or include the + site-packages location in your `CMAKE_MODULE_PATH`. Or you can use + the new `pybind11[global]` extra when you install `pybind11`, which + installs the CMake files and headers into your base environment in + the standard location. + - `pybind11-config` is another way to write `python -m pybind11` if + you have your PATH set up. + - Added external typing support to the helper module, code from + `import pybind11` can now be type checked. + [#2588](https://github.com/pybind/pybind11/pull/2588) +- Minimum CMake required increased to 3.4. + [#2338](https://github.com/pybind/pybind11/pull/2338) and + [#2370](https://github.com/pybind/pybind11/pull/2370) + - Full integration with CMake's C++ standard system and compile + features replaces `PYBIND11_CPP_STANDARD`. + - Generated config file is now portable to different + Python/compiler/CMake versions. + - Virtual environments prioritized if `PYTHON_EXECUTABLE` is not set + (`venv`, `virtualenv`, and `conda`) (similar to the new FindPython + mode). + - Other CMake features now natively supported, like + `CMAKE_INTERPROCEDURAL_OPTIMIZATION`, + `set(CMAKE_CXX_VISIBILITY_PRESET hidden)`. + - `CUDA` as a language is now supported. + - Helper functions `pybind11_strip`, `pybind11_extension`, + `pybind11_find_import` added, see `cmake/index`. + - Optional `find-python-mode` and `nopython-mode` with CMake. + [#2370](https://github.com/pybind/pybind11/pull/2370) +- Uninstall target added. + [#2265](https://github.com/pybind/pybind11/pull/2265) and + [#2346](https://github.com/pybind/pybind11/pull/2346) +- `pybind11_add_module()` now accepts an optional `OPT_SIZE` flag that + switches the binding target to size-based optimization if the global + build type can not always be fixed to `MinSizeRel` (except in debug + mode, where optimizations remain disabled). `MinSizeRel` or this flag + reduces binary size quite substantially (~25% on some platforms). + [#2463](https://github.com/pybind/pybind11/pull/2463) + +Smaller or developer focused features and fixes: + +- Moved `mkdoc.py` to a new repo, + [pybind11-mkdoc](https://github.com/pybind/pybind11-mkdoc). There are + no longer submodules in the main repo. +- `py::memoryview` segfault fix and update, with new + `py::memoryview::from_memory` in Python 3, and documentation. + [#2223](https://github.com/pybind/pybind11/pull/2223) +- Fix for `buffer_info` on Python 2. + [#2503](https://github.com/pybind/pybind11/pull/2503) +- If `__eq__` defined but not `__hash__`, `__hash__` is now set to + `None`. [#2291](https://github.com/pybind/pybind11/pull/2291) +- `py::ellipsis` now also works on Python 2. + [#2360](https://github.com/pybind/pybind11/pull/2360) +- Pointer to `std::tuple` & `std::pair` supported in cast. + [#2334](https://github.com/pybind/pybind11/pull/2334) +- Small fixes in NumPy support. `py::array` now uses `py::ssize_t` as + first argument type. + [#2293](https://github.com/pybind/pybind11/pull/2293) +- Added missing signature for `py::array`. + [#2363](https://github.com/pybind/pybind11/pull/2363) +- `unchecked_mutable_reference` has access to operator `()` and `[]` + when const. [#2514](https://github.com/pybind/pybind11/pull/2514) +- `py::vectorize` is now supported on functions that return void. + [#1969](https://github.com/pybind/pybind11/pull/1969) +- `py::capsule` supports `get_pointer` and `set_pointer`. + [#1131](https://github.com/pybind/pybind11/pull/1131) +- Fix crash when different instances share the same pointer of the same + type. [#2252](https://github.com/pybind/pybind11/pull/2252) +- Fix for `py::len` not clearing Python's error state when it fails and + throws. [#2575](https://github.com/pybind/pybind11/pull/2575) +- Bugfixes related to more extensive testing, new GitHub Actions CI. + [#2321](https://github.com/pybind/pybind11/pull/2321) +- Bug in timezone issue in Eastern hemisphere midnight fixed. + [#2438](https://github.com/pybind/pybind11/pull/2438) +- `std::chrono::time_point` now works when the resolution is not the + same as the system. + [#2481](https://github.com/pybind/pybind11/pull/2481) +- Bug fixed where `py::array_t` could accept arrays that did not match + the requested ordering. + [#2484](https://github.com/pybind/pybind11/pull/2484) +- Avoid a segfault on some compilers when types are removed in Python. + [#2564](https://github.com/pybind/pybind11/pull/2564) +- `py::arg::none()` is now also respected when passing keyword + arguments. [#2611](https://github.com/pybind/pybind11/pull/2611) +- PyPy fixes, PyPy 7.3.x now supported, including PyPy3. (Known issue + with PyPy2 and Windows + [#2596](https://github.com/pybind/pybind11/issues/2596)). + [#2146](https://github.com/pybind/pybind11/pull/2146) +- CPython 3.9.0 workaround for undefined behavior (macOS segfault). + [#2576](https://github.com/pybind/pybind11/pull/2576) +- CPython 3.9 warning fixes. + [#2253](https://github.com/pybind/pybind11/pull/2253) +- Improved C++20 support, now tested in CI. + [#2489](https://github.com/pybind/pybind11/pull/2489) + [#2599](https://github.com/pybind/pybind11/pull/2599) +- Improved but still incomplete debug Python interpreter support. + [#2025](https://github.com/pybind/pybind11/pull/2025) +- NVCC (CUDA 11) now supported and tested in CI. + [#2461](https://github.com/pybind/pybind11/pull/2461) +- NVIDIA PGI compilers now supported and tested in CI. + [#2475](https://github.com/pybind/pybind11/pull/2475) +- At least Intel 18 now explicitly required when compiling with Intel. + [#2577](https://github.com/pybind/pybind11/pull/2577) +- Extensive style checking in CI, with + [pre-commit](https://pre-commit.com) support. Code modernization, + checked by clang-tidy. +- Expanded docs, including new main page, new installing section, and + CMake helpers page, along with over a dozen new sections on existing + pages. +- In GitHub, new docs for contributing and new issue templates. + +## v2.5.0 (Mar 31, 2020) + +- Use C++17 fold expressions in type casters, if available. This can + improve performance during overload resolution when functions have + multiple arguments. + [#2043](https://github.com/pybind/pybind11/pull/2043). +- Changed include directory resolution in `pybind11/__init__.py` and + installation in `setup.py`. This fixes a number of open issues where + pybind11 headers could not be found in certain environments. + [#1995](https://github.com/pybind/pybind11/pull/1995). +- C++20 `char8_t` and `u8string` support. + [#2026](https://github.com/pybind/pybind11/pull/2026). +- CMake: search for Python 3.9. + [bb9c91](https://github.com/pybind/pybind11/commit/bb9c91). +- Fixes for MSYS-based build environments. + [#2087](https://github.com/pybind/pybind11/pull/2087), + [#2053](https://github.com/pybind/pybind11/pull/2053). +- STL bindings for `std::vector<...>::clear`. + [#2074](https://github.com/pybind/pybind11/pull/2074). +- Read-only flag for `py::buffer`. + [#1466](https://github.com/pybind/pybind11/pull/1466). +- Exception handling during module initialization. + [bf2b031](https://github.com/pybind/pybind11/commit/bf2b031). +- Support linking against a CPython debug build. + [#2025](https://github.com/pybind/pybind11/pull/2025). +- Fixed issues involving the availability and use of aligned `new` and + `delete`. [#1988](https://github.com/pybind/pybind11/pull/1988), + [759221](https://github.com/pybind/pybind11/commit/759221). +- Fixed a resource leak upon interpreter shutdown. + [#2020](https://github.com/pybind/pybind11/pull/2020). +- Fixed error handling in the boolean caster. + [#1976](https://github.com/pybind/pybind11/pull/1976). + +## v2.4.3 (Oct 15, 2019) + +- Adapt pybind11 to a C API convention change in Python 3.8. + [#1950](https://github.com/pybind/pybind11/pull/1950). + +## v2.4.2 (Sep 21, 2019) + +- Replaced usage of a C++14 only construct. + [#1929](https://github.com/pybind/pybind11/pull/1929). +- Made an ifdef future-proof for Python \>= 4. + [f3109d](https://github.com/pybind/pybind11/commit/f3109d). + +## v2.4.1 (Sep 20, 2019) + +- Fixed a problem involving implicit conversion from enumerations to + integers on Python 3.8. + [#1780](https://github.com/pybind/pybind11/pull/1780). + +## v2.4.0 (Sep 19, 2019) + +- Try harder to keep pybind11-internal data structures separate when + there are potential ABI incompatibilities. Fixes crashes that occurred + when loading multiple pybind11 extensions that were e.g. compiled by + GCC (libstdc++) and Clang (libc++). + [#1588](https://github.com/pybind/pybind11/pull/1588) and + [c9f5a](https://github.com/pybind/pybind11/commit/c9f5a). +- Added support for `__await__`, `__aiter__`, and `__anext__` protocols. + [#1842](https://github.com/pybind/pybind11/pull/1842). +- `pybind11_add_module()`: don't strip symbols when compiling in + `RelWithDebInfo` mode. + [#1980](https://github.com/pybind/pybind11/pull/1980). +- `enum_`: Reproduce Python behavior when comparing against invalid + values (e.g. `None`, strings, etc.). Add back support for + `__invert__()`. + [#1912](https://github.com/pybind/pybind11/pull/1912), + [#1907](https://github.com/pybind/pybind11/pull/1907). +- List insertion operation for `py::list`. Added `.empty()` to all + collection types. Added `py::set::contains()` and + `py::dict::contains()`. + [#1887](https://github.com/pybind/pybind11/pull/1887), + [#1884](https://github.com/pybind/pybind11/pull/1884), + [#1888](https://github.com/pybind/pybind11/pull/1888). +- `py::details::overload_cast_impl` is available in C++11 mode, can be + used like `overload_cast` with an additional set of parentheses. + [#1581](https://github.com/pybind/pybind11/pull/1581). +- Fixed `get_include()` on Conda. + [#1877](https://github.com/pybind/pybind11/pull/1877). +- `stl_bind.h`: negative indexing support. + [#1882](https://github.com/pybind/pybind11/pull/1882). +- Minor CMake fix to add MinGW compatibility. + [#1851](https://github.com/pybind/pybind11/pull/1851). +- GIL-related fixes. + [#1836](https://github.com/pybind/pybind11/pull/1836), + [8b90b](https://github.com/pybind/pybind11/commit/8b90b). +- Other very minor/subtle fixes and improvements. + [#1329](https://github.com/pybind/pybind11/pull/1329), + [#1910](https://github.com/pybind/pybind11/pull/1910), + [#1863](https://github.com/pybind/pybind11/pull/1863), + [#1847](https://github.com/pybind/pybind11/pull/1847), + [#1890](https://github.com/pybind/pybind11/pull/1890), + [#1860](https://github.com/pybind/pybind11/pull/1860), + [#1848](https://github.com/pybind/pybind11/pull/1848), + [#1821](https://github.com/pybind/pybind11/pull/1821), + [#1837](https://github.com/pybind/pybind11/pull/1837), + [#1833](https://github.com/pybind/pybind11/pull/1833), + [#1748](https://github.com/pybind/pybind11/pull/1748), + [#1852](https://github.com/pybind/pybind11/pull/1852). + +## v2.3.0 (June 11, 2019) + +- Significantly reduced module binary size (10-20%) when compiled in + C++11 mode with GCC/Clang, or in any mode with MSVC. Function + signatures are now always precomputed at compile time (this was + previously only available in C++14 mode for non-MSVC compilers). + [#934](https://github.com/pybind/pybind11/pull/934). + +- Add basic support for tag-based static polymorphism, where classes + provide a method to returns the desired type of an instance. + [#1326](https://github.com/pybind/pybind11/pull/1326). + +- Python type wrappers (`py::handle`, `py::object`, etc.) now support + map Python's number protocol onto C++ arithmetic operators such as + `operator+`, `operator/=`, etc. + [#1511](https://github.com/pybind/pybind11/pull/1511). + +- A number of improvements related to enumerations: + + > 1. The `enum_` implementation was rewritten from scratch to reduce + > code bloat. Rather than instantiating a full implementation for + > each enumeration, most code is now contained in a generic base + > class. [#1511](https://github.com/pybind/pybind11/pull/1511). + > 2. The `value()` method of `py::enum_` now accepts an optional + > docstring that will be shown in the documentation of the + > associated enumeration. + > [#1160](https://github.com/pybind/pybind11/pull/1160). + > 3. check for already existing enum value and throw an error if + > present. [#1453](https://github.com/pybind/pybind11/pull/1453). + +- Support for over-aligned type allocation via C++17's aligned `new` + statement. [#1582](https://github.com/pybind/pybind11/pull/1582). + +- Added `py::ellipsis()` method for slicing of multidimensional NumPy + arrays [#1502](https://github.com/pybind/pybind11/pull/1502). + +- Numerous Improvements to the `mkdoc.py` script for extracting + documentation from C++ header files. + [#1788](https://github.com/pybind/pybind11/pull/1788). + +- `pybind11_add_module()`: allow including Python as a `SYSTEM` include + path. [#1416](https://github.com/pybind/pybind11/pull/1416). + +- `pybind11/stl.h` does not convert strings to `vector` anymore. + [#1258](https://github.com/pybind/pybind11/issues/1258). + +- Mark static methods as such to fix auto-generated Sphinx + documentation. [#1732](https://github.com/pybind/pybind11/pull/1732). + +- Re-throw forced unwind exceptions (e.g. during pthread termination). + [#1208](https://github.com/pybind/pybind11/pull/1208). + +- Added `__contains__` method to the bindings of maps (`std::map`, + `std::unordered_map`). + [#1767](https://github.com/pybind/pybind11/pull/1767). + +- Improvements to `gil_scoped_acquire`. + [#1211](https://github.com/pybind/pybind11/pull/1211). + +- Type caster support for `std::deque`. + [#1609](https://github.com/pybind/pybind11/pull/1609). + +- Support for `std::unique_ptr` holders, whose deleters differ between a + base and derived class. + [#1353](https://github.com/pybind/pybind11/pull/1353). + +- Construction of STL array/vector-like data structures from iterators. + Added an `extend()` operation. + [#1709](https://github.com/pybind/pybind11/pull/1709), + +- CMake build system improvements for projects that include non-C++ + files (e.g. plain C, CUDA) in `pybind11_add_module` et al. + [#1678](https://github.com/pybind/pybind11/pull/1678). + +- Fixed asynchronous invocation and deallocation of Python functions + wrapped in `std::function`. + [#1595](https://github.com/pybind/pybind11/pull/1595). + +- Fixes regarding return value policy propagation in STL type casters. + [#1603](https://github.com/pybind/pybind11/pull/1603). + +- Fixed scoped enum comparisons. + [#1571](https://github.com/pybind/pybind11/pull/1571). + +- Fixed iostream redirection for code that releases the GIL. + [#1368](https://github.com/pybind/pybind11/pull/1368), + +- A number of CI-related fixes. + [#1757](https://github.com/pybind/pybind11/pull/1757), + [#1744](https://github.com/pybind/pybind11/pull/1744), + [#1670](https://github.com/pybind/pybind11/pull/1670). + +## v2.2.4 (September 11, 2018) + +- Use new Python 3.7 Thread Specific Storage (TSS) implementation if + available. [#1454](https://github.com/pybind/pybind11/pull/1454), + [#1517](https://github.com/pybind/pybind11/pull/1517). +- Fixes for newer MSVC versions and C++17 mode. + [#1347](https://github.com/pybind/pybind11/pull/1347), + [#1462](https://github.com/pybind/pybind11/pull/1462). +- Propagate return value policies to type-specific casters when casting + STL containers. + [#1455](https://github.com/pybind/pybind11/pull/1455). +- Allow ostream-redirection of more than 1024 characters. + [#1479](https://github.com/pybind/pybind11/pull/1479). +- Set `Py_DEBUG` define when compiling against a debug Python build. + [#1438](https://github.com/pybind/pybind11/pull/1438). +- Untangle integer logic in number type caster to work for custom types + that may only be castable to a restricted set of builtin types. + [#1442](https://github.com/pybind/pybind11/pull/1442). +- CMake build system: Remember Python version in cache file. + [#1434](https://github.com/pybind/pybind11/pull/1434). +- Fix for custom smart pointers: use `std::addressof` to obtain holder + address instead of `operator&`. + [#1435](https://github.com/pybind/pybind11/pull/1435). +- Properly report exceptions thrown during module initialization. + [#1362](https://github.com/pybind/pybind11/pull/1362). +- Fixed a segmentation fault when creating empty-shaped NumPy array. + [#1371](https://github.com/pybind/pybind11/pull/1371). +- The version of Intel C++ compiler must be \>= 2017, and this is now + checked by the header files. + [#1363](https://github.com/pybind/pybind11/pull/1363). +- A few minor typo fixes and improvements to the test suite, and patches + that silence compiler warnings. +- Vectors now support construction from generators, as well as + `extend()` from a list or generator. + [#1496](https://github.com/pybind/pybind11/pull/1496). + +## v2.2.3 (April 29, 2018) + +- The pybind11 header location detection was replaced by a new + implementation that no longer depends on `pip` internals (the recently + released `pip` 10 has restricted access to this API). + [#1190](https://github.com/pybind/pybind11/pull/1190). +- Small adjustment to an implementation detail to work around a compiler + segmentation fault in Clang 3.3/3.4. + [#1350](https://github.com/pybind/pybind11/pull/1350). +- The minimal supported version of the Intel compiler was \>= 17.0 since + pybind11 v2.1. This check is now explicit, and a compile-time error is + raised if the compiler meet the requirement. + [#1363](https://github.com/pybind/pybind11/pull/1363). +- Fixed an endianness-related fault in the test suite. + [#1287](https://github.com/pybind/pybind11/pull/1287). + +## v2.2.2 (February 7, 2018) + +- Fixed a segfault when combining embedded interpreter + shutdown/reinitialization with external loaded pybind11 modules. + [#1092](https://github.com/pybind/pybind11/pull/1092). +- Eigen support: fixed a bug where Nx1/1xN numpy inputs couldn't be + passed as arguments to Eigen vectors (which for Eigen are simply + compile-time fixed Nx1/1xN matrices). + [#1106](https://github.com/pybind/pybind11/pull/1106). +- Clarified to license by moving the licensing of contributions from + `LICENSE` into `CONTRIBUTING.md`: the licensing of contributions is + not actually part of the software license as distributed. This isn't + meant to be a substantial change in the licensing of the project, but + addresses concerns that the clause made the license non-standard. + [#1109](https://github.com/pybind/pybind11/issues/1109). +- Fixed a regression introduced in 2.1 that broke binding functions with + lvalue character literal arguments. + [#1128](https://github.com/pybind/pybind11/pull/1128). +- MSVC: fix for compilation failures under /permissive-, and added the + flag to the appveyor test suite. + [#1155](https://github.com/pybind/pybind11/pull/1155). +- Fixed `__qualname__` generation, and in turn, fixes how class names + (especially nested class names) are shown in generated docstrings. + [#1171](https://github.com/pybind/pybind11/pull/1171). +- Updated the FAQ with a suggested project citation reference. + [#1189](https://github.com/pybind/pybind11/pull/1189). +- Added fixes for deprecation warnings when compiled under C++17 with + `-Wdeprecated` turned on, and add `-Wdeprecated` to the test suite + compilation flags. + [#1191](https://github.com/pybind/pybind11/pull/1191). +- Fixed outdated PyPI URLs in `setup.py`. + [#1213](https://github.com/pybind/pybind11/pull/1213). +- Fixed a refcount leak for arguments that end up in a `py::args` + argument for functions with both fixed positional and `py::args` + arguments. [#1216](https://github.com/pybind/pybind11/pull/1216). +- Fixed a potential segfault resulting from possible premature + destruction of `py::args`/`py::kwargs` arguments with overloaded + functions. [#1223](https://github.com/pybind/pybind11/pull/1223). +- Fixed `del map[item]` for a `stl_bind.h` bound stl map. + [#1229](https://github.com/pybind/pybind11/pull/1229). +- Fixed a regression from v2.1.x where the aggregate initialization + could unintentionally end up at a constructor taking a templated + `std::initializer_list` argument. + [#1249](https://github.com/pybind/pybind11/pull/1249). +- Fixed an issue where calling a function with a keep_alive policy on + the same nurse/patient pair would cause the internal patient storage + to needlessly grow (unboundedly, if the nurse is long-lived). + [#1251](https://github.com/pybind/pybind11/issues/1251). +- Various other minor fixes. + +## v2.2.1 (September 14, 2017) + +- Added `py::module_::reload()` member function for reloading a module. + [#1040](https://github.com/pybind/pybind11/pull/1040). +- Fixed a reference leak in the number converter. + [#1078](https://github.com/pybind/pybind11/pull/1078). +- Fixed compilation with Clang on host GCC \< 5 (old libstdc++ which + isn't fully C++11 compliant). + [#1062](https://github.com/pybind/pybind11/pull/1062). +- Fixed a regression where the automatic `std::vector` caster + would fail to compile. The same fix also applies to any container + which returns element proxies instead of references. + [#1053](https://github.com/pybind/pybind11/pull/1053). +- Fixed a regression where the `py::keep_alive` policy could not be + applied to constructors. + [#1065](https://github.com/pybind/pybind11/pull/1065). +- Fixed a nullptr dereference when loading a `py::module_local` type + that's only registered in an external module. + [#1058](https://github.com/pybind/pybind11/pull/1058). +- Fixed implicit conversion of accessors to types derived from + `py::object`. [#1076](https://github.com/pybind/pybind11/pull/1076). +- The `name` in `PYBIND11_MODULE(name, variable)` can now be a macro. + [#1082](https://github.com/pybind/pybind11/pull/1082). +- Relaxed overly strict `py::pickle()` check for matching get and set + types. [#1064](https://github.com/pybind/pybind11/pull/1064). +- Conversion errors now try to be more informative when it's likely that + a missing header is the cause (e.g. forgetting ``). + [#1077](https://github.com/pybind/pybind11/pull/1077). + +## v2.2.0 (August 31, 2017) + +- Support for embedding the Python interpreter. See the + `documentation page ` for a full overview of the + new features. [#774](https://github.com/pybind/pybind11/pull/774), + [#889](https://github.com/pybind/pybind11/pull/889), + [#892](https://github.com/pybind/pybind11/pull/892), + [#920](https://github.com/pybind/pybind11/pull/920). + + ```cpp + #include + namespace py = pybind11; + + int main() { + py::scoped_interpreter guard{}; // start the interpreter and keep it alive + + py::print("Hello, World!"); // use the Python API + } + ``` + +- Support for inheriting from multiple C++ bases in Python. + [#693](https://github.com/pybind/pybind11/pull/693). + + ```python + from cpp_module import CppBase1, CppBase2 + + + class PyDerived(CppBase1, CppBase2): + def __init__(self): + CppBase1.__init__(self) # C++ bases must be initialized explicitly + CppBase2.__init__(self) + ``` + +- `PYBIND11_MODULE` is now the preferred way to create module entry + points. `PYBIND11_PLUGIN` is deprecated. See `macros` for details. + [#879](https://github.com/pybind/pybind11/pull/879). + + ```cpp + // new + PYBIND11_MODULE(example, m) { + m.def("add", [](int a, int b) { return a + b; }); + } + + // old + PYBIND11_PLUGIN(example) { + py::module m("example"); + m.def("add", [](int a, int b) { return a + b; }); + return m.ptr(); + } + ``` + +- pybind11's headers and build system now more strictly enforce hidden + symbol visibility for extension modules. This should be seamless for + most users, but see the `upgrade` if you use a custom build system. + [#995](https://github.com/pybind/pybind11/pull/995). + +- Support for `py::module_local` types which allow multiple modules to + export the same C++ types without conflicts. This is useful for opaque + types like `std::vector`. `py::bind_vector` and `py::bind_map` + now default to `py::module_local` if their elements are builtins or + local types. See `module_local` for details. + [#949](https://github.com/pybind/pybind11/pull/949), + [#981](https://github.com/pybind/pybind11/pull/981), + [#995](https://github.com/pybind/pybind11/pull/995), + [#997](https://github.com/pybind/pybind11/pull/997). + +- Custom constructors can now be added very easily using lambdas or + factory functions which return a class instance by value, pointer or + holder. This supersedes the old placement-new `__init__` technique. + See `custom_constructors` for details. + [#805](https://github.com/pybind/pybind11/pull/805), + [#1014](https://github.com/pybind/pybind11/pull/1014). + + ```cpp + struct Example { + Example(std::string); + }; + + py::class_(m, "Example") + .def(py::init()) // existing constructor + .def(py::init([](int n) { // custom constructor + return std::make_unique(std::to_string(n)); + })); + ``` + +- Similarly to custom constructors, pickling support functions are now + bound using the `py::pickle()` adaptor which improves type safety. See + the `upgrade` and `pickling` for details. + [#1038](https://github.com/pybind/pybind11/pull/1038). + +- Builtin support for converting C++17 standard library types and + general conversion improvements: + + 1. C++17 `std::variant` is supported right out of the box. C++11/14 + equivalents (e.g. `boost::variant`) can also be added with a + simple user-defined specialization. See `cpp17_container_casters` + for details. [#811](https://github.com/pybind/pybind11/pull/811), + [#845](https://github.com/pybind/pybind11/pull/845), + [#989](https://github.com/pybind/pybind11/pull/989). + 2. Out-of-the-box support for C++17 `std::string_view`. + [#906](https://github.com/pybind/pybind11/pull/906). + 3. Improved compatibility of the builtin `optional` converter. + [#874](https://github.com/pybind/pybind11/pull/874). + 4. The `bool` converter now accepts `numpy.bool_` and types which + define `__bool__` (Python 3.x) or `__nonzero__` (Python 2.7). + [#925](https://github.com/pybind/pybind11/pull/925). + 5. C++-to-Python casters are now more efficient and move elements out + of rvalue containers whenever possible. + [#851](https://github.com/pybind/pybind11/pull/851), + [#936](https://github.com/pybind/pybind11/pull/936), + [#938](https://github.com/pybind/pybind11/pull/938). + 6. Fixed `bytes` to `std::string/char*` conversion on Python 3. + [#817](https://github.com/pybind/pybind11/pull/817). + 7. Fixed lifetime of temporary C++ objects created in Python-to-C++ + conversions. [#924](https://github.com/pybind/pybind11/pull/924). + +- Scope guard call policy for RAII types, e.g. + `py::call_guard()`, + `py::call_guard()`. See `call_policies` + for details. [#740](https://github.com/pybind/pybind11/pull/740). + +- Utility for redirecting C++ streams to Python (e.g. `std::cout` -\> + `sys.stdout`). Scope guard `py::scoped_ostream_redirect` in C++ and a + context manager in Python. See `ostream_redirect`. + [#1009](https://github.com/pybind/pybind11/pull/1009). + +- Improved handling of types and exceptions across module boundaries. + [#915](https://github.com/pybind/pybind11/pull/915), + [#951](https://github.com/pybind/pybind11/pull/951), + [#995](https://github.com/pybind/pybind11/pull/995). + +- Fixed destruction order of `py::keep_alive` nurse/patient objects in + reference cycles. + [#856](https://github.com/pybind/pybind11/pull/856). + +- NumPy and buffer protocol related improvements: + + 1. Support for negative strides in Python buffer objects/numpy + arrays. This required changing integers from unsigned to signed + for the related C++ APIs. Note: If you have compiler warnings + enabled, you may notice some new conversion warnings after + upgrading. These can be resolved with `static_cast`. + [#782](https://github.com/pybind/pybind11/pull/782). + 2. Support `std::complex` and arrays inside `PYBIND11_NUMPY_DTYPE`. + [#831](https://github.com/pybind/pybind11/pull/831), + [#832](https://github.com/pybind/pybind11/pull/832). + 3. Support for constructing `py::buffer_info` and `py::arrays` using + arbitrary containers or iterators instead of requiring a + `std::vector`. + [#788](https://github.com/pybind/pybind11/pull/788), + [#822](https://github.com/pybind/pybind11/pull/822), + [#860](https://github.com/pybind/pybind11/pull/860). + 4. Explicitly check numpy version and require \>= 1.7.0. + [#819](https://github.com/pybind/pybind11/pull/819). + +- Support for allowing/prohibiting `None` for specific arguments and + improved `None` overload resolution order. See `none_arguments` for + details. [#843](https://github.com/pybind/pybind11/pull/843). + [#859](https://github.com/pybind/pybind11/pull/859). + +- Added `py::exec()` as a shortcut for `py::eval()` + and support for C++11 raw string literals as input. See `eval`. + [#766](https://github.com/pybind/pybind11/pull/766), + [#827](https://github.com/pybind/pybind11/pull/827). + +- `py::vectorize()` ignores non-vectorizable arguments and supports + member functions. + [#762](https://github.com/pybind/pybind11/pull/762). + +- Support for bound methods as callbacks (`pybind11/functional.h`). + [#815](https://github.com/pybind/pybind11/pull/815). + +- Allow aliasing pybind11 methods: `cls.attr("foo") = cls.attr("bar")`. + [#802](https://github.com/pybind/pybind11/pull/802). + +- Don't allow mixed static/non-static overloads. + [#804](https://github.com/pybind/pybind11/pull/804). + +- Fixed overriding static properties in derived classes. + [#784](https://github.com/pybind/pybind11/pull/784). + +- Added support for write only properties. + [#1144](https://github.com/pybind/pybind11/pull/1144). + +- Improved deduction of member functions of a derived class when its + bases aren't registered with pybind11. + [#855](https://github.com/pybind/pybind11/pull/855). + + ```cpp + struct Base { + int foo() { return 42; } + } + + struct Derived : Base {} + + // Now works, but previously required also binding `Base` + py::class_(m, "Derived") + .def("foo", &Derived::foo); // function is actually from `Base` + ``` + +- The implementation of `py::init<>` now uses C++11 brace initialization + syntax to construct instances, which permits binding implicit + constructors of aggregate types. + [#1015](https://github.com/pybind/pybind11/pull/1015). + + > ```cpp + > struct Aggregate { + > int a; + > std::string b; + > }; + > + > py::class_(m, "Aggregate") + > .def(py::init()); + > ``` + +- Fixed issues with multiple inheritance with offset base/derived + pointers. [#812](https://github.com/pybind/pybind11/pull/812), + [#866](https://github.com/pybind/pybind11/pull/866), + [#960](https://github.com/pybind/pybind11/pull/960). + +- Fixed reference leak of type objects. + [#1030](https://github.com/pybind/pybind11/pull/1030). + +- Improved support for the `/std:c++14` and `/std:c++latest` modes on + MSVC 2017. [#841](https://github.com/pybind/pybind11/pull/841), + [#999](https://github.com/pybind/pybind11/pull/999). + +- Fixed detection of private operator new on MSVC. + [#893](https://github.com/pybind/pybind11/pull/893), + [#918](https://github.com/pybind/pybind11/pull/918). + +- Intel C++ compiler compatibility fixes. + [#937](https://github.com/pybind/pybind11/pull/937). + +- Fixed implicit conversion of `py::enum_` to integer types on Python + 2.7. [#821](https://github.com/pybind/pybind11/pull/821). + +- Added `py::hash` to fetch the hash value of Python objects, and + `.def(hash(py::self))` to provide the C++ `std::hash` as the Python + `__hash__` method. + [#1034](https://github.com/pybind/pybind11/pull/1034). + +- Fixed `__truediv__` on Python 2 and `__itruediv__` on Python 3. + [#867](https://github.com/pybind/pybind11/pull/867). + +- `py::capsule` objects now support the `name` attribute. This is useful + for interfacing with `scipy.LowLevelCallable`. + [#902](https://github.com/pybind/pybind11/pull/902). + +- Fixed `py::make_iterator`'s `__next__()` for past-the-end calls. + [#897](https://github.com/pybind/pybind11/pull/897). + +- Added `error_already_set::matches()` for checking Python exceptions. + [#772](https://github.com/pybind/pybind11/pull/772). + +- Deprecated `py::error_already_set::clear()`. It's no longer needed + following a simplification of the `py::error_already_set` class. + [#954](https://github.com/pybind/pybind11/pull/954). + +- Deprecated `py::handle::operator==()` in favor of `py::handle::is()` + [#825](https://github.com/pybind/pybind11/pull/825). + +- Deprecated `py::object::borrowed`/`py::object::stolen`. Use + `py::object::borrowed_t{}`/`py::object::stolen_t{}` instead. + [#771](https://github.com/pybind/pybind11/pull/771). + +- Changed internal data structure versioning to avoid conflicts between + modules compiled with different revisions of pybind11. + [#1012](https://github.com/pybind/pybind11/pull/1012). + +- Additional compile-time and run-time error checking and more + informative messages. + [#786](https://github.com/pybind/pybind11/pull/786), + [#794](https://github.com/pybind/pybind11/pull/794), + [#803](https://github.com/pybind/pybind11/pull/803). + +- Various minor improvements and fixes. + [#764](https://github.com/pybind/pybind11/pull/764), + [#791](https://github.com/pybind/pybind11/pull/791), + [#795](https://github.com/pybind/pybind11/pull/795), + [#840](https://github.com/pybind/pybind11/pull/840), + [#844](https://github.com/pybind/pybind11/pull/844), + [#846](https://github.com/pybind/pybind11/pull/846), + [#849](https://github.com/pybind/pybind11/pull/849), + [#858](https://github.com/pybind/pybind11/pull/858), + [#862](https://github.com/pybind/pybind11/pull/862), + [#871](https://github.com/pybind/pybind11/pull/871), + [#872](https://github.com/pybind/pybind11/pull/872), + [#881](https://github.com/pybind/pybind11/pull/881), + [#888](https://github.com/pybind/pybind11/pull/888), + [#899](https://github.com/pybind/pybind11/pull/899), + [#928](https://github.com/pybind/pybind11/pull/928), + [#931](https://github.com/pybind/pybind11/pull/931), + [#944](https://github.com/pybind/pybind11/pull/944), + [#950](https://github.com/pybind/pybind11/pull/950), + [#952](https://github.com/pybind/pybind11/pull/952), + [#962](https://github.com/pybind/pybind11/pull/962), + [#965](https://github.com/pybind/pybind11/pull/965), + [#970](https://github.com/pybind/pybind11/pull/970), + [#978](https://github.com/pybind/pybind11/pull/978), + [#979](https://github.com/pybind/pybind11/pull/979), + [#986](https://github.com/pybind/pybind11/pull/986), + [#1020](https://github.com/pybind/pybind11/pull/1020), + [#1027](https://github.com/pybind/pybind11/pull/1027), + [#1037](https://github.com/pybind/pybind11/pull/1037). + +- Testing improvements. + [#798](https://github.com/pybind/pybind11/pull/798), + [#882](https://github.com/pybind/pybind11/pull/882), + [#898](https://github.com/pybind/pybind11/pull/898), + [#900](https://github.com/pybind/pybind11/pull/900), + [#921](https://github.com/pybind/pybind11/pull/921), + [#923](https://github.com/pybind/pybind11/pull/923), + [#963](https://github.com/pybind/pybind11/pull/963). + +## v2.1.1 (April 7, 2017) + +- Fixed minimum version requirement for MSVC 2015u3 + [#773](https://github.com/pybind/pybind11/pull/773). + +## v2.1.0 (March 22, 2017) + +- pybind11 now performs function overload resolution in two phases. The + first phase only considers exact type matches, while the second allows + for implicit conversions to take place. A special `noconvert()` syntax + can be used to completely disable implicit conversions for specific + arguments. [#643](https://github.com/pybind/pybind11/pull/643), + [#634](https://github.com/pybind/pybind11/pull/634), + [#650](https://github.com/pybind/pybind11/pull/650). +- Fixed a regression where static properties no longer worked with + classes using multiple inheritance. The `py::metaclass` attribute is + no longer necessary (and deprecated as of this release) when binding + classes with static properties. + [#679](https://github.com/pybind/pybind11/pull/679), +- Classes bound using `pybind11` can now use custom metaclasses. + [#679](https://github.com/pybind/pybind11/pull/679), +- `py::args` and `py::kwargs` can now be mixed with other positional + arguments when binding functions using pybind11. + [#611](https://github.com/pybind/pybind11/pull/611). +- Improved support for C++11 unicode string and character types; added + extensive documentation regarding pybind11's string conversion + behavior. [#624](https://github.com/pybind/pybind11/pull/624), + [#636](https://github.com/pybind/pybind11/pull/636), + [#715](https://github.com/pybind/pybind11/pull/715). +- pybind11 can now avoid expensive copies when converting Eigen arrays + to NumPy arrays (and vice versa). + [#610](https://github.com/pybind/pybind11/pull/610). +- The "fast path" in `py::vectorize` now works for any full-size group + of C or F-contiguous arrays. The non-fast path is also faster since it + no longer performs copies of the input arguments (except when type + conversions are necessary). + [#610](https://github.com/pybind/pybind11/pull/610). +- Added fast, unchecked access to NumPy arrays via a proxy object. + [#746](https://github.com/pybind/pybind11/pull/746). +- Transparent support for class-specific `operator new` and + `operator delete` implementations. + [#755](https://github.com/pybind/pybind11/pull/755). +- Slimmer and more efficient STL-compatible iterator interface for + sequence types. [#662](https://github.com/pybind/pybind11/pull/662). +- Improved custom holder type support. + [#607](https://github.com/pybind/pybind11/pull/607). +- `nullptr` to `None` conversion fixed in various builtin type casters. + [#732](https://github.com/pybind/pybind11/pull/732). +- `enum_` now exposes its members via a special `__members__` attribute. + [#666](https://github.com/pybind/pybind11/pull/666). +- `std::vector` bindings created using `stl_bind.h` can now optionally + implement the buffer protocol. + [#488](https://github.com/pybind/pybind11/pull/488). +- Automated C++ reference documentation using doxygen and breathe. + [#598](https://github.com/pybind/pybind11/pull/598). +- Added minimum compiler version assertions. + [#727](https://github.com/pybind/pybind11/pull/727). +- Improved compatibility with C++1z. + [#677](https://github.com/pybind/pybind11/pull/677). +- Improved `py::capsule` API. Can be used to implement cleanup callbacks + that are involved at module destruction time. + [#752](https://github.com/pybind/pybind11/pull/752). +- Various minor improvements and fixes. + [#595](https://github.com/pybind/pybind11/pull/595), + [#588](https://github.com/pybind/pybind11/pull/588), + [#589](https://github.com/pybind/pybind11/pull/589), + [#603](https://github.com/pybind/pybind11/pull/603), + [#619](https://github.com/pybind/pybind11/pull/619), + [#648](https://github.com/pybind/pybind11/pull/648), + [#695](https://github.com/pybind/pybind11/pull/695), + [#720](https://github.com/pybind/pybind11/pull/720), + [#723](https://github.com/pybind/pybind11/pull/723), + [#729](https://github.com/pybind/pybind11/pull/729), + [#724](https://github.com/pybind/pybind11/pull/724), + [#742](https://github.com/pybind/pybind11/pull/742), + [#753](https://github.com/pybind/pybind11/pull/753). + +## v2.0.1 (Jan 4, 2017) + +- Fix pointer to reference error in type_caster on MSVC + [#583](https://github.com/pybind/pybind11/pull/583). +- Fixed a segmentation in the test suite due to a typo + [cd7eac](https://github.com/pybind/pybind11/commit/cd7eac). + +## v2.0.0 (Jan 1, 2017) + +- Fixed a reference counting regression affecting types with custom + metaclasses (introduced in v2.0.0-rc1). + [#571](https://github.com/pybind/pybind11/pull/571). +- Quenched a CMake policy warning. + [#570](https://github.com/pybind/pybind11/pull/570). + +## v2.0.0-rc1 (Dec 23, 2016) + +The pybind11 developers are excited to issue a release candidate of +pybind11 with a subsequent v2.0.0 release planned in early January next +year. + +An incredible amount of effort by went into pybind11 over the last ~5 +months, leading to a release that is jam-packed with exciting new +features and numerous usability improvements. The following list links +PRs or individual commits whenever applicable. + +Happy Christmas! + +- Support for binding C++ class hierarchies that make use of multiple + inheritance. [#410](https://github.com/pybind/pybind11/pull/410). + +- PyPy support: pybind11 now supports nightly builds of PyPy and will + interoperate with the future 5.7 release. No code changes are + necessary, everything "just" works as usual. Note that we only target + the Python 2.7 branch for now; support for 3.x will be added once its + `cpyext` extension support catches up. A few minor features remain + unsupported for the time being (notably dynamic attributes in custom + types). [#527](https://github.com/pybind/pybind11/pull/527). + +- Significant work on the documentation -- in particular, the monolithic + `advanced.rst` file was restructured into a easier to read + hierarchical organization. + [#448](https://github.com/pybind/pybind11/pull/448). + +- Many NumPy-related improvements: + + 1. Object-oriented API to access and modify NumPy `ndarray` + instances, replicating much of the corresponding NumPy C API + functionality. + [#402](https://github.com/pybind/pybind11/pull/402). + + 2. NumPy array `dtype` array descriptors are now first-class citizens + and are exposed via a new class `py::dtype`. + + 3. Structured dtypes can be registered using the + `PYBIND11_NUMPY_DTYPE()` macro. Special `array` constructors + accepting dtype objects were also added. + + One potential caveat involving this change: format descriptor + strings should now be accessed via `format_descriptor::format()` + (however, for compatibility purposes, the old syntax + `format_descriptor::value` will still work for non-structured data + types). [#308](https://github.com/pybind/pybind11/pull/308). + + 4. Further improvements to support structured dtypes throughout the + system. [#472](https://github.com/pybind/pybind11/pull/472), + [#474](https://github.com/pybind/pybind11/pull/474), + [#459](https://github.com/pybind/pybind11/pull/459), + [#453](https://github.com/pybind/pybind11/pull/453), + [#452](https://github.com/pybind/pybind11/pull/452), and + [#505](https://github.com/pybind/pybind11/pull/505). + + 5. Fast access operators. + [#497](https://github.com/pybind/pybind11/pull/497). + + 6. Constructors for arrays whose storage is owned by another object. + [#440](https://github.com/pybind/pybind11/pull/440). + + 7. Added constructors for `array` and `array_t` explicitly accepting + shape and strides; if strides are not provided, they are deduced + assuming C-contiguity. Also added simplified constructors for + 1-dimensional case. + + 8. Added buffer/NumPy support for `char[N]` and `std::array` + types. + + 9. Added `memoryview` wrapper type which is constructible from + `buffer_info`. + +- Eigen: many additional conversions and support for non-contiguous + arrays/slices. [#427](https://github.com/pybind/pybind11/pull/427), + [#315](https://github.com/pybind/pybind11/pull/315), + [#316](https://github.com/pybind/pybind11/pull/316), + [#312](https://github.com/pybind/pybind11/pull/312), and + [#267](https://github.com/pybind/pybind11/pull/267) + +- Incompatible changes in `class_<...>::class_()`: + + > 1. Declarations of types that provide access via the buffer + > protocol must now include the `py::buffer_protocol()` annotation + > as an argument to the `class_` constructor. + > 2. Declarations of types that require a custom metaclass (i.e. all + > classes which include static properties via commands such as + > `def_readwrite_static()`) must now include the `py::metaclass()` + > annotation as an argument to the `class_` constructor. + > + > These two changes were necessary to make type definitions in + > pybind11 future-proof, and to support PyPy via its cpyext + > mechanism. [#527](https://github.com/pybind/pybind11/pull/527). + > + > 3. This version of pybind11 uses a redesigned mechanism for + > instantiating trampoline classes that are used to override + > virtual methods from within Python. This led to the following + > user-visible syntax change: instead of + > + > ```cpp + > py::class_("MyClass") + > .alias() + > .... + > ``` + > + > write + > + > ```cpp + > py::class_("MyClass") + > .... + > ``` + > + > Importantly, both the original and the trampoline class are now + > specified as an arguments (in arbitrary order) to the + > `py::class_` template, and the `alias<..>()` call is gone. The + > new scheme has zero overhead in cases when Python doesn't + > override any functions of the underlying C++ class. [rev. + > 86d825](https://github.com/pybind/pybind11/commit/86d825). + +- Added `eval` and `eval_file` functions for evaluating expressions and + statements from a string or file. [rev. + 0d3fc3](https://github.com/pybind/pybind11/commit/0d3fc3). + +- pybind11 can now create types with a modifiable dictionary. + [#437](https://github.com/pybind/pybind11/pull/437) and + [#444](https://github.com/pybind/pybind11/pull/444). + +- Support for translation of arbitrary C++ exceptions to Python + counterparts. [#296](https://github.com/pybind/pybind11/pull/296) and + [#273](https://github.com/pybind/pybind11/pull/273). + +- Report full backtraces through mixed C++/Python code, better reporting + for import errors, fixed GIL management in exception processing. + [#537](https://github.com/pybind/pybind11/pull/537), + [#494](https://github.com/pybind/pybind11/pull/494), [rev. + e72d95](https://github.com/pybind/pybind11/commit/e72d95), and [rev. + 099d6e](https://github.com/pybind/pybind11/commit/099d6e). + +- Support for bit-level operations, comparisons, and serialization of + C++ enumerations. + [#503](https://github.com/pybind/pybind11/pull/503), + [#508](https://github.com/pybind/pybind11/pull/508), + [#380](https://github.com/pybind/pybind11/pull/380), + [#309](https://github.com/pybind/pybind11/pull/309). + [#311](https://github.com/pybind/pybind11/pull/311). + +- The `class_` constructor now accepts its template arguments in any + order. [#385](https://github.com/pybind/pybind11/pull/385). + +- Attribute and item accessors now have a more complete interface which + makes it possible to chain attributes as in + `obj.attr("a")[key].attr("b").attr("method")(1, 2, 3)`. + [#425](https://github.com/pybind/pybind11/pull/425). + +- Major redesign of the default and conversion constructors in + `pytypes.h`. [#464](https://github.com/pybind/pybind11/pull/464). + +- Added built-in support for `std::shared_ptr` holder type. It is no + longer necessary to to include a declaration of the form + `PYBIND11_DECLARE_HOLDER_TYPE(T, std::shared_ptr)` (though + continuing to do so won't cause an error). + [#454](https://github.com/pybind/pybind11/pull/454). + +- New `py::overload_cast` casting operator to select among multiple + possible overloads of a function. An example: + + > ```cpp + > py::class_(m, "Pet") + > .def("set", py::overload_cast(&Pet::set), "Set the pet's age") + > .def("set", py::overload_cast(&Pet::set), "Set the pet's name"); + > ``` + + This feature only works on C++14-capable compilers. + [#541](https://github.com/pybind/pybind11/pull/541). + +- C++ types are automatically cast to Python types, e.g. when assigning + them as an attribute. For instance, the following is now legal: + + > ```cpp + > py::module m = /* ... */ + > m.attr("constant") = 123; + > ``` + + (Previously, a `py::cast` call was necessary to avoid a compilation + error.) [#551](https://github.com/pybind/pybind11/pull/551). + +- Redesigned `pytest`-based test suite. + [#321](https://github.com/pybind/pybind11/pull/321). + +- Instance tracking to detect reference leaks in test suite. + [#324](https://github.com/pybind/pybind11/pull/324) + +- pybind11 can now distinguish between multiple different instances that + are located at the same memory address, but which have different + types. [#329](https://github.com/pybind/pybind11/pull/329). + +- Improved logic in `move` return value policy. + [#510](https://github.com/pybind/pybind11/pull/510), + [#297](https://github.com/pybind/pybind11/pull/297). + +- Generalized unpacking API to permit calling Python functions from C++ + using notation such as + `foo(a1, a2, *args, "ka"_a=1, "kb"_a=2, **kwargs)`. + [#372](https://github.com/pybind/pybind11/pull/372). + +- `py::print()` function whose behavior matches that of the native + Python `print()` function. + [#372](https://github.com/pybind/pybind11/pull/372). + +- Added `py::dict` keyword + constructor:`auto d = dict("number"_a=42, "name"_a="World");`. + [#372](https://github.com/pybind/pybind11/pull/372). + +- Added `py::str::format()` method and `_s` literal: + `py::str s = "1 + 2 = {}"_s.format(3);`. + [#372](https://github.com/pybind/pybind11/pull/372). + +- Added `py::repr()` function which is equivalent to Python's builtin + `repr()`. [#333](https://github.com/pybind/pybind11/pull/333). + +- Improved construction and destruction logic for holder types. It is + now possible to reference instances with smart pointer holder types + without constructing the holder if desired. The + `PYBIND11_DECLARE_HOLDER_TYPE` macro now accepts an optional second + parameter to indicate whether the holder type uses intrusive reference + counting. [#533](https://github.com/pybind/pybind11/pull/533) and + [#561](https://github.com/pybind/pybind11/pull/561). + +- Mapping a stateless C++ function to Python and back is now "for free" + (i.e. no extra indirections or argument conversion overheads). [rev. + 954b79](https://github.com/pybind/pybind11/commit/954b79). + +- Bindings for `std::valarray`. + [#545](https://github.com/pybind/pybind11/pull/545). + +- Improved support for C++17 capable compilers. + [#562](https://github.com/pybind/pybind11/pull/562). + +- Bindings for `std::optional`. + [#475](https://github.com/pybind/pybind11/pull/475), + [#476](https://github.com/pybind/pybind11/pull/476), + [#479](https://github.com/pybind/pybind11/pull/479), + [#499](https://github.com/pybind/pybind11/pull/499), and + [#501](https://github.com/pybind/pybind11/pull/501). + +- `stl_bind.h`: general improvements and support for `std::map` and + `std::unordered_map`. + [#490](https://github.com/pybind/pybind11/pull/490), + [#282](https://github.com/pybind/pybind11/pull/282), + [#235](https://github.com/pybind/pybind11/pull/235). + +- The `std::tuple`, `std::pair`, `std::list`, and `std::vector` type + casters now accept any Python sequence type as input. [rev. + 107285](https://github.com/pybind/pybind11/commit/107285). + +- Improved CMake Python detection on multi-architecture Linux. + [#532](https://github.com/pybind/pybind11/pull/532). + +- Infrastructure to selectively disable or enable parts of the + automatically generated docstrings. + [#486](https://github.com/pybind/pybind11/pull/486). + +- `reference` and `reference_internal` are now the default return value + properties for static and non-static properties, respectively. + [#473](https://github.com/pybind/pybind11/pull/473). (the previous + defaults were `automatic`). + [#473](https://github.com/pybind/pybind11/pull/473). + +- Support for `std::unique_ptr` with non-default deleters or no deleter + at all (`py::nodelete`). + [#384](https://github.com/pybind/pybind11/pull/384). + +- Deprecated `handle::call()` method. The new syntax to call Python + functions is simply `handle()`. It can also be invoked explicitly via + `handle::operator()`, where `X` is an optional return value policy. + +- Print more informative error messages when `make_tuple()` or `cast()` + fail. [#262](https://github.com/pybind/pybind11/pull/262). + +- Creation of holder types for classes deriving from + `std::enable_shared_from_this<>` now also works for `const` values. + [#260](https://github.com/pybind/pybind11/pull/260). + +- `make_iterator()` improvements for better compatibility with various + types (now uses prefix increment operator); it now also accepts + iterators with different begin/end types as long as they are equality + comparable. [#247](https://github.com/pybind/pybind11/pull/247). + +- `arg()` now accepts a wider range of argument types for default + values. [#244](https://github.com/pybind/pybind11/pull/244). + +- Support `keep_alive` where the nurse object may be `None`. + [#341](https://github.com/pybind/pybind11/pull/341). + +- Added constructors for `str` and `bytes` from zero-terminated char + pointers, and from char pointers and length. Added constructors for + `str` from `bytes` and for `bytes` from `str`, which will perform + UTF-8 decoding/encoding as required. + +- Many other improvements of library internals without user-visible + changes + +## 1.8.1 (July 12, 2016) + +- Fixed a rare but potentially very severe issue when the garbage + collector ran during pybind11 type creation. + +## 1.8.0 (June 14, 2016) + +- Redesigned CMake build system which exports a convenient + `pybind11_add_module` function to parent projects. +- `std::vector<>` type bindings analogous to Boost.Python's + `indexing_suite` +- Transparent conversion of sparse and dense Eigen matrices and vectors + (`eigen.h`) +- Added an `ExtraFlags` template argument to the NumPy `array_t<>` + wrapper to disable an enforced cast that may lose precision, e.g. to + create overloads for different precisions and complex vs real-valued + matrices. +- Prevent implicit conversion of floating point values to integral types + in function arguments +- Fixed incorrect default return value policy for functions returning a + shared pointer +- Don't allow registering a type via `class_` twice +- Don't allow casting a `None` value into a C++ lvalue reference +- Fixed a crash in `enum_::operator==` that was triggered by the + `help()` command +- Improved detection of whether or not custom C++ types can be + copy/move-constructed +- Extended `str` type to also work with `bytes` instances +- Added a `"name"_a` user defined string literal that is equivalent to + `py::arg("name")`. +- When specifying function arguments via `py::arg`, the test that + verifies the number of arguments now runs at compile time. +- Added `[[noreturn]]` attribute to `pybind11_fail()` to quench some + compiler warnings +- List function arguments in exception text when the dispatch code + cannot find a matching overload +- Added `PYBIND11_OVERLOAD_NAME` and `PYBIND11_OVERLOAD_PURE_NAME` + macros which can be used to override virtual methods whose name + differs in C++ and Python (e.g. `__call__` and `operator()`) +- Various minor `iterator` and `make_iterator()` improvements +- Transparently support `__bool__` on Python 2.x and Python 3.x +- Fixed issue with destructor of unpickled object not being called +- Minor CMake build system improvements on Windows +- New `pybind11::args` and `pybind11::kwargs` types to create functions + which take an arbitrary number of arguments and keyword arguments +- New syntax to call a Python function from C++ using `*args` and + `*kwargs` +- The functions `def_property_*` now correctly process docstring + arguments (these formerly caused a segmentation fault) +- Many `mkdoc.py` improvements (enumerations, template arguments, + `DOC()` macro accepts more arguments) +- Cygwin support +- Documentation improvements (pickling support, `keep_alive`, macro + usage) + +## 1.7 (April 30, 2016) + +- Added a new `move` return value policy that triggers C++11 move + semantics. The automatic return value policy falls back to this case + whenever a rvalue reference is encountered +- Significantly more general GIL state routines that are used instead of + Python's troublesome `PyGILState_Ensure` and `PyGILState_Release` API +- Redesign of opaque types that drastically simplifies their usage +- Extended ability to pass values of type `[const] void *` +- `keep_alive` fix: don't fail when there is no patient +- `functional.h`: acquire the GIL before calling a Python function +- Added Python RAII type wrappers `none` and `iterable` +- Added `*args` and `*kwargs` pass-through parameters to + `pybind11.get_include()` function +- Iterator improvements and fixes +- Documentation on return value policies and opaque types improved + +## 1.6 (April 30, 2016) + +- Skipped due to upload to PyPI gone wrong and inability to recover + () + +## 1.5 (April 21, 2016) + +- For polymorphic types, use RTTI to try to return the closest type + registered with pybind11 +- Pickling support for serializing and unserializing C++ instances to a + byte stream in Python +- Added a convenience routine `make_iterator()` which turns a range + indicated by a pair of C++ iterators into a iterable Python object +- Added `len()` and a variadic `make_tuple()` function +- Addressed a rare issue that could confuse the current virtual function + dispatcher and another that could lead to crashes in multi-threaded + applications +- Added a `get_include()` function to the Python module that returns the + path of the directory containing the installed pybind11 header files +- Documentation improvements: import issues, symbol visibility, + pickling, limitations +- Added casting support for `std::reference_wrapper<>` + +## 1.4 (April 7, 2016) + +- Transparent type conversion for `std::wstring` and `wchar_t` +- Allow passing `nullptr`-valued strings +- Transparent passing of `void *` pointers using capsules +- Transparent support for returning values wrapped in + `std::unique_ptr<>` +- Improved docstring generation for compatibility with Sphinx +- Nicer debug error message when default parameter construction fails +- Support for "opaque" types that bypass the transparent conversion + layer for STL containers +- Redesigned type casting interface to avoid ambiguities that could + occasionally cause compiler errors +- Redesigned property implementation; fixes crashes due to an + unfortunate default return value policy +- Anaconda package generation support + +## 1.3 (March 8, 2016) + +- Added support for the Intel C++ compiler (v15+) +- Added support for the STL unordered set/map data structures +- Added support for the STL linked list data structure +- NumPy-style broadcasting support in `pybind11::vectorize` +- pybind11 now displays more verbose error messages when + `arg::operator=()` fails +- pybind11 internal data structures now live in a version-dependent + namespace to avoid ABI issues +- Many, many bugfixes involving corner cases and advanced usage + +## 1.2 (February 7, 2016) + +- Optional: efficient generation of function signatures at compile time + using C++14 +- Switched to a simpler and more general way of dealing with function + default arguments. Unused keyword arguments in function calls are now + detected and cause errors as expected +- New `keep_alive` call policy analogous to Boost.Python's + `with_custodian_and_ward` +- New `pybind11::base<>` attribute to indicate a subclass relationship +- Improved interface for RAII type wrappers in `pytypes.h` +- Use RAII type wrappers consistently within pybind11 itself. This fixes + various potential refcount leaks when exceptions occur +- Added new `bytes` RAII type wrapper (maps to `string` in Python 2.7) +- Made handle and related RAII classes const correct, using them more + consistently everywhere now +- Got rid of the ugly `__pybind11__` attributes on the Python + side---they are now stored in a C++ hash table that is not visible in + Python +- Fixed refcount leaks involving NumPy arrays and bound functions +- Vastly improved handling of shared/smart pointers +- Removed an unnecessary copy operation in `pybind11::vectorize` +- Fixed naming clashes when both pybind11 and NumPy headers are included +- Added conversions for additional exception types +- Documentation improvements (using multiple extension modules, smart + pointers, other minor clarifications) +- unified infrastructure for parsing variadic arguments in `class_` and + cpp_function +- Fixed license text (was: ZLIB, should have been: 3-clause BSD) +- Python 3.2 compatibility +- Fixed remaining issues when accessing types in another plugin module +- Added enum comparison and casting methods +- Improved SFINAE-based detection of whether types are + copy-constructible +- Eliminated many warnings about unused variables and the use of + `offsetof()` +- Support for `std::array<>` conversions + +## 1.1 (December 7, 2015) + +- Documentation improvements (GIL, wrapping functions, casting, fixed + many typos) +- Generalized conversion of integer types +- Improved support for casting function objects +- Improved support for `std::shared_ptr<>` conversions +- Initial support for `std::set<>` conversions +- Fixed type resolution issue for types defined in a separate plugin + module +- CMake build system improvements +- Factored out generic functionality to non-templated code (smaller code + size) +- Added a code size / compile time benchmark vs Boost.Python +- Added an appveyor CI script + +## 1.0 (October 15, 2015) + +- Initial release diff --git a/third_party/pybind11/docs/classes.rst b/third_party/pybind11/docs/classes.rst new file mode 100644 index 0000000..97ad72f --- /dev/null +++ b/third_party/pybind11/docs/classes.rst @@ -0,0 +1,652 @@ +.. _classes: + +Object-oriented code +#################### + +Creating bindings for a custom type +=================================== + +Let's now look at a more complex example where we'll create bindings for a +custom C++ data structure named ``Pet``. Its definition is given below: + +.. code-block:: cpp + + struct Pet { + Pet(const std::string &name) : name(name) { } + void setName(const std::string &name_) { name = name_; } + const std::string &getName() const { return name; } + + std::string name; + }; + +The binding code for ``Pet`` looks as follows: + +.. code-block:: cpp + + #include + + namespace py = pybind11; + + PYBIND11_MODULE(example, m, py::mod_gil_not_used()) { + py::class_(m, "Pet") + .def(py::init()) + .def("setName", &Pet::setName) + .def("getName", &Pet::getName); + } + +``py::class_`` creates bindings for a C++ *class* or *struct*-style data +structure. :func:`init` is a convenience function that takes the types of a +constructor's parameters as template arguments and wraps the corresponding +constructor (see the :ref:`custom_constructors` section for details). + +.. note:: + + Starting with pybind11v3, it is recommended to include `py::smart_holder` + in most situations for safety, especially if you plan to support conversions + to C++ smart pointers. See :ref:`smart_holder` for more information. + +An interactive Python session demonstrating this example is shown below: + +.. code-block:: pycon + + % python + >>> import example + >>> p = example.Pet("Molly") + >>> print(p) + + >>> p.getName() + 'Molly' + >>> p.setName("Charly") + >>> p.getName() + 'Charly' + +.. seealso:: + + Static member functions can be bound in the same way using + :func:`class_::def_static`. + +.. note:: + + Binding C++ types in unnamed namespaces (also known as anonymous namespaces) + works reliably on many platforms, but not all. The `XFAIL_CONDITION` in + tests/test_unnamed_namespace_a.py encodes the currently known conditions. + For background see `#4319 `_. + If portability is a concern, it is therefore not recommended to bind C++ + types in unnamed namespaces. It will be safest to manually pick unique + namespace names. + +Keyword and default arguments +============================= +It is possible to specify keyword and default arguments using the syntax +discussed in the previous chapter. Refer to the sections :ref:`keyword_args` +and :ref:`default_args` for details. + +Binding lambda functions +======================== + +Note how ``print(p)`` produced a rather useless summary of our data structure in the example above: + +.. code-block:: pycon + + >>> print(p) + + +To address this, we could bind a utility function that returns a human-readable +summary to the special method slot named ``__repr__``. Unfortunately, there is no +suitable functionality in the ``Pet`` data structure, and it would be nice if +we did not have to change it. This can easily be accomplished by binding a +Lambda function instead: + +.. code-block:: cpp + + py::class_(m, "Pet") + .def(py::init()) + .def("setName", &Pet::setName) + .def("getName", &Pet::getName) + .def("__repr__", + [](const Pet &a) { + return ""; + } + ); + +Both stateless [#f1]_ and stateful lambda closures are supported by pybind11. +With the above change, the same Python code now produces the following output: + +.. code-block:: pycon + + >>> print(p) + + +.. [#f1] Stateless closures are those with an empty pair of brackets ``[]`` as the capture object. + +.. _properties: + +Instance and static fields +========================== + +We can also directly expose the ``name`` field using the +:func:`class_::def_readwrite` method. A similar :func:`class_::def_readonly` +method also exists for ``const`` fields. + +.. code-block:: cpp + + py::class_(m, "Pet") + .def(py::init()) + .def_readwrite("name", &Pet::name) + // ... remainder ... + +This makes it possible to write + +.. code-block:: pycon + + >>> p = example.Pet("Molly") + >>> p.name + 'Molly' + >>> p.name = "Charly" + >>> p.name + 'Charly' + +Now suppose that ``Pet::name`` was a private internal variable +that can only be accessed via setters and getters. + +.. code-block:: cpp + + class Pet { + public: + Pet(const std::string &name) : name(name) { } + void setName(const std::string &name_) { name = name_; } + const std::string &getName() const { return name; } + private: + std::string name; + }; + +In this case, the method :func:`class_::def_property` +(:func:`class_::def_property_readonly` for read-only data) can be used to +provide a field-like interface within Python that will transparently call +the setter and getter functions: + +.. code-block:: cpp + + py::class_(m, "Pet") + .def(py::init()) + .def_property("name", &Pet::getName, &Pet::setName) + // ... remainder ... + +Write only properties can be defined by passing ``nullptr`` as the +input for the read function. + +.. seealso:: + + Similar functions :func:`class_::def_readwrite_static`, + :func:`class_::def_readonly_static` :func:`class_::def_property_static`, + and :func:`class_::def_property_readonly_static` are provided for binding + static variables and properties. Please also see the section on + :ref:`static_properties` in the advanced part of the documentation. + +Dynamic attributes +================== + +Native Python classes can pick up new attributes dynamically: + +.. code-block:: pycon + + >>> class Pet: + ... name = "Molly" + ... + >>> p = Pet() + >>> p.name = "Charly" # overwrite existing + >>> p.age = 2 # dynamically add a new attribute + +By default, classes exported from C++ do not support this and the only writable +attributes are the ones explicitly defined using :func:`class_::def_readwrite` +or :func:`class_::def_property`. + +.. code-block:: cpp + + py::class_(m, "Pet") + .def(py::init<>()) + .def_readwrite("name", &Pet::name); + +Trying to set any other attribute results in an error: + +.. code-block:: pycon + + >>> p = example.Pet() + >>> p.name = "Charly" # OK, attribute defined in C++ + >>> p.age = 2 # fail + AttributeError: 'Pet' object has no attribute 'age' + +To enable dynamic attributes for C++ classes, the :class:`py::dynamic_attr` tag +must be added to the :class:`py::class_` constructor: + +.. code-block:: cpp + + py::class_(m, "Pet", py::dynamic_attr()) + .def(py::init<>()) + .def_readwrite("name", &Pet::name); + +Now everything works as expected: + +.. code-block:: pycon + + >>> p = example.Pet() + >>> p.name = "Charly" # OK, overwrite value in C++ + >>> p.age = 2 # OK, dynamically add a new attribute + >>> p.__dict__ # just like a native Python class + {'age': 2} + +Note that there is a small runtime cost for a class with dynamic attributes. +Not only because of the addition of a ``__dict__``, but also because of more +expensive garbage collection tracking which must be activated to resolve +possible circular references. Native Python classes incur this same cost by +default, so this is not anything to worry about. By default, pybind11 classes +are more efficient than native Python classes. Enabling dynamic attributes +just brings them on par. + +.. _inheritance: + +Inheritance and automatic downcasting +===================================== + +Suppose now that the example consists of two data structures with an +inheritance relationship: + +.. code-block:: cpp + + struct Pet { + Pet(const std::string &name) : name(name) { } + std::string name; + }; + + struct Dog : Pet { + Dog(const std::string &name) : Pet(name) { } + std::string bark() const { return "woof!"; } + }; + +There are two different ways of indicating a hierarchical relationship to +pybind11: the first specifies the C++ base class as an extra template +parameter of the ``py::class_``: + +.. code-block:: cpp + + py::class_(m, "Pet") + .def(py::init()) + .def_readwrite("name", &Pet::name); + + // Method 1: template parameter: + py::class_(m, "Dog") + .def(py::init()) + .def("bark", &Dog::bark); + +Alternatively, we can also assign a name to the previously bound ``Pet`` +``py::class_`` object and reference it when binding the ``Dog`` class: + +.. code-block:: cpp + + py::class_ pet(m, "Pet"); + pet.def(py::init()) + .def_readwrite("name", &Pet::name); + + // Method 2: pass parent class_ object: + py::class_(m, "Dog", pet /* <- specify Python parent type */) + .def(py::init()) + .def("bark", &Dog::bark); + +Functionality-wise, both approaches are equivalent. Afterwards, instances will +expose fields and methods of both types: + +.. code-block:: pycon + + >>> p = example.Dog("Molly") + >>> p.name + 'Molly' + >>> p.bark() + 'woof!' + +The C++ classes defined above are regular non-polymorphic types with an +inheritance relationship. This is reflected in Python: + +.. code-block:: cpp + + // Return a base pointer to a derived instance + m.def("pet_store", []() { return std::unique_ptr(new Dog("Molly")); }); + +.. code-block:: pycon + + >>> p = example.pet_store() + >>> type(p) # `Dog` instance behind `Pet` pointer + Pet # no pointer downcasting for regular non-polymorphic types + >>> p.bark() + AttributeError: 'Pet' object has no attribute 'bark' + +The function returned a ``Dog`` instance, but because it's a non-polymorphic +type behind a base pointer, Python only sees a ``Pet``. In C++, a type is only +considered polymorphic if it has at least one virtual function and pybind11 +will automatically recognize this: + +.. code-block:: cpp + + struct PolymorphicPet { + virtual ~PolymorphicPet() = default; + }; + + struct PolymorphicDog : PolymorphicPet { + std::string bark() const { return "woof!"; } + }; + + // Same binding code + py::class_(m, "PolymorphicPet"); + py::class_(m, "PolymorphicDog") + .def(py::init<>()) + .def("bark", &PolymorphicDog::bark); + + // Again, return a base pointer to a derived instance + m.def("pet_store2", []() { return std::unique_ptr(new PolymorphicDog); }); + +.. code-block:: pycon + + >>> p = example.pet_store2() + >>> type(p) + PolymorphicDog # automatically downcast + >>> p.bark() + 'woof!' + +Given a pointer to a polymorphic base, pybind11 performs automatic downcasting +to the actual derived type. Note that this goes beyond the usual situation in +C++: we don't just get access to the virtual functions of the base, we get the +concrete derived type including functions and attributes that the base type may +not even be aware of. + +.. seealso:: + + For more information about polymorphic behavior see :ref:`overriding_virtuals`. + + +Overloaded methods +================== + +Sometimes there are several overloaded C++ methods with the same name taking +different kinds of input arguments: + +.. code-block:: cpp + + struct Pet { + Pet(const std::string &name, int age) : name(name), age(age) { } + + void set(int age_) { age = age_; } + void set(const std::string &name_) { name = name_; } + + std::string name; + int age; + }; + +Attempting to bind ``Pet::set`` will cause an error since the compiler does not +know which method the user intended to select. We can disambiguate by casting +them to function pointers. Binding multiple functions to the same Python name +automatically creates a chain of function overloads that will be tried in +sequence. + +.. code-block:: cpp + + py::class_(m, "Pet") + .def(py::init()) + .def("set", static_cast(&Pet::set), "Set the pet's age") + .def("set", static_cast(&Pet::set), "Set the pet's name"); + +The overload signatures are also visible in the method's docstring: + +.. code-block:: pycon + + >>> help(example.Pet) + + class Pet(__builtin__.object) + | Methods defined here: + | + | __init__(...) + | Signature : (Pet, str, int) -> NoneType + | + | set(...) + | 1. Signature : (Pet, int) -> NoneType + | + | Set the pet's age + | + | 2. Signature : (Pet, str) -> NoneType + | + | Set the pet's name + +If you have a C++14 compatible compiler [#cpp14]_, you can use an alternative +syntax to cast the overloaded function: + +.. code-block:: cpp + + py::class_(m, "Pet") + .def("set", py::overload_cast(&Pet::set), "Set the pet's age") + .def("set", py::overload_cast(&Pet::set), "Set the pet's name"); + +Here, ``py::overload_cast`` only requires the parameter types to be specified. +The return type and class are deduced. This avoids the additional noise of +``void (Pet::*)()`` as seen in the raw cast. If a function is overloaded based +on constness, the ``py::const_`` tag should be used: + +.. code-block:: cpp + + struct Widget { + int foo(int x, float y); + int foo(int x, float y) const; + }; + + py::class_(m, "Widget") + .def("foo_mutable", py::overload_cast(&Widget::foo)) + .def("foo_const", py::overload_cast(&Widget::foo, py::const_)); + +If you prefer the ``py::overload_cast`` syntax but have a C++11 compatible compiler only, +you can use ``py::detail::overload_cast_impl`` with an additional set of parentheses: + +.. code-block:: cpp + + template + using overload_cast_ = pybind11::detail::overload_cast_impl; + + py::class_(m, "Pet") + .def("set", overload_cast_()(&Pet::set), "Set the pet's age") + .def("set", overload_cast_()(&Pet::set), "Set the pet's name"); + +.. [#cpp14] A compiler which supports the ``-std=c++14`` flag. + +.. note:: + + To define multiple overloaded constructors, simply declare one after the + other using the ``.def(py::init<...>())`` syntax. The existing machinery + for specifying keyword and default arguments also works. + +☝️ Pitfalls with raw pointers and shared ownership +================================================== + +``py::class_``-wrapped objects automatically manage the lifetime of the +wrapped C++ object, in collaboration with the chosen holder type (see +:ref:`py_class_holder`). When wrapping C++ functions involving raw pointers, +care needs to be taken to not accidentally undermine automatic lifetime +management. For example, ownership is inadvertently transferred here: + +.. code-block:: cpp + + class Child { }; + + class Parent { + public: + Parent() : child(std::make_shared()) { } + Child *get_child() { return child.get(); } /* DANGER */ + private: + std::shared_ptr child; + }; + + PYBIND11_MODULE(example, m, py::mod_gil_not_used()) { + py::class_>(m, "Child"); + + py::class_>(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`` is lost. Therefore pybind11 +will create a second independent ``std::shared_ptr`` 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`` as a base class for +``Child``, or adding a member function to ``Parent`` that returns +``std::shared_ptr``), or if that is not feasible, by using +``return_value_policy::reference_internal``. What is the best approach +depends on the exact situation. + +A highly effective way to stay in the clear — even in pure C++, but +especially when binding C++ code to Python — is to consistently prefer +``std::shared_ptr`` or ``std::unique_ptr`` over passing raw pointers. + +.. _native_enum: + +Enumerations and internal types +=============================== + +Let's now suppose that the example class contains internal types like enumerations, e.g.: + +.. code-block:: cpp + + struct Pet { + enum Kind { + Dog = 0, + Cat + }; + + struct Attributes { + float age = 0; + }; + + Pet(const std::string &name, Kind type) : name(name), type(type) { } + + std::string name; + Kind type; + Attributes attr; + }; + +The binding code for this example looks as follows: + +.. code-block:: cpp + + #include // Not already included with pybind11.h + + py::class_ pet(m, "Pet"); + + pet.def(py::init()) + .def_readwrite("name", &Pet::name) + .def_readwrite("type", &Pet::type) + .def_readwrite("attr", &Pet::attr); + + py::native_enum(pet, "Kind", "enum.Enum") + .value("Dog", Pet::Kind::Dog) + .value("Cat", Pet::Kind::Cat) + .export_values() + .finalize(); + + py::class_(pet, "Attributes") + .def(py::init<>()) + .def_readwrite("age", &Pet::Attributes::age); + + +To ensure that the nested types ``Kind`` and ``Attributes`` are created +within the scope of ``Pet``, the ``pet`` ``py::class_`` instance must be +supplied to the ``py::native_enum`` and ``py::class_`` constructors. The +``.export_values()`` function is available for exporting the enum entries +into the parent scope, if desired. + +``py::native_enum`` was introduced with pybind11v3. It binds C++ enum types +to native Python enum types, typically types in Python's +`stdlib enum `_ module, +which are `PEP 435 compatible `_. +This is the recommended way to bind C++ enums. +The older ``py::enum_`` is not PEP 435 compatible +(see `issue #2332 `_) +but remains supported indefinitely for backward compatibility. +New bindings should prefer ``py::native_enum``. + +.. note:: + + The deprecated ``py::enum_`` is :ref:`documented here `. + +The ``.finalize()`` call above is needed because Python's native enums +cannot be built incrementally — all name/value pairs need to be passed at +once. To achieve this, ``py::native_enum`` acts as a buffer to collect the +name/value pairs. The ``.finalize()`` call uses the accumulated name/value +pairs to build the arguments for constructing a native Python enum type. + +The ``py::native_enum`` constructor takes a third argument, +``native_type_name``, which specifies the fully qualified name of the Python +base class to use — e.g., ``"enum.Enum"`` or ``"enum.IntEnum"``. A fourth +optional argument, ``class_doc``, provides the docstring for the generated +class. + +For example: + +.. code-block:: cpp + + py::native_enum(pet, "Kind", "enum.IntEnum", "Constant specifying the kind of pet") + +You may use any fully qualified Python name for ``native_type_name``. +The only requirement is that the named type is similar to +`enum.Enum `_ +in these ways: + +* Has a `constructor similar to that of enum.Enum + `_:: + + Colors = enum.Enum("Colors", (("Red", 0), ("Green", 1))) + +* A `C++ underlying `_ + enum value can be passed to the constructor for the Python enum value:: + + red = Colors(0) + +* The enum values have a ``.value`` property yielding a value that + can be cast to the C++ underlying type:: + + underlying = red.value + +As of Python 3.13, the compatible `types in the stdlib enum module +`_ are: +``Enum``, ``IntEnum``, ``Flag``, ``IntFlag``. + +.. note:: + + In rare cases, a C++ enum may be bound to Python via a + :ref:`custom type caster `. In such cases, a + template specialization like this may be required: + + .. code-block:: cpp + + #if defined(PYBIND11_HAS_NATIVE_ENUM) + namespace pybind11::detail { + template + struct type_caster_enum_type_enabled< + FancyEnum, + enable_if_t::value>> : std::false_type {}; + } + #endif + + This specialization is needed only if the custom type caster is templated. + + The ``PYBIND11_HAS_NATIVE_ENUM`` guard is needed only if backward + compatibility with pybind11v2 is required. diff --git a/third_party/pybind11/docs/cmake/index.rst b/third_party/pybind11/docs/cmake/index.rst new file mode 100644 index 0000000..eaf66d7 --- /dev/null +++ b/third_party/pybind11/docs/cmake/index.rst @@ -0,0 +1,8 @@ +CMake helpers +------------- + +Pybind11 can be used with ``add_subdirectory(extern/pybind11)``, or from an +install with ``find_package(pybind11 CONFIG)``. The interface provided in +either case is functionally identical. + +.. cmake-module:: ../../tools/pybind11Config.cmake.in diff --git a/third_party/pybind11/docs/compiling.rst b/third_party/pybind11/docs/compiling.rst new file mode 100644 index 0000000..e74e3b2 --- /dev/null +++ b/third_party/pybind11/docs/compiling.rst @@ -0,0 +1,731 @@ +.. _compiling: + +Build systems +############# + +For an overview of Python packaging including compiled packaging with a pybind11 +example, along with a cookiecutter that includes several pybind11 options, see +the `Scientific Python Development Guide`_. + +.. _Scientific Python Development Guide: https://learn.scientific-python.org/development/guides/packaging-compiled/ + +.. scikit-build-core: + +Modules with CMake +================== + +A Python extension module can be created with just a few lines of code: + +.. code-block:: cmake + + cmake_minimum_required(VERSION 3.15...4.0) + project(example LANGUAGES CXX) + + set(PYBIND11_FINDPYTHON ON) + find_package(pybind11 CONFIG REQUIRED) + + pybind11_add_module(example example.cpp) + install(TARGETS example DESTINATION .) + +(You use the ``add_subdirectory`` instead, see the example in :ref:`cmake`.) In +this example, the code is located in a file named :file:`example.cpp`. Either +method will import the pybind11 project which provides the +``pybind11_add_module`` function. It will take care of all the details needed +to build a Python extension module on any platform. + +To build with pip, build, cibuildwheel, uv, or other Python tools, you can +add a ``pyproject.toml`` file like this: + +.. code-block:: toml + + [build-system] + requires = ["scikit-build-core", "pybind11"] + build-backend = "scikit_build_core.build" + + [project] + name = "example" + version = "0.1.0" + +You don't need setuptools files like ``MANIFEST.in``, ``setup.py``, or +``setup.cfg``, as this is not setuptools. See `scikit-build-core`_ for details. +For projects you plan to upload to PyPI, be sure to fill out the ``[project]`` +table with other important metadata as well (see `Writing pyproject.toml`_). + +A working sample project can be found in the [scikit_build_example]_ +repository. An older and harder-to-maintain method is in [cmake_example]_. More +details about our cmake support can be found below in :ref:`cmake`. + +.. _scikit-build-core: https://scikit-build-core.readthedocs.io + +.. [scikit_build_example] https://github.com/pybind/scikit_build_example + +.. [cmake_example] https://github.com/pybind/cmake_example + +.. _modules-meson-python: + +Modules with meson-python +========================= + +You can also build a package with `Meson`_ using `meson-python`_, if you prefer +that. Your ``meson.build`` file would look something like this: + +.. _meson-example: + +.. code-block:: meson + + project( + 'example', + 'cpp', + version: '0.1.0', + default_options: [ + 'cpp_std=c++11', + ], + ) + + py = import('python').find_installation(pure: false) + pybind11_dep = dependency('pybind11') + + py.extension_module('example', + 'example.cpp', + install: true, + dependencies : [pybind11_dep], + ) + + +And you would need a ``pyproject.toml`` file like this: + +.. code-block:: toml + + [build-system] + requires = ["meson-python", "pybind11"] + build-backend = "mesonpy" + +Meson-python *requires* your project to be in git (or mercurial) as it uses it +for the SDist creation. For projects you plan to upload to PyPI, be sure to fill out the +``[project]`` table as well (see `Writing pyproject.toml`_). + + +.. _Writing pyproject.toml: https://packaging.python.org/en/latest/guides/writing-pyproject-toml + +.. _meson: https://mesonbuild.com + +.. _meson-python: https://meson-python.readthedocs.io/en/latest + +.. _build-setuptools: + +Modules with setuptools +======================= + +For projects on PyPI, a historically popular option is setuptools. Sylvain +Corlay has kindly provided an example project which shows how to set up +everything, including automatic generation of documentation using Sphinx. +Please refer to the [python_example]_ repository. + +.. [python_example] https://github.com/pybind/python_example + +A helper file is provided with pybind11 that can simplify usage with setuptools. + +To use pybind11 inside your ``setup.py``, you have to have some system to +ensure that ``pybind11`` is installed when you build your package. There are +four possible ways to do this, and pybind11 supports all four: You can ask all +users to install pybind11 beforehand (bad), you can use +:ref:`setup_helpers-pep518` (good), ``setup_requires=`` (discouraged), or you +can :ref:`setup_helpers-copy-manually` (works but you have to manually sync +your copy to get updates). Third party packagers like conda-forge generally +strongly prefer the ``pyproject.toml`` method, as it gives them control over +the ``pybind11`` version, and they may apply patches, etc. + +An example of a ``setup.py`` using pybind11's helpers: + +.. code-block:: python + + from glob import glob + from setuptools import setup + from pybind11.setup_helpers import Pybind11Extension + + ext_modules = [ + Pybind11Extension( + "python_example", + sorted(glob("src/*.cpp")), # Sort source files for reproducibility + ), + ] + + setup(..., ext_modules=ext_modules) + +If you want to do an automatic search for the highest supported C++ standard, +that is supported via a ``build_ext`` command override; it will only affect +``Pybind11Extensions``: + +.. code-block:: python + + from glob import glob + from setuptools import setup + from pybind11.setup_helpers import Pybind11Extension, build_ext + + ext_modules = [ + Pybind11Extension( + "python_example", + sorted(glob("src/*.cpp")), + ), + ] + + setup(..., cmdclass={"build_ext": build_ext}, ext_modules=ext_modules) + +If you have single-file extension modules that are directly stored in the +Python source tree (``foo.cpp`` in the same directory as where a ``foo.py`` +would be located), you can also generate ``Pybind11Extensions`` using +``setup_helpers.intree_extensions``: ``intree_extensions(["path/to/foo.cpp", +...])`` returns a list of ``Pybind11Extensions`` which can be passed to +``ext_modules``, possibly after further customizing their attributes +(``libraries``, ``include_dirs``, etc.). By doing so, a ``foo.*.so`` extension +module will be generated and made available upon installation. + +``intree_extension`` will automatically detect if you are using a ``src``-style +layout (as long as no namespace packages are involved), but you can also +explicitly pass ``package_dir`` to it (as in ``setuptools.setup``). + +Since pybind11 does not require NumPy when building, a light-weight replacement +for NumPy's parallel compilation distutils tool is included. Use it like this: + +.. code-block:: python + + from pybind11.setup_helpers import ParallelCompile + + # Optional multithreaded build + ParallelCompile("NPY_NUM_BUILD_JOBS").install() + + setup(...) + +The argument is the name of an environment variable to control the number of +threads, such as ``NPY_NUM_BUILD_JOBS`` (as used by NumPy), though you can set +something different if you want; ``CMAKE_BUILD_PARALLEL_LEVEL`` is another choice +a user might expect. You can also pass ``default=N`` to set the default number +of threads (0 will take the number of threads available) and ``max=N``, the +maximum number of threads; if you have a large extension you may want set this +to a memory dependent number. + +If you are developing rapidly and have a lot of C++ files, you may want to +avoid rebuilding files that have not changed. For simple cases were you are +using ``pip install -e .`` and do not have local headers, you can skip the +rebuild if an object file is newer than its source (headers are not checked!) +with the following: + +.. code-block:: python + + from pybind11.setup_helpers import ParallelCompile, naive_recompile + + ParallelCompile("NPY_NUM_BUILD_JOBS", needs_recompile=naive_recompile).install() + + +If you have a more complex build, you can implement a smarter function and pass +it to ``needs_recompile``, or you can use [Ccache]_ instead. ``CXX="cache g++" +pip install -e .`` would be the way to use it with GCC, for example. Unlike the +simple solution, this even works even when not compiling in editable mode, but +it does require Ccache to be installed. + +Keep in mind that Pip will not even attempt to rebuild if it thinks it has +already built a copy of your code, which it deduces from the version number. +One way to avoid this is to use [setuptools_scm]_, which will generate a +version number that includes the number of commits since your last tag and a +hash for a dirty directory. Another way to force a rebuild is purge your cache +or use Pip's ``--no-cache-dir`` option. + +You also need a ``MANIFEST.in`` file to include all relevant files so that you +can make an SDist. If you use `pypa-build`_, that will build an SDist then a +wheel from that SDist by default, so you can look inside those files (wheels +are just zip files with a ``.whl`` extension) to make sure you aren't missing +files. `check-manifest`_ (setuptools specific) or `check-sdist`_ (general) are +CLI tools that can compare the SDist contents with your source control. + +.. [Ccache] https://ccache.dev + +.. [setuptools_scm] https://github.com/pypa/setuptools_scm + +.. _setup_helpers-pep518: + +Build requirements +------------------ + +With a ``pyproject.toml`` file, you can ensure that ``pybind11`` is available +during the compilation of your project. When this file exists, Pip will make a +new virtual environment, download just the packages listed here in +``requires=``, and build a wheel (binary Python package). It will then throw +away the environment, and install your wheel. + +Your ``pyproject.toml`` file will likely look something like this: + +.. code-block:: toml + + [build-system] + requires = ["setuptools", "pybind11"] + build-backend = "setuptools.build_meta" + +.. _PEP 517: https://www.python.org/dev/peps/pep-0517/ +.. _cibuildwheel: https://cibuildwheel.pypa.io +.. _pypa-build: https://build.pypa.io/en/latest/ +.. _check-manifest: https://pypi.io/project/check-manifest +.. _check-sdist: https://pypi.io/project/check-sdist + +.. _setup_helpers-copy-manually: + +Copy manually +------------- + +You can also copy ``setup_helpers.py`` directly to your project; it was +designed to be usable standalone, like the old example ``setup.py``. You can +set ``include_pybind11=False`` to skip including the pybind11 package headers, +so you can use it with git submodules and a specific git version. If you use +this, you will need to import from a local file in ``setup.py`` and ensure the +helper file is part of your MANIFEST. + + +Closely related, if you include pybind11 as a subproject, you can run the +``setup_helpers.py`` inplace. If loaded correctly, this should even pick up +the correct include for pybind11, though you can turn it off as shown above if +you want to input it manually. + +Suggested usage if you have pybind11 as a submodule in ``extern/pybind11``: + +.. code-block:: python + + DIR = os.path.abspath(os.path.dirname(__file__)) + + sys.path.append(os.path.join(DIR, "extern", "pybind11")) + from pybind11.setup_helpers import Pybind11Extension # noqa: E402 + + del sys.path[-1] + + +.. versionchanged:: 2.6 + + Added ``setup_helpers`` file. + +Building with cppimport +======================== + +[cppimport]_ is a small Python import hook that determines whether there is a C++ +source file whose name matches the requested module. If there is, the file is +compiled as a Python extension using pybind11 and placed in the same folder as +the C++ source file. Python is then able to find the module and load it. + +.. [cppimport] https://github.com/tbenthompson/cppimport + + + +.. _cmake: + +Building with CMake +=================== + +For C++ codebases that have an existing CMake-based build system, a Python +extension module can be created with just a few lines of code, as seen above in +the module section. Pybind11 currently defaults to the old mechanism, though be +aware that CMake 3.27 removed the old mechanism, so pybind11 will automatically +switch if the old mechanism is not available. Please opt into the new mechanism +if at all possible. Our default may change in future versions. This is the +minimum required: + + + +.. versionchanged:: 2.6 + CMake 3.4+ is required. + +.. versionchanged:: 2.11 + CMake 3.5+ is required. + +.. versionchanged:: 2.14 + CMake 3.15+ is required. + + +Further information can be found at :doc:`cmake/index`. + +pybind11_add_module +------------------- + +To ease the creation of Python extension modules, pybind11 provides a CMake +function with the following signature: + +.. code-block:: cmake + + pybind11_add_module( [MODULE | SHARED] [EXCLUDE_FROM_ALL] + [NO_EXTRAS] [THIN_LTO] [OPT_SIZE] source1 [source2 ...]) + +This function behaves very much like CMake's builtin ``add_library`` (in fact, +it's a wrapper function around that command). It will add a library target +called ```` to be built from the listed source files. In addition, it +will take care of all the Python-specific compiler and linker flags as well +as the OS- and Python-version-specific file extension. The produced target +```` can be further manipulated with regular CMake commands. + +``MODULE`` or ``SHARED`` may be given to specify the type of library. If no +type is given, ``MODULE`` is used by default which ensures the creation of a +Python-exclusive module. Specifying ``SHARED`` will create a more traditional +dynamic library which can also be linked from elsewhere. ``EXCLUDE_FROM_ALL`` +removes this target from the default build (see CMake docs for details). + +Since pybind11 is a template library, ``pybind11_add_module`` adds compiler +flags to ensure high quality code generation without bloat arising from long +symbol names and duplication of code in different translation units. It +sets default visibility to *hidden*, which is required for some pybind11 +features and functionality when attempting to load multiple pybind11 modules +compiled under different pybind11 versions. It also adds additional flags +enabling LTO (Link Time Optimization) and strip unneeded symbols. See the +:ref:`FAQ entry ` for a more detailed explanation. These +latter optimizations are never applied in ``Debug`` mode. If ``NO_EXTRAS`` is +given, they will always be disabled, even in ``Release`` mode. However, this +will result in code bloat and is generally not recommended. + +As stated above, LTO is enabled by default. Some newer compilers also support +different flavors of LTO such as `ThinLTO`_. Setting ``THIN_LTO`` will cause +the function to prefer this flavor if available. The function falls back to +regular LTO if ``-flto=thin`` is not available. If +``CMAKE_INTERPROCEDURAL_OPTIMIZATION`` is set (either ``ON`` or ``OFF``), then +that will be respected instead of the built-in flag search. + +.. note:: + + If you want to set the property form on targets or the + ``CMAKE_INTERPROCEDURAL_OPTIMIZATION_`` versions of this, you should + still use ``set(CMAKE_INTERPROCEDURAL_OPTIMIZATION OFF)`` (otherwise a + no-op) to disable pybind11's ipo flags. + +The ``OPT_SIZE`` flag enables size-based optimization equivalent to the +standard ``/Os`` or ``-Os`` compiler flags and the ``MinSizeRel`` build type, +which avoid optimizations that can substantially increase the size of the +resulting binary. This flag is particularly useful in projects that are split +into performance-critical parts and associated bindings. In this case, we can +compile the project in release mode (and hence, optimize performance globally), +and specify ``OPT_SIZE`` for the binding target, where size might be the main +concern as performance is often less critical here. A ~25% size reduction has +been observed in practice. This flag only changes the optimization behavior at +a per-target level and takes precedence over the global CMake build type +(``Release``, ``RelWithDebInfo``) except for ``Debug`` builds, where +optimizations remain disabled. + +.. _ThinLTO: http://clang.llvm.org/docs/ThinLTO.html + +Configuration variables +----------------------- + +By default, pybind11 will compile modules with the compiler default or the +minimum standard required by pybind11, whichever is higher. You can set the +standard explicitly with +`CMAKE_CXX_STANDARD `_: + +.. code-block:: cmake + + set(CMAKE_CXX_STANDARD 14 CACHE STRING "C++ version selection") # or 11, 14, 17, 20 + set(CMAKE_CXX_STANDARD_REQUIRED ON) # optional, ensure standard is supported + set(CMAKE_CXX_EXTENSIONS OFF) # optional, keep compiler extensions off + +The variables can also be set when calling CMake from the command line using +the ``-D=`` flag. You can also manually set ``CXX_STANDARD`` +on a target or use ``target_compile_features`` on your targets - anything that +CMake supports. + +Classic Python support: The target Python version can be selected by setting +``PYBIND11_PYTHON_VERSION`` or an exact Python installation can be specified +with ``PYTHON_EXECUTABLE``. For example: + +.. code-block:: bash + + cmake -DPYBIND11_PYTHON_VERSION=3.8 .. + + # Another method: + cmake -DPYTHON_EXECUTABLE=/path/to/python .. + + # This often is a good way to get the current Python, works in environments: + cmake -DPYTHON_EXECUTABLE=$(python3 -c "import sys; print(sys.executable)") .. + + +find_package vs. add_subdirectory +--------------------------------- + +For CMake-based projects that don't include the pybind11 repository internally, +an external installation can be detected through ``find_package(pybind11)``. +See the `Config file`_ docstring for details of relevant CMake variables. + +.. code-block:: cmake + + cmake_minimum_required(VERSION 3.15...4.0) + project(example LANGUAGES CXX) + + find_package(pybind11 REQUIRED) + pybind11_add_module(example example.cpp) + +Note that ``find_package(pybind11)`` will only work correctly if pybind11 +has been correctly installed on the system, e. g. after downloading or cloning +the pybind11 repository : + +.. code-block:: bash + + # Classic CMake + cd pybind11 + mkdir build + cd build + cmake .. + make install + + # CMake 3.15+ + cd pybind11 + cmake -S . -B build + cmake --build build -j 2 # Build on 2 cores + cmake --install build + +Once detected, the aforementioned ``pybind11_add_module`` can be employed as +before. The function usage and configuration variables are identical no matter +if pybind11 is added as a subdirectory or found as an installed package. You +can refer to the same [cmake_example]_ repository for a full sample project +-- just swap out ``add_subdirectory`` for ``find_package``. + +.. _Config file: https://github.com/pybind/pybind11/blob/master/tools/pybind11Config.cmake.in + + +.. _find-python-mode: + +FindPython mode +--------------- + +Modern CMake (3.18.2+ ideal) added a new module called FindPython that had a +highly improved search algorithm and modern targets and tools. If you use +FindPython, pybind11 will detect this and use the existing targets instead: + +.. code-block:: cmake + + cmake_minimum_required(VERSION 3.15...4.0) + project(example LANGUAGES CXX) + + find_package(Python 3.8 COMPONENTS Interpreter Development REQUIRED) + find_package(pybind11 CONFIG REQUIRED) + # or add_subdirectory(pybind11) + + pybind11_add_module(example example.cpp) + +You can also use the targets (as listed below) with FindPython. If you define +``PYBIND11_FINDPYTHON``, pybind11 will perform the FindPython step for you +(mostly useful when building pybind11's own tests, or as a way to change search +algorithms from the CMake invocation, with ``-DPYBIND11_FINDPYTHON=ON``. + +.. warning:: + + If you use FindPython to multi-target Python versions, use the individual + targets listed below, and avoid targets that directly include Python parts. + +There are `many ways to hint or force a discovery of a specific Python +installation `_), +setting ``Python_ROOT_DIR`` may be the most common one (though with +virtualenv/venv support, and Conda support, this tends to find the correct +Python version more often than the old system did). + +.. warning:: + + When the Python libraries (i.e. ``libpythonXX.a`` and ``libpythonXX.so`` + on Unix) are not available, as is the case on a manylinux image, the + ``Development`` component will not be resolved by ``FindPython``. When not + using the embedding functionality, CMake 3.18+ allows you to specify + ``Development.Module`` instead of ``Development`` to resolve this issue. + +.. versionadded:: 2.6 + +Advanced: interface library targets +----------------------------------- + +Pybind11 supports modern CMake usage patterns with a set of interface targets, +available in all modes. The targets provided are: + + ``pybind11::headers`` + Just the pybind11 headers and minimum compile requirements + + ``pybind11::pybind11`` + Python headers + ``pybind11::headers`` + + ``pybind11::python_link_helper`` + Just the "linking" part of pybind11:module + + ``pybind11::module`` + Everything for extension modules - ``pybind11::pybind11`` + ``Python::Module`` (FindPython) or ``pybind11::python_link_helper`` + + ``pybind11::embed`` + Everything for embedding the Python interpreter - ``pybind11::pybind11`` + ``Python::Python`` (FindPython) or Python libs + + ``pybind11::lto`` / ``pybind11::thin_lto`` + An alternative to `INTERPROCEDURAL_OPTIMIZATION` for adding link-time optimization. + + ``pybind11::windows_extras`` + ``/bigobj`` and ``/mp`` for MSVC. + + ``pybind11::opt_size`` + ``/Os`` for MSVC, ``-Os`` for other compilers. Does nothing for debug builds. + +Two helper functions are also provided: + + ``pybind11_strip(target)`` + Strips a target (uses ``CMAKE_STRIP`` after the target is built) + + ``pybind11_extension(target)`` + Sets the correct extension (with SOABI) for a target. + +You can use these targets to build complex applications. For example, the +``add_python_module`` function is identical to: + +.. code-block:: cmake + + cmake_minimum_required(VERSION 3.15...4.0) + project(example LANGUAGES CXX) + + find_package(pybind11 REQUIRED) # or add_subdirectory(pybind11) + + add_library(example MODULE main.cpp) + + target_link_libraries(example PRIVATE pybind11::module pybind11::lto pybind11::windows_extras) + + pybind11_extension(example) + if(NOT MSVC AND NOT ${CMAKE_BUILD_TYPE} MATCHES Debug|RelWithDebInfo) + # Strip unnecessary sections of the binary on Linux/macOS + pybind11_strip(example) + endif() + + set_target_properties(example PROPERTIES CXX_VISIBILITY_PRESET "hidden" + CUDA_VISIBILITY_PRESET "hidden") + +Instead of setting properties, you can set ``CMAKE_*`` variables to initialize these correctly. + +.. warning:: + + Since pybind11 is a metatemplate library, it is crucial that certain + compiler flags are provided to ensure high quality code generation. In + contrast to the ``pybind11_add_module()`` command, the CMake interface + provides a *composable* set of targets to ensure that you retain flexibility. + It can be especially important to provide or set these properties; the + :ref:`FAQ ` contains an explanation on why these are needed. + +.. versionadded:: 2.6 + +.. _nopython-mode: + +Advanced: NOPYTHON mode +----------------------- + +If you want complete control, you can set ``PYBIND11_NOPYTHON`` to completely +disable Python integration (this also happens if you run ``FindPython2`` and +``FindPython3`` without running ``FindPython``). This gives you complete +freedom to integrate into an existing system (like `Scikit-Build's +`_ ``PythonExtensions``). +``pybind11_add_module`` and ``pybind11_extension`` will be unavailable, and the +targets will be missing any Python specific behavior. + +.. versionadded:: 2.6 + +Embedding the Python interpreter +-------------------------------- + +In addition to extension modules, pybind11 also supports embedding Python into +a C++ executable or library. In CMake, simply link with the ``pybind11::embed`` +target. It provides everything needed to get the interpreter running. The Python +headers and libraries are attached to the target. Unlike ``pybind11::module``, +there is no need to manually set any additional properties here. For more +information about usage in C++, see :doc:`/advanced/embedding`. + +.. code-block:: cmake + + cmake_minimum_required(VERSION 3.15...4.0) + project(example LANGUAGES CXX) + + find_package(pybind11 REQUIRED) # or add_subdirectory(pybind11) + + add_executable(example main.cpp) + target_link_libraries(example PRIVATE pybind11::embed) + +.. _building_manually: + +Building manually +================= + +pybind11 is a header-only library, hence it is not necessary to link against +any special libraries and there are no intermediate (magic) translation steps. + +On Linux, you can compile an example such as the one given in +:ref:`simple_example` using the following command: + +.. code-block:: bash + + $ c++ -O3 -Wall -shared -std=c++11 -fPIC $(python3 -m pybind11 --includes) example.cpp -o example$(python3-config --extension-suffix) + +The ``python3 -m pybind11 --includes`` command fetches the include paths for +both pybind11 and Python headers. This assumes that pybind11 has been installed +using ``pip`` or ``conda``. If it hasn't, you can also manually specify +``-I /include`` together with the Python includes path +``python3-config --includes``. + +On macOS: the build command is almost the same but it also requires passing +the ``-undefined dynamic_lookup`` flag so as to ignore missing symbols when +building the module: + +.. code-block:: bash + + $ c++ -O3 -Wall -shared -std=c++11 -undefined dynamic_lookup $(python3 -m pybind11 --includes) example.cpp -o example$(python3-config --extension-suffix) + +In general, it is advisable to include several additional build parameters +that can considerably reduce the size of the created binary. Refer to section +:ref:`cmake` for a detailed example of a suitable cross-platform CMake-based +build system that works on all platforms including Windows. + +.. note:: + + On Linux and macOS, it's better to (intentionally) not link against + ``libpython``. The symbols will be resolved when the extension library + is loaded into a Python binary. This is preferable because you might + have several different installations of a given Python version (e.g. the + system-provided Python, and one that ships with a piece of commercial + software). In this way, the plugin will work with both versions, instead + of possibly importing a second Python library into a process that already + contains one (which will lead to a segfault). + + +Building with Bazel +=================== + +You can build with the Bazel build system using the `pybind11_bazel +`_ repository. + +Building with Meson +=================== + +You can use Meson, which has support for ``pybind11`` as a dependency (internally +relying on our ``pkg-config`` support). See the :ref:`module example above `. + + +Generating binding code automatically +===================================== + +The ``Binder`` project is a tool for automatic generation of pybind11 binding +code by introspecting existing C++ codebases using LLVM/Clang. See the +[binder]_ documentation for details. + +.. [binder] http://cppbinder.readthedocs.io/en/latest/about.html + +[AutoWIG]_ is a Python library that wraps automatically compiled libraries into +high-level languages. It parses C++ code using LLVM/Clang technologies and +generates the wrappers using the Mako templating engine. The approach is automatic, +extensible, and applies to very complex C++ libraries, composed of thousands of +classes or incorporating modern meta-programming constructs. + +.. [AutoWIG] https://github.com/StatisKit/AutoWIG + +[semiwrap]_ is a build tool that makes it simpler to wrap C/C++ libraries with +pybind11 by automating large portions of the wrapping process and handling some +of the more complex aspects of creating pybind11 based wrappers (especially with +trampolines to allow inheriting from C++ classes from Python). It includes a +hatchling plugin that autogenerates meson.build files that can be built using +meson, and those build files parse your wrapped headers and generate/compile +pybind11 based wrappers into python extension modules. + +.. [semiwrap] https://semiwrap.readthedocs.io + +[litgen]_ is an automatic python bindings generator with a focus on generating +documented and discoverable bindings: bindings will nicely reproduce the documentation +found in headers. It is based on srcML (srcml.org), a highly scalable, multi-language +parsing tool with a developer centric approach. The API that you want to expose to python +must be C++14 compatible (but your implementation can use more modern constructs). + +.. [litgen] https://pthom.github.io/litgen diff --git a/third_party/pybind11/docs/conf.py b/third_party/pybind11/docs/conf.py new file mode 100644 index 0000000..5f216bf --- /dev/null +++ b/third_party/pybind11/docs/conf.py @@ -0,0 +1,369 @@ +#!/usr/bin/env python3 +# +# pybind11 documentation build configuration file, created by +# sphinx-quickstart on Sun Oct 11 19:23:48 2015. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. +from __future__ import annotations + +import os +import re +import subprocess +import sys +from pathlib import Path + +DIR = Path(__file__).parent.resolve() + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "breathe", + "myst_parser", + "sphinx_copybutton", + "sphinxcontrib.rsvgconverter", + "sphinxcontrib.moderncmakedomain", +] + +breathe_projects = {"pybind11": ".build/doxygenxml/"} +breathe_default_project = "pybind11" +breathe_domain_by_extension = {"h": "cpp"} + +# Add any paths that contain templates here, relative to this directory. +templates_path = [".templates"] + +# The suffix(es) of source filenames. +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = "index" + +# General information about the project. +project = "pybind11" +copyright = "2017, Wenzel Jakob" +author = "Wenzel Jakob" + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. + +# Read the listed version +version_file = DIR.parent / "pybind11/_version.py" +with version_file.open(encoding="utf-8") as f: + code = compile(f.read(), version_file, "exec") +loc = {"__file__": str(version_file)} +exec(code, loc) + +# The full version, including alpha/beta/rc tags. +version = loc["__version__"] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = "en" + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [".build", "release.rst"] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +default_role = "any" + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +# pygments_style = 'monokai' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. + +html_theme = "furo" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +html_css_files = [ + "css/custom.css", +] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr' +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = "pybind11doc" + +# -- Options for LaTeX output --------------------------------------------- + +latex_engine = "pdflatex" + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # + # Additional stuff for the LaTeX preamble. + # remove blank pages (between the title page and the TOC, etc.) + "classoptions": ",openany,oneside", + "preamble": r""" +\usepackage{fontawesome} +\usepackage{textgreek} +\DeclareUnicodeCharacter{00A0}{} +\DeclareUnicodeCharacter{2194}{\faArrowsH} +\DeclareUnicodeCharacter{1F382}{\faBirthdayCake} +\DeclareUnicodeCharacter{1F355}{\faAdjust} +\DeclareUnicodeCharacter{0301}{'} +\DeclareUnicodeCharacter{03C0}{\textpi} + +""", + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, "pybind11.tex", "pybind11 Documentation", "Wenzel Jakob", "manual"), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = 'pybind11-logo.png' + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [(master_doc, "pybind11", "pybind11 Documentation", [author], 1)] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + master_doc, + "pybind11", + "pybind11 Documentation", + author, + "pybind11", + "One line description of project.", + "Miscellaneous", + ), +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + +primary_domain = "cpp" +highlight_language = "cpp" + + +def generate_doxygen_xml(app): + build_dir = os.path.join(app.confdir, ".build") + if not os.path.exists(build_dir): + os.mkdir(build_dir) + + try: + subprocess.call(["doxygen", "--version"]) + retcode = subprocess.call(["doxygen"], cwd=app.confdir) + if retcode < 0: + sys.stderr.write(f"doxygen error code: {-retcode}\n") + except OSError as e: + sys.stderr.write(f"doxygen execution failed: {e}\n") + + +def prepare(app): + with open(DIR.parent / "README.rst") as f: + contents = f.read() + + if app.builder.name == "latex": + # Remove badges and stuff from start + contents = contents[contents.find(r".. start") :] + + # Filter out section titles for index.rst for LaTeX + contents = re.sub(r"^(.*)\n[-~]{3,}$", r"**\1**", contents, flags=re.MULTILINE) + + with open(DIR / "readme.rst", "w") as f: + f.write(contents) + + +def clean_up(app, exception): # noqa: ARG001 + (DIR / "readme.rst").unlink() + + +def setup(app): + # Add hook for building doxygen xml when needed + app.connect("builder-inited", generate_doxygen_xml) + + # Copy the readme in + app.connect("builder-inited", prepare) + + # Clean up the generated readme + app.connect("build-finished", clean_up) diff --git a/third_party/pybind11/docs/faq.rst b/third_party/pybind11/docs/faq.rst new file mode 100644 index 0000000..2b89d20 --- /dev/null +++ b/third_party/pybind11/docs/faq.rst @@ -0,0 +1,351 @@ +Frequently asked questions +########################## + +"ImportError: dynamic module does not define init function" +=========================================================== + +1. Make sure that the name specified in PYBIND11_MODULE is identical to the +filename of the extension library (without suffixes such as ``.so``). + +2. If the above did not fix the issue, you are likely using an incompatible +version of Python that does not match what you compiled with. + +"Symbol not found: ``__Py_ZeroStruct`` / ``_PyInstanceMethod_Type``" +======================================================================== + +See the first answer. + +"SystemError: dynamic module not initialized properly" +====================================================== + +See the first answer. + +The Python interpreter immediately crashes when importing my module +=================================================================== + +See the first answer. + +.. _faq_reference_arguments: + +Limitations involving reference arguments +========================================= + +In C++, it's fairly common to pass arguments using mutable references or +mutable pointers, which allows both read and write access to the value +supplied by the caller. This is sometimes done for efficiency reasons, or to +realize functions that have multiple return values. Here are two very basic +examples: + +.. code-block:: cpp + + void increment(int &i) { i++; } + void increment_ptr(int *i) { (*i)++; } + +In Python, all arguments are passed by reference, so there is no general +issue in binding such code from Python. + +However, certain basic Python types (like ``str``, ``int``, ``bool``, +``float``, etc.) are **immutable**. This means that the following attempt +to port the function to Python doesn't have the same effect on the value +provided by the caller -- in fact, it does nothing at all. + +.. code-block:: python + + def increment(i): + i += 1 # nope.. + +pybind11 is also affected by such language-level conventions, which means that +binding ``increment`` or ``increment_ptr`` will also create Python functions +that don't modify their arguments. + +Although inconvenient, one workaround is to encapsulate the immutable types in +a custom type that does allow modifications. + +An other alternative involves binding a small wrapper lambda function that +returns a tuple with all output arguments (see the remainder of the +documentation for examples on binding lambda functions). An example: + +.. code-block:: cpp + + int foo(int &i) { i++; return 123; } + +and the binding code + +.. code-block:: cpp + + m.def("foo", [](int i) { int rv = foo(i); return std::make_tuple(rv, i); }); + + +How can I reduce the build time? +================================ + +It's good practice to split binding code over multiple files, as in the +following example: + +:file:`example.cpp`: + +.. code-block:: cpp + + void init_ex1(py::module_ &); + void init_ex2(py::module_ &); + /* ... */ + + PYBIND11_MODULE(example, m, py::mod_gil_not_used()) { + init_ex1(m); + init_ex2(m); + /* ... */ + } + +:file:`ex1.cpp`: + +.. code-block:: cpp + + void init_ex1(py::module_ &m) { + m.def("add", [](int a, int b) { return a + b; }); + } + +:file:`ex2.cpp`: + +.. code-block:: cpp + + void init_ex2(py::module_ &m) { + m.def("sub", [](int a, int b) { return a - b; }); + } + +:command:`python`: + +.. code-block:: pycon + + >>> import example + >>> example.add(1, 2) + 3 + >>> example.sub(1, 1) + 0 + +As shown above, the various ``init_ex`` functions should be contained in +separate files that can be compiled independently from one another, and then +linked together into the same final shared object. Following this approach +will: + +1. reduce memory requirements per compilation unit. + +2. enable parallel builds (if desired). + +3. allow for faster incremental builds. For instance, when a single class + definition is changed, only a subset of the binding code will generally need + to be recompiled. + +"recursive template instantiation exceeded maximum depth of 256" +================================================================ + +If you receive an error about excessive recursive template evaluation, try +specifying a larger value, e.g. ``-ftemplate-depth=1024`` on GCC/Clang. The +culprit is generally the generation of function signatures at compile time +using C++14 template metaprogramming. + +.. _`faq:hidden_visibility`: + +"'SomeClass' declared with greater visibility than the type of its field 'SomeClass::member' [-Wattributes]" +============================================================================================================ + +This error typically indicates that you are compiling without the required +``-fvisibility`` flag. pybind11 code internally forces hidden visibility on +all internal code, but if non-hidden (and thus *exported*) code attempts to +include a pybind type (for example, ``py::object`` or ``py::list``) you can run +into this warning. + +To avoid it, make sure you are specifying ``-fvisibility=hidden`` when +compiling pybind code. + +As to why ``-fvisibility=hidden`` is necessary, because pybind modules could +have been compiled under different versions of pybind itself, it is also +important that the symbols defined in one module do not clash with the +potentially-incompatible symbols defined in another. While Python extension +modules are usually loaded with localized symbols (under POSIX systems +typically using ``dlopen`` with the ``RTLD_LOCAL`` flag), this Python default +can be changed, but even if it isn't it is not always enough to guarantee +complete independence of the symbols involved when not using +``-fvisibility=hidden``. + +Additionally, ``-fvisibility=hidden`` can deliver considerably binary size +savings. (See the following section for more details.) + + +.. _`faq:symhidden`: + +How can I create smaller binaries? +================================== + +To do its job, pybind11 extensively relies on a programming technique known as +*template metaprogramming*, which is a way of performing computation at compile +time using type information. Template metaprogramming usually instantiates code +involving significant numbers of deeply nested types that are either completely +removed or reduced to just a few instructions during the compiler's optimization +phase. However, due to the nested nature of these types, the resulting symbol +names in the compiled extension library can be extremely long. For instance, +the included test suite contains the following symbol: + +.. only:: html + + .. code-block:: none + + _​_​Z​N​8​p​y​b​i​n​d​1​1​1​2​c​p​p​_​f​u​n​c​t​i​o​n​C​1​I​v​8​E​x​a​m​p​l​e​2​J​R​N​S​t​3​_​_​1​6​v​e​c​t​o​r​I​N​S​3​_​1​2​b​a​s​i​c​_​s​t​r​i​n​g​I​w​N​S​3​_​1​1​c​h​a​r​_​t​r​a​i​t​s​I​w​E​E​N​S​3​_​9​a​l​l​o​c​a​t​o​r​I​w​E​E​E​E​N​S​8​_​I​S​A​_​E​E​E​E​E​J​N​S​_​4​n​a​m​e​E​N​S​_​7​s​i​b​l​i​n​g​E​N​S​_​9​i​s​_​m​e​t​h​o​d​E​A​2​8​_​c​E​E​E​M​T​0​_​F​T​_​D​p​T​1​_​E​D​p​R​K​T​2​_ + +.. only:: not html + + .. code-block:: cpp + + __ZN8pybind1112cpp_functionC1Iv8Example2JRNSt3__16vectorINS3_12basic_stringIwNS3_11char_traitsIwEENS3_9allocatorIwEEEENS8_ISA_EEEEEJNS_4nameENS_7siblingENS_9is_methodEA28_cEEEMT0_FT_DpT1_EDpRKT2_ + +which is the mangled form of the following function type: + +.. code-block:: cpp + + pybind11::cpp_function::cpp_function, std::__1::allocator >, std::__1::allocator, std::__1::allocator > > >&, pybind11::name, pybind11::sibling, pybind11::is_method, char [28]>(void (Example2::*)(std::__1::vector, std::__1::allocator >, std::__1::allocator, std::__1::allocator > > >&), pybind11::name const&, pybind11::sibling const&, pybind11::is_method const&, char const (&) [28]) + +The memory needed to store just the mangled name of this function (196 bytes) +is larger than the actual piece of code (111 bytes) it represents! On the other +hand, it's silly to even give this function a name -- after all, it's just a +tiny cog in a bigger piece of machinery that is not exposed to the outside +world. So we'll generally only want to export symbols for those functions which +are actually called from the outside. + +This can be achieved by specifying the parameter ``-fvisibility=hidden`` to GCC +and Clang, which sets the default symbol visibility to *hidden*, which has a +tremendous impact on the final binary size of the resulting extension library. +(On Visual Studio, symbols are already hidden by default, so nothing needs to +be done there.) + +In addition to decreasing binary size, ``-fvisibility=hidden`` also avoids +potential serious issues when loading multiple modules and is required for +proper pybind operation. See the previous FAQ entry for more details. + +How can I properly handle Ctrl-C in long-running functions? +=========================================================== + +Ctrl-C is received by the Python interpreter, and holds it until the GIL +is released, so a long-running function won't be interrupted. + +To interrupt from inside your function, you can use the ``PyErr_CheckSignals()`` +function, that will tell if a signal has been raised on the Python side. This +function merely checks a flag, so its impact is negligible. When a signal has +been received, you must either explicitly interrupt execution by throwing +``py::error_already_set`` (which will propagate the existing +``KeyboardInterrupt``), or clear the error (which you usually will not want): + +.. code-block:: cpp + + PYBIND11_MODULE(example, m, py::mod_gil_not_used()) { + m.def("long running_func", []() + { + for (;;) { + if (PyErr_CheckSignals() != 0) + throw py::error_already_set(); + // Long running iteration + } + }); + } + +What is a highly conclusive and simple way to find memory leaks (e.g. in pybind11 bindings)? +============================================================================================ + +Use ``while True`` & ``top`` (Linux, macOS). + +For example, locally change tests/test_type_caster_pyobject_ptr.py like this: + +.. code-block:: diff + + def test_return_list_pyobject_ptr_reference(): + + while True: + vec_obj = m.return_list_pyobject_ptr_reference(ValueHolder) + assert [e.value for e in vec_obj] == [93, 186] + # Commenting out the next `assert` will leak the Python references. + # An easy way to see evidence of the leaks: + # Insert `while True:` as the first line of this function and monitor the + # process RES (Resident Memory Size) with the Unix top command. + - assert m.dec_ref_each_pyobject_ptr(vec_obj) == 2 + + # assert m.dec_ref_each_pyobject_ptr(vec_obj) == 2 + +Then run the test as you would normally do, which will go into the infinite loop. + +**In another shell, but on the same machine** run: + +.. code-block:: bash + + top + +This will show: + +.. code-block:: + + PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND + 1266095 rwgk 20 0 5207496 611372 45696 R 100.0 0.3 0:08.01 test_type_caste + +Look for the number under ``RES`` there. You'll see it going up very quickly. + +**Don't forget to Ctrl-C the test command** before your machine becomes +unresponsive due to swapping. + +This method only takes a couple minutes of effort and is very conclusive. +What you want to see is that the ``RES`` number is stable after a couple +seconds. + +CMake doesn't detect the right Python version +============================================= + +The CMake-based build system will try to automatically detect the installed +version of Python and link against that. When this fails, or when there are +multiple versions of Python and it finds the wrong one, delete +``CMakeCache.txt`` and then add ``-DPYTHON_EXECUTABLE=$(which python)`` to your +CMake configure line. (Replace ``$(which python)`` with a path to python if +your prefer.) + +You can alternatively try ``-DPYBIND11_FINDPYTHON=ON``, which will activate the +new CMake FindPython support instead of pybind11's custom search. Newer CMake, +like, 3.18.2+, is recommended. You can set this in your ``CMakeLists.txt`` +before adding or finding pybind11, as well. + +Inconsistent detection of Python version in CMake and pybind11 +============================================================== + +The functions ``find_package(PythonInterp)`` and ``find_package(PythonLibs)`` +provided by CMake for Python version detection are modified by pybind11 due to +unreliability and limitations that make them unsuitable for pybind11's needs. +Instead pybind11 provides its own, more reliable Python detection CMake code. +Conflicts can arise, however, when using pybind11 in a project that *also* uses +the CMake Python detection in a system with several Python versions installed. + +This difference may cause inconsistencies and errors if *both* mechanisms are +used in the same project. + +There are three possible solutions: + +1. Avoid using ``find_package(PythonInterp)`` and ``find_package(PythonLibs)`` + from CMake and rely on pybind11 in detecting Python version. If this is not + possible, the CMake machinery should be called *before* including pybind11. +2. Set ``PYBIND11_FINDPYTHON`` to ``True`` or use ``find_package(Python + COMPONENTS Interpreter Development)`` on modern CMake ( 3.18.2+ best). + Pybind11 in these cases uses the new CMake FindPython instead of the old, + deprecated search tools, and these modules are much better at finding the + correct Python. If FindPythonLibs/Interp are not available (CMake 3.27+), + then this will be ignored and FindPython will be used. +3. Set ``PYBIND11_NOPYTHON`` to ``TRUE``. Pybind11 will not search for Python. + However, you will have to use the target-based system, and do more setup + yourself, because it does not know about or include things that depend on + Python, like ``pybind11_add_module``. This might be ideal for integrating + into an existing system, like scikit-build's Python helpers. + +How to cite this project? +========================= + +We suggest the following BibTeX template to cite pybind11 in scientific +discourse: + +.. code-block:: bash + + @misc{pybind11, + author = {Wenzel Jakob and Jason Rhinelander and Dean Moldovan}, + year = {2017}, + note = {https://github.com/pybind/pybind11}, + title = {pybind11 -- Seamless operability between C++11 and Python} + } diff --git a/third_party/pybind11/docs/index.rst b/third_party/pybind11/docs/index.rst new file mode 100644 index 0000000..77b097c --- /dev/null +++ b/third_party/pybind11/docs/index.rst @@ -0,0 +1,49 @@ +.. only:: latex + + Intro + ===== + +.. include:: readme.rst + +.. only:: not latex + + Contents: + +.. toctree:: + :maxdepth: 1 + + changelog + upgrade + +.. toctree:: + :caption: The Basics + :maxdepth: 2 + + installing + basics + classes + compiling + +.. toctree:: + :caption: Advanced Topics + :maxdepth: 2 + + advanced/functions + advanced/classes + advanced/exceptions + advanced/smart_ptrs + advanced/cast/index + advanced/pycpp/index + advanced/embedding + advanced/misc + advanced/deprecated + +.. toctree:: + :caption: Extra Information + :maxdepth: 1 + + faq + benchmark + limitations + reference + cmake/index diff --git a/third_party/pybind11/docs/installing.rst b/third_party/pybind11/docs/installing.rst new file mode 100644 index 0000000..1817372 --- /dev/null +++ b/third_party/pybind11/docs/installing.rst @@ -0,0 +1,105 @@ +.. _installing: + +Installing the library +###################### + +There are several ways to get the pybind11 source, which lives at +`pybind/pybind11 on GitHub `_. The pybind11 +developers recommend one of the first three ways listed here, submodule, PyPI, +or conda-forge, for obtaining pybind11. + +.. _include_as_a_submodule: + +Include as a submodule +====================== + +When you are working on a project in Git, you can use the pybind11 repository +as a submodule. From your git repository, use: + +.. code-block:: bash + + git submodule add -b stable ../../pybind/pybind11 extern/pybind11 + git submodule update --init + +This assumes you are placing your dependencies in ``extern/``, and that you are +using GitHub; if you are not using GitHub, use the full https or ssh URL +instead of the relative URL ``../../pybind/pybind11`` above. Some other servers +also require the ``.git`` extension (GitHub does not). + +From here, you can now include ``extern/pybind11/include``, or you can use +the various integration tools (see :ref:`compiling`) pybind11 provides directly +from the local folder. + +Include with PyPI +================= + +You can download the sources and CMake files as a Python package from PyPI +using Pip. Just use: + +.. code-block:: bash + + pip install pybind11 + +This will provide pybind11 in a standard Python package format. If you want +pybind11 available directly in your environment root, you can use: + +.. code-block:: bash + + pip install "pybind11[global]" + +This is not recommended if you are installing with your system Python, as it +will add files to ``/usr/local/include/pybind11`` and +``/usr/local/share/cmake/pybind11``, so unless that is what you want, it is +recommended only for use in virtual environments or your ``pyproject.toml`` +file (see :ref:`compiling`). + +Include with conda-forge +======================== + +You can use pybind11 with conda packaging via `conda-forge +`_: + +.. code-block:: bash + + conda install -c conda-forge pybind11 + + +Include with vcpkg +================== +You can download and install pybind11 using the Microsoft `vcpkg +`_ dependency manager: + +.. code-block:: bash + + git clone https://github.com/Microsoft/vcpkg.git + cd vcpkg + ./bootstrap-vcpkg.sh + ./vcpkg integrate install + vcpkg install pybind11 + +The pybind11 port in vcpkg is kept up to date by Microsoft team members and +community contributors. If the version is out of date, please `create an issue +or pull request `_ on the vcpkg +repository. + +Global install with brew +======================== + +The brew package manager (Homebrew on macOS, or Linuxbrew on Linux) has a +`pybind11 package +`_. +To install: + +.. code-block:: bash + + brew install pybind11 + +.. We should list Conan, and possibly a few other C++ package managers (hunter, +.. perhaps). Conan has a very clean CMake integration that would be good to show. + +Other options +============= + +Other locations you can find pybind11 are `listed here +`_; these are maintained +by various packagers and the community. diff --git a/third_party/pybind11/docs/limitations.rst b/third_party/pybind11/docs/limitations.rst new file mode 100644 index 0000000..1b06ea8 --- /dev/null +++ b/third_party/pybind11/docs/limitations.rst @@ -0,0 +1,68 @@ +Limitations +########### + +Design choices +^^^^^^^^^^^^^^ + +pybind11 strives to be a general solution to binding generation, but it also has +certain limitations: + +- pybind11 casts away ``const``-ness in function arguments and return values. + This is in line with the Python language, which has no concept of ``const`` + values. This means that some additional care is needed to avoid bugs that + would be caught by the type checker in a traditional C++ program. + +- The NumPy interface ``pybind11::array`` greatly simplifies accessing + numerical data from C++ (and vice versa), but it's not a full-blown array + class like ``Eigen::Array`` or ``boost.multi_array``. ``Eigen`` objects are + directly supported, however, with ``pybind11/eigen.h``. + +Large but useful features could be implemented in pybind11 but would lead to a +significant increase in complexity. Pybind11 strives to be simple and compact. +Users who require large new features are encouraged to write an extension to +pybind11; see `pybind11_json `_ for an +example. + + +Known bugs +^^^^^^^^^^ + +These are issues that hopefully will one day be fixed, but currently are +unsolved. If you know how to help with one of these issues, contributions +are welcome! + +- Intel 20.2 is currently having an issue with the test suite. + `#2573 `_ + +- Debug mode Python does not support 1-5 tests in the test suite currently. + `#2422 `_ + +- PyPy3 7.3.1 and 7.3.2 have issues with several tests on 32-bit Windows. + +Known limitations +^^^^^^^^^^^^^^^^^ + +These are issues that are probably solvable, but have not been fixed yet. A +clean, well written patch would likely be accepted to solve them. + +- Type casters are not kept alive recursively. + `#2527 `_ + One consequence is that containers of ``char *`` are currently not supported. + `#2245 `_ + +Python 3.9.0 warning +^^^^^^^^^^^^^^^^^^^^ + +Combining older versions of pybind11 (< 2.6.0) with Python on exactly 3.9.0 +will trigger undefined behavior that typically manifests as crashes during +interpreter shutdown (but could also destroy your data. **You have been +warned**). + +This issue was `fixed in Python `_. +As a mitigation for this bug, pybind11 2.6.0 or newer includes a workaround +specifically when Python 3.9.0 is detected at runtime, leaking about 50 bytes +of memory when a callback function is garbage collected. For reference, the +pybind11 test suite has about 2,000 such callbacks, but only 49 are garbage +collected before the end-of-process. Wheels (even if built with Python 3.9.0) +will correctly avoid the leak when run in Python 3.9.1, and this does not +affect other 3.X versions. diff --git a/third_party/pybind11/docs/pybind11-logo.png b/third_party/pybind11/docs/pybind11-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..2d633a4d0c129d6bdd94b4134c9516fdc92bb192 GIT binary patch literal 61034 zcmeGE<9BA=6D@$ow$(w$9XlPnW81cE8=Z7)vt!#G+jcs(-FN5xopbJga6jEKo+lsn zSkFS$teRDG?U4w1*&m2-cyJ&fAczv;B8ng&5LO@{pz<(Kz!R8?TV)Us%rBnG>duM= zZp8MEcBU5ACdAGj_9nz8?iQvXAnvP`>1K6g-yMVh9a6hPl=^eZ3Zz{_@$m6a{l+3q zZZ{hAoqJbSp+MQ$0sB7nob#`1%I~@)nlRh2a!J8zTMpNR>@bRu&u{S64&m?nc-@D+x(SMJUpJ-*v0amFD(c*X~896E5 z9)J(_&w2?wCToJTvjXFFER7z8M#%nWeFxTGvl8`GDrA zBv-bro>tf3cIi4HwluuNhS~$LpTl4{1URtj5K$ zTR9hUC-e%pevi-AE%ocVK2s*=vpEZ+X(eHfR*}fw8gdg6dK7MU4ou8$IjlC#O?b=K zi|6$B{bn0GbtLSYL+Kv(il(E7%jjwoC5s&l5O~Oqwd#d?&i!sbUDg`8oYLZUXkE_a zk$APsvN;dwqVU+bt!)lr)9S8T)oMEo5rbwkVhNy9qUxRfji}{}Gen#89$)UCpM4Fu zHd1 z2I4go-M=U(U=NuuM9+Txqki2K_GuA+ark+EJcPE)Kon8`sK6lg0C<1m?{O+j$?Fr%jrH3FyZ6ngjOZ11Qz2-kWv8U(;YiW&TI#ZSy;4tg?pq&2D2R6D>^o z_b;>pqfSJiw8*sBc$41yJQsT;_~Hw%@c{u@n$+!-3I0JZsPNGkX}b+#!w6sIbS!mO zXxy|R>A_)NSMaj`qz<5~Q!d*+(f z_-sjRy}Njg)8vyR7SO@KP{L@NYKK$N&XiJ7?sa%t%PmH2>klOrLnkolPJfWB3mUDQ zMg=w1!<8ElPSbJNWb{|l3#PVr=y%f27-5$t%Lb3i^-_a;C!&)J%C_X;CHfvF`y` z4EtCNho&#e1r$`nhF9#uTdYbO$4hY2n>cF0Slme2FZfM`mGIRK+3DLdTKSZN>It@X?Y z0x--GX>r`$kIb07SBf9gdxXn=&F{YRxiH}TJF6Pe!}Jcf=3#esRCS!(-i4)st0XpW zfMLw+g$c>>u8pv$`Qt5csNDZ5ZX-2I3g(ojoB51ZAo@)jtKD8m{K!(riX;N0dZTbr z?`Z!C+)98;1Hs0G)~JT^i}CCb$i160)tfZ6bQ`A5M8;NCF@upWCM=lLGj$x68;t2R zYyqb_ecR7MZT4wLog*yyQP@-Ynf+{vrAum0pS*m>*R{MC6HC zzC|kT)=Y`~L+~PgDS2#TX*2Pkm@i{vJ2z$5EI8e1-amGmNZo3H3T(O;20L zumOQ(I6P7Z9c%DaeYCZe<)gHqdy`mYS!#>$a7;8?DhjePdOhg#a3EPYcC`^B#jbs$ zJsNB|LYKMP$vzteqodjf_>jr0ur&gf|AmntHO&nsd$3rf1#Ei?)vZY^)OVsyP1Z}C z2cePEaI$+Zc}8pMGxS%!+JO6Ze0J#;q;$wLi6LtG4)p$(Oi+kj>q>saqupxypQ&Y` z@7Ez2jNmnFly~(8?3RxeS8xyCwjMVQ{A2J+FYfMTjTRYMN+~cFrwN8Tv1Js8)|#c- zORUIrBl_g*4z6kn(LhtjcsLLYF67UN1DZm7+JB{ zZ?p!7D*X$K>nhlC3PZ=dYxTBqh;;_FSN%2n`U>q_&++*~y*PTX0x}_#p(vR)Q#)E# zl^pHjjosC-4eiKt?~m`RO2Oe^D<3#An|laGs`fh-zGx2wA4h+u-}@ynp-~Gp43-h@ zSORmYxmQ7cPtw=GjV-!lk)nwdrj`zZtD1qnNyWm)DO(eUWth7x zVnfymGLxKT3wv?iU>%82Uf($#l1Ga9mpym~IH*b7pF9XwH2C=uMR-S0pV{8ZkzVXb zVI*8w6Z~<4Ko|UPH@4wcIm2J5>~59Q!*~xY)!CA8x!j6nf|g`P;ymnk*`UbAOc<+U z>4p8jQtrKmTR&;hv*E5+RPK;t59Vyw;?0YLUJqh?9eM0S_5Jzcd|7al9ZM>bi2B%p zebs5Ganh;}K~RiK@pgJ0VR-fRUnt45AO=3mo&2}K-QE259o~sKXOypoI7F4nPgG-H$mP=&bQ}`XBUTbN?|h{(#X8 z5K{*o+kky%35|x4NUFgdpYL5vp(3Qn*)4EQnj*&TUUjm6$Cgy{SYn~#LIQm$k}#;t z>A?MAN%h@8WSSaJZhY=Es*l0g8OvW#Gj&@&qACPpWMYbVQ0ETbC|tr4$tn}p&K@!v zgVAugEp5T}3lX%T z=x}fLO{=|W;8ge26 z5XWCesno86h=cmXI1#wLp}EfruYUykLEKDRP0jPD zNe-HWRtFf_g1;Y`Q`|-FaGkiGi@R+x(v!xy(S*}IaJr@lD86&pnC1_Qdi0QSWJKo9 z66!jkN12{Ez|5!1lg4JOfETsX@k+uXruV9o_&M^Cw(SGczJ?*Gord-K~TZnj6#Q*IUm`sBZNY*jmG{H&GDm7!Cv$#ije3<=-am|s*9h) z7xeYJT)UKHmdCkSeop;Ci4&b={sErW(mj{Nl-ilwW~qY8zu?dV4B(+0#$M@;N%4hw ze?@~IBU4eF+UtK!7cNms6@}AQetX;A=+}a^fDpF13!SCmrZ(9VCA87tc!hD<1L73y!)4c&NY7iS&C^NRAK$t8jS6~E!3`OlOA@6k?JFd$YKF+T}LcOt2BflWz z=%={(b|Ly;Dp($BYF?97n>6jejo&Ck%(dcSI*)|H?>nOAJLDy^BQJoky&s$XOR4Kny=Htq;+6 zQWMops<}DPwf&pISm_E@+PM%E4EM_{0iCT~MZe7=q`u)PSC5fDO!gHH2#L{k=L7MQ z?p%Fd8i`))d_FORnn>0LdOb)6q_$l_zI7o6@3{ikmwO0lG!CI}@byJhcxeVb#dE?l zYG#a%8X8XcOmUROH7cQK5gKU#=xK z#o!eB8>4a6<$y)9kX_S3MNfl>l4viK9O6i78lq;gK==wKXPkwPB|JOJ3(lKdCQdqc z2~B^CCizYvB8!91Cp6@Yo%EyQ$z#ns8v2aOekg zCUhS0R+#j`dfIcxM(=N3q>M!JdRP0kgln~rXz8y(ow}P4l+&aR#ST83o)1CXAfj{k z#c_HKU0JaE(-F zNPFT;lAGwr0pKi@sY+-}!hK$k)l98l4&eB)e%yRJf7edo-WsiIWqNwJYk1-a`8R2y0X5Ibl+YCS3E zm4}N6Rv~HG`9qrNdp$jBa>FfJmM{?N!La3{)Qo|J!pm+!jm%zUTo(S>BrXG0VTASG zF>LT(Y1Jw2#|uO2lXCD~2?OE(M6-uzavl%P-N>>EB&P%?0R zOFE?m38v^*3!R-MpeR9^V8VdNr-{V2fs!bD=WH9kP>K(|K&2_}&YuUiu1{NF~J7O1pObdAwiM(h}mD*Q_S>EP~VL(xW4Pmjo^khpPa=UxzVfo6Z9gEj9$@;rH|&+_h0LC5}wApT*H4fDJB(>lzu~LrGRv zzH6b%kf7eSE~W0ALaHJ>#^hxYkU``ck`-_Fnw?|Fb-gA)fT90^91?Xy(Ad@pMou$D z!^8ZdAxK>MCzzutyhK$z&o?J$rl%+H4tiqx4c#^0|8AaZ+vpTm4Xur@rlda%;E5 zG>LVYuxsxPXTrLJDE<>x*ql@t4@_adgSxV4h{1Q>oBm5>buz~5Kf=U)=pd_z)PXEkj^Q$4KF-Vc;{LT_eUCy?CZx=?uY`Q4 zOA&ap_-sG9X?e?tAw_t}(?vc&Z3t<&vPtGs9yy^lBhIu#g@&{jPX9!IZ5w6Epx!o$ zEWRcD%i9o3&sD;o7~=4QbL(FKScTEL>|D^#3>O3In9gjP=86RAc-q~gI#o4wXq5R$ zH`A~U)74YsFm{5!NN?RXg*99qEzyG_Qj3F1jqa zv9iZ8(thgOFD^&WZF!=pcB4BlH)dy3C*&ElY$3`_JVF$TQu8w)27M`cLFk*>jMEtC zp@lXR*ft#7PNA+BMKYex_?cH$J{ed{h!B2k0Lfai12X(RLm)t3s?WAqK%(Raz?5`WZUj2ko2N zBbylo_n`}A4gCp%^aa$gA*jnI`Im)bl=MmbL^fyRzI|g+-Q>>VY(WERyT$8{w82M7 ztwwdfXn_cHQ*tAtKKK>LC(JL;Go^yXc^MVeK71#`)`ua9$T?6B?3OjwIuchzi3pD64&EyR){!tsCGpt{c375Swy z_LTKJTv(&0E~Q+nFkm`c8~h^}TwyHvrE37~2c{i$(=5Jes~nqw)wph|Qrj6}ahgFg zBOVlfp?HFcfUFiqO87do)l+-aM@qIfETltI+~Aro@k%Q>~iw}QuD3QsMAQ(v);c*&b%hhKNuwM>wK;` zJ90)i=mdx88Y&VUX||kRKyKqzj-Zf`@)$@O)vU%hw6oT_?M9#9LFiB&qf$HPrvdRA z%24Wu2nZ4gA_$5SK`1rw1lC?$!wCcg9{uwR3X-0Q13ZLwmXHyJ-iN~i1E)i8iKVa=6WW=TB6CNVI$|1dHAQb#9_1Vzdwo)3`y|+|IhzVZD5N3g#q+)Mb=zY z0Xh(55DtI5fo>O27_g(bt~U^&4&(o?N9v=X{gEAZ$dmu35c#L1#Qi^486V7p!4P`| zP%NmSTvrf$x-qUUz(oG@r)e^pAl6F%YJUHQBaDRxJ_`#ASMEGF-H>3Q!9pYuV4%Rq z+10i9r5ze|ssZ)}4gLSYpl~RrWlLJoR9Z(z=WN9+C&onB%gd{xtc+SESqA2M_S^p( ziNXxI1jDAHqEZVEjr7N~uS}`L5D^ivOaz~S;rr+DByp1kQH8{xD#Hf8OlK6V4w(&)7~A~vvTvN+(Z3bE0G6u z{O8W8bC;(3vs7|nbb1!I+n}Q$u&MFCj%BYZbPW6?WMM70Ew+O_b#ni+191+%Z1#at zdc(IhkH?FRTJ3nD8dws)6~o}T*`b8P#sn0_!SD`S0uRawC(?Kr_Z-pIo^u5-)EBog?Fii?UwpKZRFvrEII>8ykN zM%%g)gZ>ZVBan`k_kg1uvqyE*)P6Ya%ob^$ek2<3TbazE2$`ZHv(nz5ou3!AGLn$N znl7RUi618z(`Q-*iTEG%k^iLa0#0l(n?oUNVlJ%^hr*oUzAvi$8m*iTk1j;@IUF}` z3aymUpEx78Fi!N>;NaT{>9^WqINFe}!5GJ@xG)g$$%?wZLNEh(LNL??h?G_rBee1* zCVrByrtvYM)W8&`KIes>%M;0009&@@bZXr}xVlNfxG4OolHq3~LXM+S9|1#B&$=|D zor)5#_TRF{N+l-t6NqLKq;AA2V(S;X{OuPEHg*sCp=fgFmN?V_vbh zG@-9RvkJ5Zi=RWvrWNpX7X>EtH;ex+7Uhy~&=-sX@@d+_eIpGzj?7+tlpT9c3*=D> z;#M*YIC7sc8es2Djh_SKl>hIP2YCk{#0>l+Y`yw%f=DD}W>%DAVX!36frf}A!S?+l zh?FCV+hjIb9Li~I!6?j1=Je7q)G+^T-lCwal~JixDqDY7kdr{wtZ^Um;k(cSF#pw@ z7?Xoh=o|k;gA6MNwrUmvhB0~~tFQP9+m1cX#Kc5;m%Efy6jyn1hzyX}AbD=SN`9Ip zJ5OC0hNLK>m|UL6v*8Q|G!8QzIEkey(%;+Xt9d0kYQKgr7|^gJ^&PI34hcd3XQzLE z&=fYD*sL}E>5uwYB9OgYM4XFlu+ZoV4J#va^eA)uw-76B4h2p*TnZQro`w zxwW~u{G{1L$J>9$Es`Uy1@(SdF>~tLS#Pqze-|D_Z)R>0M1ssP%kfdAn-9)yftLjk z#h5eVByDGBH@PI6^q3qbBk;+!iZAAt^yBS8CNgxpeG%)>rra4)L+>NQB0+$e*-~A4p;*=kNC0Jpt-KIJD^vpfI%N%L~JdK=PR%-4EUX zrsNXQ1p~}Kl8Xzn4J4osLmtmWvNo_?4HY_&CNkgU#l_I3CU#{NmAu+o)W*if(yA)i zlZ*fX5FjwVeE9;v>?C0TjfedG9EE|6r0~z8>}TQtHk1eoI<1|$j~!b_GlDvp2 zErcL@U)T*y3baOR#O#EUnBb+@A(|9>1~K~l~Fr18&u>?at>W()^5o1z65 z%A-i+0$!@XQ;mLoQ;allS+gF2lK;G#7M4LkOGF>o!-W+!;LMfvlTJC)M!n+v$7lSs z>|~<;ZV$q+68|Oy@-~YNoa6p8akbcDNyN!5`#uMMMs(s)s1kgT$UbEa0U)}09bM1nj- zZeHsZKnzJx5##B=EQ*P>6z24q&BT7+R@c^y?(gsG4ODX$)EIFJXRd&07;(m>UeC9> zbIyMNhO_6$1cGk#IkX-~`>mW!S2qBSQ#12KxKse^9-f-o*;RAZ80Y2$?(FO=XY+co zBHy6v_4oH9JeX0%Il~PbiDQhFs&wXr%Dn+#i@k|5)r-YU7Z)EWkE;uf>lMi|HWcFHQ}^2=b@l)Ui!4` z114O^ky?Vm>)+D`dH~?S%&3AuP6F~E_l*TT0qvmxKL*@DlkJA4y^xHL5AQ?>i+T5_ z3#xS5;i}%{4Jkcp5h8(1{i7m+|9=Z8+FO~mrov+f!JZp;{CmGVEERaEE1}GG2b1G} zckb=HRAk16`j0F|Y&dWA<8YuRLSO-2IUhGYrvMug@RuJ1jeI2vtlD9D*cCAAS+@v$b%;~ zx7t&bxM0@Fga7Yv0adlr)7tK1$#ksP6aYrY-Q)C}4BV(8pOqYrrt<<>@*sf|+IH(R zsow(35O1G6+qO(p8IQwFwERYmXpJf=68(sfsq|IG8(l%7ZBHKgBw=i_P5 z+?qD~)uG6g9${J^@Pwr0Cr|DWXM8p`OOqq8PzlMS`B+ww8^Ny3qXPi?UR|7>w@>x{ zc?xDPvSEJykg@)gH7)xk{^vtdb9$b!0N>iwX<4!FsqiIM-9-PMhSZyFb!K4MK>jm3 z#?dPLXT<|UlC~QVdeEonuRRZ-l5gvJZzyUo7|X=+bB8W&ZbP3Sm_JvGJm{kh`WhU! zE7tYp$gx#kM7r)2m6iJ~*Gd z{V!hfj`$DzLg1yU&ecDixNdI>*!_PX$TaL4VN&_@qLMR3LxRF@U^k=LU5}lYNx||; zdU|?}2YnzcpCyekd!`2?Hq>YJK@x0b#%^V%5YAR)Da4Hnm?E?49pLY)Wuw?6>DQ#+ z%VM>m;}3l$6}?&3_wc1)yii`j<9+`H)bBZ3q?`ZJjSyh22?2hzi0w49?B0S{K260h z`HABpQuhs2WmG8%9WWyh$o{4vd=|a11_#CRg2#4^U{~M3<%Ndlt(aL^u{WD+G91^N z{x@5n5A8%q3CvvybKXXWhm%6abp9XUfn~Qm6~ugBPZ+h{k{h-pLO^c7v(y=uB~no zUn=^o8GmHg=9~O|?4gmgvL&$u*itt}gyvw}9QiSsDhuKQLnNp@tUTF;rk z)L$5cq*@P?p%JWG9Yl3Rd~}Z!8Ev5Nj=%*{U^J6=u}Lz9;WrDJEBLY+<319CJV3o3 ze6tMA`Qcv-=1#O0<e5KbWAf$A}B8ABvr{u zU&2DDG*gBX20ERY>9f1)q51qz+Yf7EankUrTte+(eswi+h{&(QnA@%PHLK97TkmZb zo7@157q`ee9(w@q9IM3}b@=94_YaEzg^s_DEBYB0Do14}=Hp^Fa#V_T7`JVCFAM)G z!^WkbTMsLNFFuq4gCDLaF9Ou@zkI^{+%VvHy3kVjiC4~U{4Y>qC>KP%#}}ZP$H#K_ zvo5o0G`smSR;ZA=&%QafiI-Uu$zblt2K&Xv;z~h(^clnLIeD})WSbjywqJN4GbI^-~cvZ34MkTT7{J1&=CVxSl_s5P5P zKG|er`f>PMPMS>)8snWbF=(oIWmRL?P^L8vh-D_=+}xF?+*{8`*#LRO+jc9m{m*yX zpdhxossUQbDirT~5mhM3^fmp)D7j1ETu1&EvdF)FIqg^r2HIdjbh)l6)MN~f=ipqkBy0G3**Vl_dfi?;nk*jH^+@XW;jWS5f1`KlvhLn zSz)@DID$1$7dlH8`Y(q2J6QW0=P!Mawss=QsZfU(A%6PM&?LJNNd2h01&Yo~p{;## zw$Y%=%Fq!i?ccJ-om%(;ju!$V0tzg%78y7jwQ# zB-thHWg43geCD55mX_PDLo8<-wvTK%Y&Zy`gF|`pFj-ky$6!H!-cXalK=smo##Ri) z4Pr=Lb&<E%~jrqOvk+sN`+1ur8K$Pa%u99UFb6p3HA=BZ?N% z*(C=kAiIibIe=EGk^~x=P?|%ILqf0h2%i;O%md(8F{X6*lr;+-C56$0J`5{XEGygA zysr|e;xL$gPkW*jx|RV8*5cHr#-k%F5^kN`EX!x?q`qbs=`pLL9HG*lLsmq^#T~kgz1Lqc#I7iI z*GO9->oG?mEp#gw#zpu5=3zUI4?7oND@5{7LHzBvmP=7`NZKHO0kH|C4V@D=TGi zAxsJWN(BVm(1=bSDMCQ#DEeIo6l!j0~k^-FPS< z76gd>fBr-Q6d#vlLX1Adq5LLgqpv|#lI46PZo8jVynJ>EC8|TB59u!*ULB^T0*o}% zmk*ZJH}Yy;NTzBT%%iY=1Ml06E!t;m1oD9cxA>|v3qVzQnoa3aWe)%?FNmU$7+TDf@suZNjqq-b@F) z!K)Rmw$&CW@VbUWK&S+z&5fB6Beby%jqa0Yr%zVUvkg%aK_zY-+Fce@Ar zyVvffI&U%%kE7SiGc%w$Q_$U8)z(fwMQudWB@WF%%+1Y*HFDyxPcTfxM?JVix0WL! z@SW*caO?k?(`#Q)G?Y=XcPBWT$jR|sLuC8D9M`3fOD<@q8pgPSl7jSDu=H7{cijEW z;+PN~8j)(L{SC&Ig%rpaYJHj~>xN8LiCSieW3iW@9H`F>)AByp3Vc1N$DF>B?zuNw zp=2ZT_&>vA_1HG|8P@g~vkGBA9NoQ;?dZQ}HShenM(6Z91MyclR+5%0Rj7B>ARiY) zL>DIWX4m0!UUBjpwTsVCadyl@iUeL-Bwp)2n`$BX}|?mW5nNEVTE!KDwSB` z7>5$vxcD2|5uwGk#b-h>m(&Hbd4^=*&<$>7TPpq<)(=kV4tO?{)Tl-Sff4Vn21hhC z2F&+<_WQF37Pl_`$&`j3t+CUNL=Z^I7-aPleDzZK%Bw0IXG}~?9pgUWq1)#gpuAEJ zFwAFV^}i9-?f(7yH|w>lJfx{;l12gwAw2ETt)x-yw*__S=rC^_IY98pZ*0V@tgM8A z0K0njHn+0cQ=b3r8&`-GPnZ?T z*h{EmG_{#@V6a`dQ^2mp1hi|}9i4r>jj>4H2_OnP9jvQ>!7wJj4ycDrtXppk0odd5kZ z{p$WYoBQS#_HtdKIZg*@O27W~T`OK5&@+NI+TBP2C9APf#VL;h6L1uuCUCl(U^H2; z*!@yxMWQE>x{68&utY&~bF=EZcVOOii2FkQLVQpT7{&UCvV}FCkj{P@GLsqN$Yxqa6LiEp=e&gwWQ>Gqk z$%bDrGNC=9QJf z0-{CW)+NI-srH5~ho+_`3If#3{CuJ%E!3zp?PQ{<1#-Nz0{X2JBTn$r>B66G6ZV(E zCY!bSf9r7rJUXrieM*ooVaP;-pUsBq2dgFA#-;J^htrdjzW2v1z1gAPB?XBSA=HcJ z9V-)mo%a(j$FUN%XWT-g6xB-Wqr>KqeSqo?B*_$NV zhfO zLQ4Uvs-z9Vh(7?EX9}l4iwPe;(A&n0=R|1yOXYU4m9OQ?V2eh5K0`({n5`Bs@@1Qa zuJ-uM=`Oj2;@a{!)ba$B`ovdYmP2}^?e&3(=(1t`$yn~id2P-ZJsB2%*S{2;4khd; zFy@Yrj!l69i;Joa&CLZ>^cKU)5>64=e<5R=C$3)1nUGjo_~>RirB6Dvnydu@vriq) z{aLeY8q5bSXS}?)EiEnQ16;rV95_~_)2Ysq4?kjKW8<{n7EqX&vYa`XFHDNQ4D&rSpa z%b|<`z^S_G3L9^y#E=%HNF)fxan)Fg%Fd9@KmUL0uLxbw^ZYv(gF}pNf4v;uEAQ1^ z*PtE7+VK_Iclg%3HiLejnAo>xr7CFzcsL#E%bGy0+fov^a!Z?%B0w?e#J4>*k;T@oS@JXs)gNS!S)p|rq>cppC!r>UnBafG!*EROBe4oH`W{NPzLkFL4$iP>ynXG>!vz&6XREXPLVlC)Z*4)5O%_iR{j!+z&7QI^V%9Lsmcil}Bt z3k!qGW^sLr@`017;v87qTwL>M7!kG0<8%j!tdj5fvaPyjo1ORoF^N*n0?J)g@}Y%_ z#k{SwFBg>*H!6eI%S}qRc3cUhh0dr_v@hi^afn#{4|hRRaof!fjoT$!6DNa6w$>lI zuvzRzs=f78M~s9?e_{~ot$-^G5-M3DFpw#)%RYYZ!|K|D;-u+gXM3)!mVd(d*C|^6 zFp`pNqeaB@8#T9`R~2?#N4`#Uv?isp48_1Tqa(E=n%2XL9Yd5p&CDpl!@y(F4LrFc z)S7F%rbpsVn6R4*Cu;AK&j zG08p6;{->{QoghPbW%$S^%ylCH%U}M2P*UoMb#L=>9HXf%9n)ng{5|Vrl{~}F$3m7 znVbnRP^ch6O4+a(4o0r)<}gQBFlAl#%!F_@SSEGZa-fUp3jl|XDP;NGU2K zMzdRFe*{_nd0@HY*_-CMDC zKBrpgU8YPgSpZoD(rT?WT48s6+*ez@q!-!JOV^6^$7mO8u)#w3XjeoGGLMxcpxz>9lD&Y=iS~@53fs$`!Vykb^7rvt%&DaG$9#CZF%KtY|ZyBgLL8rO?1u;bEM9H%XH3%OM zPjc7xoDI9J2@B{@bRuVzp#;BP3Sd{M&*i}kyU{GYh^T6n#q|HtUYeOv_-Vw1kM_0A zy6dlF>(yEPRNv)eN^m&e3Qv~77FGM~q_QvNkDmn8r4QxR)kA=SG&4P&yJ@wbX?Vx| z-RVHOx3fez3<-Fd`|T^eURTBOX>!|Vl0xKgOv{8Q`eTj3NS}gKgw3g}!8U?ELpN5l z@=Bd5Ly;N{1(Oex#h1;Sn;C1XTaTBs^+pZRKG}2b+IQ~S`!~{TPMr=57!{tMnj}xk zfaOV=KjW@C;arps@O_PjNO&M26t%o8nP8zOjm%?ZpLU7{o&MjoRC%P`updJSBK{XN zK!@*);v5;DiA(5qQJ11(8Uu}My1?_#k^`VMF$LrVLF6Dow86V$_z7DL-H7H%9T_wq zG@&x$uV}b^hmv%0vJPtexd}V#Fxom@w|ti;1%GO2&p0Y@i<0CXF&; z`FG?4>c$fD!Td2DNWd)sK=1|nh(&DaB}qO(MOh%ae((2z7R_I{UG=xReAGKV*+90R zuJ_Wre1U!)JAS#zmjPb$u3LA|y$~NPt#2K-dK>aXkI+ z?bR|iVbFqQz<^% zDTt*!p>jU+;$mo_7gfCog!^JAKOwd@JNn0k259?0?wdlFTzEY8X*P`np>U~&LIlTT zXi+&v5K@nH34Y3iyzJft66XS+Gh_T<8W(gl)p|(@?o+K?`)KW574Q; zyD`F#pL+3r^x@_q?6{zSOzuh@lKxps78Mm~g9mJczX~PZy#NBW1h|n}_MddR6Mr5Y zgk)oO87w0Q%F#7v&K)f>y~N^T3TJ2ML}}`EgjX?A^;KBn3pYh7a{1TC%b~?eE#QRv zITk*@6@XyJh+J+mn@rP(f6Iq- ze>mq-UUag=M7i%e<6zSx_t`T2@zF*=HnK0M61DyQ35s}DopuJ8cCj0++0mVxrYe7s4Y zfePMl#Ob(;_Ej-7k=W4K7>Bz7As=+VUmHgqmSJTj>`MIl0(_%L1H$ zNV&1?BEJ?$Q~7M${!h2{6${e(;Auq0w160v-7`F&5D+{(bzIY=0qwz$(^cU^mo;Cs zU?R0xaMw7%uoaeVRG{bbk%q&a9%C}XslLm1Mw|1UbKGSc8vzOxDXjYWIhjstl$}@& z>hJH`Bbw_*`bznFuSZ)}jubZ)_1z;km96FcB6X$Gl|V|l?D5mn%hg8s*N1Z@d?9d< zP4_)SnJp;*d;40}Yi%wx4`(Y0jtCa#9Lh-lNpGveGL+>9C)?(OQz~ZW746SZ)~jzC zwCXh|NMT- z$`)-SF{-!)y>^q3OyJ3h<-hd_@%1PrT+_#3w{5JFTU8|K;o2?u^_;X`0qia z_A4>hJ*yb}qpQ{!#@%=%QSnI-9J)Eq^_57^EbE9Agr%}qU?8-aM!iMTR}};VH<}2D=3%TstKQW5fg^tkJJSq1qLrZ)IggEsA*sQ`0+-b z6*fHJ3l{>u1_eY+d;q{okGeNwzJPRby zw4Zoz>D_7)6XozHeLs(4=qi1FmCu-#g?g8rO+c=d@z7i{7Qz>(rBe&f9ChmcHMXeD z$;|wdt+@j|$NkB`*|}kFSjw+wK?*xJN{o?@9jSc+_GoviepQFl=Q|uoi^s$_?~nS} zKGXWXotpl?&OOHs{icn5=Bz>}!4>bO(iGrdNl6`y3_uD5TCW4c}?JJ-u{u5-@NyzT>_JckxX6A}DRTGCgn+q1K=G2zHh&(4AY!rwU0O_F$=IB@k@77AQ0j*b`5X*Jm+$TDGJ{&g<8 z(Ax{^Q;QUmIkwn6cdN5nqPJdcuoxxg2Yr`~r-rDtIbE!D-;JPT{>G6HT;dfk zr#7`-rAhU>Kh+`&U_h=rO^NX=KY<`Xfxo=IUXR!Ri;+M2CQSjfOQ>Q6sQmxVt<*c* zNxJTqOPJg)2$s)Pmu(g!ZYZ7JTIarx9B-Un_FN)$hP&CdfGYriCd%Ppe#Z|80{$}s zq6&&AXduetXlwIk(CbAfzS&e~4AEN+qM4klzPB|_pe`l!ER+Irfgo}L&XhkRm7M>q z%w=NXGbR?T-kD+~n~Mh;0|rHZKXr~i`%!`{SVomHARq?=eckpOnKs;Y{2 zCdFS@qAjl%?MY6N&;tf>88e^sT{e`Le9#Aod9*(1U^!D^E~kssuQk}y%Hm6rs#GFg zaBRni$3W-I^Ryk5K4B4}xms3KA`aZn0>Z_t>D>NaC;6rxkU`CRh@PcRwokIn-QOSxL-M}j>z61wcSHQb>Fk$_G zdY!ADUZr4Z1*kmAl15CJG4eQnnb(;5qZXH`rsn=?ua+g1i1!7vE9HreJtpVkyvsJA zH6)tIg*MMilY=UOd z;Bau)5Zv7@NN@-q+}+)SySrPE;1Vpjy9Jlv8sy+E_u>7%dv6s#Ql#qS?9T2?Pj}BI zBw$qd;T4-cRYUPX3u1FN&Ib#P(--pWSiRdO(tA!b`Xb3I`U7NPSs0mIjgEvo15O{~ z7=4PcRp9M1RZl zp2wvm(nB&;>?F%hpU;!3ai;pDZO+S4Kbw90u$N zj{xIBGiUO}+PcCCT0f+vOrK8ma{_I@UxM!j#Aw?u6(q$3LGN2ROEIJ$x7Y<6(q6wn zzuZoi0)QH2c=K;wtC4h|X|0E?jL6=tffe`ch*)gCoM2qPmMj*37U-ujJLuS1^BSFEWGSR#46&!8rAz4?!L zBQ7x^H2n{3m+r3g4PT#IYcz#G00<)@i!@k>LOA$`80&Ox{qDJD_o>7x=Q;_;- zJDs`nmX25C+~VSn_Qs?7%5lZ)k;}KPW>u`B4e4sws+Xrb@Ggvhs!x2(-tuu@%CfL;=7HWTXYD6Ree4DA&^=57P2s0Tv%F((+IX3n$W z6{73j6rzTNKLB`nMs#Rqk%faJ`)}yTUjGDl%^<&hO;6aFx4&fGfJ!rDseNDUrPBD@X;#deAX!o;pg!`7F1sGA^xp^WTt?e5x;4iUd`lQP75%UOudC8x; zHa?}*K@kk{lCo*3xq#$3aa*dyNuMwa{{VeWI~qDC@HicGkM_nq?eHd8&%>TmU+V8| zM(TGV4Eb#IHh#xZ;6RE>?1vtP+7+JT|E9Qf-+8xL5VsNcbmqH}47N_XQ@P*pUk$Oi z=ecHgT*wI?wrJ0;FdHB$)|~zBL7SX(U1@t@d>OOiwFuQ0UQMB@TI%`>8Qp zJ-G}fh>v6;nHz~^DU<=%-)vWGdZo@74v1Z;KoxybGpxs5V~>@AX)mQ>l@txwA@z& zzx$%Re6ZD9@|1472}vav`pyh1gFdG)?eWgUqBjc{!RHotkndKHwcnjamnUl1s>L2|DLZ3uW1JT8H*>yBU-R3Zpu4TActzR#M8Y>2GO6!1|dz@w*( zoR6>@R<_@8W%K)!Bp_+93^5rQ7Gs;KIO+cbl9vZfXhIo6lzj^VxYHK9QXPrNjS%3k zbeQ0XPzl%DwsJ=GE9e4PsqDYK6+T=6BtPX+%S;d{u{Vj>FErK;CTo=Q=@}#^^%$Ce zk{>_UO|gE-ULX7mz5^%@Xn-FDjQ<9=GGg*50wibxB#J$-41n=?>6fJnYZT|@V{u5U z0}a+!`#+XUmGe+@GYK3xv#_#}a@d}zGSNL^?WlS+8ng=>BhU6%0^zP9%X{eKsHz zm(%!>!M_;uX{@T2u@mBeh$ut9_=(uz6D6Yn`KC;Lyff~14>y_9X*I+7y=G(ZiC^-)5IF%v z=+Kp~-H$I?li@@2-yc}k0-hk?5wFrVxLVN*G_xTcpUWLI!}T?p799nE`#rz&f4k%H z+s9(D>(Ay*nLc(c)8Rwo9@mFZ#xmr}0;pkw=H*Q%zD;!I*@gliMuHMYjBM>dNlQ_^_4$F z02URYJT#yn-dys3Zd6r>o6Hfa6%N1{XL8u$VgD0wjR{nKmfgCz*dr-9Kp- z2XW#=ki7fp#m^M~F#6yQFh~OsTw3T6%CWW;KyR)rm9 zkJ2S%e>AV#JukA#UAWA|QNN=*yAj(OP&bHFdM&SeYBqI|M$KmDcYm$uc>nNm>7}nr zHUqz|>6ZBLd7|zfL8xw-6_>81@U`fm{`&Qd?ZQWV`*K&~aGheT+2SA+EeQ>D89-~nfWv;mMF?Em6E{K|u6Msj zwB$!|<$hhT7hLY!%h;$80nML_`9zQNC3E4FuP0e9K03`c(|jyLsjW2)&(@s(BB<+qJg0NYHS1) zM_O=U%<8E+A&NKTgd#FML7k);6KIojRG#H8Fol#il{WHss@CY)m1g0mm0a?)Uedzi z{Co&-2#f)yo^BrIEUomhu8+6&3X9Hog7NxdrEoKM!RCUa0Zf4)|LdvSKt+((8u zeS8x>K-Hhy*;#S#c6@iySL&a6?VXb1R_S%Ox%a7J@O5PW>`4!Ze9v+V$aVt{O*-qN z{_KWixkmM(|I_dk3aQ|mIt;}53aS3k;1kK9|MM!E!&T-k$Ea&#^XA^hZ}g;5_3b?4 zNAM@0MJO1?+y6HKy5>7{?XH)Q4)DYN#R-#w>riZYx=Kz=;^iPH&dRiKcs=5~`HE&M z{?~gwL|6D87iefiO+yHAqVUxLMllPUt3rY=V2mM)@A&4?+Gv!5SX)o-BcP_vnDl#a zgjz6!YKD4pZUrR#s3e%dv&JVKTmAc12#>)Ivg9j%C5?ybwHeIT#;77Fe$$}kzVYiK z1-u#OULBq&AZ(+U(&54MXTPxrk5$?-$%K1JQx?>|NT9EdV9ywrXaw}l$dxAh4W_8i z4>&mOdNp4wX`AZOHLpz2eu~lfBZi1s*xBWl>${Ts&Dv32c^k#19oz-Mp&0>#U%(k4 z1o}P1-!q8wI`vq3xP60a0u`M2!bw_eGZBYax6l**L9))K%V*8+~tgYgT%l6lyHX^oqna0m1ONMZYFNt zo}{f{-|lZ#y^>=i>H5$sl&`Nw65Mv81k2LCfdEdDkd%#NjX&VhXtk5oDNBF>HAr_q z?|$X1a$mnZEdwO%cTWAEHu(FDMQ{&jD)!IuwNl!5;A`2utfV;}{lQ+cQEw$xYteO_ z`dEQYRb*I5qySgh;R%pU2R7uuV{a4Xkl+6irW*SQ5a3#~ov6I`h+3QzHc*oI1deNYVs&wfLdK3uph%>*VVG$%9MsVWAV&BE?&<2_b*z90-W;n0BpRtCw{zrog}IP zQ%ESQQF>gK{m%eEXBja`2A05`{yNL->A1V6VbHAo$v^X+*2u9y>I+@bnEDcpNPD`d zx_qDogP)H#l`q|Y#9-#R89~gZH8KV@+HY%X>l#+_6s{F_SwgV-xZi%Jex^HVu-LPW zwe^^GzNW5j)%vtoq)GIMFN5NKZ-CKn$q<_K4^WVvMCCFnzbQqFzh%n4G%P14I;h07 zkY#b80-tzApjpvBYlI&qZJj%|CkFgxef z?J8645{>l1~rUH>T84tWjF;&lJuj?iD2Uf^cg?QIEo>N|gI;{m|t9c6QC=l6R$MQfk-p`i&>UZ_0e}B+q0DpH8 zoNo{$-nD@iH&mqXa+b)oL=qF|(1pd~LI*vtzyB=fSPoIAdA9HU>%_P`za(kV!i63^ckn5R}5UJl(=wQb0 z&oqf0X$(*;$WiB4*VIU{;Pns25SAien*YNV>q@$old=I+RVlzHLgKlbkd0sqF~Akc zDZ#K%HmXqjI=SjF8$<8-;KU3-^%FPxN-laiDir}tBLWi6pWy>Wc*Mj5OZPl_zNauk zkLS3F!I|2Ezh8z>2XOYw*Jue9NFsdgw%GpKV{W{iO9}U6G(;lMQXz27j#mPz_s-pr z7t4@k;7op4PkvaLhRMQV^+@HkZ9b_d_%iC)Xzt$OYQmj z4VWqH0pD3~XbyOCcey3rFd>oEP{JHCnqNi zSX;k-e|gNnjjYV{(QOL`)gWHq?f=yOR6SNAcBp|L$r<3&9=3eWzuai8p)i_j?hA$W zf4u;Q?rehf*sH(*N#r}z)2bjZWg$E7hqX$xfK{d00PJhc!_YhFLa!l)M?w%Pie(6r z2v0;mw}IzGs57&%Au^xrj0qFEqHdu>;KYeS2e(MQ?Y^I0vEK%`>yezAHjkoYXZlyC zIU9-{lgge{g!=4^X zd|jSGZ`|`cb~vMBV#o<%O2&z_e(&<_HM>f1l&mRbm$3h>B!J*?dv?9Pm077lpm2xyQ4L@|eg^4ODqUZouG0<|5EN ztLMzSDOruBLV<`(dP=IQ7@3O&%H7Io6YG`=v%4-6)Yv0HT?meOg+3(>_n;}T!prFW_47LsQAchMvp_eR zpDb`40q1ak$E=uqN7lB}I_r4k#Qga9RJX_6G$Muqv38wXN3H*AdVK-aZbse%dhyxL zdV6YkOKhI$J*rq;zSzLoso+TQJuwgW@4S{P!TRdL!#R3qC577B;v7kNAAkSjgX2#E1g4b zayGWy>vo_{6Y;IYunS@uQ?sSt6{R6DeUWnu>lL29vj9Narqp#mKA$KcH=AUof{YCzIpY=ZrFFp#)$p9J#x`H*9KgPN`=k_xbN00rGAp5v(frMmybU5+e>Klm5}b zlE=ULl%w+~eUk1OjrDX8`To}01GiC(gwxAz;SK=I2BW0-YOCEC*IlI;Nj&d&mVVz@ z-ygr-bk&;mLF2LMggN8FIlTTMdkh-{#Zcr*8)F!<0#;seO?k&2D)KpaFXHROpANr$ zbxFADFA!SW%q69oqY6R72y%`#-u0T!x~#BqBU+qUq@jI=c?+bEBV7-5Mp~Ree+@L+ zFv`i%S+19L`}(ijW&+no@`wLO68)!4dZv`{mMLJ-DL({>a&S?}Q|rPq%nf^c?1f5> zsd}o>Di>@_EUJQjv^r?P%u36nhB*AYdiZ7AvOQ9nu-Fa^>Q6jr85UtPDq}TPoK8Zy8RIfh~*h_fO}a`e!!+tzr6EikkH=3i*Xcq zsR5ukxSW2Dhs^tIlA!7FCDLd|P^c}-H2J*c-5T()Awsa=x$bO5X=;lvGQ&vNK0P#h z8*mIZkim42@Ermy(fLw|)I}Bb8&2+%P-J8)k|EX&3*k0Y%mhQPS;X6h5rzTVq2U({ ztFLk9DI>KDZ4REI!tSrV?}?V*UExpN=|7=Hm!m=>M3SU>E1?5l53i`T$ae8&QTyj3hq`;vCSqeIU%KHa`(MDF~va$thg$5AUp z^rR1*9JrGv0mvb9JuY=X)dgsFfVM?E8{UKJp=bV1U_Srr*RQe(M{aD<4Mfodl-Ux%)bt z!6^-#E#WH!o}6X#`F9F9*WVXMHkBcoG|Y~xhb$8GgN^;h*&pD9hc}QY+;E2PN4(?H zmxf6NJd_@a_9+lCULKalD^|*XcMlOxgv@f7Z;N*N6alRCe2)QZOi%ygx*9})Yr%S% zh1~cJ@Hj-yK>BJZ0?eF{iDH4n*uS}9urr|Gcw$0E0kR@s@i{#`_1I02;$SbxK?Vv< z=r^0yE`MPF6J_4rMu}5+JRX&DcHsP%_RMbM-J6fbLsF1YQGw>_vOdKo@Q?q)$kZ(uvhx6PjSBA|l=$bNG7vxkOQu<(H-f$=Lv zCEf4}zl`6a-bhNDOwe}@TbD1b&pSF#qS ze2~W~gQ&u)!7x=+nK1ljVoV7fC$HrH3NbKiz-70l3Hl$Mr7oeawHBjvmeq7wro_kV zO2eVip9S3__U3LoNy3Xb38!UD!;3t;uov%s<>6qTvqJf;=ZReNpdXgNSLX-%b<6%- zso2|i&CA6N{tMu{stA|FB>A#<`%%NmO{Tz36Sz(!o@Ia+NsylWYJB-AA?ODjk#zwVlLWnQ$avqZ^>fuz%?_bW~!{HSO1 z-U99|bpfjGGoUW%t=N}$7Gv*OF(E5eX54(I!*n(r*yRKkPvvtpQabH<-SXTqgYhIx zQ~A-QL87{`#p8laoSZ~Qu{ElC_4}uab#z6_gwpatkX1eo>}0l}@Tu^R*`w{D?y(p8 zhYht1&Ja39fY|`ZtT>;`o=U%mp|^iS>%Lw6fcWdcbK=lSAZGd)_E2@G z+u!@(Zm*Ic2q8@>RQb!$+5zJiIh%9UJw-h%ea}z%!|T&l>@|p>W5oNFX`PntYUMw{ zOKX+4KWPUI9y1;BP{YuXajw)&)f239-v^eCjR8ZfZ{#00EDcND^?i5F5Cf*{$g?v$ zd3lS506*#s1d4At3n^53#Y?GDGz;UGl1!M+TQC42#LC4LYr&CPZ}aId_*M6q>3M6Q zFFd+mJ_J@77ypEQh2L&599K$D2vKxeA5*7vyFk$oc_-HNPouc{Vm(BB(H6V;M(!=C z=iU-4OfG-$>no%sM%yj#=YyG~@z!$38)+^8t<=KA#78nbvEuTlQ zM)Sa3Ej8W@tGxC6W1K*uJ21Bm5CiPMjYwad{aq4hl;sw#^U*w{av}tC#>Ix9Sh0qf zAM(xr6<0EJUGj+@GmBU>x-mAcU@1=X@Ov_9CGNG;h|KTS;UgD=zr^lahdm9`LxcHo zM^xAhi1B1U_`zZN9tg+acE)4jX#l#Xc~AD7hHpzLc16G<;T9Acp{g_JC%Bwex7h_` zOHja)hy2pc9WJlSJU0bY`NEb2DH$fhw2&A*ZZJ9P*q?M|U57nhV& z(%KsQQylefrLP@gx6)AnL@)k#0{sKJ*NCR3r{JsA)5b^~3Y88?3|2Cl_Q6;e!-aBhl8+&Rf^J6Wry%vrvpqzfwi=kZ7L*aeNg%A!4tP{3M7R=dbF|G+;@W zfoE8FF;)^BvS2KyJETiJPM@lT0gS2cPs;CnwaqYpjLmom*Z9c1C43WT; zb#uMVK0vQ#D04o_un~_u5{gOhY{)+EjngJp0`D*nFhU3S84eK@L7FuHd^0{^CO{2C zL2V;;%fbd2Xu#SONG4MAZ4tH00j6t7xNZbswu}L03k9pWs0Dl&Muo68N}P#g?ilk6 z6+-P(IOC^32fKu9-*VQ92(Ch?KwinlwZFe*nQC!%xfk%DR3tTt#)~soDF)L~LVhcq zJu z>b;T0g$_@%$mV_G3e*+N=5s~-*k>5t3r~cD4t(jbR~FV~iJ=R|{KE#T#Na4ne;>i3 zN`g;O)%vkWLsP&UgeWOJ!3Ke+qyJ6gQ3i6?qZKffjztzZQflzm^9gaybqMkKEM#%U z^%f(Qsk}erOo=>_6S0N>^UPz2?Wo~!&n6xAD*Il%kJw{x2|wH8*mbS_7FDy#3~;V% zR$VY>O(14nFTIaYe<7N$Qe<$rMDlyjXG2u?~gae4NuU}RF%FeNWGX3|#GKj9?v zlQ6!QwNhd^Qt^vavc#VWFIJc7YO^{rxT@BoozwNOrHJ=e=)1GvA1$lQ*#FCDB*nCz z1LF{Nm!Y0zE~^I3S%zFOTbIRY=Rt40F`eh|HeBr2k9aP1hCq2Pr0KT8F<{FuWF>Sg zpbl07&a`T|e z50bQ{1|8t>vGF-aJ6-NWK6<>~N$rAxO=;Ddkd05LP_mJ* zgzqtlyouWH4RMUYSd>mtn;ozImPnZcRV*Q`8TrtG6git5nU4A;gVPho8Y%?i9M{Qs z2K>WgCC*6uwV>ym!ETq06Zh=6EpjYvvd;iSHoOeo9q6gxv)ieCe(|(uM2R73;{&2f zg5;_|P-w$vI(VB}&ys9*%smQ3v)WLCJ*yYbWa;=)A}5_-tF=zy6~)+wIdin@c2M#Z znQ^4RTzc@0JEt{AxVbMk!`bdpuHtFWM++TYx{IQt)C3m_dHd0ZhRz+V{6XgO5 zxtO-0FepWhGDy{Ea75x^MCz4bed6L`k;oR%^nEv;gl^iW=nKSW--!9x+zY1}a_PrS z=$@|5ANhohq60MroM-m~5{`cLM@)!*fY|IEI6)3=``y*OCu>dykHr%U*+)S2+j6j` zTxlgMsT~aQY0K3+DDhV%ulxi$8i$yaUGSRP$M-V_Frq zTqA%%76b#yFh-RkR9txsR|7Vn$NTvFUqu(}SluQM4#QZW zA)eBl&V%Z|t33a$dCIR00ukT@O2;1Y3w$h8^mc#9Ki#NCy%C>;`*l1lm(B<|`S>y? z?^6u+Kn~O9tct&ZVTIL&yJS=)?~&wTVmnUUN$T*8h&It-t|!sqOzag4c1~O&hcf7$ zBHW(3=;}(=>eo`)FW}Z4DvmXsn1TXFnn;Km3Xud)BB2#yp~25v6kiy)e~{iKhtICAEU-)}lOA&9n4_+n%_2VU(8l}`{14ml;FMbgi|1Sb zX^-a7@!W`WbUG5V zprq&5`Rl|N--j>c2stiHnaDA^Ci2$SiAqk)8N~E_&Ee%#(4a0%_n>&&+n{((daPkn zBc?U?EsWb!Z$dr%-%j7>Q$Rm+iPYyF=pAk4@vBi4zaQY83q-wiJ=w&jhi{ecntusU ze%WRFZ8mAr@)RXO>anQ=_w5brAFPr2o#GL>YSMT@~FOxLSV4ot_%I zV2TTn1Zw-<+84$E8HvxnD13Z=VHp|t;zgl9tRSC%-Q>xuq4ar~^{L#GOJm?7@80$O zCC-P(kt)i0Uz&L+R((l|-0WUoA*JJ2u@2b55JdS|8J`*iRO%JOg!h$EuIU0 zS{_jSgdeEhECi#xcs%5ZNvF3<=*3>CpG7=iHU$)FF3+bJJ7;qJZy1KE)Qp7(OMLS= z{$|P+maF8oKOj|t@EXR+()TYn%U1Bjf?Q-9&LKQDa_r8}yf?yie=zp24}2tph%(F< z4733A9+rs2-vb+mzgHrEIrE@dNE6+2Al$7t3LS%ua{Z6TX4YRJ&CJcwqXt0Sf>DV> zV12*WvDSgO*tejd5%|@levSwVgxxe}G5#(I9#&kpB|KQD0M)msCMW^U@qk}N@~)X| z*rnacf0j%cvc(3wki`a>2^D~G96sP^dW#HmnSXZ)`c{x{%<8-a9maRQ?rq;gFaJ5A z-{cdFgz4PH;nowu`D5D3lPg#68_MFo-qRfOdyuPQq{z1>LHZpWb-XT^%C!)Atd&zxP3jJbL7<~CgHda zu5~fW%9R{<`#s0UCj(8jW*Y`0OJ8r&;A4;bi6%UH*=H~E;wfhmv6~vTYDD4+&W8!K z54;eyX7x_~i>n*zH-|!zB+Dy-UqO}9yl6QbxlL&z#p5*{WSU&ztqyKve$;1h3GvLki95`f9KyQR0=kdFmWSd-@-o^K+7!Hs{3WD zs5U<>*Um}cSc#s0Ds7Z0(g~_L%sOt=)u<=VWdS;n0mC+X)db4f{gy|cim5!lWR9EV z4w7Q>omG)q29WdC$$OSX5o_9m3$7d?-apH<`tMq8VGaO-*e!OmzZv1ecZbPuSrJa&H4Vd_5XFI$F6kp@Xj)45^P5 zUC|wXKqcgNc6}F-M4n+N6d=Zq95A^dl>bOL6Sqz&91#A*je3xbjErXbybP9*>m5Mq;%?<=co+~R|^fngciNMPq-+S z=rODL4NDU~P*05dymICxqW;&<$>g~*IYN$=@YH@$t)GE4f8Av#HwGfh5wVGNaUHxl ztnL@4&pli&uNRp+&4ldC2!zR`x1U9XigV}@_BF^J+zb+V!0pugy_0xF92!SRj{eOl zlrTivA515!1X4t>w;%0}A2Q8!KbpuRW^cOJ8}@~I-l02ht%(jdJ%0xhG024sM{KB+ z^t&NVEiy_(X^&%XBrQ1x53j~=D6DF6K6Bmc3ryXmIfsVzOWtDoKZ~T^ApWxs=(or5 zt9%%e|LQ*;35n|;Gi$%}-`4b?m;n}kLJ8AWL}h~>LKu`OHUm6Fj?V|GOh0xtw06QI z)UM#<-M@3Inzj0*sfG)HVg`|&w|F2FzgF0#4$Uvu?o1J{22Cc5bauoq9s|st4`oCw zF`5z6$uKKjzcY)a+^JF$kLHYN^~DbuE9}58d4jhl{W?6}OQ-Hei+=jyWWZiP9(`zp z5*<3#|JgS#2UD1z#&1~;13dfCPyKn8(xZc7mohJNZ4Nq2NKhM@u&+=^1Zk@;4y~xN z5=LMuz*LKc!#4VA%~*9lO7Lwg&)_tZZhTx)>D%^a1`=7>)Ln%ANnuv}L1Q%A9^lil z_5vuK;>C5<`kcHhRjYR;O(hb4ID}1X)O~VPQr;iXi~ z87Mp2l+tpfVaM~`W+)v&FEf@oFLuEM&y ze3v&qVPj&d@EJmrk-)vyEbywKFmDATC6WQ<<`#G(q~)KLH5u4J4TTkVGElX4jGJzt zri3^og3*(bHk%DR&fE#ivTCc6No;GVWDT`S07&usUq5OHB`q!K4}KvmTwDNnyn+G1 zpmReNg9iDSKslYN!0S>KkMAuaRz?`Zm1LCNUpbG~e*xl`sDcQ8H4X#T2D8{z=3#<% z?(YutdR-ei<0&BvX}<69>S{H>)7~ykJ~_I2zyN}vHhA*R%-YQ31zPlKQi^0L7&>5 zXCQEJAE1F+gFig~aG&4q2P2A0=D{*C^WS5fMiiicO|&pkgp)&3=+6Xl6 zb!BomtE!bh+}i?`bn&bWc1Dw^4*Q-7;Tq-xC}OfhY3%I+ZNF}J0Q@DfrTYgxY7Me> zkY^aZHNjQ-dqvrne;#KA9AJ$S%3{Nro+i(JSS3*XIvc0IhXK4gAUYm`gy!q(+tf+Q zikl0~il=8Lrgl*CMIn%0Rp;o=$ijo@cp(|00kL@di6tBco)I2&6#YG{;>T&e*L*P0po{)|wSi_=w@S@q$bGyGwe^_rkm2AJg zb>vuYfV^hoqxzKpw4hTvc`%==!Wa=0`e+3Jql7P59H)?b1sdX7&S%eL3U|5U=8M21 zEaKBI%WG=cBaYAL(ijK8Tp)*u>`uV{^#U}Wb#5-E3eZ?*bCvY#EEyV$KU=Ar+d7vO z2H($D0*MtDxPiAo)Xqft>Z^*1`WB`{#zPK7k~zna`MBn%xP@1I#v1RpPq4+uaeBwR z8?e;m3z|+82sCUVP31R2WbZAHg?Ci%aQT#XRFuDN2bFjh&|rAvLQeo0KQ(v77ng~j zHG)N0%7QKX8ZNXLNUM!y)=pB9_7hh6+t+=C|u)3e4f~6a?ApR$|v1}=sH!K6Dr4Pq)F{lA>3MXp!2nTY3%!Jq zO%=_NQD5LOZ9wThoOY>iLqow~J1_aoc}R*}Xr@bxml>!hl)Re#l~TwS)FA_0I*vJw zqJqv3FF~T$xum`Fi#4pHFwSpG5YxhV!R7GzG>G=#MJ)YjpxwY~>>k)A$1Q&j>W1E6|9gMhbHjcsg@ z!JSXlRbc7&I1Xo;+B6|JZ@E~M)$|;LNro~JQ8-Qm%<+p!1UsMyK*Nx!Tz{nET(@Uq zG1D_qgUorq)I-Rt^jr~{Xa$ydZOy7$WFppRgwnuoYJR|yXV!X67SUKdQcdhffY(HT zr~mhy;&Bk9qS-bWrpbUBDK_am`mZr~UTxt%p|BhhcvsBaos?n*Z>i->tAWUI2aeQr zXaB|;JvU;rxyILOU2*2Zzq|5DmD97l&7S$1bCpTUMdp&&VVkI-PiLukA2_ofuE2q` zrLv9`S4+a`1AWS7H*DTOV8zwb0)XFhU_9p-{BA0n<-BUgT#%_n|4$w##>V55P9NhT{`1U$er_RKWI@2#v?5@?M7 z%YQ9qoNNJP(yy`NC=f2bZYvRl)wHFj z2*{I9MU;TEuwk5=cg9!9vb=iRo=;INNrZ;O_8z?Z`hGC8&sw46u>qsg#n~&<+`nN!gybqi+4-v+q2O@JsJjuV#d4BGDhz4!7hG1!;YF|CehAAnRh;1&zLg!-l zuD3cDc#*WyN<$gdwfw{wy_F3SGi<+km9DI!3+QgJ@ZO;*K~_VdHZTD&Ck2B14BVx( zbrkVvX0jtnJnw$_%h)?6d-Oa|l1Mu>Hn^yu-EB2x`sbE{29$`Cc(g7|Bc}HH_nHPv zZe2f=-CFB!c~u?};qVoZpLw*1J}F5Pp4~J$pH7=*4E4ouZwC3=iz!pmM8Zg8^jryO zrZ)bnn~ZgkrwwrWCT1!LMLSw@O;ExM3fg1u)VQpQHi*(O9d&ARGofLB!@T4I8h7%|hbls%u4%Ubc~sh3wsRun zFAI^!OmmBgFfSW_z2wY(b1FAF{p5ql}PK^1|pw+ z7*lEC69@)gwOGsYe%SuWB=tBy{*?2?NYw|NaO5~S6Tz@`k2{_f|2urT(RL*)$jI@} z2_AFynrU2{S_Szo%4+g7Sd#hn!@&DVFr=h>G5VbzpoRwJzqSa7m?m+mPgC8@X6V1QLW-o<+ad0?DB@;eKYGH;1{{7LyiC5@rM8&92+ zKTI@c#!OKhenzAcmWh;gkgFT4mf-RT&43$vnO{k}>!`~L1n=&9yzL|m5IJPNR5n}% z$}FNGvzreEN_bCbKA{mxOE#i9atQNZBR{2P47zxH;OP5aNYhVCu$&K}eTbAf& zT~Tjl;Q@8GrjC|JC7S3lJ}G&=9+t!74~!9w%0NPFWx#7@29i1DTO#fiBYMP!kk!Uh z=Iq9sLKb!#UNLfdT+DyG@(aR-m%&w=hv?p%ceGinMg5csqlMG$i2Pf)>pSEW-9&xsx|lW1EFv(8=S9vI$V#8he{uIm?YwlRVG#GX$7jpP6cC_@jd zf})chfwyX`a4NGL+QS6Ets@3*9l(1wJp(M^GC95TR!_wa&w?+`0n_#86jP4%4oE!- zxu>PcGa=w#FtYI>$kYf{Ok!c<(_+XH8;mRtMX?5+v-iGV`OM$LhD;-K$3IeT>V9WQ zO|2^3b{^= zzMGynL}TA~@Zj4;=fZXV+}+=8JWu-Q;#OECCW<>r_)8d?tx24ji-d=d4}RG=v^~Fu z1eS~<9 zBbSt#v#?_ZP+nbO!C)2~87(_Zz*msb3{P0(NSGyN?0w11vSX33?0;Tzz`V9{~;bg zfdHfz4z=JZ>Vkgi9j7;o8QT`uM%g%94z`$#3@vfvx=MZo$nJn3VmmyItHk4gzEWki zE$B3|Z-?TzmAll#Y;oY{*Bl`ELFSt0dr6d)!>gee;1w$p4ShGXm`;YXM9xgBsJ6`b zsPm`7N=V3uKnJc7Tjr{1kYIt?g9*(O^ zB!C|A{I44>3tJY|ZWUN>j-Vv4sM;aUyuY<8QRHrvew+_*0DCO(KjHq1#m0&&^s>uw*#lGv3f^{6dXbADV{Vg&9a4J0Z(R3WHQ?U`OIRVplqQ-lv) zt7~5{;1PypAx+6%14&9$MIvc4pB9m%=+x~u)YB%i30 zE*o!CHcdUcY?&2MI`P{1P~}thg%m$*?2UCpXr_J`IxigQU0>77{;= z#amEoW!*$<%81IzH8J)d@mBQZ8~rL@i6xfqsRG~Kr3sTM4*4|Zz8pZ0r~1MYKLNP}&hKfr4x z@w#bBr-n>p;&mV8(&N*Un`8{Vujf`r_(!l~dAFg5OQ9x4c_p9CCs2eqIzV(u$nV=s z{4{Ykq_%I`Hzx$PTKbQm1>PW;UfDo|nby9twr=Qpr)bi&%(&n&ksSV&&c_i+hQe~* zh2^L|Deu}68359>`le;FAtS@0M-5$EW=WxEB11!13}WVHgl4%W`Ry+1r0cjc`UD1! z*D>rz>hAYSB;N1MRuuoWG>(VcGg0;+UU8f(sRW0dur?aKbKD=uSF@qT7ED@~nar4o z5JT#~MN_p+<&^X{-x;o!TKtG7Z%_kEXjnKxs;8K#PP+zJnlh5pAiF(i0yP;TJs48e z9xx$@_y3oxV@%pMo-CvN_Te$I`B7s78lc$@qV30WiXtydk;sR&F;0s-G7Q_ng}P50bJg zjcwpSQ;E$QXyHQ#^#F&A?JI*8c_hX51+SodiO&RmO-GRXhP!-)D*Hbod=ybEo?4|8AJa5=kpB>|#iBee>@FgFDdx0Fiz8uW#-eS%w2Y zv0pSHgtBNyr&BgUaq#WV{)yGH%!&uym|f*wx}cKL4JI3yfwq(T;Vd6-W2<($Nx#ys zlMZlx-#!0ex3<={3h(#8G}9z=N>r{mA%|~BZv_A-08)9u1b?_##lO9y22+aPyUtC1 zq<#(>jdMM)h#ERvyij`oCu}=wI=_u+Yo;>43&j1l3n?nmL zc=`xeqqfm0bN-c?y48XFtYU^+D%YIH=l_XGhoGlYnJcxtS~<0*(o&je&ELRTaRGRMB>^O$8h8nG7mOrhr&lJpxNKJYDLF&5HT}4a^dZU%7)0D3#J}11@mO)0 z*87<^_IrnNI6h>S>;+XKVErGe-U28K=ldR}8|jc1>5`Q0mKG3@?k?$WkS^&4sfTXq zR6syLx;vzi?sxI``Of^`8OL!P6n3B8yXT&B?!CQ4NHR2H;P8`TL>#6ZwBvoG<={%7Uviwz)c9(MQ`k zi1-&Lgm1@VZG42q8ky0+1w-I?MT)Mte(00sX&Et)*QORg;h;=K7Li|Om0Upf&3YmF zddK_{Pgl&v$5v8GX_v?G1v;^{@}4SqlRm>lI`9O>^j57MH2Wfvpr+>mNuDqiW|V!E z7eBCTeR79jv2l(}X}G=X=G9{RAcvQJ2U@X}DI`<*U zT9rhHJuaOzDr4GVkua!0QGB`6r^9$Ryi!8T>VI|Rmeyq6dz}cA`s6!nbN?}FJ5e&* zdqLzp|Qme?vOF-DVj!zj;eOD=N_e0niI8iE*~5L0?2oYv>)Ag8ux` z8XlHdouDd-KmvGL^}+T^7A^F+feU|}da|ASATE7GxC{K@Z7Z4iV zD6Z8}$k;TCL(Aw~A@{pe3>KR>@r1X41Y;MVw`*WgM7AmFvDe!*9u7Wcy6+K?r}no6 zgXz8~mbQb5%?_`sm~S}W+P;~7_9)b4GukP;x15p)=tVg(hD5zF5$h(=$Pad+d6wou zWhV81>x|>lf@|F}MUe=Y8p>j#@>fb)y@+U0LKl{v+)Vfa({!nW%siKGP-_sNM^D$reb`0O9^TJbJF$5$G77(Ny2GO&3JPQ-YlfhQq*Bp+ltenYb zk(`q=tG~Cf3PRkx^$;r{KQkw}D#C;Ajw||Y^_$7GiL4w=4bVU?mVEJ-R%O*$5?$Q9 zf?X~b;HIo4CrHT&)g|uyyitlohs@91;fBJ-#>QC%L0S5Uy8h2#_|fIJ^hgW<##*?)KhYhQ3(G1+&)H5wn&iQlv6p9^?ed>R3VwfNb2~gRc5UxfcK@1`y{gAyI`% z&--0uGztL@RLQlA&749}kk~Sh@82iQwhYF0=jGa6mm?7pk@as*MlHakb&(i4zS(AVQq(^7 z3%Ye6o$?QysWpW#AK#uy4wCi`2s1RuE*jaQRjHhv`W3G`p+jPt@0vdj%Rx{??E#b_11-Suw5Idm@yTVgKc(Sn^JNZNynC< z#CWChL41NnrEbi9zpopOhPHS2_C8-5)`a6`|If(CiM0`Of^__Kz33&3MI#M2vU)V0 zerpx9G(UJ-3O@I5du^Honfn>5Ji9SJp(3LvmZ_jiEuFvyno@Q z<&A`bk^zN_F`Y!}-shj6T)JZ*tg-OJtd)6Xc;bOlp7@UT9vg$3JES*;po`Qf-J) zm{>HqEbD@Oz@xyo+EKeO=8f6*(Ll~ty6l?@jqOG z&IH}K3DA)|cbFxEDN!*c+ul*o$n3%KdWu6 zNvYytd&hX(H<@5|5W9hnNF!@d%>4HgkZQiGaUqX!hRARtyu}x1+SVG=rz4$TK41-( z3%wYYN7!HvNgvxR#hE-6)7J)*Y!Ap(i)A-$|E()C=!Q@gk+J38wd(ZGdZ?K0$|2=O zcrA?=NG6{Nlq0BD*6e6}dsaJg^;XkK>p!~)Av4K7U?NQaIp23p&8emiC!zKpy=v9jL#}UW2FRT14@4 zbVf|ZC8O(_5F7L{b$KO~e$Dx#x%1VLDu&9|cEZ zJc<2ggrcg{4otA20Ci-0FmI6q!MVx4`31EQFV`OhNxAjafGWGb^mi_US62)$ zX0KHwjM@5(5p)x~d7ojFJm8UyY|My4isH|E%{DZ0>7o=y8cacj-HlA#e56MVmXqP9 z7ez7F@m>+L9Y3@&>AF0&!oH)1r=s%Xfb4OJ!X$$OXp3ktFUp!v+MvG*rbbI(MgG9j zhi=?HPthpnMm^nYN>diRZ5T;K3hA!nGzkyWz*q!2p8D5m(gG;cc|T@K{G zaeJ_n;BzAi`EJ4Y-QQC*Sj;f<_5ctFaQ(jxw1_w*yAz9oK4f)bn^M2CQZ|v~NZy4? za)qrJ1EHT#Wn*z*^BhQ3>s#DAYFr$uv#S0(0f*Z?sKaGq;&oX80zh&Z8IA)V3BLva zOM6jefY&)}u_8f&i=c5`Z1bpN783ai$MAeMpWSfJ~0b8Gu z=S+qUZw4T_Hn>n+omk~^O~U(u=_&7q|H{aS9WC3~g)5pSErLjEv)c)cuz<_6Q9{8; zp4ok_aKr3Z5bnCAXxsU1afzNb08rg$OoY8V{kc}#N|&M572K)?x!{e0<$uc}qf?X* zOrMjRQF(krQN!MsA+ns5Y`(597k;48u;D%zy`YShxpbber;oAWyN$k8+}6w zMKEs=M@w~#TG>_C#pRoRbj5SxNN_;N>nXovz+!`Fs1A41YsTL3`PUpC{3*X9Xk@w# z5)+!B+}Byn)z3F)++uq#z}fvU%UH9ik+Up@mn8_J>!>d}%+*HzcB84ok)N;Cr8dIQ zqFoM4(sb&A9uH(HSxW@vZVk=O2Qbse^_U=B&fYCbE4O2}p@2n3z4+L|R@d=ZNIs-6 z82puM!d8~#V7{5lSRFmL%wJ7?IJL`rkHD#-#RHjE=iZB#A&(xLGXwFht_vU^P-Ec1 z6UBFG{buYej;`hXrE=|$DkK})4QTK{F@why5T|d=fv$&Ytm0(IILsbPva)-V@*+xKUAFW24y(jPkJPte2mf=fTL&lqW5ivgr@TH}uErHEL35fh1>-sQ@hwnX08bQCTACI`wlKGpB2gYfTT?7D3M>5A zT0pDB*y>JwCPm+Ou5_^J@OjhUpc}EsZ{P zGLkC+SYaGT^QQxoH!VV){(srufFMP68Yj`AJeW?SNwtG<^v$#zQE1W~_0nfH+O}!> z&r+m7Go!W6axK4YE@nE~#&?Za12Y;J3`x;so-fxXpJ7l{HswdjWj8617Ig?p4*DIG z*0~d@$Xf9!X7R=7a1plhPGvUmEu`otrNcV9Zsf#2OBK+aS)RE2m-XU&bN7JrAqX4U z38fuZL$gLznJOntAA!xNY-wzucI>qMXBA+Ty?>7!LCH;^2y%=o+cpf2crBZ!p9y|Z;j^ah@Z ziP)5tU4M$&I4XRB0!A`$?*S?g(g*^$Pbyp~v?$_VqQ3VIDJ={*l0DugrOv`!aok2% zUq6|wdwo(}0t6F+N?qmTZVcXN3+`U7q&iOQMiV?MEi7^^4JWTLHb;1jQn+!pc~>2p zMd;7@TrFAgd|Aq{6)$(W4-!Cn`!VTE$Rr*F82fr!*;iA_`oR7|)ONaz?Cj@@yn&;- z?F2l|hBbhH(tX9`kUH)KW>Yh3)W8OaK%Qh&7=bO~8De+^WJgMjb0Io8jwaUr2 zu?iLaF*7|qFZBZ!9C7VuQ1$$9!Lt!6#zqZ?#Afl?Ll7HnD|$C#mqM%jY#E8(UOSfh z;YurA8o8Um1ZnhlvvNWhI01YD;_ZaQmuo7EbU5|#2T9Es*~6czNVjvq{V49^BDE9@ zOc6YOYYdd}ghn-s^LgX~?^%7h&S37r1gJR~Gzidol5$Ha+w@e9AN%$rh(e3%j=miAW4 zIFN(IOyDfwnno`SrhheI$gmUBlN4bBa5v0#_gR8OgP*`AWeH8gl%iCj!;W3O=A=@w zA7%c_^jxH|Td36R{QDiV(uM~<#>z^ZdP-d^Mh-Yz2&4PdAJMG8)Ivig2+J>IkRpYd zLqlFPB5ubea@Wqob_v&<3V=W7-c=qNRFah zI)@f?{+kos>vDF6BH@dODPRNs1?f4Ea#D658EyC2x4B_Y&3s{jkOA}c_|03>Wv#rz2PPJP4RiB4JY}EA8P`vF@@q5|A?c0Wu^;V) zR4KY^zMHrc0lw!opp215rMiDR&({{)Fbb4#gFm%>*Yy~X3gm=czy1PKG; zGI4QcydT&-&Y$rztVO!0yBX2<>QCJBX;dHMX~tYyt*W>jt3hw9g?B&SzsvPp6YyxO za2hV$LlB$(<}Du%7Gv#QFx08Y!9;*}pf-j3zkmhIX@{%bL5;o$VvVLC@n*ty{(5$T z6w>o7#p|eUX}=dV_}w$*`h!3ZlVVeHt4_MVY|3)`PceWp^nsi#$9 zrn2wm1gwhH*#*Y5kR3OCrrik+Xrxq0CR)OGL--e}oPom9Yh_k8N*2jTc8l_G+%U6A z-wabA2oByuc487Hjoi<8Gu`b@G>-4cj%Fiqy&nwe?zzMUfD;JD0Qa0ecfGucl15Gj zsou7+=s)gX&*zS?vVwk8MldcS3&W--PpNZK9aDzJvV63)vXPRD&5`)Bhqd_&HJM*> zAp`+REYVO`7iToa`})v2C%ylaP>-p)*-{DzOZ1douv9oc?I-{|~bWDFka^<q=c4(enYU|q$DoetAig5fUmKpG#s=5&hu zA8MM_g@MPcW!8?HUP6T6g@z;vqYe=XKO`9VSiMfrOnSzxqh;S7E#LCe0thSJmf!8`IwuS<@&?Yw8Z>073fGF9X-7{U(tO}ripYh z{ozjWwB759<~#Qbd2CxQ0!3M?#RSd_`DaQ=1#F9V&i&xV(e#B6sy}%~}~h&jxl)T(zJ14HZ-0oXfk`C1czMmd-}yLA2IBDLEN?0 zqKnr>TmJFlMB30o3xZFg? z25X<0sOF=_8q0=X)UE1VmfIir)3gSk>76jAonLdezQH!HO-3T%KczFQf!Y<2Oh#cV zOyj)QO5I0DipRq8qCvdoPqq0$7b5i3Ve1vhdHYpUCi;O95U_NriQ-xZ!s_sD{uI>%QIj zXrQ7{6t{6hX^n)H`pi^%#l_g{9~{(QaDdC^g*ggN)eDu))jR>ZH|n``e6j_eIN2nT zWr)c=(Jtz{g2KTvoDr#pxz>U{KnK2Du&)*>oP#%>L5ak@?Y#f~I?^*6TpYS68F?u2 ziCjyfFa1H*Wi#tnr|U!p3Ap}?B0veGcRHNHvlJ00 zsmHxwW>LrFz*a@1*Mp2Zqh8jQ$R(8XrU9;OP;#S*mMgAFl`JQL=OBzjmPJg0$q@zc zNd)t4PLTYed!2%UOZ5&eE^6jK(JUF_W;YW!N&@i&`rQ8y=LAeDc0p-qYWk|61`}lA z0Pz4b#>~4()<09QX}N%4m|Am`$Oo(jTVi$1dLAip1-D!8y2qNx0hiEgs8wSAruAPY zwe-f`?%xobmOaDb&nHe&muj88uQ15_xiegiEG!7qA^G)vVSj7idshp~hTfo|Ob~aW zT_T1i3=#na?~MNL!_J4c_G2oBq4rgtA532PbnS)r+~lq30UfUrznwF{fC7P3)_JpC z_`#td>0dOZRy~Q86coA{R4l=u&z2fYAG!tHNnKyGZmVk{4Ru+>`1rV5tyz_LA}NT) zubvN#hPlq6=E7(FkscW>0yka(yZWQp!)XZ?@-3xj=QR9(L=``XKb+8rqiiKw8dfEU zCKl;=WHNtCWvj>r+*j#Q;r+x8{sP5S@TK$XxngTHvRLPTA z4B7!BXKzTwF6MtXC(tA-vX6eiC2J*{ix?f%K^W!uVN6&Z3S(aLsjE0U?F_Oe*`{eC z+6aoqLc6{5`+om1o-sq;JWTFyYG}|JV)?PEQ;Q&?HypB*Fq!I<1uV97He3X*8TpLS zSXU6xldt%QZG`2O73aREbyI1zHs}%dUr|*vY;d_O&cO%uWN;Xyn!^CWXrczVx3&m> z@S2QkqMdRUDnp$t*)N&4H}@J6SG`FpIi2~kq4cC`*Q^iHnDEh16~8kYnFOTloi6rp zMeQ^4Du~|wls;#{h6Qc*!<5|i16pJ+e8*t=N`;?;qApH4+H0c7S42}uTyvOQfPxwA zbVj01FE8tlYCLC>%b=M>1|FZ=3v0)sVtrvmv@O*hH~J;}i{-~kDr#kShy|a>7PYJn zL+VPqSJOo$ei-6kFT>N)L1~Jd_2>;X%G56+@oYc$=gm@@tL1>bB^;K2C>N?dDB+^0 zCZ?x*!=zSDN%+B8?@9&`U_Ad3U?7KN)~W*~Ey3n5W%Bjbfvrk2Mz4PO^}ZyA2vx27 zrzLOz4x5(Z(&>2es0&tR2Zqb5%yeIV^gUOQp$xN;a}dj8)$=JPZd&riz?BT8LRs}7 zL+kC@ki|6qgLt2Zc+|ab-(kNTGn_xB0mG5L`zK3vTA2(ZzvkfK*~sI*RZ;L<4($mK z*fmg#b%v%Hs<`l{{Fi?C=_$PgrIW;lQRiV@CpZdNcmmPuiTFE9RW#vQvdO8({v7Sr z-lYNFU=qgR#?10^_Q#*KDZ^~wCiFg2e@W!38c}6gKZ!)%xHPznSvb(V61Mm81G8`5 z4>_MbXk(cw{L7M_b7fGx{S}$7quH8P(~vZuZI`A84L&`;_UN|0Pd3PcQ>C%iA>kpY z(;Y5p3*xe2EA5M%L1T==!952`H|}Si?g^;^>byIL^~wRYqp|$w$7L&-f01XNC*D9U zT)<8jYm51a(Y4>x*2;)+x}_QTugHkWTdB^DKh<4W#%BHuCl{U zR@eA>zIPkkU;4gj4hNQTi)o>)Zl08Xh0lj3w%Vs`E}vT6&#oG^wGz#iJYjw@xG7+A zZKpSYnPA$jcg%4A!>NFua|2a(mVryr7u;*Hop-i6yT!oB6Tl?nSyCE=G7YRfTocNzvvH>z}xVjjj)bmwh|? zb+w5cx?y4pc_)HAHRwQyI3`}} z_rAiiR`@SpgL}fa@eZk)3J#w~!$#D}$!Sl(-f7@gDE2eBgKo?7&TrV8{-0!f5jGS} z^ivo3*eBKY6D=o-Dt0@s=^2JBluvmqFfe1Q&**ZoarEgll&jej zxhrvuy0R<{>Mr_9rUmy+IEn8`3jZ@4L#-n1X_(qNVGxsg<9;%rb&e6@Sn*_5ewNZ( z?D4N0r&Jji8PvuZzN~{Ye-*N*fUGzM&82qefFml= z(zc=-U6?NPnfm?>Nbm-Toabd!~)d501pC;H& zerKW}@r_7q;?CQ{S3n34wD&P4=3xPBQ4bQz$Ld;UA|I*W(=S$a7*y&W8i}i~{JhEC zmVIG6cqU@Kj(l;yI0(XMz_mS`n%0x=O758ZJQw?boB${sAi-x^Uh+e*wa$Ccmmo z)qgX5qNG-qi^Y0{_rcc|)JXjiK7u*x&PMJum9w%OH!~h?+%(K4QKGg2VZ*W?lgrY# zz%>D%I_NqJm+XIgPT@9_)kO1<*D@bFCj<2_$r`ET9_l7AXEE&0x}dwDS8k_Nbj|AT zh;7O9lw9hX-4LbYj0UAbD(e(O0-B)+qczu$M|Z$o-tSoHHa2Vxbw7LEMBcJ^;hvlk zJxUlPwV^-1Ts1TGVRh7XB@866XC2}67)0Fm5|WZHIj2zdRzZVc;bq@r*!!aiA@_D{ zlV+66K9Om{@(rHP`A}NPxpeH{%c?X2@?|h3u>c91|3@;Mh(b%f_a7bZUPZ*HNEko> z%)^9@oI0q`#=mPrznGeBIQy{Zafd!g>*+>5ZEpcJ zRAT@#YRPU`3@gaYx>DzrG!p3AG1>Wu%?X++P$R)$$YQ@5N|2qVs|DpTuTBIsgG%y} zDXg;n*3?M^77dqQC>bfmk7#goweYb+$Cx^sj=&hx0`D;J)SP5!2zB4?w=1{jD~_Eo z@gyS*QEk6%us}U>PE8A^z*a~_+kYYd5VYa$=a+JmI_EInu;+@d1-tvn19W7j&GBY; zOhI^H*d=>CYp30vyNsbLTZf3RPb8u-aWGd$n?zSb%Az{e)v}F4Ny!XC_F6obU8>t5 z>trCkspAce4b;QBUY+Rdfo}K3lDXE(&eVg@X&(+43{oQ*lJxu!{?}*$No(URRT`>x z9z?HC5F0SSnlz!B!^U(NpL+YllnQRs-wSq|q1j_@T;PWE7hu?mg4_EnRk_S02W=3l zB6pufo%#W0bjJTjEBETasgwIwbit{}igF8vx;659H3jf92%3_x+XUI(J10zC_8tF$K7YFa6mrEV{aad}JK}|tj1=K+jpKPJpupDh zy|hrDfSSXK&mVY2BD zfLi*G>jn1#lpK_A_k3_D_m?rjt|2sbwu^Y3^1cM*uFD;-o}K?O#$BxSdW|qt?RtRp zUU_O?IQel$Tm5)zz5N9!Nl3V}E9BX66H6hY?&Je@b?)wjP2(9e-FrS!D zBrSNO_RZODi}e3;M_`fH$xybHrw@3STb@r+$FT#tDRlL%i^LQvziD3%*sm({@2W%4 zDoDxxs=7D8p7S+$)dL|jFFV)bC!JeBn#s%!<3Cfqv^_i&nA=cL>;~m;cR6og@6iD? zxTGzH=@kcb_m}|4yKl?-$gzmdMJolsCa9M~URbylCxHdJADE>|BB%7b3i;2h%!kRP z+>Sd8Avg#i#+Zs`JaTF#lz8lCxwc&#=`4!WosvtNMgFdzmX8DcJtjPUres<@p-Gzb zNXxT5z2+!AVc72+o|T3MC6GyZag7*bw49Xha!T9uuXcyueK1Mmj`k;Jx*|Wi#sbHlBsr)aSx!UJx zvLNs{ql>Br1M6}iC~-i1<_Q%<;YpjAa?4+mk%jb7&*Stbwk$J+fH1(3a2|9+x2jwo13ZCx${ zw}uP{0}Xz041jTC3X~q$-7Ochf52WUD5za_k!~>pp)b7f1^8Wk=57A&$NK_tT3>7E zrD2~@GV=>@8O%Rs0&IL%F>ZOq+T0BP^8%C~%K=5n9P$4gSI_KMZ{T(ha$mk-AC@%H zr%x&%w{j@iko$6L^3T`ecwhoW?tTA~=(zc1!oXZ*@Ic7G0Xdq{inO`IL}*oRc{xe? zUI@r(2NDc1hr5igr(M1+0SC>gkx)XerJT!HI_7V~&cJR%nj!nKjyr z=nOwpB|H~II?$CPxP0k_W{`8S7nVsN=a$kNac(tNg&z5LD#>L3WoWp%az<~?kL1k4 zOAEMJaz=G#vZ_0pnwqNic7O|f4glJ3#J~YSUPAfwDEB;*nU<86O#u66>h7~es&Izi z;Tzb9Bsx$K5aOgu7bN5yN8(;_PBtHpcKM)8lPlaK; z$nH&gJf+5C1{D1F*1OTwiC-$5HXS&ordxEUrT@PiHw$3EfU4y>^gCg`;JG=Z{Bgqd zNDJ?0V01s!DP+FPqPuakG!}BLx;dGJN~h@Ki`7gBr^*=usHhr?O9?8dD1;3IUVPOF z!?v4gp)+5V?g^^Z8g5xIU8Q%q-D^-Q9u~L_%eRz_{jGmq$<=Jr?sYKOX*%_ZAZQn z-e0;r=s7+4`HPYJ)@8YL0#NNFUyI$kIR6$}66vLdK}tZsvRY7D3lAjVj>ujpe{kJG zi~8*()kBiU5p97p^V$DdBnEm=IfBIXejF6hx9s0v*A^29rc~wcENUrF^6`5>KYKfDi~Ngp3x0YHK6``}%`l!xTKw>KB2ggu&)!U7wgN z(qVRQmU(rT^bJNaw1*cy(i4+(u-|!Y)+^9hizTjQe))hVZs!^w$Cy`MX#b0*^G-;$P4=zd4g0T8q|O@MR9dv1j|QzoK9 z^*O)9Ybw=LYt9EhW(V`ds0glmABb;wN=#ieDrY0Y*Bv+R$puCY8I&1{jRdAw#r15V z%_l^BiX3{XM+?yhRd+%9I$~3!Tr(3TNhKREL@RlH#o)g6oOA&D&Pi)|b^` zFDa;~@ZmC{WKBL9U}JB_^~D&|x_bAyQOVUX4>o?C-s*r{#_qAWG*Ru>$4s9+c;7oV zwMZA}BwdX) zb~SfFK5so(p&V4`PGX@P=ql;3A!QY}J?|eI$9}~xw6hnMj=_9ilU8g>!yZn=w|ILJ zF0h<}V}}h;Fm~ULth{%$^?Rq}s=7jC;K004-%bLLJPMS*;&e;{(!P3_-MQpKIfyL1 zFTP5c&m9K%Z3jXNTkR{pB2(((9El27F3qKxQr4WH!qvC)SwCbb3nkYIbL#oHf=PBB z)VEP2h&QtLq*fx_=8QR`dnHO38bjM;BdM+J#a@C%IgV-&EcDJ0-QY?>#vVylunYqE zga9kMV8D$>rZlT_z0Q6s#WqItXiUu5a{I)d&`$_ukh|P}sd%U{QLNOtnUrtCBEVWO zer)pd3%&P7m@E}`cQ1ypK>q09b`P3$=%GndF&M_;vHo&6hnpAz5s6n-r^;9LQ5JAv z?|6vS?^oCG!-Q-H%oOwQe5D zL?0L4n5c=J&jb|gINk&@dipR!opfX9M8+=HqM46oNz)OE`1&Hj-*^n5!egObubp`s z?0SCMOMr8X6Gey8@jFzvu;7Vwr!)+M8ze|1orLQ8GBolgYt~w@KbFx`pwxng|GN5z z{Gr@K+fx~Ttl?!Q^_UBH&)Qpoa~TccS6U6zu;q|$B;Z6N9|j%%qiztAjSX3q_4KkG zACYst+g_yd;uRiWSx_PPKxLrDifF2G#jG?<{mG%eB;2oTZhpzAQR(dYIT|#e%0Rv9 zwK(TrGw{34BiHNk15&yd+fgUZ2L;fF;)n z_-5IaQeJ-Q>HJNX!C4^yA`?fAe79V>f7yOWigmwAt3AF<_U8;yuPvAGILnI2fx7QZ z9g)>-`L}O-atP|S;gsJK+6z)%yQUu0vPR87{gA_T5sYIVR0&`3VnF#1~|L z@F$0x-(BB?3r>sQms}3q;PiI{H3Tgnl#W%AxBfo!6M~Xs>e?JsU2`RNcRow}Wg8Ld z6#v3IHiPPHmK}Q}q)w4XMMb4M8;QW9>gUg&wZteX#`hsnHY|%xwejAuG|EnfADq$u z7Iq!!8q;!@Y1E;xGnUXZG7cdL@WNX;M~C>*g0s~YLng?#{@-cZGU0A*cCcNdZ>#ab zpiyE7G~5NEZ$u^vkEd_-epNe4-8PeCKRj|eL_`&@Bmzw`nL^g}+o_#Gfs@}zh@a~V zU#{ruZl%T-1`dM$?>^7Oc5kIcD6>u;&#a$$IBvLTYz&O!fZi(*v#YB3ua$A;JVnGG z&1S4`Mvk+)^_Rv4OL$urZYhO}+CL%4+dd%O)p9jBpYQt~9%2dTH50=p;v0AlGPwgy zuEA}!xgIaqC?2^}?WzPFyY4X^qsuOHC_p4f6x{%kYvYtEOH~Eogp5s%@bT&ko^DVr zk?U+Y@PU=d=gdo~|z00a@KEeE-YVC@a(fXE^=s|H-$KAdC^at_lTW=ed;cBy4 zMLuBf#vl=hA{Rc98_wWI_0^w0Cszmo9fA8guBw!h{9ukrS`C!c-^r=f-u||M^}n^+ zkLmdnct*VU-4>CBXtv%>V)csX!PC*t{STB8lHu+7T#zrb+x-RY>0idG*JP31@~PFK zrz2Gr{Luzov0P8*x?n3@Nbk86dej-QugKiLgC@t>K9HmNP9ntnkwemP69YsFTen%a zYW&fTYVsuQSTRS1emuEl#GKJcWmbRxl`!M}veRvC(Ah+qza}EX$QglCFw>?|jvT4l z4?QzU11$P&^hU~eus7Q55yvX(mE;SA{^%d6e;0{YXw{kZC~CKBD)(;p7>|M=V(7HC z2L8M;Bca!_z&n>EWQ)Q;_CT7Rq0Q>{3k~jG5AGgNt7PAF5O5^}=-y$Dxpl3bd9WEz z!_>QF`!mVKNuUOfF_-_bdZBHc6dLh0^z0%Wrt5_b(8c|(#_eK#DoaUO#M^hzj`=ks z3ywoo*v~!%i`^h0c!Q0CQjR05!V z>}AOGS#zoqvK0IkYxeZZv^6jV754UrhQ2TYU5NW*5|O*}%Nq|NXT8tjADlOL2n>JL zV_QH_bZ1swTUSrN9gdCeeDCetofk+)^?FUpM6SqTH4>5t+lM{~J(UGj?YJTJB{^Af zmLUV3_^rW6I@g>&*|8{kasGLQ4He?QSUh&htWmDmks=3`+tx+`#znmTn;nyum|{|J zRX!E+5$amn=*h@wEr2-MmzLxJgZwQ4StpH^Y4n-4$PAajU04bQl8ECeE*y*yToCm2 zgOIxb%WitI%>d)M7s^<_#$wdf9?s`}oWZ0F|0WLNF0=dORL^FQXkmS4sf9Oo{QgzG z`vgnrFLLay4r{R20R+%n_Qmb=@f7~Z2cucNON5JyONo2_n(*W`CgHuc*6BFL+KAvC zXr9}uj*2eDvl!v`aP;7QUh^|5*X*Y}@29PZf!d%d_L7%SJDWx;-7U~Q#;VpZ4vhJjAYD)ba>4VavtIJ}fOrF+pOCpI;|L@AyG_&@mJ9^c6&3zS< z&(?wKTnSSiJC?sV@myj>gN>lXu)26HdGQ)wsY`xV!Fd7ljEEwyrsv z{L`sD@mXEp3v*$m8YAW++K>uPSa04Jd$hv=Nxdq&FS06AVr%*}&s0edL3*rYWM%gk z`tL~aumA|e6QEFHp7d_KoVQlNgO9hE)H7S)M0_Z+_vt|4_Bn8JKUo`jsjq)8YWOsw zUri(U^!bLsmkRN#4eQGJ{I3nowrig;7jy_@eLB_$>FFeie;f#myaED$n@PZ# z43deYYz;jAETuDMDhKx$OR!@rLU7RdcQDHH7ltj^ceWQ>mX=NU`PDX`%yRtxw~r^Y zI;n;VidoJ&LVhv2qHzSDdZN{o3mDiXWQivCq=CCioXJX~Ak)%f(1K-gLbiWF{liFf zPIS`nM~1eP+mBw-a90m^_|Gt*#z%w8?qRk<^Q@t2ZSTqlQ)ME^;L&+FvjOuaB+;uP z_~b^w0sXYWB0WNeDndfw1xG_*;?xsL1}q}RhH6ebYS~c>qRVlXYX=#UtmdP~X@Jig z?MTLHns3e{U2t*JIh&2Kx^q?b5PP(O260KcFBmC?A`@ydwNWBnVfNk+asY`Ticf$K zhXNOEHc88ue9?{|+xJMx{a8)orKvRItcC?HVmKJty43N-wOQMs&iCOqQ;!+~P*j;l z)sMehLv>F^t<=rBmk#6^tU*KwADbIiw)Qxa>;gu97s@%+V%N5`5ET{{YIgeiT)MWC zx;7a9z%}|X9mNcg#p8b`@^{V2-{${=+SUCI;v}2wQ<33z{06kuE0s| zHe+9O z#+M4#25&~Q3 z;ITmipw|B1yQ`CPpx5lo_E$_4E{tsv>OiU&c|wfRP|q1fEw-~+pVR)ni!|IX^Sx23 zE_pp2nWqVd(8b&v!y%40UF0W*BQu@BKYpCCI#=|+L(-kerTdv%Bvhyku!mxfWp%Nr z7XFyD`p8D77g5gbf$nt~|51;9wmZ#6V<`t``8T;m_Y-yN_uuE?{6t?UQoNjog0jCHn-) zHE*znqR*z0qudCR2;%n5q{EkD6?G$@lQ5 ztGoAl=6E^QBQnMCf_uiL>}%Rb5|O!`J`MX@^3#{255p#^^Lbj)n-R!%DWQL3bzR2! zb4u*G&K6?U9**Ax&1}dX9V0j^gyaukO4Mlg{;{rXfoWawCN8qfFD&FL7>%RT5|%i6 zJ4TXhJR}3=pz(!w&N>#pbaj!Hdbqj0*jIV~o}ESRNHvL5P~O8TKvyAAZX)}~Pye)$ zkh@0`5X}nbu4sD5T`#GwbZJQ|N=v)JT?X&W@(t zcU$D>b)#2vIy^ho|2-qbf4y=cC~68J5Qey~YpC2%6ab~wvaW*8fDsMhd+mOWW-GT> z)50mqf3O5?=Z>bQK?XNqw%E3Q<_`J9*x_{i^!=#mk~ax6pN@txh?S}8`@0KBfUf2< z){T8SvRw2TZBK1-e`%+8>LGA_Viv5uz}`{i-a<}(Yrnpn(XrUlW>x25{C!@6OW0NX zJaGX=%;9p;1C*vd z|2*|HO=VQ5@w@QV)|#U~r5sr&az>|GHp4$D+!`26LDV-W>q{#uf3&#lXTD1>7lndS zqY@@3{^U-+q4tFhe;OnPg>0h5rC%9d%~05WoJ?lcW;OnS26Bi`@=AsZ6@Tl!Z~h(} zBF;{67Vfscv#Re&XUJ}OzVH1QZwY=0{*`!P9ms+chC$ks@cVri^4n0_#cE+ztV}@y zQE78$8Cp`MM~c&S{^MRHGyQ0L@&(Isq1vHIzTZUnp#0m_-rH;=gYeG#g5=}0Q zWZCFAfSoZ~7~(&1kespFtF@|7>eEu^n5WGc85x-~-FkS4Qm2NEc9AI?dl&L{f4V~4 z!-Mxjm7X9aZ0#c)XHrtqY`vxGrCQ=aoEa&N6g_`&KH93FQEn2>-I7FRQ7yFVn-m3^ zG7CsaiHM{mJlNOJBu0(=wl;5xqMM6`3NWcW7(ktD80W4^+>dkpZ%HCmKhuYUeeH~Y zu~4L#HGgQ0wm>+Iw)fQ-i2MwGcZB#XI!Iax2at3_&xH9F)iGSGW0H!Y$3iZ;!Ks7} zpB;AZ3kL&T+6h0KuXZ^}o>ReJMxY_)5zkbHM zv#$pGV9A8ZV%t}mDGT{)q(|En2hR{;cIh}HP`+83uaJ2LlEsPssMir`sw=m4JL!~r zs@Gxs9(}Fc3WYz{H?g){WQ&zr2iF$7G?sJbodxC>{<|@<_NH^L{XJMbK z$dUY`MbR@lt@KxAPj>^et4dfPnf4M4%gy_>Oh+=+klLJ&L=~F1_OE8x|p=jvN6ZB2!Dp7SIx3Ln#&`Gbwno!{+s0Gb2Rq%Pyk^Fv zNOeszrmz)scmDZ{{OS`@ie2Z4_x*=9)l?2qR^cms$2k>!`ZyHG9dp${>y{?7^vlIJ% zbe?RGP6XC5?CBym6fyr z05Ns0v^cuBd;)L8+V!*EGceev%Ovo6VIC1|AX%z7wX;Dr5_d9#Tz-~Q>>w6+G@Rku zbG_!(PXB;^b9eVEdFLi@`ao5dP+D5LF~)|Tj<)Iz((-~Uwax^7B!*~TBblFeI;RWE zQq*5$FTqdzz1k^I?lb?i`0U3=37?-6T-VmV`exiC$}G!6liz+^>48pOWN?;XO8h!D?B*Ip@waAVz_KDaLUUhfLV<)~%@TTdtC!Kvv(-DV584 zZlbTcPeeNr=SxlugP;3EXH9cg6ft(hn@xooCpR<^+}XQJd~HhnE){LbfTopHPVt>BN7_a(v=#&-KwK2KZ7R_~d2J zF@99nyMhfpe_Nn_OSUn=vV#TGrDT#Veez1zk*pc}Ij2QGOwt>k7$faRE*FtI)t+*T z=#N2C^cP!7#l5n9jBjWRKPPk;;L``(Wu>>50t$6+oLQ|YB9JA!#XYa~WOQ8sYd?Qt zzIjmB)JP$FI4P`i))g%mYr|WSMt-d$VE_IT=S~-%0=yuV&aGXeY&Rz@;ZE#GCfh0F z8x}PKyL6nvwspn}`w3Lml3LH&g1eD$=fRKS&TJAD%1c&)6bH8lmiFHKpJ-)oX&B9vqpHOlzV8Vp=dg2O%@p5)C zhpp)uO1~=k{E38RG8jS$eI>jbN#Y|(*}AANspDJjGELk$YslBx|LU;xL|LG*uU8I% zK!}wSojhfzJ+!hgZX$C%kW)oQ( z6k0HhxQ;W($j;Gq z+a_oz0ag2wE=`aps7SlMf_}@&0U!e?np5RrmQZ|+?GwuP-qvOlW zZ^?8MAMHu#K_zYzSuc;WtL}4iR%;W7^nDqRf@SBF0?diQqy;qnA$QHo{tL@m*oviD zp4IO#iz3Rr6g2$Z`?Lv1&@?MPm%GRyloH+uT$zZ(%z(EvQNG=~ zlW%3HczS`n{Pbr-v&0_P6gL{&Zup~3DER*lNrL}M-+o7<7MmxMV~2D7VagM!K!m`f zL^N!%!Nv9(PzN*3UBky)`VXXCjDES*l7qZAZQpOsc`*ULOh_@j)CnMuNZ3NUV&_ms zNN=bE+pSz7)BQ66w@y2m+m*`iT?bKp;GA$?Tcce{Hiu z=_5a_(R0C{_A^=>uin%=zokE> z9axMoF7WAJ5x#ne*EX-u>%J+iYmeu(7L z1CaooUm{87zHrjt+nJwl0ysA~pdD>-x_7njREz-wWBGsULEw)llj`TjY<$c}LAzP1 z11J&{q_SstkKedR~lYFflTg-WuOD`O4?` zwqLF&UmfR1Ha2RwPP#sdL+t?15T$sb_&>nOR32MFTW%L{C?myoGKnC?hHqHL+83}I zWYgYjYE5-Sa-!ZhR+PBnP!?#IRmX0J$aOaQmmF5ymgun{0jJh^{gZ>vtJziam+mQ5 zwn1;ed#_IT*HXnA;zQWFfTf;0#*zPR4Dmp#RGd*r-7JOHT^^;&-rMXqvcnDX>AqEI z7DKMde#Ssok||W)oIM^Mji2`}DsX-cW7Q&rd)ZJNP3{~4TFPh3?rPS@UnyqNNv3h; zNo$4LgZB6hSJFKV*-unQW5 zWCs|M%x#P$Dv2r@iiuu=5dWZSfwqt2XUP5*_)xb^hiJ3QEUK7^S53_PYz8u#ee|6w z#OQd6DGAR_<7oelMNcRk&ZXicWJ)^{E?s~J8P;f4EBzWjT9y~tz+huUG8a3N2$u4j zQuG?G_I$w2wA!D+<+xq>=xHWE=O%B@IQG{4$(FRPg?BUdXOcFNNy zHT&PkphvEHlvID7D6=}|F<|?Z*a-;IP(#9QyjVerM9Ryvx6uKj0#3X$L^-GtpeRo_ zK)$(qBoNoiYC`$m)>UED{ms(x8-5$62Pg7h(#1QMi)gRZWG|a?Xr}ovcvivfrA)|- z=(D-hB-y$H~zLy6(vmrD;~T@LNXk}MjZ2eUj5;e zFsJJY0{(kD#K(WhWLX?=;kgMdR~(aa8e{$hMTFYp%V!YP2(=BMDW$fF`bN+P+a7NQ zr&z;b(=9J~Nn;Rr6`XSF`U3@#iyHpAHa8yRzMl%a#a!a#_LhgfCBIJfVhi|GZF_Vzvtkk{lj)r<6 zm7pB3Jb|4F>;;cT!%8#sN&LL%lB5pp%{5XYD*J~U8clVP4P&+XM017nPq0A2fy)Cs zm~pI`2CW4v8-V+RoP|!id2hY?eTPr%?N<<|hnfd77(FCMM3*D9yeQa<6W#o>p&lRc z7n|Qia9&8@syiGYaabf7$S0x$p(Y_qvTmU!G#s1DS4b~@^en5V4MtcJoS#)7tR}Jzo``x^N<&}-DkuoHh`m7s^y5x zjv@1MEA)9t2S)R>gkvP}o z8UnfqZtd}b*V!@if>F4M1ga50YaSRR)l>d6(e?kDYz*cvBk5yb0kv ztJB!y0i&g}xDdaE8yoTedZknv2Jf?M;I)^q5Cgp;@vCztFLmmDqud8u9A2|6?Lv94 zK&OW`bvtGpaUQLWT3;p1cr~WOb+71)zY{5V8OE)shsZb32>jr`c1QA^8`!QZ7j>sG z4-Lj%WDk^`x}S;3zW&JYshCejB|B(G`Y5+Dx1Qpvrf2oMA1>!#C&E)!pRMl%SKAn2 zEh&!VYc|WmO_I|;l}2)cu)Z|sdD;SI-H_q{Wod`a7gr8~O{U%*^n4wD!KLwcllDr& z=`WUI&}Z#0(ERMN*tNhso69luTPxFc0|O(YvW4#{YTV;VjQZp)X+=pbMFiKTc~=n z-;B5BSPeUlwJj86Z%m$HG&HbbL|-yPqDDE3JO<8xjBn>1x>X9jn$+{hBJiS+={}wo zRI%fFA z_cHD^y?fZX+Nw=Q6=IpSu0Y-pofgWk9&@Q#rF3m%idCr<{~HNSJ-<9Hp;SRENC3n# z^s|dkyFw2oibZvcp+a~khL0sV-0tkUS9!dd=1FsMsBCQQRsAb?v9ra;hVe2JGSlvO zo9XM#IEMh*0^N+O73b}~m0s;^s@d-~DoWJ`;3R06B*EJIrJG4>Uwh0PaRTaQyerP6 zBcT%HDEB8{>?4WE@W0)l$?vb?_&Lg^2D8Q!5hID?m7`Vyb#{>D1W@EUrY{cR2hVRQ z*5p=&QRjt%tA>5V6cpE79$oc#@NaIE>lnu#|MyTio21gSJ@YdREczCb8|2ACiaMMJ zGo+BrZ3TRK!AkE>gG^D1dP+ah!!g#Ph%OdgiFA z@%8Gdi)LEy0Otq2nODz7k$vMQgg$c*({~wM)Gm>;KuWF%!|Gq9^^9AI{)aUScL^rb3+OZYuVHn zb$NxLvA5rldutJ%Hzog;ml$iQr6ehQckULgoorl=wP8H{#OM3t7_A|;JQ*7&$Edj~ zf4j8RuXjc&#X^QN{%temrescP1Bw8Y|In<36N0+Ev`TDs+zB>#k%9^aoN|zMYo+H2 z%-YjdQPO5y{@rRvYz>Wk51_Qb$n>x(dJ8<_8ZFoUD*FKU)1>zYXoz zw)#oEXiZ~C7GyIO8`Y^jchi~}Tf~mg!3wZ(N~P&=;<;C(VpGzN5}?*#y1{A8;HjN) ztkgo-`tj<#w}6+2Wv{vW^c5!vF}_Am2&6f;D`)_fn~46#nR9*>(ndM*@NC!(ai3(# zDOkbka8j};_07MP^|WX5k5lL|= zHRJ=;P>JlA+n@U|7;rRcIu$r{#PZR1Q4nMeF70*@2#Elti%A}U;^NcVnfx$_#QZA{ zrqts;ZRxraD22oE?1*n`(VdT^nwVR|Cs4KPylepC{Z2g4WDH^CVq%`(z)x8f`wUxDW8jBiA3RiGQ) zQ=N|~(LGkJ-(kJk#y9$o+kZvxWl&*ma_P20U9FzL)wf!s?CfCH#~Oc=&3MR%(&fOAI%UMgZgXYbsD zJ=Jcw0>8ga*2y$-q2)-nI@+;>Tp`*^yNf$KBo(60xl4F^Y4-!YwuXc$((n_Vl5&JJ zy1d(*d0id$c6fLSVue^o$UQUE#)nut^rkVthBow=^orCTQCrw(UwAPI)9&uj5gT72 z@Z~sl7mJ5M(kU_=V7neJyIIUM3-IF|Aws;esilf_h6UhPlsr=8M1Qt7pRoX)`!-s$ zD!QkxM2Fp>pKtP#aSBL$b3s7x)_hmHfL!t0W-;*svJqXQ=|Z-B_hk0~Km*w7G@!M( z8_mC=wt%MDp(7%pS?!Ym`HWyBz-fc^Nvw)cB`Vk5lGeUDg9Q#cr(RnZ?u*qF!M+4Ini#8ndZsx! zKjYX=2l8nH%VAfUcNp9Myx+N%33^&RiOrv7w+J+qZh{q^9aVtU9x7$t9j_`G>|By}Z2ehuHX`cR?FKh9Pt;r{j`Y=EgquW_g2zm*@s2f{PM zbm?MA9||F8m=Y?RD6Hu%(qqa>V z9rPVHk$rr5%Rfx)0u9la2tEJno86fR_Nu?#5ipYG(qXZe-byFB4R9Y*&HD=Oe4vAm zAE!+0;9{wKb=$bI3lPo4MJ3?G?wd?A2Kd01Di_Lypmd*uClL6MLd2AyN!U-7g3qNm zu!|Cwk(5Z1NKSba;&XP286Uf=ICPvJ59d{wfzS^QxsRu3OU5hM5*u=Vo(IAYqM9&u zBo~6?eL$W{P}Y+Ai8_MoD9!z*tL<-#;{5+WbVB%EM%Hg1&RQHyV-O*KBlC#{ttQRN zOhDF@MNkR02#Yb4|JNsmcrq*GB(IEkzFbrwm-knmMEnVn=bZ(bX9SkF^7mdwR_W7O z{$ly333y$he0Oqz>Dguwrnwcp7=LT*+w9k;Ur!vy+0rjM_5as@_b=y{A&ROf literal 0 HcmV?d00001 diff --git a/third_party/pybind11/docs/pybind11_vs_boost_python1.png b/third_party/pybind11/docs/pybind11_vs_boost_python1.png new file mode 100644 index 0000000000000000000000000000000000000000..833231f240809884fb6eb4079db528b9b3c0a9ac GIT binary patch literal 44653 zcmcG$2UJsC+by~S0ty0#-ob!0=^(vo5G*tyf`Ficf<(IX7WG9sm=~2^M5TnLV(3kf zqLhFLNUs_YA@oSUEBJlqd;fFpx%d9}j=LSh0TGhD*LupF^O?&iQ)2^0dLDWRf*3Ct zBCkLYH35RC7?09|SD;a&cJMdttxE<-=z#JkyDl#gf`p(8NIeVx^j~8^!M3+Ebe0L^ zluJApUr4)3+^xi8Mvqunu(97i?d46A)QB_va{ou?doHD#>gxSkJ`bPb!V!I?Pw5v% z+Vw4+*q_BrvXAM*3&`}ZM~5FjMT=o`@BXbuAd}lVpWc-*`XZ{9*iGCETyaq#su8z3 z9gW-lGKrdWLWuvym0BV)2O%v&Q&UrML4kqsjNxY`5dPa2N(3|6pE2q+eA!gWb95G=j()kE$JV(bGl z{kk3q5Iob{pw9OL`{!(IMjp{+K8cJJSDnhHK4G@Z5`}b-NwQ(gu3qkeFs=|2%^RpO z4XXX*nI86QaWQ0~xMF;m)%5FylZc1{7e-9LBV}nS2<^JAyW??PWprq0>l$?MwBvg` zwW)e)m@0+`r8TX)lj1yh-ER!Ox3{NK_%lGfR^ZeRSUyY+{WFoq05v%MtZD1mtj>)s z2ahPx_((pc8}gVu(YYsQpgYlq{YUr{!0pLNWkyNbBCx-caiK8CVgm-bSy~Pf6jNfE zXAOodHdt}h^o=!zg@p}FlhKf{i7I+A3puL{g(Vkhm){#w5Mzl74*sjFf!ZT2a`(== z?FsuT+ocV}sy3AIs3NM}1k%jIg{5pee#kE@jKTe!fMIZUNyd3;kGhfIGJn*fXhsv$ zHdAWZPvETIYt7M*De<|kVmX|P$8T^$gQr-cI8hsY(EdrRVXelqi(_ivABbI0&)A1y z1dsGL5CgcOlx*;!nZywJx#Q-p-RWu(FP0CwJye6;8$BZy(C9YzNPbRJiL5S!>uJGgmd;cdW`{ zh1cYvc!k!#it)1jU%zVps4mI)E0hW5@ec2sE1wG@POP=s-N9kzCfGc&t$M+dl9K&} zE|rPhim2`i*|%1|4B^+PvV(ea^wVe?2p}FWv?dE%_>>U?WaE8n9Tlo{QAzo@MG|S^ z>-hM%Pd2w@k(KAeNIrI^2*1tsbxq|jua6B3Kar<}CU-(f`4dcc0L=vvtXfv78z_=%><*6pqQ`ExIN9HgbChlIRNz~OO^86Lw?`HvqzPW4b7 zh3Q&sG|%7P&h6cdYMUXkV1!!Drk`be3k(+x?Pxc2zBZ&v+-gJd{#3^HI2 zOtGU{?gw=z>@-JI{LCoRgEZ4RzK?T7A?u59gHW=WvjQZ<8igzoT%KY=7H5@I#UBVu0g;qTwA9v{7!)?Ebw6*zNRnLo&;443eWC3+3 z(@`Oy1g}gp`TkZGVl|tzLvlx>dA+(^H3h;HF|yI^X)B+1K5}9Oc^tIAeEIV3u06qt zizT7W0kK;8EeKmXhFImFAnVu#hk<7%M4o?{5l-~I0Vhv{x7|DtyrKMTdQK$`l)OFfye`zlj3_)H@^-=cpGc#o__MVwe-wk=hKr$@xWFu2=&R!5 zMeLNF2`Kv6$-QYOdOwJ>(JyX2!Y|Y9<$sx94*|LF;4$?}wR@x(&kU(c*sK*V~?**#Z zAU>K&JCrM`-<|54b^BIIcXu}->DSs3jLxDOracR~_hx{@;Ic4u#|lmUslySIaVvI< zA48`8#yHskd!PUF9K;dRZr$d2<@HYT?wdJ2Xsu~#`8tk=Zux!Ws9F07*z&%uj33?k z18BnpQs%4|fZo6wAJ^B{heG1B8D^@YkPshJ#FK+60mjLs@TRQ;Xf$q@jscI`9`o1S zhoKh<5Fg6_V2^L>>9~>379-C#F zNO#euu(2aqjYu5hzK^(NF_xVs8^Jd$rX8uOw z^pl~G7~42eho*;lasvvT1l<*Nh9=t*)sV2e;Er^>W@17hUSyuDcJtr-H8dd+Y-K?` z$r-*op|^jq7zK)I#I3hhuJfTA8yjUWd*@{7NilpF_mg2I+RQi3tQOWYzraPnk{x2X z@2=Fk%ue_z8U#o~(2D=AmqVwl#YQny9^JkOX+k5&*;@{sk0`P9mM;eM0G!9LvRSx7 z>sOp4v>uqLG7hiN`nj;+MEzTE_P~GN&fT5V-y%_3vXJVO8So&%Ke#7Q;xb|BMI9dR9`RfeKd zw>4x*9Vr~Pb9zIQ)Yp+Dnk!w-oGBpj$`7*{Z>e+-5qa6j2W)zxUB<8RxN!<@lw5BO__`hpZ&H00JK1lc37 zm8Ph$qm!oyYvXFUoDw8QNY)xXVHzAqU&g*DHh;69*0bt)=h6d#{!%-z&JA38$$OO z!il>w@G8#60%)JV(Wz|c7h}sM4!*XkV_WbsX6Sd`^aHS0DGAZ-LC|`1J3FObPM2Fr z`PRz+u!F>++KZuayHSp~^E!`q)hZYpM`HR8_}ii&XWA3IZEHiar>_>NUPab32}vU6 zK_)H4^mShH=5nY9&HBEVY2T-)$Vl3mc15#r$;Fn_M_+ zd+Tp((O70Gf2KxHEiJ7i=86et>+DV+{$T&qo^-?|yAb~|h>uGi_3{Y#&P0Uw-; z=Vy0&5tgd*_3eSC`;$Z{+apeiUQH)9f70TNomBdR-Fr;4PNKR`0E1$n@@3eG`jk;yP%KBKuTxMpoGH;V8~Z**Q)~v zYqal%e)+UWC4S=a)>^Gl*?EbxvkVL=Ck9XhLKW=L53dr!E8F=N>Mv1%V#<|U4;96^YQ zJGa9KY?b9B!F5gdq{!Vj%ZuU7xB26U0a=@x?k|V|pQg$SUFH`8=JwakRJ&=yWy8LV zj@G(XDh~`#F9hbys9vIVmmLkf*WL_e%G}er2NpUU$8;^OdX~67dvws2Q%6L+j<|U$ zJfuNuG{-j_`)N98?%{_Kx=W&oZ7|hiP^|pIV|1DC;;=Mg^<`7V&W0U#>*g2csEhX@ z-J9zBcA$oA20P!1O`(JM`T3oM4<0<*B$JubbTW(&V2#ZH!R?1bZ@h`!6(@Dhy&~nm zjIRz_)(&S56AkJ2gIB%!_8P3(qYBRGc|nfh`0X_j1R_;3z1+y+1#-5kDQRtU$m9Mc zNEdaWdW9OjD9CV{jWD;kSPV0*=6dSu=f|wFf&Xo=VOZ#sP^qAbnMip5!aoFulMyKB zvQmv_g=5Q#@p&=rg-^0_cU@*VzfnE0PuYU1#W|XV>q}xdqyt}-m6Zu@g@1g0qbL6b z&W-=(;PvoD#q-~^PXVy7V4P&_Q*_0+irP@pFe+|g^Z~9y3?hy7* z%`8}WS!BC6jvk((btSEr?W)PXB}%J$nTJD57%_3R|1_EWO&=F%HT6wcn{&{oct%yL zos-ZU*O*XAvhd&fp5zzz-U!*c?kzoPSv40c|I6#QGh-3HWw6}IzJmR9fFL7zcqsvH zpKvxzIFs(tFuQ$X$aoV#vR+dG0$0A3{>}^weHCJ{k@D8@n>}a~>EV`l>guYOC+cJW zx!0gZ5T4k7;BHNpH;Uuq;;Ph4>TvbpBd$0qT&sQ7Z48~j!t=yI@6e(#6=C7lMENyE zR2AVF&JSNzKm~l=ImVp##>HQ8wIYA}6o!|+;u~&7v-B!b`|3S_Z8vv(F|EnBZYoVL z{H!jKaH|-I51d#i@EyLJXY`TaYx1E0M*?lpo4jFse+MjN7rP^(x ze$TPiD=iWwtEWm z6_&mU`8GYw1vWWRp>-M!gW41u7hG5`cU z8NYccT-N>+BCAb%X=g#Tn~s6}EgZ)|euUevT>g#gF3C@P2;b(*Fm>oJZC93L43HM7!wUDoV zSKIaU^q4B1E&CoGCg_Sr2f6&EOovMj`r4WJ`nLcpmK-N{MG6XKVTw3V{#`%VeE06% z0G4nn3sfn8iIGBzt%dDz6XX(iiIFLIW&zqa)Rj;Qf*uoiH;w)D)lMHir!$x|`o+*%=iVHf=n?NKTV9L| zga_?*0erwE0~>%$c3CkUPa0giyAt=(=`XAD)#FX2sM`-72*#Zsq)uj>WCnGO=N-$s zGp?}EFI$evskqL6*|*J82Iwz5bwulH6J+vb%QLO9z8PZi>L9RBhL!&0p7Qu@bK0^b z-Mm^0;IT)z(EQ~^%hol`)^o_{ssuyP#2C@SEVClm6Z8H-A79_l7N4;%*UbMm6w#)e zygVxl4I!fsxQxv>V8M3o^4Yv)0 zS2bA&h0mx0+K|yZ1sR{a>GCFWR~A$KMgRFgsr|uOO@W5<$bGs-o%1hyz4_a!7`7G) z2;g}UVO4p6kSEZQbuQRl?N>p*>@@)Jv;_A9IXl)~I=Pb*`ISUC`aAUuI*>K$qc!R} z&E(4{nO=%>hhrxST%<9=`i=zr;Ns$94S!nzed7vZmAcI{lM@>TczVV0 z!K8)iDi96N@S9@L`1H=cL;TFHF4C8cKIYbk`-Q}S;%0sagcVxlq|P?qy8-R*s@+WR z087bdJf7^!QO}L@4klHNSyu&FYzK#i0$$9hl5sfc+NBm|VYhWnl8S>`E-}DPQ$WWA zIi81`@Z=*Bp-{RTOsg+T4IqC#WQk-QvuD)_Y#5z~%xcAt?I`dDu-^=rmqmDz-oEx{ zn~;exor?qP`8eD*d4GT3FaM`aoIF`0evKa*L2VQxR%sz#tPYWUtJswTi-t*oTbx$y zu7mCY_M`!In)ka$w4i{>K{2P)1gq>`S4uPvNmr5NcZw(9#Ou1E@ zM2lw+LL^!FVwP}c6OxgKa2;@C7G%kej z6Vkago{baK1GjP+#ZOp!ev^gc`sr0ol0I~BB%5xF+=Ruczp6~V2WUPDC9Aiu?05;X zwFF8D&z4PAe^4ede&$K4ah?t|c@8QUK1khH#Lz;Du+clQ0bLfMhH?Vo8^>hWu_mx~ zDxeJ*z-;4ocRFH_h*Eydi~|aJSy))8fx>%(Arjp(0payLa`eb#V)F)2DPt-Y1KGBk zYMB~QP#~;!kZY}YW!B{Nm10PS1ikO+=IY}9R~JQCE}&dt%Qk?Efyn#F zwU%ltV@Wgl7Vu5td5u=9>)u^w6bo^<=WOSbDrBwS&tXHxHuKwk#+J(n+BPw}T8}Fd zZVOI6%eo}a7R_}0`2C{mHJisS-|E%0a&U0yFS%Y5&w))6TlEYlb}aDNm1}0(dD_a!Vj;whv451uU>Hg^m{+NV%EKiv|~~~`sdaEzyI!i z^>;S)(=>n0dNZUKUl8m+8tr1qvF!5>kkcY!}(HOU@^HXLILG^YNowPhhwq zT4H?sP~^ElkGK^Fq9 zP|zu#xz~#IjKb|}VRWL~39V`KH+-{6oTxfsHu@FnV~EsHzP11$n$>zsZeJ8lbQdSj z2(-VY3{HT0@@dIiY7wN96VT0H&ZuU6%eqXb*yhP}K{PRs4y+iZy#rlEF}Hf+(H`H} zM2Of7-*vo8e-r3--~Bc18gx>a?f|`^hys{;)HY8=#!@tcIn{3YM9*JQ>IR9QW*>sm zK59YaB7{10amBP4Ul3ujHx^+b4S~-pqYi0MjqmHHKp3-tNaxizk=fBb}g$P#)B@Bni( zI4Y#P%lyKPY^7n~(9G((la&(dVDdG{cd98|wtoG~rIB3qHvdhHp4g8Qo=A%ixn9G{ zM#axgTgv$IIob87MLPQ@o-xXd6s0Bfe)@2C1ldOiKp+@qfb0B+=@iMc=H}*j(vBx2 z_~YSCR%{{6RGu+G7A{tz7HXW#WG(a zEqbjq&GoIy?ijgWzdq&yEo&wey0Sh?0SVk4$E#A3spc(8`e1DF7;FTPgIJ+|ughh2 z;lxktv>6W~A6r_bWD&*9Qa(E>X#2;rn1#>avnVqiaJ{^-a{13!O7zAfxzRlo*?nXr zh#mSmFfe{K8F3ML`_|U#_cb6f=_6LXKzk9M(?q^kY4ZdzN&q~90ECV#T0s59k4j}0 zApUB;=@5I3?>-ZP$4;CLr_d^Owf|nvwMb`iRL1StYxj!3gLSZYOL?d{aAj!)`OBF`}%Kd#9ig;W@@9xriuvNo0#k)T{t!qM^!GNwL3wOk2J zR7Ct$XQQ)Sl8F&!={<6D$`P#YME@L~ln${EI%yQerhbixS1VY(AK z@z=ZSH_LQ_*9ITZiAuApfzK=gk<@Pts{p%EamD<1r zn6k2bZk`i$?2UB}6Xyg=)m=Ui#H2w*Jw^#UQ_8$T#eMuO)I%A1^?;h-4jQu}0QKnL z2|_?-#TiQ6Re*8TH89Xy3z;BoXu1dW1blvQCij!o&K)Qs;mg;GCn&q=Uk?h}^^u7Y z!UPMr3mW~ho+P^#5|*-19XtUN$3s<Ow9BUWk!&#FfE&KLRlo^;d3g?$6B3%mkROkx^G%$-;29 zBE0uBko}A0MRRdO_titp4>t)k0V#OZWt2)@-~7mx3oe{TCWg1HnVy6PpcGPm(E^G|(jv@+Y*7N^D3nblMt)NLolVTmW zy_JrvB`OS%i7%@1Wzsx{#6 z;)!01TYu`Q64R~O`4!Ub%+zHeq|$4U6_RHG#6yAk1qw2?u?ga}91)e2J)9iShXah7 z1cY~ffVXn$)Z)uNg4`Bo3lx2JaZhPZQ*X^^DXEp&k6JZ2wkH4B7WwiWQABDmUqEj3 z38siR`8#jr?|A+zm@QDMItj-pt>rbYELJ|I7|-yi`wCOM{rX>hk!SlE2I4;G6H#%GHeJ&QVa3lUsg|yHkWe;Jp9b%ky4a zj;!v6*vpEqM#B>aA3m8Nk%@7Aa+$^K4*Uf%%x*>*Z(1LJugg(o z>^Z?^V)cx~PrA2%u7^9ydHT(tC|8HtLr zQ&|DI>_!_UE7po4lJ9wfLOub$@QHrIwIAztrl1&jZH2kQc%90KY>T4?6MPZn(!8oPM1adm?ygro0GM*^}9*6ix%a8gf}oY zmV+1JG*Nx!|G*8DxB~T(jnY$IPyoLBc&!7BqBVWWUOUk{PJw3@!2R*NK5I?W9etRH zl;;KV^pBnT2|(UA!Oy{I9{e|JAO%su_1I6Qb>VP#P-l4Wb0BymdE$Q16P^4hk0y>< zH198xzvBeHiG0{}cfVftnw*Tg(>JeF8Ui}k|5R+wA=!=q&isdT z#66@uEEst9f!TKj52Q($$yYQ>DF8$1(Mr#mpDBt?E{EF#{2Myd-;Oj=5T%(ZKq4(b z+pE)a0{x9$<~3z!autB7h628({?*PXdjae>f41d30D2a19$wzUz@VT~Dh#L~Bb8um z8E~yWcx%^G{603aHr+UnbX1)gzS!lNerjOY8^9+;!0PiTjEbI$60uVr-?$t&=s*NN z=A;kDfn5F9dS662aXWC>psQ|h!BJ8i;F;9b)wi7pnHjK6DFD`Pf8;7Vhf-`!-Urdu zYf4Q`ZDN4H#^QbdwJ8+TdGlFM++o88eUm}cAnNngpr9a5Ov#@O0ltraFWG7$=SFN~KJwhT<|5$H$&LJF{Q3$r9VI`WUl!%GLYrLazo(w@;}i$d z0;{?T&{s{32GtD-%>snfbB5dr=5psFh z_TM^m8F7)$l7H$*PDu5S$2C`v`iAJSuLRIgE_=9ICM*{yqy1#YB3 z*#XM9V(mwl1_uO^H}g1UV~fE||2*hCaikqJ!df{60o%R(^|;3E$gKH}v)2XVCT8h_ zik5SCyOlBap-RnOItviwMgn+QSfx zJMRr5=^Av1Xe_NBFx)7r@Yf`#@{;N&uTIuqhy{X4@?A5{Qfs`+O_?MOmc|(O(eBsyAJH&*N=*sEB1`>yX^sMh3CaQ|gxYidwd#@~|`%9JAU=;bv4$SH)5(o|1d zhAoZ1e6ltnml<-zpP8a1=($+45$Z_|<;&k)Gl^qwO3Q(63g5CH^$W~QlF|-cy(%m@g<%edz${B zL^@=5z{Y(M=D~nDcPY>NFi1=}QhCY7(GM;}o<&-4p z#bE0RuV3fyl8cv4F`IY^A#xg@hODG_e7{qGqnqp)y0__CVBu0n3`nt%+_(wENC>`l z>-zQU@84WHqC4TyrqIe3wiO|&qxLKjc+J-DlnwO{-Sa(TkP-FS1jMkDa@ut*Ik_hk zmRmRd+{Au2D6#}PU-x|Lh3N)Hksa`XhgUZH%C!h1OgFxJj9e-BN(K_M7G|(BLxb!C zg)-jY#B71CetmEZ{eoeFoFLb#i`*|ykP*ghcLM<;!#FR@wE84Rj5IX{^xMUz;sgka zp8@UtI&h^?X8X^lXMiSsd4fz(YP|w;iRtM!Szr^w%y zGC+6~@+RTY+l2V|c!oQKOs&N%x}6(>bhia<8Y1e$Iqk)6Qvmg>TY# zTEX|3bl4R61H#~a z+qC03VII|yLMfNEZK^+52hn0O>Pe)HOU5X4tb7}z9iuJs2j~ki?J=(t2+8sekMX{5 zaoReS-VU9&pc{g}z-=;be$f6#w5d$f1Q2dAot#1yJVR}BKO|TiX6RNyr+*wFSLGPd~4N7hdFiW`L8q5 zqvSn%UWa|YD5Ux&K@y1+*2%T@PX0%@UP6OoY!#rr4kyry8UMKP8-m}zw5c&v2<(;X zo9xOWjiV=@T?n~36Vcon7C|ErtR6D$6d&Whe@{&(L1Av@)AQ%g@2#u=HpJx6=^iI< z$*9c%f0nm0_FEf@Lf)#vm9SzpK>P$)FY3hx9tCWm!0U~FW1>ggEB2k_KM=gKP?TEBqQKiOwZqUK+SB577 zzAdhL+g>v$bI`ST&j6B*X%7Ss2FA&j1H)qav%&DYBtU^~y$$j9UNeSQabSQArrk50 zj<0R&W#ld=rnsKeMjfQUmJDJ)6xEgQ^7v&p@_XCAP)5*0AjbqS=h<<>vqSl6I-lCk zQ71kFa*y-vur5XDJs!VzuOElX+o^B3f|`J`c^df)lO@iZv+RTsva$MjZF59&7ZW)Y{0%IUx@Et`EP7E?pUai2!8u;@2Ocy7y}bV=}R| zCLvl|Bk(jLXa4SRtR^e}(LtZ)jEoE-gdqknLp>N_xLFiMPXM#P%kZI$i?0QkKxc=w zsU^4$5BoMLo{-{M(5BiAR#1ckfKEY||6vMlLlZf1`CtAi#fY06p~sfShR|tF#4LxI z+!8_L=>CggO~tg+!iOfSWhnLWvIxsO9Lw06+;9X?3cHnuVc&S52EKFV4E9&kYj5>+ zBxXbbra{5}CxL`VU8#5ou0a||0rl=#Mj0zFZMl-5cM9@l#c7Y;qh0&7Ezu4cU4BM) zRS`K7t$)Op^Y?$@imySO?kmQ%Y&nCv%REpS+c!jGh}ol3f&S&+40=QnMC!disMgsc z9D6%nhSjVE@YnxujDz8^nSOq8aol!&LnqK#N)}c_Of2pIc%wN%PAd5M{g6`uSKQxC zYTNOD_|gAEaRne}dXk?;x19fBytp3Vp?3{-04ak2Rdy(kOu`0BLQ?uVrv|)B_UnS{807;fO3z! zQ4|XO1Cs%kKQEd%&!|of0I!Dx4Z$o&;n^q0V1S@<=-Yta{O9_=R&iVV%cDMbtbXqx z0!K*RrbxggQht$ABawW4k@j%U_)(%CQKq zL3uhhHVT%eFZ|2x5Wy4HYOf#iV1N#5p!+lchl(5iON9MDAzZeH-jGacD3hoK=~Bld zk*5wvT+LI8`i_2JXH^dcLNL&3v<~|FkTc4@70QYJNZ}e|V`FgW5=_eHy5-?!DYk+$ z76tgt(Zi>zCk+Z69Q2k^N*x>9q2xL@w@mELsDT0Z;CBj*j6x!`28J0C?@oicgOY_z zQji2soEx+p{69A8EZ8VI52wSS05I7fqFkGW!O{uZ8#ds@$cG>QH~S?ZDS{{k6PhvT zM)4j%T-16IIn=;(`TtH2&8_*TWF{BmoO)wL^JytA4YbH}dUP+M%x!FV7w6}%(LyB) z<8##|jOwiLIs_jRfg+OP?!ZRb4y6)tHfu1E2jR@!xTr@=Svu6oLKjt;4n$9;ic+Ga z{Z1KA6!P66&jbSUXk();hb~1X7(a0L6XbojElSOIN7}AaFKo+*JSIzLNTOiqjO0*R45DB%hg{IjfruAu&fk+WR(ZRfHpc z&uyF7?w;*Ydt}Nb5#spuF%n59Z|9%~Qh=TGla~}&$iBvFW~PzUE4z`G2heJSD(sapxaOXcs!`u1l2NnflF2mc~IbvC9F`|ELAtcvl3@ zkS_o*hMegBH`_a95T8~_hJ|rPx)Ks;(M{pbH~;TsOv#u<{K@u8zrxCftp7UcDX6sH zx2RG`x$NG<4aQO7mn8h-zdS|z$&##no5y5t{TkFfr!SE8(eSoJ;-}vr-;nI_hgws9 z&avgamBpKFLz$70OtgoMAU|h|XPXK$=5TNP!B4|L1)w3B1x!|h=Y5BEM_VvM`;%wE1NIT=aK0hFxNp`p{g(t|?tSqscj#3FJd0iU2`}He6Z2h{H zIY-H5)&E)91ai|PMQip@y$AGccH*$L)Lh z`fQqCDhXMCo2^KD`^JsQc|(!E-wpto;oq`@co9prJf#|H64rblfFO0AsW6EV*!DW; z>bc$>+f$;IVDPpkki+8?t;g2$a#o#yd-v8jsbjg5H#awBpz9z-5cDjE*u<uy0Ea58%aiwJ_+`0c#zy#m`rXVrRf%ooA;gLz2mA zw@SdO`M?yA1cP`yL=cj_Jw0-#`IxdK5H)~fHtP{ze9n;^OqdB{xXHSj2x)6ZVLu!H zud*j))t8o*j$&Rz&#OyL9}3Uh{~0UgzniOoQ?0uK7$!tCxsv|w`%Wn1>VcpZrTQWD zQl7VXQ*@!XPKt3}#Hcz#Ai-V&kwxX< z<>Vv=CfYq*Yb!uHq03cOfA-*iRaIegAB&c@=E}JyFir8FKAV^PQ)Ins9ow!R&w6e@ z0XG=g9*EkDjT~jpHbx2nXGb2BOT!gpJ< zvS8hTciVYhnXpz*E5tBKiXJ=@(L9BQ@lj27v;b>6g|%61_(FLUTcor(`FK9x*Z%(S zt0lHo{@{q%pM0VmDYB~a`hKg;GaifvP?-+QLAwi7qdL#a>E8?R2mN|+A>P85(o5O9 zdtV;*z^C)3n(n6kh1dfNf7O7-unZ>q>TJ#=3c(g@q%JsJLYozH}U+uH6Qg`N)x{TSHe+@0p+LJUfsQRctDZXgBimL3qAvU z;n|LBFCaSsH$Axt@&N~ZxDcY>ob4Gvg}Em^NrV?v?icitNZ~Z!7VkrcU>$E`3RHj9 z+jc>p{nf?a&)Y~pqw9KsZK{tRrnYPq$ zus^Nj2@d?t1W#nCIkd*QQd~k47X|ErF&$**6c`Ll&kWjncXfgjA$(57iw^&k6mAHz zk40c2bHneVG=a^{1-%#o#ZxWcC9G*{TrQJ=yn%h+>Dm56Dj>P2v~f}Ynn_hhWxyuu zUYO3k0_Tx*UXK*vEvdc*toIrm&|$P1*g__B?2+*!bwPf#jjexQH)hAK>Cc{ofKQ$sd@k14YI1) zsWfFVv_eYoBm8DWyM1Zx=e64B@KiUdHzLLcmbaBWRuC*)kGc|ssaek(VEH-S(hYTBZmZKo+ zgaNQ{YyfLk$(8Obn!$} z{IIHG-Ctg2QJ-Iao8G|C=NoSDWqV0KwWC5j;o$iqT1F1sw_;VO5_1&|`WuYSEbSCi z>NbleL{dZ=>ISx@xvhFhenIoEla@I3d-)sL96BTDE~dkpFu?5ju&h$UFwJfz*-fZ+is}*K>|}@5>rNr=i(;ha2tsxf1c%gxW`|9MAG+)WU7iD@FjPP`~N3 zc?ombGd`Sr+?A#xm})3u4T9qm%~3E;1=khh^_+iu0g$2?@IhpxTi~YmBju-_?%;&+ zZBTMKVHQ`fj^lg?h?d(Q9@5Z>utb%`$(P<%NYR*yH$YYc9Pi7fp9fwpF0i`N};CnbWyedu?F&`3IYrcIUDIV_>Ja%BDXxS*(w26+1;x zIC*dA-RqEv5VGq-mE4UOL->j&i5=~lNDNr?Y(pUGeD2@BCnX_qH#*0;?LWUXi~Fl2 zL4yfCZ=;?O%3o)oAAJ=ZomReKGYXXXj|Fq&0FFNk5;gL~AXBz#_V2sEI_*!B4Nh#y zyAHn(7#N0+9gD~IcX6gmG$l#pcW^{Eqy=soh3+MPOC+12_HzP!B5 zC?Fu9j^lC}a|8lY9bsGNag zm%tE}IW}ib9PJAHIK3 z&$?TD9s9}A1-f|gqPBDK2BsfaYT!VmU@gK6($-rnN9y}FKbN*?y4#mqOnvmBE;yZ~ zpZn_7t25C#KCQ`vGnDx5xKk#Z^!#}VwOy>f|pS=c?Vd*(7$t&-HLl4jWjn9t{+!~L^FgV+H1X!i0faLB+ z?;*NO{`~p#j>gC}G@0i8__aUl-ufDrNCc)oksB|?19ci-T}YIn`i#jsqIcrKX`!33 zfNR&hnCy){R5>C)-e|l#0u=9{59Ga?Soy5d!a|KP>mVwO{10Vlg1nF;Ud{7uVyzbS z@9s`F-oy3yA=-*X?2kS>2SV?8y z=qFLUE0b8w^|tPqS;VB|bkehD{3jmYq=cIGl0V3JIcK~pVa=r&?`MOapm|Rn128cO z94Z%s(OIDzo?d)?l|%I^cI@i4Yu9)lPu0pDC(`K2%@OJ%V@n(r)U=K_gYaXRiNBqb zELf!Gzl2AJI_G?(mEv~j!ndZL%9JPTpp63^$MHHEic4It{XvQiRgvd{C>taq^Jr;p zcZ?KD)}I{RS|ggcfHI>`-t#;V1_zf@POl@bya&U>dlxQ5g&ONeTY&QzqUtr9JCeb|A1jlvR7?FiaLC%(jt>t9vg_*WxA+V{)PGe8`lCf)rlmu%>nBHriCB%ymChSQx2=Q;_eFB1 zGK6M~!Mhx5O$L5EliLd1>{wRpvAd1ZL7+I8ycwu(whnR-j8cSBF5l7e$dmsuLlb2R z?)H5A_fI!7d#e>ktMEb;^)dD&wHxYoaRx0g{*~(u<9Qu6c|J8F&wu&*)TLqI%5Xbk znAgYS!y%zSX>0nib!GQP$`|32$Atcq;Ve;NWkW?> zMxXY%*E5NDkEy0+a2PWJb0BRRixAEMNiMy_17S(T$ww*t%42NTHDNm+4 zVdRd>z8%m$8r;O?9j2TXBH+y2?D0tcM^NMC$ueH?BHj$2D#Gf-U_E^eY%l4 z=WvyKIseR$qO?*qgYXw%QN3vS0%)z?-fB6mccL~3ObNU(KLxiGpPoy<$x zno3hUa(pgDLrd4z@|pvdKTPuMWj>XuClTUv=AI%EZ_j`Ukm!=XW77`TauqDTfp(YL z|LAY|<#p#HXQCw^NH=Q|7j^GoW;7nSHu_G=Pa0>RP_wgtYYDT2)nLr&dx(+TN&$~m z2694l$R`zkh$LPB(&jbKwv&jEOCl_{Gl^aA2FgG3cOd(~arlN0pZJ>n8=r&2hn4UVsk793wh56oK&(bzIMMhscni&AH` zg_w+gnXw|0%jOm&k4pq_a4&%W-{ng^seVWK125+zMexBei+tQ1Np;DMEblO0x8tcRD!MKF~6=n0lAV^c0`+@3_BQ0v;G*FXr`?z9i4( z2g)dpv?aU4ZbMdb9zu^_#-7O;rO&A#<5Ed50gZ}d(x(ZaGH{^rS#`w&_rY^L2$8{Bimxivm=eKo4IBqil&fucul zIJH)%GWsQ*5cV2>`ku$=%GAKXKIgKLEyAB|xxz}Ahc^>e|B$!9go+63aEQw{1dVy8 zUWfX(&@z(iF|il~bggtbCmfz)s+=3I_VHW1J5w=U&2R0ddn%pD84e|JIJdVON6Yrb>W0Yjcy%@p?Rt5<;?Fz!N@ z?Jh!j)SOiAtsz?F)92mX>1b2yyhS}=9!jPUPkU|V*=E_S4f9iVc5G0~g_jh3)p;dn z{({s|6Xw6PIa6u2%lQCBoxZ~~DV5Ey(zGW(sa55$^M!qf>|syLyhD`)iA~pMrg;&{ zp4a$Y#|(yWyBYsedFGw`gNLhGK~ zULK1RcgI5^LuD0}tm97riE)}#$&8GBH_Gy2CQe=h^yYJ(ZHgtQ-X%@$ukidIe7$!d z)qndxe(aJxvO-akJu)&IRv{7DE3=N7-LWeqBMmbYl|mHZ$j*+OB>UKM5{~WQ7{BXy z-}m=>-=E*__c?#P-&yDNIy^c1T{NMTJB%X^W9o~mG_#p17^>PwmiID?xi`bmkq)YoZOiUU+~#H zAgTp(6KcK%_(~+_d2yKI+nQ4ruh+BJ?^Bi2%X@|@hnJQA5zT%`=SbXGIE5CqbAgsa zqR%QO?libpDPFK^8X9^UO7n3#L|bN0-^V3?A1FTF(3Z*^Wlx1){Bsz#?B#Th!gJs3 zJUOdRh1UdncoEJ$h<81oM`qhLVoO~;G_|=`U+n$RN7>^pf#{QM`+($W7?u;WsAc8{|3zNyt@HLEH8PPTV$rccB^l@J*{I>|IV{yeYs z+%wznAvQE@x9{%U3L@~gj}*1U*9%2F+CI04u*x~?CA&l^(Utw1k4R(vNxgdtdl~(x ztazgDoo$S$MV~o#o*dgRZ%eLVREJ1W+?VRdkDRB+N4Aev4oKop&&;BW7fy}~S$(yl z*f|lfV~t+ysTahsv$M~oLuOdKG;S)YO0(s)xMlhMp11mzG)$BcTA7-$dY3O>MzU$n z#Yu}?HE~U*h(=v`mg>voVUeMC4Wuf+AydZ>J)17`$+|(xe_mQ>`$;p7gd5FP zCJ^c~ye>~0`o^brVMeIydfU$J zm^1RX#^1SDb?xWs+?Fa^Ng66XhWA zFt;5#GeKdgV21R>IG1MJVdv0ni37d1|9BC4iYciUWDuWU68;E(5^og0d%K3=R2M52 zaw_C0GNuwP#fDFWG^$Mf(j2p}EMHskp|(`0uA=4{93?+{q4;a`Z*;e&S8hw)+X{X3 z?Vf<~zV0kC>^-<@^P=wyz6LLpcUAjmQqZbt7z|QDJYd*Vy2bsxxJS@;!H{G8hu7D# zZfDh>n%AD{BM-39BRpa)@M>SZTv?t-2+XRi9Jcg+xazelT9bFLVnQN3m@9x;U@Xt4 zBCN&Tvae?jZ8&?{+qOsdk6L_nPuR~YDS!F?#rJ4R)Jk~!DtLJaw2e#1z9HV0)Pgu^ z)91;_lf=;C@}Ybv=8j@gj6VoNwR>)xHIhgGcU(>h)I2`@i%Fi|2_@l?w21 zS=nLo@Li|2y17e%b@juwtzm=<35>74i=vOvR1gApPNOF+d%SZ$*|sbDixru1qHq1I zn#v003zG<_Qjq9o^dXF;p>|MfwmpBiux#^$@mj`^Q<%Cr99BGtK;ZlN?1)3B5cPgU z*d1ZaDQLo%FKcvv`?0Fl!IWoh;XsZ3c|}9$h3RbFZNF?G{q)Z@=RYCDa`r>A2rco# zeUq`FstK05N37Xjze4J}+bVe>eZ~@WeWQJfn%UQsq!z8b=H4$hoLWqoQ7b1ydbMw3 zB6ulO7PIcAj_OMJPyV%bZ;qcVdb4AFJncug#2^G0{7cvKhm;F)#`-Atwmj2 zC)Fj>6|1x=M*N)0V{PyDRp#Aei=LOS?8QASA=~$ouq=0@u^tTW1_j%DaNb7u4FNXS zDY<=nin!;7T)>4_a5)r~ZR~*wwkM#DX#Jr#EgYI+mYzI=?89JV|1lJ6<&^{$5_=7`1Ji4mzIspllQhq53`19k!n}>1)VKfqZ|4-rE^;QC0Bv zDtkS|MSDHS-)R0IxOY+_spb@i=ZPnOkh3Cc<;piEp5W5z_Z#BVQRpOBFXV#&ZRN&c zW*37x#;vHc&A}gU4@2%o{uR2>e5s=nR_GK+MMEq?pqz!RJK#iDsrcktj43!BzJXpz z({QaH;-?z5rLE4eK>Pp3p0n#nqn8a6W!1Wmq`-rxdO~^8_KFw_ls)#79%Z!qpcnl> z!^Yjvw$!E|ZLtBgk8$La9LRxk#*OAK#w#CvXzoZeG*-cZ?EE;y5&ovYZgA8$o*QSd zj;|CqGRPEMkW8$v%;al~kK&Ih5ZSeUx%&0jNv!MEhkGgkR(;(jzll#Phh@DjZYH*N{fxVIV_%e9h@)egXy}q;gM@eSRC??_4hB=%74lkg{+;Y=h`7k zoxE2R07qq|CCe{YYCJI^$LOjV18w1Oh>}gy(^oh6)EYb{36iXmJ{$MA!6T+Yc=wPp zaZynsx@?2Vq0{fZasDbzqOZ~jAnk)KsjCnsl>l&Un5c2JQ80+b1AYda3t>J(PJ&0s zYP7XSn9B^tj$n^`4BE1MTk}Ohc~r(FgcyFh{r>0Rt(8_UK_`LxNn4IzO9O7s1_(t) z)N##aj;*DgbKfoFI>qPl=%m-f+b$FD)hFNnO&-?@?O*rVQ}27~$tm-r`!>P^1Nfz8^T+nmCGRJ(CR7-Pm zaYL+#fxbkn!wo#foEQPpZZuhmoAvU-PnFmzVQU z+0^xxJ{8O#Pb@BX9bqPRD<_IlIZvx?yjrq3nPNH7cg=KC>jiPRr%HBXmw2wWO38)2 zj{lD+|9ZIRM6DVx`ld^jdwmiP;NW{+rZ+>uz&_V*Su+*AVHWd*upWLe9HT zgL|_EfCY=wH9lfIH~o0{-to4+-d_68qcfD@aJ;s{P_(4t3d=Yh5*9+z5AZU&W@zor z$Cc{?^6zCE-?y23+@?{C1=>*IW~W!I+QR!cYoqzMZLKCz$E=a|3R4@0y8_rHW|a^M zlSFo_i)hvgy|n`Lg{DLA-XcZMcs18{wSHLLW%uIs*j{I_lKwas!Rq54@Hh^dkIvv8vR*)WFwMVbi?88K5+d7 zWqq8OI2V@-4xx2IO2i9!g`^2(-ieAG2`lB0e5*L8nqw_@#2l4!}db zYohlU5NaH6I{a41rDCp1#@)EP9^YtH`_Usc|ixCM;?wM=1w)rAzX-v;l;~a_+JzkgRsL)M&_LHBeE21{Xu{a8o z!98}5p&etptN1CC4V9qL2UX)sg5$>Hk17*`&9M)XYBvJ-l20rwb82?mnI?+iX?3Ji zX{#Y?0%g74CVEuP%tVFD<-cL3$~0C1qmy?mnflC-;4q5oQ+vcl^5?R~NrO!y8(g;) z&Af?vfr&rmtScmyy&n!GG9r}!Mgsc^9pQ6Yc#sD$=ih7{j1y?v^WSxxc2U5)Gn zB^CwMKvoHJD@{Vu)Yan2w;s0lMbYa=v4__DvD~A|UY3{FI~#1iy3_jwNzCy2+I;rn zpf;)`GOl;yR((UhXDv)^;@im8DQ<`Fw}-5`h%IOIP8Ya7vI@}EgFfMwV%5P2BkkQ z7q;3>Jr*0MbtP+l4gLDH)^hg~Y@sW&&;`&odYJ-SwzkRCbTL+`k2A^h8ceL+{@7L)vO$X&PJAuFZ(3-w*;*@ z;=>6WYRT#KR;+fIn8*D(obdj6zS+}R!3NV6Tv9==& z1EBf*a1=dH?bXqtSU}g4r05vO0>(lzywuqc^T6URLaPg5qxYu8vmn>_2LRQOtH&|B zEJWY9M2lFLE(sAcFM0g|bjk#K&Mev&@;7Xwx3BR}p%c&b4RL@J!zjo)uDSn}+OJmh zd@e+Iyago+kN5sk;$T0s1Ai%G3}ySl8NvXk8VbC+YCEUw>$H~wnty!9Ij#0g3Q(KhQg)qzRbzF>2!jEH;Vqe6PsqwAL$)F&F;Mx z&N%4|qFS$9X&)ZY(`saYQT!Iow~h`P?oY`ADLN+_#3f6kgD zFcoAo@aq>FA^DPnIh$s89|@7lWYo)2*^+YTl;3_YdeZ21LX$pon5>7=S@c)?;%4?A zuG~M*Ch1C4I$A(NBCSGVus?o6>|>WjMwg>Z0cW#9D7fWQK9u$IIH)CEc~hGb24d8V z@aFm;*thf(9r`D}aduwL>(O5Ws)86VeL>{;UvoB+&O^gdW2?4KJmWiG72wP>z>YQH z)xNyFeNXh=hWwXBQ&kW8Tj@F;`5PwnCYeZ8kWIv{TuGCD+ip=cU{S@S@VzC{(lgSs zv#tjEQx5MIVQA?ALZ^1m5e@QaG5Maw^iY;gI;g0i0F_s^K|79wbR_SWP7pYNaw;9v zj^K~7-}Kx+$4Om4a^wsd@I3>MipC^Hh|?+Od6 zO?t~UV>=*Iivi+gTzDL8pcxA}`i?DWbF)@mIX34y1V8ivUywnfz6PwwvG+R!_ajA9 zM7>eiM4g3%JmFV*q_ zfdxFLj?dGTCHfy$vEu;o1X>Vspi8hsAFTs2tZ(Q&pr5fhf5u5HqhepwFzsBT-p3{` z>dRR^!_mP!0}zJ@0{j|j?vK#*xQL2~Y$&t@lPTT?@ujVZ@5fA#IIJ&d2uOpFAKTl% z45W~1=GE+}pwZztX`c^e{LpekI>erUred!ZttT{B3w=XEz*3S>gG5|Vu^BQ$1!Jik zh-Bt+2O~VshcW;t6AoaTF2KH{~D!@&MVY|u4=k729UR*a~!$PBv{a95}>5@{I| z)3%8t?v;ZFES7Y_ZK;io-u@Q>2H53?ZB1}0QagVc-*aLiR8U}TJGV}shPE;K~9^TflLHji`;?7BfxP)&P%oW~=7x<&HqvWs8J z)Yo&YITWZlJRXVbFsFF|Kk%%iq~tQf@U=8|(x;mrMXg&1yR8wIa)gz9K$J9hSAHpE zUuJx`CDjSI(2_`vbFrT>tD9_;7fQgLRYG%)PU_PhC!DcXLAU<;iV!uEhT$Q_cAURHhzo05Yvi%@b7Kk}6tQroO7OXaEJ& zB`)ZvMHRgwXQ1-Z4Lc;P-df-f=ie?2SEL|Z$S5x?ooAxFlBF3N^DkcYS7gCtrFK3Z zE!g1DEpA7x`+{tgJ*~eEL5UhFZVP0OvVR~wBQ}2Ke0yn(p3XfFljm37gnGoC;|U~J z9I>!GV)byC;jeh#P#F};5@0_#Xpa@Nc?_30>AJ?5yTqC2HJQKOeD>_wXKshSpe({4 z9hI@yb^5!A)C#((XC1r0E}gokz?zl{x3#0PF4v%y_fd?F6X}NwZCBSoas_g6XpKM9(V>P_g`Xw;TMLl#SjVy%9z~rx_)b$3ljrz~ zvCt#oiR7)E4kYn*9_&h$(n97I7TcL`bW`vmZttM#TynDI#p5NZZN#rhk%|xlAoIA5 zS466%qOR7$GRfZ_22^Taph%Z;NZRZ)fS>0xyO>duDn!3MPgM)q)(Z!Fgv%sJRFI(_ zw)c8vWhGXM4$RYcd-&8}Ni*Jj&)dRv;>|+X$W*9i%X?TM@12~SXztq&K*N-ssLaQl zq)2BWMYky-;k}n2JtI7xmr3)aecA**je7GBA3pd|#d`nZa`*-(O4wc;KYQ<@ul*M{ z`z#y9%%usD{&zW}Rtw8G5}H<>bmtSpUoDQf&1V+Wtxcq8=XfS93n%GxcGYN)@dSuX zH9*N)+3#mdlD=7gG6&3#$L$!rP*5a%K_pHa=x~}qx+(_MwI7TVeHSpIuCH^OIH$;> z1G5xJRqO)O$;pJv8&h-{ zsf|xovQG>hNne;qme|bO8u*D+I+YiRwZ-CRHCtlHw6lC3p3K70`)j&!zf`CNp7uEu zA0EyQF3!-yzP`NDl02JNpXnV7m^1AnhPaU$@U~QGvxbk_;Y?`G&C9m*u<}L2ed44U z6TRHv!9mT>jAO^h>I%NhCajz(PR7h1|CGBsz>87%p2ph3OG^BRlAXe3M-qzwft^7;lAm8w zvs(gCt^$|C43~q_qe#E`p|UwS2ffSq)!#rKZG3%jrsRJ#-xruP?qv!JbO`-Mr==sxI=HV%0pje2RBk`5zv z+IPl?i}xChV;x^;aD5WrI0Y{kDRVFqmbja*b%R||AW(Kqwj+yjx0Wx6ZPso zxY)qEaL=1YK+xsCBv49MCDvl%c>V|dd+rIQ=7bzlOU7P}VkUT8>SbenBlAXiLcjiu zeu{bx@+6U!D-j9~uV(id@DCzIo^R`8m*e~(izBRXwRVxXo$a_Y9Il%Mr#2n+1gcOf zz2SHtm)~6*F zS?o$4Jf(NOHS4%na>j3ZK572Cqe{uY)mb#K`?PWTl6#%>^1()|O+2m79;lfnT&ln1 z8~-g4HKLUjfX4>KO27TZSqk0j^Wxw9vMn#3RuOx4T2mx#_n`9dgiq1(W#Mx??{K<7kzeFDWEsHF&7 zN>(h@V@zEkvP*vBJ6K#;M`l3Vp;j~BFQ+hBI9|68R0?I|^s6{bHsy=Mj>?dEkeenh0usQp5p=zothY@glh3C&d3C_kKQh17gH%-9NIa$Np+3h zc;ZO~hqvJSG4j39sp<}I!9pG{q%YA&-b-nTWhomtMb3&B>u0gP^LgRQ5yP`6<%+rR z%k>7~#8tk!qrw!)ldr|qeN?hCQo}ZJVf)8}h0G@DRJF3; z2(mW-f$EHQp`f)?dfHxSi}sqZ2Xi|ao@RkYwMzjcOk;Nli(0RB{!3^m7)oWVv2otd zZ~Yfot*ap@p0;LNj>=?FO9Y6w? z{@&hQHU-|vMY#0gT>jd&9|t1HilV8)99NgDC$(elrlVrTc zn81`FXB0cSF86d3@1v#;?k>*J!!N40624tr*v)9xe~ve&+mJinHloh@u2Z=@KfATz zw-$fLi0z<3wt5a~5<7eJrBA^y6$RBu^jMFoH{O@Vx>&sK=Ps9T^WM2HEV!%6Ub&4j zU+-GWU3p`43%TG_4<>PSvfnMKEj1fM1+}I60B&G8OXVvwU^m>$RVUaaY=;R zS>?u!U-EToM!S#V6d;muh|VoRnc)nrIC|3blDwSd-j#@(T&{;3{H@C7DgNwL*wILk zWkqLv$+Xo+dEou&moBPfh)swPe;cdxSW8cAsh3$8b^6w4(E!VIf*J1J>UoY*f$_`Z zyqDrGM7_jJ1EuLF^jU5x z%hS2!-^JYOzc;85Ff4B;S~2oG?q%px++i{MxFDa9kX`?9;n+RE<&`HHfC`SnEe*N! zd3@{KyD#T_s)!tE%O`h&!?;gHZC>uDfIwBjfAlUBH=Gm9pOJaCwfi{IU=4x{=#yXK zpH?lLBj2&Kk}fhw=l9w+nT%z{@lfHByWV*b8yB+D1L__Va{~6h|22=O%DYSzXMfRX z1#9X0Aw&RjrW6CObBX>Zx4HDs`XKFV#x^!KfK)>0AK~2Gt$@yVBTM(h(*ze8CrUZH zD4fX`>i0R(yJa;U$#qU$+Z#!L4IHZ>-ZjhO#tr}ToKf!3fz`>qmC+z|Dh{aQV+7RE zDv{f=$gHjJK52rUjZ5tfL)@EF>Nz1lspxQRWC0*K@fc-I$pl!MNC=m&(Y2Rm~}MIFA}UaEJ9#8SfXY!wlC94&DuQhGi5 zieojXqzLVw%+X)XUPY{Sdc94@gA~{yCaW?@4pO!nLqS|6ZeB z!8l~5p_N(Yp8{;-YW3l&x&q&GZe7XcT)hUE1~29)nzmt)Z#VhMlMU)P@jgR^LoWL^ zU%4RV|k0y+vmo!u)CfUZ{5`CcKjZzsnhOU=T8h{P++0^==K;la6Js6 z6p*(mG?Mq|-Z0JfTk=+^6Y*6^I6$<0Z*WHK-gsW{?j2gzlulphF@#BE#x1!f$HcvG z>PW5$AI%le6jk`X`RM}BxBK>VN3&`v&9 zADl0(xW9~cU|~*LUif&z@tGI!www(mOsTjV$2yu9$$a1I*9eeHT9tM$KPUPPwt zowG}RUp&2gZ&7&-GG#fO+=(bUGwn$cIxw}V;B~#ifa^`5(Ea696@JgS22P)I*2J8e z6KQ%3@bqgq>ZJ!Pq%%hBawi4px{N$-3+$}&|DM}26jpOiaWPLi8qiXipZ*A!iSo?t zLmu=?K4`gyF^BQ5w&Ue@ztB{uZF_8w4Odd2r33aQ#yRQ*#vQHH))hV2s*1~65enm4 z;rqX)mQPi-@^c?=d4moq+aGBClueF zsXRW{{m8|C;tpspm7dYCgOmUZZW2J4Ywz)K=I(e$(YUjuXIaY*N%&nAx-N$cae8(M zB81L-W~%U9%^v~QQBgHuzl!4X9HREe)F%vMZg%nd>ZaT!MMA;7V_`wzI8V;6t2knX zeL1GWk+F+cw#8({%GNf_j!lz>LOnqlM68cEBqcoE-D_w8S-;p@?u1Q6Eu>dc*Qx~S z`m8ti7llmDAiK_d6RCuNwC7p4-v2+YNplOO;i%Br@F8V1oTr(c>j(NuR-;sKl{EFZ zB>ZSA%s-^X(=V%o=Bn=6D=B6!gQFox_rZ;$9)H46t$48=Z4)oBJV|L2xgW)}X{>vU zFV-vn5iuS-Z`16Rv=>(}4FS_&TtN6hq)Jxxxi~mJ&H)P|q4&nfp!w*_Cg=7ir`#c; zQ-S<-&#m1%&%Es|b$z26jOljiETz+Gx)7n}?^69u0VrDCUZ3-P0jJO(MU*jZ?}kVY zo_bdFnGykq!7E?NpOFVXnK1B7K78Bi6b1z2N{hfgrGIzkzbf=pHbNA@-;aHJ!FX(C z>j+pya;-1g#-9Jz={in$iZ_whxoB3i)$o41kH?t@q~(|Y{{0z^MZ+_E`-m*Etg(2X z>{p^ep@$Uwi0jO;x-FI7&s8WYERb+y64QNSB>9^U#l7hXcm_>%UUhXa+0w%1MK)$G zF1~VKbmQlw-q1vNSZ6{c2%nUpdQUhTx*dBT?s${awB1K3)8?LN$LP~${no(5vJGGA zt691q$~b@z<^@>athsEb#__T=c$3HAv_NSr~f z@D-nJ32s`gPU$5PJbxVmh%cvlO)ulWd!4iy3nsa-*_+pte*N=B0YZZ!F)WzwBbwY^ zpiw?)v@ipBsC&D4X_O2VefW39#rt_X6ozcP)boMh!K&uN>B+Usb7&ggsyKZ`=(MKc z=WOY>)vZ(Q!m%5Va^B^-;96355x-j7HaJ3b&jDlPASE@n#UIQR3 zeK^1b92?z^T6q7C^B4z66VUAb3+-73;HkTU`)1I99}R~w2?3U?us7T_1vG9DSzOci zWIqsvA}Wo84Pekc-tY3|_Ep&8ZXw-^ZL0^}-ieb3z3Gz3?Y4NuM0Bdc)L;(~mFJj$*MYtmt2ytM3+x#R%fW zURrhW=g(`A5upD_`Xrpfh9NqB+@Qv2aBz2Kd}!vzsMzcK;>1m}31(Pnl0qQPZ%QPn z>r~4Tcx-M2W(DwFBXfhPfE$l5F>FkJ6PSwl-%MXAf*1i+_ra1=FXY{al){f6I{R15$Pvt67P-O}z<;QMJMnb|=|lnN zeWmecl7;8tqbDwDOeD`?MAc-%C5`Pqki|uksumK`l` zN|w__v+6+aAg~OZAYh;DhclwOvBSX5IKELZXD)zSE%MDV3ZW}fi$ijW_iF6dO}nh) zrRDL8+C4s^&NZ!Oi`xu2J#;M;e~!myS%yw~HrS|^Iydfmw<@9M;9DW^K1MA4) zd4+4r$oW?1pI_KFv41pxw!PHg!H>M%OCqs(-Q0L zmhd*SPwvCz+To|er4F37In(AsBn5Ig+TpP(E3-AD9?uoaN0m2iJ_^++DH7VrquF_Q zUL;{1%f;-+n<}4@)!N^a#mhI;43bC7yB(O9V%grqFJJ=4sAFW$XLn{U)|t>L-1)IoBvA!e=g9dA@r-38n%ZgS750`IhQr*uvs~(VFcd><+@V2BUz=-x|FiYl2m! zbL<%`pvQVbs+d)0IGE3?Ipl~BGbe1&r!WZ#E-ODp zDgz401!MRjO~cob_5w2Yw@6DFiLg#s353s zqlmZOG4a`f66rfr7qwU`8YM#S%=v)AmfU&o+7J&qsO6NwSq{a*ktbL4Y_%5+lX7|i zQ>7m`dSDv;2^pDjTm^M^@V6bl6QX~7mMiH#ji>Jt`y!sEW%29~heMQKGY{*|wF;O;9TwoFo;+wibgHt<9 z>D_9m=ln}$U3omfyY-VYkbg9aqOmzgfrr*fI^6gXtZ+w{*zygI3$Q*r_%#4IUCoep z=M86ZNtz_#P28H@N)DZK2X1Q6ex&H?>h_aKwj2=5qzCE;co!M4><7R%P?kpzs^tNu z!}eQk8O|q~@TZsyXz{}03aA>!oB)UKdz`D0(mRCjrrEoQ7FSAZ5?kZ=3|ecQq;%8* zMop?+FNkj5Ldw*^?9hf1^zdI*d zSKe{*0o_eoz3&_3GqLTyp_0t7eWC@pm)CS&kcl1R;p!uux7nrdb3FPx?ot}pzBkA@ z(@kLeU0Nf&-BUe|C&c-?d8hGXD;K3$UBU;c4#PYkc#XcC4tnP1`7qh;9P+UIyII5ttMhWs|@$^+LfN4R{GQzq;}IgCQy~@i?EoXf-WO*_Ai#^OuKpE<9eogJ4#TRnSnq zV$u}(gIrvnLcob-=&Zi;M(C)zOv70)TcBiCiJ@x2>G<9Gvd}8$bLQqmmPaPs4iM`L z$5-1UkhRDA4)jN7nJaZnDnMmZMardPqbyRvMdZJb8FGm8)C%b|7KrW68k08Z!Z2h$ zlcH*&?f8J$Q~SE2zMyvipgw+0RQdytSS zmI>`{GEkDb5yeUlQ+~L8-rEulOU3hpuUe{3`pv$vQM<#e{}zn@eWY&^dU~0ZNl6W3 zGf)DMo&d=<$)pHh!)vi2kvEv)(p~(X^$R~T8x}fq^;O`}`tIC!`&Fogb5nQsfk*v& z470oi)|1iVqUz;W6phal7xpWG$$NS)S+SYc7 z2l@Vz!c`4N1DUiP8wgwcbH3bNawTM6tfRyqBytCHVAv?tq{IyHX#A5A`?Ap!A_N5I zJoO)cMD|V#J+8RZ=X3p8W!!#WO!f7MF-DtL!@=X#%0+eK8B+_QY_wbsofjQCzb=<+ zYOrET3SB*dB}h|*=wIi{#z`N61Qn5kq@#&%K71bnU^r?$yKW|p=e1m1W6G4qYu21F z`A`C5dgi0y*!{=_3OU=b2G(mK!zK!9YgcV|37l;z@8&m}_x%P9wReBTXD6k_ghI3b z1w8%N>*p9DeVY7cT#$(g2nO+_2*vYoCPgV8y9&}t1=8O&KJGRgdX_ISoAsYLCnBNc z?iDbw*_br4A*!|G-@^`~8rmUTmGtVC3dG1hr)>4U2&ZyS8brSzfAct_d+wRn&DQ7v z*%?8^Rhnt0`mr;y{I&BbVT8ENnZuQ)St}s?aMluLQ!>%mIL-2~m9&az;9#fxm9X1< zu+}X9y|AudcJ=gRq%b45gGqlZzI@!uexs~IqrN+)Dh^qcUaH|o$U-EK_ln%XSQUhH zBuwX2P-Z^WYUPw=t!IH0>4Sky(?K>=ch$5FjvOos#h|xOU|h}Q!!~E;!Ffdn)66_! zleUC!))|y$^!401^OP|=cZg9_V=pjnXVoUW(3dpiAu5@LG*&@4<2$}9B*EjK-xN3~ z|NOqONH6_(#7mzaoAX$&uO{R*!IW>J>sv<>PmQh^RNqH|K+IL=p2M?ucJ46I;B+`? zCXWEEQTNp>I1`I}o$z|FNF3A?TI~ms$nFIfft+Q-^)_o>Tp`IwkMMZw=;6Lx_}os%V)@`WhZv)gH9$bOg%loX@oiCSrzLM%3QAIpvO z`PT=fAD)x0(hBp%$#$$vIuOCuCj8PZ&kFvEAWQ@N{7lF>+fQX1I|5cwc+O|$7{x*R zK$RJ-g*h*(9aj1!P5rQ;D+|eD1QMKrB^AlJFL+3zJ&{8J4@YN=RxY55bH3Ju=7aGS zuio)-I>%L#)zcwFt@=M02t6eTu^g_bsv^20;1e^4*^Yt(&)Dum`2w||E&ynM6|WkG zjHS>%sPLrIUdY@$d6o;ZW{<(J!u-F@r0CfQu?~x8Jh?8Ud{SZIX8DJTH1&I+D*d$B zg5B*RAj0!&Rb%Yf3VoG6eks=beb&ApL{pEz3n2aBm|oJOqHs_V}AB= zzW@8%L!6DaS6B?&Me;k!#XFRG;C%4j_}g5afd<2MlXoJEK@t}#ZC?h9|2cNne^t_b z7TfK+6MzWzy&vru|9ea|EzNbZ(6R!53Q8e+A)JBo5Gw4jYI2UV_fDS+kemxAnwu6` z1-Z&+>>ffuE(6SF5X?C|(LgMunj=S)Mi;QRnc^f-9!S2Mq=jU7Sh&2SoW|=|t7GY) z5MmW^_B6}kJt_UOn&NS)b(elwQI7ZC>wW)cWYscZ&o}GeKl8WU2ULISlaD0j$l6ws_@3MNf)5|8$q_)T*8yBSQZwxEX~0s$ zF*#qY8w>#zqYID)WS08fnIl%`(cG7?h0>54kS6g+`t7}t>Ab|=0@D;o9l{opvL6*- zwV%$L4EmUurB<|ic~}x)L=)x34~45X8U8=B_v9DFF^g%vmA{`0hC;^vnnKgt7Wn3{ zHAv#=DifQlsa;f0(i5ta=L%u#sAGq)_X}%eFRe8suJwLscU&oYf0ysU08MPL^rLsF zY`^VDa(^-AAkKOkT}!3J zcz5E|yVy$T)9n}%d}n(%-}ZFOtA zl|Ko)1PC8S6hgwFp}okL=Qv1#eT@s+rx@2qq$j9t|6xy&O7$8rU!r#c1bh96tB9p@{eJ2S zL-Mef7;C%$pTyKd10B*vzs3mL2^^WO%exKyPzsh~rh5NQViU_uYn5H9pN@?GfmtxPj*^>2+791 zYE2E}xLD^EEIe?Q2pnv7wAY2%WLi=mG@7y)GKqD>ayuN&zkPS}w!k+9lT7IlyYP2Z72VaNz8O&nz#t4ZOO`W(R!>B=2Z%*4CMs^t3xZseqwLmnXl; zKEDrKfK>P?M6zOn;6eT7a&RU$gT!E%LkCq>1ygVygZp#qAn1|SH0%9IxU#@f7tAOf zOliR0%D#_y_%We=;Pn7t)?awHvtjD z7b>jmshK<+wT8!$TGzM@n-#Lh0^PP=N0YuRAmUx^mT~1G6i+!A!|H%|`Rdg~<;&G$ zad&4d;)31yJgR@tB5YqY>1aGH0@T3*^vw@&LFWB_wxj_;yzfZ;%USNsxgeXoxi65C zOq!%<1&sx?lU&Oxp6_8}<83`Nu!u5=A?Ju&`PkjZ%KqY-@Y&YY>Noj!4+ei7?7eMGP&XFl{wvz=>P5DkY73Y`tD8y=chDG! zL{+Ns_y3F&62)jxIqtm?&qS2R&u~&@rNVSH((74cyR6~F){JYc)3f!1e>r>i;8qsm z!ZgE~)!fZO%j~wwJqcY#mwg@wI`31qv%X)S58F^I^}xN;e~bOVcKuEq%X3Kb`VDJ0 z=E^a69RIl++|;N4JtC`d+-caD1soQ+Fufp!jD%fgKG^x}o@4YG{0x=JPMN0#P#_K_ z95lZr?x>_iqKkQQnP`%Z3Tf^c1ktbPojP%FX7~z!w|o5Gg$SMwQWMi9)grbQlFdjb znDeB$U6!hd)N+?PvIlQ*a2`86ZeqAIbp2#v!N|t&;o00bZ>p-RRj8`>?BLly-jZr+ zBIgu0yMJ3=K!n6h{pTs*!o+kMd0Fo4CQ@ZwNcbWXLRIqpxr-4`1#!>rq>d z(yfS_qxp-yez8LDyrV!mWzig-qE*|{TP~Ss;_W4zSCo2gox4MXzD$x2;xCQ&le)k${B3TAcMP2;F0?NuSCuX*_NG-_HwnhY~n{GbdTMW}ZbB zj=((4K!Fl-4SD5+MiZADa#n_DWerDAAxIunQJ_2VSlplTe@b48`*kVGTfzy)nwdwt zG5oy@JAQg25Z>m2V2qo!6G-<3sP5K56A6Q1@suA)VP6^;owj5vy0!qSA0wPjvOV`5!&Whh5dzkog$7R*UZRBj$ z-hVgs@p<9`>46ZE*aO|Shzh3TOA+zn!G=M)kC1|Dg;`ay?hlcMRDOv0hIiq-Xy2p8 z(9GNTY`63HwtXerXyA5!VPPE1{`dv8EMaPinDwq6rp}xL+o4JCL3l9*JjTKbS{R0d z^A>vLSa>GkM)GXdt^HP0F{W-0lc33gfpT@omLD7SnoagVn7Vr^O^jkuFUIJPlh<>M z2QXdk%>Lxp6L`7{0hTqnV+?t%!wfLS8EmEB9c6AI77p&TaoLgcL!6}tXV(i8L=WO8 zccLM)H<;!UPk&ixW$`?WDH~F!AHR)=ULW3l9bu!YzA?{u`pek+i@d4H-xQvimUo84 zGt$70kz-^x>`zMEb83vD|3Lcf_olx2WVzKWY`Qjm4&i@%>e90plb87581S`@pLKY< ztU5}RX|kTCyqf!;!?HlmUf`lj)_ukX?zYFQI2-C8#cl=?le-5WoQ4J!3FH_U{QM`7 zY@RupM|x)FGX1~4l>4=#e6>D0_)xgqB!w{so23HM9%OcC=!((v#rY{Q2^&l%ZW(dHZ^WKo@gt2ZrcSAP9toSw`8P&q7>~gazDdO(zBZO5 zRuGvCkwI#v`j?^%E`xiwy|Opap={A^sx71CPAVa!)oy4X3jx0{=7NhfV#71{WV!(9 zhp+eM!SQ2JD8Io0S-xwp-Lp&}+Z@;VtNAv|s-fuhOXs6*} zrXxyD-nW5XmXMS*AS+f+jftU+k)AOz(dTj?MP_SI{J*QKOEt&V*F!J<3h{V+ z-liOdw`D_?f5#Ny6gDB|S0(%Z`H)&ttqPK?LS3-UU@bUhRdSxIu+Q1q6fDWJ45@N> z3BG@WMF<NMs$CT(Vc!)J+n0w##3=zi{K-a9~d2VI+m2J`?oztu!hZwWmyh|_$|gp z;ya61|99fyUjd822Oyv|M*i{x;Xe`#;)yY;uy>RS3ku$ShaA6os}LR(#PwgW#lJmj zv@3cucKz1hSXc}5<2({UqKhq(yHvo9Xc~;x{!Lz2jAi7DU@vE{q-quPH$k(z>(}Ld z$=`4h6}I6TA|1(laGgA_!6pRw-JMxK?AyZ{ z0cT9&B3>F9_@%L?tw9kqCTOFZE~#E58*2%WU%kVw-uEMr6p+!(EI5&T3R-fq7lQfL z#o@SftfXYwf#ils9MI!kD1K?c&sC{izh7FD0)Xntp%S{2w3tYRKwn=sb9hPamSYu* z5@z&wxa=ZWz`YO^WVGRf(lKM5+S6bN-%P}W2_YMX2nN3rPhV5Tamcs@f8+E-McwQ5 zEqp<%_UnJV*?gfR4Hr6L*{i$5t6yKnh2WcT5l`+XdFBp=8px;`G8X$G9`1fw*4W@@ z=!cuX)OIewB`064zZkel2j~oKO4Q10Q5<1BwG2(_d6eqs(s;o|cAPRU;L^<6 z_B;=)kQzf*lClVF9aujq_);1S-o#|9m;=2kCe>7LJ6dO8|Id{VIzE;hripcG@5Ak4 zGJLTT81Z(Rp50^na+F5C?!&&}lk_w0&=k2Pp!vDw_Ug#@r&F9L6y!vS${d!bB`Qxc@}mrbx6Rg1t1Ghv~7a6#?ra_2h1Gup%}Ff1?_L-as#tro>p+Q z>CU^WS5221E622SqHYk5Y11I)G6~ZRT4q;#33kHr!eAlXJC?Y>g|AW_aO+ z$4^OHpzVNu`7ph{rR7WCUedw)Eg&*fOsZ49SA z-W8ZPbUasMkLGYX`o?dRxnu9)Hg`zd-qxmx`9=e)fQheHT1tMi7db-8Up92^Lc}J_ zIg=@AR`^2Y%=DHGu|G?_A?!bWa3>z?Hu{uw*8#w9&Gq%PnC`wCD(nMu&k35hO73uDTMAXTKH3okhj?Z zr_~FN)Y)I1ISLt`DM+>lf|H(z3PJ%k*Ob!W3Fd~*@1263Qan)h7A-_y=$sS@pT&^! zA)r|)z1c+>&pzxH3V(aqXfb7h6In+wPh)a(gtjckX$1}lH zQxh#z_;P%GM#ZX2yP_bXOJcxQ!5dukkbYrNk(H5EK|*3J1Ss`~O!;V4y0?OvqIG!w z4~(ffNZpz-jPHk+FW|;1(p^tY?ts=}=HO5GL>yzv24?OHAjz*BC|lGVR;2Plm$KzH zlp^b1&^G53fct1xpyabUsaT%_I)42A&Ex#i)w`V72<02mh zC$n`z%ZY{*2bJLUoP|IF&i!NmjJUz{I9n|shDbq>ISPKS(Qt9zEOXR=fjmeGIWqS2 z+Z_sh+V9_0P)BflD`vQI!&0XNJE%-A-kF8#WynW{w_SX%%mMc|l21IY_Z<~|*fsMT zBu%gUimk=3%Mwv7UnA zY_nqtRW~A*fQRjqs@(4BQ6zeB=ajIgBqC79S53RTD*aS)n0Rz@+2{EbO@J2#dEI)m zn$Bdqw$E8gEk5ooyj;2$TT!E3tc75#cw@_S=luY;{lf>^Gv%T8?pw@8E|Hg?o)fu*kS}Md~!RFxbq+y-rp&d#N*JWYguhf(WJp&Sum&=8~|ONc{9L+ zs*73UrIXvKhHF6u9Ki?G>x&p+o6v#FveI^GL{GoUBpQn93`FxN@Qh6QbiD;#JY$#; zDxI2()GXfL^Xzjwqt~zH9p5`W={_W0CV7=H*C%2q4J-te&I6Hb%U0$*Rkw-_nbD;l zr@{jC9apn;*+mnBdOzOJ3F$LSCf(B(?Iz-oDx!|~BT#`cvkP5CT2hMnHd+Xyt;q60 zi|@wX`l4TAT6*@QYNE&xw7g&>BYg6%Hw zZPgwY*!2d0rvoV22~f6D@Oh@hq&g&tDKRCr&-S5k z9zwr1^XIb$hNP-=^#x71ngv?E9MIa`6FFX2kJa534co51ndWhr!$HloEWSUfbF*hGU0HM zt(f)4Tt2f>9f9H8;UTR9@#qnSej$WNV;EB!oT!+wAwdwd2*;CufkV!g$9q^@9Lmyj zOydUB5y?#2tNv zj>8ksD|-}=Ue39V<>5h07{fS+$0>4@-t2%vjgD_PGSd~kM?Dxy=5Ll;cc z3;tlUi!2khA&*DkeW5mwVoy?Gb)W_p&6H|KM&olhnN!0CngkmT*aP;CGSGNDNAw-~ zgF0ddBM4@dI};M!34BfcW3X)K)V4-=3C zboSMm_!H(+9WI8?n_VcngwjF-Xj{J49(D2c?ebPG1WSqspjKt9ks5Km_l8dj+3qnf zbBkSOT4BEl@+vVJhzF#_USbHOiG}3BofY^GE2&@`kWs!lu;rdV^;HUVJpO;YR-RSV z<#4%Y{Ul&l7aCs(T0IwK1Ie8kp*tXFexo;vtrQICL0`>Gk6?oG zPoGo+=`0mZ(mdr4+9)WWN@=}TiY@n%d|pM0ZGCVjf)uHTXyW;wuI@Ig2_(`qU!t9$ zVZprf+ocf3+nP_lGMTlCypFXQSpWAek3)O!gDdvz)kGDqAsr$)h8007n*nN3d9XDO zqiEu_`fty5(tVfL8FJN#qq}Xe2wol`no(K^wb-c%SyA$aVW`C3(hqq?F@{7|o#Fa- zmKFpx<&MF!V}1rq;`3$CV<63+mClr~Ro1OqeE!vv7Y2>|L9s&qrYa+5U|?*CR0yEs zI@crJ&LF#vDbK}^ZK}HC+E_#~Gj$ct7HL5_Q4pl_6~s59e$tW)k_u<+n7x69x5{-s zb4FDZg4D?MvwYYa7SjcAcS}UZw%u%vgwq`ozi;bWRa8kzza*KYag57(zANkB6 z-!!zk83mN4@w0@CXkF#Qxp!| z#2xYeFg$v8G%sl)nx^OY$s*pDG^y`f=ZHO!J5d@1!8a*4zuXdR5Ot!qL zXovXpj2GoGxcQv}*`N{1d}uwppl>jJVeT?8YVxYV-UL+ zckhp4N~XW#lw;ky&=|6YCJ=9iu~zDi&x4YP&Rh1G=Eom?j}u7F2c?86&3p4?}~ z=y9BF^PYrtNW1%$PXxL(^`fg(>HsKq^~V?syrATK7ml539I^{{xd5uWd!+!3ZUS>x z&T^m!#Un&7aK66`A zZPNGHrQBC4WL@iz5swU(N`>wikBlg8O*02-AE?!=p^`@uxjnB2|LNh4I4t>R)=H?_ zLr<((2(UXjl&;^2jkT2OAD!K7(jtTo_Bmy&1?Es{pKgkH>a;^wcJS!YLWT5B|Iq>< zNjv9H=>Y5-OX0r;DXX7IoK`g560yFs5WrEW*^)Sc)bjIP=uWvQBnW^Pa1sT1fiiGH z%{XcT$|kOfKL{z_G~CBj0D#Sy?U{r#_bwfxc;#$upb_P#;mv4lVxQ_ViyK-$AXLA6 zb*@MXeA}A&4L<=%UZ+iFutM%l!C@c!oIhy9*%n`WE}IcBn7J8T-xj1)OK;=)eh3k^+NShWyE`vE7fv&gl+TnKAV*Tn8${yZUIS*Y1}bCk0#kJhH$lZlwG&bg`{CD>{&NFw?J&GFa=hr* zEBC>*PG@4s9XuXy;Qigx(c*wp=E+^>>;!n+3dk$}h`7f66!%%Mp@y(o!A?O*h~h*6 z@tQIB%VC8$5A3?>3q<;;f+E^MqN%+pxzDEubyoZdfa|hCBpZ%)0dx*{6I?XR+- zFu_CEQOh~rB(sI0c&JAm^i5J(x|UjG^{y?f!xajB7NmC7H*~!1I=-1~hB0P*J1e4G zKh>V7uRvbnOlS?t#W$kQq(?T`(7aS*6yVx;4hU@Wwi2R(wt+Lpdn+t)Cjvvj_~1S_ zx5uwTuD-|kgTVXTym>edT;AW$wB-xGRkTyXJU5$qWD>0<&|jm3mo + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/third_party/pybind11/docs/pybind11_vs_boost_python2.png b/third_party/pybind11/docs/pybind11_vs_boost_python2.png new file mode 100644 index 0000000000000000000000000000000000000000..9f17272c50663957d6ae6d8e23fdd5a15757e71f GIT binary patch literal 41121 zcmcG$2{_bm-#7dlYuP7j)*2;A*6eFFmdcVCl08D%$sVSK#-6`~tdTIu8nP>8iAb_9 zL)2s)`(O;uIlBJW^<4LJy~lk&@A1CVag-dh{C?;8T|UeAoXD#NI?N2b3=jk{U(!Wh zgCOc22%>@=q65G27mTd{|IppMqJxC?DSxsX@)IHG7<37F-XtJ>VLbSrrEiAD-XO_G zx!q19+z#eMQJgxu2;=9Gah;QabMrGu=*Ck6;8Ic$aM$}OS zg7;p(a^lFo7y=)c-B}%i^PqzUeLd((3kW_d0lVX^DPi=bI3k(7O?~C}yW)A6q6IQ^ zCUD|s)fzwcuCiN|2QD;_jV6m)N(+_n#W9S2GNYHD&tB?|ybB_pm1jdtvY}D2u${ zg!|gpCu@j|!K&j)dz<%1qA)PDXjCoB&wydqO=O$brm2aEt7uo_%}-I&xuVY(6}v0+ z_4OrLDw_gS)knS3r(2{Iu-JO(8N1w#X4WA($@EFcy-9=vvA?|nI4yL1EMh6274$;6nK9*Bf@SCC*S<{Jq% zsbNcMh}A1ITuiUeE=BF=PLN3I$$BEmuje#iip7(v19az? zW2Z88_AI%0?Iq|vwQ)X1{Tr<*CBd2gVOeYM4mUr3QrE3Ym(8xJfHuGp;{|{76weDr zj;-%FwMePTaz&GMQ5uo^B-?<;7)ub3`W+6dZrJDVUATpUuc0)?M@DvPPwy0(%rzKs zgm5?85CfH|mf6rHTaEjpdom}FL?$6teIcEVO{4yOXjuRr$Payxy4Uht&c(VTt3?4; zWZJKC!@@$N&oIs(X>?Zu-A*L8?4$=1h+A@vgs|dCUnMk&9)qz2p>mdd z>l9ey_X4XqCy~g+OQBw+ry;S3z6sxP5$H`jXLmf+GHfiyG9lPVoGaL~AB*aHJYooz za)f8?3?xKdYK|O%&QWijMcc!66;t*0jL%mO-r`K)MmqR}*Tg9 z%{&F+=$^KlWsfZf1qMDiL?VB<+IN+}>V=v&cWbsF`Kb2O*dPy?)O#B@?xMyIP5N&& z(GFKpZCQDgDY4ndbYyk9ws|cX_ZvpH+e7a3%SX`W*dTkER8>Qi5Y@5>L@b;Oqxub7 zHig%;_>K?mTAVr(d29Q@MhQ&y4B`zmKs7`+sRjw&wW@xRwYFyluc2!;!tPv|*(2{= zLGD>2_w3PqDOB0k$X6TH(o8Kpdjy=TZftC<52TudJq(E<{G)W)(ff4EBB+L8-|;IE z6_f-HI%_a0lG9NnAs8>oTXf#dZPDJ$I`HTF-UZbJU2)n{D$PTa_i)6pZ*_0V%DfE3 zx$5YfN9*e9N~pdn4mI+(nHOSZQ5#FSamshRlr!Rjs%wf#z7Wo+Kg`wHc`GzHIM^?n zyw%wBwh7-i`*!yCZ)bW>2K1LN99d9DNn}EHKmGKFeO{@T4H*LA`tt>ZDVN z-#we^PIvV*VjlbYHG4ye2Y7QgTq8LcyK@rNpqzA>Tm|xdWnf^y<5&C!4%#zCrCC^5 zgeeYrG4O|vMNJcksstExz46|*UYl1ay=^ge;uwNeDQ+!tqHqKRuLo)aHlr@CNZs79 z&BXYGB=r&6f}`g zkkb=M#24Hl9qM-aezR=I7y5Nv0TC954@^5)18Jz5>fH%&nf_OuB%RTYQK%*+O*bH{5i>v1$Tz15y{=t`GCzk<2dU7O@zIyCezv1_ZOU3=VzqtGk; zG{2K*CUltkLTSs6zzhD*n~S3*(6Sd)q8R5hP&sH#Y9gn%p+Xp)pyiOTU=FQ@@cq9) z@tQn$2WrRV2J)iylai7;Nug2+2Km%IYkNjWK`OTBoZn}1m6G=g=1`3Ujjtr4oXbEx z0-><6H_lU0M3C#w#H$^e?17FULI~qztr_*}p?AB}m0pvIw=$YSl~V}{U%b*8gR8ZS z?jH9}zA$dG#T%4KltrE0`Qc7!Wso{_EGFl7Un9X|u5O%2&O#_qYvzdVwB5vm>i^vJ zx+;6G!vO7M&HKinpddQ_PXaOXwWlCOID~Yt3UdS1KuF6S>(S+vP9zS#O2()rg>3~6 z`ZlG4Hb8W*Tm5{7b*C|FIb^@?%a<>8+6fy7R0Er)A%_+-_`f01J-ThW4W@V)ijgK~ z>WCz63wRqB+P9{h@1bs{U&B|pqr+P{YFMeD$%nIdgY+gIBWJk7d$f$!FYHZq?{Re= zNf3atvBo4-^7~yMw{W4GkY;0wduR2w)DymbdQZpDto;cabrkthSWo;(`!4hC$6;L# zGKMTqrt`NS6D%t4pipJ9a5!9FB)v)>nK-zboYeHU%Ys6q-IbkZkp-T{tD#K`RuGmK|w)E0uJv(_60u;@kdaHM90Lc z;}Ughi%D73=jN?6i?DTdBxfj%&RGX^Wm>R-@K^)fr;2VKJJR6o+qZ|OYL_lRHuRo? z=$3>tCQbZWy~!%d%F0I~KXQZQ^bmA!c97XNKs6ji=VEc2AvhuNWK2ErY7ez0;fFJI zahF@n@Sufm>&>!4>Po)D@L7I`HBF&I^{qwb6?cMzyer;5JjNr{gjwk1{>jPA%*+X* zS~f@nE!DanY=Qmt>z5ViSu|22coppk2dSG32%RJ~?)cV_g{7ya`TF}*_H1FZm zR%cYk*4Pqav9)Z?Hn4YYXveUmeV=3k>0vBS^7no-oAJfkB}OQYE1`*Md46vsvfW~h zwHk&dkR-d^uM589CY%khn6&DxV2j@Q~=3&PXRH#LwpJQu^u(l^d+A2x)cDBoO z@>vV{yz=t$2_kt>ct{dt$9>@*Br?}~y;o-+u1OCejo!X&lJ88G)R5QKJ!)xC?UlKcC+qSM0Z^-1gyQ}u}IN}NeA#1FYr$QX}Yw7*wtxJT;4_W8k zHx>q+ot-_OkRWR8NSY05!w+IhSR;)VV(t|+;bW!iR!2!^|I(W2nxa!^U3Ux%MkFZK zG|7V)#7a%*52R3Ok2@R0P_#bwLA(J8qzr zU~`qJc@E@H$A>k@^WvVW_1xTCtxIXfr<-LWGq2p6E}_y$Twk|Y4@(&J6Oa3QEVx9p zn|d2@SkY$FH`@R-LD;ZjRs{fdZhpSxg8R&_EkH#Zyx#U*ob6T?Wa&X)jZy!s;`vO5 z$*iyOqESI+<~CQi)Sl{|cvdi%O{6DuuGQNdt4>LUCs+WAv)%fDOxDlhS70gSRR%lB zjP9$7#Awg93&+=Eb93$C=y=#Wxl}!M4z1o?XzszWEtMHA@*Gv^TLL+b#IDt=5F;%_ z=Xq00>r<2Rn=N2(@g$WNObOIYyL<&YMSp(T1P}nwW0{+&P-NXujd*}6 zJ>vFIl$=uZ4N$^vL|GcCiZ>GWPjW>!TtRtIT|JJ-y4EjQI5*rL@?>oq6gi^2 zoZO<&O*7D8OeTE?eLzYT=&B0ZK$E&q@PlJR-v%+^KRh->VN-+S@qwxqpdOaBrqsku z(?Ie}_PnaRyu9fz?3>s5EuyPCdE@e~ zBpakD`_5V9h&~rVNG?n?kZSD2Eh#PW|NjSj_z;U!Z%uJ994!PXUR|({#1vrT2FZe- zL$yc!Pms004$L%Nfb92z3~e8H?FMno<6Azgw66LJZZvB9gbFXpc5PBM!`OZ{9m?Ae z6*|qgy(JjvOs4$BvO;<};Fa!wPC-FK>D3F2bJr(V`jp?unWHH3MK&5d2kAN|C#MJN zgGttD-=@dqS-qPAmzt)kI1^G^Q~V3&N^(T!1aH6U5RJ;21x4{O?fKGSzi0Qs736+z z1L^@g&3l-AS0{Mkb#ZyQs2uxT(Vb4`o%mn7+9OVii?Pxugm;jkVUG~Y1}Gbs$z=6w z@~bOqt6z6k)V$Y`FK?i5hbCux*W*9k44a*u4ZIa&4~NHUfL^CJ=qn`gsq9+e_tVpX z|GcuBm1pSzu1QPKJu%^+(q?;^>|t6o{b_n-TH@X0gBDg_jpBLJ{A-2PF;)A{-5xJP zB1SVc;!6}JY}o&~DoR0Dk|i>p>7FnUbPF5w^;ZC$_h_dc(uBX&58_ovo&9{O-o6rd zak$5s6!+4m%(}_jHs&y@vdu5<{nH&>HKuJ|y7kfH+C(6rgxjSExb63*<8(>OPTuRS zBo`-PA)GMl8(hGCCT|am%0g*7kL=vOMArx}6iZS*8xvT`fS<6 z4%J&KtVT5!Wj8-Xs;Q~Too92seaPEW2l*@qM@+x_UlExb3v^sZgxC= z)W6?mgcpoO>N@d6q{T{Gx}`buOSRs8WXHo}&ob04lW;PzV;gae6|&>;mWsxFz6j`g zpYQl%H#|id%!zFC9UrGqY*+lToEPB2C^zW*l=oY;sexR-mywd${Y1!wDnOe?<2AOZ zeq?_x)lwte`LD@yaPV?~?VR;+fx9M!duk@dMz(Nt3#3QCY=E*H=+7W`ZYNKy3_i0z z(#tc|E^BoE4 z`~{soJbFgD?fbTI*XrAkQRlWUjoz^5yd!FcFuz0;ynkR z2yX10tw#jXgbE>}z|_L%a_3HWWkxs#YV+d#AXQ&lT)adxYF^Z7Y8CaK5pUgh@-LSt zfybDr_)oG%FnC8)`+4}`gOF@Zxr$`bHZmCywnR>cOGgkAAl~A4zG5_;+FyUh+?rM4 z;yA+!Pom3rW9I}EPI>ewMl`>sCQugL2^Kepzh}+;ZHAp{N^RKOD9j}OrJ<-dFS?22 z6dayJ1yX>r(At{0*U7php7$6MTkqC~KjGy}6LZ*x_qGtNwYWAHLQDY2laz;W>B;At zG{+?4v!g%!rq*IaB2T_|0hx5-NTd&}%d~$KV2TP#6jqps$$=a9G4TbIv8KaMFvlBT z>;4c67=cO%4(Ff}f3`_43ohQU-YpdQxjLfH+QhwPi7&dEQ-vGO$qg>ey2KPYr}grK zA6t%hK9&=4ji6}o24oUV!JRjl?>a^%w^gFuWF1pFVSx@j`dRUlme~LR9jb9O?Q6MsbYB4)#*4w6Y0+SpqceS_JWh66?wa&_Ts0I#}qg#x}_BWXs+T$$;qm!DhWuS%7@K}1t)CdVzpD$0I7#gZIckYlC~s$-JHm$WJY|NB_~_ zE&?UP=zf4|W4l-SQ9GXE9tRoW#&}_PYzA1qD=0(S(zdmF`h$1`lHfU1#;js@E)Z4g zJ*44DoRn~5OQ6NpUPaD<`x5iV-pI!?!o*8KprNIh3{CpO|5cE{2Z62;gnAR3gNe>z zGY948Xv9>A5yxURB`#4RddN)B{C~{#B2E0jrE@N;5)S_zP26ak;qLQDB|w`mf!|?V zr{20zG7se5aSBX7c<@qDf)LX-eF|0}-|7koVf>;h@@JRtc&%vEFW7Gis~_&ZXtHEl zblvNwp`oEZ8%^5C$cW!)_eG@1WdPX3jv?~-?73dgxq_PWIRn!r(<%-KRsv<$Y0i5- zmv;0L=TiChr^5cZp(-h+I@n!MtxcAYFJ+lpzO<$!gTz5J^Yp}+F{Y*iTHMulYo zB4U$)6XR8~Y(@rv2*^W&qm&!U#E;vnP{R|>QnZDG$2ppRggO#=QFQ+HXz_d~y!r8C z=S@~iubO&s^Kyrs_1V4*DJCMR5oZs|tCEjZ^#`x?=MBNci1~pxqb`(^>*DHK^ahKK zS{$oc(*zi9z)ujg53%_l<|tO~glW<+2el^?I;8BnxVV>ic~NccPNE%;U>;Tjwj4uQ zG(F_62)lPLU%h%ojrO3tp$~ulai$h~Kvmpf&7*B_BlFYqKWZu~H(o=HH@5D{r0(9w zh8iJx)1E)yw7_U{Me3R&S*RxIPa&Tjwf`U*1!~AgxI~UuGfyI|=T+pE;3ed({Gw?5 z9?0DIf;n!O!7Ur_AkJbU)6%8m=JzrPZRjH6jrn#e4u2SWJ& zWxb)aJpFeGc;N61@YuW4dSay=9mCvytZX5mePKkW)<;ac34Hr9hgLkmGBwl-JC=|d zz-bEHrtVn)A0fv`U8lE?vC#_fS7$j^%iP!i5h$0Z)2;*hn?MZ}z&5PMa8nqq)jB84pc- zvl)$wit>T+pGG8aa&<#rL2Av^EPeTsFtjXt!UI16RiU9r(yI3E$kWrtzqF0MH#mNI9vebT0{D#%&CDmS zO767TllfgyQUjctY3ZmiCgAEAM669p2gG!E#(?W!4~p+4Zb$kFs?x(P|<3Nd`zIR+_+>U_p2141&r?lb5jU!BcS)1gJSq}LK41RfH{Y0SJ|n`l6M=KLVUB0*|wc(TwUaw z*lJZU-3XzqZItds@CrW0+WOQsaCuCE5C8s$hu9YIg%F9|@q*XrqE3CZ<$~)!NpJ#2 z7C_vtK%t%gHhcGpo=6YR%k5EEGce_*=-|USShfTOZdc{wVd=dR_j*qw;+5kn8bQbP zAtbH@sNUtzzknicx}|?{tN_s?0QqesmQh2swY52oJ$&}obXP$Mf8W?cf4;QGE1l(E zS3_C4YXa1Lahiq;rRFKh^TPQ29;MaE_3p=`P0NuF*%wtW-;3D`HH-n$ugO#+NV(@v z`j7ytDwu4@z_;Jx153<9`hCaUpg5YVsCRe#0D3(cm4l0F&&b4|U8-negt~y1KcCy~ z{R;ak1gGKlH2>nX9$ zed&Y9mrrC6-0F9ooQlbxl}MKbpI{2wMLx>)2y?&+<~$x^4LbIRt-c}8z2LDQpnfMA zm6LH%UL+?+rgZ_ig!gKo!0rX(SrrypgoZ%2=hFQ5W!rF@zpet%B7amTlL#vSrF(=( z?r!8mzO+WcY(1LPBB6jx;-f_-!o86ncd60kqL~UMN-Id6md@IWjA&Tu z4`&(^(+G(6aPfi2Cb>t$i#0B;+bKrlWMIg)v$mUgouez=7PBt zgMH)vhnaY<3oz#Wzh?n19|x#JUzvH<;tZ{#`-u>m^6cw@t%-PqAGOJ$@%jRq080QNqcRy8N_tG%HYD|Kb=(3@&LqpdYC+|VQ z(3p!fB9`L6pMd&XQ(_wlgtCms1?j+E<_7jMlmYO=X;A(@8<7**Tn3{hPiuQ7bA=o1 zJXqfDI_zQe`;F*zOch%AiICe0UcRGbLpg1P~HSX{!l8W;GKxoN_sU%a}Ub*5{K5leM}${Iq?FU9GpoE z8J%*zC)?^8o#R}A^+5O{4stsj6Vu>uE&~+EPQLpv&#sQ<664 zPV}sS35WX_@6~+|8xIwFqni2NWgD@NmXPg$)N`Ebu-V9xX-KrD_PM{rpMY(Cr<;H& zpb>Fc83S4lU-Qz75n!>Mf~lJC9<<)XLH*fJDm_Yy&3m$M!>jUPA^dJo^c zQ20He2UjF^fde7-;;^}DyaM2Wl(_Iyc-6DFQQo?D7tB_N6~g>O_(hJ4Z<>A~SvNTgORC^m_2X;*ytyadpzho zYZm#DPp1PXV!`;usWx%kR?XSeZ9YhUdV{ghmwKmVpV{f&bVdhmMMf&;5*o~HfJd*W z03U9-g;}AyuBx0*Nc)jObOE(oTE+RhgY}$gI}LBd4p#Vptg*b`U6Ws;^?VIJ$HcP! z*8x=q`0EgVpdfX9&)Upix+l76r7Tb$fJ^kS4By8@iGaq=+_KD%8c*nOa4!c5IaX6V znvL~A&VUI8h2d^lqZM@^iLgiGrJG5rhRT)O3U3)k&jSRGHO1&QNWXGj61s9Ov+$q1 zs}tEuQe~&?`ah_a36LwJDCM@et}ghsbgLPv*yPGN7EJr%z4#M3-k*K|so_5|smOx# z6<)?a{NX=QiD>?|RCvVH4p3?TqTph2a4*;TjbRHbs)X~DN@4}NoIc7)Id09_*tjnm zP)~T$5sJ2hX{SP2iT+cjG42nCxB#L;YVt&!!p?ngmACLXU;MF( zUlvJR(|RcgMl$LpnObN;Km3_Ni)mGgQ;mnA)P4s}1dS>kJaczV)#D<;e$ZDq%^c&r z74YRC5I`ufDX!}Mf1~OAk+l9hQHP>Zjed|?p!<58QYhIIx}}&D08Xi*kV1Ps9iE8$ z(!bDPYms@alwHIJ`j2*NB9#CrAB8MIje`FK%6B|yn8+&65qU~DQ|{s)+!weR_knW7 z@INgJ|Cu)3Tv4S%I@|#}O$$uuQ9yC3M!J!?W>!|@4k@PiYyDYJKr2OI5JC8~NLgM3 zI|6I2ro_2YTpw^eqr4Ds4ApiUL8;=jtKn-+x%-sy1vG<0kO7owXhy)?y{3t(EeEgjUlvo&HOBV zy!D+>n*?Nzu~r`4SC-~oyz~k)z9ULOy+#nb=(j&bO(o z{t=dJrsM=_xebuzcP_Ob}_ZRK{mO_#;A0Tm_2fF2dBuR^98R4HXw#0VrOzByi zWYyN1f$95rsr8H-6KuRb6|YtdEm5A)GH=&|-2L4P z#5J9sd6?8f_&LDLnK$hoDpL690WuT zuEIMRSP6~<7Dzm^@MUq+7I>@FD}4Ar{e?pf`sadJ5e16 z>4~IO?Fs(iM~C=)+uePFcG3(ea7lF`eXnKYNadXovOD4rI^*Iz?!Dls0U~u|AM&8O zUOg4|!_b`hCSG%ebe>PFILLmwm5?OL1vk0`gdosua*lt|SFcoyqRl_O-icNpcQS_B z$yc{0%OYc6Yh@2yI0EN{{}08i#-=^tw$1f*RW_RQztY0U*;ECxNxgB?5&^}Xe)5Q% zn}0k51MY-elZ{gcoae*=HeGw|RuLdlE`I1iUyO9y$D3sq2Dsn&seYZ9$gIqGj460Z=~e%LVb%rMw&4R6&cPk1-vi&jr@Mgu3X7XQ z_sA~5&dO^1Fy+dVcn^B>fjD*O;Ko{0q@r>F)be^1P4NsIVEi2LMx7%@!=S#Ifa%Qn zzb%n3ki>x{qS{l}3jzXR0rXkQZd1U|pPU0fMl|0Z{SQ6`rI4Oe|2GrjzXmICxBi8j zDECas!7(YO9;1E%KwCs8U?XF`mKm$8gIogIX5ykMd(uCmm2bG~06qSynGzvk?r2cJcwtU=8x81wb__mFGd!j9Ne77gL8f)kD` zusl#LNqYtd8w=zyM$N|*c-cbKMTj|BW}^@8{=eQnl9r-rfeDyLcJI^^JL(-M8s(L| zYZWFNCQvX)r>~S&nS43Vz_>p(Zd!E&7`!=x+>M;R2nK?`9qjQR905(r&emxZB@;i-9ZIspcRqJlWp|u9xb(BfXcg3d`sjt1Mlejwh*L#auzGFKT zjE&^zY8z54tJ_(98D3z2{$C5&iT&S%c5gnXN@lIt?vi3^M19ws9*Q1p@_oL@R7Lw= zv~5bs045vo9=~8m{>EjyJ=5}|<|1#X)r6=#x0Y3$Td+doR;ahC(_I6VYZDbGWeH9e zGHaW@PAWu?j;{HUa>og>#SJ|9q1Z>i#%r>zcfnB5Fpp33ANib;{XqS8qfnQ(Z{NC7 zdp0ccC#GWReIKdau@0m?1#S5lQN^-9j~Mn|uMdkv6iE!3(0(Ev3&1^-TMHeT@|8$U zTo6rTwNUG+Yx|Rss{oOhbaMy`YH>X>j)LD(9o}hW|Mp;zv%BPYb6e2O{=pZ*FcD{VVeO z`}?y1^1pym>;9u405Dl!`s&p$OR(&(U7A*2yup_HrF`L(N(`%X>-Uc>sQF#^DN1HS z@c?Cp1C)7+!Z1wk9PlDajf>KCrl4xs)<+0$DbV^nIs4Ax8KD8zem$+eL95jS(v>Ie z5(%@y3)0^<*`HDDJ)}w1Ka3~K-Eil0XVCUyrf?5av}YqE!+xXF8mD6q$6x;vk>7jyec098 zs`@+%k7>^Ule2*Kf`$dkNrSc9p7P6or?$r@lCJ$sHFh|&$=&`SE#%AzUd(%XWKCJCr}Hz^xEzqB-QCuW5*x4!!7@@cwD~5v( z+>3)H2O|rpO8F>+MAQX`RB1zqB*`VPN1wvB>hoRli zek_R39l+(Iz-k9Z0HFTd&wscbjl-Ii(vG zXZQWd=?ps_clp+OS4x|0O^K6YqPFjX{keZiSN>ao14n79VDA7cM0^HHgW!MTd0sDf z=m4f*zKR{s5;5eTEhT(fQ7)Lc#60-MqI!^WSA+lWiVx-xz+=GuW1OFxGx!7fD9GzT zv0~HwyTTZ82*l)IC}RR>X%WWBY|OISUzpDq0IT_ zl>6>g6BHR<+~aS)bhYrRFkiZ8eZ$#?Ey=113dskf0!lr;;|%cB66`n_>Iy1uXvko+ zds+y_tR>LH*q~sro51+Y@qPxZp9s5vIP6lpgN#CKe<+`OLx1Y(_qUyFKNuk_IKze! zLrCK+o;S|7N|=OIsfD!el_`t#I!ylC$iTtW$_TJ-ea)zcUSPwhO3NA>LoI;!`E=3J zK_5&7MC*nx9;4uvGsu?{Ug;y!V}&OBHNUiBjS&+cwku-}b!UlX5EU%F=D$m;Nc5h_ z#sWGjq-B(M5YncbpM1cZQK8R3yBClXClNwWDGKEQ9PMcFHep8OOx3YNyI@ofe*j#8 zq-*i;*mA}2f}4G158!5_sNShDg`KB`q*oyxMR8Zo9R>Oq7(+PE=IO`*Iwp|6U$=z@an-i3XC3@b82hnT_~w zamEsh2jdwcQN;<>eC|+%w4zdpDN~SeYag6Wu+DD zCjfy?8tTXHj86b10enOzz<-Y zN*PY%darf$jVU;0XtKOJ5tvrB<=tDh6rtjVKLP6Wt@a;E83t)_adADc>yxCt%aE=} zqL5ktJj$0B?Ftstsb@{%wBJzKD=dNP$vE)Hg(=fiIr;f`J$NBk!efwVg4G%E7)9y}-JOjzy4%xB=KFVT4Zg7gj0y`x#3>C4+SEBYD|x8wnXTe;c(qXtZt zsz8klw)E&EirJcjeFMFMy<=@wMKvfU=&JUQj0E|3O~;*uD_Ns#ic3l~G!8v@t>wS~ z6<}+NgDVLnZrIgM>B5iy4PsutO3c^9>yi%L{Z{hMs;-1or|da3c7?{f-^b+_*?nm> zHvZ`eo>-NCo6(R2Bm#^zJe1(63fh<}gw$Cl!ARc(GX!S(2=r3y%>s>ttfSGN_86ME z;O0i_Z$sV{TMT~vDm8OC9?aw?&EBoWu^!G5#lobhn>i8Q$I&fXGY;???q+;q#|*wz zUQVCpKY?}ovL@{5Btxh@?qxhiU7o8=uq3m=ZwZdQF4y%dPLzT?&lQ7lwH&NOmt)1o zL8TnY{NE0Y&q3{~UW{c>fZ%YDH_uL`Lo^+)(0{xvt zK$m>2h=v;*8}#60LM`akC3M%-g2m9Csy*Of4{kPaA`297UTC)jYkj@QCwm1`!+Lm=cZWZcT%Pgf>GSAb}{9#-D*O&Twf4@GzRQ2d$Y&xx2IRhe*v?}oF@Dun3 z=BQU3_44B%G&w8cVDygC;}gz4j8lC*X9@=3x1q_}rPELx_ZHJmYu#!66KT@U^N z=BfcRgF`wj-zh@sGlR|I zL(W(f&l}J_fgn@^bAT_$mJ76(h1o5=ew+_*eEYKNY1mNy8d3-lTXM;jz&8N;j%k0G z+wI$dzL$-_@gFdtF%NwNrzS#`!5H<7HOfjLV(KOow%}GriF0}uenrmaX>b%svB~5+ z5E5An=JwaEZ0~%E;%uWo?^%zj2X(?`N7Y7%=KTfGe0$ccD}G-_By2$tWd!&=0Oe*S zo#4^NzS^Gtn3~{GYxcswz)K>n{3ovS$Npv< zIi8SdT*23pCpI4MuQ$56U*V5m@k06TH*4U0PF+eqkta@j;|9aoryy+3pA{_-wfLmt zcK-8o5r2_mn~&Aqv)MH7(Quobm>tu*a-HGwJtP|&2Q6GdQwVNe2U%S!IBVscD3Ti7 z)TGhPlxmQ8N#x6nqf8btI`Eb^L5XiHci-e1}UOx|PP>bfYHUbu=mwv(10D zd8^Np_8JlaVZGDC7~A(9=h!aot8z9sYdpE|WK9Unhrec>Tq|XKM5bv5Sn5_+iZnPG zg0-ffL_mgMfZv6Y)4|+)I27up@l-+kN4DFL#Lgfpj1B!~&$1%VQov$pe4Lo9gOA9rT{y1#DQ)F`o@jFs(fm`=-YGsuE>v?vl)V?ilsc5=~>Uu6#g;|y( z0ad8%YL6Mw4QbXl>Q_m4?qVKu5Hh`A>CoJ$jobv?88S3s{mw<#<}pFTZnwHL@Kej{ z8%=$4+%IF{yK7s9IzM?ec_Fghrd$PWRNTHr6OO3;W8RjprH@kl++tF}uul`L-m<7f z_@%txwu*GBo`m7aujk(G4@`jU|MR^7Oy~w!`tzVJdMWzAr79^Z0fua)jg3Ys%O;tP z6spPG(%d)=Slz9aCFLWURL$z5dJ8Q%qJ$5~++L4@xk`k$fvRBBnYHx!+7jxa;MJLq zpP+M{AE*KHOC45y2%NIoEF}P@tsJ~mgV%xh^RS@l?fb3#_|!?y)7gO?0W*0EdsmF5 zG1|HL+l@^MXdF0SBS$tpmh&L;(@kR_FYClg^MUgv#})##D^Sr+dq~dY8PRepxfF#4 z_n!}2xHw`Jd!5%gaKuwb?FH9VOD5;XpHdC_Dx6B}5Pl|ZF7qRJT>FV6q-%IoO{lrH zXzeHDNTtZ#OuE+ANI%)xa>Q!t9&PgmWUUh?m%X!md_AVCfww`jwMJ*ImeE#+pSrn3 z>RslND>GC~RZ6w#lsJ22$f#SOU5#JkE_qWmzkgt$(FXY|s(lJF4bJ3_)y~agd0^`T zX6J-~vu2Y7Royz(ecA#XP;7M+)MGZ>cbhwZ5*!jiq-8WA9CRc!FUZ0Kc;i5@0go-2gBP>$X2;b|5cK? zJs_p9e+oK7QXHg7lM012ndI-!yFE27+~!{Ry3lw6+7)aj*#$4e(=3lkeU$sLk*2C} z?i_O9jm2OQmfMj(lnyf4kOlh)1X_JC47ME>a-yi^4ZEhCYsrqmXf%&K_Te!!W?6_C z4mWysyYfsZ!({$zc3DTNltQV+S6zWiXh!QX9zR#)xeo=Ow+DBF1kvFt*=?}w;5Q5QFebfB7?Z7U6PU7{ zH`%y=3Snxl|853q+62`kExhI~n93Hu)!6C?C0vngxSQNRW8&NMz3=QW9*7z3&u`S- z-2Oho$*TX_YEzNj3GrE;Nbeu7MtDwd0VAKz7HaNR`ecOO4Je8U+w~b7uk*Mr?bvR~ zR#xJ+xk%3OA`#owea z^@%1>FW+8JZSdn-I5a#GBj1_K#@-(I0%=_eCr`XM!vFE9{0MtbhO9y#y^qSlKd_UNSq< zYy!za640_1q_LE@jjjrS@Pf*(<%K zksz5aW%nVb)c&;NO29qy9SQi~1L|-w+ zg)!F^SB0EF2iqkU3_`oyXz9|9SubesP+ihcJle{7?K~ui)_*hz+v0b^OsN_DqBZFuDHN4Terp4Kex^kbivNehA%@eQm(G z5FA3|8oze3RDnrl+8^33^rH2H2*Qb4l#(pvnq4KI*Sp1jVRyqjH zA~t+>!CYaHnKYzJ(5V&)T{=jkxqG|2zw}bS{1B3mU)s=y7WfdN?0PNP-6=k%*2%$g z+W)9q@qMdVWwj>73|0RR5>cCubHN%L~%FoP- zp77~lyk?U{zs#|)JDUW_=f(Nwp4yzKQV!+uOW6>zwIM{89^S|@#v68sHL*1xFKsF6 zq4|o*>}@*(vrJK@8?qbMu{E=Yb_F&gI!d6TaI)1716oC9L{90k8|Y@q0&VxPnJn3Z z{hX4GTR%R76Rd|JNqp^qr+IzAiZ?jWPe1AM^XJcaFoG<*Ky}lGPRan)^wmsK84hL| z{ayC+FwTnS_VHy{V1#Xk;0Uym6Q>*u&!4_@fCTEKIatTM3N?^)Q-SGW2Yv z=FlfliK0O}yZF6tsyMxRy1L@bszm)pm^_1(v#r7fxP z9YI|e41W}rsx=enm*b0S!yZ}LGn8KJl+B>ARd!ts#vijM1q-$Hk+S12_S9M>+CGk? zt_fqY=uMmnD~*>KE|ER!6Y7g=WOFLTSa2&UE%b)N5*d0mYw!>=) z(M=Y7pT09>H%k1#A{55tH&uS&9d(_==1-7oHq2?d#f1F5%F+gc4SMkfeNfPSp@@*P z+jH7DlBd(AcD_fDLt{Rf%#=*LcB=1}dYsc96M`(#lZk%=1TZyh&>KuwctbEXL_lX4 ze;peh-d+q)ofsyfJ|ysFexa>DusS0i{4hGSYA&@@^2R28aCB^7s+_~m>vf+U`>g1~ zliw>xZ~3iXlQdTDxr8^UGv+Q;`d(-E7@5U5+A`nFa;fpeMu4DSCpKAXeF?T4JzjvL zs{1m493pOTm#Tf3Arf{j1bmlGQt9+@v0G)=U26#>C+yq~5+Qx0>f#Bp z+r{(UsQwOwcN0F4ys>^&C@S!^nEmp!rqRPtF2T^W&#a7my=c|LX){Wt7oTOdbTc9d z_cK4e3rd{0c6yvI&2YS-eD2jEI>WkF)R&xSm-w^KE^$rRHt}0->00`9f-UpH?vMDE zZm&Jsg_~BWQpShl3VL1+`~2Rs^Y|yp=^bmglC9+ZNSliq90|{Wl#>k3Xb3gG9{y=L zXhmcD03R4~)?6K1ct;1!rOGTQI=7qTsek?af#p%b_rg1=7`=0?kA_{&BTr**oJ0Ut zCQ4{Jw{a4D+07LVe=Gl&C$*I-EdzHd@HYR8wzm$8vTfJJA3{KpQt47ckPwiTREClg zVL(7il#p&|6e%SHq@#Bc~?Q)^hW%9zlvc>-oB0J1Rr?Dbg7iCJByB z3((1hQM40ub4H^XO*ZCKTho7i)HoTqRfnG z*{UZyNo33X**`c~Mj*p$cS*ZrpI#M$s2ZrNS6XaY_PsuM-w2F@k_l5Hu$|Vk6(ZeU zd{bAo$!A+j-@MY$WUix^QGLX8M(^j1b@iF>Rl4yrRAZhFv1jf^()+)gIA zN+flBdq^D;&rO#jo(=!8m1pi_*@gFrSZYf0=sL`M>T|~NrUEBmB#!kqXSR8e9!ML##PeV z2}nZ6#K_YPO^Z5?zDCRp51VNyb9uU$F+6Xvx>v2>HjcjmdMOQyrB4hXhYs^&g1YM& zX!E!s^=N4S&d6t5^H7#1S`YKjTCKb49xYJ_ck@u~rttLm>>-C&>&`M%@|W#?c~jWM z?z4<#mtF8k+LxpkYCMsOU$E~Ov`($XglqunFg|V-v zX4~6`CXp>%eSsSHEK0>M49@IvG9S^6nJ;yjna*U@(YN|R2}p9+ri;6al~+986twF6 zStqWeGaz&6)5472?A(gwRGYX7Ty`hIaAbHG4oK^T2ya!6OXE*J(oiis*x5}b_@$m1 zIBPofrNv|3($4j0v&DAH3B1`XNE+ILe8qM;wzCcYf$h=4qxe5d6mR zYjaWd5&3jLIUs#jqL&4z9VM%9T&TGtL$$+B^G4&rFdDK82SQJw%oN%MZ@xV)hr4UF zJEuRhv-6c%d!GN~gaKL0v`8?<(nbv(8ns&T29}%qeAEhES9CXvn>TGGFW*oj4m<}H zhiar!oVy=`I5OJqZtuy3iXqBS=1M=hHNmw=$RrT8T2pmHEe(q5%iq#dV&pZen#1=% zwbB=?_NvKXY^`_9j;Y1Guw*WdRQ1f2`ujSim?4^Nj&h2;$6Xc1KhR6zaz1K>5K`Pc zv^U_AM@+@Dv5b?92csB!f2`cC;_*@0zSCart&G${d#$wF?ibgj1A~Cr2hbbI#fsqx zsIonN_Ust~GCSV?V=Rtx8w#7;dQYSYBi9+e!M1q`y50x7_F(ut!aE}DOS8YzCG9ZZ znG8<0Az*G2S~uWoK~CdO6C+V&PrCvuBXUgm75eTCE6hu-NjFKb3RsL@`$_Qm0#d_k zM72+}clY|*y-~jdiog-+$rUY0J2r~31N4cFGNxguODFn~iJFXy0jbn?vkxO5Pxqeq zSth5RTC>N5WvE{-RGcdWif=%oOc}nTM|EJ@w>9B9%rEq`Er|g70C?K$9Ur42s$Z?kq|*TzDdZ>o#YAoa}`ouj=^$Z1u{ z?qI0{P5B>|n)Ru0Y>rwp*j_s9}V+700EYr4DD&P3Ax$4Y-kC0tohuIoRGGp$-qQu*}wTJy$qk{AA_a1GuqFbZPufm?h3Ry;>CAeNOgX%UQY*Y$aY63GO z2UeV0gfm%!;A9&I|0Ds8re5K;Zv9~`h+AhELOQ~-bAaq(I?(#5s#|ufUCu3nu%IVj z2l55Tuf6HqbWo)ASE05~JAO@FKNx`4)sntK=ppR%>%Le{a1-yE;( zZ>*E$El#xG5@8$M00lvd?zXeUmu_g`$bXQoTn2ahLyUUoY5<|_9&FJJvm?#r{~i^hJZ z@l~eoZSEfllUhLy_c^=utz%+AW1=za;21FXKvwwMp77^*^W<5Ml-zqdrC~MorQ0#{Jjrf&Ig?5Rbpdk02(i1pn6mU^^cDmlx-=8 zzt)&8v>ye4uB=~* zB#J_J@Aw5wygGl`pD0i~AuK<8tt?&_{80m(O5`1gJdhrNYmZITtvD}F8@LLaV}j%e zXA4(wMY8e`QI|}7s+gNp%al~O)8o-T#c0$Had#EQ-f=h2q-U~-5MX1zLwQk^VsxdB zf{qs%?4>KY9KZiDluU6Fmi0m?Bm*$H$~>06KwqR0+a)}wKR|u39^5kL7?rOCzm1_x zM24+{1J(wyZw!cItBP}zjhH?Hr**+LO4mHX8I`d&mQ%y^wRTlk@c(j_0s`2fR$!gFIxnSFc7?FI`1K#9e!z-n7Yq; zg}x_3bDG!lGL^PDYTD^==t6@Fq*$dem)g#td5=aqpHjm}YKI3e%h!*A9*nES&|Y)t zwbxJI4QOR~BnPA>-DdXsbcc69(pHRWNEeY#@Z}fUYKMwhRJ?+Z?N-hSMCW_W!pvQa zJ&O^VG%-gqeMVH^onfsuiNlrQByhG{+OSQdoFr?)x)a2ZqaJ_CwU@ycj4#aMLC)}# zZXRaOA1dmpc=GTr*pp1O1YE(rr`Y2W#jL^6bg;Cx_Q*csk8Xueez8{vZGz{`I*WxH)XamKnWw`>^yjb%+d*E!tNO*P z2#;_j0;-zmjF>tBhDa7Rw##_PJwFdiD(djGOEaK@yfsp&k7D62;_x9TX{ah(*88Kf z{sx6B+u*Ev=JBUzvfHoZUzVSHP7D#hozL{{`!O-U7cSo#6&5EZ$0(f6R6Iw%b+?W;% z+S-&hUTDHNgGsMYKBbCj)!m_^N~SymXW>9OOSj78 zYfIvSSMZR$Br|WntGf~*#OON{z(MlT9(;>y4dZ7M(AU*<;`CScRS8W0Le`u(W8!C$ACH;V*h9uHnq5YFm;d+aOV3r?7ShsN?~e z-!CAB6NW(d98~Jj8Bw6h8prXrM`x5jK#_s+74s0u)L z4%A36i~Zz%evJBK27%L^sMUaTNNGp_FKMRhAR1J#SW*uCg#%3?YpCCd^^d(%;@QyBP8&z2F~trVdc;CHA0N_HAiibM&)Z%)Y5e2!d|^#Sh65guT#bG1eV;bM8EMj&CscQWOU%4GcY zs8In!=&hFO=~DeCZm;Sa7ps)ygxHU)gIod$BIFwg%ZSt+gE@%WU6N!(mO#FwNO9p6 z83HrBz&&I!-^nw9QL)m_IXuXJy6eEz{PLq0sLJoi>mNlSS%SLfBQs?y^|T&ITmA;^ z(M0#p&03UpVyk~RYZ#x(l!}v(hcuYKEx<<(>ZU;b=j*=xzyj8f6TZu$cL|bww2^E# zL_u~0+Q(n(35$|mrK!lQ8&W(wC_f)oJYV3#qhIpSQ1*~Q-{d!w*uqnPfnu@Y2}GO4 zDGRt`86hlh*71We4jm{J)h;Rr7KONAbG$cDqgE@B`By!Ko!0hk=rZ)B<@(oyeOWuq z&H=RhlKJI{5LA-WYZ_&I8B@}Fz4yW_!`R2^p$GFc1QIu>wM=h@YWQzyq~c8~_+P%q z=S(!VrT*p3!PX+sHP)8`#AQ&@mRfrrb}xCg_GuJa*8x>KY+CEKJaTqS{~3EZ+S@aC zv!Zn8bhoApt7(us!C{>9&mg()`;E+?EF2@vIlL=V;Of}2s}extk-zQfT{G>aK3(wb zZ!SPVNz)ySLTMGA1ii=U+?Sb_>%##-8oxk+I;q{31oGuxecu#>$~f37?c5F>5T5hV zf=o4KPKE3QyeHapk1m^;a*SR`Yeg4#$3sKIwhHS^Yu(qY#kJ1dmKSs>{bDGOZtv zp6WIkA)Q=$a>Pm-nvlgZNCAR<+m!=JdQ;}HhP2aIbgj>#M52S1IV~6OyKSena7i`1 zV1}EfWxy@`^`X=otmki0`P!T1R6KpQ{yOvmU9YxeZ_iyVignk9R7X`mnadtLwgIHU zIX&IZ8!`nYUH8XKW)dHmM#E-Y3)xFCcx2aly{>?6edQ}S&Tg55Z#bkj69*Zrm@V9 zZG!-t%#&#fGa_%txt1TJ8W0O+{#eVrDsF;Q%vqM)W8W=c>##2b#VTn;z4p=q`n~F3 z{JC!91qJO{*nqwcPYqQV8o59wEYK40KDbE018`{DlR#>ep+xdoYQ-2!DJM* z{A772qV1eYX`}BcBvcXlWh*5H7{@XR724?&P_ zstgNeXWRQD96M+U(=Wz%QVhH1MzDW1(8@g2sD$`8-q^G`vB$ zd5=d1q#vk|HW15;^^-J;I>#^g`vKfeo<83>p=r{(rE#6oBP}_Kx)OJ?wYNJv&~-8e zKF%Nze9-i5iM?VbAe;6Yoep?@>utMYMaemts0%PwDa^`IAC8~K!ZI>@w~R*!Z5KTK zBCV>XV_OxiJl&A%wLnafZ!|qqN!yA5ot4DiyJ(Kgx8QRtCCRmtcQ!I1Bkkc5DseYdwKJX8Lpf=a4KX zkK~3HAzd>knML=~hTk>2%{RTlwy^$@WI3@|@GA_DCWG#U0m*DiaKsI}mD$22KcPgE zj`Jm)jYDc#F9}LG*?WE_g5W;1YU=xC+ zbr_hgJjm%U#n=GEr3+8cizORiB=us>zhDFq+k;ps`BzJ~#twQgA!(P%AUSdYCZ6jc zv@T{5PM_UPzq}+x{76}8#Aoowk1yvN`p|5dlz`AnwR1|s zW1!XS@NL^S;GEB&tAR3jgr%xm;xQ8gvH5bT7I$D-Ar{@t9cThUy2f>myI1D680z5N zTBI}=fP?DaKOg7?F%W6*U4V#NG*O4Q0+|(PX(Bz&HkWnH=8rt61~`g&0V(nse=BqL z3mG~npl3--q-W?TUAi#;!fyQzt{mhdVVA-U)Y{j7LT&UG2|npnoNLdy<(T1VtTj^R-%}qEi2{~+MTo|DyC^h|=*}KT z*tqX1aAxN_E!dZ|=RUkKL0z0J^cKHqT6Zu@->3qo{4>hpHc;qMn0)SM+bAuS&7NOC zj*z9r*k@cHxy_cJ9LS<@ITcLz2|(dGi&wEX0E7x2`TGE&uK^nCE@RG=+NWT(anFM1 zS;3w9>&wGtN$~OhJE+L>^xwH;My+Q^_>UjDa9v%PnB7=u131h$XB`%D*$0Ga5scy+ zV4x9DO}%rLX`dl{qyXUqa=sup2P!bDN7$D0m#=q|{AY5`Hpt1w3@M$kAYtrjLTy0M z^FO#jNkFWVt)&n2NuTBAIR49+5M|6T*vOZVJLc_oU_gJViG7VOEUcx){BJqV6Ej=~ zEAH`w;_nn1b~2j^fB=BeSrLrs!!cm!RLL3A59(V(Kt)XlJ__zu-5JzhQ!J$q=X%p| z0$2?sQb6(X=hwMpYkhzeQOO&Oy`YT04d=fc6At>$aNvnNyb$)}F(u(V4onc4`YVO@ ziS2v>=2AI=t)*SC`Ztb)tC^61K~A8^3(I-^pDvBc04I(JeF{@Us!Cazf=52QA|;tQ8VIGdhN;*R7P<%B@MxRntI!jOyB+{8(^Trqp4!V05lMO zci{-jN0kgJr4>w2oE00-4e(?cokhCtFybmnHTS(3@A-sf3w6qa6&~ZQbNS;s588u@ zEGG2%)4kq=!-{XuzN8foVc;MO6S54#97Pk}Ddop4-~Hh{#kqMPO$cuP-|G#k3w>vi z0WK9!VSY}6B=(k+(WFk?M|J9$8o4ZW5|7l^yHumIjsbJZ9{)EC9EBJlgNUUD@GQ*y zC;mB@2;vlsJRY1-6) z9fH2sOU&!>>*7`Z&L%c?eH_2!w-7(Ca9?6z`&ZfLqP{X0F3YlS#BfClO#+BA%(@z6 z7T5Z_eKo)atE4^?4i>TTu(v&M+c;?IteB{j1X#EVmhJwtl0sL`d`pP=8( zc!{(Idevsu+^Zf!I7p4&e09^xDzR7Do-G7btHo@CYgX= zfQ?ks?)moXGram%v7jo!OX@#n4#^hSeB>7<#VSOH6}hD6!H79&6wx<#)U9@Bo+<~_ z3J}*}bG5Z+1d$ z2Fg5wu?Gs}0%?k{h$UcfGw%W;`tI9SJ+S$pB-x+f$jt9LLc^92vl3W4ZwpOPc`%7Q z2f~Md^~mbM1bgxg?TnR+54%SLmYMp7>3o%!p4V;^ucm?iTeCA$rX&e$vEnnER+~Q3 z--Ry{Xi0o9XFnhc2bPd(i(T^yas~VShTC$He!BOf;H$ISCc@(kgv}B_&Al9Ntq`#X z6l3*UqPP;JiY1<+jzfs$mQVeF(<>2$(fcw@gOV%EqWn zQ3Jp~r`H`-gSc$~+W>&6BFH(Z$hg2KszY3g35Nhf>dDmvvD8W;X-xydMvK&C<8*Zc1g4f~B5JXi| zLMO)_9u|TRwlN>*MJ16UVk-lMWe@1Uu}cXS+>G;jPag?JoUPHndu!n741fZ>mJ^c| z#mrs?7}nwVw=av+-I0KdfCWe6u-+8_sN2C&pqo4oFvd+O{&HqGL>w0ev#_(_q7}dl z!$rG9Nb|EThB*R_Y)N2rP556s>|W#IK?|t>)8%kj)Eau55ex$ADJ6n^1Y^4j5OB~H zt9>Q&Exm;p7;UFQNeE8$nGCfd%%nI!|KVTJPtjc5B2G*eOi%Pn#mWYrvh+UZ_67Qq z$)y%_pDOo1`glq<>z?nYe#fcL1fm>J`U zf7<#QP&}Dqqi#TCJodTM(_ov}E#ZBy=k;*wCAtAh=l`MA=UJXRTV(<>nm{WMzesCpEpipvVlwb>Q4wcOb`=7VpZ^?idtbTg?yy7Hb4PdX1D?t0M(xci zr5ktJk}B>{e$pM@Ew$);s%+KHML1^lVO~+lb3EEg@5-&~nIEsStrrAD+n#M>3w5BI z!22JLf!e;$6||smDb8i2FYeS(J^-gM8xeZYSaOH**tIj3)A1<~;%u65PHie&L4oq< zTiK1;jdPG8B!a)M^3jAKQXTAyX0R(rUNj2#@x;%^C*jQ=-2JMcOY+}=c;LBjd{18l zwt<1FMjvLm=K)3?0!~T5CBkMy_(_n^!XHqms9mi!?d3~U;qYe#Qllw=J^|G4s$O@P z;-yxbHNTW0-G2~9)OQtQ@}y$u(%E6-)>2Fa3eZP4sBFH&m0%7;PUizd;qFlge;OnM zBo2}=W)&&Kp)>^Ctpe=CgEBe6IYCDso&*K=m;!#NO0n{Hev{CZMpxx!%lmmdU38GbEvTNeWzjlpZHP|wkk%zzBd2eGcKt<`5HQnT+7 z&n6}&x&};L5)Qx~1J&?n?RzKo>5J~6%vz>w*Pjd0t6U<$dVUIcZ+JA7a+1i-Ao=Lu z>i$(BI1X1~K|uky>0uyXH}?Uo3H>wcmzSxM4x-9zAl@uTX2uh!4Am1(me-TQWrzc* zVluKXTR|$ovQ!uQkOr1iR8?hMn5Df#sZJg9rtAB6?D-Fp#(+hGHJjPf!v9^D;!s=Q z3SHZvk5n?Y=w`<`h9P3`r=mfGLI=mG23PHk6%`aDKho3l2thb(N|%Uk-5s$0aV}7N z#&>HM%+HC6K)XU~ePS18+Wysj0jf~o{j``0O3*7!D_iM3$?Sky*o+-c@83>!5K^I^E39{$g;aP7Zzr941@aW!&jnCTW_Csrt_k1IxLa`Gh zFF$Z&S-3LURMX+^_>d_abwekY&jk4LdBlYNpS`>lX;hbcIt}O+bcXytBC6hW=)>lG zidPX~$9PC8(D`;1jx8j(=$wjZ6i8Ng0JS5ZJc`#HF@Wnp6C;`&+yx#%SChbaxcXDX zZF;CJg1%e_<4sBE6W%cgGDESg=Ny*`09VWYqB-MP_EXyA%6{ms`!4e2v6cSO02I~J z=#aZOGqpz%;E>Yj-klUhb%491j)68=sBOP7gKu-RS!}E=-@27<=p4wGUOs~}>zuU+ zM)e#^X~So-5ba?dkY^f4W+}De<|7l6Mg*V+^@Eut4p5kqtEN#pIgY<_+9~@}qPOiT z31mj}+rx2N8IKRIKQ-oU6E|B1m>iG+uCf6w0fg08L0fTE4#mjmsDLYzRVGjYB@+dV z0W_lzreV)s%42QpsY)qYq6!ZQ+HO3aunvlLe$3_-F(;mEfiwG!aso$&Fp*o-^J&G_B8Oz~20d6WNDDll zrUNP$LEy8#Egop?hm5h2(UGP_w=mnL6BvBTxixjh+CobR!{&Ox+9Ym;%|C(L1DeHX zd{cp7uWj`yGg}gIlBfJ^7*UsQn(6e2)5_(OQI@n3kv?f;XnO8jf^Q$xbTeXBdPDPi zjfMsSa03-C1g+MlfSM~6&}Fm1Ri(cdaeJq4i4e(4m0hxe?ho(&7%E$Ht(tP_3V_xI zjWpQ1g2|$z&iDIYCKQD(ekeF4d^@YQXnKMysS}krEe?@nY>9HOX1-tLO9l!2mDYn+ z%gjl{GiU-&w+E1>S&qXV{ zzk;gT$hP!FGH5qh#Ac8M60=MPb22l-fD%bnP9~cm{5B2#VL09unMXOGQRo@*5U#Co z9NL8sAAu@3Z%_>p6WA465oX0ND^qwYkG_TG1nBzbj^4in=Pa4Knks3^)5OB*YgxYk5 zjrA%yGkrTchmzO{uZAwWT%8LGzTA0YWF*2}u-1^T{I z#6ikz%*UpNciicYGR4b(Fgyg=oquU|f6MH~6CTGqn`-HJPUaH0%#@Ac(zn~~zr3I# zwlYLj9AIh6!H1)v=NFNo5Ys0Fe_N6TxM8HNbX;UHjT9 zPy1Y@Sx(Odn$Gb6q4Z;7D1a_KEWh87QFForw0&YP_LCAloOk5cPnXRP{`p^G&Wj5S zFcFb|a5iMKSK*Y}*#BM7sryN$PxmF;gr8)f`!c4mTaQWi^F`tI`mpd`&DDf8$^kW^ z$*3@~nB_l%-NjY-EC{eTTcdKW)Ym>=@YM!ZaugeT;hQM&2)`p;TPbcmaYmu5DB4v!+VLj)Ss^b=no!Ba@YHGMXogObfif% zX?z%!W0uSPgv5!ugPx{vfL8HbC~2dZF&#MhDUDz%^?b7R2V&`|D*7kyL#=Tq+#1Y9 zm%2vsG8vkv8NRB$|6c&l6oA=*lL!FM*Doc~l&{W69=>KL9!}`^185zHT8!Ds<$?ac zNFGt>R2-j%5NOhmgC7Eh&nXUDU~pLT%FVp`m}wZ>wf;z%2y`(;7_1)oa|P};|KQ5} z$j-Ljh$#_iv%?W?@c#=`;9Rkex&nMSkyAt1SI7Yl=Pu!w+%_X@e(k%$Jr}WD(Z#~8 zdxq8p#Zd@AoY>EALh^AqK~C#+}pQ& zA-~yQtK9#ApuRjX@~dL^@txNRD~9jb%!Pd{FGapHY49$rGOl>cPgB@&-PHr1l!P0J z_xs0xZ~^4*Db~P^R-^9~d}Y0I-=FXxhEOn;ld}_>`k`xJ;c?$s#(Y zUA^}p6;p2&=cp;`+M8PLWH4<2nIW9#=!JX3za2UJ?j1#K_q(!4qOub^6r7f^3vQ!L zOi?-&J$A_MU6p$j3Xh=BtFPW#8dP$1-HLL;85IB&>*Aj`E1h}o*F^Ly9@}`V!*B7CRhfIFLL%s$}hhmVsBC!9M_>Nyavi@Ls{I0?{b&dho8mkpkFY>cg=Hd zV0l!v;5_k|xin&Hw|SQX(G7oHFjiq;czEaGv=?N?<2>i}{`<4#(*(DWZ`R=vgjmD{NnuWA;)@~b({isAWZ*#DlRBYa-|JvvxCL%K2>cxk2fLh&9{A3OK z2F0~h-sPF=H#8K^Uz^(4AT8rVXL8H;-X)nF5;?Ioj;jvjBD@5{)RAOll>jyW(Fp^#5TRSu!qnE5mU}kIV4&IQ(6&Y#bYDQT{@~O9L#JdgOzGZC_#A_-ql4 z0|rh(g??#PqK!uI_EY}VZRNd=qbw6nn+==JzU_VPdq2JXaK8iOxLjs_Z-MHjbU7sP zTm)R)s*)$g*(N+qQ6Q-U?+2t0gnZ zxKj>tRsm}pn;UjBjeetTk&MKfy#$a>IB5u8R(FaxCVEJuVGNa#_}4Xu+q^fC21)i7 zxK#Pqnfd%0LvLtrKC0#er(SSaV)J6eV@m?dO66a7?c}HLlGr3X^#Oa7gjSI36(teJ zx{xsLppyfGa4(i)bS@1K`PO}P#6Dp=9Cx4}6zIw(dJ;h$q&-{aW|qKjj66EEuXRQ% z$wr<7Hci&u!-Hm{cJ*eX?D=j%5n%f2ssKv9^ey&@WwhEvf-47Zcj-jS9xk~8KH`^B ztkHXGvycy7veJiu-x(ln5LD%k?K-Y8-%F7mDpZ%9d1@529cg>J58L~s;X3%`>&n0! zI^j&5LAn9NBn^(v#>;5m9qBDpM$D?UuI5Sn%9R0D}9p+GF>G*rEw%t7bJ*t;7 zNfsN$k~KHnTsAp9?$t$_drP0-AuynpBkw#ZKMd6P#3ffKX@9x;Ps_?$%>Y@_g3q_o z5|f!KRH(Mm;JV zjx{W5OEv&^B+p(;XJh%u{da(Do~$)*Z>(Dvhte}T)mXbeDT2UjV7Q=PY~=zl5|p?b zNUzMBS5n@l?|}Y<^HLBKANU~o>zgSH_Y9?bdo+_G_;61{nv>}X{uYaU%#F9y@V1{d0*6Dc#GUFR7Oj3_?REZrv^vHUjm^S_yxDhr?2~M)s z*+~Wp;vOo8CexD8#R9!TxgIG3Xf7C-gM!F3N5!;A z#mds3?ugUu?(Fbie18h_le~WC^F!a5Y_Dstj)1@B!TIzz=;!7MPr1}4jEnRzonV!h z^h!+pzR%9i9vc?z%7dwdj%WU9K)Ua0CvorddzX5qIE2e*gvxU^{Dbzr2x@MXb6$Jp z+HF_J@!smHRfXZY=(SguF9f&HatuflSaajf;C~B0TD}HTR%Y8w2-tYycAk}G-H-^1 z>Fz!p=h?2kDzbS$au;VSZ^gym%UMh@DCEeo`98{xCld01ihbhF7VF<*A0+o;MgTTO znZ@e~@X14}u@`Y??TIs!I1pG304?mxJENve!eA+~Y#kj`_|oPXPLLNw051ri(#Ta%;VN&_lpHh8D5QW)^m#^c@0azLaW3YoVlI@!gR|*4? z!P=~`rB75Ttq$g`@X#hPWf>V;J?_jwQ-8S&9*^_8t{KmPo@8+NNl$sj@T+N*?m z*R{SUJ<$dJ4TeP{Q=_Av9iv%5a+(~#u&&qt_2(p$4qa;MIl9V*)N%%G+f%H>QdXKU z=y+w>-I&lyRP#te*Zk-c1CPV^qP9_KD!Jp|Bo`b4n_8IDPvVu+ z!jmRFlAqKD3HI-c(JbF3E~7l8Cz7Kbvb+F$Bx~X| zXTj=ajr#-da~D&_c~K3#uQPqxQ*6Xs_PjRy?~?qqx;!qcF=V>Ev(vCYVOxT7sV>Kp zsIQ*b{pb^3SE4es{khZsBVSiH%C9!cha0W#Hu=ZSv$Vp}GInlbF~{civ`YDe8`evG z))E)#y67s)3})##|B zJm4cHe&i5ZCIX8B!s0wPPtO4FPw!o7d>_BhwMrWQyn!VZu9H-a&1>VX0(!19aoaA! zq?R5=IS&qsIWpdfL*4h!_9%(@4zQM{d)wRF8->@S&|VwZ>%vBsmQuDA6QkmGV@{_J zEok0+qXlkCZtBF^^Ry<}PgFG)b%e0DwS5zHdnI4I_Q)}5JTMyrVmnrr+$v%y?)3sa zSrJfkl@_iWKnY+rHn65yqrh#`RN7CDpf?ty4J%X!Svge8?4QNrmn#?OdNwS-x;dz7=m{nP1Jf=Em71Aae0 zzpD4+tAipk&aEM26p_U@Xx?-wkeJ47uTj0xQ4NUU=*-DlMN43lviHecc`iK3UxU;|Z=oV2&B;P-}2*vOzi^hdycBlmXmks2Xr{d6%+9jg#5j5;Jfg?YG65_~@1= ztcLnRaKPK`2f{}d1%<2f7C*9sgz z)&6A-JXLG0+M}2qS^tFZAKl9tbl&jy2kzFd!tiAA#(DB?GvIS-ju=!ESCFhz9`_Kc zxAW@ij$Ry=G2Y90@TSfb&>q}AXH%$x5Z6#!u3@_nB;pON1YasD8nVD#+nQLtBEyQ6 zL4eg0Feu{QI3VEkwyHpXzrSN|6ccVFKjyh@%EmdD4H9*b!7 zrOr+g2Hv={6%k@#d1_;6#ihEbrz+Kk=qg+L;(cO#M29XuL>I)-TuD;AOCrV5PzOlP z2cYfu)b&%XH@d#hYp+1d?^$#?_q`7;U{#s8VKX2$gfK zYH8)mv2dwgd-Zu?B`#Le4un5W!*Kl*{f5Q_j?P}8XPmnQP%fC&Mqpv|Fknj7`x~|X zqX7Y%#B48}_asRtZKMU1Y(>l6?kVANDNazuwi#bKq_Pm!$5Xcz=|j?i8M^N|Jog$l zs8%-|3*`JQz6arzKaAy&i`x!NZt$P~9^d4_vzx$g)Z5=b%Bj>_XS5O>AmaUrvc+gc zt4WgH;Dx~wjjAiCM@~z)n4gR|Ille!6j(z~wL!4y_C(yI5UwkxPra4=nryOmW2#gD zBC;(zJarPyL6$V$#4_SZ0EN3?)+s`A(#IE_oBm?*$7*3Z+F$zLQf1N=s4r&maAr2qELGSmWPAE7~ zxY`oBz@GxC4$^@5*u!o+V=yhci_@m(z33KcaEnH)A?lsv+M<~CF zY^&sP3baIHxn7}tj9YHqOtstcAg|I$AAn`DVjDS^>#9`aJS?y7eGt+537`{=M?WuaWclV=H=Z^**C@En9T%f$;RI$=+?5lkFiN z;65=R+-iurFyps}@^5GM^mPWp*K!_v?~_jw>jHYZ@2ST6+Pa+pH30vE6@8E=@O62p z-0N90@x-t&G4a6*;lIz#ZW_3owOxrr~6F@<_R4=8MfxbfSPMmYU4CQ&zZ~ zwfaaI1Uqurb;p3C(TxG$N&Bi{&D+b_tBc*qu8t(;_Z9X$ur43(SLZ({Slc<72bUq^ zyHb#6Vr3~M>gHUQQF}zKmU#1IsOx6kCr3A#|8cze|N4bV-U*%n+u8>Kt%0f)YkqIH z?EM1WM!|D27 z&YYQh?tJ(AJ-)f$y$GADudN#l`Fyw|2U`XN@3*NlLy#*@K*5lMJPq#(@gb?7A3ic5 zOnSR;zAc7!@3`Ztb8pk3!l=xP`QzK*@pr?!JrN{+Qjv240HdEX>wYq_w8LMvSjWFE zZ`0V$Sc0ASqUPxlb0j08KAcwuHXL%nSj*XXVWXvVaiKzTeTfShda0ovn1dTt0Qp)TL@B93zQ6DHZM=Q(=r)kg|Q20Aa~n0^M^IG#I&?G z#R8#3&&R`^tr%9`BWOLUHu=k*l#s344B42GxuT!2Z-Iu2p(!b^4k?V^&17(t;5eH= z%=nRF83QYejd88v`zt3jx%<>r!1oP*uou||>zK61ing<<#jHX?hqbdFGY{bZ$+L`W zU+lOz&xwJ_1zf@LM z4$Nw{H89q`t)sF{*fRcs_o=g31kCTPO0X(?jd9npc zt-PsL`Gsn8Ngauh=5u#S7l-@jnV2dHqWWV~AI!zP&+__Qh)pPlrv?qZ3*Bx^wi8BP zBY^7&C{fNBv-$NwiFPk024(qXT0$TC%e${DDk`k7?3pM?jUe6UvDs&$c0lB;FW8kTMk3o0(a@?_erDDrqW}(o+=F_r`{%Cut*%a zX#Z}S>v=mNhhIS+SRqj#epAgV@gJ`MLtj)Qm4B3o9!EEH56f%#<+ONv2 z#>^*FdkN@%J)R%ZLbs7xkSf`Zr^N;@|0n1UO6!Y@_Fvv12Y8S!{pySNeOt5UZbBZd zEkqYMJQ|0e}_?rrr(WpOnMVklR28I*6RP zF~@Z0d3-_)A0QP%(T-Lj-d{M?hD&}zdpZ|Rj|k9?LFGU!v`jt(2NUj1Y7tkH)!x`u zv7tHy6_#hV88$G7l)wMp=zQtTF>G1U5i9G#8#HrsH#jg8o%!qYk9c@`ra&6?l?|Zx z%H;)`wIs}|#vJT1RoXOKysaf7#?` z*49q88u!3@`3Up*B7DtLDAu&cZZa&t_kZNKU(M~6-=Pf)Klpk566PE1)8HL{@qbes BtT6xp literal 0 HcmV?d00001 diff --git a/third_party/pybind11/docs/pybind11_vs_boost_python2.svg b/third_party/pybind11/docs/pybind11_vs_boost_python2.svg new file mode 100644 index 0000000..5ed6530 --- /dev/null +++ b/third_party/pybind11/docs/pybind11_vs_boost_python2.svg @@ -0,0 +1,427 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/third_party/pybind11/docs/reference.rst b/third_party/pybind11/docs/reference.rst new file mode 100644 index 0000000..c275798 --- /dev/null +++ b/third_party/pybind11/docs/reference.rst @@ -0,0 +1,130 @@ +.. _reference: + +.. warning:: + + Please be advised that the reference documentation discussing pybind11 + internals is currently incomplete. Please refer to the previous sections + and the pybind11 header files for the nitty gritty details. + +Reference +######### + +.. _macros: + +Macros +====== + +.. doxygendefine:: PYBIND11_MODULE + +.. _core_types: + +Convenience classes for arbitrary Python types +============================================== + +Common member functions +----------------------- + +.. doxygenclass:: object_api + :members: + +Without reference counting +-------------------------- + +.. doxygenclass:: handle + :members: + +With reference counting +----------------------- + +.. doxygenclass:: object + :members: + +.. doxygenfunction:: reinterpret_borrow + +.. doxygenfunction:: reinterpret_steal + +Convenience classes for specific Python types +============================================= + +.. doxygenclass:: module_ + :members: + +.. doxygengroup:: pytypes + :members: + +Convenience functions converting to Python types +================================================ + +.. doxygenfunction:: make_tuple(Args&&...) + +.. doxygenfunction:: make_iterator(Iterator, Sentinel, Extra &&...) +.. doxygenfunction:: make_iterator(Type &, Extra&&...) + +.. doxygenfunction:: make_key_iterator(Iterator, Sentinel, Extra &&...) +.. doxygenfunction:: make_key_iterator(Type &, Extra&&...) + +.. doxygenfunction:: make_value_iterator(Iterator, Sentinel, Extra &&...) +.. doxygenfunction:: make_value_iterator(Type &, Extra&&...) + +.. _extras: + +Passing extra arguments to ``def`` or ``py::class_`` +==================================================== + +.. doxygengroup:: annotations + :members: + +Embedding the interpreter +========================= + +.. doxygendefine:: PYBIND11_EMBEDDED_MODULE + +.. doxygenfunction:: initialize_interpreter + +.. doxygenfunction:: finalize_interpreter + +.. doxygenclass:: scoped_interpreter + +Redirecting C++ streams +======================= + +.. doxygenclass:: scoped_ostream_redirect + +.. doxygenclass:: scoped_estream_redirect + +.. doxygenfunction:: add_ostream_redirect + +Python built-in functions +========================= + +.. doxygengroup:: python_builtins + :members: + +Inheritance +=========== + +See :doc:`/classes` and :doc:`/advanced/classes` for more detail. + +.. doxygendefine:: PYBIND11_OVERRIDE + +.. doxygendefine:: PYBIND11_OVERRIDE_PURE + +.. doxygendefine:: PYBIND11_OVERRIDE_NAME + +.. doxygendefine:: PYBIND11_OVERRIDE_PURE_NAME + +.. doxygenfunction:: get_override + +Exceptions +========== + +.. doxygenclass:: error_already_set + :members: + +.. doxygenclass:: builtin_exception + :members: + +Literals +======== + +.. doxygennamespace:: literals diff --git a/third_party/pybind11/docs/release.rst b/third_party/pybind11/docs/release.rst new file mode 100644 index 0000000..98b97d9 --- /dev/null +++ b/third_party/pybind11/docs/release.rst @@ -0,0 +1,135 @@ +On version numbers +^^^^^^^^^^^^^^^^^^ + +The version number must be a valid `PEP 440 +`_ version number. + +For example: + +.. code-block:: C++ + + #define PYBIND11_VERSION_MAJOR X + #define PYBIND11_VERSION_MINOR Y + #define PYBIND11_VERSION_MICRO Z + #define PYBIND11_VERSION_RELEASE_LEVEL PY_RELEASE_LEVEL_ALPHA + #define PYBIND11_VERSION_RELEASE_SERIAL 0 + #define PYBIND11_VERSION_PATCH Za0 + +For beta, ``PYBIND11_VERSION_PATCH`` should be ``Zb1``. RC's can be ``Zrc1``. +For a final release, this must be a simple integer. + + +To release a new version of pybind11: +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you don't have nox, you should either use ``pipx run nox`` instead, or use +``uv tool install nox``, ``pipx install nox``, or ``brew install nox`` (Unix). + +- Update the version number + + - Update ``PYBIND11_VERSION_MAJOR`` etc. in + ``include/pybind11/detail/common.h``. MICRO should be a simple integer. + + - Run ``nox -s tests_packaging`` to ensure this was done correctly. + +- Ensure that all the information in ``pyproject.toml`` is up-to-date, like + supported Python versions. + +- Add release date in ``docs/changelog.md`` and integrate the output of + ``nox -s make_changelog``. + + - Note that the ``nox -s make_changelog`` command inspects + `needs changelog `_. + + - Manually clear the ``needs changelog`` labels using the GitHub web + interface (very easy: start by clicking the link above). + +- ``git add`` and ``git commit``, ``git push``. **Ensure CI passes**. (If it + fails due to a known flake issue, either ignore or restart CI.) + +- Add a release branch if this is a new MINOR version, or update the existing + release branch if it is a patch version + + - NOTE: This documentation assumes your ``upstream`` is ``https://github.com/pybind/pybind11.git`` + + - New branch: ``git checkout -b vX.Y``, ``git push -u upstream vX.Y`` + + - Update branch: ``git checkout vX.Y``, ``git merge ``, ``git push`` + +- Update tags (optional; if you skip this, the GitHub release makes a + non-annotated tag for you) + + - ``git tag -a vX.Y.Z -m 'vX.Y.Z release'`` + + - ``git grep PYBIND11_VERSION include/pybind11/detail/common.h`` + + - Last-minute consistency check: same as tag? + + - Push the new tag: ``git push upstream vX.Y.Z`` + +- Update stable + + - ``git checkout stable`` + + - ``git merge -X theirs vX.Y.Z`` + + - ``git diff vX.Y.Z`` + + - Carefully review and reconcile any diffs. There should be none. + + - ``git push`` + +- Make a GitHub release (this shows up in the UI, sends new release + notifications to users watching releases, and also uploads PyPI packages). + (Note: if you do not use an existing tag, this creates a new lightweight tag + for you, so you could skip the above step.) + + - GUI method: Under `releases `_ + click "Draft a new release" on the far right, fill in the tag name + (if you didn't tag above, it will be made here), fill in a release name + like "Version X.Y.Z", and copy-and-paste the markdown-formatted (!) changelog + into the description. You can remove line breaks and optionally strip links + to PRs and issues, e.g. to a bare ``#1234`` without the hyperlink markup. + Check "pre-release" if this is an alpha/beta/RC. + + - CLI method: with ``gh`` installed, run ``gh release create vX.Y.Z -t "Version X.Y.Z"`` + If this is a pre-release, add ``-p``. + +- Get back to work + + - Make sure you are on master, not somewhere else: ``git checkout master`` + + - Update version macros in ``include/pybind11/detail/common.h`` (set PATCH to + ``0a0`` and increment MINOR). + + - Update ``pybind11/_version.py`` to match. + + - Run ``nox -s tests_packaging`` to ensure this was done correctly. + + - If the release was a new MINOR version, add a new ``IN DEVELOPMENT`` + section in ``docs/changelog.md``. + + - ``git add``, ``git commit``, ``git push`` + +If a version branch is updated, remember to set PATCH to ``1a0``. + +Conda-forge should automatically make a PR in a few hours, and automatically +merge it if there are no issues. Homebrew should be automatic, too. + + +Manual packaging +^^^^^^^^^^^^^^^^ + +If you need to manually upload releases, you can download the releases from +the job artifacts and upload them with twine. You can also make the files +locally (not recommended in general, as your local directory is more likely +to be "dirty" and SDists love picking up random unrelated/hidden files); +this is the procedure: + +.. code-block:: bash + + nox -s build + nox -s build_global + twine upload dist/* + +This makes SDists and wheels, and the final line uploads them. diff --git a/third_party/pybind11/docs/requirements.in b/third_party/pybind11/docs/requirements.in new file mode 100644 index 0000000..cb15ac5 --- /dev/null +++ b/third_party/pybind11/docs/requirements.in @@ -0,0 +1,7 @@ +breathe +furo +myst_parser +sphinx +sphinx-copybutton +sphinxcontrib-moderncmakedomain +sphinxcontrib-svg2pdfconverter diff --git a/third_party/pybind11/docs/requirements.txt b/third_party/pybind11/docs/requirements.txt new file mode 100644 index 0000000..0bbb01a --- /dev/null +++ b/third_party/pybind11/docs/requirements.txt @@ -0,0 +1,91 @@ +# This file was autogenerated by uv via the following command: +# uv pip compile docs/requirements.in -o docs/requirements.txt +alabaster==0.7.16 + # via sphinx +babel==2.14.0 + # via sphinx +beautifulsoup4==4.12.3 + # via furo +breathe==4.35.0 + # via -r requirements.in +certifi==2024.7.4 + # via requests +charset-normalizer==3.3.2 + # via requests +docutils==0.20.1 + # via + # breathe + # myst-parser + # sphinx +furo==2024.1.29 + # via -r requirements.in +idna==3.7 + # via requests +imagesize==1.4.1 + # via sphinx +importlib-metadata==8.7.0 + # via sphinx +jinja2==3.1.6 + # via + # myst-parser + # sphinx +markdown-it-py==3.0.0 + # via + # mdit-py-plugins + # myst-parser +markupsafe==2.1.5 + # via jinja2 +mdit-py-plugins==0.4.2 + # via myst-parser +mdurl==0.1.2 + # via markdown-it-py +myst-parser==3.0.1 + # via -r requirements.in +packaging==24.0 + # via sphinx +pygments==2.17.2 + # via + # furo + # sphinx +pyyaml==6.0.2 + # via myst-parser +requests==2.32.4 + # via sphinx +snowballstemmer==2.2.0 + # via sphinx +soupsieve==2.5 + # via beautifulsoup4 +sphinx==7.2.6 + # via + # -r requirements.in + # breathe + # furo + # myst-parser + # sphinx-basic-ng + # sphinx-copybutton + # sphinxcontrib-moderncmakedomain + # sphinxcontrib-svg2pdfconverter +sphinx-basic-ng==1.0.0b2 + # via furo +sphinx-copybutton==0.5.2 + # via -r requirements.in +sphinxcontrib-applehelp==1.0.8 + # via sphinx +sphinxcontrib-devhelp==1.0.6 + # via sphinx +sphinxcontrib-htmlhelp==2.0.5 + # via sphinx +sphinxcontrib-jsmath==1.0.1 + # via sphinx +sphinxcontrib-moderncmakedomain==3.27.0 + # via -r requirements.in +sphinxcontrib-qthelp==1.0.7 + # via sphinx +sphinxcontrib-serializinghtml==1.1.10 + # via sphinx +sphinxcontrib-svg2pdfconverter==1.2.2 + # via -r requirements.in +urllib3==2.5.0 + # via requests +zipp==3.23.0 + # via importlib-metadata diff --git a/third_party/pybind11/docs/upgrade.rst b/third_party/pybind11/docs/upgrade.rst new file mode 100644 index 0000000..9b373fc --- /dev/null +++ b/third_party/pybind11/docs/upgrade.rst @@ -0,0 +1,746 @@ +Upgrade guide +############# + +This is a companion guide to the :doc:`changelog`. While the changelog briefly +lists all of the new features, improvements and bug fixes, this upgrade guide +focuses only the subset which directly impacts your experience when upgrading +to a new version. But it goes into more detail. This includes things like +deprecated APIs and their replacements, build system changes, general code +modernization and other useful information. + +.. _upgrade-guide-3.0: + +v3.0 +==== + +pybind11 v3.0 introduces major new features, but the vast majority of +existing extensions are expected to build and run without modification. Minor +adjustments may be needed in rare cases, and any such changes can be easily +wrapped in preprocessor conditionals to maintain compatibility with the +2.x series. + +However, due to new features and modernizations, extensions built with +pybind11 v3.0 are not ABI-compatible with those built using v2.13. To ensure +cross-extension-module compatibility, it is recommended to rebuild all +pybind11-based extensions with v3.0. + +CMake support now defaults to the modern FindPython module. If you haven't +updated yet, we provide some backward compatibility for ``PYTHON_*`` variables, +but you should switch to using ``Python_*`` variables instead. Note that +setting ``PYTHON_*`` variables no longer affects the build. + +A major new feature in this release is the integration of +``py::smart_holder``, which improves support for ``std::unique_ptr`` +and ``std::shared_ptr``, resolving several long-standing issues. See +:ref:`smart_holder` for details. Closely related is the addition +of ``py::trampoline_self_life_support``, documented under +:ref:`overriding_virtuals`. + +This release includes a major modernization of cross-extension-module +ABI compatibility handling. The new implementation reflects actual ABI +compatibility much more accurately than in previous versions. The details +are subtle and complex; see +`#4953 `_ and +`#5439 `_. + +Also new in v3.0 is ``py::native_enum``, a modern API for exposing +C++ enumerations as native Python types — typically standard-library +``enum.Enum`` or related subclasses. This provides improved integration with +Python's enum system, compared to the older (now deprecated) ``py::enum_``. +See `#5555 `_ for details. + +Functions exposed with pybind11 are now pickleable. This removes a +long-standing obstacle when using pybind11-bound functions with Python features +that rely on pickling, such as multiprocessing and caching tools. +See `#5580 `_ for details. + +Anything producing a deprecation warning in the 2.x series may be removed in a +future minor release of 3.x. Most of these are still present in 3.0 in order to ease +transition. The new :ref:`deprecated` page details deprecations. + +Migration Recommendations +------------------------- + +We recommend migrating to pybind11 v3.0 promptly, while keeping initial +changes to a minimum. Most projects can upgrade simply by updating the +pybind11 version, without altering existing binding code. + +After a short stabilization period — enough to surface any subtle issues — +you may incrementally adopt new features where appropriate: + +* Use ``py::smart_holder`` and ``py::trampoline_self_life_support`` as needed, + or to improve code health. Note that ``py::classh`` is available as a + shortcut — for example, ``py::classh`` is shorthand for + ``py::class_``. This is designed to enable easy + experimentation with ``py::smart_holder`` without introducing distracting + whitespace changes. In many cases, a global replacement of ``py::class_`` + with ``py::classh`` can be an effective first step. Build failures will + quickly identify places where ``std::shared_ptr<...>`` holders need to be + removed. Runtime failures (assuming good unit test coverage) will highlight + base-and-derived class situations that require coordinated changes. + + Note that ``py::bind_vector`` and ``py::bind_map`` (in pybind11/stl_bind.h) + have a ``holder_type`` template parameter that defaults to + ``std::unique_ptr``. If ``py::smart_holder`` functionality is desired or + required, use e.g. ``py::bind_vector``. + +* Gradually migrate from ``py::enum_`` to ``py::native_enum`` to improve + integration with Python's standard enum types. + +There is no urgency to refactor existing, working bindings — adopt new +features as the need arises or as part of ongoing maintenance efforts. + +If you are using CMake, update to FindPython variables (mostly changing +variables from ``PYTHON_*`` -> ``Python_*``). You should see if you can use +``set(PYBIND11_FINDPYTHON ON)``, which has been supported for years and will +avoid setting the compatibility mode variables (and will avoid a warning). + +Potential stumbling blocks when migrating to v3.0 +------------------------------------------------- + +The following issues are very unlikely to arise, and easy to work around: + +* In rare cases, a C++ enum may be bound to Python via a + :ref:`custom type caster `. In such cases, a + template specialization like this may be required: + + .. code-block:: cpp + + #if defined(PYBIND11_HAS_NATIVE_ENUM) + namespace pybind11::detail { + template + struct type_caster_enum_type_enabled< + FancyEnum, + enable_if_t::value>> : std::false_type {}; + } + #endif + + This specialization is needed only if the custom type caster is templated. + + The ``PYBIND11_HAS_NATIVE_ENUM`` guard is needed only + if backward compatibility with pybind11v2 is required. + +* Similarly, template specializations like the following may be required + if there are custom + + * ``pybind11::detail::copyable_holder_caster`` or + + * ``pybind11::detail::move_only_holder_caster`` + + implementations that are used for ``std::shared_ptr`` or ``std::unique_ptr`` + conversions: + + .. code-block:: cpp + + #if defined(PYBIND11_HAS_INTERNALS_WITH_SMART_HOLDER_SUPPORT) + namespace pybind11::detail { + template + struct copyable_holder_caster_shared_ptr_with_smart_holder_support_enabled< + ExampleType, + enable_if_t::value>> : std::false_type {}; + } + #endif + + .. code-block:: cpp + + #if defined(PYBIND11_HAS_INTERNALS_WITH_SMART_HOLDER_SUPPORT) + namespace pybind11::detail { + template + struct move_only_holder_caster_unique_ptr_with_smart_holder_support_enabled< + ExampleType, + enable_if_t::value>> : std::false_type {}; + } + #endif + + The ``PYBIND11_HAS_INTERNALS_WITH_SMART_HOLDER_SUPPORT`` guard is needed only + if backward compatibility with pybind11v2 is required. + + (Note that ``copyable_holder_caster`` and ``move_only_holder_caster`` are not + documented, although they existed since 2017.) + + +.. _upgrade-guide-2.12: + +v2.12 +===== + +NumPy support has been upgraded to support the 2.x series too. The two relevant +changes are that: + +* ``dtype.flags()`` is now a ``uint64`` and ``dtype.alignment()`` an + ``ssize_t`` (and NumPy may return an larger than integer value for + ``itemsize()`` in NumPy 2.x). + +* The long deprecated NumPy function ``PyArray_GetArrayParamsFromObject`` + function is not available anymore. + +Due to NumPy changes, you may experience difficulties updating to NumPy 2. +Please see the `NumPy 2 migration guide `_ +for details. +For example, a more direct change could be that the default integer ``"int_"`` +(and ``"uint"``) is now ``ssize_t`` and not ``long`` (affects 64bit windows). + +If you want to only support NumPy 1.x for now and are having problems due to +the two internal changes listed above, you can define +``PYBIND11_NUMPY_1_ONLY`` to disable the new support for now. Make sure you +define this on all pybind11 compile units, since it could be a source of ODR +violations if used inconsistently. This option will be removed in the future, +so adapting your code is highly recommended. + + +.. _upgrade-guide-2.11: + +v2.11 +===== + +* The minimum version of CMake is now 3.5. A future version will likely move to + requiring something like CMake 3.15. Note that CMake 3.27 is removing the + long-deprecated support for ``FindPythonInterp`` if you set 3.27 as the + minimum or maximum supported version. To prepare for that future, CMake 3.15+ + using ``FindPython`` or setting ``PYBIND11_FINDPYTHON`` is highly recommended, + otherwise pybind11 will automatically switch to using ``FindPython`` if + ``FindPythonInterp`` is not available. + + +.. _upgrade-guide-2.9: + +v2.9 +==== + +* Any usage of the recently added ``py::make_simple_namespace`` should be + converted to using ``py::module_::import("types").attr("SimpleNamespace")`` + instead. + +* The use of ``_`` in custom type casters can now be replaced with the more + readable ``const_name`` instead. The old ``_`` shortcut has been retained + unless it is being used as a macro (like for gettext). + + +.. _upgrade-guide-2.7: + +v2.7 +==== + +*Before* v2.7, ``py::str`` can hold ``PyUnicodeObject`` or ``PyBytesObject``, +and ``py::isinstance()`` is ``true`` for both ``py::str`` and +``py::bytes``. Starting with v2.7, ``py::str`` exclusively holds +``PyUnicodeObject`` (`#2409 `_), +and ``py::isinstance()`` is ``true`` only for ``py::str``. To help in +the transition of user code, the ``PYBIND11_STR_LEGACY_PERMISSIVE`` macro +is provided as an escape hatch to go back to the legacy behavior. This macro +will be removed in future releases. Two types of required fixes are expected +to be common: + +* Accidental use of ``py::str`` instead of ``py::bytes``, masked by the legacy + behavior. These are probably very easy to fix, by changing from + ``py::str`` to ``py::bytes``. + +* Reliance on py::isinstance(obj) being ``true`` for + ``py::bytes``. This is likely to be easy to fix in most cases by adding + ``|| py::isinstance(obj)``, but a fix may be more involved, e.g. if + ``py::isinstance`` appears in a template. Such situations will require + careful review and custom fixes. + + +.. _upgrade-guide-2.6: + +v2.6 +==== + +Usage of the ``PYBIND11_OVERLOAD*`` macros and ``get_overload`` function should +be replaced by ``PYBIND11_OVERRIDE*`` and ``get_override``. In the future, the +old macros may be deprecated and removed. + +``py::module`` has been renamed ``py::module_``, but a backward compatible +typedef has been included. This change was to avoid a language change in C++20 +that requires unqualified ``module`` not be placed at the start of a logical +line. Qualified usage is unaffected and the typedef will remain unless the +C++ language rules change again. + +The public constructors of ``py::module_`` have been deprecated. Use +``PYBIND11_MODULE`` or ``module_::create_extension_module`` instead. + +An error is now thrown when ``__init__`` is forgotten on subclasses. This was +incorrect before, but was not checked. Add a call to ``__init__`` if it is +missing. + +A ``py::type_error`` is now thrown when casting to a subclass (like +``py::bytes`` from ``py::object``) if the conversion is not valid. Make a valid +conversion instead. + +The undocumented ``h.get_type()`` method has been deprecated and replaced by +``py::type::of(h)``. + +Enums now have a ``__str__`` method pre-defined; if you want to override it, +the simplest fix is to add the new ``py::prepend()`` tag when defining +``"__str__"``. + +If ``__eq__`` defined but not ``__hash__``, ``__hash__`` is now set to +``None``, as in normal CPython. You should add ``__hash__`` if you intended the +class to be hashable, possibly using the new ``py::hash`` shortcut. + +The constructors for ``py::array`` now always take signed integers for size, +for consistency. This may lead to compiler warnings on some systems. Cast to +``py::ssize_t`` instead of ``std::size_t``. + +The ``tools/clang`` submodule and ``tools/mkdoc.py`` have been moved to a +standalone package, `pybind11-mkdoc`_. If you were using those tools, please +use them via a pip install from the new location. + +The ``pybind11`` package on PyPI no longer fills the wheel "headers" slot - if +you were using the headers from this slot, they are available by requesting the +``global`` extra, that is, ``pip install "pybind11[global]"``. (Most users will +be unaffected, as the ``pybind11/include`` location is reported by ``python -m +pybind11 --includes`` and ``pybind11.get_include()`` is still correct and has +not changed since 2.5). + +.. _pybind11-mkdoc: https://github.com/pybind/pybind11-mkdoc + +CMake support: +-------------- + +The minimum required version of CMake is now 3.4. Several details of the CMake +support have been deprecated; warnings will be shown if you need to change +something. The changes are: + +* ``PYBIND11_CPP_STANDARD=`` is deprecated, please use + ``CMAKE_CXX_STANDARD=`` instead, or any other valid CMake CXX or CUDA + standard selection method, like ``target_compile_features``. + +* If you do not request a standard, pybind11 targets will compile with the + compiler default, but not less than C++11, instead of forcing C++14 always. + If you depend on the old behavior, please use ``set(CMAKE_CXX_STANDARD 14 CACHE STRING "")`` + instead. + +* Direct ``pybind11::module`` usage should always be accompanied by at least + ``set(CMAKE_CXX_VISIBILITY_PRESET hidden)`` or similar - it used to try to + manually force this compiler flag (but not correctly on all compilers or with + CUDA). + +* ``pybind11_add_module``'s ``SYSTEM`` argument is deprecated and does nothing; + linking now behaves like other imported libraries consistently in both + config and submodule mode, and behaves like a ``SYSTEM`` library by + default. + +* If ``PYTHON_EXECUTABLE`` is not set, virtual environments (``venv``, + ``virtualenv``, and ``conda``) are prioritized over the standard search + (similar to the new FindPython mode). + +In addition, the following changes may be of interest: + +* ``CMAKE_INTERPROCEDURAL_OPTIMIZATION`` will be respected by + ``pybind11_add_module`` if set instead of linking to ``pybind11::lto`` or + ``pybind11::thin_lto``. + +* Using ``find_package(Python COMPONENTS Interpreter Development)`` before + pybind11 will cause pybind11 to use the new Python mechanisms instead of its + own custom search, based on a patched version of classic ``FindPythonInterp`` + / ``FindPythonLibs``. In the future, this may become the default. A recent + (3.15+ or 3.18.2+) version of CMake is recommended. + + + +v2.5 +==== + +The Python package now includes the headers as data in the package itself, as +well as in the "headers" wheel slot. ``pybind11 --includes`` and +``pybind11.get_include()`` report the new location, which is always correct +regardless of how pybind11 was installed, making the old ``user=`` argument +meaningless. If you are not using the function to get the location already, you +are encouraged to switch to the package location. + + +v2.2 +==== + +Deprecation of the ``PYBIND11_PLUGIN`` macro +-------------------------------------------- + +``PYBIND11_MODULE`` is now the preferred way to create module entry points. +The old macro emits a compile-time deprecation warning. + +.. code-block:: cpp + + // old + PYBIND11_PLUGIN(example) { + py::module m("example", "documentation string"); + + m.def("add", [](int a, int b) { return a + b; }); + + return m.ptr(); + } + + // new + PYBIND11_MODULE(example, m) { + m.doc() = "documentation string"; // optional + + m.def("add", [](int a, int b) { return a + b; }); + } + + +New API for defining custom constructors and pickling functions +--------------------------------------------------------------- + +The old placement-new custom constructors have been deprecated. The new approach +uses ``py::init()`` and factory functions to greatly improve type safety. + +Placement-new can be called accidentally with an incompatible type (without any +compiler errors or warnings), or it can initialize the same object multiple times +if not careful with the Python-side ``__init__`` calls. The new-style custom +constructors prevent such mistakes. See :ref:`custom_constructors` for details. + +.. code-block:: cpp + + // old -- deprecated (runtime warning shown only in debug mode) + py::class(m, "Foo") + .def("__init__", [](Foo &self, ...) { + new (&self) Foo(...); // uses placement-new + }); + + // new + py::class(m, "Foo") + .def(py::init([](...) { // Note: no `self` argument + return new Foo(...); // return by raw pointer + // or: return std::make_unique(...); // return by holder + // or: return Foo(...); // return by value (move constructor) + })); + +Mirroring the custom constructor changes, ``py::pickle()`` is now the preferred +way to get and set object state. See :ref:`pickling` for details. + +.. code-block:: cpp + + // old -- deprecated (runtime warning shown only in debug mode) + py::class(m, "Foo") + ... + .def("__getstate__", [](const Foo &self) { + return py::make_tuple(self.value1(), self.value2(), ...); + }) + .def("__setstate__", [](Foo &self, py::tuple t) { + new (&self) Foo(t[0].cast(), ...); + }); + + // new + py::class(m, "Foo") + ... + .def(py::pickle( + [](const Foo &self) { // __getstate__ + return py::make_tuple(self.value1(), self.value2(), ...); // unchanged + }, + [](py::tuple t) { // __setstate__, note: no `self` argument + return new Foo(t[0].cast(), ...); + // or: return std::make_unique(...); // return by holder + // or: return Foo(...); // return by value (move constructor) + } + )); + +For both the constructors and pickling, warnings are shown at module +initialization time (on import, not when the functions are called). +They're only visible when compiled in debug mode. Sample warning: + +.. code-block:: none + + pybind11-bound class 'mymodule.Foo' is using an old-style placement-new '__init__' + which has been deprecated. See the upgrade guide in pybind11's docs. + + +Stricter enforcement of hidden symbol visibility for pybind11 modules +--------------------------------------------------------------------- + +pybind11 now tries to actively enforce hidden symbol visibility for modules. +If you're using either one of pybind11's :doc:`CMake or Python build systems +` (the two example repositories) and you haven't been exporting any +symbols, there's nothing to be concerned about. All the changes have been done +transparently in the background. If you were building manually or relied on +specific default visibility, read on. + +Setting default symbol visibility to *hidden* has always been recommended for +pybind11 (see :ref:`faq:symhidden`). On Linux and macOS, hidden symbol +visibility (in conjunction with the ``strip`` utility) yields much smaller +module binaries. `CPython's extension docs`_ also recommend hiding symbols +by default, with the goal of avoiding symbol name clashes between modules. +Starting with v2.2, pybind11 enforces this more strictly: (1) by declaring +all symbols inside the ``pybind11`` namespace as hidden and (2) by including +the ``-fvisibility=hidden`` flag on Linux and macOS (only for extension +modules, not for embedding the interpreter). + +.. _CPython's extension docs: https://docs.python.org/3/extending/extending.html#providing-a-c-api-for-an-extension-module + +The namespace-scope hidden visibility is done automatically in pybind11's +headers and it's generally transparent to users. It ensures that: + +* Modules compiled with different pybind11 versions don't clash with each other. + +* Some new features, like ``py::module_local`` bindings, can work as intended. + +The ``-fvisibility=hidden`` flag applies the same visibility to user bindings +outside of the ``pybind11`` namespace. It's now set automatic by pybind11's +CMake and Python build systems, but this needs to be done manually by users +of other build systems. Adding this flag: + +* Minimizes the chances of symbol conflicts between modules. E.g. if two + unrelated modules were statically linked to different (ABI-incompatible) + versions of the same third-party library, a symbol clash would be likely + (and would end with unpredictable results). + +* Produces smaller binaries on Linux and macOS, as pointed out previously. + +Within pybind11's CMake build system, ``pybind11_add_module`` has always been +setting the ``-fvisibility=hidden`` flag in release mode. From now on, it's +being applied unconditionally, even in debug mode and it can no longer be opted +out of with the ``NO_EXTRAS`` option. The ``pybind11::module`` target now also +adds this flag to its interface. The ``pybind11::embed`` target is unchanged. + +The most significant change here is for the ``pybind11::module`` target. If you +were previously relying on default visibility, i.e. if your Python module was +doubling as a shared library with dependents, you'll need to either export +symbols manually (recommended for cross-platform libraries) or factor out the +shared library (and have the Python module link to it like the other +dependents). As a temporary workaround, you can also restore default visibility +using the CMake code below, but this is not recommended in the long run: + +.. code-block:: cmake + + target_link_libraries(mymodule PRIVATE pybind11::module) + + add_library(restore_default_visibility INTERFACE) + target_compile_options(restore_default_visibility INTERFACE -fvisibility=default) + target_link_libraries(mymodule PRIVATE restore_default_visibility) + + +Local STL container bindings +---------------------------- + +Previous pybind11 versions could only bind types globally -- all pybind11 +modules, even unrelated ones, would have access to the same exported types. +However, this would also result in a conflict if two modules exported the +same C++ type, which is especially problematic for very common types, e.g. +``std::vector``. :ref:`module_local` were added to resolve this (see +that section for a complete usage guide). + +``py::class_`` still defaults to global bindings (because these types are +usually unique across modules), however in order to avoid clashes of opaque +types, ``py::bind_vector`` and ``py::bind_map`` will now bind STL containers +as ``py::module_local`` if their elements are: builtins (``int``, ``float``, +etc.), not bound using ``py::class_``, or bound as ``py::module_local``. For +example, this change allows multiple modules to bind ``std::vector`` +without causing conflicts. See :ref:`stl_bind` for more details. + +When upgrading to this version, if you have multiple modules which depend on +a single global binding of an STL container, note that all modules can still +accept foreign ``py::module_local`` types in the direction of Python-to-C++. +The locality only affects the C++-to-Python direction. If this is needed in +multiple modules, you'll need to either: + +* Add a copy of the same STL binding to all of the modules which need it. + +* Restore the global status of that single binding by marking it + ``py::module_local(false)``. + +The latter is an easy workaround, but in the long run it would be best to +localize all common type bindings in order to avoid conflicts with +third-party modules. + + +Negative strides for Python buffer objects and numpy arrays +----------------------------------------------------------- + +Support for negative strides required changing the integer type from unsigned +to signed in the interfaces of ``py::buffer_info`` and ``py::array``. If you +have compiler warnings enabled, you may notice some new conversion warnings +after upgrading. These can be resolved using ``static_cast``. + + +Deprecation of some ``py::object`` APIs +--------------------------------------- + +To compare ``py::object`` instances by pointer, you should now use +``obj1.is(obj2)`` which is equivalent to ``obj1 is obj2`` in Python. +Previously, pybind11 used ``operator==`` for this (``obj1 == obj2``), but +that could be confusing and is now deprecated (so that it can eventually +be replaced with proper rich object comparison in a future release). + +For classes which inherit from ``py::object``, ``borrowed`` and ``stolen`` +were previously available as protected constructor tags. Now the types +should be used directly instead: ``borrowed_t{}`` and ``stolen_t{}`` +(`#771 `_). + + +Stricter compile-time error checking +------------------------------------ + +Some error checks have been moved from run time to compile time. Notably, +automatic conversion of ``std::shared_ptr`` is not possible when ``T`` is +not directly registered with ``py::class_`` (e.g. ``std::shared_ptr`` +or ``std::shared_ptr>`` are not automatically convertible). +Attempting to bind a function with such arguments now results in a compile-time +error instead of waiting to fail at run time. + +``py::init<...>()`` constructor definitions are also stricter and now prevent +bindings which could cause unexpected behavior: + +.. code-block:: cpp + + struct Example { + Example(int &); + }; + + py::class_(m, "Example") + .def(py::init()); // OK, exact match + // .def(py::init()); // compile-time error, mismatch + +A non-``const`` lvalue reference is not allowed to bind to an rvalue. However, +note that a constructor taking ``const T &`` can still be registered using +``py::init()`` because a ``const`` lvalue reference can bind to an rvalue. + +v2.1 +==== + +Minimum compiler versions are enforced at compile time +------------------------------------------------------ + +The minimums also apply to v2.0 but the check is now explicit and a compile-time +error is raised if the compiler does not meet the requirements: + +* GCC >= 4.8 +* clang >= 3.3 (appleclang >= 5.0) +* MSVC >= 2015u3 +* Intel C++ >= 15.0 + + +The ``py::metaclass`` attribute is not required for static properties +--------------------------------------------------------------------- + +Binding classes with static properties is now possible by default. The +zero-parameter version of ``py::metaclass()`` is deprecated. However, a new +one-parameter ``py::metaclass(python_type)`` version was added for rare +cases when a custom metaclass is needed to override pybind11's default. + +.. code-block:: cpp + + // old -- emits a deprecation warning + py::class_(m, "Foo", py::metaclass()) + .def_property_readonly_static("foo", ...); + + // new -- static properties work without the attribute + py::class_(m, "Foo") + .def_property_readonly_static("foo", ...); + + // new -- advanced feature, override pybind11's default metaclass + py::class_(m, "Bar", py::metaclass(custom_python_type)) + ... + + +v2.0 +==== + +Breaking changes in ``py::class_`` +---------------------------------- + +These changes were necessary to make type definitions in pybind11 +future-proof, to support PyPy via its ``cpyext`` mechanism (`#527 +`_), and to improve efficiency +(`rev. 86d825 `_). + +1. Declarations of types that provide access via the buffer protocol must + now include the ``py::buffer_protocol()`` annotation as an argument to + the ``py::class_`` constructor. + + .. code-block:: cpp + + py::class_("Matrix", py::buffer_protocol()) + .def(py::init<...>()) + .def_buffer(...); + +2. Classes which include static properties (e.g. ``def_readwrite_static()``) + must now include the ``py::metaclass()`` attribute. Note: this requirement + has since been removed in v2.1. If you're upgrading from 1.x, it's + recommended to skip directly to v2.1 or newer. + +3. This version of pybind11 uses a redesigned mechanism for instantiating + trampoline classes that are used to override virtual methods from within + Python. This led to the following user-visible syntax change: + + .. code-block:: cpp + + // old v1.x syntax + py::class_("MyClass") + .alias() + ... + + // new v2.x syntax + py::class_("MyClass") + ... + + Importantly, both the original and the trampoline class are now specified + as arguments to the ``py::class_`` template, and the ``alias<..>()`` call + is gone. The new scheme has zero overhead in cases when Python doesn't + override any functions of the underlying C++ class. + `rev. 86d825 `_. + + The class type must be the first template argument given to ``py::class_`` + while the trampoline can be mixed in arbitrary order with other arguments + (see the following section). + + +Deprecation of the ``py::base()`` attribute +---------------------------------------------- + +``py::base()`` was deprecated in favor of specifying ``T`` as a template +argument to ``py::class_``. This new syntax also supports multiple inheritance. +Note that, while the type being exported must be the first argument in the +``py::class_`` template, the order of the following types (bases, +holder and/or trampoline) is not important. + +.. code-block:: cpp + + // old v1.x + py::class_("Derived", py::base()); + + // new v2.x + py::class_("Derived"); + + // new -- multiple inheritance + py::class_("Derived"); + + // new -- apart from `Derived` the argument order can be arbitrary + py::class_("Derived"); + + +Out-of-the-box support for ``std::shared_ptr`` +---------------------------------------------- + +The relevant type caster is now built in, so it's no longer necessary to +include a declaration of the form: + +.. code-block:: cpp + + PYBIND11_DECLARE_HOLDER_TYPE(T, std::shared_ptr) + +Continuing to do so won't cause an error or even a deprecation warning, +but it's completely redundant. + + +Deprecation of a few ``py::object`` APIs +---------------------------------------- + +All of the old-style calls emit deprecation warnings. + ++---------------------------------------+---------------------------------------------+ +| Old syntax | New syntax | ++=======================================+=============================================+ +| ``obj.call(args...)`` | ``obj(args...)`` | ++---------------------------------------+---------------------------------------------+ +| ``obj.str()`` | ``py::str(obj)`` | ++---------------------------------------+---------------------------------------------+ +| ``auto l = py::list(obj); l.check()`` | ``py::isinstance(obj)`` | ++---------------------------------------+---------------------------------------------+ +| ``py::object(ptr, true)`` | ``py::reinterpret_borrow(ptr)`` | ++---------------------------------------+---------------------------------------------+ +| ``py::object(ptr, false)`` | ``py::reinterpret_steal(ptr)`` | ++---------------------------------------+---------------------------------------------+ +| ``if (obj.attr("foo"))`` | ``if (py::hasattr(obj, "foo"))`` | ++---------------------------------------+---------------------------------------------+ +| ``if (obj["bar"])`` | ``if (obj.contains("bar"))`` | ++---------------------------------------+---------------------------------------------+ diff --git a/third_party/pybind11/include/pybind11/attr.h b/third_party/pybind11/include/pybind11/attr.h new file mode 100644 index 0000000..9b631fa --- /dev/null +++ b/third_party/pybind11/include/pybind11/attr.h @@ -0,0 +1,722 @@ +/* + pybind11/attr.h: Infrastructure for processing custom + type and function attributes + + Copyright (c) 2016 Wenzel Jakob + + 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 "detail/common.h" +#include "cast.h" +#include "trampoline_self_life_support.h" + +#include + +PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +/// \addtogroup annotations +/// @{ + +/// Annotation for methods +struct is_method { + handle class_; + explicit is_method(const handle &c) : class_(c) {} +}; + +/// Annotation for setters +struct is_setter {}; + +/// Annotation for operators +struct is_operator {}; + +/// Annotation for classes that cannot be subclassed +struct is_final {}; + +/// Annotation for parent scope +struct scope { + handle value; + explicit scope(const handle &s) : value(s) {} +}; + +/// Annotation for documentation +struct doc { + const char *value; + explicit doc(const char *value) : value(value) {} +}; + +/// Annotation for function names +struct name { + const char *value; + explicit name(const char *value) : value(value) {} +}; + +/// Annotation indicating that a function is an overload associated with a given "sibling" +struct sibling { + handle value; + explicit sibling(const handle &value) : value(value.ptr()) {} +}; + +/// Annotation indicating that a class derives from another given type +template +struct base { + + PYBIND11_DEPRECATED( + "base() was deprecated in favor of specifying 'T' as a template argument to class_") + base() = default; +}; + +/// Keep patient alive while nurse lives +template +struct keep_alive {}; + +/// Annotation indicating that a class is involved in a multiple inheritance relationship +struct multiple_inheritance {}; + +/// Annotation which enables dynamic attributes, i.e. adds `__dict__` to a class +struct dynamic_attr {}; + +/// Annotation which enables the buffer protocol for a type +struct buffer_protocol {}; + +/// Annotation which enables releasing the GIL before calling the C++ destructor of wrapped +/// instances (pybind/pybind11#1446). +struct release_gil_before_calling_cpp_dtor {}; + +/// Annotation which requests that a special metaclass is created for a type +struct metaclass { + handle value; + + PYBIND11_DEPRECATED("py::metaclass() is no longer required. It's turned on by default now.") + metaclass() = default; + + /// Override pybind11's default metaclass + explicit metaclass(handle value) : value(value) {} +}; + +/// Specifies a custom callback with signature `void (PyHeapTypeObject*)` that +/// may be used to customize the Python type. +/// +/// The callback is invoked immediately before `PyType_Ready`. +/// +/// Note: This is an advanced interface, and uses of it may require changes to +/// work with later versions of pybind11. You may wish to consult the +/// implementation of `make_new_python_type` in `detail/classes.h` to understand +/// the context in which the callback will be run. +struct custom_type_setup { + using callback = std::function; + + explicit custom_type_setup(callback value) : value(std::move(value)) {} + + callback value; +}; + +/// Annotation that marks a class as local to the module: +struct module_local { + const bool value; + constexpr explicit module_local(bool v = true) : value(v) {} +}; + +/// Annotation to mark enums as an arithmetic type +struct arithmetic {}; + +/// Mark a function for addition at the beginning of the existing overload chain instead of the end +struct prepend {}; + +/** \rst + A call policy which places one or more guard variables (``Ts...``) around the function call. + + For example, this definition: + + .. code-block:: cpp + + m.def("foo", foo, py::call_guard()); + + is equivalent to the following pseudocode: + + .. code-block:: cpp + + m.def("foo", [](args...) { + T scope_guard; + return foo(args...); // forwarded arguments + }); + \endrst */ +template +struct call_guard; + +template <> +struct call_guard<> { + using type = detail::void_type; +}; + +template +struct call_guard { + static_assert(std::is_default_constructible::value, + "The guard type must be default constructible"); + + using type = T; +}; + +template +struct call_guard { + struct type { + T guard{}; // Compose multiple guard types with left-to-right default-constructor order + typename call_guard::type next{}; + }; +}; + +/// @} annotations + +PYBIND11_NAMESPACE_BEGIN(detail) +/* Forward declarations */ +enum op_id : int; +enum op_type : int; +struct undefined_t; +template +struct op_; +void keep_alive_impl(size_t Nurse, size_t Patient, function_call &call, handle ret); + +/// Internal data structure which holds metadata about a keyword argument +struct argument_record { + const char *name; ///< Argument name + const char *descr; ///< Human-readable version of the argument value + handle value; ///< Associated Python object + bool convert : 1; ///< True if the argument is allowed to convert when loading + bool none : 1; ///< True if None is allowed when loading + + argument_record(const char *name, const char *descr, handle value, bool convert, bool none) + : name(name), descr(descr), value(value), convert(convert), none(none) {} +}; + +/// Internal data structure which holds metadata about a bound function (signature, overloads, +/// etc.) +#define PYBIND11_DETAIL_FUNCTION_RECORD_ABI_ID "v1" // PLEASE UPDATE if the struct is changed. +struct function_record { + function_record() + : is_constructor(false), is_new_style_constructor(false), is_stateless(false), + is_operator(false), is_method(false), is_setter(false), has_args(false), + has_kwargs(false), prepend(false) {} + + /// Function name + char *name = nullptr; /* why no C++ strings? They generate heavier code.. */ + + // User-specified documentation string + char *doc = nullptr; + + /// Human-readable version of the function signature + char *signature = nullptr; + + /// List of registered keyword arguments + std::vector args; + + /// Pointer to lambda function which converts arguments and performs the actual call + handle (*impl)(function_call &) = nullptr; + + /// Storage for the wrapped function pointer and captured data, if any + void *data[3] = {}; + + /// Pointer to custom destructor for 'data' (if needed) + void (*free_data)(function_record *ptr) = nullptr; + + /// Return value policy associated with this function + return_value_policy policy = return_value_policy::automatic; + + /// True if name == '__init__' + bool is_constructor : 1; + + /// True if this is a new-style `__init__` defined in `detail/init.h` + bool is_new_style_constructor : 1; + + /// True if this is a stateless function pointer + bool is_stateless : 1; + + /// True if this is an operator (__add__), etc. + bool is_operator : 1; + + /// True if this is a method + bool is_method : 1; + + /// True if this is a setter + bool is_setter : 1; + + /// True if the function has a '*args' argument + bool has_args : 1; + + /// True if the function has a '**kwargs' argument + bool has_kwargs : 1; + + /// True if this function is to be inserted at the beginning of the overload resolution chain + bool prepend : 1; + + /// Number of arguments (including py::args and/or py::kwargs, if present) + std::uint16_t nargs; + + /// Number of leading positional arguments, which are terminated by a py::args or py::kwargs + /// argument or by a py::kw_only annotation. + std::uint16_t nargs_pos = 0; + + /// Number of leading arguments (counted in `nargs`) that are positional-only + std::uint16_t nargs_pos_only = 0; + + /// Python method object + PyMethodDef *def = nullptr; + + /// Python handle to the parent scope (a class or a module) + handle scope; + + /// Python handle to the sibling function representing an overload chain + handle sibling; + + /// Pointer to next overload + function_record *next = nullptr; +}; +// The main purpose of this macro is to make it easy to pin-point the critically related code +// sections. +#define PYBIND11_ENSURE_PRECONDITION_FOR_FUNCTIONAL_H_PERFORMANCE_OPTIMIZATIONS(...) \ + static_assert( \ + __VA_ARGS__, \ + "Violation of precondition for pybind11/functional.h performance optimizations!") + +/// Special data structure which (temporarily) holds metadata about a bound class +struct type_record { + PYBIND11_NOINLINE type_record() + : multiple_inheritance(false), dynamic_attr(false), buffer_protocol(false), + module_local(false), is_final(false), release_gil_before_calling_cpp_dtor(false) {} + + /// Handle to the parent scope + handle scope; + + /// Name of the class + const char *name = nullptr; + + // Pointer to RTTI type_info data structure + const std::type_info *type = nullptr; + + /// How large is the underlying C++ type? + size_t type_size = 0; + + /// What is the alignment of the underlying C++ type? + size_t type_align = 0; + + /// How large is the type's holder? + size_t holder_size = 0; + + /// The global operator new can be overridden with a class-specific variant + void *(*operator_new)(size_t) = nullptr; + + /// Function pointer to class_<..>::init_instance + void (*init_instance)(instance *, const void *) = nullptr; + + /// Function pointer to class_<..>::dealloc + void (*dealloc)(detail::value_and_holder &) = nullptr; + + /// Function pointer for casting alias class (aka trampoline) pointer to + /// trampoline_self_life_support pointer. Sidesteps cross-DSO RTTI issues + /// on platforms like macOS (see PR #5728 for details). + get_trampoline_self_life_support_fn get_trampoline_self_life_support + = [](void *) -> trampoline_self_life_support * { return nullptr; }; + + /// List of base classes of the newly created type + list bases; + + /// Optional docstring + const char *doc = nullptr; + + /// Custom metaclass (optional) + handle metaclass; + + /// Custom type setup. + custom_type_setup::callback custom_type_setup_callback; + + /// Multiple inheritance marker + bool multiple_inheritance : 1; + + /// Does the class manage a __dict__? + bool dynamic_attr : 1; + + /// Does the class implement the buffer protocol? + bool buffer_protocol : 1; + + /// Is the class definition local to the module shared object? + bool module_local : 1; + + /// Is the class inheritable from python classes? + bool is_final : 1; + + /// Solves pybind/pybind11#1446 + bool release_gil_before_calling_cpp_dtor : 1; + + holder_enum_t holder_enum_v = holder_enum_t::undefined; + + PYBIND11_NOINLINE void add_base(const std::type_info &base, void *(*caster)(void *) ) { + auto *base_info = detail::get_type_info(base, false); + if (!base_info) { + std::string tname(base.name()); + detail::clean_type_id(tname); + pybind11_fail("generic_type: type \"" + std::string(name) + + "\" referenced unknown base type \"" + tname + "\""); + } + + // SMART_HOLDER_BAKEIN_FOLLOW_ON: Refine holder compatibility checks. + bool this_has_unique_ptr_holder = (holder_enum_v == holder_enum_t::std_unique_ptr); + bool base_has_unique_ptr_holder + = (base_info->holder_enum_v == holder_enum_t::std_unique_ptr); + if (this_has_unique_ptr_holder != base_has_unique_ptr_holder) { + std::string tname(base.name()); + detail::clean_type_id(tname); + pybind11_fail("generic_type: type \"" + std::string(name) + "\" " + + (this_has_unique_ptr_holder ? "does not have" : "has") + + " a non-default holder type while its base \"" + tname + "\" " + + (base_has_unique_ptr_holder ? "does not" : "does")); + } + + bases.append((PyObject *) base_info->type); + +#ifdef PYBIND11_BACKWARD_COMPATIBILITY_TP_DICTOFFSET + dynamic_attr |= base_info->type->tp_dictoffset != 0; +#else + dynamic_attr |= (base_info->type->tp_flags & Py_TPFLAGS_MANAGED_DICT) != 0; +#endif + + if (caster) { + base_info->implicit_casts.emplace_back(type, caster); + } + } +}; + +inline function_call::function_call(const function_record &f, handle p) : func(f), parent(p) { + args.reserve(f.nargs); + args_convert.reserve(f.nargs); +} + +/// Tag for a new-style `__init__` defined in `detail/init.h` +struct is_new_style_constructor {}; + +/** + * Partial template specializations to process custom attributes provided to + * cpp_function_ and class_. These are either used to initialize the respective + * fields in the type_record and function_record data structures or executed at + * runtime to deal with custom call policies (e.g. keep_alive). + */ +template +struct process_attribute; + +template +struct process_attribute_default { + /// Default implementation: do nothing + static void init(const T &, function_record *) {} + static void init(const T &, type_record *) {} + static void precall(function_call &) {} + static void postcall(function_call &, handle) {} +}; + +/// Process an attribute specifying the function's name +template <> +struct process_attribute : process_attribute_default { + static void init(const name &n, function_record *r) { r->name = const_cast(n.value); } +}; + +/// Process an attribute specifying the function's docstring +template <> +struct process_attribute : process_attribute_default { + static void init(const doc &n, function_record *r) { r->doc = const_cast(n.value); } +}; + +/// Process an attribute specifying the function's docstring (provided as a C-style string) +template <> +struct process_attribute : process_attribute_default { + static void init(const char *d, function_record *r) { r->doc = const_cast(d); } + static void init(const char *d, type_record *r) { r->doc = d; } +}; +template <> +struct process_attribute : process_attribute {}; + +/// Process an attribute indicating the function's return value policy +template <> +struct process_attribute : process_attribute_default { + static void init(const return_value_policy &p, function_record *r) { r->policy = p; } +}; + +/// Process an attribute which indicates that this is an overloaded function associated with a +/// given sibling +template <> +struct process_attribute : process_attribute_default { + static void init(const sibling &s, function_record *r) { r->sibling = s.value; } +}; + +/// Process an attribute which indicates that this function is a method +template <> +struct process_attribute : process_attribute_default { + static void init(const is_method &s, function_record *r) { + r->is_method = true; + r->scope = s.class_; + } +}; + +/// Process an attribute which indicates that this function is a setter +template <> +struct process_attribute : process_attribute_default { + static void init(const is_setter &, function_record *r) { r->is_setter = true; } +}; + +/// Process an attribute which indicates the parent scope of a method +template <> +struct process_attribute : process_attribute_default { + static void init(const scope &s, function_record *r) { r->scope = s.value; } +}; + +/// Process an attribute which indicates that this function is an operator +template <> +struct process_attribute : process_attribute_default { + static void init(const is_operator &, function_record *r) { r->is_operator = true; } +}; + +template <> +struct process_attribute + : process_attribute_default { + static void init(const is_new_style_constructor &, function_record *r) { + r->is_new_style_constructor = true; + } +}; + +inline void check_kw_only_arg(const arg &a, function_record *r) { + if (r->args.size() > r->nargs_pos && (!a.name || a.name[0] == '\0')) { + pybind11_fail("arg(): cannot specify an unnamed argument after a kw_only() annotation or " + "args() argument"); + } +} + +inline void append_self_arg_if_needed(function_record *r) { + if (r->is_method && r->args.empty()) { + r->args.emplace_back("self", nullptr, handle(), /*convert=*/true, /*none=*/false); + } +} + +/// Process a keyword argument attribute (*without* a default value) +template <> +struct process_attribute : process_attribute_default { + static void init(const arg &a, function_record *r) { + append_self_arg_if_needed(r); + r->args.emplace_back(a.name, nullptr, handle(), !a.flag_noconvert, a.flag_none); + + check_kw_only_arg(a, r); + } +}; + +/// Process a keyword argument attribute (*with* a default value) +template <> +struct process_attribute : process_attribute_default { + static void init(const arg_v &a, function_record *r) { + if (r->is_method && r->args.empty()) { + r->args.emplace_back( + "self", /*descr=*/nullptr, /*parent=*/handle(), /*convert=*/true, /*none=*/false); + } + + if (!a.value) { +#if defined(PYBIND11_DETAILED_ERROR_MESSAGES) + std::string descr("'"); + if (a.name) { + descr += std::string(a.name) + ": "; + } + descr += a.type + "'"; + if (r->is_method) { + if (r->name) { + descr += " in method '" + (std::string) str(r->scope) + "." + + (std::string) r->name + "'"; + } else { + descr += " in method of '" + (std::string) str(r->scope) + "'"; + } + } else if (r->name) { + descr += " in function '" + (std::string) r->name + "'"; + } + pybind11_fail("arg(): could not convert default argument " + descr + + " into a Python object (type not registered yet?)"); +#else + pybind11_fail("arg(): could not convert default argument " + "into a Python object (type not registered yet?). " + "#define PYBIND11_DETAILED_ERROR_MESSAGES or compile in debug mode for " + "more information."); +#endif + } + r->args.emplace_back(a.name, a.descr, a.value.inc_ref(), !a.flag_noconvert, a.flag_none); + + check_kw_only_arg(a, r); + } +}; + +/// Process a keyword-only-arguments-follow pseudo argument +template <> +struct process_attribute : process_attribute_default { + static void init(const kw_only &, function_record *r) { + append_self_arg_if_needed(r); + if (r->has_args && r->nargs_pos != static_cast(r->args.size())) { + pybind11_fail("Mismatched args() and kw_only(): they must occur at the same relative " + "argument location (or omit kw_only() entirely)"); + } + r->nargs_pos = static_cast(r->args.size()); + } +}; + +/// Process a positional-only-argument maker +template <> +struct process_attribute : process_attribute_default { + static void init(const pos_only &, function_record *r) { + append_self_arg_if_needed(r); + r->nargs_pos_only = static_cast(r->args.size()); + if (r->nargs_pos_only > r->nargs_pos) { + pybind11_fail("pos_only(): cannot follow a py::args() argument"); + } + // It also can't follow a kw_only, but a static_assert in pybind11.h checks that + } +}; + +/// Process a parent class attribute. Single inheritance only (class_ itself already guarantees +/// that) +template +struct process_attribute::value>> + : process_attribute_default { + static void init(const handle &h, type_record *r) { r->bases.append(h); } +}; + +/// Process a parent class attribute (deprecated, does not support multiple inheritance) +template +struct process_attribute> : process_attribute_default> { + static void init(const base &, type_record *r) { r->add_base(typeid(T), nullptr); } +}; + +/// Process a multiple inheritance attribute +template <> +struct process_attribute : process_attribute_default { + static void init(const multiple_inheritance &, type_record *r) { + r->multiple_inheritance = true; + } +}; + +template <> +struct process_attribute : process_attribute_default { + static void init(const dynamic_attr &, type_record *r) { r->dynamic_attr = true; } +}; + +template <> +struct process_attribute { + static void init(const custom_type_setup &value, type_record *r) { + r->custom_type_setup_callback = value.value; + } +}; + +template <> +struct process_attribute : process_attribute_default { + static void init(const is_final &, type_record *r) { r->is_final = true; } +}; + +template <> +struct process_attribute : process_attribute_default { + static void init(const buffer_protocol &, type_record *r) { r->buffer_protocol = true; } +}; + +template <> +struct process_attribute : process_attribute_default { + static void init(const metaclass &m, type_record *r) { r->metaclass = m.value; } +}; + +template <> +struct process_attribute : process_attribute_default { + static void init(const module_local &l, type_record *r) { r->module_local = l.value; } +}; + +template <> +struct process_attribute + : process_attribute_default { + static void init(const release_gil_before_calling_cpp_dtor &, type_record *r) { + r->release_gil_before_calling_cpp_dtor = true; + } +}; + +/// Process a 'prepend' attribute, putting this at the beginning of the overload chain +template <> +struct process_attribute : process_attribute_default { + static void init(const prepend &, function_record *r) { r->prepend = true; } +}; + +/// Process an 'arithmetic' attribute for enums (does nothing here) +template <> +struct process_attribute : process_attribute_default {}; + +template +struct process_attribute> : process_attribute_default> {}; + +/** + * Process a keep_alive call policy -- invokes keep_alive_impl during the + * pre-call handler if both Nurse, Patient != 0 and use the post-call handler + * otherwise + */ +template +struct process_attribute> + : public process_attribute_default> { + template = 0> + static void precall(function_call &call) { + keep_alive_impl(Nurse, Patient, call, handle()); + } + template = 0> + static void postcall(function_call &, handle) {} + template = 0> + static void precall(function_call &) {} + template = 0> + static void postcall(function_call &call, handle ret) { + keep_alive_impl(Nurse, Patient, call, ret); + } +}; + +/// Recursively iterate over variadic template arguments +template +struct process_attributes { + static void init(const Args &...args, function_record *r) { + PYBIND11_WORKAROUND_INCORRECT_MSVC_C4100(r); + PYBIND11_WORKAROUND_INCORRECT_GCC_UNUSED_BUT_SET_PARAMETER(r); + using expander = int[]; + (void) expander{ + 0, ((void) process_attribute::type>::init(args, r), 0)...}; + } + static void init(const Args &...args, type_record *r) { + PYBIND11_WORKAROUND_INCORRECT_MSVC_C4100(r); + PYBIND11_WORKAROUND_INCORRECT_GCC_UNUSED_BUT_SET_PARAMETER(r); + using expander = int[]; + (void) expander{0, + (process_attribute::type>::init(args, r), 0)...}; + } + static void precall(function_call &call) { + PYBIND11_WORKAROUND_INCORRECT_MSVC_C4100(call); + using expander = int[]; + (void) expander{0, + (process_attribute::type>::precall(call), 0)...}; + } + static void postcall(function_call &call, handle fn_ret) { + PYBIND11_WORKAROUND_INCORRECT_MSVC_C4100(call, fn_ret); + PYBIND11_WORKAROUND_INCORRECT_GCC_UNUSED_BUT_SET_PARAMETER(fn_ret); + using expander = int[]; + (void) expander{ + 0, (process_attribute::type>::postcall(call, fn_ret), 0)...}; + } +}; + +template +using is_call_guard = is_instantiation; + +/// Extract the ``type`` from the first `call_guard` in `Extras...` (or `void_type` if none found) +template +using extract_guard_t = typename exactly_one_t, Extra...>::type; + +/// Check the number of named arguments at compile time +template ::value...), + size_t self = constexpr_sum(std::is_same::value...)> +constexpr bool expected_num_args(size_t nargs, bool has_args, bool has_kwargs) { + PYBIND11_WORKAROUND_INCORRECT_MSVC_C4100(nargs, has_args, has_kwargs); + return named == 0 || (self + named + size_t(has_args) + size_t(has_kwargs)) == nargs; +} + +PYBIND11_NAMESPACE_END(detail) +PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/third_party/pybind11/include/pybind11/buffer_info.h b/third_party/pybind11/include/pybind11/buffer_info.h new file mode 100644 index 0000000..75aec0b --- /dev/null +++ b/third_party/pybind11/include/pybind11/buffer_info.h @@ -0,0 +1,208 @@ +/* + pybind11/buffer_info.h: Python buffer object interface + + Copyright (c) 2016 Wenzel Jakob + + 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 "detail/common.h" + +PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +PYBIND11_NAMESPACE_BEGIN(detail) + +// Default, C-style strides +inline std::vector c_strides(const std::vector &shape, ssize_t itemsize) { + auto ndim = shape.size(); + std::vector strides(ndim, itemsize); + if (ndim > 0) { + for (size_t i = ndim - 1; i > 0; --i) { + strides[i - 1] = strides[i] * shape[i]; + } + } + return strides; +} + +// F-style strides; default when constructing an array_t with `ExtraFlags & f_style` +inline std::vector f_strides(const std::vector &shape, ssize_t itemsize) { + auto ndim = shape.size(); + std::vector strides(ndim, itemsize); + for (size_t i = 1; i < ndim; ++i) { + strides[i] = strides[i - 1] * shape[i - 1]; + } + return strides; +} + +template +struct compare_buffer_info; + +PYBIND11_NAMESPACE_END(detail) + +/// Information record describing a Python buffer object +struct buffer_info { + void *ptr = nullptr; // Pointer to the underlying storage + ssize_t itemsize = 0; // Size of individual items in bytes + ssize_t size = 0; // Total number of entries + std::string format; // For homogeneous buffers, this should be set to + // format_descriptor::format() + ssize_t ndim = 0; // Number of dimensions + std::vector shape; // Shape of the tensor (1 entry per dimension) + std::vector strides; // Number of bytes between adjacent entries + // (for each per dimension) + bool readonly = false; // flag to indicate if the underlying storage may be written to + + buffer_info() = default; + + buffer_info(void *ptr, + ssize_t itemsize, + const std::string &format, + ssize_t ndim, + detail::any_container shape_in, + detail::any_container strides_in, + bool readonly = false) + : ptr(ptr), itemsize(itemsize), size(1), format(format), ndim(ndim), + shape(std::move(shape_in)), strides(std::move(strides_in)), readonly(readonly) { + if (ndim != (ssize_t) shape.size() || ndim != (ssize_t) strides.size()) { + pybind11_fail("buffer_info: ndim doesn't match shape and/or strides length"); + } + for (size_t i = 0; i < (size_t) ndim; ++i) { + size *= shape[i]; + } + } + + template + buffer_info(T *ptr, + detail::any_container shape_in, + detail::any_container strides_in, + bool readonly = false) + : buffer_info(private_ctr_tag(), + ptr, + sizeof(T), + format_descriptor::format(), + static_cast(shape_in->size()), + std::move(shape_in), + std::move(strides_in), + readonly) {} + + buffer_info(void *ptr, + ssize_t itemsize, + const std::string &format, + ssize_t size, + bool readonly = false) + : buffer_info(ptr, itemsize, format, 1, {size}, {itemsize}, readonly) {} + + template + buffer_info(T *ptr, ssize_t size, bool readonly = false) + : buffer_info(ptr, sizeof(T), format_descriptor::format(), size, readonly) {} + + template + buffer_info(const T *ptr, ssize_t size, bool readonly = true) + : buffer_info( + const_cast(ptr), sizeof(T), format_descriptor::format(), size, readonly) {} + + explicit buffer_info(Py_buffer *view, bool ownview = true) + : buffer_info( + view->buf, + view->itemsize, + view->format, + view->ndim, + {view->shape, view->shape + view->ndim}, + /* Though buffer::request() requests PyBUF_STRIDES, ctypes objects + * ignore this flag and return a view with NULL strides. + * When strides are NULL, build them manually. */ + view->strides + ? std::vector(view->strides, view->strides + view->ndim) + : detail::c_strides({view->shape, view->shape + view->ndim}, view->itemsize), + (view->readonly != 0)) { + // NOLINTNEXTLINE(cppcoreguidelines-prefer-member-initializer) + this->m_view = view; + // NOLINTNEXTLINE(cppcoreguidelines-prefer-member-initializer) + this->ownview = ownview; + } + + buffer_info(const buffer_info &) = delete; + buffer_info &operator=(const buffer_info &) = delete; + + buffer_info(buffer_info &&other) noexcept { (*this) = std::move(other); } + + buffer_info &operator=(buffer_info &&rhs) noexcept { + ptr = rhs.ptr; + itemsize = rhs.itemsize; + size = rhs.size; + format = std::move(rhs.format); + ndim = rhs.ndim; + shape = std::move(rhs.shape); + strides = std::move(rhs.strides); + std::swap(m_view, rhs.m_view); + std::swap(ownview, rhs.ownview); + readonly = rhs.readonly; + return *this; + } + + ~buffer_info() { + if (m_view && ownview) { + PyBuffer_Release(m_view); + delete m_view; + } + } + + Py_buffer *view() const { 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(b)` and + // `buffer_info::item_type_is_equivalent_to(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 + bool item_type_is_equivalent_to() const { + return detail::compare_buffer_info::compare(*this); + } + +private: + struct private_ctr_tag {}; + + buffer_info(private_ctr_tag, + void *ptr, + ssize_t itemsize, + const std::string &format, + ssize_t ndim, + detail::any_container &&shape_in, + detail::any_container &&strides_in, + bool readonly) + : buffer_info( + ptr, itemsize, format, ndim, std::move(shape_in), std::move(strides_in), readonly) {} + + Py_buffer *m_view = nullptr; + bool ownview = false; +}; + +PYBIND11_NAMESPACE_BEGIN(detail) + +template +struct compare_buffer_info { + static bool compare(const buffer_info &b) { + // NOLINTNEXTLINE(bugprone-sizeof-expression) Needed for `PyObject *` + return b.format == format_descriptor::format() && b.itemsize == (ssize_t) sizeof(T); + } +}; + +template +struct compare_buffer_info::value>> { + static bool compare(const buffer_info &b) { + return (size_t) b.itemsize == sizeof(T) + && (b.format == format_descriptor::value + || ((sizeof(T) == sizeof(long)) + && b.format == (std::is_unsigned::value ? "L" : "l")) + || ((sizeof(T) == sizeof(size_t)) + && b.format == (std::is_unsigned::value ? "N" : "n"))); + } +}; + +PYBIND11_NAMESPACE_END(detail) +PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/third_party/pybind11/include/pybind11/cast.h b/third_party/pybind11/include/pybind11/cast.h new file mode 100644 index 0000000..c635791 --- /dev/null +++ b/third_party/pybind11/include/pybind11/cast.h @@ -0,0 +1,2361 @@ +/* + pybind11/cast.h: Partial template specializations to cast between + C++ and Python types + + Copyright (c) 2016 Wenzel Jakob + + 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 "detail/common.h" +#include "detail/descr.h" +#include "detail/native_enum_data.h" +#include "detail/type_caster_base.h" +#include "detail/typeid.h" +#include "pytypes.h" + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +PYBIND11_WARNING_DISABLE_MSVC(4127) + +PYBIND11_NAMESPACE_BEGIN(detail) + +template +class type_caster : public type_caster_base {}; +template +using make_caster = type_caster>; + +// Shortcut for calling a caster's `cast_op_type` cast operator for casting a type_caster to a T +template +typename make_caster::template cast_op_type cast_op(make_caster &caster) { + using result_t = typename make_caster::template cast_op_type; // See PR #4893 + return caster.operator result_t(); +} +template +typename make_caster::template cast_op_type::type> +cast_op(make_caster &&caster) { + using result_t = typename make_caster::template cast_op_type< + typename std::add_rvalue_reference::type>; // See PR #4893 + return std::move(caster).operator result_t(); +} + +template +class type_caster_enum_type { +private: + using Underlying = typename std::underlying_type::type; + +public: + static constexpr auto name = const_name(); + + template + static handle cast(SrcType &&src, return_value_policy, handle parent) { + handle native_enum + = global_internals_native_enum_type_map_get_item(std::type_index(typeid(EnumType))); + if (native_enum) { + return native_enum(static_cast(src)).release(); + } + return type_caster_base::cast( + std::forward(src), + // Fixes https://github.com/pybind/pybind11/pull/3643#issuecomment-1022987818: + return_value_policy::copy, + parent); + } + + template + static handle cast(SrcType *src, return_value_policy policy, handle parent) { + return cast(*src, policy, parent); + } + + bool load(handle src, bool convert) { + handle native_enum + = global_internals_native_enum_type_map_get_item(std::type_index(typeid(EnumType))); + if (native_enum) { + if (!isinstance(src, native_enum)) { + return false; + } + type_caster underlying_caster; + if (!underlying_caster.load(src.attr("value"), convert)) { + pybind11_fail("native_enum internal consistency failure."); + } + value = static_cast(static_cast(underlying_caster)); + return true; + } + if (!pybind11_enum_) { + pybind11_enum_.reset(new type_caster_base()); + } + return pybind11_enum_->load(src, convert); + } + + template + using cast_op_type = detail::cast_op_type; + + // NOLINTNEXTLINE(google-explicit-constructor) + operator EnumType *() { + if (!pybind11_enum_) { + return &value; + } + return pybind11_enum_->operator EnumType *(); + } + + // NOLINTNEXTLINE(google-explicit-constructor) + operator EnumType &() { + if (!pybind11_enum_) { + return value; + } + return pybind11_enum_->operator EnumType &(); + } + +private: + std::unique_ptr> pybind11_enum_; + EnumType value; +}; + +template +struct type_caster_enum_type_enabled : std::true_type {}; + +template +struct type_uses_type_caster_enum_type { + static constexpr bool value + = std::is_enum::value && type_caster_enum_type_enabled::value; +}; + +template +class type_caster::value>> + : public type_caster_enum_type {}; + +template ::value, int> = 0> +bool isinstance_native_enum_impl(handle obj, const std::type_info &tp) { + handle native_enum = global_internals_native_enum_type_map_get_item(tp); + if (!native_enum) { + return false; + } + return isinstance(obj, native_enum); +} + +template ::value, int> = 0> +bool isinstance_native_enum_impl(handle, const std::type_info &) { + return false; +} + +template +bool isinstance_native_enum(handle obj, const std::type_info &tp) { + return isinstance_native_enum_impl>(obj, tp); +} + +template +class type_caster> { +private: + using caster_t = make_caster; + caster_t subcaster; + using reference_t = type &; + using subcaster_cast_op_type = typename caster_t::template cast_op_type; + + static_assert( + std::is_same::type &, subcaster_cast_op_type>::value + || std::is_same::value, + "std::reference_wrapper 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 &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 + using cast_op_type = std::reference_wrapper; + explicit operator std::reference_wrapper() { return cast_op(subcaster); } +}; + +#define PYBIND11_TYPE_CASTER(type, py_name) \ +protected: \ + type value; \ + \ +public: \ + static constexpr auto name = py_name; \ + template >::value, \ + int> \ + = 0> \ + static ::pybind11::handle cast( \ + T_ *src, ::pybind11::return_value_policy policy, ::pybind11::handle parent) { \ + if (!src) \ + return ::pybind11::none().release(); \ + if (policy == ::pybind11::return_value_policy::take_ownership) { \ + auto h = cast(std::move(*src), policy, parent); \ + delete src; \ + return h; \ + } \ + return cast(*src, policy, parent); \ + } \ + operator type *() { return &value; } /* NOLINT(bugprone-macro-parentheses) */ \ + operator type &() { return value; } /* NOLINT(bugprone-macro-parentheses) */ \ + operator type &&() && { return std::move(value); } /* NOLINT(bugprone-macro-parentheses) */ \ + template \ + using cast_op_type = ::pybind11::detail::movable_cast_op_type + +template +using is_std_char_type = any_of, /* std::string */ +#if defined(PYBIND11_HAS_U8STRING) + std::is_same, /* std::u8string */ +#endif + std::is_same, /* std::u16string */ + std::is_same, /* std::u32string */ + std::is_same /* std::wstring */ + >; + +template +struct type_caster::value && !is_std_char_type::value>> { + using _py_type_0 = conditional_t; + using _py_type_1 = conditional_t::value, + _py_type_0, + typename std::make_unsigned<_py_type_0>::type>; + using py_type = conditional_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::value) { + if (convert || PyFloat_Check(src.ptr())) { + py_value = (py_type) PyFloat_AsDouble(src.ptr()); + } else { + return false; + } + } else if (PyFloat_Check(src.ptr()) + || (!convert && !PYBIND11_LONG_CHECK(src.ptr()) && !index_check(src.ptr()))) { + return false; + } else { + handle src_or_index = src; + // PyPy: 7.3.7's 3.8 does not implement PyLong_*'s __index__ calls. +#if defined(PYPY_VERSION) + object index; + if (!PYBIND11_LONG_CHECK(src.ptr())) { // So: index_check(src.ptr()) + index = reinterpret_steal(PyNumber_Index(src.ptr())); + if (!index) { + PyErr_Clear(); + if (!convert) + return false; + } else { + src_or_index = index; + } + } +#endif + if (std::is_unsigned::value) { + py_value = as_unsigned(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::value && sizeof(py_type) != sizeof(T) + && py_value != (py_type) (T) py_value)) { + PyErr_Clear(); + if (py_err && convert && (PyNumber_Check(src.ptr()) != 0)) { + auto tmp = reinterpret_steal(std::is_floating_point::value + ? PyNumber_Float(src.ptr()) + : PyNumber_Long(src.ptr())); + PyErr_Clear(); + return load(tmp, false); + } + return false; + } + + value = (T) py_value; + return true; + } + + template + static typename std::enable_if::value, handle>::type + cast(U src, return_value_policy /* policy */, handle /* parent */) { + return PyFloat_FromDouble((double) src); + } + + template + static typename std::enable_if::value && std::is_signed::value + && (sizeof(U) <= sizeof(long)), + handle>::type + cast(U src, return_value_policy /* policy */, handle /* parent */) { + return PYBIND11_LONG_FROM_SIGNED((long) src); + } + + template + static typename std::enable_if::value && std::is_unsigned::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 + static typename std::enable_if::value && std::is_signed::value + && (sizeof(U) > sizeof(long)), + handle>::type + cast(U src, return_value_policy /* policy */, handle /* parent */) { + return PyLong_FromLongLong((long long) src); + } + + template + static typename std::enable_if::value && std::is_unsigned::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, + io_name::value>( + "typing.SupportsInt", "int", "typing.SupportsFloat", "float")); +}; + +template +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().release(); + } + PYBIND11_TYPE_CASTER(T, const_name("None")); +}; + +template <> +class type_caster : public void_caster {}; + +template <> +class type_caster : public type_caster { +public: + using type_caster::cast; + + bool load(handle h, bool) { + if (!h) { + return false; + } + if (h.is_none()) { + value = nullptr; + return true; + } + + /* Check if this is a capsule */ + if (isinstance(h)) { + value = reinterpret_borrow(h); + return true; + } + + /* Check if this is a C++ type */ + const 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(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(); + } + return none().release(); + } + + template + using cast_op_type = void *&; + explicit operator void *&() { return value; } + static constexpr auto name = const_name(PYBIND11_CAPSULE_TYPE_TYPE_HINT); + +private: + void *value = nullptr; +}; + +template <> +class type_caster : public void_caster {}; + +template <> +class type_caster { +public: + bool load(handle src, bool convert) { + if (!src) { + return false; + } + if (src.ptr() == Py_True) { + value = true; + return true; + } + if (src.ptr() == Py_False) { + value = false; + return true; + } + if (convert || is_numpy_bool(src)) { + // (allow non-implicit conversion for numpy booleans), use strncmp + // since NumPy 1.x had an additional trailing underscore. + + 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__" 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 = Py_TYPE(src.ptr())->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 = (res != 0); + return true; + } + 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, const_name("bool")); + +private: + // Test if an object is a NumPy boolean (without fetching the type). + static inline bool is_numpy_bool(handle object) { + const char *type_name = Py_TYPE(object.ptr())->tp_name; + // Name changed to `numpy.bool` in NumPy 2, `numpy.bool_` is needed for 1.x support + return std::strcmp("numpy.bool", type_name) == 0 + || std::strcmp("numpy.bool_", type_name) == 0; + } +}; + +// Helper class for UTF-{8,16,32} C++ stl strings: +template +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::value || sizeof(CharT) == 1, + "Unsupported char size != 1"); +#if defined(PYBIND11_HAS_U8STRING) + static_assert(!std::is_same::value || sizeof(CharT) == 1, + "Unsupported char8_t size != 1"); +#endif + static_assert(!std::is_same::value || sizeof(CharT) == 2, + "Unsupported char16_t size != 2"); + static_assert(!std::is_same::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::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) { + handle load_src = src; + if (!src) { + return false; + } + if (!PyUnicode_Check(load_src.ptr())) { + return load_raw(load_src); + } + + // For UTF-8 we avoid the need for a temporary `bytes` object by using + // `PyUnicode_AsUTF8AndSize`. + if (UTF_N == 8) { + Py_ssize_t size = -1; + const auto *buffer + = reinterpret_cast(PyUnicode_AsUTF8AndSize(load_src.ptr(), &size)); + if (!buffer) { + PyErr_Clear(); + return false; + } + value = StringType(buffer, static_cast(size)); + return true; + } + + auto utfNbytes + = reinterpret_steal(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(PYBIND11_BYTES_AS_STRING(utfNbytes.ptr())); + size_t length = (size_t) PYBIND11_BYTES_SIZE(utfNbytes.ptr()) / sizeof(CharT); + // Skip BOM for UTF-16/32 + if (UTF_N > 8) { + buffer++; + length--; + } + 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(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, const_name(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/bytearray 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 + bool load_raw(enable_if_t::value, handle> src) { + if (PYBIND11_BYTES_CHECK(src.ptr())) { + // We were passed 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) { + pybind11_fail("Unexpected PYBIND11_BYTES_AS_STRING() failure."); + } + value = StringType(bytes, (size_t) PYBIND11_BYTES_SIZE(src.ptr())); + return true; + } + if (PyByteArray_Check(src.ptr())) { + // We were passed a bytearray; accept it into a std::string or char* + // without any encoding attempt. + const char *bytearray = PyByteArray_AsString(src.ptr()); + if (!bytearray) { + pybind11_fail("Unexpected PyByteArray_AsString() failure."); + } + value = StringType(bytearray, (size_t) PyByteArray_Size(src.ptr())); + return true; + } + + return false; + } + + template + bool load_raw(enable_if_t::value, handle>) { + return false; + } +}; + +template +struct type_caster, + enable_if_t::value>> + : string_caster> {}; + +#ifdef PYBIND11_HAS_STRING_VIEW +template +struct type_caster, + enable_if_t::value>> + : string_caster, 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 +struct type_caster::value>> { + using StringType = std::basic_string; + using StringCaster = make_caster; + 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().release(); + } + return StringCaster::cast(StringType(src), policy, parent); + } + + static handle cast(CharT src, return_value_policy policy, handle parent) { + if (std::is_same::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); + } + + explicit operator CharT *() { + return none ? nullptr : const_cast(static_cast(str_caster).c_str()); + } + explicit operator CharT &() { + if (none) { + throw value_error("Cannot convert None to a character"); + } + + auto &value = static_cast(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(value[0]); + // low bits only: 0-127 + // 0b110xxxxx - start of 2-byte sequence + // 0b1110xxxx - start of 3-byte sequence + // 0b11110xxx - start of 4-byte sequence + size_t char0_bytes = (v0 & 0x80) == 0 ? 1 + : (v0 & 0xE0) == 0xC0 ? 2 + : (v0 & 0xF0) == 0xE0 ? 3 + : 4; + + 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(((v0 & 3) << 6) + + (static_cast(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(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 = const_name(PYBIND11_STRING_NAME); + template + using cast_op_type = pybind11::detail::cast_op_type<_T>; +}; + +// Base implementation for std::tuple and std::pair +template