commit
fba01da1c3
234 changed files with 61172 additions and 0 deletions
@ -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: 36 |
||||||
|
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* |
||||||
@ -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: '<pybind11/.*' |
||||||
|
Priority: -1 |
||||||
|
- Regex: 'pybind11.h"$' |
||||||
|
Priority: 1 |
||||||
|
- Regex: '^".*/?detail/' |
||||||
|
Priority: 1 |
||||||
|
SortPriority: 2 |
||||||
|
- Regex: '^"' |
||||||
|
Priority: 1 |
||||||
|
SortPriority: 3 |
||||||
|
- Regex: '<[[:alnum:]._]+>' |
||||||
|
Priority: 4 |
||||||
|
- Regex: '.*' |
||||||
|
Priority: 5 |
||||||
|
... |
||||||
@ -0,0 +1,77 @@ |
|||||||
|
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-easily-swappable-parameters, |
||||||
|
-bugprone-exception-escape, |
||||||
|
-bugprone-reserved-identifier, |
||||||
|
-bugprone-unused-raii, |
||||||
|
|
||||||
|
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' |
||||||
@ -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 |
||||||
@ -0,0 +1,24 @@ |
|||||||
|
template <op_id id, op_type ot, typename L = undefined_t, typename R = undefined_t> |
||||||
|
template <typename ThisT> |
||||||
|
auto &this_ = static_cast<ThisT &>(*this); |
||||||
|
if (load_impl<ThisT>(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<id, ot, Base, L_type, R_type>; |
||||||
|
template <op_id id, op_type ot, typename L, typename R> |
||||||
|
template <detail::op_id id, detail::op_type ot, typename L, typename R, typename... Extra> |
||||||
|
class_ &def(const detail::op_<id, ot, L, R> &op, const Extra &...extra) { |
||||||
|
class_ &def_cast(const detail::op_<id, ot, L, R> &op, const Extra &...extra) { |
||||||
|
@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_<IntStruct>(m, "IntStruct").def(py::init([](const int i) { return IntStruct(i); })); |
||||||
|
py::implicitly_convertible<int, IntStruct>(); |
||||||
|
m.def("test", [](int expected, const IntStruct &in) { |
||||||
|
[](int expected, const IntStruct &in) { |
||||||
@ -0,0 +1 @@ |
|||||||
|
docs/*.svg binary |
||||||
@ -0,0 +1 @@ |
|||||||
|
build/ |
||||||
@ -0,0 +1,181 @@ |
|||||||
|
# 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: |
||||||
|
# Standard hooks |
||||||
|
- repo: https://github.com/pre-commit/pre-commit-hooks |
||||||
|
rev: "v4.4.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 |
||||||
|
|
||||||
|
# Upgrade old Python syntax |
||||||
|
- repo: https://github.com/asottile/pyupgrade |
||||||
|
rev: "v3.3.1" |
||||||
|
hooks: |
||||||
|
- id: pyupgrade |
||||||
|
args: [--py36-plus] |
||||||
|
|
||||||
|
# Nicely sort includes |
||||||
|
- repo: https://github.com/PyCQA/isort |
||||||
|
rev: "5.12.0" |
||||||
|
hooks: |
||||||
|
- id: isort |
||||||
|
|
||||||
|
# Black, the code formatter, natively supports pre-commit |
||||||
|
- repo: https://github.com/psf/black |
||||||
|
rev: "23.1.0" # Keep in sync with blacken-docs |
||||||
|
hooks: |
||||||
|
- id: black |
||||||
|
|
||||||
|
# Also code format the docs |
||||||
|
- repo: https://github.com/asottile/blacken-docs |
||||||
|
rev: "1.13.0" |
||||||
|
hooks: |
||||||
|
- id: blacken-docs |
||||||
|
additional_dependencies: |
||||||
|
- black==23.1.0 # keep in sync with black hook |
||||||
|
|
||||||
|
# Changes tabs to spaces |
||||||
|
- repo: https://github.com/Lucas-C/pre-commit-hooks |
||||||
|
rev: "v1.4.2" |
||||||
|
hooks: |
||||||
|
- id: remove-tabs |
||||||
|
|
||||||
|
- repo: https://github.com/sirosen/texthooks |
||||||
|
rev: "0.5.0" |
||||||
|
hooks: |
||||||
|
- id: fix-ligatures |
||||||
|
- id: fix-smartquotes |
||||||
|
|
||||||
|
# Autoremoves unused imports |
||||||
|
- repo: https://github.com/hadialqattan/pycln |
||||||
|
rev: "v2.1.3" |
||||||
|
hooks: |
||||||
|
- id: pycln |
||||||
|
stages: [manual] |
||||||
|
|
||||||
|
# Checking for common mistakes |
||||||
|
- repo: https://github.com/pre-commit/pygrep-hooks |
||||||
|
rev: "v1.10.0" |
||||||
|
hooks: |
||||||
|
- id: python-check-blanket-noqa |
||||||
|
- id: python-check-blanket-type-ignore |
||||||
|
- id: python-no-log-warn |
||||||
|
- id: python-use-type-annotations |
||||||
|
- id: rst-backticks |
||||||
|
- id: rst-directive-colons |
||||||
|
- id: rst-inline-touching-normal |
||||||
|
|
||||||
|
# Automatically remove noqa that are not used |
||||||
|
- repo: https://github.com/asottile/yesqa |
||||||
|
rev: "v1.4.0" |
||||||
|
hooks: |
||||||
|
- id: yesqa |
||||||
|
additional_dependencies: &flake8_dependencies |
||||||
|
- flake8-bugbear |
||||||
|
- pep8-naming |
||||||
|
|
||||||
|
# Flake8 also supports pre-commit natively (same author) |
||||||
|
- repo: https://github.com/PyCQA/flake8 |
||||||
|
rev: "6.0.0" |
||||||
|
hooks: |
||||||
|
- id: flake8 |
||||||
|
exclude: ^(docs/.*|tools/.*)$ |
||||||
|
additional_dependencies: *flake8_dependencies |
||||||
|
|
||||||
|
# PyLint has native support - not always usable, but works for us |
||||||
|
- repo: https://github.com/PyCQA/pylint |
||||||
|
rev: "v2.16.1" |
||||||
|
hooks: |
||||||
|
- id: pylint |
||||||
|
files: ^pybind11 |
||||||
|
|
||||||
|
# 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)?$ |
||||||
|
|
||||||
|
# Check static types with mypy |
||||||
|
- repo: https://github.com/pre-commit/mirrors-mypy |
||||||
|
rev: "v0.991" |
||||||
|
hooks: |
||||||
|
- id: mypy |
||||||
|
args: [] |
||||||
|
exclude: ^(tests|docs)/ |
||||||
|
additional_dependencies: [nox, rich] |
||||||
|
|
||||||
|
# Checks the manifest for missing files (native support) |
||||||
|
- repo: https://github.com/mgedmin/check-manifest |
||||||
|
rev: "0.49" |
||||||
|
hooks: |
||||||
|
- id: check-manifest |
||||||
|
# This is a slow hook, so only run this if --hook-stage manual is passed |
||||||
|
stages: [manual] |
||||||
|
additional_dependencies: [cmake, ninja] |
||||||
|
|
||||||
|
# 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.2.2" |
||||||
|
hooks: |
||||||
|
- id: codespell |
||||||
|
exclude: ".supp$" |
||||||
|
args: ["-x", ".codespell-ignore-lines"] |
||||||
|
|
||||||
|
# Check for common shell mistakes |
||||||
|
- repo: https://github.com/shellcheck-py/shellcheck-py |
||||||
|
rev: "v0.9.0.2" |
||||||
|
hooks: |
||||||
|
- id: shellcheck |
||||||
|
|
||||||
|
# Disallow some common capitalization mistakes |
||||||
|
- repo: local |
||||||
|
hooks: |
||||||
|
- id: disallow-caps |
||||||
|
name: Disallow improper capitalization |
||||||
|
language: pygrep |
||||||
|
entry: PyBind|Numpy|Cmake|CCache|PyTest |
||||||
|
exclude: ^\.pre-commit-config.yaml$ |
||||||
|
|
||||||
|
# Clang format the codebase automatically |
||||||
|
- repo: https://github.com/pre-commit/mirrors-clang-format |
||||||
|
rev: "v15.0.7" |
||||||
|
hooks: |
||||||
|
- id: clang-format |
||||||
|
types_or: [c++, c, cuda] |
||||||
@ -0,0 +1,3 @@ |
|||||||
|
python: |
||||||
|
version: 3 |
||||||
|
requirements_file: docs/requirements.txt |
||||||
@ -0,0 +1,320 @@ |
|||||||
|
# CMakeLists.txt -- Build system for the pybind11 modules |
||||||
|
# |
||||||
|
# Copyright (c) 2015 Wenzel Jakob <wenzel@inf.ethz.ch> |
||||||
|
# |
||||||
|
# All rights reserved. Use of this source code is governed by a |
||||||
|
# BSD-style license that can be found in the LICENSE file. |
||||||
|
|
||||||
|
cmake_minimum_required(VERSION 3.4) |
||||||
|
|
||||||
|
# The `cmake_minimum_required(VERSION 3.4...3.22)` syntax does not work with |
||||||
|
# some versions of VS that have a patched CMake 3.11. This forces us to emulate |
||||||
|
# the behavior using the following workaround: |
||||||
|
if(${CMAKE_VERSION} VERSION_LESS 3.22) |
||||||
|
cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}) |
||||||
|
else() |
||||||
|
cmake_policy(VERSION 3.22) |
||||||
|
endif() |
||||||
|
|
||||||
|
# Avoid infinite recursion if tests include this as a subdirectory |
||||||
|
if(DEFINED PYBIND11_MASTER_PROJECT) |
||||||
|
return() |
||||||
|
endif() |
||||||
|
|
||||||
|
# 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) |
||||||
|
|
||||||
|
if(OSX AND CMAKE_VERSION VERSION_LESS 3.7) |
||||||
|
# Bug in macOS CMake < 3.7 is unable to download catch |
||||||
|
message(WARNING "CMAKE 3.7+ needed on macOS to download catch, and newer HIGHLY recommended") |
||||||
|
elseif(WINDOWS AND CMAKE_VERSION VERSION_LESS 3.8) |
||||||
|
# Only tested with 3.8+ in CI. |
||||||
|
message(WARNING "CMAKE 3.8+ tested on Windows, previous versions untested") |
||||||
|
endif() |
||||||
|
|
||||||
|
message(STATUS "CMake ${CMAKE_VERSION}") |
||||||
|
|
||||||
|
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) |
||||||
|
else() |
||||||
|
set(PYBIND11_MASTER_PROJECT OFF) |
||||||
|
set(pybind11_system SYSTEM) |
||||||
|
endif() |
||||||
|
|
||||||
|
# Options |
||||||
|
option(PYBIND11_INSTALL "Install pybind11 header files?" ${PYBIND11_MASTER_PROJECT}) |
||||||
|
option(PYBIND11_TEST "Build pybind11 test suite?" OFF) |
||||||
|
option(PYBIND11_NOPYTHON "Disable search for Python" 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.") |
||||||
|
|
||||||
|
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) |
||||||
|
|
||||||
|
cmake_dependent_option(PYBIND11_FINDPYTHON "Force new FindPython" OFF |
||||||
|
"NOT CMAKE_VERSION VERSION_LESS 3.12" OFF) |
||||||
|
|
||||||
|
# NB: when adding a header don't forget to also add it to setup.py |
||||||
|
set(PYBIND11_HEADERS |
||||||
|
include/pybind11/detail/class.h |
||||||
|
include/pybind11/detail/common.h |
||||||
|
include/pybind11/detail/descr.h |
||||||
|
include/pybind11/detail/init.h |
||||||
|
include/pybind11/detail/internals.h |
||||||
|
include/pybind11/detail/type_caster_base.h |
||||||
|
include/pybind11/detail/typeid.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/options.h |
||||||
|
include/pybind11/eigen.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/iostream.h |
||||||
|
include/pybind11/functional.h |
||||||
|
include/pybind11/numpy.h |
||||||
|
include/pybind11/operators.h |
||||||
|
include/pybind11/pybind11.h |
||||||
|
include/pybind11/pytypes.h |
||||||
|
include/pybind11/stl.h |
||||||
|
include/pybind11/stl_bind.h |
||||||
|
include/pybind11/stl/filesystem.h) |
||||||
|
|
||||||
|
# Compare with grep and warn if mismatched |
||||||
|
if(PYBIND11_MASTER_PROJECT AND NOT CMAKE_VERSION VERSION_LESS 3.12) |
||||||
|
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() |
||||||
|
|
||||||
|
# CMake 3.12 added list(TRANSFORM <list> PREPEND |
||||||
|
# But we can't use it yet |
||||||
|
string(REPLACE "include/" "${CMAKE_CURRENT_SOURCE_DIR}/include/" PYBIND11_HEADERS |
||||||
|
"${PYBIND11_HEADERS}") |
||||||
|
|
||||||
|
# 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 $<BUILD_INTERFACE:${pybind11_INCLUDE_DIR}> |
||||||
|
$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>) |
||||||
|
|
||||||
|
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) |
||||||
|
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}) |
||||||
|
|
||||||
|
if(CMAKE_VERSION VERSION_LESS 3.14) |
||||||
|
# Remove CMAKE_SIZEOF_VOID_P from ConfigVersion.cmake since the library does |
||||||
|
# not depend on architecture specific settings or libraries. |
||||||
|
set(_PYBIND11_CMAKE_SIZEOF_VOID_P ${CMAKE_SIZEOF_VOID_P}) |
||||||
|
unset(CMAKE_SIZEOF_VOID_P) |
||||||
|
|
||||||
|
write_basic_package_version_file( |
||||||
|
${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake |
||||||
|
VERSION ${PROJECT_VERSION} |
||||||
|
COMPATIBILITY AnyNewerVersion) |
||||||
|
|
||||||
|
set(CMAKE_SIZEOF_VOID_P ${_PYBIND11_CMAKE_SIZEOF_VOID_P}) |
||||||
|
else() |
||||||
|
# CMake 3.14+ 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) |
||||||
|
endif() |
||||||
|
|
||||||
|
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 |
||||||
|
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) |
||||||
|
set(prefix_for_pc_file "${CMAKE_INSTALL_PREFIX}") |
||||||
|
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/") |
||||||
|
|
||||||
|
# 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() |
||||||
@ -0,0 +1,2 @@ |
|||||||
|
zlib >= 1.2.5 |
||||||
|
HDF5 >= 1.10.1 |
||||||
@ -0,0 +1,29 @@ |
|||||||
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch>, 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. |
||||||
@ -0,0 +1,6 @@ |
|||||||
|
prune tests |
||||||
|
recursive-include pybind11/include/pybind11 *.h |
||||||
|
recursive-include pybind11 *.py |
||||||
|
recursive-include pybind11 py.typed |
||||||
|
include pybind11/share/cmake/pybind11/*.cmake |
||||||
|
include LICENSE README.rst pyproject.toml setup.py setup.cfg |
||||||
@ -0,0 +1,19 @@ |
|||||||
|
#!/usr/bin/env bash |
||||||
|
|
||||||
|
if [ -z "$1" ] |
||||||
|
then |
||||||
|
printf "Usage: setup.sh install_directory [dependencies].\n" 1>&2 |
||||||
|
exit 1 |
||||||
|
fi |
||||||
|
|
||||||
|
cd $(dirname $0) |
||||||
|
libname=$(basename $(pwd)) |
||||||
|
mkdir -p build |
||||||
|
cd build |
||||||
|
cmake -DCMAKE_INSTALL_DATAROOTDIR="$1" -DCMAKE_INSTALL_INCLUDEDIR="$1/include" -Wno-dev ../ |
||||||
|
make -j8 install |
||||||
|
|
||||||
|
# Moving directories |
||||||
|
mv "$1/include/pybind11" "$1/temp" |
||||||
|
rmdir "$1/include" |
||||||
|
mv "$1/temp" "$1/include" |
||||||
@ -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 |
||||||
@ -0,0 +1,192 @@ |
|||||||
|
# Makefile for Sphinx documentation
|
||||||
|
#
|
||||||
|
|
||||||
|
# You can set these variables from the command line.
|
||||||
|
SPHINXOPTS =
|
||||||
|
SPHINXBUILD = sphinx-build
|
||||||
|
PAPER =
|
||||||
|
BUILDDIR = .build
|
||||||
|
|
||||||
|
# User-friendly check for sphinx-build
|
||||||
|
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) |
||||||
|
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) |
||||||
|
endif |
||||||
|
|
||||||
|
# Internal variables.
|
||||||
|
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||||
|
PAPEROPT_letter = -D latex_paper_size=letter
|
||||||
|
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||||
|
# the i18n builder cannot share the environment and doctrees with the others
|
||||||
|
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||||
|
|
||||||
|
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext |
||||||
|
|
||||||
|
help: |
||||||
|
@echo "Please use \`make <target>' where <target> is one of"
|
||||||
|
@echo " html to make standalone HTML files"
|
||||||
|
@echo " dirhtml to make HTML files named index.html in directories"
|
||||||
|
@echo " singlehtml to make a single large HTML file"
|
||||||
|
@echo " pickle to make pickle files"
|
||||||
|
@echo " json to make JSON files"
|
||||||
|
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||||
|
@echo " qthelp to make HTML files and a qthelp project"
|
||||||
|
@echo " applehelp to make an Apple Help Book"
|
||||||
|
@echo " devhelp to make HTML files and a Devhelp project"
|
||||||
|
@echo " epub to make an epub"
|
||||||
|
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||||
|
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||||
|
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
||||||
|
@echo " text to make text files"
|
||||||
|
@echo " man to make manual pages"
|
||||||
|
@echo " texinfo to make Texinfo files"
|
||||||
|
@echo " info to make Texinfo files and run them through makeinfo"
|
||||||
|
@echo " gettext to make PO message catalogs"
|
||||||
|
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||||
|
@echo " xml to make Docutils-native XML files"
|
||||||
|
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
||||||
|
@echo " linkcheck to check all external links for integrity"
|
||||||
|
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||||
|
@echo " coverage to run coverage check of the documentation (if enabled)"
|
||||||
|
|
||||||
|
clean: |
||||||
|
rm -rf $(BUILDDIR)/*
|
||||||
|
|
||||||
|
html: |
||||||
|
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||||
|
|
||||||
|
dirhtml: |
||||||
|
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||||
|
|
||||||
|
singlehtml: |
||||||
|
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||||
|
|
||||||
|
pickle: |
||||||
|
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can process the pickle files."
|
||||||
|
|
||||||
|
json: |
||||||
|
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can process the JSON files."
|
||||||
|
|
||||||
|
htmlhelp: |
||||||
|
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||||
|
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||||
|
|
||||||
|
qthelp: |
||||||
|
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||||
|
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||||
|
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pybind11.qhcp"
|
||||||
|
@echo "To view the help file:"
|
||||||
|
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pybind11.qhc"
|
||||||
|
|
||||||
|
applehelp: |
||||||
|
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
|
||||||
|
@echo "N.B. You won't be able to view it unless you put it in" \
|
||||||
|
"~/Library/Documentation/Help or install it in your application" \
|
||||||
|
"bundle."
|
||||||
|
|
||||||
|
devhelp: |
||||||
|
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||||
|
@echo
|
||||||
|
@echo "Build finished."
|
||||||
|
@echo "To view the help file:"
|
||||||
|
@echo "# mkdir -p $$HOME/.local/share/devhelp/pybind11"
|
||||||
|
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pybind11"
|
||||||
|
@echo "# devhelp"
|
||||||
|
|
||||||
|
epub: |
||||||
|
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||||
|
|
||||||
|
latex: |
||||||
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||||
|
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||||
|
"(use \`make latexpdf' here to do that automatically)."
|
||||||
|
|
||||||
|
latexpdf: |
||||||
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||||
|
@echo "Running LaTeX files through pdflatex..."
|
||||||
|
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||||
|
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||||
|
|
||||||
|
latexpdfja: |
||||||
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||||
|
@echo "Running LaTeX files through platex and dvipdfmx..."
|
||||||
|
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
||||||
|
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||||
|
|
||||||
|
text: |
||||||
|
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||||
|
|
||||||
|
man: |
||||||
|
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||||
|
|
||||||
|
texinfo: |
||||||
|
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||||
|
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||||
|
"(use \`make info' here to do that automatically)."
|
||||||
|
|
||||||
|
info: |
||||||
|
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||||
|
@echo "Running Texinfo files through makeinfo..."
|
||||||
|
make -C $(BUILDDIR)/texinfo info
|
||||||
|
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||||
|
|
||||||
|
gettext: |
||||||
|
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||||
|
|
||||||
|
changes: |
||||||
|
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||||
|
@echo
|
||||||
|
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||||
|
|
||||||
|
linkcheck: |
||||||
|
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||||
|
@echo
|
||||||
|
@echo "Link check complete; look for any errors in the above output " \
|
||||||
|
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||||
|
|
||||||
|
doctest: |
||||||
|
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||||
|
@echo "Testing of doctests in the sources finished, look at the " \
|
||||||
|
"results in $(BUILDDIR)/doctest/output.txt."
|
||||||
|
|
||||||
|
coverage: |
||||||
|
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
|
||||||
|
@echo "Testing of coverage in the sources finished, look at the " \
|
||||||
|
"results in $(BUILDDIR)/coverage/python.txt."
|
||||||
|
|
||||||
|
xml: |
||||||
|
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||||
|
|
||||||
|
pseudoxml: |
||||||
|
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||||
@ -0,0 +1,3 @@ |
|||||||
|
.highlight .go { |
||||||
|
color: #707070; |
||||||
|
} |
||||||
@ -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. |
||||||
@ -0,0 +1,93 @@ |
|||||||
|
Custom type casters |
||||||
|
=================== |
||||||
|
|
||||||
|
In very rare cases, applications may require custom type casters that cannot be |
||||||
|
expressed using the abstractions provided by pybind11, thus requiring raw |
||||||
|
Python C API calls. This is fairly advanced usage and should only be pursued by |
||||||
|
experts who are familiar with the intricacies of Python reference counting. |
||||||
|
|
||||||
|
The following snippets demonstrate how this works for a very simple ``inty`` |
||||||
|
type that that should be convertible from Python types that provide a |
||||||
|
``__int__(self)`` method. |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
struct inty { long long_value; }; |
||||||
|
|
||||||
|
void print(inty s) { |
||||||
|
std::cout << s.long_value << std::endl; |
||||||
|
} |
||||||
|
|
||||||
|
The following Python snippet demonstrates the intended usage from the Python side: |
||||||
|
|
||||||
|
.. code-block:: python |
||||||
|
|
||||||
|
class A: |
||||||
|
def __int__(self): |
||||||
|
return 123 |
||||||
|
|
||||||
|
|
||||||
|
from example import print |
||||||
|
|
||||||
|
print(A()) |
||||||
|
|
||||||
|
To register the necessary conversion routines, it is necessary to add an |
||||||
|
instantiation of the ``pybind11::detail::type_caster<T>`` template. |
||||||
|
Although this is an implementation detail, adding an instantiation of this |
||||||
|
type is explicitly allowed. |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
namespace PYBIND11_NAMESPACE { namespace detail { |
||||||
|
template <> struct type_caster<inty> { |
||||||
|
public: |
||||||
|
/** |
||||||
|
* This macro establishes the name 'inty' in |
||||||
|
* function signatures and declares a local variable |
||||||
|
* 'value' of type inty |
||||||
|
*/ |
||||||
|
PYBIND11_TYPE_CASTER(inty, const_name("inty")); |
||||||
|
|
||||||
|
/** |
||||||
|
* Conversion part 1 (Python->C++): convert a PyObject into a inty |
||||||
|
* instance or return false upon failure. The second argument |
||||||
|
* indicates whether implicit conversions should be applied. |
||||||
|
*/ |
||||||
|
bool load(handle src, bool) { |
||||||
|
/* Extract PyObject from handle */ |
||||||
|
PyObject *source = src.ptr(); |
||||||
|
/* Try converting into a Python integer value */ |
||||||
|
PyObject *tmp = PyNumber_Long(source); |
||||||
|
if (!tmp) |
||||||
|
return false; |
||||||
|
/* Now try to convert into a C++ int */ |
||||||
|
value.long_value = PyLong_AsLong(tmp); |
||||||
|
Py_DECREF(tmp); |
||||||
|
/* Ensure return code was OK (to avoid out-of-range errors etc) */ |
||||||
|
return !(value.long_value == -1 && !PyErr_Occurred()); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Conversion part 2 (C++ -> Python): convert an inty instance into |
||||||
|
* a Python object. The second and third arguments are used to |
||||||
|
* indicate the return value policy and parent object (for |
||||||
|
* ``return_value_policy::reference_internal``) and are generally |
||||||
|
* ignored by implicit casters. |
||||||
|
*/ |
||||||
|
static handle cast(inty src, return_value_policy /* policy */, handle /* parent */) { |
||||||
|
return PyLong_FromLong(src.long_value); |
||||||
|
} |
||||||
|
}; |
||||||
|
}} // namespace PYBIND11_NAMESPACE::detail |
||||||
|
|
||||||
|
.. note:: |
||||||
|
|
||||||
|
A ``type_caster<T>`` defined with ``PYBIND11_TYPE_CASTER(T, ...)`` requires |
||||||
|
that ``T`` is default-constructible (``value`` is first default constructed |
||||||
|
and then ``load()`` assigns to it). |
||||||
|
|
||||||
|
.. warning:: |
||||||
|
|
||||||
|
When using custom type casters, it's important to declare them consistently |
||||||
|
in every compilation unit of the Python extension module. Otherwise, |
||||||
|
undefined behavior can ensue. |
||||||
@ -0,0 +1,310 @@ |
|||||||
|
Eigen |
||||||
|
##### |
||||||
|
|
||||||
|
`Eigen <http://eigen.tuxfamily.org>`_ 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<MatrixType>`` 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<const MatrixType>`` |
||||||
|
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<MatrixType>`` (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<Eigen::VectorXd> 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_<MyClass>(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<MatrixType>`` 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<MatrixType>`` to the |
||||||
|
more general ``Eigen::Ref<MatrixType, 0, Eigen::Stride<Eigen::Dynamic, |
||||||
|
Eigen::Dynamic>>`` (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<MatrixType>`` 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<Eigen::MatrixXd> 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<double, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>; |
||||||
|
// Use RowMatrixXd instead of MatrixXd |
||||||
|
|
||||||
|
Now bound functions accepting ``Eigen::Ref<RowMatrixXd>`` 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<MatrixXd>`` (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<const MatrixType>`` 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<const MatrixXd> &matrix) { /* ... */ } |
||||||
|
}; |
||||||
|
float some_function(const Eigen::Ref<const MatrixXf> &big, |
||||||
|
const Eigen::Ref<const MatrixXf> &small) { |
||||||
|
// ... |
||||||
|
} |
||||||
|
|
||||||
|
// The associated binding code: |
||||||
|
using namespace pybind11::literals; // for "arg"_a |
||||||
|
py::class_<MyClass>(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 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<MatrixXd>`` 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<double, Dynamic, 5>``: 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<float, Dynamic, 4>``), 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. |
||||||
@ -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<int(int)> &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<int(int)> func_ret(const std::function<int(int)> &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/functional.h> |
||||||
|
|
||||||
|
PYBIND11_MODULE(example, m) { |
||||||
|
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. |
||||||
@ -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 |
||||||
@ -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<int> &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<int>`` 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<T1, T2>`` | 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<T>`` | Complex numbers | :file:`pybind11/complex.h` | |
||||||
|
+------------------------------------+---------------------------+-----------------------------------+ |
||||||
|
| ``std::array<T, Size>`` | STL static array | :file:`pybind11/stl.h` | |
||||||
|
+------------------------------------+---------------------------+-----------------------------------+ |
||||||
|
| ``std::vector<T>`` | STL dynamic array | :file:`pybind11/stl.h` | |
||||||
|
+------------------------------------+---------------------------+-----------------------------------+ |
||||||
|
| ``std::deque<T>`` | STL double-ended queue | :file:`pybind11/stl.h` | |
||||||
|
+------------------------------------+---------------------------+-----------------------------------+ |
||||||
|
| ``std::valarray<T>`` | STL value array | :file:`pybind11/stl.h` | |
||||||
|
+------------------------------------+---------------------------+-----------------------------------+ |
||||||
|
| ``std::list<T>`` | STL linked list | :file:`pybind11/stl.h` | |
||||||
|
+------------------------------------+---------------------------+-----------------------------------+ |
||||||
|
| ``std::map<T1, T2>`` | STL ordered map | :file:`pybind11/stl.h` | |
||||||
|
+------------------------------------+---------------------------+-----------------------------------+ |
||||||
|
| ``std::unordered_map<T1, T2>`` | STL unordered map | :file:`pybind11/stl.h` | |
||||||
|
+------------------------------------+---------------------------+-----------------------------------+ |
||||||
|
| ``std::set<T>`` | STL ordered set | :file:`pybind11/stl.h` | |
||||||
|
+------------------------------------+---------------------------+-----------------------------------+ |
||||||
|
| ``std::unordered_set<T>`` | STL unordered set | :file:`pybind11/stl.h` | |
||||||
|
+------------------------------------+---------------------------+-----------------------------------+ |
||||||
|
| ``std::optional<T>`` | STL optional type (C++17) | :file:`pybind11/stl.h` | |
||||||
|
+------------------------------------+---------------------------+-----------------------------------+ |
||||||
|
| ``std::experimental::optional<T>`` | STL optional type (exp.) | :file:`pybind11/stl.h` | |
||||||
|
+------------------------------------+---------------------------+-----------------------------------+ |
||||||
|
| ``std::variant<...>`` | Type-safe union (C++17) | :file:`pybind11/stl.h` | |
||||||
|
+------------------------------------+---------------------------+-----------------------------------+ |
||||||
|
| ``std::filesystem::path<T>`` | 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 |
||||||
|
``os.PathLike`` is converted to ``std::filesystem::path``. |
||||||
@ -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 <typename T> |
||||||
|
struct type_caster<boost::optional<T>> : optional_caster<boost::optional<T>> {}; |
||||||
|
}} |
||||||
|
|
||||||
|
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 <typename... Ts> |
||||||
|
struct type_caster<boost::variant<Ts...>> : variant_caster<boost::variant<Ts...>> {}; |
||||||
|
|
||||||
|
// Specifies the function used to visit the variant -- `apply_visitor` instead of `visit` |
||||||
|
template <> |
||||||
|
struct visit_helper<boost::variant> { |
||||||
|
template <typename... Args> |
||||||
|
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<int, bool>``, |
||||||
|
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<bool, int>``, 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<int> &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<int> contents; |
||||||
|
}; |
||||||
|
|
||||||
|
/* ... binding code ... */ |
||||||
|
|
||||||
|
py::class_<MyClass>(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<int>`` into an opaque type, add |
||||||
|
the declaration |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
PYBIND11_MAKE_OPAQUE(std::vector<int>); |
||||||
|
|
||||||
|
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<int>``. Opaque types must |
||||||
|
also have a corresponding ``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_<std::vector<int>>(m, "IntVector") |
||||||
|
.def(py::init<>()) |
||||||
|
.def("clear", &std::vector<int>::clear) |
||||||
|
.def("pop_back", &std::vector<int>::pop_back) |
||||||
|
.def("__len__", [](const std::vector<int> &v) { return v.size(); }) |
||||||
|
.def("__iter__", [](std::vector<int> &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/stl_bind.h> |
||||||
|
|
||||||
|
PYBIND11_MAKE_OPAQUE(std::vector<int>); |
||||||
|
PYBIND11_MAKE_OPAQUE(std::map<std::string, double>); |
||||||
|
|
||||||
|
// ... |
||||||
|
|
||||||
|
// later in binding code: |
||||||
|
py::bind_vector<std::vector<int>>(m, "VectorInt"); |
||||||
|
py::bind_map<std::map<std::string, double>>(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<int>`` 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<std::vector<int>>(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<int>`` 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. |
||||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,262 @@ |
|||||||
|
.. _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.4) |
||||||
|
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 <pybind11/embed.h> // 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 <pybind11/embed.h> |
||||||
|
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 <pybind11/embed.h> |
||||||
|
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 <pybind11/embed.h> |
||||||
|
#include <iostream> |
||||||
|
|
||||||
|
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::string>(); |
||||||
|
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<int>(); |
||||||
|
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 <pybind11/embed.h> |
||||||
|
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<int>(); |
||||||
|
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 <pybind11/embed.h> |
||||||
|
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<int>() == 1); |
||||||
|
assert(locals["b"].cast<int>() == 2); |
||||||
|
|
||||||
|
py::exec(R"( |
||||||
|
c = a + b |
||||||
|
message = fmt.format(a, b, c) |
||||||
|
)", py::globals(), locals); |
||||||
|
|
||||||
|
assert(locals["c"].cast<int>() == 3); |
||||||
|
assert(locals["message"].cast<std::string>() == "1 + 2 = 3"); |
||||||
|
} |
||||||
|
|
||||||
|
|
||||||
|
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. |
||||||
|
|
||||||
|
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. |
||||||
|
|
||||||
|
|
||||||
|
Sub-interpreter support |
||||||
|
======================= |
||||||
|
|
||||||
|
Creating multiple copies of ``scoped_interpreter`` is not possible because it |
||||||
|
represents the main Python interpreter. Sub-interpreters are something different |
||||||
|
and they do permit the existence of multiple interpreters. This is an advanced |
||||||
|
feature of the CPython API and should be handled with care. pybind11 does not |
||||||
|
currently offer a C++ interface for sub-interpreters, so refer to the CPython |
||||||
|
documentation for all the details regarding this feature. |
||||||
|
|
||||||
|
We'll just mention a couple of caveats the sub-interpreters support in pybind11: |
||||||
|
|
||||||
|
1. Sub-interpreters will not receive independent copies of embedded modules. |
||||||
|
Instead, these are shared and modifications in one interpreter may be |
||||||
|
reflected in another. |
||||||
|
|
||||||
|
2. Managing multiple threads, multiple interpreters and the GIL can be |
||||||
|
challenging and there are several caveats here, even within the pure |
||||||
|
CPython API (please refer to the Python docs for details). As for |
||||||
|
pybind11, keep in mind that ``gil_scoped_release`` and ``gil_scoped_acquire`` |
||||||
|
do not take sub-interpreters into account. |
||||||
@ -0,0 +1,401 @@ |
|||||||
|
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 |
||||||
|
<handling_python_exceptions_cpp>` 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<CppExp>(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<CppExp>(module, "PyExp"); |
||||||
|
|
||||||
|
|
||||||
|
It is possible to specify base class for the exception using the third |
||||||
|
parameter, a ``handle``: |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
py::register_exception<CppExp>(module, "PyExp", PyExc_RuntimeError); |
||||||
|
py::register_local_exception<CppExp>(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 <https://docs.python.org/3/c-api/exceptions.html#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 |
||||||
|
``PyErr_SetString`` to set a Python exception or ``ex(string)`` to set |
||||||
|
the python exception to a custom exception type (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 |
||||||
|
|
||||||
|
static py::exception<MyCustomException> exc(m, "MyCustomError"); |
||||||
|
py::register_exception_translator([](std::exception_ptr p) { |
||||||
|
try { |
||||||
|
if (p) std::rethrow_exception(p); |
||||||
|
} catch (const MyCustomException &e) { |
||||||
|
exc(e.what()); |
||||||
|
} catch (const OtherException &e) { |
||||||
|
PyErr_SetString(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 either ``PyErr_SetString`` or a custom exception's call |
||||||
|
operator (``exc(string)``) 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 |
||||||
|
<https://stackoverflow.com/questions/19496643/using-clang-fvisibility-hidden-and-typeinfo-and-type-erasure/28827430>`_ |
||||||
|
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 <https://gcc.gnu.org/wiki/Visibility>`_. |
||||||
|
|
||||||
|
|
||||||
|
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) { |
||||||
|
PyErr_SetString("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) { |
||||||
|
PyErr_SetString("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 <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 ``PyErr_SetString``. |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
PyErr_SetString(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 |
||||||
|
<https://docs.python.org/3/c-api/exceptions.html#c.PyErr_Clear>`_. |
||||||
|
|
||||||
|
Any Python error must be thrown or cleared, or Python/pybind11 will be left in |
||||||
|
an invalid state. |
||||||
|
|
||||||
|
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 are logged by Python as an unraisable error. In Python 3.8+, a |
||||||
|
`system hook is triggered |
||||||
|
<https://docs.python.org/3/library/sys.html#sys.unraisablehook>`_ |
||||||
|
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 |
||||||
@ -0,0 +1,614 @@ |
|||||||
|
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 a 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` | Indicates that the lifetime of the return value is tied to the lifetime | |
||||||
|
| | of a parent object, namely the implicit ``this``, or ``self`` argument of | |
||||||
|
| | the called method or property. 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_<MyClass>(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_<MyClass>(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<Nurse, Patient>`` |
||||||
|
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_<List>(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_<Nurse>(m, "Nurse") |
||||||
|
.def(py::init<Patient &>(), 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<T>`` 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<T>()); |
||||||
|
|
||||||
|
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<T1, T2, T3...>``. 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>("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_<SomeType>``), 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 = <SomeType object at 0x101b7b080>) -> 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>("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>("MyClass") |
||||||
|
.def("myFunction", py::arg("arg") = static_cast<SomeType *>(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<A,B>()`` |
||||||
|
* Calling a method accepting a double with an integer argument |
||||||
|
* Calling a ``std::complex<float>`` 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 "<stdin>", line 1, in <module> |
||||||
|
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_<Dog>(m, "Dog").def(py::init<>()); |
||||||
|
py::class_<Cat>(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 "<stdin>", line 1, in <module> |
||||||
|
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 <opaque>` types. Pointers to built-in types |
||||||
|
(``double *``, ``int *``, ...) and STL types (``std::vector<T> *``, ...; 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<T>`` |
||||||
|
|
||||||
|
.. _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 <typename T> |
||||||
|
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<int>); |
||||||
|
m.def("set", &set<std::string>); |
||||||
|
|
||||||
|
Sometimes it's more clear to bind them with separate names, which is also |
||||||
|
an option: |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
m.def("setInt", &set<int>); |
||||||
|
m.def("setString", &set<std::string>); |
||||||
@ -0,0 +1,400 @@ |
|||||||
|
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<T1, T2>, Class<T3, T4>, 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<T1, T2>; |
||||||
|
using ClassType = Class<T3, T4>; |
||||||
|
PYBIND11_OVERRIDE(ReturnType, ClassType, func); |
||||||
|
|
||||||
|
// Version 2: using the PYBIND11_TYPE macro: |
||||||
|
PYBIND11_OVERRIDE(PYBIND11_TYPE(MyReturnType<T1, T2>), |
||||||
|
PYBIND11_TYPE(Class<T3, T4>), 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. |
||||||
|
|
||||||
|
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: |
||||||
|
/* 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, PyAnimal> animal(m, "Animal"); |
||||||
|
animal |
||||||
|
.def(py::init<>()) |
||||||
|
.def("go", &Animal::go); |
||||||
|
|
||||||
|
py::class_<Dog>(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<py::gil_scoped_release>()); |
||||||
|
|
||||||
|
|
||||||
|
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. |
||||||
|
|
||||||
|
- 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). |
||||||
|
|
||||||
|
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> pet(m, "Pet"); |
||||||
|
pet.def(py::init<const std::string &>()) |
||||||
|
.def_readwrite("name", &Pet::name); |
||||||
|
|
||||||
|
py::class_<Dog>(m, "Dog", pet /* <- specify parent */) |
||||||
|
.def(py::init<const std::string &>()) |
||||||
|
.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 ``class_<Dog>``. |
||||||
|
However, it can be acquired as follows: |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
py::object pet = (py::object) py::module_::import("basic").attr("Pet"); |
||||||
|
|
||||||
|
py::class_<Dog>(m, "Dog", pet) |
||||||
|
.def(py::init<const std::string &>()) |
||||||
|
.def("bark", &Dog::bark); |
||||||
|
|
||||||
|
Alternatively, you can specify the base class as a template parameter option to |
||||||
|
``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_<Dog, Pet>(m, "Dog") |
||||||
|
.def(py::init<const std::string &>()) |
||||||
|
.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<MyData *>(py::get_shared_data("mydata")); |
||||||
|
if (!data) |
||||||
|
data = static_cast<MyData *>(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_<ns::Foo>(m, "Foo"); |
||||||
|
auto pyBar = py::class_<ns::Bar>(m, "Bar"); |
||||||
|
|
||||||
|
pyFoo.def(py::init<const ns::Bar&>()); |
||||||
|
pyBar.def(py::init<const ns::Foo&>()); |
||||||
|
} |
||||||
@ -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 |
||||||
@ -0,0 +1,455 @@ |
|||||||
|
.. _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_<Matrix>(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<float>::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<py::ssize_t> shape; |
||||||
|
std::vector<py::ssize_t> 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_<Matrix>(m, "Matrix", py::buffer_protocol()) |
||||||
|
.def(py::init([](py::buffer b) { |
||||||
|
typedef Eigen::Stride<Eigen::Dynamic, Eigen::Dynamic> Strides; |
||||||
|
|
||||||
|
/* Request a buffer descriptor from Python */ |
||||||
|
py::buffer_info info = b.request(); |
||||||
|
|
||||||
|
/* Some basic validation checks ... */ |
||||||
|
if (info.format != py::format_descriptor<Scalar>::format()) |
||||||
|
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<Matrix, 0, Strides>( |
||||||
|
static_cast<Scalar *>(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<Scalar>::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<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<double> 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<double, py::array::c_style | py::array::forcecast> 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) { |
||||||
|
// ... |
||||||
|
|
||||||
|
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. |
||||||
|
|
||||||
|
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 <pybind11/pybind11.h> |
||||||
|
#include <pybind11/numpy.h> |
||||||
|
|
||||||
|
namespace py = pybind11; |
||||||
|
|
||||||
|
py::array_t<double> add_arrays(py::array_t<double> input1, py::array_t<double> 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<double>(buf1.size); |
||||||
|
|
||||||
|
py::buffer_info buf3 = result.request(); |
||||||
|
|
||||||
|
double *ptr1 = static_cast<double *>(buf1.ptr); |
||||||
|
double *ptr2 = static_cast<double *>(buf2.ptr); |
||||||
|
double *ptr3 = static_cast<double *>(buf3.ptr); |
||||||
|
|
||||||
|
for (size_t idx = 0; idx < buf1.shape[0]; idx++) |
||||||
|
ptr3[idx] = ptr1[idx] + ptr2[idx]; |
||||||
|
|
||||||
|
return result; |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_MODULE(test, m) { |
||||||
|
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<T>`` template |
||||||
|
class offer an unchecked proxy object that can be used for this unchecked |
||||||
|
access through the ``unchecked<N>`` and ``mutable_unchecked<N>`` methods, |
||||||
|
where ``N`` gives the required dimensionality of the array: |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
m.def("sum_3d", [](py::array_t<double> 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<double> 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<float, 2>()``. |
||||||
|
|
||||||
|
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<T>()``. 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)``. |
||||||
|
|
||||||
|
- ``.ndim()`` returns the number of dimensions. |
||||||
|
|
||||||
|
- ``.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. |
||||||
@ -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<MyClass *>(); |
||||||
|
|
||||||
|
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<MyClass>(); |
||||||
|
|
||||||
|
.. _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 <pybind11/numpy.h> |
||||||
|
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<float> 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++ |
||||||
|
<handling_python_exceptions_cpp>` 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<bool>(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). |
||||||
@ -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 <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 <pybind11/iostream.h> |
||||||
|
|
||||||
|
... |
||||||
|
|
||||||
|
// 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 <https://github.com/pybind/pybind11/pull/2982>`_ and |
||||||
|
`PR #2995 <https://github.com/pybind/pybind11/pull/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 <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<py::scoped_ostream_redirect, |
||||||
|
py::scoped_estream_redirect>()); |
||||||
|
|
||||||
|
The redirection can also be done in Python with the addition of a context |
||||||
|
manager, using the ``py::add_ostream_redirect() <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 <pybind11/eval.h> |
||||||
|
|
||||||
|
... |
||||||
|
|
||||||
|
// 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<int>(); |
||||||
|
|
||||||
|
// 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<eval_statements>``. |
||||||
@ -0,0 +1,174 @@ |
|||||||
|
Smart pointers |
||||||
|
############## |
||||||
|
|
||||||
|
std::unique_ptr |
||||||
|
=============== |
||||||
|
|
||||||
|
Given a class ``Example`` with Python bindings, it's possible to return |
||||||
|
instances wrapped in C++11 unique pointers, like so |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
std::unique_ptr<Example> create_example() { return std::unique_ptr<Example>(new Example()); } |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
m.def("create_example", &create_example); |
||||||
|
|
||||||
|
In other words, there is nothing special that needs to be done. While returning |
||||||
|
unique pointers in this way is allowed, it is *illegal* to use them as function |
||||||
|
arguments. For instance, the following function signature cannot be processed |
||||||
|
by pybind11. |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
void do_something_with_example(std::unique_ptr<Example> ex) { ... } |
||||||
|
|
||||||
|
The above signature would imply that Python needs to give up ownership of an |
||||||
|
object that is passed to this function, which is generally not possible (for |
||||||
|
instance, the object might be referenced elsewhere). |
||||||
|
|
||||||
|
std::shared_ptr |
||||||
|
=============== |
||||||
|
|
||||||
|
The binding generator for classes, :class:`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 named ``Type`` is ``std::unique_ptr<Type>``, which means that the object |
||||||
|
is deallocated when Python's reference count goes to zero. |
||||||
|
|
||||||
|
It is possible to switch to other types of reference counting wrappers or smart |
||||||
|
pointers, which is useful in codebases that rely on them. For instance, the |
||||||
|
following snippet causes ``std::shared_ptr`` to be used instead. |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
py::class_<Example, std::shared_ptr<Example> /* <- holder type */> obj(m, "Example"); |
||||||
|
|
||||||
|
Note that any particular class can only be associated with a single holder type. |
||||||
|
|
||||||
|
One potential stumbling block when using holder types is that they need to be |
||||||
|
applied consistently. Can you guess what's broken about the following binding |
||||||
|
code? |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
class Child { }; |
||||||
|
|
||||||
|
class Parent { |
||||||
|
public: |
||||||
|
Parent() : child(std::make_shared<Child>()) { } |
||||||
|
Child *get_child() { return child.get(); } /* Hint: ** DON'T DO THIS ** */ |
||||||
|
private: |
||||||
|
std::shared_ptr<Child> child; |
||||||
|
}; |
||||||
|
|
||||||
|
PYBIND11_MODULE(example, m) { |
||||||
|
py::class_<Child, std::shared_ptr<Child>>(m, "Child"); |
||||||
|
|
||||||
|
py::class_<Parent, std::shared_ptr<Parent>>(m, "Parent") |
||||||
|
.def(py::init<>()) |
||||||
|
.def("get_child", &Parent::get_child); |
||||||
|
} |
||||||
|
|
||||||
|
The following Python code will cause undefined behavior (and likely a |
||||||
|
segmentation fault). |
||||||
|
|
||||||
|
.. code-block:: python |
||||||
|
|
||||||
|
from example import Parent |
||||||
|
|
||||||
|
print(Parent().get_child()) |
||||||
|
|
||||||
|
The problem is that ``Parent::get_child()`` returns a pointer to an instance of |
||||||
|
``Child``, but the fact that this instance is already managed by |
||||||
|
``std::shared_ptr<...>`` is lost when passing raw pointers. In this case, |
||||||
|
pybind11 will create a second independent ``std::shared_ptr<...>`` that also |
||||||
|
claims ownership of the pointer. In the end, the object will be freed **twice** |
||||||
|
since these shared pointers have no way of knowing about each other. |
||||||
|
|
||||||
|
There are two ways to resolve this issue: |
||||||
|
|
||||||
|
1. For types that are managed by a smart pointer class, never use raw pointers |
||||||
|
in function arguments or return values. In other words: always consistently |
||||||
|
wrap pointers into their designated holder types (such as |
||||||
|
``std::shared_ptr<...>``). In this case, the signature of ``get_child()`` |
||||||
|
should be modified as follows: |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
std::shared_ptr<Child> get_child() { return child; } |
||||||
|
|
||||||
|
2. Adjust the definition of ``Child`` by specifying |
||||||
|
``std::enable_shared_from_this<T>`` (see cppreference_ for details) as a |
||||||
|
base class. This adds a small bit of information to ``Child`` that allows |
||||||
|
pybind11 to realize that there is already an existing |
||||||
|
``std::shared_ptr<...>`` and communicate with it. In this case, the |
||||||
|
declaration of ``Child`` should look as follows: |
||||||
|
|
||||||
|
.. _cppreference: http://en.cppreference.com/w/cpp/memory/enable_shared_from_this |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
class Child : public std::enable_shared_from_this<Child> { }; |
||||||
|
|
||||||
|
.. _smart_pointers: |
||||||
|
|
||||||
|
Custom smart pointers |
||||||
|
===================== |
||||||
|
|
||||||
|
pybind11 supports ``std::unique_ptr`` and ``std::shared_ptr`` right out of the |
||||||
|
box. For any other custom smart pointer, 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<T>); |
||||||
|
|
||||||
|
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<T>, true); |
||||||
|
|
||||||
|
if ``SmartPtr<T>`` 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<T>); |
||||||
|
|
||||||
|
// Only needed if the type's `.get()` goes by another name |
||||||
|
namespace PYBIND11_NAMESPACE { namespace detail { |
||||||
|
template <typename T> |
||||||
|
struct holder_helper<SmartPtr<T>> { // <-- specialization |
||||||
|
static const T *get(const SmartPtr<T> &p) { return p.getPointer(); } |
||||||
|
}; |
||||||
|
}} |
||||||
|
|
||||||
|
The above specialization informs pybind11 that the custom ``SmartPtr`` class |
||||||
|
provides ``.get()`` functionality via ``.getPointer()``. |
||||||
|
|
||||||
|
.. 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. |
||||||
@ -0,0 +1,307 @@ |
|||||||
|
.. _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 <pybind11/pybind11.h> |
||||||
|
|
||||||
|
namespace py = pybind11; |
||||||
|
|
||||||
|
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 <pybind11/pybind11.h> |
||||||
|
|
||||||
|
int add(int i, int j) { |
||||||
|
return i + j; |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_MODULE(example, m) { |
||||||
|
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_ <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-config --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) { |
||||||
|
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. |
||||||
@ -0,0 +1,87 @@ |
|||||||
|
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_<cl{cl:03}>(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 <pybind11/pybind11.h>\n\n" |
||||||
|
result += "namespace py = pybind11;\n\n" |
||||||
|
result += decl + "\n" |
||||||
|
result += "PYBIND11_MODULE(example, m) {\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 += "class cl%03i {\n" % cl |
||||||
|
decl += "public:\n" |
||||||
|
bindings += f' py::class_<cl{cl:03}>("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<py::manage_new_object>())\n' |
||||||
|
decl += "};\n\n" |
||||||
|
bindings += " ;\n" |
||||||
|
|
||||||
|
result = "#include <boost/python.hpp>\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(0, 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(" {%i, %f, %i}," % (nclasses * nfns, elapsed, size)) |
||||||
|
print("}") |
||||||
@ -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::class_<cl034>(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 |
||||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,541 @@ |
|||||||
|
.. _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 <pybind11/pybind11.h> |
||||||
|
|
||||||
|
namespace py = pybind11; |
||||||
|
|
||||||
|
PYBIND11_MODULE(example, m) { |
||||||
|
py::class_<Pet>(m, "Pet") |
||||||
|
.def(py::init<const std::string &>()) |
||||||
|
.def("setName", &Pet::setName) |
||||||
|
.def("getName", &Pet::getName); |
||||||
|
} |
||||||
|
|
||||||
|
:class:`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). An |
||||||
|
interactive Python session demonstrating this example is shown below: |
||||||
|
|
||||||
|
.. code-block:: pycon |
||||||
|
|
||||||
|
% python |
||||||
|
>>> import example |
||||||
|
>>> p = example.Pet("Molly") |
||||||
|
>>> print(p) |
||||||
|
<example.Pet object at 0x10cd98060> |
||||||
|
>>> 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`. |
||||||
|
|
||||||
|
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) |
||||||
|
<example.Pet object at 0x10cd98060> |
||||||
|
|
||||||
|
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_<Pet>(m, "Pet") |
||||||
|
.def(py::init<const std::string &>()) |
||||||
|
.def("setName", &Pet::setName) |
||||||
|
.def("getName", &Pet::getName) |
||||||
|
.def("__repr__", |
||||||
|
[](const Pet &a) { |
||||||
|
return "<example.Pet named '" + a.name + "'>"; |
||||||
|
} |
||||||
|
); |
||||||
|
|
||||||
|
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) |
||||||
|
<example.Pet named 'Molly'> |
||||||
|
|
||||||
|
.. [#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_<Pet>(m, "Pet") |
||||||
|
.def(py::init<const std::string &>()) |
||||||
|
.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_<Pet>(m, "Pet") |
||||||
|
.def(py::init<const std::string &>()) |
||||||
|
.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_<Pet>(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_<Pet>(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 :class:`class_`: |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
py::class_<Pet>(m, "Pet") |
||||||
|
.def(py::init<const std::string &>()) |
||||||
|
.def_readwrite("name", &Pet::name); |
||||||
|
|
||||||
|
// Method 1: template parameter: |
||||||
|
py::class_<Dog, Pet /* <- specify C++ parent type */>(m, "Dog") |
||||||
|
.def(py::init<const std::string &>()) |
||||||
|
.def("bark", &Dog::bark); |
||||||
|
|
||||||
|
Alternatively, we can also assign a name to the previously bound ``Pet`` |
||||||
|
:class:`class_` object and reference it when binding the ``Dog`` class: |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
py::class_<Pet> pet(m, "Pet"); |
||||||
|
pet.def(py::init<const std::string &>()) |
||||||
|
.def_readwrite("name", &Pet::name); |
||||||
|
|
||||||
|
// Method 2: pass parent class_ object: |
||||||
|
py::class_<Dog>(m, "Dog", pet /* <- specify Python parent type */) |
||||||
|
.def(py::init<const std::string &>()) |
||||||
|
.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<Pet>(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_<PolymorphicPet>(m, "PolymorphicPet"); |
||||||
|
py::class_<PolymorphicDog, PolymorphicPet>(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<PolymorphicPet>(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_<Pet>(m, "Pet") |
||||||
|
.def(py::init<const std::string &, int>()) |
||||||
|
.def("set", static_cast<void (Pet::*)(int)>(&Pet::set), "Set the pet's age") |
||||||
|
.def("set", static_cast<void (Pet::*)(const std::string &)>(&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_<Pet>(m, "Pet") |
||||||
|
.def("set", py::overload_cast<int>(&Pet::set), "Set the pet's age") |
||||||
|
.def("set", py::overload_cast<const std::string &>(&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_<Widget>(m, "Widget") |
||||||
|
.def("foo_mutable", py::overload_cast<int, float>(&Widget::foo)) |
||||||
|
.def("foo_const", py::overload_cast<int, float>(&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 <typename... Args> |
||||||
|
using overload_cast_ = pybind11::detail::overload_cast_impl<Args...>; |
||||||
|
|
||||||
|
py::class_<Pet>(m, "Pet") |
||||||
|
.def("set", overload_cast_<int>()(&Pet::set), "Set the pet's age") |
||||||
|
.def("set", overload_cast_<const std::string &>()(&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. |
||||||
|
|
||||||
|
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 |
||||||
|
|
||||||
|
py::class_<Pet> pet(m, "Pet"); |
||||||
|
|
||||||
|
pet.def(py::init<const std::string &, Pet::Kind>()) |
||||||
|
.def_readwrite("name", &Pet::name) |
||||||
|
.def_readwrite("type", &Pet::type) |
||||||
|
.def_readwrite("attr", &Pet::attr); |
||||||
|
|
||||||
|
py::enum_<Pet::Kind>(pet, "Kind") |
||||||
|
.value("Dog", Pet::Kind::Dog) |
||||||
|
.value("Cat", Pet::Kind::Cat) |
||||||
|
.export_values(); |
||||||
|
|
||||||
|
py::class_<Pet::Attributes>(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`` :class:`class_` instance must be supplied to the :class:`enum_` and :class:`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>(pet, "Kind", py::arithmetic()) |
||||||
|
... |
||||||
|
|
||||||
|
By default, these are omitted to conserve space. |
||||||
@ -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 |
||||||
@ -0,0 +1,638 @@ |
|||||||
|
.. _compiling: |
||||||
|
|
||||||
|
Build systems |
||||||
|
############# |
||||||
|
|
||||||
|
.. _build-setuptools: |
||||||
|
|
||||||
|
Building with setuptools |
||||||
|
======================== |
||||||
|
|
||||||
|
For projects on PyPI, building with setuptools is the way to go. 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, but very new and requires Pip 10), |
||||||
|
:ref:`setup_helpers-setup_requires` (discouraged by Python packagers now that |
||||||
|
PEP 518 is available, but it still works everywhere), or you can |
||||||
|
:ref:`setup_helpers-copy-manually` (always works but you have to manually sync |
||||||
|
your copy to get updates). |
||||||
|
|
||||||
|
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. |
||||||
|
|
||||||
|
.. [Ccache] https://ccache.dev |
||||||
|
|
||||||
|
.. [setuptools_scm] https://github.com/pypa/setuptools_scm |
||||||
|
|
||||||
|
.. _setup_helpers-pep518: |
||||||
|
|
||||||
|
PEP 518 requirements (Pip 10+ required) |
||||||
|
--------------------------------------- |
||||||
|
|
||||||
|
If you use `PEP 518's <https://www.python.org/dev/peps/pep-0518/>`_ |
||||||
|
``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>=42", "wheel", "pybind11~=2.6.1"] |
||||||
|
build-backend = "setuptools.build_meta" |
||||||
|
|
||||||
|
.. note:: |
||||||
|
|
||||||
|
The main drawback to this method is that a `PEP 517`_ compliant build tool, |
||||||
|
such as Pip 10+, is required for this approach to work; older versions of |
||||||
|
Pip completely ignore this file. If you distribute binaries (called wheels |
||||||
|
in Python) using something like `cibuildwheel`_, remember that ``setup.py`` |
||||||
|
and ``pyproject.toml`` are not even contained in the wheel, so this high |
||||||
|
Pip requirement is only for source builds, and will not affect users of |
||||||
|
your binary wheels. If you are building SDists and wheels, then |
||||||
|
`pypa-build`_ is the recommended official tool. |
||||||
|
|
||||||
|
.. _PEP 517: https://www.python.org/dev/peps/pep-0517/ |
||||||
|
.. _cibuildwheel: https://cibuildwheel.readthedocs.io |
||||||
|
.. _pypa-build: https://pypa-build.readthedocs.io/en/latest/ |
||||||
|
|
||||||
|
.. _setup_helpers-setup_requires: |
||||||
|
|
||||||
|
Classic ``setup_requires`` |
||||||
|
-------------------------- |
||||||
|
|
||||||
|
If you want to support old versions of Pip with the classic |
||||||
|
``setup_requires=["pybind11"]`` keyword argument to setup, which triggers a |
||||||
|
two-phase ``setup.py`` run, then you will need to use something like this to |
||||||
|
ensure the first pass works (which has not yet installed the ``setup_requires`` |
||||||
|
packages, since it can't install something it does not know about): |
||||||
|
|
||||||
|
.. code-block:: python |
||||||
|
|
||||||
|
try: |
||||||
|
from pybind11.setup_helpers import Pybind11Extension |
||||||
|
except ImportError: |
||||||
|
from setuptools import Extension as Pybind11Extension |
||||||
|
|
||||||
|
|
||||||
|
It doesn't matter that the Extension class is not the enhanced subclass for the |
||||||
|
first pass run; and the second pass will have the ``setup_requires`` |
||||||
|
requirements. |
||||||
|
|
||||||
|
This is obviously more of a hack than the PEP 518 method, but it supports |
||||||
|
ancient versions of Pip. |
||||||
|
|
||||||
|
.. _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: |
||||||
|
|
||||||
|
.. code-block:: cmake |
||||||
|
|
||||||
|
cmake_minimum_required(VERSION 3.4...3.18) |
||||||
|
project(example LANGUAGES CXX) |
||||||
|
|
||||||
|
add_subdirectory(pybind11) |
||||||
|
pybind11_add_module(example example.cpp) |
||||||
|
|
||||||
|
This assumes that the pybind11 repository is located in a subdirectory named |
||||||
|
:file:`pybind11` and that the code is located in a file named :file:`example.cpp`. |
||||||
|
The CMake command ``add_subdirectory`` 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. |
||||||
|
|
||||||
|
A working sample project, including a way to invoke CMake from :file:`setup.py` for |
||||||
|
PyPI integration, can be found in the [cmake_example]_ repository. |
||||||
|
|
||||||
|
.. [cmake_example] https://github.com/pybind/cmake_example |
||||||
|
|
||||||
|
.. versionchanged:: 2.6 |
||||||
|
CMake 3.4+ 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(<name> [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 ``<name>`` 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 |
||||||
|
``<name>`` 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 <faq:symhidden>` 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_<CONFIG>`` 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 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 <https://cmake.org/cmake/help/latest/variable/CMAKE_CXX_STANDARD.html>`_: |
||||||
|
|
||||||
|
.. 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<variable>=<value>`` 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.6 .. |
||||||
|
|
||||||
|
# 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.4...3.18) |
||||||
|
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 |
||||||
|
--------------- |
||||||
|
|
||||||
|
CMake 3.12+ (3.15+ recommended, 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...3.22) |
||||||
|
project(example LANGUAGES CXX) |
||||||
|
|
||||||
|
find_package(Python 3.6 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 <https://cmake.org/cmake/help/latest/module/FindPython.html>`_), |
||||||
|
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 CMake 3.15+) 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.4) |
||||||
|
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 <faq:symhidden>` 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 |
||||||
|
<https://scikit-build.readthedocs.io>`_ ``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.4...3.18) |
||||||
|
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 <path-to-pybind11>/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 |
||||||
|
<https://github.com/pybind/pybind11_bazel>`_ repository. |
||||||
|
|
||||||
|
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 |
||||||
|
|
||||||
|
[robotpy-build]_ is a is a pure python, cross platform build tool that aims to |
||||||
|
simplify creation of python wheels for pybind11 projects, and provide |
||||||
|
cross-project dependency management. Additionally, it is able to autogenerate |
||||||
|
customizable pybind11-based wrappers by parsing C++ header files. |
||||||
|
|
||||||
|
.. [robotpy-build] https://robotpy-build.readthedocs.io |
||||||
@ -0,0 +1,368 @@ |
|||||||
|
#!/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. |
||||||
|
|
||||||
|
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", |
||||||
|
"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. |
||||||
|
# You can specify multiple suffix as a list of string: |
||||||
|
# source_suffix = ['.rst', '.md'] |
||||||
|
source_suffix = ".rst" |
||||||
|
|
||||||
|
# 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 |
||||||
|
with open("../pybind11/_version.py") as f: |
||||||
|
code = compile(f.read(), "../pybind11/_version.py", "exec") |
||||||
|
loc = {} |
||||||
|
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 = None |
||||||
|
|
||||||
|
# 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 |
||||||
|
# "<project> v<version> 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 <link> 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): |
||||||
|
(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) |
||||||
@ -0,0 +1,48 @@ |
|||||||
|
.. 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 |
||||||
|
|
||||||
|
.. toctree:: |
||||||
|
:caption: Extra Information |
||||||
|
:maxdepth: 1 |
||||||
|
|
||||||
|
faq |
||||||
|
benchmark |
||||||
|
limitations |
||||||
|
reference |
||||||
|
cmake/index |
||||||
@ -0,0 +1,105 @@ |
|||||||
|
.. _installing: |
||||||
|
|
||||||
|
Installing the library |
||||||
|
###################### |
||||||
|
|
||||||
|
There are several ways to get the pybind11 source, which lives at |
||||||
|
`pybind/pybind11 on GitHub <https://github.com/pybind/pybind11>`_. 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 |
||||||
|
<https://github.com/conda-forge/pybind11-feedstock>`_: |
||||||
|
|
||||||
|
.. code-block:: bash |
||||||
|
|
||||||
|
conda install -c conda-forge pybind11 |
||||||
|
|
||||||
|
|
||||||
|
Include with vcpkg |
||||||
|
================== |
||||||
|
You can download and install pybind11 using the Microsoft `vcpkg |
||||||
|
<https://github.com/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 <https://github.com/Microsoft/vcpkg/>`_ on the vcpkg |
||||||
|
repository. |
||||||
|
|
||||||
|
Global install with brew |
||||||
|
======================== |
||||||
|
|
||||||
|
The brew package manager (Homebrew on macOS, or Linuxbrew on Linux) has a |
||||||
|
`pybind11 package |
||||||
|
<https://github.com/Homebrew/homebrew-core/blob/master/Formula/pybind11.rb>`_. |
||||||
|
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 |
||||||
|
<https://repology.org/project/python:pybind11/versions>`_; these are maintained |
||||||
|
by various packagers and the community. |
||||||
@ -0,0 +1,72 @@ |
|||||||
|
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 <https://github.com/pybind/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 <https://github.com/pybind/pybind11/pull/2573>`_ |
||||||
|
|
||||||
|
- Debug mode Python does not support 1-5 tests in the test suite currently. |
||||||
|
`#2422 <https://github.com/pybind/pybind11/pull/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 <https://github.com/pybind/pybind11/issues/2527>`_ |
||||||
|
One consequence is that containers of ``char *`` are currently not supported. |
||||||
|
`#2245 <https://github.com/pybind/pybind11/issues/2245>`_ |
||||||
|
|
||||||
|
- The ``cpptest`` does not run on Windows with Python 3.8 or newer, due to DLL |
||||||
|
loader changes. User code that is correctly installed should not be affected. |
||||||
|
`#2560 <https://github.com/pybind/pybind11/issue/2560>`_ |
||||||
|
|
||||||
|
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 <https://github.com/python/cpython/pull/22670>`_. |
||||||
|
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. |
||||||
|
After Width: | Height: | Size: 60 KiB |
|
After Width: | Height: | Size: 44 KiB |
|
After Width: | Height: | Size: 86 KiB |
|
After Width: | Height: | Size: 40 KiB |
|
After Width: | Height: | Size: 84 KiB |
@ -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 ``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 |
||||||
@ -0,0 +1,97 @@ |
|||||||
|
On version numbers |
||||||
|
^^^^^^^^^^^^^^^^^^ |
||||||
|
|
||||||
|
The two version numbers (C++ and Python) must match when combined (checked when |
||||||
|
you build the PyPI package), and must be a valid `PEP 440 |
||||||
|
<https://www.python.org/dev/peps/pep-0440>`_ version when combined. |
||||||
|
|
||||||
|
For example: |
||||||
|
|
||||||
|
.. code-block:: C++ |
||||||
|
|
||||||
|
#define PYBIND11_VERSION_MAJOR X |
||||||
|
#define PYBIND11_VERSION_MINOR Y |
||||||
|
#define PYBIND11_VERSION_PATCH Z.dev1 |
||||||
|
|
||||||
|
For beta, ``PYBIND11_VERSION_PATCH`` should be ``Z.b1``. RC's can be ``Z.rc1``. |
||||||
|
Always include the dot (even though PEP 440 allows it to be dropped). For a |
||||||
|
final release, this must be a simple integer. There is also a HEX version of |
||||||
|
the version just below. |
||||||
|
|
||||||
|
|
||||||
|
To release a new version of pybind11: |
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
||||||
|
|
||||||
|
If you don't have nox, you should either use ``pipx run nox`` instead, or use |
||||||
|
``pipx install nox`` or ``brew install nox`` (Unix). |
||||||
|
|
||||||
|
- Update the version number |
||||||
|
- Update ``PYBIND11_VERSION_MAJOR`` etc. in |
||||||
|
``include/pybind11/detail/common.h``. PATCH should be a simple integer. |
||||||
|
- Update the version HEX just below, as well. |
||||||
|
- Update ``pybind11/_version.py`` (match above) |
||||||
|
- Run ``nox -s tests_packaging`` to ensure this was done correctly. |
||||||
|
- Ensure that all the information in ``setup.cfg`` is up-to-date, like |
||||||
|
supported Python versions. |
||||||
|
- Add release date in ``docs/changelog.rst``. |
||||||
|
- Check to make sure |
||||||
|
`needs-changelog <https://github.com/pybind/pybind11/pulls?q=is%3Apr+is%3Aclosed+label%3A%22needs+changelog%22>`_ |
||||||
|
issues are entered in the changelog (clear the label when done). |
||||||
|
- ``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 |
||||||
|
- New branch: ``git checkout -b vX.Y``, ``git push -u origin vX.Y`` |
||||||
|
- Update branch: ``git checkout vX.Y``, ``git merge <release branch>``, ``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 push --tags``. |
||||||
|
- Update stable |
||||||
|
- ``git checkout stable`` |
||||||
|
- ``git merge master`` |
||||||
|
- ``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 <https://github.com/pybind/pybind11/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 (usually ``cat docs/changelog.rst | pandoc -f rst -t gfm``). |
||||||
|
Check "pre-release" if this is a 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 |
||||||
|
``0.dev1`` and increment MINOR). |
||||||
|
- Update ``_version.py`` to match |
||||||
|
- Run ``nox -s tests_packaging`` to ensure this was done correctly. |
||||||
|
- Add a spot for in-development updates in ``docs/changelog.rst``. |
||||||
|
- ``git add``, ``git commit``, ``git push`` |
||||||
|
|
||||||
|
If a version branch is updated, remember to set PATCH to ``1.dev1``. |
||||||
|
|
||||||
|
If you'd like to bump homebrew, run: |
||||||
|
|
||||||
|
.. code-block:: console |
||||||
|
|
||||||
|
brew bump-formula-pr --url https://github.com/pybind/pybind11/archive/vX.Y.Z.tar.gz |
||||||
|
|
||||||
|
Conda-forge should automatically make a PR in a few hours, and automatically |
||||||
|
merge it if there are no issues. |
||||||
|
|
||||||
|
|
||||||
|
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 |
||||||
|
twine upload dist/* |
||||||
|
|
||||||
|
This makes SDists and wheels, and the final line uploads them. |
||||||
@ -0,0 +1,6 @@ |
|||||||
|
breathe==4.34.0 |
||||||
|
furo==2022.6.21 |
||||||
|
sphinx==5.0.2 |
||||||
|
sphinx-copybutton==0.5.0 |
||||||
|
sphinxcontrib-moderncmakedomain==3.21.4 |
||||||
|
sphinxcontrib-svg2pdfconverter==1.2.0 |
||||||
@ -0,0 +1,552 @@ |
|||||||
|
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-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<str>()`` is ``true`` for both ``py::str`` and |
||||||
|
``py::bytes``. Starting with v2.7, ``py::str`` exclusively holds |
||||||
|
``PyUnicodeObject`` (`#2409 <https://github.com/pybind/pybind11/pull/2409>`_), |
||||||
|
and ``py::isinstance<str>()`` 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<str>(obj) being ``true`` for |
||||||
|
``py::bytes``. This is likely to be easy to fix in most cases by adding |
||||||
|
``|| py::isinstance<bytes>(obj)``, but a fix may be more involved, e.g. if |
||||||
|
``py::isinstance<T>`` 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=<platform-flag>`` is deprecated, please use |
||||||
|
``CMAKE_CXX_STANDARD=<number>`` 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<Foo>(m, "Foo") |
||||||
|
.def("__init__", [](Foo &self, ...) { |
||||||
|
new (&self) Foo(...); // uses placement-new |
||||||
|
}); |
||||||
|
|
||||||
|
// new |
||||||
|
py::class<Foo>(m, "Foo") |
||||||
|
.def(py::init([](...) { // Note: no `self` argument |
||||||
|
return new Foo(...); // return by raw pointer |
||||||
|
// or: return std::make_unique<Foo>(...); // 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<Foo>(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<std::string>(), ...); |
||||||
|
}); |
||||||
|
|
||||||
|
// new |
||||||
|
py::class<Foo>(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<std::string>(), ...); |
||||||
|
// or: return std::make_unique<Foo>(...); // 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 |
||||||
|
<compiling>` (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<int>``. :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<int>`` |
||||||
|
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 <https://github.com/pybind/pybind11/pull/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<T>`` is not possible when ``T`` is |
||||||
|
not directly registered with ``py::class_<T>`` (e.g. ``std::shared_ptr<int>`` |
||||||
|
or ``std::shared_ptr<std::vector<T>>`` 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_<Example>(m, "Example") |
||||||
|
.def(py::init<int &>()); // OK, exact match |
||||||
|
// .def(py::init<int>()); // 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<T>()`` 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_<Foo>(m, "Foo", py::metaclass()) |
||||||
|
.def_property_readonly_static("foo", ...); |
||||||
|
|
||||||
|
// new -- static properties work without the attribute |
||||||
|
py::class_<Foo>(m, "Foo") |
||||||
|
.def_property_readonly_static("foo", ...); |
||||||
|
|
||||||
|
// new -- advanced feature, override pybind11's default metaclass |
||||||
|
py::class_<Bar>(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 |
||||||
|
<https://github.com/pybind/pybind11/pull/527>`_), and to improve efficiency |
||||||
|
(`rev. 86d825 <https://github.com/pybind/pybind11/commit/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>("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_<TrampolineClass>("MyClass") |
||||||
|
.alias<MyClass>() |
||||||
|
... |
||||||
|
|
||||||
|
// new v2.x syntax |
||||||
|
py::class_<MyClass, TrampolineClass>("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 <https://github.com/pybind/pybind11/commit/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<T>()`` attribute |
||||||
|
---------------------------------------------- |
||||||
|
|
||||||
|
``py::base<T>()`` 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_<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>("Derived", py::base<Base>()); |
||||||
|
|
||||||
|
// new v2.x |
||||||
|
py::class_<Derived, Base>("Derived"); |
||||||
|
|
||||||
|
// new -- multiple inheritance |
||||||
|
py::class_<Derived, Base1, Base2>("Derived"); |
||||||
|
|
||||||
|
// new -- apart from `Derived` the argument order can be arbitrary |
||||||
|
py::class_<Derived, Base1, Holder, Base2, Trampoline>("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<T>) |
||||||
|
|
||||||
|
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<py::list>(obj)`` | |
||||||
|
+---------------------------------------+---------------------------------------------+ |
||||||
|
| ``py::object(ptr, true)`` | ``py::reinterpret_borrow<py::object>(ptr)`` | |
||||||
|
+---------------------------------------+---------------------------------------------+ |
||||||
|
| ``py::object(ptr, false)`` | ``py::reinterpret_steal<py::object>(ptr)`` | |
||||||
|
+---------------------------------------+---------------------------------------------+ |
||||||
|
| ``if (obj.attr("foo"))`` | ``if (py::hasattr(obj, "foo"))`` | |
||||||
|
+---------------------------------------+---------------------------------------------+ |
||||||
|
| ``if (obj["bar"])`` | ``if (obj.contains("bar"))`` | |
||||||
|
+---------------------------------------+---------------------------------------------+ |
||||||
@ -0,0 +1,678 @@ |
|||||||
|
/*
|
||||||
|
pybind11/attr.h: Infrastructure for processing custom |
||||||
|
type and function attributes |
||||||
|
|
||||||
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> |
||||||
|
|
||||||
|
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 <functional> |
||||||
|
|
||||||
|
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 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 <typename T> |
||||||
|
struct base { |
||||||
|
|
||||||
|
PYBIND11_DEPRECATED( |
||||||
|
"base<T>() was deprecated in favor of specifying 'T' as a template argument to class_") |
||||||
|
base() = default; |
||||||
|
}; |
||||||
|
|
||||||
|
/// Keep patient alive while nurse lives
|
||||||
|
template <size_t Nurse, size_t Patient> |
||||||
|
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 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<void(PyHeapTypeObject *heap_type)>; |
||||||
|
|
||||||
|
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<T>()); |
||||||
|
|
||||||
|
is equivalent to the following pseudocode: |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
m.def("foo", [](args...) { |
||||||
|
T scope_guard; |
||||||
|
return foo(args...); // forwarded arguments
|
||||||
|
}); |
||||||
|
\endrst */ |
||||||
|
template <typename... Ts> |
||||||
|
struct call_guard; |
||||||
|
|
||||||
|
template <> |
||||||
|
struct call_guard<> { |
||||||
|
using type = detail::void_type; |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename T> |
||||||
|
struct call_guard<T> { |
||||||
|
static_assert(std::is_default_constructible<T>::value, |
||||||
|
"The guard type must be default constructible"); |
||||||
|
|
||||||
|
using type = T; |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename T, typename... Ts> |
||||||
|
struct call_guard<T, Ts...> { |
||||||
|
struct type { |
||||||
|
T guard{}; // Compose multiple guard types with left-to-right default-constructor order
|
||||||
|
typename call_guard<Ts...>::type next{}; |
||||||
|
}; |
||||||
|
}; |
||||||
|
|
||||||
|
/// @} annotations
|
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
/* Forward declarations */ |
||||||
|
enum op_id : int; |
||||||
|
enum op_type : int; |
||||||
|
struct undefined_t; |
||||||
|
template <op_id id, op_type ot, typename L = undefined_t, typename R = undefined_t> |
||||||
|
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.)
|
||||||
|
struct function_record { |
||||||
|
function_record() |
||||||
|
: is_constructor(false), is_new_style_constructor(false), is_stateless(false), |
||||||
|
is_operator(false), is_method(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<argument_record> 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 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; |
||||||
|
}; |
||||||
|
|
||||||
|
/// 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), |
||||||
|
default_holder(true), module_local(false), is_final(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; |
||||||
|
|
||||||
|
/// 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 default (unique_ptr) holder type used?
|
||||||
|
bool default_holder : 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; |
||||||
|
|
||||||
|
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 + "\""); |
||||||
|
} |
||||||
|
|
||||||
|
if (default_holder != base_info->default_holder) { |
||||||
|
std::string tname(base.name()); |
||||||
|
detail::clean_type_id(tname); |
||||||
|
pybind11_fail("generic_type: type \"" + std::string(name) + "\" " |
||||||
|
+ (default_holder ? "does not have" : "has") |
||||||
|
+ " a non-default holder type while its base \"" + tname + "\" " |
||||||
|
+ (base_info->default_holder ? "does not" : "does")); |
||||||
|
} |
||||||
|
|
||||||
|
bases.append((PyObject *) base_info->type); |
||||||
|
|
||||||
|
#if PY_VERSION_HEX < 0x030B0000 |
||||||
|
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 <typename T, typename SFINAE = void> |
||||||
|
struct process_attribute; |
||||||
|
|
||||||
|
template <typename T> |
||||||
|
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<name> : process_attribute_default<name> { |
||||||
|
static void init(const name &n, function_record *r) { r->name = const_cast<char *>(n.value); } |
||||||
|
}; |
||||||
|
|
||||||
|
/// Process an attribute specifying the function's docstring
|
||||||
|
template <> |
||||||
|
struct process_attribute<doc> : process_attribute_default<doc> { |
||||||
|
static void init(const doc &n, function_record *r) { r->doc = const_cast<char *>(n.value); } |
||||||
|
}; |
||||||
|
|
||||||
|
/// Process an attribute specifying the function's docstring (provided as a C-style string)
|
||||||
|
template <> |
||||||
|
struct process_attribute<const char *> : process_attribute_default<const char *> { |
||||||
|
static void init(const char *d, function_record *r) { r->doc = const_cast<char *>(d); } |
||||||
|
static void init(const char *d, type_record *r) { r->doc = d; } |
||||||
|
}; |
||||||
|
template <> |
||||||
|
struct process_attribute<char *> : process_attribute<const char *> {}; |
||||||
|
|
||||||
|
/// Process an attribute indicating the function's return value policy
|
||||||
|
template <> |
||||||
|
struct process_attribute<return_value_policy> : process_attribute_default<return_value_policy> { |
||||||
|
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<sibling> : process_attribute_default<sibling> { |
||||||
|
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<is_method> : process_attribute_default<is_method> { |
||||||
|
static void init(const is_method &s, function_record *r) { |
||||||
|
r->is_method = true; |
||||||
|
r->scope = s.class_; |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
/// Process an attribute which indicates the parent scope of a method
|
||||||
|
template <> |
||||||
|
struct process_attribute<scope> : process_attribute_default<scope> { |
||||||
|
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<is_operator> : process_attribute_default<is_operator> { |
||||||
|
static void init(const is_operator &, function_record *r) { r->is_operator = true; } |
||||||
|
}; |
||||||
|
|
||||||
|
template <> |
||||||
|
struct process_attribute<is_new_style_constructor> |
||||||
|
: process_attribute_default<is_new_style_constructor> { |
||||||
|
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<arg> : process_attribute_default<arg> { |
||||||
|
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<arg_v> : process_attribute_default<arg_v> { |
||||||
|
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<kw_only> : process_attribute_default<kw_only> { |
||||||
|
static void init(const kw_only &, function_record *r) { |
||||||
|
append_self_arg_if_needed(r); |
||||||
|
if (r->has_args && r->nargs_pos != static_cast<std::uint16_t>(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<std::uint16_t>(r->args.size()); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
/// Process a positional-only-argument maker
|
||||||
|
template <> |
||||||
|
struct process_attribute<pos_only> : process_attribute_default<pos_only> { |
||||||
|
static void init(const pos_only &, function_record *r) { |
||||||
|
append_self_arg_if_needed(r); |
||||||
|
r->nargs_pos_only = static_cast<std::uint16_t>(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 <typename T> |
||||||
|
struct process_attribute<T, enable_if_t<is_pyobject<T>::value>> |
||||||
|
: process_attribute_default<handle> { |
||||||
|
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 <typename T> |
||||||
|
struct process_attribute<base<T>> : process_attribute_default<base<T>> { |
||||||
|
static void init(const base<T> &, type_record *r) { r->add_base(typeid(T), nullptr); } |
||||||
|
}; |
||||||
|
|
||||||
|
/// Process a multiple inheritance attribute
|
||||||
|
template <> |
||||||
|
struct process_attribute<multiple_inheritance> : process_attribute_default<multiple_inheritance> { |
||||||
|
static void init(const multiple_inheritance &, type_record *r) { |
||||||
|
r->multiple_inheritance = true; |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
template <> |
||||||
|
struct process_attribute<dynamic_attr> : process_attribute_default<dynamic_attr> { |
||||||
|
static void init(const dynamic_attr &, type_record *r) { r->dynamic_attr = true; } |
||||||
|
}; |
||||||
|
|
||||||
|
template <> |
||||||
|
struct process_attribute<custom_type_setup> { |
||||||
|
static void init(const custom_type_setup &value, type_record *r) { |
||||||
|
r->custom_type_setup_callback = value.value; |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
template <> |
||||||
|
struct process_attribute<is_final> : process_attribute_default<is_final> { |
||||||
|
static void init(const is_final &, type_record *r) { r->is_final = true; } |
||||||
|
}; |
||||||
|
|
||||||
|
template <> |
||||||
|
struct process_attribute<buffer_protocol> : process_attribute_default<buffer_protocol> { |
||||||
|
static void init(const buffer_protocol &, type_record *r) { r->buffer_protocol = true; } |
||||||
|
}; |
||||||
|
|
||||||
|
template <> |
||||||
|
struct process_attribute<metaclass> : process_attribute_default<metaclass> { |
||||||
|
static void init(const metaclass &m, type_record *r) { r->metaclass = m.value; } |
||||||
|
}; |
||||||
|
|
||||||
|
template <> |
||||||
|
struct process_attribute<module_local> : process_attribute_default<module_local> { |
||||||
|
static void init(const module_local &l, type_record *r) { r->module_local = l.value; } |
||||||
|
}; |
||||||
|
|
||||||
|
/// Process a 'prepend' attribute, putting this at the beginning of the overload chain
|
||||||
|
template <> |
||||||
|
struct process_attribute<prepend> : process_attribute_default<prepend> { |
||||||
|
static void init(const prepend &, function_record *r) { r->prepend = true; } |
||||||
|
}; |
||||||
|
|
||||||
|
/// Process an 'arithmetic' attribute for enums (does nothing here)
|
||||||
|
template <> |
||||||
|
struct process_attribute<arithmetic> : process_attribute_default<arithmetic> {}; |
||||||
|
|
||||||
|
template <typename... Ts> |
||||||
|
struct process_attribute<call_guard<Ts...>> : process_attribute_default<call_guard<Ts...>> {}; |
||||||
|
|
||||||
|
/**
|
||||||
|
* 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 <size_t Nurse, size_t Patient> |
||||||
|
struct process_attribute<keep_alive<Nurse, Patient>> |
||||||
|
: public process_attribute_default<keep_alive<Nurse, Patient>> { |
||||||
|
template <size_t N = Nurse, size_t P = Patient, enable_if_t<N != 0 && P != 0, int> = 0> |
||||||
|
static void precall(function_call &call) { |
||||||
|
keep_alive_impl(Nurse, Patient, call, handle()); |
||||||
|
} |
||||||
|
template <size_t N = Nurse, size_t P = Patient, enable_if_t<N != 0 && P != 0, int> = 0> |
||||||
|
static void postcall(function_call &, handle) {} |
||||||
|
template <size_t N = Nurse, size_t P = Patient, enable_if_t<N == 0 || P == 0, int> = 0> |
||||||
|
static void precall(function_call &) {} |
||||||
|
template <size_t N = Nurse, size_t P = Patient, enable_if_t<N == 0 || P == 0, int> = 0> |
||||||
|
static void postcall(function_call &call, handle ret) { |
||||||
|
keep_alive_impl(Nurse, Patient, call, ret); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
/// Recursively iterate over variadic template arguments
|
||||||
|
template <typename... Args> |
||||||
|
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<typename std::decay<Args>::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<typename std::decay<Args>::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<typename std::decay<Args>::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<typename std::decay<Args>::type>::postcall(call, fn_ret), 0)...}; |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename T> |
||||||
|
using is_call_guard = is_instantiation<call_guard, T>; |
||||||
|
|
||||||
|
/// Extract the ``type`` from the first `call_guard` in `Extras...` (or `void_type` if none found)
|
||||||
|
template <typename... Extra> |
||||||
|
using extract_guard_t = typename exactly_one_t<is_call_guard, call_guard<>, Extra...>::type; |
||||||
|
|
||||||
|
/// Check the number of named arguments at compile time
|
||||||
|
template <typename... Extra, |
||||||
|
size_t named = constexpr_sum(std::is_base_of<arg, Extra>::value...), |
||||||
|
size_t self = constexpr_sum(std::is_same<is_method, Extra>::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) |
||||||
@ -0,0 +1,193 @@ |
|||||||
|
/*
|
||||||
|
pybind11/buffer_info.h: Python buffer object interface |
||||||
|
|
||||||
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> |
||||||
|
|
||||||
|
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<ssize_t> c_strides(const std::vector<ssize_t> &shape, ssize_t itemsize) { |
||||||
|
auto ndim = shape.size(); |
||||||
|
std::vector<ssize_t> 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<ssize_t> f_strides(const std::vector<ssize_t> &shape, ssize_t itemsize) { |
||||||
|
auto ndim = shape.size(); |
||||||
|
std::vector<ssize_t> strides(ndim, itemsize); |
||||||
|
for (size_t i = 1; i < ndim; ++i) { |
||||||
|
strides[i] = strides[i - 1] * shape[i - 1]; |
||||||
|
} |
||||||
|
return strides; |
||||||
|
} |
||||||
|
|
||||||
|
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<T>::format()
|
||||||
|
ssize_t ndim = 0; // Number of dimensions
|
||||||
|
std::vector<ssize_t> shape; // Shape of the tensor (1 entry per dimension)
|
||||||
|
std::vector<ssize_t> 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<ssize_t> shape_in, |
||||||
|
detail::any_container<ssize_t> 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 <typename T> |
||||||
|
buffer_info(T *ptr, |
||||||
|
detail::any_container<ssize_t> shape_in, |
||||||
|
detail::any_container<ssize_t> strides_in, |
||||||
|
bool readonly = false) |
||||||
|
: buffer_info(private_ctr_tag(), |
||||||
|
ptr, |
||||||
|
sizeof(T), |
||||||
|
format_descriptor<T>::format(), |
||||||
|
static_cast<ssize_t>(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 <typename T> |
||||||
|
buffer_info(T *ptr, ssize_t size, bool readonly = false) |
||||||
|
: buffer_info(ptr, sizeof(T), format_descriptor<T>::format(), size, readonly) {} |
||||||
|
|
||||||
|
template <typename T> |
||||||
|
buffer_info(const T *ptr, ssize_t size, bool readonly = true) |
||||||
|
: buffer_info( |
||||||
|
const_cast<T *>(ptr), sizeof(T), format_descriptor<T>::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<ssize_t>(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; } |
||||||
|
|
||||||
|
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<ssize_t> &&shape_in, |
||||||
|
detail::any_container<ssize_t> &&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 <typename T, typename SFINAE = void> |
||||||
|
struct compare_buffer_info { |
||||||
|
static bool compare(const buffer_info &b) { |
||||||
|
return b.format == format_descriptor<T>::format() && b.itemsize == (ssize_t) sizeof(T); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename T> |
||||||
|
struct compare_buffer_info<T, detail::enable_if_t<std::is_integral<T>::value>> { |
||||||
|
static bool compare(const buffer_info &b) { |
||||||
|
return (size_t) b.itemsize == sizeof(T) |
||||||
|
&& (b.format == format_descriptor<T>::value |
||||||
|
|| ((sizeof(T) == sizeof(long)) |
||||||
|
&& b.format == (std::is_unsigned<T>::value ? "L" : "l")) |
||||||
|
|| ((sizeof(T) == sizeof(size_t)) |
||||||
|
&& b.format == (std::is_unsigned<T>::value ? "N" : "n"))); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,225 @@ |
|||||||
|
/*
|
||||||
|
pybind11/chrono.h: Transparent conversion between std::chrono and python's datetime |
||||||
|
|
||||||
|
Copyright (c) 2016 Trent Houliston <trent@houliston.me> and |
||||||
|
Wenzel Jakob <wenzel.jakob@epfl.ch> |
||||||
|
|
||||||
|
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 "pybind11.h" |
||||||
|
|
||||||
|
#include <chrono> |
||||||
|
#include <cmath> |
||||||
|
#include <ctime> |
||||||
|
#include <datetime.h> |
||||||
|
#include <mutex> |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
template <typename type> |
||||||
|
class duration_caster { |
||||||
|
public: |
||||||
|
using rep = typename type::rep; |
||||||
|
using period = typename type::period; |
||||||
|
|
||||||
|
// signed 25 bits required by the standard.
|
||||||
|
using days = std::chrono::duration<int_least32_t, std::ratio<86400>>; |
||||||
|
|
||||||
|
bool load(handle src, bool) { |
||||||
|
using namespace std::chrono; |
||||||
|
|
||||||
|
// Lazy initialise the PyDateTime import
|
||||||
|
if (!PyDateTimeAPI) { |
||||||
|
PyDateTime_IMPORT; |
||||||
|
} |
||||||
|
|
||||||
|
if (!src) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
// If invoked with datetime.delta object
|
||||||
|
if (PyDelta_Check(src.ptr())) { |
||||||
|
value = type(duration_cast<duration<rep, period>>( |
||||||
|
days(PyDateTime_DELTA_GET_DAYS(src.ptr())) |
||||||
|
+ seconds(PyDateTime_DELTA_GET_SECONDS(src.ptr())) |
||||||
|
+ microseconds(PyDateTime_DELTA_GET_MICROSECONDS(src.ptr())))); |
||||||
|
return true; |
||||||
|
} |
||||||
|
// If invoked with a float we assume it is seconds and convert
|
||||||
|
if (PyFloat_Check(src.ptr())) { |
||||||
|
value = type(duration_cast<duration<rep, period>>( |
||||||
|
duration<double>(PyFloat_AsDouble(src.ptr())))); |
||||||
|
return true; |
||||||
|
} |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
// If this is a duration just return it back
|
||||||
|
static const std::chrono::duration<rep, period> & |
||||||
|
get_duration(const std::chrono::duration<rep, period> &src) { |
||||||
|
return src; |
||||||
|
} |
||||||
|
|
||||||
|
// If this is a time_point get the time_since_epoch
|
||||||
|
template <typename Clock> |
||||||
|
static std::chrono::duration<rep, period> |
||||||
|
get_duration(const std::chrono::time_point<Clock, std::chrono::duration<rep, period>> &src) { |
||||||
|
return src.time_since_epoch(); |
||||||
|
} |
||||||
|
|
||||||
|
static handle cast(const type &src, return_value_policy /* policy */, handle /* parent */) { |
||||||
|
using namespace std::chrono; |
||||||
|
|
||||||
|
// Use overloaded function to get our duration from our source
|
||||||
|
// Works out if it is a duration or time_point and get the duration
|
||||||
|
auto d = get_duration(src); |
||||||
|
|
||||||
|
// Lazy initialise the PyDateTime import
|
||||||
|
if (!PyDateTimeAPI) { |
||||||
|
PyDateTime_IMPORT; |
||||||
|
} |
||||||
|
|
||||||
|
// Declare these special duration types so the conversions happen with the correct
|
||||||
|
// primitive types (int)
|
||||||
|
using dd_t = duration<int, std::ratio<86400>>; |
||||||
|
using ss_t = duration<int, std::ratio<1>>; |
||||||
|
using us_t = duration<int, std::micro>; |
||||||
|
|
||||||
|
auto dd = duration_cast<dd_t>(d); |
||||||
|
auto subd = d - dd; |
||||||
|
auto ss = duration_cast<ss_t>(subd); |
||||||
|
auto us = duration_cast<us_t>(subd - ss); |
||||||
|
return PyDelta_FromDSU(dd.count(), ss.count(), us.count()); |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_TYPE_CASTER(type, const_name("datetime.timedelta")); |
||||||
|
}; |
||||||
|
|
||||||
|
inline std::tm *localtime_thread_safe(const std::time_t *time, std::tm *buf) { |
||||||
|
#if (defined(__STDC_LIB_EXT1__) && defined(__STDC_WANT_LIB_EXT1__)) || defined(_MSC_VER) |
||||||
|
if (localtime_s(buf, time)) |
||||||
|
return nullptr; |
||||||
|
return buf; |
||||||
|
#else |
||||||
|
static std::mutex mtx; |
||||||
|
std::lock_guard<std::mutex> lock(mtx); |
||||||
|
std::tm *tm_ptr = std::localtime(time); |
||||||
|
if (tm_ptr != nullptr) { |
||||||
|
*buf = *tm_ptr; |
||||||
|
} |
||||||
|
return tm_ptr; |
||||||
|
#endif |
||||||
|
} |
||||||
|
|
||||||
|
// This is for casting times on the system clock into datetime.datetime instances
|
||||||
|
template <typename Duration> |
||||||
|
class type_caster<std::chrono::time_point<std::chrono::system_clock, Duration>> { |
||||||
|
public: |
||||||
|
using type = std::chrono::time_point<std::chrono::system_clock, Duration>; |
||||||
|
bool load(handle src, bool) { |
||||||
|
using namespace std::chrono; |
||||||
|
|
||||||
|
// Lazy initialise the PyDateTime import
|
||||||
|
if (!PyDateTimeAPI) { |
||||||
|
PyDateTime_IMPORT; |
||||||
|
} |
||||||
|
|
||||||
|
if (!src) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
std::tm cal; |
||||||
|
microseconds msecs; |
||||||
|
|
||||||
|
if (PyDateTime_Check(src.ptr())) { |
||||||
|
cal.tm_sec = PyDateTime_DATE_GET_SECOND(src.ptr()); |
||||||
|
cal.tm_min = PyDateTime_DATE_GET_MINUTE(src.ptr()); |
||||||
|
cal.tm_hour = PyDateTime_DATE_GET_HOUR(src.ptr()); |
||||||
|
cal.tm_mday = PyDateTime_GET_DAY(src.ptr()); |
||||||
|
cal.tm_mon = PyDateTime_GET_MONTH(src.ptr()) - 1; |
||||||
|
cal.tm_year = PyDateTime_GET_YEAR(src.ptr()) - 1900; |
||||||
|
cal.tm_isdst = -1; |
||||||
|
msecs = microseconds(PyDateTime_DATE_GET_MICROSECOND(src.ptr())); |
||||||
|
} else if (PyDate_Check(src.ptr())) { |
||||||
|
cal.tm_sec = 0; |
||||||
|
cal.tm_min = 0; |
||||||
|
cal.tm_hour = 0; |
||||||
|
cal.tm_mday = PyDateTime_GET_DAY(src.ptr()); |
||||||
|
cal.tm_mon = PyDateTime_GET_MONTH(src.ptr()) - 1; |
||||||
|
cal.tm_year = PyDateTime_GET_YEAR(src.ptr()) - 1900; |
||||||
|
cal.tm_isdst = -1; |
||||||
|
msecs = microseconds(0); |
||||||
|
} else if (PyTime_Check(src.ptr())) { |
||||||
|
cal.tm_sec = PyDateTime_TIME_GET_SECOND(src.ptr()); |
||||||
|
cal.tm_min = PyDateTime_TIME_GET_MINUTE(src.ptr()); |
||||||
|
cal.tm_hour = PyDateTime_TIME_GET_HOUR(src.ptr()); |
||||||
|
cal.tm_mday = 1; // This date (day, month, year) = (1, 0, 70)
|
||||||
|
cal.tm_mon = 0; // represents 1-Jan-1970, which is the first
|
||||||
|
cal.tm_year = 70; // earliest available date for Python's datetime
|
||||||
|
cal.tm_isdst = -1; |
||||||
|
msecs = microseconds(PyDateTime_TIME_GET_MICROSECOND(src.ptr())); |
||||||
|
} else { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
value = time_point_cast<Duration>(system_clock::from_time_t(std::mktime(&cal)) + msecs); |
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
static handle cast(const std::chrono::time_point<std::chrono::system_clock, Duration> &src, |
||||||
|
return_value_policy /* policy */, |
||||||
|
handle /* parent */) { |
||||||
|
using namespace std::chrono; |
||||||
|
|
||||||
|
// Lazy initialise the PyDateTime import
|
||||||
|
if (!PyDateTimeAPI) { |
||||||
|
PyDateTime_IMPORT; |
||||||
|
} |
||||||
|
|
||||||
|
// Get out microseconds, and make sure they are positive, to avoid bug in eastern
|
||||||
|
// hemisphere time zones (cfr. https://github.com/pybind/pybind11/issues/2417)
|
||||||
|
using us_t = duration<int, std::micro>; |
||||||
|
auto us = duration_cast<us_t>(src.time_since_epoch() % seconds(1)); |
||||||
|
if (us.count() < 0) { |
||||||
|
us += seconds(1); |
||||||
|
} |
||||||
|
|
||||||
|
// Subtract microseconds BEFORE `system_clock::to_time_t`, because:
|
||||||
|
// > If std::time_t has lower precision, it is implementation-defined whether the value is
|
||||||
|
// rounded or truncated. (https://en.cppreference.com/w/cpp/chrono/system_clock/to_time_t)
|
||||||
|
std::time_t tt |
||||||
|
= system_clock::to_time_t(time_point_cast<system_clock::duration>(src - us)); |
||||||
|
|
||||||
|
std::tm localtime; |
||||||
|
std::tm *localtime_ptr = localtime_thread_safe(&tt, &localtime); |
||||||
|
if (!localtime_ptr) { |
||||||
|
throw cast_error("Unable to represent system_clock in local time"); |
||||||
|
} |
||||||
|
return PyDateTime_FromDateAndTime(localtime.tm_year + 1900, |
||||||
|
localtime.tm_mon + 1, |
||||||
|
localtime.tm_mday, |
||||||
|
localtime.tm_hour, |
||||||
|
localtime.tm_min, |
||||||
|
localtime.tm_sec, |
||||||
|
us.count()); |
||||||
|
} |
||||||
|
PYBIND11_TYPE_CASTER(type, const_name("datetime.datetime")); |
||||||
|
}; |
||||||
|
|
||||||
|
// Other clocks that are not the system clock are not measured as datetime.datetime objects
|
||||||
|
// since they are not measured on calendar time. So instead we just make them timedeltas
|
||||||
|
// Or if they have passed us a time as a float we convert that
|
||||||
|
template <typename Clock, typename Duration> |
||||||
|
class type_caster<std::chrono::time_point<Clock, Duration>> |
||||||
|
: public duration_caster<std::chrono::time_point<Clock, Duration>> {}; |
||||||
|
|
||||||
|
template <typename Rep, typename Period> |
||||||
|
class type_caster<std::chrono::duration<Rep, Period>> |
||||||
|
: public duration_caster<std::chrono::duration<Rep, Period>> {}; |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
@ -0,0 +1,2 @@ |
|||||||
|
#include "detail/common.h" |
||||||
|
#warning "Including 'common.h' is deprecated. It will be removed in v3.0. Use 'pybind11.h'." |
||||||
@ -0,0 +1,74 @@ |
|||||||
|
/*
|
||||||
|
pybind11/complex.h: Complex number support |
||||||
|
|
||||||
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> |
||||||
|
|
||||||
|
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 "pybind11.h" |
||||||
|
|
||||||
|
#include <complex> |
||||||
|
|
||||||
|
/// glibc defines I as a macro which breaks things, e.g., boost template names
|
||||||
|
#ifdef I |
||||||
|
# undef I |
||||||
|
#endif |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
|
||||||
|
template <typename T> |
||||||
|
struct format_descriptor<std::complex<T>, detail::enable_if_t<std::is_floating_point<T>::value>> { |
||||||
|
static constexpr const char c = format_descriptor<T>::c; |
||||||
|
static constexpr const char value[3] = {'Z', c, '\0'}; |
||||||
|
static std::string format() { return std::string(value); } |
||||||
|
}; |
||||||
|
|
||||||
|
#ifndef PYBIND11_CPP17 |
||||||
|
|
||||||
|
template <typename T> |
||||||
|
constexpr const char |
||||||
|
format_descriptor<std::complex<T>, |
||||||
|
detail::enable_if_t<std::is_floating_point<T>::value>>::value[3]; |
||||||
|
|
||||||
|
#endif |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
template <typename T> |
||||||
|
struct is_fmt_numeric<std::complex<T>, detail::enable_if_t<std::is_floating_point<T>::value>> { |
||||||
|
static constexpr bool value = true; |
||||||
|
static constexpr int index = is_fmt_numeric<T>::index + 3; |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename T> |
||||||
|
class type_caster<std::complex<T>> { |
||||||
|
public: |
||||||
|
bool load(handle src, bool convert) { |
||||||
|
if (!src) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
if (!convert && !PyComplex_Check(src.ptr())) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
Py_complex result = PyComplex_AsCComplex(src.ptr()); |
||||||
|
if (result.real == -1.0 && PyErr_Occurred()) { |
||||||
|
PyErr_Clear(); |
||||||
|
return false; |
||||||
|
} |
||||||
|
value = std::complex<T>((T) result.real, (T) result.imag); |
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
static handle |
||||||
|
cast(const std::complex<T> &src, return_value_policy /* policy */, handle /* parent */) { |
||||||
|
return PyComplex_FromDoubles((double) src.real(), (double) src.imag()); |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_TYPE_CASTER(std::complex<T>, const_name("complex")); |
||||||
|
}; |
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
@ -0,0 +1,743 @@ |
|||||||
|
/*
|
||||||
|
pybind11/detail/class.h: Python C API implementation details for py::class_ |
||||||
|
|
||||||
|
Copyright (c) 2017 Wenzel Jakob <wenzel.jakob@epfl.ch> |
||||||
|
|
||||||
|
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 "../attr.h" |
||||||
|
#include "../options.h" |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
#if !defined(PYPY_VERSION) |
||||||
|
# define PYBIND11_BUILTIN_QUALNAME |
||||||
|
# define PYBIND11_SET_OLDPY_QUALNAME(obj, nameobj) |
||||||
|
#else |
||||||
|
// In PyPy, we still set __qualname__ so that we can produce reliable function type
|
||||||
|
// signatures; in CPython this macro expands to nothing:
|
||||||
|
# define PYBIND11_SET_OLDPY_QUALNAME(obj, nameobj) \ |
||||||
|
setattr((PyObject *) obj, "__qualname__", nameobj) |
||||||
|
#endif |
||||||
|
|
||||||
|
inline std::string get_fully_qualified_tp_name(PyTypeObject *type) { |
||||||
|
#if !defined(PYPY_VERSION) |
||||||
|
return type->tp_name; |
||||||
|
#else |
||||||
|
auto module_name = handle((PyObject *) type).attr("__module__").cast<std::string>(); |
||||||
|
if (module_name == PYBIND11_BUILTINS_MODULE) |
||||||
|
return type->tp_name; |
||||||
|
else |
||||||
|
return std::move(module_name) + "." + type->tp_name; |
||||||
|
#endif |
||||||
|
} |
||||||
|
|
||||||
|
inline PyTypeObject *type_incref(PyTypeObject *type) { |
||||||
|
Py_INCREF(type); |
||||||
|
return type; |
||||||
|
} |
||||||
|
|
||||||
|
#if !defined(PYPY_VERSION) |
||||||
|
|
||||||
|
/// `pybind11_static_property.__get__()`: Always pass the class instead of the instance.
|
||||||
|
extern "C" inline PyObject *pybind11_static_get(PyObject *self, PyObject * /*ob*/, PyObject *cls) { |
||||||
|
return PyProperty_Type.tp_descr_get(self, cls, cls); |
||||||
|
} |
||||||
|
|
||||||
|
/// `pybind11_static_property.__set__()`: Just like the above `__get__()`.
|
||||||
|
extern "C" inline int pybind11_static_set(PyObject *self, PyObject *obj, PyObject *value) { |
||||||
|
PyObject *cls = PyType_Check(obj) ? obj : (PyObject *) Py_TYPE(obj); |
||||||
|
return PyProperty_Type.tp_descr_set(self, cls, value); |
||||||
|
} |
||||||
|
|
||||||
|
// Forward declaration to use in `make_static_property_type()`
|
||||||
|
inline void enable_dynamic_attributes(PyHeapTypeObject *heap_type); |
||||||
|
|
||||||
|
/** A `static_property` is the same as a `property` but the `__get__()` and `__set__()`
|
||||||
|
methods are modified to always use the object type instead of a concrete instance. |
||||||
|
Return value: New reference. */ |
||||||
|
inline PyTypeObject *make_static_property_type() { |
||||||
|
constexpr auto *name = "pybind11_static_property"; |
||||||
|
auto name_obj = reinterpret_steal<object>(PYBIND11_FROM_STRING(name)); |
||||||
|
|
||||||
|
/* Danger zone: from now (and until PyType_Ready), make sure to
|
||||||
|
issue no Python C API calls which could potentially invoke the |
||||||
|
garbage collector (the GC will call type_traverse(), which will in |
||||||
|
turn find the newly constructed type in an invalid state) */ |
||||||
|
auto *heap_type = (PyHeapTypeObject *) PyType_Type.tp_alloc(&PyType_Type, 0); |
||||||
|
if (!heap_type) { |
||||||
|
pybind11_fail("make_static_property_type(): error allocating type!"); |
||||||
|
} |
||||||
|
|
||||||
|
heap_type->ht_name = name_obj.inc_ref().ptr(); |
||||||
|
# ifdef PYBIND11_BUILTIN_QUALNAME |
||||||
|
heap_type->ht_qualname = name_obj.inc_ref().ptr(); |
||||||
|
# endif |
||||||
|
|
||||||
|
auto *type = &heap_type->ht_type; |
||||||
|
type->tp_name = name; |
||||||
|
type->tp_base = type_incref(&PyProperty_Type); |
||||||
|
type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE; |
||||||
|
type->tp_descr_get = pybind11_static_get; |
||||||
|
type->tp_descr_set = pybind11_static_set; |
||||||
|
|
||||||
|
if (PyType_Ready(type) < 0) { |
||||||
|
pybind11_fail("make_static_property_type(): failure in PyType_Ready()!"); |
||||||
|
} |
||||||
|
|
||||||
|
# if PY_VERSION_HEX >= 0x030C0000 |
||||||
|
// PRE 3.12 FEATURE FREEZE. PLEASE REVIEW AFTER FREEZE.
|
||||||
|
// Since Python-3.12 property-derived types are required to
|
||||||
|
// have dynamic attributes (to set `__doc__`)
|
||||||
|
enable_dynamic_attributes(heap_type); |
||||||
|
# endif |
||||||
|
|
||||||
|
setattr((PyObject *) type, "__module__", str("pybind11_builtins")); |
||||||
|
PYBIND11_SET_OLDPY_QUALNAME(type, name_obj); |
||||||
|
|
||||||
|
return type; |
||||||
|
} |
||||||
|
|
||||||
|
#else // PYPY
|
||||||
|
|
||||||
|
/** PyPy has some issues with the above C API, so we evaluate Python code instead.
|
||||||
|
This function will only be called once so performance isn't really a concern. |
||||||
|
Return value: New reference. */ |
||||||
|
inline PyTypeObject *make_static_property_type() { |
||||||
|
auto d = dict(); |
||||||
|
PyObject *result = PyRun_String(R"(\
|
||||||
|
class pybind11_static_property(property): |
||||||
|
def __get__(self, obj, cls): |
||||||
|
return property.__get__(self, cls, cls) |
||||||
|
|
||||||
|
def __set__(self, obj, value): |
||||||
|
cls = obj if isinstance(obj, type) else type(obj) |
||||||
|
property.__set__(self, cls, value) |
||||||
|
)", |
||||||
|
Py_file_input, |
||||||
|
d.ptr(), |
||||||
|
d.ptr()); |
||||||
|
if (result == nullptr) |
||||||
|
throw error_already_set(); |
||||||
|
Py_DECREF(result); |
||||||
|
return (PyTypeObject *) d["pybind11_static_property"].cast<object>().release().ptr(); |
||||||
|
} |
||||||
|
|
||||||
|
#endif // PYPY
|
||||||
|
|
||||||
|
/** Types with static properties need to handle `Type.static_prop = x` in a specific way.
|
||||||
|
By default, Python replaces the `static_property` itself, but for wrapped C++ types |
||||||
|
we need to call `static_property.__set__()` in order to propagate the new value to |
||||||
|
the underlying C++ data structure. */ |
||||||
|
extern "C" inline int pybind11_meta_setattro(PyObject *obj, PyObject *name, PyObject *value) { |
||||||
|
// Use `_PyType_Lookup()` instead of `PyObject_GetAttr()` in order to get the raw
|
||||||
|
// descriptor (`property`) instead of calling `tp_descr_get` (`property.__get__()`).
|
||||||
|
PyObject *descr = _PyType_Lookup((PyTypeObject *) obj, name); |
||||||
|
|
||||||
|
// The following assignment combinations are possible:
|
||||||
|
// 1. `Type.static_prop = value` --> descr_set: `Type.static_prop.__set__(value)`
|
||||||
|
// 2. `Type.static_prop = other_static_prop` --> setattro: replace existing `static_prop`
|
||||||
|
// 3. `Type.regular_attribute = value` --> setattro: regular attribute assignment
|
||||||
|
auto *const static_prop = (PyObject *) get_internals().static_property_type; |
||||||
|
const auto call_descr_set = (descr != nullptr) && (value != nullptr) |
||||||
|
&& (PyObject_IsInstance(descr, static_prop) != 0) |
||||||
|
&& (PyObject_IsInstance(value, static_prop) == 0); |
||||||
|
if (call_descr_set) { |
||||||
|
// Call `static_property.__set__()` instead of replacing the `static_property`.
|
||||||
|
#if !defined(PYPY_VERSION) |
||||||
|
return Py_TYPE(descr)->tp_descr_set(descr, obj, value); |
||||||
|
#else |
||||||
|
if (PyObject *result = PyObject_CallMethod(descr, "__set__", "OO", obj, value)) { |
||||||
|
Py_DECREF(result); |
||||||
|
return 0; |
||||||
|
} else { |
||||||
|
return -1; |
||||||
|
} |
||||||
|
#endif |
||||||
|
} else { |
||||||
|
// Replace existing attribute.
|
||||||
|
return PyType_Type.tp_setattro(obj, name, value); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
/**
|
||||||
|
* Python 3's PyInstanceMethod_Type hides itself via its tp_descr_get, which prevents aliasing |
||||||
|
* methods via cls.attr("m2") = cls.attr("m1"): instead the tp_descr_get returns a plain function, |
||||||
|
* when called on a class, or a PyMethod, when called on an instance. Override that behaviour here |
||||||
|
* to do a special case bypass for PyInstanceMethod_Types. |
||||||
|
*/ |
||||||
|
extern "C" inline PyObject *pybind11_meta_getattro(PyObject *obj, PyObject *name) { |
||||||
|
PyObject *descr = _PyType_Lookup((PyTypeObject *) obj, name); |
||||||
|
if (descr && PyInstanceMethod_Check(descr)) { |
||||||
|
Py_INCREF(descr); |
||||||
|
return descr; |
||||||
|
} |
||||||
|
return PyType_Type.tp_getattro(obj, name); |
||||||
|
} |
||||||
|
|
||||||
|
/// metaclass `__call__` function that is used to create all pybind11 objects.
|
||||||
|
extern "C" inline PyObject *pybind11_meta_call(PyObject *type, PyObject *args, PyObject *kwargs) { |
||||||
|
|
||||||
|
// use the default metaclass call to create/initialize the object
|
||||||
|
PyObject *self = PyType_Type.tp_call(type, args, kwargs); |
||||||
|
if (self == nullptr) { |
||||||
|
return nullptr; |
||||||
|
} |
||||||
|
|
||||||
|
// This must be a pybind11 instance
|
||||||
|
auto *instance = reinterpret_cast<detail::instance *>(self); |
||||||
|
|
||||||
|
// Ensure that the base __init__ function(s) were called
|
||||||
|
for (const auto &vh : values_and_holders(instance)) { |
||||||
|
if (!vh.holder_constructed()) { |
||||||
|
PyErr_Format(PyExc_TypeError, |
||||||
|
"%.200s.__init__() must be called when overriding __init__", |
||||||
|
get_fully_qualified_tp_name(vh.type->type).c_str()); |
||||||
|
Py_DECREF(self); |
||||||
|
return nullptr; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
return self; |
||||||
|
} |
||||||
|
|
||||||
|
/// Cleanup the type-info for a pybind11-registered type.
|
||||||
|
extern "C" inline void pybind11_meta_dealloc(PyObject *obj) { |
||||||
|
auto *type = (PyTypeObject *) obj; |
||||||
|
auto &internals = get_internals(); |
||||||
|
|
||||||
|
// A pybind11-registered type will:
|
||||||
|
// 1) be found in internals.registered_types_py
|
||||||
|
// 2) have exactly one associated `detail::type_info`
|
||||||
|
auto found_type = internals.registered_types_py.find(type); |
||||||
|
if (found_type != internals.registered_types_py.end() && found_type->second.size() == 1 |
||||||
|
&& found_type->second[0]->type == type) { |
||||||
|
|
||||||
|
auto *tinfo = found_type->second[0]; |
||||||
|
auto tindex = std::type_index(*tinfo->cpptype); |
||||||
|
internals.direct_conversions.erase(tindex); |
||||||
|
|
||||||
|
if (tinfo->module_local) { |
||||||
|
get_local_internals().registered_types_cpp.erase(tindex); |
||||||
|
} else { |
||||||
|
internals.registered_types_cpp.erase(tindex); |
||||||
|
} |
||||||
|
internals.registered_types_py.erase(tinfo->type); |
||||||
|
|
||||||
|
// Actually just `std::erase_if`, but that's only available in C++20
|
||||||
|
auto &cache = internals.inactive_override_cache; |
||||||
|
for (auto it = cache.begin(), last = cache.end(); it != last;) { |
||||||
|
if (it->first == (PyObject *) tinfo->type) { |
||||||
|
it = cache.erase(it); |
||||||
|
} else { |
||||||
|
++it; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
delete tinfo; |
||||||
|
} |
||||||
|
|
||||||
|
PyType_Type.tp_dealloc(obj); |
||||||
|
} |
||||||
|
|
||||||
|
/** This metaclass is assigned by default to all pybind11 types and is required in order
|
||||||
|
for static properties to function correctly. Users may override this using `py::metaclass`. |
||||||
|
Return value: New reference. */ |
||||||
|
inline PyTypeObject *make_default_metaclass() { |
||||||
|
constexpr auto *name = "pybind11_type"; |
||||||
|
auto name_obj = reinterpret_steal<object>(PYBIND11_FROM_STRING(name)); |
||||||
|
|
||||||
|
/* Danger zone: from now (and until PyType_Ready), make sure to
|
||||||
|
issue no Python C API calls which could potentially invoke the |
||||||
|
garbage collector (the GC will call type_traverse(), which will in |
||||||
|
turn find the newly constructed type in an invalid state) */ |
||||||
|
auto *heap_type = (PyHeapTypeObject *) PyType_Type.tp_alloc(&PyType_Type, 0); |
||||||
|
if (!heap_type) { |
||||||
|
pybind11_fail("make_default_metaclass(): error allocating metaclass!"); |
||||||
|
} |
||||||
|
|
||||||
|
heap_type->ht_name = name_obj.inc_ref().ptr(); |
||||||
|
#ifdef PYBIND11_BUILTIN_QUALNAME |
||||||
|
heap_type->ht_qualname = name_obj.inc_ref().ptr(); |
||||||
|
#endif |
||||||
|
|
||||||
|
auto *type = &heap_type->ht_type; |
||||||
|
type->tp_name = name; |
||||||
|
type->tp_base = type_incref(&PyType_Type); |
||||||
|
type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE; |
||||||
|
|
||||||
|
type->tp_call = pybind11_meta_call; |
||||||
|
|
||||||
|
type->tp_setattro = pybind11_meta_setattro; |
||||||
|
type->tp_getattro = pybind11_meta_getattro; |
||||||
|
|
||||||
|
type->tp_dealloc = pybind11_meta_dealloc; |
||||||
|
|
||||||
|
if (PyType_Ready(type) < 0) { |
||||||
|
pybind11_fail("make_default_metaclass(): failure in PyType_Ready()!"); |
||||||
|
} |
||||||
|
|
||||||
|
setattr((PyObject *) type, "__module__", str("pybind11_builtins")); |
||||||
|
PYBIND11_SET_OLDPY_QUALNAME(type, name_obj); |
||||||
|
|
||||||
|
return type; |
||||||
|
} |
||||||
|
|
||||||
|
/// For multiple inheritance types we need to recursively register/deregister base pointers for any
|
||||||
|
/// base classes with pointers that are difference from the instance value pointer so that we can
|
||||||
|
/// correctly recognize an offset base class pointer. This calls a function with any offset base
|
||||||
|
/// ptrs.
|
||||||
|
inline void traverse_offset_bases(void *valueptr, |
||||||
|
const detail::type_info *tinfo, |
||||||
|
instance *self, |
||||||
|
bool (*f)(void * /*parentptr*/, instance * /*self*/)) { |
||||||
|
for (handle h : reinterpret_borrow<tuple>(tinfo->type->tp_bases)) { |
||||||
|
if (auto *parent_tinfo = get_type_info((PyTypeObject *) h.ptr())) { |
||||||
|
for (auto &c : parent_tinfo->implicit_casts) { |
||||||
|
if (c.first == tinfo->cpptype) { |
||||||
|
auto *parentptr = c.second(valueptr); |
||||||
|
if (parentptr != valueptr) { |
||||||
|
f(parentptr, self); |
||||||
|
} |
||||||
|
traverse_offset_bases(parentptr, parent_tinfo, self, f); |
||||||
|
break; |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
inline bool register_instance_impl(void *ptr, instance *self) { |
||||||
|
get_internals().registered_instances.emplace(ptr, self); |
||||||
|
return true; // unused, but gives the same signature as the deregister func
|
||||||
|
} |
||||||
|
inline bool deregister_instance_impl(void *ptr, instance *self) { |
||||||
|
auto ®istered_instances = get_internals().registered_instances; |
||||||
|
auto range = registered_instances.equal_range(ptr); |
||||||
|
for (auto it = range.first; it != range.second; ++it) { |
||||||
|
if (self == it->second) { |
||||||
|
registered_instances.erase(it); |
||||||
|
return true; |
||||||
|
} |
||||||
|
} |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
inline void register_instance(instance *self, void *valptr, const type_info *tinfo) { |
||||||
|
register_instance_impl(valptr, self); |
||||||
|
if (!tinfo->simple_ancestors) { |
||||||
|
traverse_offset_bases(valptr, tinfo, self, register_instance_impl); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
inline bool deregister_instance(instance *self, void *valptr, const type_info *tinfo) { |
||||||
|
bool ret = deregister_instance_impl(valptr, self); |
||||||
|
if (!tinfo->simple_ancestors) { |
||||||
|
traverse_offset_bases(valptr, tinfo, self, deregister_instance_impl); |
||||||
|
} |
||||||
|
return ret; |
||||||
|
} |
||||||
|
|
||||||
|
/// Instance creation function for all pybind11 types. It allocates the internal instance layout
|
||||||
|
/// for holding C++ objects and holders. Allocation is done lazily (the first time the instance is
|
||||||
|
/// cast to a reference or pointer), and initialization is done by an `__init__` function.
|
||||||
|
inline PyObject *make_new_instance(PyTypeObject *type) { |
||||||
|
#if defined(PYPY_VERSION) |
||||||
|
// PyPy gets tp_basicsize wrong (issue 2482) under multiple inheritance when the first
|
||||||
|
// inherited object is a plain Python type (i.e. not derived from an extension type). Fix it.
|
||||||
|
ssize_t instance_size = static_cast<ssize_t>(sizeof(instance)); |
||||||
|
if (type->tp_basicsize < instance_size) { |
||||||
|
type->tp_basicsize = instance_size; |
||||||
|
} |
||||||
|
#endif |
||||||
|
PyObject *self = type->tp_alloc(type, 0); |
||||||
|
auto *inst = reinterpret_cast<instance *>(self); |
||||||
|
// Allocate the value/holder internals:
|
||||||
|
inst->allocate_layout(); |
||||||
|
|
||||||
|
return self; |
||||||
|
} |
||||||
|
|
||||||
|
/// Instance creation function for all pybind11 types. It only allocates space for the
|
||||||
|
/// C++ object, but doesn't call the constructor -- an `__init__` function must do that.
|
||||||
|
extern "C" inline PyObject *pybind11_object_new(PyTypeObject *type, PyObject *, PyObject *) { |
||||||
|
return make_new_instance(type); |
||||||
|
} |
||||||
|
|
||||||
|
/// An `__init__` function constructs the C++ object. Users should provide at least one
|
||||||
|
/// of these using `py::init` or directly with `.def(__init__, ...)`. Otherwise, the
|
||||||
|
/// following default function will be used which simply throws an exception.
|
||||||
|
extern "C" inline int pybind11_object_init(PyObject *self, PyObject *, PyObject *) { |
||||||
|
PyTypeObject *type = Py_TYPE(self); |
||||||
|
std::string msg = get_fully_qualified_tp_name(type) + ": No constructor defined!"; |
||||||
|
PyErr_SetString(PyExc_TypeError, msg.c_str()); |
||||||
|
return -1; |
||||||
|
} |
||||||
|
|
||||||
|
inline void add_patient(PyObject *nurse, PyObject *patient) { |
||||||
|
auto &internals = get_internals(); |
||||||
|
auto *instance = reinterpret_cast<detail::instance *>(nurse); |
||||||
|
instance->has_patients = true; |
||||||
|
Py_INCREF(patient); |
||||||
|
internals.patients[nurse].push_back(patient); |
||||||
|
} |
||||||
|
|
||||||
|
inline void clear_patients(PyObject *self) { |
||||||
|
auto *instance = reinterpret_cast<detail::instance *>(self); |
||||||
|
auto &internals = get_internals(); |
||||||
|
auto pos = internals.patients.find(self); |
||||||
|
assert(pos != internals.patients.end()); |
||||||
|
// Clearing the patients can cause more Python code to run, which
|
||||||
|
// can invalidate the iterator. Extract the vector of patients
|
||||||
|
// from the unordered_map first.
|
||||||
|
auto patients = std::move(pos->second); |
||||||
|
internals.patients.erase(pos); |
||||||
|
instance->has_patients = false; |
||||||
|
for (PyObject *&patient : patients) { |
||||||
|
Py_CLEAR(patient); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
/// Clears all internal data from the instance and removes it from registered instances in
|
||||||
|
/// preparation for deallocation.
|
||||||
|
inline void clear_instance(PyObject *self) { |
||||||
|
auto *instance = reinterpret_cast<detail::instance *>(self); |
||||||
|
|
||||||
|
// Deallocate any values/holders, if present:
|
||||||
|
for (auto &v_h : values_and_holders(instance)) { |
||||||
|
if (v_h) { |
||||||
|
|
||||||
|
// We have to deregister before we call dealloc because, for virtual MI types, we still
|
||||||
|
// need to be able to get the parent pointers.
|
||||||
|
if (v_h.instance_registered() |
||||||
|
&& !deregister_instance(instance, v_h.value_ptr(), v_h.type)) { |
||||||
|
pybind11_fail( |
||||||
|
"pybind11_object_dealloc(): Tried to deallocate unregistered instance!"); |
||||||
|
} |
||||||
|
|
||||||
|
if (instance->owned || v_h.holder_constructed()) { |
||||||
|
v_h.type->dealloc(v_h); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
// Deallocate the value/holder layout internals:
|
||||||
|
instance->deallocate_layout(); |
||||||
|
|
||||||
|
if (instance->weakrefs) { |
||||||
|
PyObject_ClearWeakRefs(self); |
||||||
|
} |
||||||
|
|
||||||
|
PyObject **dict_ptr = _PyObject_GetDictPtr(self); |
||||||
|
if (dict_ptr) { |
||||||
|
Py_CLEAR(*dict_ptr); |
||||||
|
} |
||||||
|
|
||||||
|
if (instance->has_patients) { |
||||||
|
clear_patients(self); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
/// Instance destructor function for all pybind11 types. It calls `type_info.dealloc`
|
||||||
|
/// to destroy the C++ object itself, while the rest is Python bookkeeping.
|
||||||
|
extern "C" inline void pybind11_object_dealloc(PyObject *self) { |
||||||
|
auto *type = Py_TYPE(self); |
||||||
|
|
||||||
|
// If this is a GC tracked object, untrack it first
|
||||||
|
// Note that the track call is implicitly done by the
|
||||||
|
// default tp_alloc, which we never override.
|
||||||
|
if (PyType_HasFeature(type, Py_TPFLAGS_HAVE_GC) != 0) { |
||||||
|
PyObject_GC_UnTrack(self); |
||||||
|
} |
||||||
|
|
||||||
|
clear_instance(self); |
||||||
|
|
||||||
|
type->tp_free(self); |
||||||
|
|
||||||
|
#if PY_VERSION_HEX < 0x03080000 |
||||||
|
// `type->tp_dealloc != pybind11_object_dealloc` means that we're being called
|
||||||
|
// as part of a derived type's dealloc, in which case we're not allowed to decref
|
||||||
|
// the type here. For cross-module compatibility, we shouldn't compare directly
|
||||||
|
// with `pybind11_object_dealloc`, but with the common one stashed in internals.
|
||||||
|
auto pybind11_object_type = (PyTypeObject *) get_internals().instance_base; |
||||||
|
if (type->tp_dealloc == pybind11_object_type->tp_dealloc) |
||||||
|
Py_DECREF(type); |
||||||
|
#else |
||||||
|
// This was not needed before Python 3.8 (Python issue 35810)
|
||||||
|
// https://github.com/pybind/pybind11/issues/1946
|
||||||
|
Py_DECREF(type); |
||||||
|
#endif |
||||||
|
} |
||||||
|
|
||||||
|
std::string error_string(); |
||||||
|
|
||||||
|
/** Create the type which can be used as a common base for all classes. This is
|
||||||
|
needed in order to satisfy Python's requirements for multiple inheritance. |
||||||
|
Return value: New reference. */ |
||||||
|
inline PyObject *make_object_base_type(PyTypeObject *metaclass) { |
||||||
|
constexpr auto *name = "pybind11_object"; |
||||||
|
auto name_obj = reinterpret_steal<object>(PYBIND11_FROM_STRING(name)); |
||||||
|
|
||||||
|
/* Danger zone: from now (and until PyType_Ready), make sure to
|
||||||
|
issue no Python C API calls which could potentially invoke the |
||||||
|
garbage collector (the GC will call type_traverse(), which will in |
||||||
|
turn find the newly constructed type in an invalid state) */ |
||||||
|
auto *heap_type = (PyHeapTypeObject *) metaclass->tp_alloc(metaclass, 0); |
||||||
|
if (!heap_type) { |
||||||
|
pybind11_fail("make_object_base_type(): error allocating type!"); |
||||||
|
} |
||||||
|
|
||||||
|
heap_type->ht_name = name_obj.inc_ref().ptr(); |
||||||
|
#ifdef PYBIND11_BUILTIN_QUALNAME |
||||||
|
heap_type->ht_qualname = name_obj.inc_ref().ptr(); |
||||||
|
#endif |
||||||
|
|
||||||
|
auto *type = &heap_type->ht_type; |
||||||
|
type->tp_name = name; |
||||||
|
type->tp_base = type_incref(&PyBaseObject_Type); |
||||||
|
type->tp_basicsize = static_cast<ssize_t>(sizeof(instance)); |
||||||
|
type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE; |
||||||
|
|
||||||
|
type->tp_new = pybind11_object_new; |
||||||
|
type->tp_init = pybind11_object_init; |
||||||
|
type->tp_dealloc = pybind11_object_dealloc; |
||||||
|
|
||||||
|
/* Support weak references (needed for the keep_alive feature) */ |
||||||
|
type->tp_weaklistoffset = offsetof(instance, weakrefs); |
||||||
|
|
||||||
|
if (PyType_Ready(type) < 0) { |
||||||
|
pybind11_fail("PyType_Ready failed in make_object_base_type(): " + error_string()); |
||||||
|
} |
||||||
|
|
||||||
|
setattr((PyObject *) type, "__module__", str("pybind11_builtins")); |
||||||
|
PYBIND11_SET_OLDPY_QUALNAME(type, name_obj); |
||||||
|
|
||||||
|
assert(!PyType_HasFeature(type, Py_TPFLAGS_HAVE_GC)); |
||||||
|
return (PyObject *) heap_type; |
||||||
|
} |
||||||
|
|
||||||
|
/// dynamic_attr: Allow the garbage collector to traverse the internal instance `__dict__`.
|
||||||
|
extern "C" inline int pybind11_traverse(PyObject *self, visitproc visit, void *arg) { |
||||||
|
PyObject *&dict = *_PyObject_GetDictPtr(self); |
||||||
|
Py_VISIT(dict); |
||||||
|
// https://docs.python.org/3/c-api/typeobj.html#c.PyTypeObject.tp_traverse
|
||||||
|
#if PY_VERSION_HEX >= 0x03090000 |
||||||
|
Py_VISIT(Py_TYPE(self)); |
||||||
|
#endif |
||||||
|
return 0; |
||||||
|
} |
||||||
|
|
||||||
|
/// dynamic_attr: Allow the GC to clear the dictionary.
|
||||||
|
extern "C" inline int pybind11_clear(PyObject *self) { |
||||||
|
PyObject *&dict = *_PyObject_GetDictPtr(self); |
||||||
|
Py_CLEAR(dict); |
||||||
|
return 0; |
||||||
|
} |
||||||
|
|
||||||
|
/// Give instances of this type a `__dict__` and opt into garbage collection.
|
||||||
|
inline void enable_dynamic_attributes(PyHeapTypeObject *heap_type) { |
||||||
|
auto *type = &heap_type->ht_type; |
||||||
|
type->tp_flags |= Py_TPFLAGS_HAVE_GC; |
||||||
|
#if PY_VERSION_HEX < 0x030B0000 |
||||||
|
type->tp_dictoffset = type->tp_basicsize; // place dict at the end
|
||||||
|
type->tp_basicsize += (ssize_t) sizeof(PyObject *); // and allocate enough space for it
|
||||||
|
#else |
||||||
|
type->tp_flags |= Py_TPFLAGS_MANAGED_DICT; |
||||||
|
#endif |
||||||
|
type->tp_traverse = pybind11_traverse; |
||||||
|
type->tp_clear = pybind11_clear; |
||||||
|
|
||||||
|
static PyGetSetDef getset[] = {{ |
||||||
|
#if PY_VERSION_HEX < 0x03070000 |
||||||
|
const_cast<char *>("__dict__"), |
||||||
|
#else |
||||||
|
"__dict__", |
||||||
|
#endif |
||||||
|
PyObject_GenericGetDict, |
||||||
|
PyObject_GenericSetDict, |
||||||
|
nullptr, |
||||||
|
nullptr}, |
||||||
|
{nullptr, nullptr, nullptr, nullptr, nullptr}}; |
||||||
|
type->tp_getset = getset; |
||||||
|
} |
||||||
|
|
||||||
|
/// buffer_protocol: Fill in the view as specified by flags.
|
||||||
|
extern "C" inline int pybind11_getbuffer(PyObject *obj, Py_buffer *view, int flags) { |
||||||
|
// Look for a `get_buffer` implementation in this type's info or any bases (following MRO).
|
||||||
|
type_info *tinfo = nullptr; |
||||||
|
for (auto type : reinterpret_borrow<tuple>(Py_TYPE(obj)->tp_mro)) { |
||||||
|
tinfo = get_type_info((PyTypeObject *) type.ptr()); |
||||||
|
if (tinfo && tinfo->get_buffer) { |
||||||
|
break; |
||||||
|
} |
||||||
|
} |
||||||
|
if (view == nullptr || !tinfo || !tinfo->get_buffer) { |
||||||
|
if (view) { |
||||||
|
view->obj = nullptr; |
||||||
|
} |
||||||
|
PyErr_SetString(PyExc_BufferError, "pybind11_getbuffer(): Internal error"); |
||||||
|
return -1; |
||||||
|
} |
||||||
|
std::memset(view, 0, sizeof(Py_buffer)); |
||||||
|
buffer_info *info = tinfo->get_buffer(obj, tinfo->get_buffer_data); |
||||||
|
if ((flags & PyBUF_WRITABLE) == PyBUF_WRITABLE && info->readonly) { |
||||||
|
delete info; |
||||||
|
// view->obj = nullptr; // Was just memset to 0, so not necessary
|
||||||
|
PyErr_SetString(PyExc_BufferError, "Writable buffer requested for readonly storage"); |
||||||
|
return -1; |
||||||
|
} |
||||||
|
view->obj = obj; |
||||||
|
view->ndim = 1; |
||||||
|
view->internal = info; |
||||||
|
view->buf = info->ptr; |
||||||
|
view->itemsize = info->itemsize; |
||||||
|
view->len = view->itemsize; |
||||||
|
for (auto s : info->shape) { |
||||||
|
view->len *= s; |
||||||
|
} |
||||||
|
view->readonly = static_cast<int>(info->readonly); |
||||||
|
if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT) { |
||||||
|
view->format = const_cast<char *>(info->format.c_str()); |
||||||
|
} |
||||||
|
if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES) { |
||||||
|
view->ndim = (int) info->ndim; |
||||||
|
view->strides = info->strides.data(); |
||||||
|
view->shape = info->shape.data(); |
||||||
|
} |
||||||
|
Py_INCREF(view->obj); |
||||||
|
return 0; |
||||||
|
} |
||||||
|
|
||||||
|
/// buffer_protocol: Release the resources of the buffer.
|
||||||
|
extern "C" inline void pybind11_releasebuffer(PyObject *, Py_buffer *view) { |
||||||
|
delete (buffer_info *) view->internal; |
||||||
|
} |
||||||
|
|
||||||
|
/// Give this type a buffer interface.
|
||||||
|
inline void enable_buffer_protocol(PyHeapTypeObject *heap_type) { |
||||||
|
heap_type->ht_type.tp_as_buffer = &heap_type->as_buffer; |
||||||
|
|
||||||
|
heap_type->as_buffer.bf_getbuffer = pybind11_getbuffer; |
||||||
|
heap_type->as_buffer.bf_releasebuffer = pybind11_releasebuffer; |
||||||
|
} |
||||||
|
|
||||||
|
/** Create a brand new Python type according to the `type_record` specification.
|
||||||
|
Return value: New reference. */ |
||||||
|
inline PyObject *make_new_python_type(const type_record &rec) { |
||||||
|
auto name = reinterpret_steal<object>(PYBIND11_FROM_STRING(rec.name)); |
||||||
|
|
||||||
|
auto qualname = name; |
||||||
|
if (rec.scope && !PyModule_Check(rec.scope.ptr()) && hasattr(rec.scope, "__qualname__")) { |
||||||
|
qualname = reinterpret_steal<object>( |
||||||
|
PyUnicode_FromFormat("%U.%U", rec.scope.attr("__qualname__").ptr(), name.ptr())); |
||||||
|
} |
||||||
|
|
||||||
|
object module_; |
||||||
|
if (rec.scope) { |
||||||
|
if (hasattr(rec.scope, "__module__")) { |
||||||
|
module_ = rec.scope.attr("__module__"); |
||||||
|
} else if (hasattr(rec.scope, "__name__")) { |
||||||
|
module_ = rec.scope.attr("__name__"); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
const auto *full_name = c_str( |
||||||
|
#if !defined(PYPY_VERSION) |
||||||
|
module_ ? str(module_).cast<std::string>() + "." + rec.name : |
||||||
|
#endif |
||||||
|
rec.name); |
||||||
|
|
||||||
|
char *tp_doc = nullptr; |
||||||
|
if (rec.doc && options::show_user_defined_docstrings()) { |
||||||
|
/* Allocate memory for docstring (using PyObject_MALLOC, since
|
||||||
|
Python will free this later on) */ |
||||||
|
size_t size = std::strlen(rec.doc) + 1; |
||||||
|
tp_doc = (char *) PyObject_MALLOC(size); |
||||||
|
std::memcpy((void *) tp_doc, rec.doc, size); |
||||||
|
} |
||||||
|
|
||||||
|
auto &internals = get_internals(); |
||||||
|
auto bases = tuple(rec.bases); |
||||||
|
auto *base = (bases.empty()) ? internals.instance_base : bases[0].ptr(); |
||||||
|
|
||||||
|
/* Danger zone: from now (and until PyType_Ready), make sure to
|
||||||
|
issue no Python C API calls which could potentially invoke the |
||||||
|
garbage collector (the GC will call type_traverse(), which will in |
||||||
|
turn find the newly constructed type in an invalid state) */ |
||||||
|
auto *metaclass |
||||||
|
= rec.metaclass.ptr() ? (PyTypeObject *) rec.metaclass.ptr() : internals.default_metaclass; |
||||||
|
|
||||||
|
auto *heap_type = (PyHeapTypeObject *) metaclass->tp_alloc(metaclass, 0); |
||||||
|
if (!heap_type) { |
||||||
|
pybind11_fail(std::string(rec.name) + ": Unable to create type object!"); |
||||||
|
} |
||||||
|
|
||||||
|
heap_type->ht_name = name.release().ptr(); |
||||||
|
#ifdef PYBIND11_BUILTIN_QUALNAME |
||||||
|
heap_type->ht_qualname = qualname.inc_ref().ptr(); |
||||||
|
#endif |
||||||
|
|
||||||
|
auto *type = &heap_type->ht_type; |
||||||
|
type->tp_name = full_name; |
||||||
|
type->tp_doc = tp_doc; |
||||||
|
type->tp_base = type_incref((PyTypeObject *) base); |
||||||
|
type->tp_basicsize = static_cast<ssize_t>(sizeof(instance)); |
||||||
|
if (!bases.empty()) { |
||||||
|
type->tp_bases = bases.release().ptr(); |
||||||
|
} |
||||||
|
|
||||||
|
/* Don't inherit base __init__ */ |
||||||
|
type->tp_init = pybind11_object_init; |
||||||
|
|
||||||
|
/* Supported protocols */ |
||||||
|
type->tp_as_number = &heap_type->as_number; |
||||||
|
type->tp_as_sequence = &heap_type->as_sequence; |
||||||
|
type->tp_as_mapping = &heap_type->as_mapping; |
||||||
|
type->tp_as_async = &heap_type->as_async; |
||||||
|
|
||||||
|
/* Flags */ |
||||||
|
type->tp_flags |= Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HEAPTYPE; |
||||||
|
if (!rec.is_final) { |
||||||
|
type->tp_flags |= Py_TPFLAGS_BASETYPE; |
||||||
|
} |
||||||
|
|
||||||
|
if (rec.dynamic_attr) { |
||||||
|
enable_dynamic_attributes(heap_type); |
||||||
|
} |
||||||
|
|
||||||
|
if (rec.buffer_protocol) { |
||||||
|
enable_buffer_protocol(heap_type); |
||||||
|
} |
||||||
|
|
||||||
|
if (rec.custom_type_setup_callback) { |
||||||
|
rec.custom_type_setup_callback(heap_type); |
||||||
|
} |
||||||
|
|
||||||
|
if (PyType_Ready(type) < 0) { |
||||||
|
pybind11_fail(std::string(rec.name) + ": PyType_Ready failed: " + error_string()); |
||||||
|
} |
||||||
|
|
||||||
|
assert(!rec.dynamic_attr || PyType_HasFeature(type, Py_TPFLAGS_HAVE_GC)); |
||||||
|
|
||||||
|
/* Register type with the parent scope */ |
||||||
|
if (rec.scope) { |
||||||
|
setattr(rec.scope, rec.name, (PyObject *) type); |
||||||
|
} else { |
||||||
|
Py_INCREF(type); // Keep it alive forever (reference leak)
|
||||||
|
} |
||||||
|
|
||||||
|
if (module_) { // Needed by pydoc
|
||||||
|
setattr((PyObject *) type, "__module__", module_); |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_SET_OLDPY_QUALNAME(type, qualname); |
||||||
|
|
||||||
|
return (PyObject *) type; |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,158 @@ |
|||||||
|
/*
|
||||||
|
pybind11/detail/descr.h: Helper type for concatenating type signatures at compile time |
||||||
|
|
||||||
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> |
||||||
|
|
||||||
|
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 "common.h" |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
#if !defined(_MSC_VER) |
||||||
|
# define PYBIND11_DESCR_CONSTEXPR static constexpr |
||||||
|
#else |
||||||
|
# define PYBIND11_DESCR_CONSTEXPR const |
||||||
|
#endif |
||||||
|
|
||||||
|
/* Concatenate type signatures at compile time */ |
||||||
|
template <size_t N, typename... Ts> |
||||||
|
struct descr { |
||||||
|
char text[N + 1]{'\0'}; |
||||||
|
|
||||||
|
constexpr descr() = default; |
||||||
|
// NOLINTNEXTLINE(google-explicit-constructor)
|
||||||
|
constexpr descr(char const (&s)[N + 1]) : descr(s, make_index_sequence<N>()) {} |
||||||
|
|
||||||
|
template <size_t... Is> |
||||||
|
constexpr descr(char const (&s)[N + 1], index_sequence<Is...>) : text{s[Is]..., '\0'} {} |
||||||
|
|
||||||
|
template <typename... Chars> |
||||||
|
// NOLINTNEXTLINE(google-explicit-constructor)
|
||||||
|
constexpr descr(char c, Chars... cs) : text{c, static_cast<char>(cs)..., '\0'} {} |
||||||
|
|
||||||
|
static constexpr std::array<const std::type_info *, sizeof...(Ts) + 1> types() { |
||||||
|
return {{&typeid(Ts)..., nullptr}}; |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
template <size_t N1, size_t N2, typename... Ts1, typename... Ts2, size_t... Is1, size_t... Is2> |
||||||
|
constexpr descr<N1 + N2, Ts1..., Ts2...> plus_impl(const descr<N1, Ts1...> &a, |
||||||
|
const descr<N2, Ts2...> &b, |
||||||
|
index_sequence<Is1...>, |
||||||
|
index_sequence<Is2...>) { |
||||||
|
PYBIND11_WORKAROUND_INCORRECT_MSVC_C4100(b); |
||||||
|
return {a.text[Is1]..., b.text[Is2]...}; |
||||||
|
} |
||||||
|
|
||||||
|
template <size_t N1, size_t N2, typename... Ts1, typename... Ts2> |
||||||
|
constexpr descr<N1 + N2, Ts1..., Ts2...> operator+(const descr<N1, Ts1...> &a, |
||||||
|
const descr<N2, Ts2...> &b) { |
||||||
|
return plus_impl(a, b, make_index_sequence<N1>(), make_index_sequence<N2>()); |
||||||
|
} |
||||||
|
|
||||||
|
template <size_t N> |
||||||
|
constexpr descr<N - 1> const_name(char const (&text)[N]) { |
||||||
|
return descr<N - 1>(text); |
||||||
|
} |
||||||
|
constexpr descr<0> const_name(char const (&)[1]) { return {}; } |
||||||
|
|
||||||
|
template <size_t Rem, size_t... Digits> |
||||||
|
struct int_to_str : int_to_str<Rem / 10, Rem % 10, Digits...> {}; |
||||||
|
template <size_t... Digits> |
||||||
|
struct int_to_str<0, Digits...> { |
||||||
|
// WARNING: This only works with C++17 or higher.
|
||||||
|
static constexpr auto digits = descr<sizeof...(Digits)>(('0' + Digits)...); |
||||||
|
}; |
||||||
|
|
||||||
|
// Ternary description (like std::conditional)
|
||||||
|
template <bool B, size_t N1, size_t N2> |
||||||
|
constexpr enable_if_t<B, descr<N1 - 1>> const_name(char const (&text1)[N1], char const (&)[N2]) { |
||||||
|
return const_name(text1); |
||||||
|
} |
||||||
|
template <bool B, size_t N1, size_t N2> |
||||||
|
constexpr enable_if_t<!B, descr<N2 - 1>> const_name(char const (&)[N1], char const (&text2)[N2]) { |
||||||
|
return const_name(text2); |
||||||
|
} |
||||||
|
|
||||||
|
template <bool B, typename T1, typename T2> |
||||||
|
constexpr enable_if_t<B, T1> const_name(const T1 &d, const T2 &) { |
||||||
|
return d; |
||||||
|
} |
||||||
|
template <bool B, typename T1, typename T2> |
||||||
|
constexpr enable_if_t<!B, T2> const_name(const T1 &, const T2 &d) { |
||||||
|
return d; |
||||||
|
} |
||||||
|
|
||||||
|
template <size_t Size> |
||||||
|
auto constexpr const_name() -> remove_cv_t<decltype(int_to_str<Size / 10, Size % 10>::digits)> { |
||||||
|
return int_to_str<Size / 10, Size % 10>::digits; |
||||||
|
} |
||||||
|
|
||||||
|
template <typename Type> |
||||||
|
constexpr descr<1, Type> const_name() { |
||||||
|
return {'%'}; |
||||||
|
} |
||||||
|
|
||||||
|
// If "_" is defined as a macro, py::detail::_ cannot be provided.
|
||||||
|
// It is therefore best to use py::detail::const_name universally.
|
||||||
|
// This block is for backward compatibility only.
|
||||||
|
// (The const_name code is repeated to avoid introducing a "_" #define ourselves.)
|
||||||
|
#ifndef _ |
||||||
|
# define PYBIND11_DETAIL_UNDERSCORE_BACKWARD_COMPATIBILITY |
||||||
|
template <size_t N> |
||||||
|
constexpr descr<N - 1> _(char const (&text)[N]) { |
||||||
|
return const_name<N>(text); |
||||||
|
} |
||||||
|
template <bool B, size_t N1, size_t N2> |
||||||
|
constexpr enable_if_t<B, descr<N1 - 1>> _(char const (&text1)[N1], char const (&text2)[N2]) { |
||||||
|
return const_name<B, N1, N2>(text1, text2); |
||||||
|
} |
||||||
|
template <bool B, size_t N1, size_t N2> |
||||||
|
constexpr enable_if_t<!B, descr<N2 - 1>> _(char const (&text1)[N1], char const (&text2)[N2]) { |
||||||
|
return const_name<B, N1, N2>(text1, text2); |
||||||
|
} |
||||||
|
template <bool B, typename T1, typename T2> |
||||||
|
constexpr enable_if_t<B, T1> _(const T1 &d1, const T2 &d2) { |
||||||
|
return const_name<B, T1, T2>(d1, d2); |
||||||
|
} |
||||||
|
template <bool B, typename T1, typename T2> |
||||||
|
constexpr enable_if_t<!B, T2> _(const T1 &d1, const T2 &d2) { |
||||||
|
return const_name<B, T1, T2>(d1, d2); |
||||||
|
} |
||||||
|
|
||||||
|
template <size_t Size> |
||||||
|
auto constexpr _() -> remove_cv_t<decltype(int_to_str<Size / 10, Size % 10>::digits)> { |
||||||
|
return const_name<Size>(); |
||||||
|
} |
||||||
|
template <typename Type> |
||||||
|
constexpr descr<1, Type> _() { |
||||||
|
return const_name<Type>(); |
||||||
|
} |
||||||
|
#endif // #ifndef _
|
||||||
|
|
||||||
|
constexpr descr<0> concat() { return {}; } |
||||||
|
|
||||||
|
template <size_t N, typename... Ts> |
||||||
|
constexpr descr<N, Ts...> concat(const descr<N, Ts...> &descr) { |
||||||
|
return descr; |
||||||
|
} |
||||||
|
|
||||||
|
template <size_t N, typename... Ts, typename... Args> |
||||||
|
constexpr auto concat(const descr<N, Ts...> &d, const Args &...args) |
||||||
|
-> decltype(std::declval<descr<N + 2, Ts...>>() + concat(args...)) { |
||||||
|
return d + const_name(", ") + concat(args...); |
||||||
|
} |
||||||
|
|
||||||
|
template <size_t N, typename... Ts> |
||||||
|
constexpr descr<N + 2, Ts...> type_descr(const descr<N, Ts...> &descr) { |
||||||
|
return const_name("{") + descr + const_name("}"); |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
@ -0,0 +1,434 @@ |
|||||||
|
/*
|
||||||
|
pybind11/detail/init.h: init factory function implementation and support code. |
||||||
|
|
||||||
|
Copyright (c) 2017 Jason Rhinelander <jason@imaginary.ca> |
||||||
|
|
||||||
|
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 "class.h" |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
|
||||||
|
PYBIND11_WARNING_DISABLE_MSVC(4127) |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
template <> |
||||||
|
class type_caster<value_and_holder> { |
||||||
|
public: |
||||||
|
bool load(handle h, bool) { |
||||||
|
value = reinterpret_cast<value_and_holder *>(h.ptr()); |
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
template <typename> |
||||||
|
using cast_op_type = value_and_holder &; |
||||||
|
explicit operator value_and_holder &() { return *value; } |
||||||
|
static constexpr auto name = const_name<value_and_holder>(); |
||||||
|
|
||||||
|
private: |
||||||
|
value_and_holder *value = nullptr; |
||||||
|
}; |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(initimpl) |
||||||
|
|
||||||
|
inline void no_nullptr(void *ptr) { |
||||||
|
if (!ptr) { |
||||||
|
throw type_error("pybind11::init(): factory function returned nullptr"); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// Implementing functions for all forms of py::init<...> and py::init(...)
|
||||||
|
template <typename Class> |
||||||
|
using Cpp = typename Class::type; |
||||||
|
template <typename Class> |
||||||
|
using Alias = typename Class::type_alias; |
||||||
|
template <typename Class> |
||||||
|
using Holder = typename Class::holder_type; |
||||||
|
|
||||||
|
template <typename Class> |
||||||
|
using is_alias_constructible = std::is_constructible<Alias<Class>, Cpp<Class> &&>; |
||||||
|
|
||||||
|
// Takes a Cpp pointer and returns true if it actually is a polymorphic Alias instance.
|
||||||
|
template <typename Class, enable_if_t<Class::has_alias, int> = 0> |
||||||
|
bool is_alias(Cpp<Class> *ptr) { |
||||||
|
return dynamic_cast<Alias<Class> *>(ptr) != nullptr; |
||||||
|
} |
||||||
|
// Failing fallback version of the above for a no-alias class (always returns false)
|
||||||
|
template <typename /*Class*/> |
||||||
|
constexpr bool is_alias(void *) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
// Constructs and returns a new object; if the given arguments don't map to a constructor, we fall
|
||||||
|
// back to brace aggregate initiailization so that for aggregate initialization can be used with
|
||||||
|
// py::init, e.g. `py::init<int, int>` to initialize a `struct T { int a; int b; }`. For
|
||||||
|
// non-aggregate types, we need to use an ordinary T(...) constructor (invoking as `T{...}` usually
|
||||||
|
// works, but will not do the expected thing when `T` has an `initializer_list<T>` constructor).
|
||||||
|
template <typename Class, |
||||||
|
typename... Args, |
||||||
|
detail::enable_if_t<std::is_constructible<Class, Args...>::value, int> = 0> |
||||||
|
inline Class *construct_or_initialize(Args &&...args) { |
||||||
|
return new Class(std::forward<Args>(args)...); |
||||||
|
} |
||||||
|
template <typename Class, |
||||||
|
typename... Args, |
||||||
|
detail::enable_if_t<!std::is_constructible<Class, Args...>::value, int> = 0> |
||||||
|
inline Class *construct_or_initialize(Args &&...args) { |
||||||
|
return new Class{std::forward<Args>(args)...}; |
||||||
|
} |
||||||
|
|
||||||
|
// Attempts to constructs an alias using a `Alias(Cpp &&)` constructor. This allows types with
|
||||||
|
// an alias to provide only a single Cpp factory function as long as the Alias can be
|
||||||
|
// constructed from an rvalue reference of the base Cpp type. This means that Alias classes
|
||||||
|
// can, when appropriate, simply define a `Alias(Cpp &&)` constructor rather than needing to
|
||||||
|
// inherit all the base class constructors.
|
||||||
|
template <typename Class> |
||||||
|
void construct_alias_from_cpp(std::true_type /*is_alias_constructible*/, |
||||||
|
value_and_holder &v_h, |
||||||
|
Cpp<Class> &&base) { |
||||||
|
v_h.value_ptr() = new Alias<Class>(std::move(base)); |
||||||
|
} |
||||||
|
template <typename Class> |
||||||
|
[[noreturn]] void construct_alias_from_cpp(std::false_type /*!is_alias_constructible*/, |
||||||
|
value_and_holder &, |
||||||
|
Cpp<Class> &&) { |
||||||
|
throw type_error("pybind11::init(): unable to convert returned instance to required " |
||||||
|
"alias class: no `Alias<Class>(Class &&)` constructor available"); |
||||||
|
} |
||||||
|
|
||||||
|
// Error-generating fallback for factories that don't match one of the below construction
|
||||||
|
// mechanisms.
|
||||||
|
template <typename Class> |
||||||
|
void construct(...) { |
||||||
|
static_assert(!std::is_same<Class, Class>::value /* always false */, |
||||||
|
"pybind11::init(): init function must return a compatible pointer, " |
||||||
|
"holder, or value"); |
||||||
|
} |
||||||
|
|
||||||
|
// Pointer return v1: the factory function returns a class pointer for a registered class.
|
||||||
|
// If we don't need an alias (because this class doesn't have one, or because the final type is
|
||||||
|
// inherited on the Python side) we can simply take over ownership. Otherwise we need to try to
|
||||||
|
// construct an Alias from the returned base instance.
|
||||||
|
template <typename Class> |
||||||
|
void construct(value_and_holder &v_h, Cpp<Class> *ptr, bool need_alias) { |
||||||
|
PYBIND11_WORKAROUND_INCORRECT_MSVC_C4100(need_alias); |
||||||
|
no_nullptr(ptr); |
||||||
|
if (Class::has_alias && need_alias && !is_alias<Class>(ptr)) { |
||||||
|
// We're going to try to construct an alias by moving the cpp type. Whether or not
|
||||||
|
// that succeeds, we still need to destroy the original cpp pointer (either the
|
||||||
|
// moved away leftover, if the alias construction works, or the value itself if we
|
||||||
|
// throw an error), but we can't just call `delete ptr`: it might have a special
|
||||||
|
// deleter, or might be shared_from_this. So we construct a holder around it as if
|
||||||
|
// it was a normal instance, then steal the holder away into a local variable; thus
|
||||||
|
// the holder and destruction happens when we leave the C++ scope, and the holder
|
||||||
|
// class gets to handle the destruction however it likes.
|
||||||
|
v_h.value_ptr() = ptr; |
||||||
|
v_h.set_instance_registered(true); // To prevent init_instance from registering it
|
||||||
|
v_h.type->init_instance(v_h.inst, nullptr); // Set up the holder
|
||||||
|
Holder<Class> temp_holder(std::move(v_h.holder<Holder<Class>>())); // Steal the holder
|
||||||
|
v_h.type->dealloc(v_h); // Destroys the moved-out holder remains, resets value ptr to null
|
||||||
|
v_h.set_instance_registered(false); |
||||||
|
|
||||||
|
construct_alias_from_cpp<Class>(is_alias_constructible<Class>{}, v_h, std::move(*ptr)); |
||||||
|
} else { |
||||||
|
// Otherwise the type isn't inherited, so we don't need an Alias
|
||||||
|
v_h.value_ptr() = ptr; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// Pointer return v2: a factory that always returns an alias instance ptr. We simply take over
|
||||||
|
// ownership of the pointer.
|
||||||
|
template <typename Class, enable_if_t<Class::has_alias, int> = 0> |
||||||
|
void construct(value_and_holder &v_h, Alias<Class> *alias_ptr, bool) { |
||||||
|
no_nullptr(alias_ptr); |
||||||
|
v_h.value_ptr() = static_cast<Cpp<Class> *>(alias_ptr); |
||||||
|
} |
||||||
|
|
||||||
|
// Holder return: copy its pointer, and move or copy the returned holder into the new instance's
|
||||||
|
// holder. This also handles types like std::shared_ptr<T> and std::unique_ptr<T> where T is a
|
||||||
|
// derived type (through those holder's implicit conversion from derived class holder
|
||||||
|
// constructors).
|
||||||
|
template <typename Class> |
||||||
|
void construct(value_and_holder &v_h, Holder<Class> holder, bool need_alias) { |
||||||
|
PYBIND11_WORKAROUND_INCORRECT_MSVC_C4100(need_alias); |
||||||
|
auto *ptr = holder_helper<Holder<Class>>::get(holder); |
||||||
|
no_nullptr(ptr); |
||||||
|
// If we need an alias, check that the held pointer is actually an alias instance
|
||||||
|
if (Class::has_alias && need_alias && !is_alias<Class>(ptr)) { |
||||||
|
throw type_error("pybind11::init(): construction failed: returned holder-wrapped instance " |
||||||
|
"is not an alias instance"); |
||||||
|
} |
||||||
|
|
||||||
|
v_h.value_ptr() = ptr; |
||||||
|
v_h.type->init_instance(v_h.inst, &holder); |
||||||
|
} |
||||||
|
|
||||||
|
// return-by-value version 1: returning a cpp class by value. If the class has an alias and an
|
||||||
|
// alias is required the alias must have an `Alias(Cpp &&)` constructor so that we can construct
|
||||||
|
// the alias from the base when needed (i.e. because of Python-side inheritance). When we don't
|
||||||
|
// need it, we simply move-construct the cpp value into a new instance.
|
||||||
|
template <typename Class> |
||||||
|
void construct(value_and_holder &v_h, Cpp<Class> &&result, bool need_alias) { |
||||||
|
PYBIND11_WORKAROUND_INCORRECT_MSVC_C4100(need_alias); |
||||||
|
static_assert(std::is_move_constructible<Cpp<Class>>::value, |
||||||
|
"pybind11::init() return-by-value factory function requires a movable class"); |
||||||
|
if (Class::has_alias && need_alias) { |
||||||
|
construct_alias_from_cpp<Class>(is_alias_constructible<Class>{}, v_h, std::move(result)); |
||||||
|
} else { |
||||||
|
v_h.value_ptr() = new Cpp<Class>(std::move(result)); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// return-by-value version 2: returning a value of the alias type itself. We move-construct an
|
||||||
|
// Alias instance (even if no the python-side inheritance is involved). The is intended for
|
||||||
|
// cases where Alias initialization is always desired.
|
||||||
|
template <typename Class> |
||||||
|
void construct(value_and_holder &v_h, Alias<Class> &&result, bool) { |
||||||
|
static_assert( |
||||||
|
std::is_move_constructible<Alias<Class>>::value, |
||||||
|
"pybind11::init() return-by-alias-value factory function requires a movable alias class"); |
||||||
|
v_h.value_ptr() = new Alias<Class>(std::move(result)); |
||||||
|
} |
||||||
|
|
||||||
|
// Implementing class for py::init<...>()
|
||||||
|
template <typename... Args> |
||||||
|
struct constructor { |
||||||
|
template <typename Class, typename... Extra, enable_if_t<!Class::has_alias, int> = 0> |
||||||
|
static void execute(Class &cl, const Extra &...extra) { |
||||||
|
cl.def( |
||||||
|
"__init__", |
||||||
|
[](value_and_holder &v_h, Args... args) { |
||||||
|
v_h.value_ptr() = construct_or_initialize<Cpp<Class>>(std::forward<Args>(args)...); |
||||||
|
}, |
||||||
|
is_new_style_constructor(), |
||||||
|
extra...); |
||||||
|
} |
||||||
|
|
||||||
|
template < |
||||||
|
typename Class, |
||||||
|
typename... Extra, |
||||||
|
enable_if_t<Class::has_alias && std::is_constructible<Cpp<Class>, Args...>::value, int> |
||||||
|
= 0> |
||||||
|
static void execute(Class &cl, const Extra &...extra) { |
||||||
|
cl.def( |
||||||
|
"__init__", |
||||||
|
[](value_and_holder &v_h, Args... args) { |
||||||
|
if (Py_TYPE(v_h.inst) == v_h.type->type) { |
||||||
|
v_h.value_ptr() |
||||||
|
= construct_or_initialize<Cpp<Class>>(std::forward<Args>(args)...); |
||||||
|
} else { |
||||||
|
v_h.value_ptr() |
||||||
|
= construct_or_initialize<Alias<Class>>(std::forward<Args>(args)...); |
||||||
|
} |
||||||
|
}, |
||||||
|
is_new_style_constructor(), |
||||||
|
extra...); |
||||||
|
} |
||||||
|
|
||||||
|
template < |
||||||
|
typename Class, |
||||||
|
typename... Extra, |
||||||
|
enable_if_t<Class::has_alias && !std::is_constructible<Cpp<Class>, Args...>::value, int> |
||||||
|
= 0> |
||||||
|
static void execute(Class &cl, const Extra &...extra) { |
||||||
|
cl.def( |
||||||
|
"__init__", |
||||||
|
[](value_and_holder &v_h, Args... args) { |
||||||
|
v_h.value_ptr() |
||||||
|
= construct_or_initialize<Alias<Class>>(std::forward<Args>(args)...); |
||||||
|
}, |
||||||
|
is_new_style_constructor(), |
||||||
|
extra...); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
// Implementing class for py::init_alias<...>()
|
||||||
|
template <typename... Args> |
||||||
|
struct alias_constructor { |
||||||
|
template < |
||||||
|
typename Class, |
||||||
|
typename... Extra, |
||||||
|
enable_if_t<Class::has_alias && std::is_constructible<Alias<Class>, Args...>::value, int> |
||||||
|
= 0> |
||||||
|
static void execute(Class &cl, const Extra &...extra) { |
||||||
|
cl.def( |
||||||
|
"__init__", |
||||||
|
[](value_and_holder &v_h, Args... args) { |
||||||
|
v_h.value_ptr() |
||||||
|
= construct_or_initialize<Alias<Class>>(std::forward<Args>(args)...); |
||||||
|
}, |
||||||
|
is_new_style_constructor(), |
||||||
|
extra...); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
// Implementation class for py::init(Func) and py::init(Func, AliasFunc)
|
||||||
|
template <typename CFunc, |
||||||
|
typename AFunc = void_type (*)(), |
||||||
|
typename = function_signature_t<CFunc>, |
||||||
|
typename = function_signature_t<AFunc>> |
||||||
|
struct factory; |
||||||
|
|
||||||
|
// Specialization for py::init(Func)
|
||||||
|
template <typename Func, typename Return, typename... Args> |
||||||
|
struct factory<Func, void_type (*)(), Return(Args...)> { |
||||||
|
remove_reference_t<Func> class_factory; |
||||||
|
|
||||||
|
// NOLINTNEXTLINE(google-explicit-constructor)
|
||||||
|
factory(Func &&f) : class_factory(std::forward<Func>(f)) {} |
||||||
|
|
||||||
|
// The given class either has no alias or has no separate alias factory;
|
||||||
|
// this always constructs the class itself. If the class is registered with an alias
|
||||||
|
// type and an alias instance is needed (i.e. because the final type is a Python class
|
||||||
|
// inheriting from the C++ type) the returned value needs to either already be an alias
|
||||||
|
// instance, or the alias needs to be constructible from a `Class &&` argument.
|
||||||
|
template <typename Class, typename... Extra> |
||||||
|
void execute(Class &cl, const Extra &...extra) && { |
||||||
|
#if defined(PYBIND11_CPP14) |
||||||
|
cl.def( |
||||||
|
"__init__", |
||||||
|
[func = std::move(class_factory)] |
||||||
|
#else |
||||||
|
auto &func = class_factory; |
||||||
|
cl.def( |
||||||
|
"__init__", |
||||||
|
[func] |
||||||
|
#endif |
||||||
|
(value_and_holder &v_h, Args... args) { |
||||||
|
construct<Class>( |
||||||
|
v_h, func(std::forward<Args>(args)...), Py_TYPE(v_h.inst) != v_h.type->type); |
||||||
|
}, |
||||||
|
is_new_style_constructor(), |
||||||
|
extra...); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
// Specialization for py::init(Func, AliasFunc)
|
||||||
|
template <typename CFunc, |
||||||
|
typename AFunc, |
||||||
|
typename CReturn, |
||||||
|
typename... CArgs, |
||||||
|
typename AReturn, |
||||||
|
typename... AArgs> |
||||||
|
struct factory<CFunc, AFunc, CReturn(CArgs...), AReturn(AArgs...)> { |
||||||
|
static_assert(sizeof...(CArgs) == sizeof...(AArgs), |
||||||
|
"pybind11::init(class_factory, alias_factory): class and alias factories " |
||||||
|
"must have identical argument signatures"); |
||||||
|
static_assert(all_of<std::is_same<CArgs, AArgs>...>::value, |
||||||
|
"pybind11::init(class_factory, alias_factory): class and alias factories " |
||||||
|
"must have identical argument signatures"); |
||||||
|
|
||||||
|
remove_reference_t<CFunc> class_factory; |
||||||
|
remove_reference_t<AFunc> alias_factory; |
||||||
|
|
||||||
|
factory(CFunc &&c, AFunc &&a) |
||||||
|
: class_factory(std::forward<CFunc>(c)), alias_factory(std::forward<AFunc>(a)) {} |
||||||
|
|
||||||
|
// The class factory is called when the `self` type passed to `__init__` is the direct
|
||||||
|
// class (i.e. not inherited), the alias factory when `self` is a Python-side subtype.
|
||||||
|
template <typename Class, typename... Extra> |
||||||
|
void execute(Class &cl, const Extra &...extra) && { |
||||||
|
static_assert(Class::has_alias, |
||||||
|
"The two-argument version of `py::init()` can " |
||||||
|
"only be used if the class has an alias"); |
||||||
|
#if defined(PYBIND11_CPP14) |
||||||
|
cl.def( |
||||||
|
"__init__", |
||||||
|
[class_func = std::move(class_factory), alias_func = std::move(alias_factory)] |
||||||
|
#else |
||||||
|
auto &class_func = class_factory; |
||||||
|
auto &alias_func = alias_factory; |
||||||
|
cl.def( |
||||||
|
"__init__", |
||||||
|
[class_func, alias_func] |
||||||
|
#endif |
||||||
|
(value_and_holder &v_h, CArgs... args) { |
||||||
|
if (Py_TYPE(v_h.inst) == v_h.type->type) { |
||||||
|
// If the instance type equals the registered type we don't have inheritance,
|
||||||
|
// so don't need the alias and can construct using the class function:
|
||||||
|
construct<Class>(v_h, class_func(std::forward<CArgs>(args)...), false); |
||||||
|
} else { |
||||||
|
construct<Class>(v_h, alias_func(std::forward<CArgs>(args)...), true); |
||||||
|
} |
||||||
|
}, |
||||||
|
is_new_style_constructor(), |
||||||
|
extra...); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
/// Set just the C++ state. Same as `__init__`.
|
||||||
|
template <typename Class, typename T> |
||||||
|
void setstate(value_and_holder &v_h, T &&result, bool need_alias) { |
||||||
|
construct<Class>(v_h, std::forward<T>(result), need_alias); |
||||||
|
} |
||||||
|
|
||||||
|
/// Set both the C++ and Python states
|
||||||
|
template <typename Class, |
||||||
|
typename T, |
||||||
|
typename O, |
||||||
|
enable_if_t<std::is_convertible<O, handle>::value, int> = 0> |
||||||
|
void setstate(value_and_holder &v_h, std::pair<T, O> &&result, bool need_alias) { |
||||||
|
construct<Class>(v_h, std::move(result.first), need_alias); |
||||||
|
auto d = handle(result.second); |
||||||
|
if (PyDict_Check(d.ptr()) && PyDict_Size(d.ptr()) == 0) { |
||||||
|
// Skipping setattr below, to not force use of py::dynamic_attr() for Class unnecessarily.
|
||||||
|
// See PR #2972 for details.
|
||||||
|
return; |
||||||
|
} |
||||||
|
setattr((PyObject *) v_h.inst, "__dict__", d); |
||||||
|
} |
||||||
|
|
||||||
|
/// Implementation for py::pickle(GetState, SetState)
|
||||||
|
template <typename Get, |
||||||
|
typename Set, |
||||||
|
typename = function_signature_t<Get>, |
||||||
|
typename = function_signature_t<Set>> |
||||||
|
struct pickle_factory; |
||||||
|
|
||||||
|
template <typename Get, |
||||||
|
typename Set, |
||||||
|
typename RetState, |
||||||
|
typename Self, |
||||||
|
typename NewInstance, |
||||||
|
typename ArgState> |
||||||
|
struct pickle_factory<Get, Set, RetState(Self), NewInstance(ArgState)> { |
||||||
|
static_assert(std::is_same<intrinsic_t<RetState>, intrinsic_t<ArgState>>::value, |
||||||
|
"The type returned by `__getstate__` must be the same " |
||||||
|
"as the argument accepted by `__setstate__`"); |
||||||
|
|
||||||
|
remove_reference_t<Get> get; |
||||||
|
remove_reference_t<Set> set; |
||||||
|
|
||||||
|
pickle_factory(Get get, Set set) : get(std::forward<Get>(get)), set(std::forward<Set>(set)) {} |
||||||
|
|
||||||
|
template <typename Class, typename... Extra> |
||||||
|
void execute(Class &cl, const Extra &...extra) && { |
||||||
|
cl.def("__getstate__", std::move(get)); |
||||||
|
|
||||||
|
#if defined(PYBIND11_CPP14) |
||||||
|
cl.def( |
||||||
|
"__setstate__", |
||||||
|
[func = std::move(set)] |
||||||
|
#else |
||||||
|
auto &func = set; |
||||||
|
cl.def( |
||||||
|
"__setstate__", |
||||||
|
[func] |
||||||
|
#endif |
||||||
|
(value_and_holder &v_h, ArgState state) { |
||||||
|
setstate<Class>( |
||||||
|
v_h, func(std::forward<ArgState>(state)), Py_TYPE(v_h.inst) != v_h.type->type); |
||||||
|
}, |
||||||
|
is_new_style_constructor(), |
||||||
|
extra...); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(initimpl) |
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
@ -0,0 +1,611 @@ |
|||||||
|
/*
|
||||||
|
pybind11/detail/internals.h: Internal data structure and related functions |
||||||
|
|
||||||
|
Copyright (c) 2017 Wenzel Jakob <wenzel.jakob@epfl.ch> |
||||||
|
|
||||||
|
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 "common.h" |
||||||
|
|
||||||
|
#if defined(WITH_THREAD) && defined(PYBIND11_SIMPLE_GIL_MANAGEMENT) |
||||||
|
# include "../gil.h" |
||||||
|
#endif |
||||||
|
|
||||||
|
#include "../pytypes.h" |
||||||
|
|
||||||
|
#include <exception> |
||||||
|
|
||||||
|
/// Tracks the `internals` and `type_info` ABI version independent of the main library version.
|
||||||
|
///
|
||||||
|
/// Some portions of the code use an ABI that is conditional depending on this
|
||||||
|
/// version number. That allows ABI-breaking changes to be "pre-implemented".
|
||||||
|
/// Once the default version number is incremented, the conditional logic that
|
||||||
|
/// no longer applies can be removed. Additionally, users that need not
|
||||||
|
/// maintain ABI compatibility can increase the version number in order to take
|
||||||
|
/// advantage of any functionality/efficiency improvements that depend on the
|
||||||
|
/// newer ABI.
|
||||||
|
///
|
||||||
|
/// WARNING: If you choose to manually increase the ABI version, note that
|
||||||
|
/// pybind11 may not be tested as thoroughly with a non-default ABI version, and
|
||||||
|
/// further ABI-incompatible changes may be made before the ABI is officially
|
||||||
|
/// changed to the new version.
|
||||||
|
#ifndef PYBIND11_INTERNALS_VERSION |
||||||
|
# define PYBIND11_INTERNALS_VERSION 4 |
||||||
|
#endif |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
|
||||||
|
using ExceptionTranslator = void (*)(std::exception_ptr); |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
constexpr const char *internals_function_record_capsule_name = "pybind11_function_record_capsule"; |
||||||
|
|
||||||
|
// Forward declarations
|
||||||
|
inline PyTypeObject *make_static_property_type(); |
||||||
|
inline PyTypeObject *make_default_metaclass(); |
||||||
|
inline PyObject *make_object_base_type(PyTypeObject *metaclass); |
||||||
|
|
||||||
|
// The old Python Thread Local Storage (TLS) API is deprecated in Python 3.7 in favor of the new
|
||||||
|
// Thread Specific Storage (TSS) API.
|
||||||
|
#if PY_VERSION_HEX >= 0x03070000 |
||||||
|
// Avoid unnecessary allocation of `Py_tss_t`, since we cannot use
|
||||||
|
// `Py_LIMITED_API` anyway.
|
||||||
|
# if PYBIND11_INTERNALS_VERSION > 4 |
||||||
|
# define PYBIND11_TLS_KEY_REF Py_tss_t & |
||||||
|
# if defined(__GNUC__) && !defined(__INTEL_COMPILER) |
||||||
|
// Clang on macOS warns due to `Py_tss_NEEDS_INIT` not specifying an initializer
|
||||||
|
// for every field.
|
||||||
|
# define PYBIND11_TLS_KEY_INIT(var) \ |
||||||
|
_Pragma("GCC diagnostic push") /**/ \
|
||||||
|
_Pragma("GCC diagnostic ignored \"-Wmissing-field-initializers\"") /**/ \
|
||||||
|
Py_tss_t var \
|
||||||
|
= Py_tss_NEEDS_INIT; \
|
||||||
|
_Pragma("GCC diagnostic pop") |
||||||
|
# else |
||||||
|
# define PYBIND11_TLS_KEY_INIT(var) Py_tss_t var = Py_tss_NEEDS_INIT; |
||||||
|
# endif |
||||||
|
# define PYBIND11_TLS_KEY_CREATE(var) (PyThread_tss_create(&(var)) == 0) |
||||||
|
# define PYBIND11_TLS_GET_VALUE(key) PyThread_tss_get(&(key)) |
||||||
|
# define PYBIND11_TLS_REPLACE_VALUE(key, value) PyThread_tss_set(&(key), (value)) |
||||||
|
# define PYBIND11_TLS_DELETE_VALUE(key) PyThread_tss_set(&(key), nullptr) |
||||||
|
# define PYBIND11_TLS_FREE(key) PyThread_tss_delete(&(key)) |
||||||
|
# else |
||||||
|
# define PYBIND11_TLS_KEY_REF Py_tss_t * |
||||||
|
# define PYBIND11_TLS_KEY_INIT(var) Py_tss_t *var = nullptr; |
||||||
|
# define PYBIND11_TLS_KEY_CREATE(var) \ |
||||||
|
(((var) = PyThread_tss_alloc()) != nullptr && (PyThread_tss_create((var)) == 0)) |
||||||
|
# define PYBIND11_TLS_GET_VALUE(key) PyThread_tss_get((key)) |
||||||
|
# define PYBIND11_TLS_REPLACE_VALUE(key, value) PyThread_tss_set((key), (value)) |
||||||
|
# define PYBIND11_TLS_DELETE_VALUE(key) PyThread_tss_set((key), nullptr) |
||||||
|
# define PYBIND11_TLS_FREE(key) PyThread_tss_free(key) |
||||||
|
# endif |
||||||
|
#else |
||||||
|
// Usually an int but a long on Cygwin64 with Python 3.x
|
||||||
|
# define PYBIND11_TLS_KEY_REF decltype(PyThread_create_key()) |
||||||
|
# define PYBIND11_TLS_KEY_INIT(var) PYBIND11_TLS_KEY_REF var = 0; |
||||||
|
# define PYBIND11_TLS_KEY_CREATE(var) (((var) = PyThread_create_key()) != -1) |
||||||
|
# define PYBIND11_TLS_GET_VALUE(key) PyThread_get_key_value((key)) |
||||||
|
# if defined(PYPY_VERSION) |
||||||
|
// On CPython < 3.4 and on PyPy, `PyThread_set_key_value` strangely does not set
|
||||||
|
// the value if it has already been set. Instead, it must first be deleted and
|
||||||
|
// then set again.
|
||||||
|
inline void tls_replace_value(PYBIND11_TLS_KEY_REF key, void *value) { |
||||||
|
PyThread_delete_key_value(key); |
||||||
|
PyThread_set_key_value(key, value); |
||||||
|
} |
||||||
|
# define PYBIND11_TLS_DELETE_VALUE(key) PyThread_delete_key_value(key) |
||||||
|
# define PYBIND11_TLS_REPLACE_VALUE(key, value) \ |
||||||
|
::pybind11::detail::tls_replace_value((key), (value)) |
||||||
|
# else |
||||||
|
# define PYBIND11_TLS_DELETE_VALUE(key) PyThread_set_key_value((key), nullptr) |
||||||
|
# define PYBIND11_TLS_REPLACE_VALUE(key, value) PyThread_set_key_value((key), (value)) |
||||||
|
# endif |
||||||
|
# define PYBIND11_TLS_FREE(key) (void) key |
||||||
|
#endif |
||||||
|
|
||||||
|
// Python loads modules by default with dlopen with the RTLD_LOCAL flag; under libc++ and possibly
|
||||||
|
// other STLs, this means `typeid(A)` from one module won't equal `typeid(A)` from another module
|
||||||
|
// even when `A` is the same, non-hidden-visibility type (e.g. from a common include). Under
|
||||||
|
// libstdc++, this doesn't happen: equality and the type_index hash are based on the type name,
|
||||||
|
// which works. If not under a known-good stl, provide our own name-based hash and equality
|
||||||
|
// functions that use the type name.
|
||||||
|
#if defined(__GLIBCXX__) |
||||||
|
inline bool same_type(const std::type_info &lhs, const std::type_info &rhs) { return lhs == rhs; } |
||||||
|
using type_hash = std::hash<std::type_index>; |
||||||
|
using type_equal_to = std::equal_to<std::type_index>; |
||||||
|
#else |
||||||
|
inline bool same_type(const std::type_info &lhs, const std::type_info &rhs) { |
||||||
|
return lhs.name() == rhs.name() || std::strcmp(lhs.name(), rhs.name()) == 0; |
||||||
|
} |
||||||
|
|
||||||
|
struct type_hash { |
||||||
|
size_t operator()(const std::type_index &t) const { |
||||||
|
size_t hash = 5381; |
||||||
|
const char *ptr = t.name(); |
||||||
|
while (auto c = static_cast<unsigned char>(*ptr++)) { |
||||||
|
hash = (hash * 33) ^ c; |
||||||
|
} |
||||||
|
return hash; |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
struct type_equal_to { |
||||||
|
bool operator()(const std::type_index &lhs, const std::type_index &rhs) const { |
||||||
|
return lhs.name() == rhs.name() || std::strcmp(lhs.name(), rhs.name()) == 0; |
||||||
|
} |
||||||
|
}; |
||||||
|
#endif |
||||||
|
|
||||||
|
template <typename value_type> |
||||||
|
using type_map = std::unordered_map<std::type_index, value_type, type_hash, type_equal_to>; |
||||||
|
|
||||||
|
struct override_hash { |
||||||
|
inline size_t operator()(const std::pair<const PyObject *, const char *> &v) const { |
||||||
|
size_t value = std::hash<const void *>()(v.first); |
||||||
|
value ^= std::hash<const void *>()(v.second) + 0x9e3779b9 + (value << 6) + (value >> 2); |
||||||
|
return value; |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
/// Internal data structure used to track registered instances and types.
|
||||||
|
/// Whenever binary incompatible changes are made to this structure,
|
||||||
|
/// `PYBIND11_INTERNALS_VERSION` must be incremented.
|
||||||
|
struct internals { |
||||||
|
// std::type_index -> pybind11's type information
|
||||||
|
type_map<type_info *> registered_types_cpp; |
||||||
|
// PyTypeObject* -> base type_info(s)
|
||||||
|
std::unordered_map<PyTypeObject *, std::vector<type_info *>> registered_types_py; |
||||||
|
std::unordered_multimap<const void *, instance *> registered_instances; // void * -> instance*
|
||||||
|
std::unordered_set<std::pair<const PyObject *, const char *>, override_hash> |
||||||
|
inactive_override_cache; |
||||||
|
type_map<std::vector<bool (*)(PyObject *, void *&)>> direct_conversions; |
||||||
|
std::unordered_map<const PyObject *, std::vector<PyObject *>> patients; |
||||||
|
std::forward_list<ExceptionTranslator> registered_exception_translators; |
||||||
|
std::unordered_map<std::string, void *> shared_data; // Custom data to be shared across
|
||||||
|
// extensions
|
||||||
|
#if PYBIND11_INTERNALS_VERSION == 4 |
||||||
|
std::vector<PyObject *> unused_loader_patient_stack_remove_at_v5; |
||||||
|
#endif |
||||||
|
std::forward_list<std::string> static_strings; // Stores the std::strings backing
|
||||||
|
// detail::c_str()
|
||||||
|
PyTypeObject *static_property_type; |
||||||
|
PyTypeObject *default_metaclass; |
||||||
|
PyObject *instance_base; |
||||||
|
#if defined(WITH_THREAD) |
||||||
|
// Unused if PYBIND11_SIMPLE_GIL_MANAGEMENT is defined:
|
||||||
|
PYBIND11_TLS_KEY_INIT(tstate) |
||||||
|
# if PYBIND11_INTERNALS_VERSION > 4 |
||||||
|
PYBIND11_TLS_KEY_INIT(loader_life_support_tls_key) |
||||||
|
# endif // PYBIND11_INTERNALS_VERSION > 4
|
||||||
|
// Unused if PYBIND11_SIMPLE_GIL_MANAGEMENT is defined:
|
||||||
|
PyInterpreterState *istate = nullptr; |
||||||
|
|
||||||
|
# if PYBIND11_INTERNALS_VERSION > 4 |
||||||
|
// Note that we have to use a std::string to allocate memory to ensure a unique address
|
||||||
|
// We want unique addresses since we use pointer equality to compare function records
|
||||||
|
std::string function_record_capsule_name = internals_function_record_capsule_name; |
||||||
|
# endif |
||||||
|
|
||||||
|
internals() = default; |
||||||
|
internals(const internals &other) = delete; |
||||||
|
internals &operator=(const internals &other) = delete; |
||||||
|
~internals() { |
||||||
|
# if PYBIND11_INTERNALS_VERSION > 4 |
||||||
|
PYBIND11_TLS_FREE(loader_life_support_tls_key); |
||||||
|
# endif // PYBIND11_INTERNALS_VERSION > 4
|
||||||
|
|
||||||
|
// This destructor is called *after* Py_Finalize() in finalize_interpreter().
|
||||||
|
// That *SHOULD BE* fine. The following details what happens when PyThread_tss_free is
|
||||||
|
// called. PYBIND11_TLS_FREE is PyThread_tss_free on python 3.7+. On older python, it does
|
||||||
|
// nothing. PyThread_tss_free calls PyThread_tss_delete and PyMem_RawFree.
|
||||||
|
// PyThread_tss_delete just calls TlsFree (on Windows) or pthread_key_delete (on *NIX).
|
||||||
|
// Neither of those have anything to do with CPython internals. PyMem_RawFree *requires*
|
||||||
|
// that the `tstate` be allocated with the CPython allocator.
|
||||||
|
PYBIND11_TLS_FREE(tstate); |
||||||
|
} |
||||||
|
#endif |
||||||
|
}; |
||||||
|
|
||||||
|
/// Additional type information which does not fit into the PyTypeObject.
|
||||||
|
/// Changes to this struct also require bumping `PYBIND11_INTERNALS_VERSION`.
|
||||||
|
struct type_info { |
||||||
|
PyTypeObject *type; |
||||||
|
const std::type_info *cpptype; |
||||||
|
size_t type_size, type_align, holder_size_in_ptrs; |
||||||
|
void *(*operator_new)(size_t); |
||||||
|
void (*init_instance)(instance *, const void *); |
||||||
|
void (*dealloc)(value_and_holder &v_h); |
||||||
|
std::vector<PyObject *(*) (PyObject *, PyTypeObject *)> implicit_conversions; |
||||||
|
std::vector<std::pair<const std::type_info *, void *(*) (void *)>> implicit_casts; |
||||||
|
std::vector<bool (*)(PyObject *, void *&)> *direct_conversions; |
||||||
|
buffer_info *(*get_buffer)(PyObject *, void *) = nullptr; |
||||||
|
void *get_buffer_data = nullptr; |
||||||
|
void *(*module_local_load)(PyObject *, const type_info *) = nullptr; |
||||||
|
/* A simple type never occurs as a (direct or indirect) parent
|
||||||
|
* of a class that makes use of multiple inheritance. |
||||||
|
* A type can be simple even if it has non-simple ancestors as long as it has no descendants. |
||||||
|
*/ |
||||||
|
bool simple_type : 1; |
||||||
|
/* True if there is no multiple inheritance in this type's inheritance tree */ |
||||||
|
bool simple_ancestors : 1; |
||||||
|
/* for base vs derived holder_type checks */ |
||||||
|
bool default_holder : 1; |
||||||
|
/* true if this is a type registered with py::module_local */ |
||||||
|
bool module_local : 1; |
||||||
|
}; |
||||||
|
|
||||||
|
/// On MSVC, debug and release builds are not ABI-compatible!
|
||||||
|
#if defined(_MSC_VER) && defined(_DEBUG) |
||||||
|
# define PYBIND11_BUILD_TYPE "_debug" |
||||||
|
#else |
||||||
|
# define PYBIND11_BUILD_TYPE "" |
||||||
|
#endif |
||||||
|
|
||||||
|
/// Let's assume that different compilers are ABI-incompatible.
|
||||||
|
/// A user can manually set this string if they know their
|
||||||
|
/// compiler is compatible.
|
||||||
|
#ifndef PYBIND11_COMPILER_TYPE |
||||||
|
# if defined(_MSC_VER) |
||||||
|
# define PYBIND11_COMPILER_TYPE "_msvc" |
||||||
|
# elif defined(__INTEL_COMPILER) |
||||||
|
# define PYBIND11_COMPILER_TYPE "_icc" |
||||||
|
# elif defined(__clang__) |
||||||
|
# define PYBIND11_COMPILER_TYPE "_clang" |
||||||
|
# elif defined(__PGI) |
||||||
|
# define PYBIND11_COMPILER_TYPE "_pgi" |
||||||
|
# elif defined(__MINGW32__) |
||||||
|
# define PYBIND11_COMPILER_TYPE "_mingw" |
||||||
|
# elif defined(__CYGWIN__) |
||||||
|
# define PYBIND11_COMPILER_TYPE "_gcc_cygwin" |
||||||
|
# elif defined(__GNUC__) |
||||||
|
# define PYBIND11_COMPILER_TYPE "_gcc" |
||||||
|
# else |
||||||
|
# define PYBIND11_COMPILER_TYPE "_unknown" |
||||||
|
# endif |
||||||
|
#endif |
||||||
|
|
||||||
|
/// Also standard libs
|
||||||
|
#ifndef PYBIND11_STDLIB |
||||||
|
# if defined(_LIBCPP_VERSION) |
||||||
|
# define PYBIND11_STDLIB "_libcpp" |
||||||
|
# elif defined(__GLIBCXX__) || defined(__GLIBCPP__) |
||||||
|
# define PYBIND11_STDLIB "_libstdcpp" |
||||||
|
# else |
||||||
|
# define PYBIND11_STDLIB "" |
||||||
|
# endif |
||||||
|
#endif |
||||||
|
|
||||||
|
/// On Linux/OSX, changes in __GXX_ABI_VERSION__ indicate ABI incompatibility.
|
||||||
|
#ifndef PYBIND11_BUILD_ABI |
||||||
|
# if defined(__GXX_ABI_VERSION) |
||||||
|
# define PYBIND11_BUILD_ABI "_cxxabi" PYBIND11_TOSTRING(__GXX_ABI_VERSION) |
||||||
|
# else |
||||||
|
# define PYBIND11_BUILD_ABI "" |
||||||
|
# endif |
||||||
|
#endif |
||||||
|
|
||||||
|
#ifndef PYBIND11_INTERNALS_KIND |
||||||
|
# if defined(WITH_THREAD) |
||||||
|
# define PYBIND11_INTERNALS_KIND "" |
||||||
|
# else |
||||||
|
# define PYBIND11_INTERNALS_KIND "_without_thread" |
||||||
|
# endif |
||||||
|
#endif |
||||||
|
|
||||||
|
#define PYBIND11_INTERNALS_ID \ |
||||||
|
"__pybind11_internals_v" PYBIND11_TOSTRING(PYBIND11_INTERNALS_VERSION) \
|
||||||
|
PYBIND11_INTERNALS_KIND PYBIND11_COMPILER_TYPE PYBIND11_STDLIB PYBIND11_BUILD_ABI \
|
||||||
|
PYBIND11_BUILD_TYPE "__" |
||||||
|
|
||||||
|
#define PYBIND11_MODULE_LOCAL_ID \ |
||||||
|
"__pybind11_module_local_v" PYBIND11_TOSTRING(PYBIND11_INTERNALS_VERSION) \
|
||||||
|
PYBIND11_INTERNALS_KIND PYBIND11_COMPILER_TYPE PYBIND11_STDLIB PYBIND11_BUILD_ABI \
|
||||||
|
PYBIND11_BUILD_TYPE "__" |
||||||
|
|
||||||
|
/// Each module locally stores a pointer to the `internals` data. The data
|
||||||
|
/// itself is shared among modules with the same `PYBIND11_INTERNALS_ID`.
|
||||||
|
inline internals **&get_internals_pp() { |
||||||
|
static internals **internals_pp = nullptr; |
||||||
|
return internals_pp; |
||||||
|
} |
||||||
|
|
||||||
|
// forward decl
|
||||||
|
inline void translate_exception(std::exception_ptr); |
||||||
|
|
||||||
|
template <class T, |
||||||
|
enable_if_t<std::is_same<std::nested_exception, remove_cvref_t<T>>::value, int> = 0> |
||||||
|
bool handle_nested_exception(const T &exc, const std::exception_ptr &p) { |
||||||
|
std::exception_ptr nested = exc.nested_ptr(); |
||||||
|
if (nested != nullptr && nested != p) { |
||||||
|
translate_exception(nested); |
||||||
|
return true; |
||||||
|
} |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
template <class T, |
||||||
|
enable_if_t<!std::is_same<std::nested_exception, remove_cvref_t<T>>::value, int> = 0> |
||||||
|
bool handle_nested_exception(const T &exc, const std::exception_ptr &p) { |
||||||
|
if (const auto *nep = dynamic_cast<const std::nested_exception *>(std::addressof(exc))) { |
||||||
|
return handle_nested_exception(*nep, p); |
||||||
|
} |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
inline bool raise_err(PyObject *exc_type, const char *msg) { |
||||||
|
if (PyErr_Occurred()) { |
||||||
|
raise_from(exc_type, msg); |
||||||
|
return true; |
||||||
|
} |
||||||
|
PyErr_SetString(exc_type, msg); |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
inline void translate_exception(std::exception_ptr p) { |
||||||
|
if (!p) { |
||||||
|
return; |
||||||
|
} |
||||||
|
try { |
||||||
|
std::rethrow_exception(p); |
||||||
|
} catch (error_already_set &e) { |
||||||
|
handle_nested_exception(e, p); |
||||||
|
e.restore(); |
||||||
|
return; |
||||||
|
} catch (const builtin_exception &e) { |
||||||
|
// Could not use template since it's an abstract class.
|
||||||
|
if (const auto *nep = dynamic_cast<const std::nested_exception *>(std::addressof(e))) { |
||||||
|
handle_nested_exception(*nep, p); |
||||||
|
} |
||||||
|
e.set_error(); |
||||||
|
return; |
||||||
|
} catch (const std::bad_alloc &e) { |
||||||
|
handle_nested_exception(e, p); |
||||||
|
raise_err(PyExc_MemoryError, e.what()); |
||||||
|
return; |
||||||
|
} catch (const std::domain_error &e) { |
||||||
|
handle_nested_exception(e, p); |
||||||
|
raise_err(PyExc_ValueError, e.what()); |
||||||
|
return; |
||||||
|
} catch (const std::invalid_argument &e) { |
||||||
|
handle_nested_exception(e, p); |
||||||
|
raise_err(PyExc_ValueError, e.what()); |
||||||
|
return; |
||||||
|
} catch (const std::length_error &e) { |
||||||
|
handle_nested_exception(e, p); |
||||||
|
raise_err(PyExc_ValueError, e.what()); |
||||||
|
return; |
||||||
|
} catch (const std::out_of_range &e) { |
||||||
|
handle_nested_exception(e, p); |
||||||
|
raise_err(PyExc_IndexError, e.what()); |
||||||
|
return; |
||||||
|
} catch (const std::range_error &e) { |
||||||
|
handle_nested_exception(e, p); |
||||||
|
raise_err(PyExc_ValueError, e.what()); |
||||||
|
return; |
||||||
|
} catch (const std::overflow_error &e) { |
||||||
|
handle_nested_exception(e, p); |
||||||
|
raise_err(PyExc_OverflowError, e.what()); |
||||||
|
return; |
||||||
|
} catch (const std::exception &e) { |
||||||
|
handle_nested_exception(e, p); |
||||||
|
raise_err(PyExc_RuntimeError, e.what()); |
||||||
|
return; |
||||||
|
} catch (const std::nested_exception &e) { |
||||||
|
handle_nested_exception(e, p); |
||||||
|
raise_err(PyExc_RuntimeError, "Caught an unknown nested exception!"); |
||||||
|
return; |
||||||
|
} catch (...) { |
||||||
|
raise_err(PyExc_RuntimeError, "Caught an unknown exception!"); |
||||||
|
return; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
#if !defined(__GLIBCXX__) |
||||||
|
inline void translate_local_exception(std::exception_ptr p) { |
||||||
|
try { |
||||||
|
if (p) { |
||||||
|
std::rethrow_exception(p); |
||||||
|
} |
||||||
|
} catch (error_already_set &e) { |
||||||
|
e.restore(); |
||||||
|
return; |
||||||
|
} catch (const builtin_exception &e) { |
||||||
|
e.set_error(); |
||||||
|
return; |
||||||
|
} |
||||||
|
} |
||||||
|
#endif |
||||||
|
|
||||||
|
/// Return a reference to the current `internals` data
|
||||||
|
PYBIND11_NOINLINE internals &get_internals() { |
||||||
|
auto **&internals_pp = get_internals_pp(); |
||||||
|
if (internals_pp && *internals_pp) { |
||||||
|
return **internals_pp; |
||||||
|
} |
||||||
|
|
||||||
|
#if defined(WITH_THREAD) |
||||||
|
# if defined(PYBIND11_SIMPLE_GIL_MANAGEMENT) |
||||||
|
gil_scoped_acquire gil; |
||||||
|
# else |
||||||
|
// Ensure that the GIL is held since we will need to make Python calls.
|
||||||
|
// Cannot use py::gil_scoped_acquire here since that constructor calls get_internals.
|
||||||
|
struct gil_scoped_acquire_local { |
||||||
|
gil_scoped_acquire_local() : state(PyGILState_Ensure()) {} |
||||||
|
gil_scoped_acquire_local(const gil_scoped_acquire_local &) = delete; |
||||||
|
gil_scoped_acquire_local &operator=(const gil_scoped_acquire_local &) = delete; |
||||||
|
~gil_scoped_acquire_local() { PyGILState_Release(state); } |
||||||
|
const PyGILState_STATE state; |
||||||
|
} gil; |
||||||
|
# endif |
||||||
|
#endif |
||||||
|
error_scope err_scope; |
||||||
|
|
||||||
|
PYBIND11_STR_TYPE id(PYBIND11_INTERNALS_ID); |
||||||
|
auto builtins = handle(PyEval_GetBuiltins()); |
||||||
|
if (builtins.contains(id) && isinstance<capsule>(builtins[id])) { |
||||||
|
internals_pp = static_cast<internals **>(capsule(builtins[id])); |
||||||
|
|
||||||
|
// We loaded builtins through python's builtins, which means that our `error_already_set`
|
||||||
|
// and `builtin_exception` may be different local classes than the ones set up in the
|
||||||
|
// initial exception translator, below, so add another for our local exception classes.
|
||||||
|
//
|
||||||
|
// libstdc++ doesn't require this (types there are identified only by name)
|
||||||
|
// libc++ with CPython doesn't require this (types are explicitly exported)
|
||||||
|
// libc++ with PyPy still need it, awaiting further investigation
|
||||||
|
#if !defined(__GLIBCXX__) |
||||||
|
(*internals_pp)->registered_exception_translators.push_front(&translate_local_exception); |
||||||
|
#endif |
||||||
|
} else { |
||||||
|
if (!internals_pp) { |
||||||
|
internals_pp = new internals *(); |
||||||
|
} |
||||||
|
auto *&internals_ptr = *internals_pp; |
||||||
|
internals_ptr = new internals(); |
||||||
|
#if defined(WITH_THREAD) |
||||||
|
|
||||||
|
PyThreadState *tstate = PyThreadState_Get(); |
||||||
|
if (!PYBIND11_TLS_KEY_CREATE(internals_ptr->tstate)) { |
||||||
|
pybind11_fail("get_internals: could not successfully initialize the tstate TSS key!"); |
||||||
|
} |
||||||
|
PYBIND11_TLS_REPLACE_VALUE(internals_ptr->tstate, tstate); |
||||||
|
|
||||||
|
# if PYBIND11_INTERNALS_VERSION > 4 |
||||||
|
if (!PYBIND11_TLS_KEY_CREATE(internals_ptr->loader_life_support_tls_key)) { |
||||||
|
pybind11_fail("get_internals: could not successfully initialize the " |
||||||
|
"loader_life_support TSS key!"); |
||||||
|
} |
||||||
|
# endif |
||||||
|
internals_ptr->istate = tstate->interp; |
||||||
|
#endif |
||||||
|
builtins[id] = capsule(internals_pp); |
||||||
|
internals_ptr->registered_exception_translators.push_front(&translate_exception); |
||||||
|
internals_ptr->static_property_type = make_static_property_type(); |
||||||
|
internals_ptr->default_metaclass = make_default_metaclass(); |
||||||
|
internals_ptr->instance_base = make_object_base_type(internals_ptr->default_metaclass); |
||||||
|
} |
||||||
|
return **internals_pp; |
||||||
|
} |
||||||
|
|
||||||
|
// the internals struct (above) is shared between all the modules. local_internals are only
|
||||||
|
// for a single module. Any changes made to internals may require an update to
|
||||||
|
// PYBIND11_INTERNALS_VERSION, breaking backwards compatibility. local_internals is, by design,
|
||||||
|
// restricted to a single module. Whether a module has local internals or not should not
|
||||||
|
// impact any other modules, because the only things accessing the local internals is the
|
||||||
|
// module that contains them.
|
||||||
|
struct local_internals { |
||||||
|
type_map<type_info *> registered_types_cpp; |
||||||
|
std::forward_list<ExceptionTranslator> registered_exception_translators; |
||||||
|
#if defined(WITH_THREAD) && PYBIND11_INTERNALS_VERSION == 4 |
||||||
|
|
||||||
|
// For ABI compatibility, we can't store the loader_life_support TLS key in
|
||||||
|
// the `internals` struct directly. Instead, we store it in `shared_data` and
|
||||||
|
// cache a copy in `local_internals`. If we allocated a separate TLS key for
|
||||||
|
// each instance of `local_internals`, we could end up allocating hundreds of
|
||||||
|
// TLS keys if hundreds of different pybind11 modules are loaded (which is a
|
||||||
|
// plausible number).
|
||||||
|
PYBIND11_TLS_KEY_INIT(loader_life_support_tls_key) |
||||||
|
|
||||||
|
// Holds the shared TLS key for the loader_life_support stack.
|
||||||
|
struct shared_loader_life_support_data { |
||||||
|
PYBIND11_TLS_KEY_INIT(loader_life_support_tls_key) |
||||||
|
shared_loader_life_support_data() { |
||||||
|
if (!PYBIND11_TLS_KEY_CREATE(loader_life_support_tls_key)) { |
||||||
|
pybind11_fail("local_internals: could not successfully initialize the " |
||||||
|
"loader_life_support TLS key!"); |
||||||
|
} |
||||||
|
} |
||||||
|
// We can't help but leak the TLS key, because Python never unloads extension modules.
|
||||||
|
}; |
||||||
|
|
||||||
|
local_internals() { |
||||||
|
auto &internals = get_internals(); |
||||||
|
// Get or create the `loader_life_support_stack_key`.
|
||||||
|
auto &ptr = internals.shared_data["_life_support"]; |
||||||
|
if (!ptr) { |
||||||
|
ptr = new shared_loader_life_support_data; |
||||||
|
} |
||||||
|
loader_life_support_tls_key |
||||||
|
= static_cast<shared_loader_life_support_data *>(ptr)->loader_life_support_tls_key; |
||||||
|
} |
||||||
|
#endif // defined(WITH_THREAD) && PYBIND11_INTERNALS_VERSION == 4
|
||||||
|
}; |
||||||
|
|
||||||
|
/// Works like `get_internals`, but for things which are locally registered.
|
||||||
|
inline local_internals &get_local_internals() { |
||||||
|
// Current static can be created in the interpreter finalization routine. If the later will be
|
||||||
|
// destroyed in another static variable destructor, creation of this static there will cause
|
||||||
|
// static deinitialization fiasco. In order to avoid it we avoid destruction of the
|
||||||
|
// local_internals static. One can read more about the problem and current solution here:
|
||||||
|
// https://google.github.io/styleguide/cppguide.html#Static_and_Global_Variables
|
||||||
|
static auto *locals = new local_internals(); |
||||||
|
return *locals; |
||||||
|
} |
||||||
|
|
||||||
|
/// Constructs a std::string with the given arguments, stores it in `internals`, and returns its
|
||||||
|
/// `c_str()`. Such strings objects have a long storage duration -- the internal strings are only
|
||||||
|
/// cleared when the program exits or after interpreter shutdown (when embedding), and so are
|
||||||
|
/// suitable for c-style strings needed by Python internals (such as PyTypeObject's tp_name).
|
||||||
|
template <typename... Args> |
||||||
|
const char *c_str(Args &&...args) { |
||||||
|
auto &strings = get_internals().static_strings; |
||||||
|
strings.emplace_front(std::forward<Args>(args)...); |
||||||
|
return strings.front().c_str(); |
||||||
|
} |
||||||
|
|
||||||
|
inline const char *get_function_record_capsule_name() { |
||||||
|
#if PYBIND11_INTERNALS_VERSION > 4 |
||||||
|
return get_internals().function_record_capsule_name.c_str(); |
||||||
|
#else |
||||||
|
return nullptr; |
||||||
|
#endif |
||||||
|
} |
||||||
|
|
||||||
|
// Determine whether or not the following capsule contains a pybind11 function record.
|
||||||
|
// Note that we use `internals` to make sure that only ABI compatible records are touched.
|
||||||
|
//
|
||||||
|
// This check is currently used in two places:
|
||||||
|
// - An important optimization in functional.h to avoid overhead in C++ -> Python -> C++
|
||||||
|
// - The sibling feature of cpp_function to allow overloads
|
||||||
|
inline bool is_function_record_capsule(const capsule &cap) { |
||||||
|
// Pointer equality as we rely on internals() to ensure unique pointers
|
||||||
|
return cap.name() == get_function_record_capsule_name(); |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
|
||||||
|
/// Returns a named pointer that is shared among all extension modules (using the same
|
||||||
|
/// pybind11 version) running in the current interpreter. Names starting with underscores
|
||||||
|
/// are reserved for internal usage. Returns `nullptr` if no matching entry was found.
|
||||||
|
PYBIND11_NOINLINE void *get_shared_data(const std::string &name) { |
||||||
|
auto &internals = detail::get_internals(); |
||||||
|
auto it = internals.shared_data.find(name); |
||||||
|
return it != internals.shared_data.end() ? it->second : nullptr; |
||||||
|
} |
||||||
|
|
||||||
|
/// Set the shared data that can be later recovered by `get_shared_data()`.
|
||||||
|
PYBIND11_NOINLINE void *set_shared_data(const std::string &name, void *data) { |
||||||
|
detail::get_internals().shared_data[name] = data; |
||||||
|
return data; |
||||||
|
} |
||||||
|
|
||||||
|
/// Returns a typed reference to a shared data entry (by using `get_shared_data()`) if
|
||||||
|
/// such entry exists. Otherwise, a new object of default-constructible type `T` is
|
||||||
|
/// added to the shared data under the given name and a reference to it is returned.
|
||||||
|
template <typename T> |
||||||
|
T &get_or_create_shared_data(const std::string &name) { |
||||||
|
auto &internals = detail::get_internals(); |
||||||
|
auto it = internals.shared_data.find(name); |
||||||
|
T *ptr = (T *) (it != internals.shared_data.end() ? it->second : nullptr); |
||||||
|
if (!ptr) { |
||||||
|
ptr = new T(); |
||||||
|
internals.shared_data[name] = ptr; |
||||||
|
} |
||||||
|
return *ptr; |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,65 @@ |
|||||||
|
/*
|
||||||
|
pybind11/detail/typeid.h: Compiler-independent access to type identifiers |
||||||
|
|
||||||
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> |
||||||
|
|
||||||
|
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 <cstdio> |
||||||
|
#include <cstdlib> |
||||||
|
|
||||||
|
#if defined(__GNUG__) |
||||||
|
# include <cxxabi.h> |
||||||
|
#endif |
||||||
|
|
||||||
|
#include "common.h" |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
/// Erase all occurrences of a substring
|
||||||
|
inline void erase_all(std::string &string, const std::string &search) { |
||||||
|
for (size_t pos = 0;;) { |
||||||
|
pos = string.find(search, pos); |
||||||
|
if (pos == std::string::npos) { |
||||||
|
break; |
||||||
|
} |
||||||
|
string.erase(pos, search.length()); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_NOINLINE void clean_type_id(std::string &name) { |
||||||
|
#if defined(__GNUG__) |
||||||
|
int status = 0; |
||||||
|
std::unique_ptr<char, void (*)(void *)> res{ |
||||||
|
abi::__cxa_demangle(name.c_str(), nullptr, nullptr, &status), std::free}; |
||||||
|
if (status == 0) { |
||||||
|
name = res.get(); |
||||||
|
} |
||||||
|
#else |
||||||
|
detail::erase_all(name, "class "); |
||||||
|
detail::erase_all(name, "struct "); |
||||||
|
detail::erase_all(name, "enum "); |
||||||
|
#endif |
||||||
|
detail::erase_all(name, "pybind11::"); |
||||||
|
} |
||||||
|
|
||||||
|
inline std::string clean_type_id(const char *typeid_name) { |
||||||
|
std::string name(typeid_name); |
||||||
|
detail::clean_type_id(name); |
||||||
|
return name; |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
|
||||||
|
/// Return a string representation of a C++ type
|
||||||
|
template <typename T> |
||||||
|
static std::string type_id() { |
||||||
|
return detail::clean_type_id(typeid(T).name()); |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
@ -0,0 +1,12 @@ |
|||||||
|
/*
|
||||||
|
pybind11/eigen.h: Transparent conversion for dense and sparse Eigen matrices |
||||||
|
|
||||||
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> |
||||||
|
|
||||||
|
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 "eigen/matrix.h" |
||||||
@ -0,0 +1,701 @@ |
|||||||
|
/*
|
||||||
|
pybind11/eigen/matrix.h: Transparent conversion for dense and sparse Eigen matrices |
||||||
|
|
||||||
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> |
||||||
|
|
||||||
|
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 "../numpy.h" |
||||||
|
|
||||||
|
/* HINT: To suppress warnings originating from the Eigen headers, use -isystem.
|
||||||
|
See also: |
||||||
|
https://stackoverflow.com/questions/2579576/i-dir-vs-isystem-dir
|
||||||
|
https://stackoverflow.com/questions/1741816/isystem-for-ms-visual-studio-c-compiler
|
||||||
|
*/ |
||||||
|
PYBIND11_WARNING_PUSH |
||||||
|
PYBIND11_WARNING_DISABLE_MSVC(5054) // https://github.com/pybind/pybind11/pull/3741
|
||||||
|
// C5054: operator '&': deprecated between enumerations of different types
|
||||||
|
#if defined(__MINGW32__) |
||||||
|
PYBIND11_WARNING_DISABLE_GCC("-Wmaybe-uninitialized") |
||||||
|
#endif |
||||||
|
|
||||||
|
#include <Eigen/Core> |
||||||
|
#include <Eigen/SparseCore> |
||||||
|
|
||||||
|
PYBIND11_WARNING_POP |
||||||
|
|
||||||
|
// Eigen prior to 3.2.7 doesn't have proper move constructors--but worse, some classes get implicit
|
||||||
|
// move constructors that break things. We could detect this an explicitly copy, but an extra copy
|
||||||
|
// of matrices seems highly undesirable.
|
||||||
|
static_assert(EIGEN_VERSION_AT_LEAST(3, 2, 7), |
||||||
|
"Eigen matrix support in pybind11 requires Eigen >= 3.2.7"); |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
|
||||||
|
PYBIND11_WARNING_DISABLE_MSVC(4127) |
||||||
|
|
||||||
|
// Provide a convenience alias for easier pass-by-ref usage with fully dynamic strides:
|
||||||
|
using EigenDStride = Eigen::Stride<Eigen::Dynamic, Eigen::Dynamic>; |
||||||
|
template <typename MatrixType> |
||||||
|
using EigenDRef = Eigen::Ref<MatrixType, 0, EigenDStride>; |
||||||
|
template <typename MatrixType> |
||||||
|
using EigenDMap = Eigen::Map<MatrixType, 0, EigenDStride>; |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
#if EIGEN_VERSION_AT_LEAST(3, 3, 0) |
||||||
|
using EigenIndex = Eigen::Index; |
||||||
|
template <typename Scalar, int Flags, typename StorageIndex> |
||||||
|
using EigenMapSparseMatrix = Eigen::Map<Eigen::SparseMatrix<Scalar, Flags, StorageIndex>>; |
||||||
|
#else |
||||||
|
using EigenIndex = EIGEN_DEFAULT_DENSE_INDEX_TYPE; |
||||||
|
template <typename Scalar, int Flags, typename StorageIndex> |
||||||
|
using EigenMapSparseMatrix = Eigen::MappedSparseMatrix<Scalar, Flags, StorageIndex>; |
||||||
|
#endif |
||||||
|
|
||||||
|
// Matches Eigen::Map, Eigen::Ref, blocks, etc:
|
||||||
|
template <typename T> |
||||||
|
using is_eigen_dense_map = all_of<is_template_base_of<Eigen::DenseBase, T>, |
||||||
|
std::is_base_of<Eigen::MapBase<T, Eigen::ReadOnlyAccessors>, T>>; |
||||||
|
template <typename T> |
||||||
|
using is_eigen_mutable_map = std::is_base_of<Eigen::MapBase<T, Eigen::WriteAccessors>, T>; |
||||||
|
template <typename T> |
||||||
|
using is_eigen_dense_plain |
||||||
|
= all_of<negation<is_eigen_dense_map<T>>, is_template_base_of<Eigen::PlainObjectBase, T>>; |
||||||
|
template <typename T> |
||||||
|
using is_eigen_sparse = is_template_base_of<Eigen::SparseMatrixBase, T>; |
||||||
|
// Test for objects inheriting from EigenBase<Derived> that aren't captured by the above. This
|
||||||
|
// basically covers anything that can be assigned to a dense matrix but that don't have a typical
|
||||||
|
// matrix data layout that can be copied from their .data(). For example, DiagonalMatrix and
|
||||||
|
// SelfAdjointView fall into this category.
|
||||||
|
template <typename T> |
||||||
|
using is_eigen_other |
||||||
|
= all_of<is_template_base_of<Eigen::EigenBase, T>, |
||||||
|
negation<any_of<is_eigen_dense_map<T>, is_eigen_dense_plain<T>, is_eigen_sparse<T>>>>; |
||||||
|
|
||||||
|
// Captures numpy/eigen conformability status (returned by EigenProps::conformable()):
|
||||||
|
template <bool EigenRowMajor> |
||||||
|
struct EigenConformable { |
||||||
|
bool conformable = false; |
||||||
|
EigenIndex rows = 0, cols = 0; |
||||||
|
EigenDStride stride{0, 0}; // Only valid if negativestrides is false!
|
||||||
|
bool negativestrides = false; // If true, do not use stride!
|
||||||
|
|
||||||
|
// NOLINTNEXTLINE(google-explicit-constructor)
|
||||||
|
EigenConformable(bool fits = false) : conformable{fits} {} |
||||||
|
// Matrix type:
|
||||||
|
EigenConformable(EigenIndex r, EigenIndex c, EigenIndex rstride, EigenIndex cstride) |
||||||
|
: conformable{true}, rows{r}, cols{c}, |
||||||
|
// TODO: when Eigen bug #747 is fixed, remove the tests for non-negativity.
|
||||||
|
// http://eigen.tuxfamily.org/bz/show_bug.cgi?id=747
|
||||||
|
stride{EigenRowMajor ? (rstride > 0 ? rstride : 0) |
||||||
|
: (cstride > 0 ? cstride : 0) /* outer stride */, |
||||||
|
EigenRowMajor ? (cstride > 0 ? cstride : 0) |
||||||
|
: (rstride > 0 ? rstride : 0) /* inner stride */}, |
||||||
|
negativestrides{rstride < 0 || cstride < 0} {} |
||||||
|
// Vector type:
|
||||||
|
EigenConformable(EigenIndex r, EigenIndex c, EigenIndex stride) |
||||||
|
: EigenConformable(r, c, r == 1 ? c * stride : stride, c == 1 ? r : r * stride) {} |
||||||
|
|
||||||
|
template <typename props> |
||||||
|
bool stride_compatible() const { |
||||||
|
// To have compatible strides, we need (on both dimensions) one of fully dynamic strides,
|
||||||
|
// matching strides, or a dimension size of 1 (in which case the stride value is
|
||||||
|
// irrelevant). Alternatively, if any dimension size is 0, the strides are not relevant
|
||||||
|
// (and numpy ≥ 1.23 sets the strides to 0 in that case, so we need to check explicitly).
|
||||||
|
if (negativestrides) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
if (rows == 0 || cols == 0) { |
||||||
|
return true; |
||||||
|
} |
||||||
|
return (props::inner_stride == Eigen::Dynamic || props::inner_stride == stride.inner() |
||||||
|
|| (EigenRowMajor ? cols : rows) == 1) |
||||||
|
&& (props::outer_stride == Eigen::Dynamic || props::outer_stride == stride.outer() |
||||||
|
|| (EigenRowMajor ? rows : cols) == 1); |
||||||
|
} |
||||||
|
// NOLINTNEXTLINE(google-explicit-constructor)
|
||||||
|
operator bool() const { return conformable; } |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename Type> |
||||||
|
struct eigen_extract_stride { |
||||||
|
using type = Type; |
||||||
|
}; |
||||||
|
template <typename PlainObjectType, int MapOptions, typename StrideType> |
||||||
|
struct eigen_extract_stride<Eigen::Map<PlainObjectType, MapOptions, StrideType>> { |
||||||
|
using type = StrideType; |
||||||
|
}; |
||||||
|
template <typename PlainObjectType, int Options, typename StrideType> |
||||||
|
struct eigen_extract_stride<Eigen::Ref<PlainObjectType, Options, StrideType>> { |
||||||
|
using type = StrideType; |
||||||
|
}; |
||||||
|
|
||||||
|
// Helper struct for extracting information from an Eigen type
|
||||||
|
template <typename Type_> |
||||||
|
struct EigenProps { |
||||||
|
using Type = Type_; |
||||||
|
using Scalar = typename Type::Scalar; |
||||||
|
using StrideType = typename eigen_extract_stride<Type>::type; |
||||||
|
static constexpr EigenIndex rows = Type::RowsAtCompileTime, cols = Type::ColsAtCompileTime, |
||||||
|
size = Type::SizeAtCompileTime; |
||||||
|
static constexpr bool row_major = Type::IsRowMajor, |
||||||
|
vector |
||||||
|
= Type::IsVectorAtCompileTime, // At least one dimension has fixed size 1
|
||||||
|
fixed_rows = rows != Eigen::Dynamic, fixed_cols = cols != Eigen::Dynamic, |
||||||
|
fixed = size != Eigen::Dynamic, // Fully-fixed size
|
||||||
|
dynamic = !fixed_rows && !fixed_cols; // Fully-dynamic size
|
||||||
|
|
||||||
|
template <EigenIndex i, EigenIndex ifzero> |
||||||
|
using if_zero = std::integral_constant<EigenIndex, i == 0 ? ifzero : i>; |
||||||
|
static constexpr EigenIndex inner_stride |
||||||
|
= if_zero<StrideType::InnerStrideAtCompileTime, 1>::value, |
||||||
|
outer_stride = if_zero < StrideType::OuterStrideAtCompileTime, |
||||||
|
vector ? size |
||||||
|
: row_major ? cols |
||||||
|
: rows > ::value; |
||||||
|
static constexpr bool dynamic_stride |
||||||
|
= inner_stride == Eigen::Dynamic && outer_stride == Eigen::Dynamic; |
||||||
|
static constexpr bool requires_row_major |
||||||
|
= !dynamic_stride && !vector && (row_major ? inner_stride : outer_stride) == 1; |
||||||
|
static constexpr bool requires_col_major |
||||||
|
= !dynamic_stride && !vector && (row_major ? outer_stride : inner_stride) == 1; |
||||||
|
|
||||||
|
// Takes an input array and determines whether we can make it fit into the Eigen type. If
|
||||||
|
// the array is a vector, we attempt to fit it into either an Eigen 1xN or Nx1 vector
|
||||||
|
// (preferring the latter if it will fit in either, i.e. for a fully dynamic matrix type).
|
||||||
|
static EigenConformable<row_major> conformable(const array &a) { |
||||||
|
const auto dims = a.ndim(); |
||||||
|
if (dims < 1 || dims > 2) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
if (dims == 2) { // Matrix type: require exact match (or dynamic)
|
||||||
|
|
||||||
|
EigenIndex np_rows = a.shape(0), np_cols = a.shape(1), |
||||||
|
np_rstride = a.strides(0) / static_cast<ssize_t>(sizeof(Scalar)), |
||||||
|
np_cstride = a.strides(1) / static_cast<ssize_t>(sizeof(Scalar)); |
||||||
|
if ((fixed_rows && np_rows != rows) || (fixed_cols && np_cols != cols)) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
return {np_rows, np_cols, np_rstride, np_cstride}; |
||||||
|
} |
||||||
|
|
||||||
|
// Otherwise we're storing an n-vector. Only one of the strides will be used, but
|
||||||
|
// whichever is used, we want the (single) numpy stride value.
|
||||||
|
const EigenIndex n = a.shape(0), |
||||||
|
stride = a.strides(0) / static_cast<ssize_t>(sizeof(Scalar)); |
||||||
|
|
||||||
|
if (vector) { // Eigen type is a compile-time vector
|
||||||
|
if (fixed && size != n) { |
||||||
|
return false; // Vector size mismatch
|
||||||
|
} |
||||||
|
return {rows == 1 ? 1 : n, cols == 1 ? 1 : n, stride}; |
||||||
|
} |
||||||
|
if (fixed) { |
||||||
|
// The type has a fixed size, but is not a vector: abort
|
||||||
|
return false; |
||||||
|
} |
||||||
|
if (fixed_cols) { |
||||||
|
// Since this isn't a vector, cols must be != 1. We allow this only if it exactly
|
||||||
|
// equals the number of elements (rows is Dynamic, and so 1 row is allowed).
|
||||||
|
if (cols != n) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
return {1, n, stride}; |
||||||
|
} // Otherwise it's either fully dynamic, or column dynamic; both become a column vector
|
||||||
|
if (fixed_rows && rows != n) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
return {n, 1, stride}; |
||||||
|
} |
||||||
|
|
||||||
|
static constexpr bool show_writeable |
||||||
|
= is_eigen_dense_map<Type>::value && is_eigen_mutable_map<Type>::value; |
||||||
|
static constexpr bool show_order = is_eigen_dense_map<Type>::value; |
||||||
|
static constexpr bool show_c_contiguous = show_order && requires_row_major; |
||||||
|
static constexpr bool show_f_contiguous |
||||||
|
= !show_c_contiguous && show_order && requires_col_major; |
||||||
|
|
||||||
|
static constexpr auto descriptor |
||||||
|
= const_name("numpy.ndarray[") + npy_format_descriptor<Scalar>::name + const_name("[") |
||||||
|
+ const_name<fixed_rows>(const_name<(size_t) rows>(), const_name("m")) + const_name(", ") |
||||||
|
+ const_name<fixed_cols>(const_name<(size_t) cols>(), const_name("n")) + const_name("]") |
||||||
|
+ |
||||||
|
// For a reference type (e.g. Ref<MatrixXd>) we have other constraints that might need to
|
||||||
|
// be satisfied: writeable=True (for a mutable reference), and, depending on the map's
|
||||||
|
// stride options, possibly f_contiguous or c_contiguous. We include them in the
|
||||||
|
// descriptor output to provide some hint as to why a TypeError is occurring (otherwise
|
||||||
|
// it can be confusing to see that a function accepts a 'numpy.ndarray[float64[3,2]]' and
|
||||||
|
// an error message that you *gave* a numpy.ndarray of the right type and dimensions.
|
||||||
|
const_name<show_writeable>(", flags.writeable", "") |
||||||
|
+ const_name<show_c_contiguous>(", flags.c_contiguous", "") |
||||||
|
+ const_name<show_f_contiguous>(", flags.f_contiguous", "") + const_name("]"); |
||||||
|
}; |
||||||
|
|
||||||
|
// Casts an Eigen type to numpy array. If given a base, the numpy array references the src data,
|
||||||
|
// otherwise it'll make a copy. writeable lets you turn off the writeable flag for the array.
|
||||||
|
template <typename props> |
||||||
|
handle |
||||||
|
eigen_array_cast(typename props::Type const &src, handle base = handle(), bool writeable = true) { |
||||||
|
constexpr ssize_t elem_size = sizeof(typename props::Scalar); |
||||||
|
array a; |
||||||
|
if (props::vector) { |
||||||
|
a = array({src.size()}, {elem_size * src.innerStride()}, src.data(), base); |
||||||
|
} else { |
||||||
|
a = array({src.rows(), src.cols()}, |
||||||
|
{elem_size * src.rowStride(), elem_size * src.colStride()}, |
||||||
|
src.data(), |
||||||
|
base); |
||||||
|
} |
||||||
|
|
||||||
|
if (!writeable) { |
||||||
|
array_proxy(a.ptr())->flags &= ~detail::npy_api::NPY_ARRAY_WRITEABLE_; |
||||||
|
} |
||||||
|
|
||||||
|
return a.release(); |
||||||
|
} |
||||||
|
|
||||||
|
// Takes an lvalue ref to some Eigen type and a (python) base object, creating a numpy array that
|
||||||
|
// reference the Eigen object's data with `base` as the python-registered base class (if omitted,
|
||||||
|
// the base will be set to None, and lifetime management is up to the caller). The numpy array is
|
||||||
|
// non-writeable if the given type is const.
|
||||||
|
template <typename props, typename Type> |
||||||
|
handle eigen_ref_array(Type &src, handle parent = none()) { |
||||||
|
// none here is to get past array's should-we-copy detection, which currently always
|
||||||
|
// copies when there is no base. Setting the base to None should be harmless.
|
||||||
|
return eigen_array_cast<props>(src, parent, !std::is_const<Type>::value); |
||||||
|
} |
||||||
|
|
||||||
|
// Takes a pointer to some dense, plain Eigen type, builds a capsule around it, then returns a
|
||||||
|
// numpy array that references the encapsulated data with a python-side reference to the capsule to
|
||||||
|
// tie its destruction to that of any dependent python objects. Const-ness is determined by
|
||||||
|
// whether or not the Type of the pointer given is const.
|
||||||
|
template <typename props, typename Type, typename = enable_if_t<is_eigen_dense_plain<Type>::value>> |
||||||
|
handle eigen_encapsulate(Type *src) { |
||||||
|
capsule base(src, [](void *o) { delete static_cast<Type *>(o); }); |
||||||
|
return eigen_ref_array<props>(*src, base); |
||||||
|
} |
||||||
|
|
||||||
|
// Type caster for regular, dense matrix types (e.g. MatrixXd), but not maps/refs/etc. of dense
|
||||||
|
// types.
|
||||||
|
template <typename Type> |
||||||
|
struct type_caster<Type, enable_if_t<is_eigen_dense_plain<Type>::value>> { |
||||||
|
using Scalar = typename Type::Scalar; |
||||||
|
using props = EigenProps<Type>; |
||||||
|
|
||||||
|
bool load(handle src, bool convert) { |
||||||
|
// If we're in no-convert mode, only load if given an array of the correct type
|
||||||
|
if (!convert && !isinstance<array_t<Scalar>>(src)) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
// Coerce into an array, but don't do type conversion yet; the copy below handles it.
|
||||||
|
auto buf = array::ensure(src); |
||||||
|
|
||||||
|
if (!buf) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
auto dims = buf.ndim(); |
||||||
|
if (dims < 1 || dims > 2) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
auto fits = props::conformable(buf); |
||||||
|
if (!fits) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
// Allocate the new type, then build a numpy reference into it
|
||||||
|
value = Type(fits.rows, fits.cols); |
||||||
|
auto ref = reinterpret_steal<array>(eigen_ref_array<props>(value)); |
||||||
|
if (dims == 1) { |
||||||
|
ref = ref.squeeze(); |
||||||
|
} else if (ref.ndim() == 1) { |
||||||
|
buf = buf.squeeze(); |
||||||
|
} |
||||||
|
|
||||||
|
int result = detail::npy_api::get().PyArray_CopyInto_(ref.ptr(), buf.ptr()); |
||||||
|
|
||||||
|
if (result < 0) { // Copy failed!
|
||||||
|
PyErr_Clear(); |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
// Cast implementation
|
||||||
|
template <typename CType> |
||||||
|
static handle cast_impl(CType *src, return_value_policy policy, handle parent) { |
||||||
|
switch (policy) { |
||||||
|
case return_value_policy::take_ownership: |
||||||
|
case return_value_policy::automatic: |
||||||
|
return eigen_encapsulate<props>(src); |
||||||
|
case return_value_policy::move: |
||||||
|
return eigen_encapsulate<props>(new CType(std::move(*src))); |
||||||
|
case return_value_policy::copy: |
||||||
|
return eigen_array_cast<props>(*src); |
||||||
|
case return_value_policy::reference: |
||||||
|
case return_value_policy::automatic_reference: |
||||||
|
return eigen_ref_array<props>(*src); |
||||||
|
case return_value_policy::reference_internal: |
||||||
|
return eigen_ref_array<props>(*src, parent); |
||||||
|
default: |
||||||
|
throw cast_error("unhandled return_value_policy: should not happen!"); |
||||||
|
}; |
||||||
|
} |
||||||
|
|
||||||
|
public: |
||||||
|
// Normal returned non-reference, non-const value:
|
||||||
|
static handle cast(Type &&src, return_value_policy /* policy */, handle parent) { |
||||||
|
return cast_impl(&src, return_value_policy::move, parent); |
||||||
|
} |
||||||
|
// If you return a non-reference const, we mark the numpy array readonly:
|
||||||
|
static handle cast(const Type &&src, return_value_policy /* policy */, handle parent) { |
||||||
|
return cast_impl(&src, return_value_policy::move, parent); |
||||||
|
} |
||||||
|
// lvalue reference return; default (automatic) becomes copy
|
||||||
|
static handle cast(Type &src, return_value_policy policy, handle parent) { |
||||||
|
if (policy == return_value_policy::automatic |
||||||
|
|| policy == return_value_policy::automatic_reference) { |
||||||
|
policy = return_value_policy::copy; |
||||||
|
} |
||||||
|
return cast_impl(&src, policy, parent); |
||||||
|
} |
||||||
|
// const lvalue reference return; default (automatic) becomes copy
|
||||||
|
static handle cast(const Type &src, return_value_policy policy, handle parent) { |
||||||
|
if (policy == return_value_policy::automatic |
||||||
|
|| policy == return_value_policy::automatic_reference) { |
||||||
|
policy = return_value_policy::copy; |
||||||
|
} |
||||||
|
return cast(&src, policy, parent); |
||||||
|
} |
||||||
|
// non-const pointer return
|
||||||
|
static handle cast(Type *src, return_value_policy policy, handle parent) { |
||||||
|
return cast_impl(src, policy, parent); |
||||||
|
} |
||||||
|
// const pointer return
|
||||||
|
static handle cast(const Type *src, return_value_policy policy, handle parent) { |
||||||
|
return cast_impl(src, policy, parent); |
||||||
|
} |
||||||
|
|
||||||
|
static constexpr auto name = props::descriptor; |
||||||
|
|
||||||
|
// NOLINTNEXTLINE(google-explicit-constructor)
|
||||||
|
operator Type *() { return &value; } |
||||||
|
// NOLINTNEXTLINE(google-explicit-constructor)
|
||||||
|
operator Type &() { return value; } |
||||||
|
// NOLINTNEXTLINE(google-explicit-constructor)
|
||||||
|
operator Type &&() && { return std::move(value); } |
||||||
|
template <typename T> |
||||||
|
using cast_op_type = movable_cast_op_type<T>; |
||||||
|
|
||||||
|
private: |
||||||
|
Type value; |
||||||
|
}; |
||||||
|
|
||||||
|
// Base class for casting reference/map/block/etc. objects back to python.
|
||||||
|
template <typename MapType> |
||||||
|
struct eigen_map_caster { |
||||||
|
private: |
||||||
|
using props = EigenProps<MapType>; |
||||||
|
|
||||||
|
public: |
||||||
|
// Directly referencing a ref/map's data is a bit dangerous (whatever the map/ref points to has
|
||||||
|
// to stay around), but we'll allow it under the assumption that you know what you're doing
|
||||||
|
// (and have an appropriate keep_alive in place). We return a numpy array pointing directly at
|
||||||
|
// the ref's data (The numpy array ends up read-only if the ref was to a const matrix type.)
|
||||||
|
// Note that this means you need to ensure you don't destroy the object in some other way (e.g.
|
||||||
|
// with an appropriate keep_alive, or with a reference to a statically allocated matrix).
|
||||||
|
static handle cast(const MapType &src, return_value_policy policy, handle parent) { |
||||||
|
switch (policy) { |
||||||
|
case return_value_policy::copy: |
||||||
|
return eigen_array_cast<props>(src); |
||||||
|
case return_value_policy::reference_internal: |
||||||
|
return eigen_array_cast<props>(src, parent, is_eigen_mutable_map<MapType>::value); |
||||||
|
case return_value_policy::reference: |
||||||
|
case return_value_policy::automatic: |
||||||
|
case return_value_policy::automatic_reference: |
||||||
|
return eigen_array_cast<props>(src, none(), is_eigen_mutable_map<MapType>::value); |
||||||
|
default: |
||||||
|
// move, take_ownership don't make any sense for a ref/map:
|
||||||
|
pybind11_fail("Invalid return_value_policy for Eigen Map/Ref/Block type"); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
static constexpr auto name = props::descriptor; |
||||||
|
|
||||||
|
// Explicitly delete these: support python -> C++ conversion on these (i.e. these can be return
|
||||||
|
// types but not bound arguments). We still provide them (with an explicitly delete) so that
|
||||||
|
// you end up here if you try anyway.
|
||||||
|
bool load(handle, bool) = delete; |
||||||
|
operator MapType() = delete; |
||||||
|
template <typename> |
||||||
|
using cast_op_type = MapType; |
||||||
|
}; |
||||||
|
|
||||||
|
// We can return any map-like object (but can only load Refs, specialized next):
|
||||||
|
template <typename Type> |
||||||
|
struct type_caster<Type, enable_if_t<is_eigen_dense_map<Type>::value>> : eigen_map_caster<Type> {}; |
||||||
|
|
||||||
|
// Loader for Ref<...> arguments. See the documentation for info on how to make this work without
|
||||||
|
// copying (it requires some extra effort in many cases).
|
||||||
|
template <typename PlainObjectType, typename StrideType> |
||||||
|
struct type_caster< |
||||||
|
Eigen::Ref<PlainObjectType, 0, StrideType>, |
||||||
|
enable_if_t<is_eigen_dense_map<Eigen::Ref<PlainObjectType, 0, StrideType>>::value>> |
||||||
|
: public eigen_map_caster<Eigen::Ref<PlainObjectType, 0, StrideType>> { |
||||||
|
private: |
||||||
|
using Type = Eigen::Ref<PlainObjectType, 0, StrideType>; |
||||||
|
using props = EigenProps<Type>; |
||||||
|
using Scalar = typename props::Scalar; |
||||||
|
using MapType = Eigen::Map<PlainObjectType, 0, StrideType>; |
||||||
|
using Array |
||||||
|
= array_t<Scalar, |
||||||
|
array::forcecast |
||||||
|
| ((props::row_major ? props::inner_stride : props::outer_stride) == 1 |
||||||
|
? array::c_style |
||||||
|
: (props::row_major ? props::outer_stride : props::inner_stride) == 1 |
||||||
|
? array::f_style |
||||||
|
: 0)>; |
||||||
|
static constexpr bool need_writeable = is_eigen_mutable_map<Type>::value; |
||||||
|
// Delay construction (these have no default constructor)
|
||||||
|
std::unique_ptr<MapType> map; |
||||||
|
std::unique_ptr<Type> ref; |
||||||
|
// Our array. When possible, this is just a numpy array pointing to the source data, but
|
||||||
|
// sometimes we can't avoid copying (e.g. input is not a numpy array at all, has an
|
||||||
|
// incompatible layout, or is an array of a type that needs to be converted). Using a numpy
|
||||||
|
// temporary (rather than an Eigen temporary) saves an extra copy when we need both type
|
||||||
|
// conversion and storage order conversion. (Note that we refuse to use this temporary copy
|
||||||
|
// when loading an argument for a Ref<M> with M non-const, i.e. a read-write reference).
|
||||||
|
Array copy_or_ref; |
||||||
|
|
||||||
|
public: |
||||||
|
bool load(handle src, bool convert) { |
||||||
|
// First check whether what we have is already an array of the right type. If not, we
|
||||||
|
// can't avoid a copy (because the copy is also going to do type conversion).
|
||||||
|
bool need_copy = !isinstance<Array>(src); |
||||||
|
|
||||||
|
EigenConformable<props::row_major> fits; |
||||||
|
if (!need_copy) { |
||||||
|
// We don't need a converting copy, but we also need to check whether the strides are
|
||||||
|
// compatible with the Ref's stride requirements
|
||||||
|
auto aref = reinterpret_borrow<Array>(src); |
||||||
|
|
||||||
|
if (aref && (!need_writeable || aref.writeable())) { |
||||||
|
fits = props::conformable(aref); |
||||||
|
if (!fits) { |
||||||
|
return false; // Incompatible dimensions
|
||||||
|
} |
||||||
|
if (!fits.template stride_compatible<props>()) { |
||||||
|
need_copy = true; |
||||||
|
} else { |
||||||
|
copy_or_ref = std::move(aref); |
||||||
|
} |
||||||
|
} else { |
||||||
|
need_copy = true; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
if (need_copy) { |
||||||
|
// We need to copy: If we need a mutable reference, or we're not supposed to convert
|
||||||
|
// (either because we're in the no-convert overload pass, or because we're explicitly
|
||||||
|
// instructed not to copy (via `py::arg().noconvert()`) we have to fail loading.
|
||||||
|
if (!convert || need_writeable) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
Array copy = Array::ensure(src); |
||||||
|
if (!copy) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
fits = props::conformable(copy); |
||||||
|
if (!fits || !fits.template stride_compatible<props>()) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
copy_or_ref = std::move(copy); |
||||||
|
loader_life_support::add_patient(copy_or_ref); |
||||||
|
} |
||||||
|
|
||||||
|
ref.reset(); |
||||||
|
map.reset(new MapType(data(copy_or_ref), |
||||||
|
fits.rows, |
||||||
|
fits.cols, |
||||||
|
make_stride(fits.stride.outer(), fits.stride.inner()))); |
||||||
|
ref.reset(new Type(*map)); |
||||||
|
|
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
// NOLINTNEXTLINE(google-explicit-constructor)
|
||||||
|
operator Type *() { return ref.get(); } |
||||||
|
// NOLINTNEXTLINE(google-explicit-constructor)
|
||||||
|
operator Type &() { return *ref; } |
||||||
|
template <typename _T> |
||||||
|
using cast_op_type = pybind11::detail::cast_op_type<_T>; |
||||||
|
|
||||||
|
private: |
||||||
|
template <typename T = Type, enable_if_t<is_eigen_mutable_map<T>::value, int> = 0> |
||||||
|
Scalar *data(Array &a) { |
||||||
|
return a.mutable_data(); |
||||||
|
} |
||||||
|
|
||||||
|
template <typename T = Type, enable_if_t<!is_eigen_mutable_map<T>::value, int> = 0> |
||||||
|
const Scalar *data(Array &a) { |
||||||
|
return a.data(); |
||||||
|
} |
||||||
|
|
||||||
|
// Attempt to figure out a constructor of `Stride` that will work.
|
||||||
|
// If both strides are fixed, use a default constructor:
|
||||||
|
template <typename S> |
||||||
|
using stride_ctor_default = bool_constant<S::InnerStrideAtCompileTime != Eigen::Dynamic |
||||||
|
&& S::OuterStrideAtCompileTime != Eigen::Dynamic |
||||||
|
&& std::is_default_constructible<S>::value>; |
||||||
|
// Otherwise, if there is a two-index constructor, assume it is (outer,inner) like
|
||||||
|
// Eigen::Stride, and use it:
|
||||||
|
template <typename S> |
||||||
|
using stride_ctor_dual |
||||||
|
= bool_constant<!stride_ctor_default<S>::value |
||||||
|
&& std::is_constructible<S, EigenIndex, EigenIndex>::value>; |
||||||
|
// Otherwise, if there is a one-index constructor, and just one of the strides is dynamic, use
|
||||||
|
// it (passing whichever stride is dynamic).
|
||||||
|
template <typename S> |
||||||
|
using stride_ctor_outer |
||||||
|
= bool_constant<!any_of<stride_ctor_default<S>, stride_ctor_dual<S>>::value |
||||||
|
&& S::OuterStrideAtCompileTime == Eigen::Dynamic |
||||||
|
&& S::InnerStrideAtCompileTime != Eigen::Dynamic |
||||||
|
&& std::is_constructible<S, EigenIndex>::value>; |
||||||
|
template <typename S> |
||||||
|
using stride_ctor_inner |
||||||
|
= bool_constant<!any_of<stride_ctor_default<S>, stride_ctor_dual<S>>::value |
||||||
|
&& S::InnerStrideAtCompileTime == Eigen::Dynamic |
||||||
|
&& S::OuterStrideAtCompileTime != Eigen::Dynamic |
||||||
|
&& std::is_constructible<S, EigenIndex>::value>; |
||||||
|
|
||||||
|
template <typename S = StrideType, enable_if_t<stride_ctor_default<S>::value, int> = 0> |
||||||
|
static S make_stride(EigenIndex, EigenIndex) { |
||||||
|
return S(); |
||||||
|
} |
||||||
|
template <typename S = StrideType, enable_if_t<stride_ctor_dual<S>::value, int> = 0> |
||||||
|
static S make_stride(EigenIndex outer, EigenIndex inner) { |
||||||
|
return S(outer, inner); |
||||||
|
} |
||||||
|
template <typename S = StrideType, enable_if_t<stride_ctor_outer<S>::value, int> = 0> |
||||||
|
static S make_stride(EigenIndex outer, EigenIndex) { |
||||||
|
return S(outer); |
||||||
|
} |
||||||
|
template <typename S = StrideType, enable_if_t<stride_ctor_inner<S>::value, int> = 0> |
||||||
|
static S make_stride(EigenIndex, EigenIndex inner) { |
||||||
|
return S(inner); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
// type_caster for special matrix types (e.g. DiagonalMatrix), which are EigenBase, but not
|
||||||
|
// EigenDense (i.e. they don't have a data(), at least not with the usual matrix layout).
|
||||||
|
// load() is not supported, but we can cast them into the python domain by first copying to a
|
||||||
|
// regular Eigen::Matrix, then casting that.
|
||||||
|
template <typename Type> |
||||||
|
struct type_caster<Type, enable_if_t<is_eigen_other<Type>::value>> { |
||||||
|
protected: |
||||||
|
using Matrix |
||||||
|
= Eigen::Matrix<typename Type::Scalar, Type::RowsAtCompileTime, Type::ColsAtCompileTime>; |
||||||
|
using props = EigenProps<Matrix>; |
||||||
|
|
||||||
|
public: |
||||||
|
static handle cast(const Type &src, return_value_policy /* policy */, handle /* parent */) { |
||||||
|
handle h = eigen_encapsulate<props>(new Matrix(src)); |
||||||
|
return h; |
||||||
|
} |
||||||
|
static handle cast(const Type *src, return_value_policy policy, handle parent) { |
||||||
|
return cast(*src, policy, parent); |
||||||
|
} |
||||||
|
|
||||||
|
static constexpr auto name = props::descriptor; |
||||||
|
|
||||||
|
// Explicitly delete these: support python -> C++ conversion on these (i.e. these can be return
|
||||||
|
// types but not bound arguments). We still provide them (with an explicitly delete) so that
|
||||||
|
// you end up here if you try anyway.
|
||||||
|
bool load(handle, bool) = delete; |
||||||
|
operator Type() = delete; |
||||||
|
template <typename> |
||||||
|
using cast_op_type = Type; |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename Type> |
||||||
|
struct type_caster<Type, enable_if_t<is_eigen_sparse<Type>::value>> { |
||||||
|
using Scalar = typename Type::Scalar; |
||||||
|
using StorageIndex = remove_reference_t<decltype(*std::declval<Type>().outerIndexPtr())>; |
||||||
|
using Index = typename Type::Index; |
||||||
|
static constexpr bool rowMajor = Type::IsRowMajor; |
||||||
|
|
||||||
|
bool load(handle src, bool) { |
||||||
|
if (!src) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
auto obj = reinterpret_borrow<object>(src); |
||||||
|
object sparse_module = module_::import("scipy.sparse"); |
||||||
|
object matrix_type = sparse_module.attr(rowMajor ? "csr_matrix" : "csc_matrix"); |
||||||
|
|
||||||
|
if (!type::handle_of(obj).is(matrix_type)) { |
||||||
|
try { |
||||||
|
obj = matrix_type(obj); |
||||||
|
} catch (const error_already_set &) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
auto values = array_t<Scalar>((object) obj.attr("data")); |
||||||
|
auto innerIndices = array_t<StorageIndex>((object) obj.attr("indices")); |
||||||
|
auto outerIndices = array_t<StorageIndex>((object) obj.attr("indptr")); |
||||||
|
auto shape = pybind11::tuple((pybind11::object) obj.attr("shape")); |
||||||
|
auto nnz = obj.attr("nnz").cast<Index>(); |
||||||
|
|
||||||
|
if (!values || !innerIndices || !outerIndices) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
value = EigenMapSparseMatrix<Scalar, |
||||||
|
Type::Flags &(Eigen::RowMajor | Eigen::ColMajor), |
||||||
|
StorageIndex>(shape[0].cast<Index>(), |
||||||
|
shape[1].cast<Index>(), |
||||||
|
std::move(nnz), |
||||||
|
outerIndices.mutable_data(), |
||||||
|
innerIndices.mutable_data(), |
||||||
|
values.mutable_data()); |
||||||
|
|
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
static handle cast(const Type &src, return_value_policy /* policy */, handle /* parent */) { |
||||||
|
const_cast<Type &>(src).makeCompressed(); |
||||||
|
|
||||||
|
object matrix_type |
||||||
|
= module_::import("scipy.sparse").attr(rowMajor ? "csr_matrix" : "csc_matrix"); |
||||||
|
|
||||||
|
array data(src.nonZeros(), src.valuePtr()); |
||||||
|
array outerIndices((rowMajor ? src.rows() : src.cols()) + 1, src.outerIndexPtr()); |
||||||
|
array innerIndices(src.nonZeros(), src.innerIndexPtr()); |
||||||
|
|
||||||
|
return matrix_type(pybind11::make_tuple( |
||||||
|
std::move(data), std::move(innerIndices), std::move(outerIndices)), |
||||||
|
pybind11::make_tuple(src.rows(), src.cols())) |
||||||
|
.release(); |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_TYPE_CASTER(Type, |
||||||
|
const_name<(Type::IsRowMajor) != 0>("scipy.sparse.csr_matrix[", |
||||||
|
"scipy.sparse.csc_matrix[") |
||||||
|
+ npy_format_descriptor<Scalar>::name + const_name("]")); |
||||||
|
}; |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
@ -0,0 +1,511 @@ |
|||||||
|
/*
|
||||||
|
pybind11/eigen/tensor.h: Transparent conversion for Eigen tensors |
||||||
|
|
||||||
|
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 "../numpy.h" |
||||||
|
|
||||||
|
#if defined(__GNUC__) && !defined(__clang__) && !defined(__INTEL_COMPILER) |
||||||
|
static_assert(__GNUC__ > 5, "Eigen Tensor support in pybind11 requires GCC > 5.0"); |
||||||
|
#endif |
||||||
|
|
||||||
|
// Disable warnings for Eigen
|
||||||
|
PYBIND11_WARNING_PUSH |
||||||
|
PYBIND11_WARNING_DISABLE_MSVC(4554) |
||||||
|
PYBIND11_WARNING_DISABLE_MSVC(4127) |
||||||
|
#if defined(__MINGW32__) |
||||||
|
PYBIND11_WARNING_DISABLE_GCC("-Wmaybe-uninitialized") |
||||||
|
#endif |
||||||
|
|
||||||
|
#include <unsupported/Eigen/CXX11/Tensor> |
||||||
|
|
||||||
|
PYBIND11_WARNING_POP |
||||||
|
|
||||||
|
static_assert(EIGEN_VERSION_AT_LEAST(3, 3, 0), |
||||||
|
"Eigen Tensor support in pybind11 requires Eigen >= 3.3.0"); |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
|
||||||
|
PYBIND11_WARNING_DISABLE_MSVC(4127) |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
inline bool is_tensor_aligned(const void *data) { |
||||||
|
return (reinterpret_cast<std::size_t>(data) % EIGEN_DEFAULT_ALIGN_BYTES) == 0; |
||||||
|
} |
||||||
|
|
||||||
|
template <typename T> |
||||||
|
constexpr int compute_array_flag_from_tensor() { |
||||||
|
static_assert((static_cast<int>(T::Layout) == static_cast<int>(Eigen::RowMajor)) |
||||||
|
|| (static_cast<int>(T::Layout) == static_cast<int>(Eigen::ColMajor)), |
||||||
|
"Layout must be row or column major"); |
||||||
|
return (static_cast<int>(T::Layout) == static_cast<int>(Eigen::RowMajor)) ? array::c_style |
||||||
|
: array::f_style; |
||||||
|
} |
||||||
|
|
||||||
|
template <typename T> |
||||||
|
struct eigen_tensor_helper {}; |
||||||
|
|
||||||
|
template <typename Scalar_, int NumIndices_, int Options_, typename IndexType> |
||||||
|
struct eigen_tensor_helper<Eigen::Tensor<Scalar_, NumIndices_, Options_, IndexType>> { |
||||||
|
using Type = Eigen::Tensor<Scalar_, NumIndices_, Options_, IndexType>; |
||||||
|
using ValidType = void; |
||||||
|
|
||||||
|
static Eigen::DSizes<typename Type::Index, Type::NumIndices> get_shape(const Type &f) { |
||||||
|
return f.dimensions(); |
||||||
|
} |
||||||
|
|
||||||
|
static constexpr bool |
||||||
|
is_correct_shape(const Eigen::DSizes<typename Type::Index, Type::NumIndices> & /*shape*/) { |
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
template <typename T> |
||||||
|
struct helper {}; |
||||||
|
|
||||||
|
template <size_t... Is> |
||||||
|
struct helper<index_sequence<Is...>> { |
||||||
|
static constexpr auto value = concat(const_name(((void) Is, "?"))...); |
||||||
|
}; |
||||||
|
|
||||||
|
static constexpr auto dimensions_descriptor |
||||||
|
= helper<decltype(make_index_sequence<Type::NumIndices>())>::value; |
||||||
|
|
||||||
|
template <typename... Args> |
||||||
|
static Type *alloc(Args &&...args) { |
||||||
|
return new Type(std::forward<Args>(args)...); |
||||||
|
} |
||||||
|
|
||||||
|
static void free(Type *tensor) { delete tensor; } |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename Scalar_, typename std::ptrdiff_t... Indices, int Options_, typename IndexType> |
||||||
|
struct eigen_tensor_helper< |
||||||
|
Eigen::TensorFixedSize<Scalar_, Eigen::Sizes<Indices...>, Options_, IndexType>> { |
||||||
|
using Type = Eigen::TensorFixedSize<Scalar_, Eigen::Sizes<Indices...>, Options_, IndexType>; |
||||||
|
using ValidType = void; |
||||||
|
|
||||||
|
static constexpr Eigen::DSizes<typename Type::Index, Type::NumIndices> |
||||||
|
get_shape(const Type & /*f*/) { |
||||||
|
return get_shape(); |
||||||
|
} |
||||||
|
|
||||||
|
static constexpr Eigen::DSizes<typename Type::Index, Type::NumIndices> get_shape() { |
||||||
|
return Eigen::DSizes<typename Type::Index, Type::NumIndices>(Indices...); |
||||||
|
} |
||||||
|
|
||||||
|
static bool |
||||||
|
is_correct_shape(const Eigen::DSizes<typename Type::Index, Type::NumIndices> &shape) { |
||||||
|
return get_shape() == shape; |
||||||
|
} |
||||||
|
|
||||||
|
static constexpr auto dimensions_descriptor = concat(const_name<Indices>()...); |
||||||
|
|
||||||
|
template <typename... Args> |
||||||
|
static Type *alloc(Args &&...args) { |
||||||
|
Eigen::aligned_allocator<Type> allocator; |
||||||
|
return ::new (allocator.allocate(1)) Type(std::forward<Args>(args)...); |
||||||
|
} |
||||||
|
|
||||||
|
static void free(Type *tensor) { |
||||||
|
Eigen::aligned_allocator<Type> allocator; |
||||||
|
tensor->~Type(); |
||||||
|
allocator.deallocate(tensor, 1); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename Type, bool ShowDetails, bool NeedsWriteable = false> |
||||||
|
struct get_tensor_descriptor { |
||||||
|
static constexpr auto details |
||||||
|
= const_name<NeedsWriteable>(", flags.writeable", "") |
||||||
|
+ const_name<static_cast<int>(Type::Layout) == static_cast<int>(Eigen::RowMajor)>( |
||||||
|
", flags.c_contiguous", ", flags.f_contiguous"); |
||||||
|
static constexpr auto value |
||||||
|
= const_name("numpy.ndarray[") + npy_format_descriptor<typename Type::Scalar>::name |
||||||
|
+ const_name("[") + eigen_tensor_helper<remove_cv_t<Type>>::dimensions_descriptor |
||||||
|
+ const_name("]") + const_name<ShowDetails>(details, const_name("")) + const_name("]"); |
||||||
|
}; |
||||||
|
|
||||||
|
// When EIGEN_AVOID_STL_ARRAY is defined, Eigen::DSizes<T, 0> does not have the begin() member
|
||||||
|
// function. Falling back to a simple loop works around this issue.
|
||||||
|
//
|
||||||
|
// We need to disable the type-limits warning for the inner loop when size = 0.
|
||||||
|
|
||||||
|
PYBIND11_WARNING_PUSH |
||||||
|
PYBIND11_WARNING_DISABLE_GCC("-Wtype-limits") |
||||||
|
|
||||||
|
template <typename T, int size> |
||||||
|
std::vector<T> convert_dsizes_to_vector(const Eigen::DSizes<T, size> &arr) { |
||||||
|
std::vector<T> result(size); |
||||||
|
|
||||||
|
for (size_t i = 0; i < size; i++) { |
||||||
|
result[i] = arr[i]; |
||||||
|
} |
||||||
|
|
||||||
|
return result; |
||||||
|
} |
||||||
|
|
||||||
|
template <typename T, int size> |
||||||
|
Eigen::DSizes<T, size> get_shape_for_array(const array &arr) { |
||||||
|
Eigen::DSizes<T, size> result; |
||||||
|
const T *shape = arr.shape(); |
||||||
|
for (size_t i = 0; i < size; i++) { |
||||||
|
result[i] = shape[i]; |
||||||
|
} |
||||||
|
|
||||||
|
return result; |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_WARNING_POP |
||||||
|
|
||||||
|
template <typename Type> |
||||||
|
struct type_caster<Type, typename eigen_tensor_helper<Type>::ValidType> { |
||||||
|
using Helper = eigen_tensor_helper<Type>; |
||||||
|
static constexpr auto temp_name = get_tensor_descriptor<Type, false>::value; |
||||||
|
PYBIND11_TYPE_CASTER(Type, temp_name); |
||||||
|
|
||||||
|
bool load(handle src, bool convert) { |
||||||
|
if (!convert) { |
||||||
|
if (!isinstance<array>(src)) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
array temp = array::ensure(src); |
||||||
|
if (!temp) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
if (!temp.dtype().is(dtype::of<typename Type::Scalar>())) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
array_t<typename Type::Scalar, compute_array_flag_from_tensor<Type>()> arr( |
||||||
|
reinterpret_borrow<object>(src)); |
||||||
|
|
||||||
|
if (arr.ndim() != Type::NumIndices) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
auto shape = get_shape_for_array<typename Type::Index, Type::NumIndices>(arr); |
||||||
|
|
||||||
|
if (!Helper::is_correct_shape(shape)) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
#if EIGEN_VERSION_AT_LEAST(3, 4, 0) |
||||||
|
auto data_pointer = arr.data(); |
||||||
|
#else |
||||||
|
// Handle Eigen bug
|
||||||
|
auto data_pointer = const_cast<typename Type::Scalar *>(arr.data()); |
||||||
|
#endif |
||||||
|
|
||||||
|
if (is_tensor_aligned(arr.data())) { |
||||||
|
value = Eigen::TensorMap<const Type, Eigen::Aligned>(data_pointer, shape); |
||||||
|
} else { |
||||||
|
value = Eigen::TensorMap<const Type>(data_pointer, shape); |
||||||
|
} |
||||||
|
|
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
static handle cast(Type &&src, return_value_policy policy, handle parent) { |
||||||
|
if (policy == return_value_policy::reference |
||||||
|
|| policy == return_value_policy::reference_internal) { |
||||||
|
pybind11_fail("Cannot use a reference return value policy for an rvalue"); |
||||||
|
} |
||||||
|
return cast_impl(&src, return_value_policy::move, parent); |
||||||
|
} |
||||||
|
|
||||||
|
static handle cast(const Type &&src, return_value_policy policy, handle parent) { |
||||||
|
if (policy == return_value_policy::reference |
||||||
|
|| policy == return_value_policy::reference_internal) { |
||||||
|
pybind11_fail("Cannot use a reference return value policy for an rvalue"); |
||||||
|
} |
||||||
|
return cast_impl(&src, return_value_policy::move, parent); |
||||||
|
} |
||||||
|
|
||||||
|
static handle cast(Type &src, return_value_policy policy, handle parent) { |
||||||
|
if (policy == return_value_policy::automatic |
||||||
|
|| policy == return_value_policy::automatic_reference) { |
||||||
|
policy = return_value_policy::copy; |
||||||
|
} |
||||||
|
return cast_impl(&src, policy, parent); |
||||||
|
} |
||||||
|
|
||||||
|
static handle cast(const Type &src, return_value_policy policy, handle parent) { |
||||||
|
if (policy == return_value_policy::automatic |
||||||
|
|| policy == return_value_policy::automatic_reference) { |
||||||
|
policy = return_value_policy::copy; |
||||||
|
} |
||||||
|
return cast(&src, policy, parent); |
||||||
|
} |
||||||
|
|
||||||
|
static handle cast(Type *src, return_value_policy policy, handle parent) { |
||||||
|
if (policy == return_value_policy::automatic) { |
||||||
|
policy = return_value_policy::take_ownership; |
||||||
|
} else if (policy == return_value_policy::automatic_reference) { |
||||||
|
policy = return_value_policy::reference; |
||||||
|
} |
||||||
|
return cast_impl(src, policy, parent); |
||||||
|
} |
||||||
|
|
||||||
|
static handle cast(const Type *src, return_value_policy policy, handle parent) { |
||||||
|
if (policy == return_value_policy::automatic) { |
||||||
|
policy = return_value_policy::take_ownership; |
||||||
|
} else if (policy == return_value_policy::automatic_reference) { |
||||||
|
policy = return_value_policy::reference; |
||||||
|
} |
||||||
|
return cast_impl(src, policy, parent); |
||||||
|
} |
||||||
|
|
||||||
|
template <typename C> |
||||||
|
static handle cast_impl(C *src, return_value_policy policy, handle parent) { |
||||||
|
object parent_object; |
||||||
|
bool writeable = false; |
||||||
|
switch (policy) { |
||||||
|
case return_value_policy::move: |
||||||
|
if (std::is_const<C>::value) { |
||||||
|
pybind11_fail("Cannot move from a constant reference"); |
||||||
|
} |
||||||
|
|
||||||
|
src = Helper::alloc(std::move(*src)); |
||||||
|
|
||||||
|
parent_object |
||||||
|
= capsule(src, [](void *ptr) { Helper::free(reinterpret_cast<Type *>(ptr)); }); |
||||||
|
writeable = true; |
||||||
|
break; |
||||||
|
|
||||||
|
case return_value_policy::take_ownership: |
||||||
|
if (std::is_const<C>::value) { |
||||||
|
// This cast is ugly, and might be UB in some cases, but we don't have an
|
||||||
|
// alternative here as we must free that memory
|
||||||
|
Helper::free(const_cast<Type *>(src)); |
||||||
|
pybind11_fail("Cannot take ownership of a const reference"); |
||||||
|
} |
||||||
|
|
||||||
|
parent_object |
||||||
|
= capsule(src, [](void *ptr) { Helper::free(reinterpret_cast<Type *>(ptr)); }); |
||||||
|
writeable = true; |
||||||
|
break; |
||||||
|
|
||||||
|
case return_value_policy::copy: |
||||||
|
writeable = true; |
||||||
|
break; |
||||||
|
|
||||||
|
case return_value_policy::reference: |
||||||
|
parent_object = none(); |
||||||
|
writeable = !std::is_const<C>::value; |
||||||
|
break; |
||||||
|
|
||||||
|
case return_value_policy::reference_internal: |
||||||
|
// Default should do the right thing
|
||||||
|
if (!parent) { |
||||||
|
pybind11_fail("Cannot use reference internal when there is no parent"); |
||||||
|
} |
||||||
|
parent_object = reinterpret_borrow<object>(parent); |
||||||
|
writeable = !std::is_const<C>::value; |
||||||
|
break; |
||||||
|
|
||||||
|
default: |
||||||
|
pybind11_fail("pybind11 bug in eigen.h, please file a bug report"); |
||||||
|
} |
||||||
|
|
||||||
|
auto result = array_t<typename Type::Scalar, compute_array_flag_from_tensor<Type>()>( |
||||||
|
convert_dsizes_to_vector(Helper::get_shape(*src)), src->data(), parent_object); |
||||||
|
|
||||||
|
if (!writeable) { |
||||||
|
array_proxy(result.ptr())->flags &= ~detail::npy_api::NPY_ARRAY_WRITEABLE_; |
||||||
|
} |
||||||
|
|
||||||
|
return result.release(); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename StoragePointerType, |
||||||
|
bool needs_writeable, |
||||||
|
enable_if_t<!needs_writeable, bool> = true> |
||||||
|
StoragePointerType get_array_data_for_type(array &arr) { |
||||||
|
#if EIGEN_VERSION_AT_LEAST(3, 4, 0) |
||||||
|
return reinterpret_cast<StoragePointerType>(arr.data()); |
||||||
|
#else |
||||||
|
// Handle Eigen bug
|
||||||
|
return reinterpret_cast<StoragePointerType>(const_cast<void *>(arr.data())); |
||||||
|
#endif |
||||||
|
} |
||||||
|
|
||||||
|
template <typename StoragePointerType, |
||||||
|
bool needs_writeable, |
||||||
|
enable_if_t<needs_writeable, bool> = true> |
||||||
|
StoragePointerType get_array_data_for_type(array &arr) { |
||||||
|
return reinterpret_cast<StoragePointerType>(arr.mutable_data()); |
||||||
|
} |
||||||
|
|
||||||
|
template <typename T, typename = void> |
||||||
|
struct get_storage_pointer_type; |
||||||
|
|
||||||
|
template <typename MapType> |
||||||
|
struct get_storage_pointer_type<MapType, void_t<typename MapType::StoragePointerType>> { |
||||||
|
using SPT = typename MapType::StoragePointerType; |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename MapType> |
||||||
|
struct get_storage_pointer_type<MapType, void_t<typename MapType::PointerArgType>> { |
||||||
|
using SPT = typename MapType::PointerArgType; |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename Type, int Options> |
||||||
|
struct type_caster<Eigen::TensorMap<Type, Options>, |
||||||
|
typename eigen_tensor_helper<remove_cv_t<Type>>::ValidType> { |
||||||
|
using MapType = Eigen::TensorMap<Type, Options>; |
||||||
|
using Helper = eigen_tensor_helper<remove_cv_t<Type>>; |
||||||
|
|
||||||
|
bool load(handle src, bool /*convert*/) { |
||||||
|
// Note that we have a lot more checks here as we want to make sure to avoid copies
|
||||||
|
if (!isinstance<array>(src)) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
auto arr = reinterpret_borrow<array>(src); |
||||||
|
if ((arr.flags() & compute_array_flag_from_tensor<Type>()) == 0) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
if (!arr.dtype().is(dtype::of<typename Type::Scalar>())) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
if (arr.ndim() != Type::NumIndices) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
constexpr bool is_aligned = (Options & Eigen::Aligned) != 0; |
||||||
|
|
||||||
|
if (is_aligned && !is_tensor_aligned(arr.data())) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
auto shape = get_shape_for_array<typename Type::Index, Type::NumIndices>(arr); |
||||||
|
|
||||||
|
if (!Helper::is_correct_shape(shape)) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
if (needs_writeable && !arr.writeable()) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
auto result = get_array_data_for_type<typename get_storage_pointer_type<MapType>::SPT, |
||||||
|
needs_writeable>(arr); |
||||||
|
|
||||||
|
value.reset(new MapType(std::move(result), std::move(shape))); |
||||||
|
|
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
static handle cast(MapType &&src, return_value_policy policy, handle parent) { |
||||||
|
return cast_impl(&src, policy, parent); |
||||||
|
} |
||||||
|
|
||||||
|
static handle cast(const MapType &&src, return_value_policy policy, handle parent) { |
||||||
|
return cast_impl(&src, policy, parent); |
||||||
|
} |
||||||
|
|
||||||
|
static handle cast(MapType &src, return_value_policy policy, handle parent) { |
||||||
|
if (policy == return_value_policy::automatic |
||||||
|
|| policy == return_value_policy::automatic_reference) { |
||||||
|
policy = return_value_policy::copy; |
||||||
|
} |
||||||
|
return cast_impl(&src, policy, parent); |
||||||
|
} |
||||||
|
|
||||||
|
static handle cast(const MapType &src, return_value_policy policy, handle parent) { |
||||||
|
if (policy == return_value_policy::automatic |
||||||
|
|| policy == return_value_policy::automatic_reference) { |
||||||
|
policy = return_value_policy::copy; |
||||||
|
} |
||||||
|
return cast(&src, policy, parent); |
||||||
|
} |
||||||
|
|
||||||
|
static handle cast(MapType *src, return_value_policy policy, handle parent) { |
||||||
|
if (policy == return_value_policy::automatic) { |
||||||
|
policy = return_value_policy::take_ownership; |
||||||
|
} else if (policy == return_value_policy::automatic_reference) { |
||||||
|
policy = return_value_policy::reference; |
||||||
|
} |
||||||
|
return cast_impl(src, policy, parent); |
||||||
|
} |
||||||
|
|
||||||
|
static handle cast(const MapType *src, return_value_policy policy, handle parent) { |
||||||
|
if (policy == return_value_policy::automatic) { |
||||||
|
policy = return_value_policy::take_ownership; |
||||||
|
} else if (policy == return_value_policy::automatic_reference) { |
||||||
|
policy = return_value_policy::reference; |
||||||
|
} |
||||||
|
return cast_impl(src, policy, parent); |
||||||
|
} |
||||||
|
|
||||||
|
template <typename C> |
||||||
|
static handle cast_impl(C *src, return_value_policy policy, handle parent) { |
||||||
|
object parent_object; |
||||||
|
constexpr bool writeable = !std::is_const<C>::value; |
||||||
|
switch (policy) { |
||||||
|
case return_value_policy::reference: |
||||||
|
parent_object = none(); |
||||||
|
break; |
||||||
|
|
||||||
|
case return_value_policy::reference_internal: |
||||||
|
// Default should do the right thing
|
||||||
|
if (!parent) { |
||||||
|
pybind11_fail("Cannot use reference internal when there is no parent"); |
||||||
|
} |
||||||
|
parent_object = reinterpret_borrow<object>(parent); |
||||||
|
break; |
||||||
|
|
||||||
|
case return_value_policy::take_ownership: |
||||||
|
delete src; |
||||||
|
// fallthrough
|
||||||
|
default: |
||||||
|
// move, take_ownership don't make any sense for a ref/map:
|
||||||
|
pybind11_fail("Invalid return_value_policy for Eigen Map type, must be either " |
||||||
|
"reference or reference_internal"); |
||||||
|
} |
||||||
|
|
||||||
|
auto result = array_t<typename Type::Scalar, compute_array_flag_from_tensor<Type>()>( |
||||||
|
convert_dsizes_to_vector(Helper::get_shape(*src)), |
||||||
|
src->data(), |
||||||
|
std::move(parent_object)); |
||||||
|
|
||||||
|
if (!writeable) { |
||||||
|
array_proxy(result.ptr())->flags &= ~detail::npy_api::NPY_ARRAY_WRITEABLE_; |
||||||
|
} |
||||||
|
|
||||||
|
return result.release(); |
||||||
|
} |
||||||
|
|
||||||
|
#if EIGEN_VERSION_AT_LEAST(3, 4, 0) |
||||||
|
|
||||||
|
static constexpr bool needs_writeable = !std::is_const<typename std::remove_pointer< |
||||||
|
typename get_storage_pointer_type<MapType>::SPT>::type>::value; |
||||||
|
#else |
||||||
|
// Handle Eigen bug
|
||||||
|
static constexpr bool needs_writeable = !std::is_const<Type>::value; |
||||||
|
#endif |
||||||
|
|
||||||
|
protected: |
||||||
|
// TODO: Move to std::optional once std::optional has more support
|
||||||
|
std::unique_ptr<MapType> value; |
||||||
|
|
||||||
|
public: |
||||||
|
static constexpr auto name = get_tensor_descriptor<Type, true, needs_writeable>::value; |
||||||
|
explicit operator MapType *() { return value.get(); } |
||||||
|
explicit operator MapType &() { return *value; } |
||||||
|
explicit operator MapType &&() && { return std::move(*value); } |
||||||
|
|
||||||
|
template <typename T_> |
||||||
|
using cast_op_type = ::pybind11::detail::movable_cast_op_type<T_>; |
||||||
|
}; |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
@ -0,0 +1,317 @@ |
|||||||
|
/*
|
||||||
|
pybind11/embed.h: Support for embedding the interpreter |
||||||
|
|
||||||
|
Copyright (c) 2017 Wenzel Jakob <wenzel.jakob@epfl.ch> |
||||||
|
|
||||||
|
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 "pybind11.h" |
||||||
|
#include "eval.h" |
||||||
|
|
||||||
|
#include <memory> |
||||||
|
#include <vector> |
||||||
|
|
||||||
|
#if defined(PYPY_VERSION) |
||||||
|
# error Embedding the interpreter is not supported with PyPy |
||||||
|
#endif |
||||||
|
|
||||||
|
#define PYBIND11_EMBEDDED_MODULE_IMPL(name) \ |
||||||
|
extern "C" PyObject *pybind11_init_impl_##name(); \
|
||||||
|
extern "C" PyObject *pybind11_init_impl_##name() { return pybind11_init_wrapper_##name(); } |
||||||
|
|
||||||
|
/** \rst
|
||||||
|
Add a new module to the table of builtins for the interpreter. Must be |
||||||
|
defined in global scope. The first macro parameter is the name of the |
||||||
|
module (without quotes). The second parameter is the variable which will |
||||||
|
be used as the interface to add functions and classes to the module. |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
PYBIND11_EMBEDDED_MODULE(example, m) { |
||||||
|
// ... initialize functions and classes here
|
||||||
|
m.def("foo", []() { |
||||||
|
return "Hello, World!"; |
||||||
|
}); |
||||||
|
} |
||||||
|
\endrst */ |
||||||
|
#define PYBIND11_EMBEDDED_MODULE(name, variable) \ |
||||||
|
static ::pybind11::module_::module_def PYBIND11_CONCAT(pybind11_module_def_, name); \
|
||||||
|
static void PYBIND11_CONCAT(pybind11_init_, name)(::pybind11::module_ &); \
|
||||||
|
static PyObject PYBIND11_CONCAT(*pybind11_init_wrapper_, name)() { \
|
||||||
|
auto m = ::pybind11::module_::create_extension_module( \
|
||||||
|
PYBIND11_TOSTRING(name), nullptr, &PYBIND11_CONCAT(pybind11_module_def_, name)); \
|
||||||
|
try { \
|
||||||
|
PYBIND11_CONCAT(pybind11_init_, name)(m); \
|
||||||
|
return m.ptr(); \
|
||||||
|
} \
|
||||||
|
PYBIND11_CATCH_INIT_EXCEPTIONS \
|
||||||
|
} \
|
||||||
|
PYBIND11_EMBEDDED_MODULE_IMPL(name) \
|
||||||
|
::pybind11::detail::embedded_module PYBIND11_CONCAT(pybind11_module_, name)( \
|
||||||
|
PYBIND11_TOSTRING(name), PYBIND11_CONCAT(pybind11_init_impl_, name)); \
|
||||||
|
void PYBIND11_CONCAT(pybind11_init_, name)(::pybind11::module_ \
|
||||||
|
& variable) // NOLINT(bugprone-macro-parentheses)
|
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
/// Python 2.7/3.x compatible version of `PyImport_AppendInittab` and error checks.
|
||||||
|
struct embedded_module { |
||||||
|
using init_t = PyObject *(*) (); |
||||||
|
embedded_module(const char *name, init_t init) { |
||||||
|
if (Py_IsInitialized() != 0) { |
||||||
|
pybind11_fail("Can't add new modules after the interpreter has been initialized"); |
||||||
|
} |
||||||
|
|
||||||
|
auto result = PyImport_AppendInittab(name, init); |
||||||
|
if (result == -1) { |
||||||
|
pybind11_fail("Insufficient memory to add a new module"); |
||||||
|
} |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
struct wide_char_arg_deleter { |
||||||
|
void operator()(wchar_t *ptr) const { |
||||||
|
// API docs: https://docs.python.org/3/c-api/sys.html#c.Py_DecodeLocale
|
||||||
|
PyMem_RawFree(ptr); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
inline wchar_t *widen_chars(const char *safe_arg) { |
||||||
|
wchar_t *widened_arg = Py_DecodeLocale(safe_arg, nullptr); |
||||||
|
return widened_arg; |
||||||
|
} |
||||||
|
|
||||||
|
inline void precheck_interpreter() { |
||||||
|
if (Py_IsInitialized() != 0) { |
||||||
|
pybind11_fail("The interpreter is already running"); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
#if !defined(PYBIND11_PYCONFIG_SUPPORT_PY_VERSION_HEX) |
||||||
|
# define PYBIND11_PYCONFIG_SUPPORT_PY_VERSION_HEX (0x03080000) |
||||||
|
#endif |
||||||
|
|
||||||
|
#if PY_VERSION_HEX < PYBIND11_PYCONFIG_SUPPORT_PY_VERSION_HEX |
||||||
|
inline void initialize_interpreter_pre_pyconfig(bool init_signal_handlers, |
||||||
|
int argc, |
||||||
|
const char *const *argv, |
||||||
|
bool add_program_dir_to_path) { |
||||||
|
detail::precheck_interpreter(); |
||||||
|
Py_InitializeEx(init_signal_handlers ? 1 : 0); |
||||||
|
# if defined(WITH_THREAD) && PY_VERSION_HEX < 0x03070000 |
||||||
|
PyEval_InitThreads(); |
||||||
|
# endif |
||||||
|
|
||||||
|
// Before it was special-cased in python 3.8, passing an empty or null argv
|
||||||
|
// caused a segfault, so we have to reimplement the special case ourselves.
|
||||||
|
bool special_case = (argv == nullptr || argc <= 0); |
||||||
|
|
||||||
|
const char *const empty_argv[]{"\0"}; |
||||||
|
const char *const *safe_argv = special_case ? empty_argv : argv; |
||||||
|
if (special_case) { |
||||||
|
argc = 1; |
||||||
|
} |
||||||
|
|
||||||
|
auto argv_size = static_cast<size_t>(argc); |
||||||
|
// SetArgv* on python 3 takes wchar_t, so we have to convert.
|
||||||
|
std::unique_ptr<wchar_t *[]> widened_argv(new wchar_t *[argv_size]); |
||||||
|
std::vector<std::unique_ptr<wchar_t[], detail::wide_char_arg_deleter>> widened_argv_entries; |
||||||
|
widened_argv_entries.reserve(argv_size); |
||||||
|
for (size_t ii = 0; ii < argv_size; ++ii) { |
||||||
|
widened_argv_entries.emplace_back(detail::widen_chars(safe_argv[ii])); |
||||||
|
if (!widened_argv_entries.back()) { |
||||||
|
// A null here indicates a character-encoding failure or the python
|
||||||
|
// interpreter out of memory. Give up.
|
||||||
|
return; |
||||||
|
} |
||||||
|
widened_argv[ii] = widened_argv_entries.back().get(); |
||||||
|
} |
||||||
|
|
||||||
|
auto *pysys_argv = widened_argv.get(); |
||||||
|
|
||||||
|
PySys_SetArgvEx(argc, pysys_argv, static_cast<int>(add_program_dir_to_path)); |
||||||
|
} |
||||||
|
#endif |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
|
||||||
|
#if PY_VERSION_HEX >= PYBIND11_PYCONFIG_SUPPORT_PY_VERSION_HEX |
||||||
|
inline void initialize_interpreter(PyConfig *config, |
||||||
|
int argc = 0, |
||||||
|
const char *const *argv = nullptr, |
||||||
|
bool add_program_dir_to_path = true) { |
||||||
|
detail::precheck_interpreter(); |
||||||
|
PyStatus status = PyConfig_SetBytesArgv(config, argc, const_cast<char *const *>(argv)); |
||||||
|
if (PyStatus_Exception(status) != 0) { |
||||||
|
// A failure here indicates a character-encoding failure or the python
|
||||||
|
// interpreter out of memory. Give up.
|
||||||
|
PyConfig_Clear(config); |
||||||
|
throw std::runtime_error(PyStatus_IsError(status) != 0 ? status.err_msg |
||||||
|
: "Failed to prepare CPython"); |
||||||
|
} |
||||||
|
status = Py_InitializeFromConfig(config); |
||||||
|
if (PyStatus_Exception(status) != 0) { |
||||||
|
PyConfig_Clear(config); |
||||||
|
throw std::runtime_error(PyStatus_IsError(status) != 0 ? status.err_msg |
||||||
|
: "Failed to init CPython"); |
||||||
|
} |
||||||
|
if (add_program_dir_to_path) { |
||||||
|
PyRun_SimpleString("import sys, os.path; " |
||||||
|
"sys.path.insert(0, " |
||||||
|
"os.path.abspath(os.path.dirname(sys.argv[0])) " |
||||||
|
"if sys.argv and os.path.exists(sys.argv[0]) else '')"); |
||||||
|
} |
||||||
|
PyConfig_Clear(config); |
||||||
|
} |
||||||
|
#endif |
||||||
|
|
||||||
|
/** \rst
|
||||||
|
Initialize the Python interpreter. No other pybind11 or CPython API functions can be |
||||||
|
called before this is done; with the exception of `PYBIND11_EMBEDDED_MODULE`. The |
||||||
|
optional `init_signal_handlers` parameter can be used to skip the registration of |
||||||
|
signal handlers (see the `Python documentation`_ for details). Calling this function |
||||||
|
again after the interpreter has already been initialized is a fatal error. |
||||||
|
|
||||||
|
If initializing the Python interpreter fails, then the program is terminated. (This |
||||||
|
is controlled by the CPython runtime and is an exception to pybind11's normal behavior |
||||||
|
of throwing exceptions on errors.) |
||||||
|
|
||||||
|
The remaining optional parameters, `argc`, `argv`, and `add_program_dir_to_path` are |
||||||
|
used to populate ``sys.argv`` and ``sys.path``. |
||||||
|
See the |PySys_SetArgvEx documentation|_ for details. |
||||||
|
|
||||||
|
.. _Python documentation: https://docs.python.org/3/c-api/init.html#c.Py_InitializeEx
|
||||||
|
.. |PySys_SetArgvEx documentation| replace:: ``PySys_SetArgvEx`` documentation |
||||||
|
.. _PySys_SetArgvEx documentation: https://docs.python.org/3/c-api/init.html#c.PySys_SetArgvEx
|
||||||
|
\endrst */ |
||||||
|
inline void initialize_interpreter(bool init_signal_handlers = true, |
||||||
|
int argc = 0, |
||||||
|
const char *const *argv = nullptr, |
||||||
|
bool add_program_dir_to_path = true) { |
||||||
|
#if PY_VERSION_HEX < PYBIND11_PYCONFIG_SUPPORT_PY_VERSION_HEX |
||||||
|
detail::initialize_interpreter_pre_pyconfig( |
||||||
|
init_signal_handlers, argc, argv, add_program_dir_to_path); |
||||||
|
#else |
||||||
|
PyConfig config; |
||||||
|
PyConfig_InitIsolatedConfig(&config); |
||||||
|
config.isolated = 0; |
||||||
|
config.use_environment = 1; |
||||||
|
config.install_signal_handlers = init_signal_handlers ? 1 : 0; |
||||||
|
initialize_interpreter(&config, argc, argv, add_program_dir_to_path); |
||||||
|
#endif |
||||||
|
} |
||||||
|
|
||||||
|
/** \rst
|
||||||
|
Shut down the Python interpreter. No pybind11 or CPython API functions can be called |
||||||
|
after this. In addition, pybind11 objects must not outlive the interpreter: |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
{ // BAD
|
||||||
|
py::initialize_interpreter(); |
||||||
|
auto hello = py::str("Hello, World!"); |
||||||
|
py::finalize_interpreter(); |
||||||
|
} // <-- BOOM, hello's destructor is called after interpreter shutdown
|
||||||
|
|
||||||
|
{ // GOOD
|
||||||
|
py::initialize_interpreter(); |
||||||
|
{ // scoped
|
||||||
|
auto hello = py::str("Hello, World!"); |
||||||
|
} // <-- OK, hello is cleaned up properly
|
||||||
|
py::finalize_interpreter(); |
||||||
|
} |
||||||
|
|
||||||
|
{ // BETTER
|
||||||
|
py::scoped_interpreter guard{}; |
||||||
|
auto hello = py::str("Hello, World!"); |
||||||
|
} |
||||||
|
|
||||||
|
.. warning:: |
||||||
|
|
||||||
|
The interpreter can be restarted by calling `initialize_interpreter` again. |
||||||
|
Modules created using pybind11 can be safely re-initialized. However, Python |
||||||
|
itself cannot completely unload binary extension modules and there are several |
||||||
|
caveats with regard to interpreter restarting. All the details can be found |
||||||
|
in the CPython documentation. In short, not all interpreter memory may be |
||||||
|
freed, either due to reference cycles or user-created global data. |
||||||
|
|
||||||
|
\endrst */ |
||||||
|
inline void finalize_interpreter() { |
||||||
|
handle builtins(PyEval_GetBuiltins()); |
||||||
|
const char *id = PYBIND11_INTERNALS_ID; |
||||||
|
|
||||||
|
// Get the internals pointer (without creating it if it doesn't exist). It's possible for the
|
||||||
|
// internals to be created during Py_Finalize() (e.g. if a py::capsule calls `get_internals()`
|
||||||
|
// during destruction), so we get the pointer-pointer here and check it after Py_Finalize().
|
||||||
|
detail::internals **internals_ptr_ptr = detail::get_internals_pp(); |
||||||
|
// It could also be stashed in builtins, so look there too:
|
||||||
|
if (builtins.contains(id) && isinstance<capsule>(builtins[id])) { |
||||||
|
internals_ptr_ptr = capsule(builtins[id]); |
||||||
|
} |
||||||
|
// Local internals contains data managed by the current interpreter, so we must clear them to
|
||||||
|
// avoid undefined behaviors when initializing another interpreter
|
||||||
|
detail::get_local_internals().registered_types_cpp.clear(); |
||||||
|
detail::get_local_internals().registered_exception_translators.clear(); |
||||||
|
|
||||||
|
Py_Finalize(); |
||||||
|
|
||||||
|
if (internals_ptr_ptr) { |
||||||
|
delete *internals_ptr_ptr; |
||||||
|
*internals_ptr_ptr = nullptr; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
/** \rst
|
||||||
|
Scope guard version of `initialize_interpreter` and `finalize_interpreter`. |
||||||
|
This a move-only guard and only a single instance can exist. |
||||||
|
|
||||||
|
See `initialize_interpreter` for a discussion of its constructor arguments. |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
#include <pybind11/embed.h> |
||||||
|
|
||||||
|
int main() { |
||||||
|
py::scoped_interpreter guard{}; |
||||||
|
py::print(Hello, World!); |
||||||
|
} // <-- interpreter shutdown
|
||||||
|
\endrst */ |
||||||
|
class scoped_interpreter { |
||||||
|
public: |
||||||
|
explicit scoped_interpreter(bool init_signal_handlers = true, |
||||||
|
int argc = 0, |
||||||
|
const char *const *argv = nullptr, |
||||||
|
bool add_program_dir_to_path = true) { |
||||||
|
initialize_interpreter(init_signal_handlers, argc, argv, add_program_dir_to_path); |
||||||
|
} |
||||||
|
|
||||||
|
#if PY_VERSION_HEX >= PYBIND11_PYCONFIG_SUPPORT_PY_VERSION_HEX |
||||||
|
explicit scoped_interpreter(PyConfig *config, |
||||||
|
int argc = 0, |
||||||
|
const char *const *argv = nullptr, |
||||||
|
bool add_program_dir_to_path = true) { |
||||||
|
initialize_interpreter(config, argc, argv, add_program_dir_to_path); |
||||||
|
} |
||||||
|
#endif |
||||||
|
|
||||||
|
scoped_interpreter(const scoped_interpreter &) = delete; |
||||||
|
scoped_interpreter(scoped_interpreter &&other) noexcept { other.is_valid = false; } |
||||||
|
scoped_interpreter &operator=(const scoped_interpreter &) = delete; |
||||||
|
scoped_interpreter &operator=(scoped_interpreter &&) = delete; |
||||||
|
|
||||||
|
~scoped_interpreter() { |
||||||
|
if (is_valid) { |
||||||
|
finalize_interpreter(); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
bool is_valid = true; |
||||||
|
}; |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
@ -0,0 +1,156 @@ |
|||||||
|
/*
|
||||||
|
pybind11/eval.h: Support for evaluating Python expressions and statements |
||||||
|
from strings and files |
||||||
|
|
||||||
|
Copyright (c) 2016 Klemens Morgenstern <klemens.morgenstern@ed-chemnitz.de> and |
||||||
|
Wenzel Jakob <wenzel.jakob@epfl.ch> |
||||||
|
|
||||||
|
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 "pybind11.h" |
||||||
|
|
||||||
|
#include <utility> |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
inline void ensure_builtins_in_globals(object &global) { |
||||||
|
#if defined(PYPY_VERSION) || PY_VERSION_HEX < 0x03080000 |
||||||
|
// Running exec and eval adds `builtins` module under `__builtins__` key to
|
||||||
|
// globals if not yet present. Python 3.8 made PyRun_String behave
|
||||||
|
// similarly. Let's also do that for older versions, for consistency. This
|
||||||
|
// was missing from PyPy3.8 7.3.7.
|
||||||
|
if (!global.contains("__builtins__")) |
||||||
|
global["__builtins__"] = module_::import(PYBIND11_BUILTINS_MODULE); |
||||||
|
#else |
||||||
|
(void) global; |
||||||
|
#endif |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
|
||||||
|
enum eval_mode { |
||||||
|
/// Evaluate a string containing an isolated expression
|
||||||
|
eval_expr, |
||||||
|
|
||||||
|
/// Evaluate a string containing a single statement. Returns \c none
|
||||||
|
eval_single_statement, |
||||||
|
|
||||||
|
/// Evaluate a string containing a sequence of statement. Returns \c none
|
||||||
|
eval_statements |
||||||
|
}; |
||||||
|
|
||||||
|
template <eval_mode mode = eval_expr> |
||||||
|
object eval(const str &expr, object global = globals(), object local = object()) { |
||||||
|
if (!local) { |
||||||
|
local = global; |
||||||
|
} |
||||||
|
|
||||||
|
detail::ensure_builtins_in_globals(global); |
||||||
|
|
||||||
|
/* PyRun_String does not accept a PyObject / encoding specifier,
|
||||||
|
this seems to be the only alternative */ |
||||||
|
std::string buffer = "# -*- coding: utf-8 -*-\n" + (std::string) expr; |
||||||
|
|
||||||
|
int start = 0; |
||||||
|
switch (mode) { |
||||||
|
case eval_expr: |
||||||
|
start = Py_eval_input; |
||||||
|
break; |
||||||
|
case eval_single_statement: |
||||||
|
start = Py_single_input; |
||||||
|
break; |
||||||
|
case eval_statements: |
||||||
|
start = Py_file_input; |
||||||
|
break; |
||||||
|
default: |
||||||
|
pybind11_fail("invalid evaluation mode"); |
||||||
|
} |
||||||
|
|
||||||
|
PyObject *result = PyRun_String(buffer.c_str(), start, global.ptr(), local.ptr()); |
||||||
|
if (!result) { |
||||||
|
throw error_already_set(); |
||||||
|
} |
||||||
|
return reinterpret_steal<object>(result); |
||||||
|
} |
||||||
|
|
||||||
|
template <eval_mode mode = eval_expr, size_t N> |
||||||
|
object eval(const char (&s)[N], object global = globals(), object local = object()) { |
||||||
|
/* Support raw string literals by removing common leading whitespace */ |
||||||
|
auto expr = (s[0] == '\n') ? str(module_::import("textwrap").attr("dedent")(s)) : str(s); |
||||||
|
return eval<mode>(expr, std::move(global), std::move(local)); |
||||||
|
} |
||||||
|
|
||||||
|
inline void exec(const str &expr, object global = globals(), object local = object()) { |
||||||
|
eval<eval_statements>(expr, std::move(global), std::move(local)); |
||||||
|
} |
||||||
|
|
||||||
|
template <size_t N> |
||||||
|
void exec(const char (&s)[N], object global = globals(), object local = object()) { |
||||||
|
eval<eval_statements>(s, std::move(global), std::move(local)); |
||||||
|
} |
||||||
|
|
||||||
|
#if defined(PYPY_VERSION) |
||||||
|
template <eval_mode mode = eval_statements> |
||||||
|
object eval_file(str, object, object) { |
||||||
|
pybind11_fail("eval_file not supported in PyPy3. Use eval"); |
||||||
|
} |
||||||
|
template <eval_mode mode = eval_statements> |
||||||
|
object eval_file(str, object) { |
||||||
|
pybind11_fail("eval_file not supported in PyPy3. Use eval"); |
||||||
|
} |
||||||
|
template <eval_mode mode = eval_statements> |
||||||
|
object eval_file(str) { |
||||||
|
pybind11_fail("eval_file not supported in PyPy3. Use eval"); |
||||||
|
} |
||||||
|
#else |
||||||
|
template <eval_mode mode = eval_statements> |
||||||
|
object eval_file(str fname, object global = globals(), object local = object()) { |
||||||
|
if (!local) { |
||||||
|
local = global; |
||||||
|
} |
||||||
|
|
||||||
|
detail::ensure_builtins_in_globals(global); |
||||||
|
|
||||||
|
int start = 0; |
||||||
|
switch (mode) { |
||||||
|
case eval_expr: |
||||||
|
start = Py_eval_input; |
||||||
|
break; |
||||||
|
case eval_single_statement: |
||||||
|
start = Py_single_input; |
||||||
|
break; |
||||||
|
case eval_statements: |
||||||
|
start = Py_file_input; |
||||||
|
break; |
||||||
|
default: |
||||||
|
pybind11_fail("invalid evaluation mode"); |
||||||
|
} |
||||||
|
|
||||||
|
int closeFile = 1; |
||||||
|
std::string fname_str = (std::string) fname; |
||||||
|
FILE *f = _Py_fopen_obj(fname.ptr(), "r"); |
||||||
|
if (!f) { |
||||||
|
PyErr_Clear(); |
||||||
|
pybind11_fail("File \"" + fname_str + "\" could not be opened!"); |
||||||
|
} |
||||||
|
|
||||||
|
if (!global.contains("__file__")) { |
||||||
|
global["__file__"] = std::move(fname); |
||||||
|
} |
||||||
|
|
||||||
|
PyObject *result |
||||||
|
= PyRun_FileEx(f, fname_str.c_str(), start, global.ptr(), local.ptr(), closeFile); |
||||||
|
|
||||||
|
if (!result) { |
||||||
|
throw error_already_set(); |
||||||
|
} |
||||||
|
return reinterpret_steal<object>(result); |
||||||
|
} |
||||||
|
#endif |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
@ -0,0 +1,137 @@ |
|||||||
|
/*
|
||||||
|
pybind11/functional.h: std::function<> support |
||||||
|
|
||||||
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> |
||||||
|
|
||||||
|
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 "pybind11.h" |
||||||
|
|
||||||
|
#include <functional> |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
template <typename Return, typename... Args> |
||||||
|
struct type_caster<std::function<Return(Args...)>> { |
||||||
|
using type = std::function<Return(Args...)>; |
||||||
|
using retval_type = conditional_t<std::is_same<Return, void>::value, void_type, Return>; |
||||||
|
using function_type = Return (*)(Args...); |
||||||
|
|
||||||
|
public: |
||||||
|
bool load(handle src, bool convert) { |
||||||
|
if (src.is_none()) { |
||||||
|
// Defer accepting None to other overloads (if we aren't in convert mode):
|
||||||
|
if (!convert) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
if (!isinstance<function>(src)) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
auto func = reinterpret_borrow<function>(src); |
||||||
|
|
||||||
|
/*
|
||||||
|
When passing a C++ function as an argument to another C++ |
||||||
|
function via Python, every function call would normally involve |
||||||
|
a full C++ -> Python -> C++ roundtrip, which can be prohibitive. |
||||||
|
Here, we try to at least detect the case where the function is |
||||||
|
stateless (i.e. function pointer or lambda function without |
||||||
|
captured variables), in which case the roundtrip can be avoided. |
||||||
|
*/ |
||||||
|
if (auto cfunc = func.cpp_function()) { |
||||||
|
auto *cfunc_self = PyCFunction_GET_SELF(cfunc.ptr()); |
||||||
|
if (cfunc_self == nullptr) { |
||||||
|
PyErr_Clear(); |
||||||
|
} else if (isinstance<capsule>(cfunc_self)) { |
||||||
|
auto c = reinterpret_borrow<capsule>(cfunc_self); |
||||||
|
|
||||||
|
function_record *rec = nullptr; |
||||||
|
// Check that we can safely reinterpret the capsule into a function_record
|
||||||
|
if (detail::is_function_record_capsule(c)) { |
||||||
|
rec = c.get_pointer<function_record>(); |
||||||
|
} |
||||||
|
|
||||||
|
while (rec != nullptr) { |
||||||
|
if (rec->is_stateless |
||||||
|
&& same_type(typeid(function_type), |
||||||
|
*reinterpret_cast<const std::type_info *>(rec->data[1]))) { |
||||||
|
struct capture { |
||||||
|
function_type f; |
||||||
|
}; |
||||||
|
value = ((capture *) &rec->data)->f; |
||||||
|
return true; |
||||||
|
} |
||||||
|
rec = rec->next; |
||||||
|
} |
||||||
|
} |
||||||
|
// PYPY segfaults here when passing builtin function like sum.
|
||||||
|
// Raising an fail exception here works to prevent the segfault, but only on gcc.
|
||||||
|
// See PR #1413 for full details
|
||||||
|
} |
||||||
|
|
||||||
|
// ensure GIL is held during functor destruction
|
||||||
|
struct func_handle { |
||||||
|
function f; |
||||||
|
#if !(defined(_MSC_VER) && _MSC_VER == 1916 && defined(PYBIND11_CPP17)) |
||||||
|
// This triggers a syntax error under very special conditions (very weird indeed).
|
||||||
|
explicit |
||||||
|
#endif |
||||||
|
func_handle(function &&f_) noexcept |
||||||
|
: f(std::move(f_)) { |
||||||
|
} |
||||||
|
func_handle(const func_handle &f_) { operator=(f_); } |
||||||
|
func_handle &operator=(const func_handle &f_) { |
||||||
|
gil_scoped_acquire acq; |
||||||
|
f = f_.f; |
||||||
|
return *this; |
||||||
|
} |
||||||
|
~func_handle() { |
||||||
|
gil_scoped_acquire acq; |
||||||
|
function kill_f(std::move(f)); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
// to emulate 'move initialization capture' in C++11
|
||||||
|
struct func_wrapper { |
||||||
|
func_handle hfunc; |
||||||
|
explicit func_wrapper(func_handle &&hf) noexcept : hfunc(std::move(hf)) {} |
||||||
|
Return operator()(Args... args) const { |
||||||
|
gil_scoped_acquire acq; |
||||||
|
// casts the returned object as a rvalue to the return type
|
||||||
|
return hfunc.f(std::forward<Args>(args)...).template cast<Return>(); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
value = func_wrapper(func_handle(std::move(func))); |
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
template <typename Func> |
||||||
|
static handle cast(Func &&f_, return_value_policy policy, handle /* parent */) { |
||||||
|
if (!f_) { |
||||||
|
return none().release(); |
||||||
|
} |
||||||
|
|
||||||
|
auto result = f_.template target<function_type>(); |
||||||
|
if (result) { |
||||||
|
return cpp_function(*result, policy).release(); |
||||||
|
} |
||||||
|
return cpp_function(std::forward<Func>(f_), policy).release(); |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_TYPE_CASTER(type, |
||||||
|
const_name("Callable[[") + concat(make_caster<Args>::name...) |
||||||
|
+ const_name("], ") + make_caster<retval_type>::name |
||||||
|
+ const_name("]")); |
||||||
|
}; |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
@ -0,0 +1,239 @@ |
|||||||
|
/*
|
||||||
|
pybind11/gil.h: RAII helpers for managing the GIL |
||||||
|
|
||||||
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> |
||||||
|
|
||||||
|
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" |
||||||
|
|
||||||
|
#if defined(WITH_THREAD) && !defined(PYBIND11_SIMPLE_GIL_MANAGEMENT) |
||||||
|
# include "detail/internals.h" |
||||||
|
#endif |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
// forward declarations
|
||||||
|
PyThreadState *get_thread_state_unchecked(); |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
|
||||||
|
#if defined(WITH_THREAD) |
||||||
|
|
||||||
|
# if !defined(PYBIND11_SIMPLE_GIL_MANAGEMENT) |
||||||
|
|
||||||
|
/* The functions below essentially reproduce the PyGILState_* API using a RAII
|
||||||
|
* pattern, but there are a few important differences: |
||||||
|
* |
||||||
|
* 1. When acquiring the GIL from an non-main thread during the finalization |
||||||
|
* phase, the GILState API blindly terminates the calling thread, which |
||||||
|
* is often not what is wanted. This API does not do this. |
||||||
|
* |
||||||
|
* 2. The gil_scoped_release function can optionally cut the relationship |
||||||
|
* of a PyThreadState and its associated thread, which allows moving it to |
||||||
|
* another thread (this is a fairly rare/advanced use case). |
||||||
|
* |
||||||
|
* 3. The reference count of an acquired thread state can be controlled. This |
||||||
|
* can be handy to prevent cases where callbacks issued from an external |
||||||
|
* thread would otherwise constantly construct and destroy thread state data |
||||||
|
* structures. |
||||||
|
* |
||||||
|
* See the Python bindings of NanoGUI (http://github.com/wjakob/nanogui) for an
|
||||||
|
* example which uses features 2 and 3 to migrate the Python thread of |
||||||
|
* execution to another thread (to run the event loop on the original thread, |
||||||
|
* in this case). |
||||||
|
*/ |
||||||
|
|
||||||
|
class gil_scoped_acquire { |
||||||
|
public: |
||||||
|
PYBIND11_NOINLINE gil_scoped_acquire() { |
||||||
|
auto &internals = detail::get_internals(); |
||||||
|
tstate = (PyThreadState *) PYBIND11_TLS_GET_VALUE(internals.tstate); |
||||||
|
|
||||||
|
if (!tstate) { |
||||||
|
/* Check if the GIL was acquired using the PyGILState_* API instead (e.g. if
|
||||||
|
calling from a Python thread). Since we use a different key, this ensures |
||||||
|
we don't create a new thread state and deadlock in PyEval_AcquireThread |
||||||
|
below. Note we don't save this state with internals.tstate, since we don't |
||||||
|
create it we would fail to clear it (its reference count should be > 0). */ |
||||||
|
tstate = PyGILState_GetThisThreadState(); |
||||||
|
} |
||||||
|
|
||||||
|
if (!tstate) { |
||||||
|
tstate = PyThreadState_New(internals.istate); |
||||||
|
# if defined(PYBIND11_DETAILED_ERROR_MESSAGES) |
||||||
|
if (!tstate) { |
||||||
|
pybind11_fail("scoped_acquire: could not create thread state!"); |
||||||
|
} |
||||||
|
# endif |
||||||
|
tstate->gilstate_counter = 0; |
||||||
|
PYBIND11_TLS_REPLACE_VALUE(internals.tstate, tstate); |
||||||
|
} else { |
||||||
|
release = detail::get_thread_state_unchecked() != tstate; |
||||||
|
} |
||||||
|
|
||||||
|
if (release) { |
||||||
|
PyEval_AcquireThread(tstate); |
||||||
|
} |
||||||
|
|
||||||
|
inc_ref(); |
||||||
|
} |
||||||
|
|
||||||
|
gil_scoped_acquire(const gil_scoped_acquire &) = delete; |
||||||
|
gil_scoped_acquire &operator=(const gil_scoped_acquire &) = delete; |
||||||
|
|
||||||
|
void inc_ref() { ++tstate->gilstate_counter; } |
||||||
|
|
||||||
|
PYBIND11_NOINLINE void dec_ref() { |
||||||
|
--tstate->gilstate_counter; |
||||||
|
# if defined(PYBIND11_DETAILED_ERROR_MESSAGES) |
||||||
|
if (detail::get_thread_state_unchecked() != tstate) { |
||||||
|
pybind11_fail("scoped_acquire::dec_ref(): thread state must be current!"); |
||||||
|
} |
||||||
|
if (tstate->gilstate_counter < 0) { |
||||||
|
pybind11_fail("scoped_acquire::dec_ref(): reference count underflow!"); |
||||||
|
} |
||||||
|
# endif |
||||||
|
if (tstate->gilstate_counter == 0) { |
||||||
|
# if defined(PYBIND11_DETAILED_ERROR_MESSAGES) |
||||||
|
if (!release) { |
||||||
|
pybind11_fail("scoped_acquire::dec_ref(): internal error!"); |
||||||
|
} |
||||||
|
# endif |
||||||
|
PyThreadState_Clear(tstate); |
||||||
|
if (active) { |
||||||
|
PyThreadState_DeleteCurrent(); |
||||||
|
} |
||||||
|
PYBIND11_TLS_DELETE_VALUE(detail::get_internals().tstate); |
||||||
|
release = false; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
/// This method will disable the PyThreadState_DeleteCurrent call and the
|
||||||
|
/// GIL won't be acquired. This method should be used if the interpreter
|
||||||
|
/// could be shutting down when this is called, as thread deletion is not
|
||||||
|
/// allowed during shutdown. Check _Py_IsFinalizing() on Python 3.7+, and
|
||||||
|
/// protect subsequent code.
|
||||||
|
PYBIND11_NOINLINE void disarm() { active = false; } |
||||||
|
|
||||||
|
PYBIND11_NOINLINE ~gil_scoped_acquire() { |
||||||
|
dec_ref(); |
||||||
|
if (release) { |
||||||
|
PyEval_SaveThread(); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
PyThreadState *tstate = nullptr; |
||||||
|
bool release = true; |
||||||
|
bool active = true; |
||||||
|
}; |
||||||
|
|
||||||
|
class gil_scoped_release { |
||||||
|
public: |
||||||
|
explicit gil_scoped_release(bool disassoc = false) : disassoc(disassoc) { |
||||||
|
// `get_internals()` must be called here unconditionally in order to initialize
|
||||||
|
// `internals.tstate` for subsequent `gil_scoped_acquire` calls. Otherwise, an
|
||||||
|
// initialization race could occur as multiple threads try `gil_scoped_acquire`.
|
||||||
|
auto &internals = detail::get_internals(); |
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-prefer-member-initializer)
|
||||||
|
tstate = PyEval_SaveThread(); |
||||||
|
if (disassoc) { |
||||||
|
// Python >= 3.7 can remove this, it's an int before 3.7
|
||||||
|
// NOLINTNEXTLINE(readability-qualified-auto)
|
||||||
|
auto key = internals.tstate; |
||||||
|
PYBIND11_TLS_DELETE_VALUE(key); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
gil_scoped_release(const gil_scoped_release &) = delete; |
||||||
|
gil_scoped_release &operator=(const gil_scoped_release &) = delete; |
||||||
|
|
||||||
|
/// This method will disable the PyThreadState_DeleteCurrent call and the
|
||||||
|
/// GIL won't be acquired. This method should be used if the interpreter
|
||||||
|
/// could be shutting down when this is called, as thread deletion is not
|
||||||
|
/// allowed during shutdown. Check _Py_IsFinalizing() on Python 3.7+, and
|
||||||
|
/// protect subsequent code.
|
||||||
|
PYBIND11_NOINLINE void disarm() { active = false; } |
||||||
|
|
||||||
|
~gil_scoped_release() { |
||||||
|
if (!tstate) { |
||||||
|
return; |
||||||
|
} |
||||||
|
// `PyEval_RestoreThread()` should not be called if runtime is finalizing
|
||||||
|
if (active) { |
||||||
|
PyEval_RestoreThread(tstate); |
||||||
|
} |
||||||
|
if (disassoc) { |
||||||
|
// Python >= 3.7 can remove this, it's an int before 3.7
|
||||||
|
// NOLINTNEXTLINE(readability-qualified-auto)
|
||||||
|
auto key = detail::get_internals().tstate; |
||||||
|
PYBIND11_TLS_REPLACE_VALUE(key, tstate); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
PyThreadState *tstate; |
||||||
|
bool disassoc; |
||||||
|
bool active = true; |
||||||
|
}; |
||||||
|
|
||||||
|
# else // PYBIND11_SIMPLE_GIL_MANAGEMENT
|
||||||
|
|
||||||
|
class gil_scoped_acquire { |
||||||
|
PyGILState_STATE state; |
||||||
|
|
||||||
|
public: |
||||||
|
gil_scoped_acquire() : state{PyGILState_Ensure()} {} |
||||||
|
gil_scoped_acquire(const gil_scoped_acquire &) = delete; |
||||||
|
gil_scoped_acquire &operator=(const gil_scoped_acquire &) = delete; |
||||||
|
~gil_scoped_acquire() { PyGILState_Release(state); } |
||||||
|
void disarm() {} |
||||||
|
}; |
||||||
|
|
||||||
|
class gil_scoped_release { |
||||||
|
PyThreadState *state; |
||||||
|
|
||||||
|
public: |
||||||
|
gil_scoped_release() : state{PyEval_SaveThread()} {} |
||||||
|
gil_scoped_release(const gil_scoped_release &) = delete; |
||||||
|
gil_scoped_release &operator=(const gil_scoped_release &) = delete; |
||||||
|
~gil_scoped_release() { PyEval_RestoreThread(state); } |
||||||
|
void disarm() {} |
||||||
|
}; |
||||||
|
|
||||||
|
# endif // PYBIND11_SIMPLE_GIL_MANAGEMENT
|
||||||
|
|
||||||
|
#else // WITH_THREAD
|
||||||
|
|
||||||
|
class gil_scoped_acquire { |
||||||
|
public: |
||||||
|
gil_scoped_acquire() { |
||||||
|
// Trick to suppress `unused variable` error messages (at call sites).
|
||||||
|
(void) (this != (this + 1)); |
||||||
|
} |
||||||
|
gil_scoped_acquire(const gil_scoped_acquire &) = delete; |
||||||
|
gil_scoped_acquire &operator=(const gil_scoped_acquire &) = delete; |
||||||
|
void disarm() {} |
||||||
|
}; |
||||||
|
|
||||||
|
class gil_scoped_release { |
||||||
|
public: |
||||||
|
gil_scoped_release() { |
||||||
|
// Trick to suppress `unused variable` error messages (at call sites).
|
||||||
|
(void) (this != (this + 1)); |
||||||
|
} |
||||||
|
gil_scoped_release(const gil_scoped_release &) = delete; |
||||||
|
gil_scoped_release &operator=(const gil_scoped_release &) = delete; |
||||||
|
void disarm() {} |
||||||
|
}; |
||||||
|
|
||||||
|
#endif // WITH_THREAD
|
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
@ -0,0 +1,265 @@ |
|||||||
|
/*
|
||||||
|
pybind11/iostream.h -- Tools to assist with redirecting cout and cerr to Python |
||||||
|
|
||||||
|
Copyright (c) 2017 Henry F. Schreiner |
||||||
|
|
||||||
|
All rights reserved. Use of this source code is governed by a |
||||||
|
BSD-style license that can be found in the LICENSE file. |
||||||
|
|
||||||
|
WARNING: The implementation in this file 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 |
||||||
|
https://github.com/pybind/pybind11/pull/2982 and
|
||||||
|
https://github.com/pybind/pybind11/pull/2995.
|
||||||
|
*/ |
||||||
|
|
||||||
|
#pragma once |
||||||
|
|
||||||
|
#include "pybind11.h" |
||||||
|
|
||||||
|
#include <algorithm> |
||||||
|
#include <cstring> |
||||||
|
#include <iostream> |
||||||
|
#include <iterator> |
||||||
|
#include <memory> |
||||||
|
#include <ostream> |
||||||
|
#include <streambuf> |
||||||
|
#include <string> |
||||||
|
#include <utility> |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
// Buffer that writes to Python instead of C++
|
||||||
|
class pythonbuf : public std::streambuf { |
||||||
|
private: |
||||||
|
using traits_type = std::streambuf::traits_type; |
||||||
|
|
||||||
|
const size_t buf_size; |
||||||
|
std::unique_ptr<char[]> d_buffer; |
||||||
|
object pywrite; |
||||||
|
object pyflush; |
||||||
|
|
||||||
|
int overflow(int c) override { |
||||||
|
if (!traits_type::eq_int_type(c, traits_type::eof())) { |
||||||
|
*pptr() = traits_type::to_char_type(c); |
||||||
|
pbump(1); |
||||||
|
} |
||||||
|
return sync() == 0 ? traits_type::not_eof(c) : traits_type::eof(); |
||||||
|
} |
||||||
|
|
||||||
|
// Computes how many bytes at the end of the buffer are part of an
|
||||||
|
// incomplete sequence of UTF-8 bytes.
|
||||||
|
// Precondition: pbase() < pptr()
|
||||||
|
size_t utf8_remainder() const { |
||||||
|
const auto rbase = std::reverse_iterator<char *>(pbase()); |
||||||
|
const auto rpptr = std::reverse_iterator<char *>(pptr()); |
||||||
|
auto is_ascii = [](char c) { return (static_cast<unsigned char>(c) & 0x80) == 0x00; }; |
||||||
|
auto is_leading = [](char c) { return (static_cast<unsigned char>(c) & 0xC0) == 0xC0; }; |
||||||
|
auto is_leading_2b = [](char c) { return static_cast<unsigned char>(c) <= 0xDF; }; |
||||||
|
auto is_leading_3b = [](char c) { return static_cast<unsigned char>(c) <= 0xEF; }; |
||||||
|
// If the last character is ASCII, there are no incomplete code points
|
||||||
|
if (is_ascii(*rpptr)) { |
||||||
|
return 0; |
||||||
|
} |
||||||
|
// Otherwise, work back from the end of the buffer and find the first
|
||||||
|
// UTF-8 leading byte
|
||||||
|
const auto rpend = rbase - rpptr >= 3 ? rpptr + 3 : rbase; |
||||||
|
const auto leading = std::find_if(rpptr, rpend, is_leading); |
||||||
|
if (leading == rbase) { |
||||||
|
return 0; |
||||||
|
} |
||||||
|
const auto dist = static_cast<size_t>(leading - rpptr); |
||||||
|
size_t remainder = 0; |
||||||
|
|
||||||
|
if (dist == 0) { |
||||||
|
remainder = 1; // 1-byte code point is impossible
|
||||||
|
} else if (dist == 1) { |
||||||
|
remainder = is_leading_2b(*leading) ? 0 : dist + 1; |
||||||
|
} else if (dist == 2) { |
||||||
|
remainder = is_leading_3b(*leading) ? 0 : dist + 1; |
||||||
|
} |
||||||
|
// else if (dist >= 3), at least 4 bytes before encountering an UTF-8
|
||||||
|
// leading byte, either no remainder or invalid UTF-8.
|
||||||
|
// Invalid UTF-8 will cause an exception later when converting
|
||||||
|
// to a Python string, so that's not handled here.
|
||||||
|
return remainder; |
||||||
|
} |
||||||
|
|
||||||
|
// This function must be non-virtual to be called in a destructor.
|
||||||
|
int _sync() { |
||||||
|
if (pbase() != pptr()) { // If buffer is not empty
|
||||||
|
gil_scoped_acquire tmp; |
||||||
|
// This subtraction cannot be negative, so dropping the sign.
|
||||||
|
auto size = static_cast<size_t>(pptr() - pbase()); |
||||||
|
size_t remainder = utf8_remainder(); |
||||||
|
|
||||||
|
if (size > remainder) { |
||||||
|
str line(pbase(), size - remainder); |
||||||
|
pywrite(std::move(line)); |
||||||
|
pyflush(); |
||||||
|
} |
||||||
|
|
||||||
|
// Copy the remainder at the end of the buffer to the beginning:
|
||||||
|
if (remainder > 0) { |
||||||
|
std::memmove(pbase(), pptr() - remainder, remainder); |
||||||
|
} |
||||||
|
setp(pbase(), epptr()); |
||||||
|
pbump(static_cast<int>(remainder)); |
||||||
|
} |
||||||
|
return 0; |
||||||
|
} |
||||||
|
|
||||||
|
int sync() override { return _sync(); } |
||||||
|
|
||||||
|
public: |
||||||
|
explicit pythonbuf(const object &pyostream, size_t buffer_size = 1024) |
||||||
|
: buf_size(buffer_size), d_buffer(new char[buf_size]), pywrite(pyostream.attr("write")), |
||||||
|
pyflush(pyostream.attr("flush")) { |
||||||
|
setp(d_buffer.get(), d_buffer.get() + buf_size - 1); |
||||||
|
} |
||||||
|
|
||||||
|
pythonbuf(pythonbuf &&) = default; |
||||||
|
|
||||||
|
/// Sync before destroy
|
||||||
|
~pythonbuf() override { _sync(); } |
||||||
|
}; |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
|
||||||
|
/** \rst
|
||||||
|
This a move-only guard that redirects output. |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
#include <pybind11/iostream.h> |
||||||
|
|
||||||
|
... |
||||||
|
|
||||||
|
{ |
||||||
|
py::scoped_ostream_redirect output; |
||||||
|
std::cout << "Hello, World!"; // Python stdout
|
||||||
|
} // <-- return std::cout to normal
|
||||||
|
|
||||||
|
You can explicitly pass the c++ stream and the python object, |
||||||
|
for example to guard stderr instead. |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
{ |
||||||
|
py::scoped_ostream_redirect output{ |
||||||
|
std::cerr, py::module::import("sys").attr("stderr")}; |
||||||
|
std::cout << "Hello, World!"; |
||||||
|
} |
||||||
|
\endrst */ |
||||||
|
class scoped_ostream_redirect { |
||||||
|
protected: |
||||||
|
std::streambuf *old; |
||||||
|
std::ostream &costream; |
||||||
|
detail::pythonbuf buffer; |
||||||
|
|
||||||
|
public: |
||||||
|
explicit scoped_ostream_redirect(std::ostream &costream = std::cout, |
||||||
|
const object &pyostream |
||||||
|
= module_::import("sys").attr("stdout")) |
||||||
|
: costream(costream), buffer(pyostream) { |
||||||
|
old = costream.rdbuf(&buffer); |
||||||
|
} |
||||||
|
|
||||||
|
~scoped_ostream_redirect() { costream.rdbuf(old); } |
||||||
|
|
||||||
|
scoped_ostream_redirect(const scoped_ostream_redirect &) = delete; |
||||||
|
scoped_ostream_redirect(scoped_ostream_redirect &&other) = default; |
||||||
|
scoped_ostream_redirect &operator=(const scoped_ostream_redirect &) = delete; |
||||||
|
scoped_ostream_redirect &operator=(scoped_ostream_redirect &&) = delete; |
||||||
|
}; |
||||||
|
|
||||||
|
/** \rst
|
||||||
|
Like `scoped_ostream_redirect`, but redirects cerr by default. This class |
||||||
|
is provided primary to make ``py::call_guard`` easier to make. |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
m.def("noisy_func", &noisy_func, |
||||||
|
py::call_guard<scoped_ostream_redirect, |
||||||
|
scoped_estream_redirect>()); |
||||||
|
|
||||||
|
\endrst */ |
||||||
|
class scoped_estream_redirect : public scoped_ostream_redirect { |
||||||
|
public: |
||||||
|
explicit scoped_estream_redirect(std::ostream &costream = std::cerr, |
||||||
|
const object &pyostream |
||||||
|
= module_::import("sys").attr("stderr")) |
||||||
|
: scoped_ostream_redirect(costream, pyostream) {} |
||||||
|
}; |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
// Class to redirect output as a context manager. C++ backend.
|
||||||
|
class OstreamRedirect { |
||||||
|
bool do_stdout_; |
||||||
|
bool do_stderr_; |
||||||
|
std::unique_ptr<scoped_ostream_redirect> redirect_stdout; |
||||||
|
std::unique_ptr<scoped_estream_redirect> redirect_stderr; |
||||||
|
|
||||||
|
public: |
||||||
|
explicit OstreamRedirect(bool do_stdout = true, bool do_stderr = true) |
||||||
|
: do_stdout_(do_stdout), do_stderr_(do_stderr) {} |
||||||
|
|
||||||
|
void enter() { |
||||||
|
if (do_stdout_) { |
||||||
|
redirect_stdout.reset(new scoped_ostream_redirect()); |
||||||
|
} |
||||||
|
if (do_stderr_) { |
||||||
|
redirect_stderr.reset(new scoped_estream_redirect()); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
void exit() { |
||||||
|
redirect_stdout.reset(); |
||||||
|
redirect_stderr.reset(); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
|
||||||
|
/** \rst
|
||||||
|
This is a helper function to add a C++ redirect context manager to Python |
||||||
|
instead of using a C++ guard. To use it, add the following to your binding code: |
||||||
|
|
||||||
|
.. code-block:: cpp |
||||||
|
|
||||||
|
#include <pybind11/iostream.h> |
||||||
|
|
||||||
|
... |
||||||
|
|
||||||
|
py::add_ostream_redirect(m, "ostream_redirect"); |
||||||
|
|
||||||
|
You now have a Python context manager that redirects your output: |
||||||
|
|
||||||
|
.. code-block:: python |
||||||
|
|
||||||
|
with m.ostream_redirect(): |
||||||
|
m.print_to_cout_function() |
||||||
|
|
||||||
|
This manager can optionally be told which streams to operate on: |
||||||
|
|
||||||
|
.. code-block:: python |
||||||
|
|
||||||
|
with m.ostream_redirect(stdout=true, stderr=true): |
||||||
|
m.noisy_function_with_error_printing() |
||||||
|
|
||||||
|
\endrst */ |
||||||
|
inline class_<detail::OstreamRedirect> |
||||||
|
add_ostream_redirect(module_ m, const std::string &name = "ostream_redirect") { |
||||||
|
return class_<detail::OstreamRedirect>(std::move(m), name.c_str(), module_local()) |
||||||
|
.def(init<bool, bool>(), arg("stdout") = true, arg("stderr") = true) |
||||||
|
.def("__enter__", &detail::OstreamRedirect::enter) |
||||||
|
.def("__exit__", [](detail::OstreamRedirect &self_, const args &) { self_.exit(); }); |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,202 @@ |
|||||||
|
/*
|
||||||
|
pybind11/operator.h: Metatemplates for operator overloading |
||||||
|
|
||||||
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> |
||||||
|
|
||||||
|
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 "pybind11.h" |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
/// Enumeration with all supported operator types
|
||||||
|
enum op_id : int { |
||||||
|
op_add, |
||||||
|
op_sub, |
||||||
|
op_mul, |
||||||
|
op_div, |
||||||
|
op_mod, |
||||||
|
op_divmod, |
||||||
|
op_pow, |
||||||
|
op_lshift, |
||||||
|
op_rshift, |
||||||
|
op_and, |
||||||
|
op_xor, |
||||||
|
op_or, |
||||||
|
op_neg, |
||||||
|
op_pos, |
||||||
|
op_abs, |
||||||
|
op_invert, |
||||||
|
op_int, |
||||||
|
op_long, |
||||||
|
op_float, |
||||||
|
op_str, |
||||||
|
op_cmp, |
||||||
|
op_gt, |
||||||
|
op_ge, |
||||||
|
op_lt, |
||||||
|
op_le, |
||||||
|
op_eq, |
||||||
|
op_ne, |
||||||
|
op_iadd, |
||||||
|
op_isub, |
||||||
|
op_imul, |
||||||
|
op_idiv, |
||||||
|
op_imod, |
||||||
|
op_ilshift, |
||||||
|
op_irshift, |
||||||
|
op_iand, |
||||||
|
op_ixor, |
||||||
|
op_ior, |
||||||
|
op_complex, |
||||||
|
op_bool, |
||||||
|
op_nonzero, |
||||||
|
op_repr, |
||||||
|
op_truediv, |
||||||
|
op_itruediv, |
||||||
|
op_hash |
||||||
|
}; |
||||||
|
|
||||||
|
enum op_type : int { |
||||||
|
op_l, /* base type on left */ |
||||||
|
op_r, /* base type on right */ |
||||||
|
op_u /* unary operator */ |
||||||
|
}; |
||||||
|
|
||||||
|
struct self_t {}; |
||||||
|
static const self_t self = self_t(); |
||||||
|
|
||||||
|
/// Type for an unused type slot
|
||||||
|
struct undefined_t {}; |
||||||
|
|
||||||
|
/// Don't warn about an unused variable
|
||||||
|
inline self_t __self() { return self; } |
||||||
|
|
||||||
|
/// base template of operator implementations
|
||||||
|
template <op_id, op_type, typename B, typename L, typename R> |
||||||
|
struct op_impl {}; |
||||||
|
|
||||||
|
/// Operator implementation generator
|
||||||
|
template <op_id id, op_type ot, typename L, typename R> |
||||||
|
struct op_ { |
||||||
|
static constexpr bool op_enable_if_hook = true; |
||||||
|
template <typename Class, typename... Extra> |
||||||
|
void execute(Class &cl, const Extra &...extra) const { |
||||||
|
using Base = typename Class::type; |
||||||
|
using L_type = conditional_t<std::is_same<L, self_t>::value, Base, L>; |
||||||
|
using R_type = conditional_t<std::is_same<R, self_t>::value, Base, R>; |
||||||
|
using op = op_impl<id, ot, Base, L_type, R_type>; |
||||||
|
cl.def(op::name(), &op::execute, is_operator(), extra...); |
||||||
|
} |
||||||
|
template <typename Class, typename... Extra> |
||||||
|
void execute_cast(Class &cl, const Extra &...extra) const { |
||||||
|
using Base = typename Class::type; |
||||||
|
using L_type = conditional_t<std::is_same<L, self_t>::value, Base, L>; |
||||||
|
using R_type = conditional_t<std::is_same<R, self_t>::value, Base, R>; |
||||||
|
using op = op_impl<id, ot, Base, L_type, R_type>; |
||||||
|
cl.def(op::name(), &op::execute_cast, is_operator(), extra...); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
#define PYBIND11_BINARY_OPERATOR(id, rid, op, expr) \ |
||||||
|
template <typename B, typename L, typename R> \
|
||||||
|
struct op_impl<op_##id, op_l, B, L, R> { \
|
||||||
|
static char const *name() { return "__" #id "__"; } \
|
||||||
|
static auto execute(const L &l, const R &r) -> decltype(expr) { return (expr); } \
|
||||||
|
static B execute_cast(const L &l, const R &r) { return B(expr); } \
|
||||||
|
}; \
|
||||||
|
template <typename B, typename L, typename R> \
|
||||||
|
struct op_impl<op_##id, op_r, B, L, R> { \
|
||||||
|
static char const *name() { return "__" #rid "__"; } \
|
||||||
|
static auto execute(const R &r, const L &l) -> decltype(expr) { return (expr); } \
|
||||||
|
static B execute_cast(const R &r, const L &l) { return B(expr); } \
|
||||||
|
}; \
|
||||||
|
inline op_<op_##id, op_l, self_t, self_t> op(const self_t &, const self_t &) { \
|
||||||
|
return op_<op_##id, op_l, self_t, self_t>(); \
|
||||||
|
} \
|
||||||
|
template <typename T> \
|
||||||
|
op_<op_##id, op_l, self_t, T> op(const self_t &, const T &) { \
|
||||||
|
return op_<op_##id, op_l, self_t, T>(); \
|
||||||
|
} \
|
||||||
|
template <typename T> \
|
||||||
|
op_<op_##id, op_r, T, self_t> op(const T &, const self_t &) { \
|
||||||
|
return op_<op_##id, op_r, T, self_t>(); \
|
||||||
|
} |
||||||
|
|
||||||
|
#define PYBIND11_INPLACE_OPERATOR(id, op, expr) \ |
||||||
|
template <typename B, typename L, typename R> \
|
||||||
|
struct op_impl<op_##id, op_l, B, L, R> { \
|
||||||
|
static char const *name() { return "__" #id "__"; } \
|
||||||
|
static auto execute(L &l, const R &r) -> decltype(expr) { return expr; } \
|
||||||
|
static B execute_cast(L &l, const R &r) { return B(expr); } \
|
||||||
|
}; \
|
||||||
|
template <typename T> \
|
||||||
|
op_<op_##id, op_l, self_t, T> op(const self_t &, const T &) { \
|
||||||
|
return op_<op_##id, op_l, self_t, T>(); \
|
||||||
|
} |
||||||
|
|
||||||
|
#define PYBIND11_UNARY_OPERATOR(id, op, expr) \ |
||||||
|
template <typename B, typename L> \
|
||||||
|
struct op_impl<op_##id, op_u, B, L, undefined_t> { \
|
||||||
|
static char const *name() { return "__" #id "__"; } \
|
||||||
|
static auto execute(const L &l) -> decltype(expr) { return expr; } \
|
||||||
|
static B execute_cast(const L &l) { return B(expr); } \
|
||||||
|
}; \
|
||||||
|
inline op_<op_##id, op_u, self_t, undefined_t> op(const self_t &) { \
|
||||||
|
return op_<op_##id, op_u, self_t, undefined_t>(); \
|
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_BINARY_OPERATOR(sub, rsub, operator-, l - r) |
||||||
|
PYBIND11_BINARY_OPERATOR(add, radd, operator+, l + r) |
||||||
|
PYBIND11_BINARY_OPERATOR(mul, rmul, operator*, l *r) |
||||||
|
PYBIND11_BINARY_OPERATOR(truediv, rtruediv, operator/, l / r) |
||||||
|
PYBIND11_BINARY_OPERATOR(mod, rmod, operator%, l % r) |
||||||
|
PYBIND11_BINARY_OPERATOR(lshift, rlshift, operator<<, l << r) |
||||||
|
PYBIND11_BINARY_OPERATOR(rshift, rrshift, operator>>, l >> r) |
||||||
|
PYBIND11_BINARY_OPERATOR(and, rand, operator&, l &r) |
||||||
|
PYBIND11_BINARY_OPERATOR(xor, rxor, operator^, l ^ r) |
||||||
|
PYBIND11_BINARY_OPERATOR(eq, eq, operator==, l == r) |
||||||
|
PYBIND11_BINARY_OPERATOR(ne, ne, operator!=, l != r) |
||||||
|
PYBIND11_BINARY_OPERATOR(or, ror, operator|, l | r) |
||||||
|
PYBIND11_BINARY_OPERATOR(gt, lt, operator>, l > r) |
||||||
|
PYBIND11_BINARY_OPERATOR(ge, le, operator>=, l >= r) |
||||||
|
PYBIND11_BINARY_OPERATOR(lt, gt, operator<, l < r) |
||||||
|
PYBIND11_BINARY_OPERATOR(le, ge, operator<=, l <= r) |
||||||
|
// PYBIND11_BINARY_OPERATOR(pow, rpow, pow, std::pow(l, r))
|
||||||
|
PYBIND11_INPLACE_OPERATOR(iadd, operator+=, l += r) |
||||||
|
PYBIND11_INPLACE_OPERATOR(isub, operator-=, l -= r) |
||||||
|
PYBIND11_INPLACE_OPERATOR(imul, operator*=, l *= r) |
||||||
|
PYBIND11_INPLACE_OPERATOR(itruediv, operator/=, l /= r) |
||||||
|
PYBIND11_INPLACE_OPERATOR(imod, operator%=, l %= r) |
||||||
|
PYBIND11_INPLACE_OPERATOR(ilshift, operator<<=, l <<= r) |
||||||
|
PYBIND11_INPLACE_OPERATOR(irshift, operator>>=, l >>= r) |
||||||
|
PYBIND11_INPLACE_OPERATOR(iand, operator&=, l &= r) |
||||||
|
PYBIND11_INPLACE_OPERATOR(ixor, operator^=, l ^= r) |
||||||
|
PYBIND11_INPLACE_OPERATOR(ior, operator|=, l |= r) |
||||||
|
PYBIND11_UNARY_OPERATOR(neg, operator-, -l) |
||||||
|
PYBIND11_UNARY_OPERATOR(pos, operator+, +l) |
||||||
|
// WARNING: This usage of `abs` should only be done for existing STL overloads.
|
||||||
|
// Adding overloads directly in to the `std::` namespace is advised against:
|
||||||
|
// https://en.cppreference.com/w/cpp/language/extending_std
|
||||||
|
PYBIND11_UNARY_OPERATOR(abs, abs, std::abs(l)) |
||||||
|
PYBIND11_UNARY_OPERATOR(hash, hash, std::hash<L>()(l)) |
||||||
|
PYBIND11_UNARY_OPERATOR(invert, operator~, (~l)) |
||||||
|
PYBIND11_UNARY_OPERATOR(bool, operator!, !!l) |
||||||
|
PYBIND11_UNARY_OPERATOR(int, int_, (int) l) |
||||||
|
PYBIND11_UNARY_OPERATOR(float, float_, (double) l) |
||||||
|
|
||||||
|
#undef PYBIND11_BINARY_OPERATOR |
||||||
|
#undef PYBIND11_INPLACE_OPERATOR |
||||||
|
#undef PYBIND11_UNARY_OPERATOR |
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
|
||||||
|
using detail::self; |
||||||
|
// Add named operators so that they are accessible via `py::`.
|
||||||
|
using detail::hash; |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
@ -0,0 +1,92 @@ |
|||||||
|
/*
|
||||||
|
pybind11/options.h: global settings that are configurable at runtime. |
||||||
|
|
||||||
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> |
||||||
|
|
||||||
|
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) |
||||||
|
|
||||||
|
class options { |
||||||
|
public: |
||||||
|
// Default RAII constructor, which leaves settings as they currently are.
|
||||||
|
options() : previous_state(global_state()) {} |
||||||
|
|
||||||
|
// Class is non-copyable.
|
||||||
|
options(const options &) = delete; |
||||||
|
options &operator=(const options &) = delete; |
||||||
|
|
||||||
|
// Destructor, which restores settings that were in effect before.
|
||||||
|
~options() { global_state() = previous_state; } |
||||||
|
|
||||||
|
// Setter methods (affect the global state):
|
||||||
|
|
||||||
|
options &disable_user_defined_docstrings() & { |
||||||
|
global_state().show_user_defined_docstrings = false; |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
options &enable_user_defined_docstrings() & { |
||||||
|
global_state().show_user_defined_docstrings = true; |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
options &disable_function_signatures() & { |
||||||
|
global_state().show_function_signatures = false; |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
options &enable_function_signatures() & { |
||||||
|
global_state().show_function_signatures = true; |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
options &disable_enum_members_docstring() & { |
||||||
|
global_state().show_enum_members_docstring = false; |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
options &enable_enum_members_docstring() & { |
||||||
|
global_state().show_enum_members_docstring = true; |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
// Getter methods (return the global state):
|
||||||
|
|
||||||
|
static bool show_user_defined_docstrings() { |
||||||
|
return global_state().show_user_defined_docstrings; |
||||||
|
} |
||||||
|
|
||||||
|
static bool show_function_signatures() { return global_state().show_function_signatures; } |
||||||
|
|
||||||
|
static bool show_enum_members_docstring() { |
||||||
|
return global_state().show_enum_members_docstring; |
||||||
|
} |
||||||
|
|
||||||
|
// This type is not meant to be allocated on the heap.
|
||||||
|
void *operator new(size_t) = delete; |
||||||
|
|
||||||
|
private: |
||||||
|
struct state { |
||||||
|
bool show_user_defined_docstrings = true; //< Include user-supplied texts in docstrings.
|
||||||
|
bool show_function_signatures = true; //< Include auto-generated function signatures
|
||||||
|
// in docstrings.
|
||||||
|
bool show_enum_members_docstring = true; //< Include auto-generated member list in enum
|
||||||
|
// docstrings.
|
||||||
|
}; |
||||||
|
|
||||||
|
static state &global_state() { |
||||||
|
static state instance; |
||||||
|
return instance; |
||||||
|
} |
||||||
|
|
||||||
|
state previous_state; |
||||||
|
}; |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,446 @@ |
|||||||
|
/*
|
||||||
|
pybind11/stl.h: Transparent conversion for STL data types |
||||||
|
|
||||||
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> |
||||||
|
|
||||||
|
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 "pybind11.h" |
||||||
|
#include "detail/common.h" |
||||||
|
|
||||||
|
#include <deque> |
||||||
|
#include <list> |
||||||
|
#include <map> |
||||||
|
#include <ostream> |
||||||
|
#include <set> |
||||||
|
#include <unordered_map> |
||||||
|
#include <unordered_set> |
||||||
|
#include <valarray> |
||||||
|
|
||||||
|
// See `detail/common.h` for implementation of these guards.
|
||||||
|
#if defined(PYBIND11_HAS_OPTIONAL) |
||||||
|
# include <optional> |
||||||
|
#elif defined(PYBIND11_HAS_EXP_OPTIONAL) |
||||||
|
# include <experimental/optional> |
||||||
|
#endif |
||||||
|
|
||||||
|
#if defined(PYBIND11_HAS_VARIANT) |
||||||
|
# include <variant> |
||||||
|
#endif |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
/// Extracts an const lvalue reference or rvalue reference for U based on the type of T (e.g. for
|
||||||
|
/// forwarding a container element). Typically used indirect via forwarded_type(), below.
|
||||||
|
template <typename T, typename U> |
||||||
|
using forwarded_type = conditional_t<std::is_lvalue_reference<T>::value, |
||||||
|
remove_reference_t<U> &, |
||||||
|
remove_reference_t<U> &&>; |
||||||
|
|
||||||
|
/// Forwards a value U as rvalue or lvalue according to whether T is rvalue or lvalue; typically
|
||||||
|
/// used for forwarding a container's elements.
|
||||||
|
template <typename T, typename U> |
||||||
|
constexpr forwarded_type<T, U> forward_like(U &&u) { |
||||||
|
return std::forward<detail::forwarded_type<T, U>>(std::forward<U>(u)); |
||||||
|
} |
||||||
|
|
||||||
|
// Checks if a container has a STL style reserve method.
|
||||||
|
// This will only return true for a `reserve()` with a `void` return.
|
||||||
|
template <typename C> |
||||||
|
using has_reserve_method = std::is_same<decltype(std::declval<C>().reserve(0)), void>; |
||||||
|
|
||||||
|
template <typename Type, typename Key> |
||||||
|
struct set_caster { |
||||||
|
using type = Type; |
||||||
|
using key_conv = make_caster<Key>; |
||||||
|
|
||||||
|
private: |
||||||
|
template <typename T = Type, enable_if_t<has_reserve_method<T>::value, int> = 0> |
||||||
|
void reserve_maybe(const anyset &s, Type *) { |
||||||
|
value.reserve(s.size()); |
||||||
|
} |
||||||
|
void reserve_maybe(const anyset &, void *) {} |
||||||
|
|
||||||
|
public: |
||||||
|
bool load(handle src, bool convert) { |
||||||
|
if (!isinstance<anyset>(src)) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
auto s = reinterpret_borrow<anyset>(src); |
||||||
|
value.clear(); |
||||||
|
reserve_maybe(s, &value); |
||||||
|
for (auto entry : s) { |
||||||
|
key_conv conv; |
||||||
|
if (!conv.load(entry, convert)) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
value.insert(cast_op<Key &&>(std::move(conv))); |
||||||
|
} |
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
template <typename T> |
||||||
|
static handle cast(T &&src, return_value_policy policy, handle parent) { |
||||||
|
if (!std::is_lvalue_reference<T>::value) { |
||||||
|
policy = return_value_policy_override<Key>::policy(policy); |
||||||
|
} |
||||||
|
pybind11::set s; |
||||||
|
for (auto &&value : src) { |
||||||
|
auto value_ = reinterpret_steal<object>( |
||||||
|
key_conv::cast(detail::forward_like<T>(value), policy, parent)); |
||||||
|
if (!value_ || !s.add(std::move(value_))) { |
||||||
|
return handle(); |
||||||
|
} |
||||||
|
} |
||||||
|
return s.release(); |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_TYPE_CASTER(type, const_name("Set[") + key_conv::name + const_name("]")); |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename Type, typename Key, typename Value> |
||||||
|
struct map_caster { |
||||||
|
using key_conv = make_caster<Key>; |
||||||
|
using value_conv = make_caster<Value>; |
||||||
|
|
||||||
|
private: |
||||||
|
template <typename T = Type, enable_if_t<has_reserve_method<T>::value, int> = 0> |
||||||
|
void reserve_maybe(const dict &d, Type *) { |
||||||
|
value.reserve(d.size()); |
||||||
|
} |
||||||
|
void reserve_maybe(const dict &, void *) {} |
||||||
|
|
||||||
|
public: |
||||||
|
bool load(handle src, bool convert) { |
||||||
|
if (!isinstance<dict>(src)) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
auto d = reinterpret_borrow<dict>(src); |
||||||
|
value.clear(); |
||||||
|
reserve_maybe(d, &value); |
||||||
|
for (auto it : d) { |
||||||
|
key_conv kconv; |
||||||
|
value_conv vconv; |
||||||
|
if (!kconv.load(it.first.ptr(), convert) || !vconv.load(it.second.ptr(), convert)) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
value.emplace(cast_op<Key &&>(std::move(kconv)), cast_op<Value &&>(std::move(vconv))); |
||||||
|
} |
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
template <typename T> |
||||||
|
static handle cast(T &&src, return_value_policy policy, handle parent) { |
||||||
|
dict d; |
||||||
|
return_value_policy policy_key = policy; |
||||||
|
return_value_policy policy_value = policy; |
||||||
|
if (!std::is_lvalue_reference<T>::value) { |
||||||
|
policy_key = return_value_policy_override<Key>::policy(policy_key); |
||||||
|
policy_value = return_value_policy_override<Value>::policy(policy_value); |
||||||
|
} |
||||||
|
for (auto &&kv : src) { |
||||||
|
auto key = reinterpret_steal<object>( |
||||||
|
key_conv::cast(detail::forward_like<T>(kv.first), policy_key, parent)); |
||||||
|
auto value = reinterpret_steal<object>( |
||||||
|
value_conv::cast(detail::forward_like<T>(kv.second), policy_value, parent)); |
||||||
|
if (!key || !value) { |
||||||
|
return handle(); |
||||||
|
} |
||||||
|
d[std::move(key)] = std::move(value); |
||||||
|
} |
||||||
|
return d.release(); |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_TYPE_CASTER(Type, |
||||||
|
const_name("Dict[") + key_conv::name + const_name(", ") + value_conv::name |
||||||
|
+ const_name("]")); |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename Type, typename Value> |
||||||
|
struct list_caster { |
||||||
|
using value_conv = make_caster<Value>; |
||||||
|
|
||||||
|
bool load(handle src, bool convert) { |
||||||
|
if (!isinstance<sequence>(src) || isinstance<bytes>(src) || isinstance<str>(src)) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
auto s = reinterpret_borrow<sequence>(src); |
||||||
|
value.clear(); |
||||||
|
reserve_maybe(s, &value); |
||||||
|
for (auto it : s) { |
||||||
|
value_conv conv; |
||||||
|
if (!conv.load(it, convert)) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
value.push_back(cast_op<Value &&>(std::move(conv))); |
||||||
|
} |
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
template <typename T = Type, enable_if_t<has_reserve_method<T>::value, int> = 0> |
||||||
|
void reserve_maybe(const sequence &s, Type *) { |
||||||
|
value.reserve(s.size()); |
||||||
|
} |
||||||
|
void reserve_maybe(const sequence &, void *) {} |
||||||
|
|
||||||
|
public: |
||||||
|
template <typename T> |
||||||
|
static handle cast(T &&src, return_value_policy policy, handle parent) { |
||||||
|
if (!std::is_lvalue_reference<T>::value) { |
||||||
|
policy = return_value_policy_override<Value>::policy(policy); |
||||||
|
} |
||||||
|
list l(src.size()); |
||||||
|
ssize_t index = 0; |
||||||
|
for (auto &&value : src) { |
||||||
|
auto value_ = reinterpret_steal<object>( |
||||||
|
value_conv::cast(detail::forward_like<T>(value), policy, parent)); |
||||||
|
if (!value_) { |
||||||
|
return handle(); |
||||||
|
} |
||||||
|
PyList_SET_ITEM(l.ptr(), index++, value_.release().ptr()); // steals a reference
|
||||||
|
} |
||||||
|
return l.release(); |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_TYPE_CASTER(Type, const_name("List[") + value_conv::name + const_name("]")); |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename Type, typename Alloc> |
||||||
|
struct type_caster<std::vector<Type, Alloc>> : list_caster<std::vector<Type, Alloc>, Type> {}; |
||||||
|
|
||||||
|
template <typename Type, typename Alloc> |
||||||
|
struct type_caster<std::deque<Type, Alloc>> : list_caster<std::deque<Type, Alloc>, Type> {}; |
||||||
|
|
||||||
|
template <typename Type, typename Alloc> |
||||||
|
struct type_caster<std::list<Type, Alloc>> : list_caster<std::list<Type, Alloc>, Type> {}; |
||||||
|
|
||||||
|
template <typename ArrayType, typename Value, bool Resizable, size_t Size = 0> |
||||||
|
struct array_caster { |
||||||
|
using value_conv = make_caster<Value>; |
||||||
|
|
||||||
|
private: |
||||||
|
template <bool R = Resizable> |
||||||
|
bool require_size(enable_if_t<R, size_t> size) { |
||||||
|
if (value.size() != size) { |
||||||
|
value.resize(size); |
||||||
|
} |
||||||
|
return true; |
||||||
|
} |
||||||
|
template <bool R = Resizable> |
||||||
|
bool require_size(enable_if_t<!R, size_t> size) { |
||||||
|
return size == Size; |
||||||
|
} |
||||||
|
|
||||||
|
public: |
||||||
|
bool load(handle src, bool convert) { |
||||||
|
if (!isinstance<sequence>(src)) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
auto l = reinterpret_borrow<sequence>(src); |
||||||
|
if (!require_size(l.size())) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
size_t ctr = 0; |
||||||
|
for (auto it : l) { |
||||||
|
value_conv conv; |
||||||
|
if (!conv.load(it, convert)) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
value[ctr++] = cast_op<Value &&>(std::move(conv)); |
||||||
|
} |
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
template <typename T> |
||||||
|
static handle cast(T &&src, return_value_policy policy, handle parent) { |
||||||
|
list l(src.size()); |
||||||
|
ssize_t index = 0; |
||||||
|
for (auto &&value : src) { |
||||||
|
auto value_ = reinterpret_steal<object>( |
||||||
|
value_conv::cast(detail::forward_like<T>(value), policy, parent)); |
||||||
|
if (!value_) { |
||||||
|
return handle(); |
||||||
|
} |
||||||
|
PyList_SET_ITEM(l.ptr(), index++, value_.release().ptr()); // steals a reference
|
||||||
|
} |
||||||
|
return l.release(); |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_TYPE_CASTER(ArrayType, |
||||||
|
const_name("List[") + value_conv::name |
||||||
|
+ const_name<Resizable>(const_name(""), |
||||||
|
const_name("[") + const_name<Size>() |
||||||
|
+ const_name("]")) |
||||||
|
+ const_name("]")); |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename Type, size_t Size> |
||||||
|
struct type_caster<std::array<Type, Size>> |
||||||
|
: array_caster<std::array<Type, Size>, Type, false, Size> {}; |
||||||
|
|
||||||
|
template <typename Type> |
||||||
|
struct type_caster<std::valarray<Type>> : array_caster<std::valarray<Type>, Type, true> {}; |
||||||
|
|
||||||
|
template <typename Key, typename Compare, typename Alloc> |
||||||
|
struct type_caster<std::set<Key, Compare, Alloc>> |
||||||
|
: set_caster<std::set<Key, Compare, Alloc>, Key> {}; |
||||||
|
|
||||||
|
template <typename Key, typename Hash, typename Equal, typename Alloc> |
||||||
|
struct type_caster<std::unordered_set<Key, Hash, Equal, Alloc>> |
||||||
|
: set_caster<std::unordered_set<Key, Hash, Equal, Alloc>, Key> {}; |
||||||
|
|
||||||
|
template <typename Key, typename Value, typename Compare, typename Alloc> |
||||||
|
struct type_caster<std::map<Key, Value, Compare, Alloc>> |
||||||
|
: map_caster<std::map<Key, Value, Compare, Alloc>, Key, Value> {}; |
||||||
|
|
||||||
|
template <typename Key, typename Value, typename Hash, typename Equal, typename Alloc> |
||||||
|
struct type_caster<std::unordered_map<Key, Value, Hash, Equal, Alloc>> |
||||||
|
: map_caster<std::unordered_map<Key, Value, Hash, Equal, Alloc>, Key, Value> {}; |
||||||
|
|
||||||
|
// This type caster is intended to be used for std::optional and std::experimental::optional
|
||||||
|
template <typename Type, typename Value = typename Type::value_type> |
||||||
|
struct optional_caster { |
||||||
|
using value_conv = make_caster<Value>; |
||||||
|
|
||||||
|
template <typename T> |
||||||
|
static handle cast(T &&src, return_value_policy policy, handle parent) { |
||||||
|
if (!src) { |
||||||
|
return none().release(); |
||||||
|
} |
||||||
|
if (!std::is_lvalue_reference<T>::value) { |
||||||
|
policy = return_value_policy_override<Value>::policy(policy); |
||||||
|
} |
||||||
|
return value_conv::cast(*std::forward<T>(src), policy, parent); |
||||||
|
} |
||||||
|
|
||||||
|
bool load(handle src, bool convert) { |
||||||
|
if (!src) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
if (src.is_none()) { |
||||||
|
return true; // default-constructed value is already empty
|
||||||
|
} |
||||||
|
value_conv inner_caster; |
||||||
|
if (!inner_caster.load(src, convert)) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
value.emplace(cast_op<Value &&>(std::move(inner_caster))); |
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_TYPE_CASTER(Type, const_name("Optional[") + value_conv::name + const_name("]")); |
||||||
|
}; |
||||||
|
|
||||||
|
#if defined(PYBIND11_HAS_OPTIONAL) |
||||||
|
template <typename T> |
||||||
|
struct type_caster<std::optional<T>> : public optional_caster<std::optional<T>> {}; |
||||||
|
|
||||||
|
template <> |
||||||
|
struct type_caster<std::nullopt_t> : public void_caster<std::nullopt_t> {}; |
||||||
|
#endif |
||||||
|
|
||||||
|
#if defined(PYBIND11_HAS_EXP_OPTIONAL) |
||||||
|
template <typename T> |
||||||
|
struct type_caster<std::experimental::optional<T>> |
||||||
|
: public optional_caster<std::experimental::optional<T>> {}; |
||||||
|
|
||||||
|
template <> |
||||||
|
struct type_caster<std::experimental::nullopt_t> |
||||||
|
: public void_caster<std::experimental::nullopt_t> {}; |
||||||
|
#endif |
||||||
|
|
||||||
|
/// Visit a variant and cast any found type to Python
|
||||||
|
struct variant_caster_visitor { |
||||||
|
return_value_policy policy; |
||||||
|
handle parent; |
||||||
|
|
||||||
|
using result_type = handle; // required by boost::variant in C++11
|
||||||
|
|
||||||
|
template <typename T> |
||||||
|
result_type operator()(T &&src) const { |
||||||
|
return make_caster<T>::cast(std::forward<T>(src), policy, parent); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
/// Helper class which abstracts away variant's `visit` function. `std::variant` and similar
|
||||||
|
/// `namespace::variant` types which provide a `namespace::visit()` function are handled here
|
||||||
|
/// automatically using argument-dependent lookup. Users can provide specializations for other
|
||||||
|
/// variant-like classes, e.g. `boost::variant` and `boost::apply_visitor`.
|
||||||
|
template <template <typename...> class Variant> |
||||||
|
struct visit_helper { |
||||||
|
template <typename... Args> |
||||||
|
static auto call(Args &&...args) -> decltype(visit(std::forward<Args>(args)...)) { |
||||||
|
return visit(std::forward<Args>(args)...); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
/// Generic variant caster
|
||||||
|
template <typename Variant> |
||||||
|
struct variant_caster; |
||||||
|
|
||||||
|
template <template <typename...> class V, typename... Ts> |
||||||
|
struct variant_caster<V<Ts...>> { |
||||||
|
static_assert(sizeof...(Ts) > 0, "Variant must consist of at least one alternative."); |
||||||
|
|
||||||
|
template <typename U, typename... Us> |
||||||
|
bool load_alternative(handle src, bool convert, type_list<U, Us...>) { |
||||||
|
auto caster = make_caster<U>(); |
||||||
|
if (caster.load(src, convert)) { |
||||||
|
value = cast_op<U>(std::move(caster)); |
||||||
|
return true; |
||||||
|
} |
||||||
|
return load_alternative(src, convert, type_list<Us...>{}); |
||||||
|
} |
||||||
|
|
||||||
|
bool load_alternative(handle, bool, type_list<>) { return false; } |
||||||
|
|
||||||
|
bool load(handle src, bool convert) { |
||||||
|
// Do a first pass without conversions to improve constructor resolution.
|
||||||
|
// E.g. `py::int_(1).cast<variant<double, int>>()` needs to fill the `int`
|
||||||
|
// slot of the variant. Without two-pass loading `double` would be filled
|
||||||
|
// because it appears first and a conversion is possible.
|
||||||
|
if (convert && load_alternative(src, false, type_list<Ts...>{})) { |
||||||
|
return true; |
||||||
|
} |
||||||
|
return load_alternative(src, convert, type_list<Ts...>{}); |
||||||
|
} |
||||||
|
|
||||||
|
template <typename Variant> |
||||||
|
static handle cast(Variant &&src, return_value_policy policy, handle parent) { |
||||||
|
return visit_helper<V>::call(variant_caster_visitor{policy, parent}, |
||||||
|
std::forward<Variant>(src)); |
||||||
|
} |
||||||
|
|
||||||
|
using Type = V<Ts...>; |
||||||
|
PYBIND11_TYPE_CASTER(Type, |
||||||
|
const_name("Union[") + detail::concat(make_caster<Ts>::name...) |
||||||
|
+ const_name("]")); |
||||||
|
}; |
||||||
|
|
||||||
|
#if defined(PYBIND11_HAS_VARIANT) |
||||||
|
template <typename... Ts> |
||||||
|
struct type_caster<std::variant<Ts...>> : variant_caster<std::variant<Ts...>> {}; |
||||||
|
|
||||||
|
template <> |
||||||
|
struct type_caster<std::monostate> : public void_caster<std::monostate> {}; |
||||||
|
#endif |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
|
||||||
|
inline std::ostream &operator<<(std::ostream &os, const handle &obj) { |
||||||
|
#ifdef PYBIND11_HAS_STRING_VIEW |
||||||
|
os << str(obj).cast<std::string_view>(); |
||||||
|
#else |
||||||
|
os << (std::string) str(obj); |
||||||
|
#endif |
||||||
|
return os; |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
@ -0,0 +1,116 @@ |
|||||||
|
// Copyright (c) 2021 The Pybind Development Team.
|
||||||
|
// 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 "../pybind11.h" |
||||||
|
#include "../detail/common.h" |
||||||
|
#include "../detail/descr.h" |
||||||
|
#include "../cast.h" |
||||||
|
#include "../pytypes.h" |
||||||
|
|
||||||
|
#include <string> |
||||||
|
|
||||||
|
#ifdef __has_include |
||||||
|
# if defined(PYBIND11_CPP17) |
||||||
|
# if __has_include(<filesystem>) && \ |
||||||
|
PY_VERSION_HEX >= 0x03060000 |
||||||
|
# include <filesystem> |
||||||
|
# define PYBIND11_HAS_FILESYSTEM 1 |
||||||
|
# elif __has_include(<experimental/filesystem>) |
||||||
|
# include <experimental/filesystem> |
||||||
|
# define PYBIND11_HAS_EXPERIMENTAL_FILESYSTEM 1 |
||||||
|
# endif |
||||||
|
# endif |
||||||
|
#endif |
||||||
|
|
||||||
|
#if !defined(PYBIND11_HAS_FILESYSTEM) && !defined(PYBIND11_HAS_EXPERIMENTAL_FILESYSTEM) \ |
||||||
|
&& !defined(PYBIND11_HAS_FILESYSTEM_IS_OPTIONAL) |
||||||
|
# error \ |
||||||
|
"Neither #include <filesystem> nor #include <experimental/filesystem is available. (Use -DPYBIND11_HAS_FILESYSTEM_IS_OPTIONAL to ignore.)" |
||||||
|
#endif |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
#if defined(PYBIND11_HAS_FILESYSTEM) || defined(PYBIND11_HAS_EXPERIMENTAL_FILESYSTEM) |
||||||
|
template <typename T> |
||||||
|
struct path_caster { |
||||||
|
|
||||||
|
private: |
||||||
|
static PyObject *unicode_from_fs_native(const std::string &w) { |
||||||
|
# if !defined(PYPY_VERSION) |
||||||
|
return PyUnicode_DecodeFSDefaultAndSize(w.c_str(), ssize_t(w.size())); |
||||||
|
# else |
||||||
|
// PyPy mistakenly declares the first parameter as non-const.
|
||||||
|
return PyUnicode_DecodeFSDefaultAndSize(const_cast<char *>(w.c_str()), ssize_t(w.size())); |
||||||
|
# endif |
||||||
|
} |
||||||
|
|
||||||
|
static PyObject *unicode_from_fs_native(const std::wstring &w) { |
||||||
|
return PyUnicode_FromWideChar(w.c_str(), ssize_t(w.size())); |
||||||
|
} |
||||||
|
|
||||||
|
public: |
||||||
|
static handle cast(const T &path, return_value_policy, handle) { |
||||||
|
if (auto py_str = unicode_from_fs_native(path.native())) { |
||||||
|
return module_::import("pathlib") |
||||||
|
.attr("Path")(reinterpret_steal<object>(py_str)) |
||||||
|
.release(); |
||||||
|
} |
||||||
|
return nullptr; |
||||||
|
} |
||||||
|
|
||||||
|
bool load(handle handle, bool) { |
||||||
|
// PyUnicode_FSConverter and PyUnicode_FSDecoder normally take care of
|
||||||
|
// calling PyOS_FSPath themselves, but that's broken on PyPy (PyPy
|
||||||
|
// issue #3168) so we do it ourselves instead.
|
||||||
|
PyObject *buf = PyOS_FSPath(handle.ptr()); |
||||||
|
if (!buf) { |
||||||
|
PyErr_Clear(); |
||||||
|
return false; |
||||||
|
} |
||||||
|
PyObject *native = nullptr; |
||||||
|
if constexpr (std::is_same_v<typename T::value_type, char>) { |
||||||
|
if (PyUnicode_FSConverter(buf, &native) != 0) { |
||||||
|
if (auto *c_str = PyBytes_AsString(native)) { |
||||||
|
// AsString returns a pointer to the internal buffer, which
|
||||||
|
// must not be free'd.
|
||||||
|
value = c_str; |
||||||
|
} |
||||||
|
} |
||||||
|
} else if constexpr (std::is_same_v<typename T::value_type, wchar_t>) { |
||||||
|
if (PyUnicode_FSDecoder(buf, &native) != 0) { |
||||||
|
if (auto *c_str = PyUnicode_AsWideCharString(native, nullptr)) { |
||||||
|
// AsWideCharString returns a new string that must be free'd.
|
||||||
|
value = c_str; // Copies the string.
|
||||||
|
PyMem_Free(c_str); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
Py_XDECREF(native); |
||||||
|
Py_DECREF(buf); |
||||||
|
if (PyErr_Occurred()) { |
||||||
|
PyErr_Clear(); |
||||||
|
return false; |
||||||
|
} |
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_TYPE_CASTER(T, const_name("os.PathLike")); |
||||||
|
}; |
||||||
|
|
||||||
|
#endif // PYBIND11_HAS_FILESYSTEM || defined(PYBIND11_HAS_EXPERIMENTAL_FILESYSTEM)
|
||||||
|
|
||||||
|
#if defined(PYBIND11_HAS_FILESYSTEM) |
||||||
|
template <> |
||||||
|
struct type_caster<std::filesystem::path> : public path_caster<std::filesystem::path> {}; |
||||||
|
#elif defined(PYBIND11_HAS_EXPERIMENTAL_FILESYSTEM) |
||||||
|
template <> |
||||||
|
struct type_caster<std::experimental::filesystem::path> |
||||||
|
: public path_caster<std::experimental::filesystem::path> {}; |
||||||
|
#endif |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
@ -0,0 +1,845 @@ |
|||||||
|
/*
|
||||||
|
pybind11/std_bind.h: Binding generators for STL data types |
||||||
|
|
||||||
|
Copyright (c) 2016 Sergey Lyskov and 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/type_caster_base.h" |
||||||
|
#include "cast.h" |
||||||
|
#include "operators.h" |
||||||
|
|
||||||
|
#include <algorithm> |
||||||
|
#include <sstream> |
||||||
|
#include <type_traits> |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
/* SFINAE helper class used by 'is_comparable */ |
||||||
|
template <typename T> |
||||||
|
struct container_traits { |
||||||
|
template <typename T2> |
||||||
|
static std::true_type |
||||||
|
test_comparable(decltype(std::declval<const T2 &>() == std::declval<const T2 &>()) *); |
||||||
|
template <typename T2> |
||||||
|
static std::false_type test_comparable(...); |
||||||
|
template <typename T2> |
||||||
|
static std::true_type test_value(typename T2::value_type *); |
||||||
|
template <typename T2> |
||||||
|
static std::false_type test_value(...); |
||||||
|
template <typename T2> |
||||||
|
static std::true_type test_pair(typename T2::first_type *, typename T2::second_type *); |
||||||
|
template <typename T2> |
||||||
|
static std::false_type test_pair(...); |
||||||
|
|
||||||
|
static constexpr const bool is_comparable |
||||||
|
= std::is_same<std::true_type, decltype(test_comparable<T>(nullptr))>::value; |
||||||
|
static constexpr const bool is_pair |
||||||
|
= std::is_same<std::true_type, decltype(test_pair<T>(nullptr, nullptr))>::value; |
||||||
|
static constexpr const bool is_vector |
||||||
|
= std::is_same<std::true_type, decltype(test_value<T>(nullptr))>::value; |
||||||
|
static constexpr const bool is_element = !is_pair && !is_vector; |
||||||
|
}; |
||||||
|
|
||||||
|
/* Default: is_comparable -> std::false_type */ |
||||||
|
template <typename T, typename SFINAE = void> |
||||||
|
struct is_comparable : std::false_type {}; |
||||||
|
|
||||||
|
/* For non-map data structures, check whether operator== can be instantiated */ |
||||||
|
template <typename T> |
||||||
|
struct is_comparable< |
||||||
|
T, |
||||||
|
enable_if_t<container_traits<T>::is_element && container_traits<T>::is_comparable>> |
||||||
|
: std::true_type {}; |
||||||
|
|
||||||
|
/* For a vector/map data structure, recursively check the value type
|
||||||
|
(which is std::pair for maps) */ |
||||||
|
template <typename T> |
||||||
|
struct is_comparable<T, enable_if_t<container_traits<T>::is_vector>> { |
||||||
|
static constexpr const bool value = is_comparable<typename T::value_type>::value; |
||||||
|
}; |
||||||
|
|
||||||
|
/* For pairs, recursively check the two data types */ |
||||||
|
template <typename T> |
||||||
|
struct is_comparable<T, enable_if_t<container_traits<T>::is_pair>> { |
||||||
|
static constexpr const bool value = is_comparable<typename T::first_type>::value |
||||||
|
&& is_comparable<typename T::second_type>::value; |
||||||
|
}; |
||||||
|
|
||||||
|
/* Fallback functions */ |
||||||
|
template <typename, typename, typename... Args> |
||||||
|
void vector_if_copy_constructible(const Args &...) {} |
||||||
|
template <typename, typename, typename... Args> |
||||||
|
void vector_if_equal_operator(const Args &...) {} |
||||||
|
template <typename, typename, typename... Args> |
||||||
|
void vector_if_insertion_operator(const Args &...) {} |
||||||
|
template <typename, typename, typename... Args> |
||||||
|
void vector_modifiers(const Args &...) {} |
||||||
|
|
||||||
|
template <typename Vector, typename Class_> |
||||||
|
void vector_if_copy_constructible(enable_if_t<is_copy_constructible<Vector>::value, Class_> &cl) { |
||||||
|
cl.def(init<const Vector &>(), "Copy constructor"); |
||||||
|
} |
||||||
|
|
||||||
|
template <typename Vector, typename Class_> |
||||||
|
void vector_if_equal_operator(enable_if_t<is_comparable<Vector>::value, Class_> &cl) { |
||||||
|
using T = typename Vector::value_type; |
||||||
|
|
||||||
|
cl.def(self == self); |
||||||
|
cl.def(self != self); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"count", |
||||||
|
[](const Vector &v, const T &x) { return std::count(v.begin(), v.end(), x); }, |
||||||
|
arg("x"), |
||||||
|
"Return the number of times ``x`` appears in the list"); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"remove", |
||||||
|
[](Vector &v, const T &x) { |
||||||
|
auto p = std::find(v.begin(), v.end(), x); |
||||||
|
if (p != v.end()) { |
||||||
|
v.erase(p); |
||||||
|
} else { |
||||||
|
throw value_error(); |
||||||
|
} |
||||||
|
}, |
||||||
|
arg("x"), |
||||||
|
"Remove the first item from the list whose value is x. " |
||||||
|
"It is an error if there is no such item."); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"__contains__", |
||||||
|
[](const Vector &v, const T &x) { return std::find(v.begin(), v.end(), x) != v.end(); }, |
||||||
|
arg("x"), |
||||||
|
"Return true the container contains ``x``"); |
||||||
|
} |
||||||
|
|
||||||
|
// Vector modifiers -- requires a copyable vector_type:
|
||||||
|
// (Technically, some of these (pop and __delitem__) don't actually require copyability, but it
|
||||||
|
// seems silly to allow deletion but not insertion, so include them here too.)
|
||||||
|
template <typename Vector, typename Class_> |
||||||
|
void vector_modifiers( |
||||||
|
enable_if_t<is_copy_constructible<typename Vector::value_type>::value, Class_> &cl) { |
||||||
|
using T = typename Vector::value_type; |
||||||
|
using SizeType = typename Vector::size_type; |
||||||
|
using DiffType = typename Vector::difference_type; |
||||||
|
|
||||||
|
auto wrap_i = [](DiffType i, SizeType n) { |
||||||
|
if (i < 0) { |
||||||
|
i += n; |
||||||
|
} |
||||||
|
if (i < 0 || (SizeType) i >= n) { |
||||||
|
throw index_error(); |
||||||
|
} |
||||||
|
return i; |
||||||
|
}; |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"append", |
||||||
|
[](Vector &v, const T &value) { v.push_back(value); }, |
||||||
|
arg("x"), |
||||||
|
"Add an item to the end of the list"); |
||||||
|
|
||||||
|
cl.def(init([](const iterable &it) { |
||||||
|
auto v = std::unique_ptr<Vector>(new Vector()); |
||||||
|
v->reserve(len_hint(it)); |
||||||
|
for (handle h : it) { |
||||||
|
v->push_back(h.cast<T>()); |
||||||
|
} |
||||||
|
return v.release(); |
||||||
|
})); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"clear", [](Vector &v) { v.clear(); }, "Clear the contents"); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"extend", |
||||||
|
[](Vector &v, const Vector &src) { v.insert(v.end(), src.begin(), src.end()); }, |
||||||
|
arg("L"), |
||||||
|
"Extend the list by appending all the items in the given list"); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"extend", |
||||||
|
[](Vector &v, const iterable &it) { |
||||||
|
const size_t old_size = v.size(); |
||||||
|
v.reserve(old_size + len_hint(it)); |
||||||
|
try { |
||||||
|
for (handle h : it) { |
||||||
|
v.push_back(h.cast<T>()); |
||||||
|
} |
||||||
|
} catch (const cast_error &) { |
||||||
|
v.erase(v.begin() + static_cast<typename Vector::difference_type>(old_size), |
||||||
|
v.end()); |
||||||
|
try { |
||||||
|
v.shrink_to_fit(); |
||||||
|
} catch (const std::exception &) { |
||||||
|
// Do nothing
|
||||||
|
} |
||||||
|
throw; |
||||||
|
} |
||||||
|
}, |
||||||
|
arg("L"), |
||||||
|
"Extend the list by appending all the items in the given list"); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"insert", |
||||||
|
[](Vector &v, DiffType i, const T &x) { |
||||||
|
// Can't use wrap_i; i == v.size() is OK
|
||||||
|
if (i < 0) { |
||||||
|
i += v.size(); |
||||||
|
} |
||||||
|
if (i < 0 || (SizeType) i > v.size()) { |
||||||
|
throw index_error(); |
||||||
|
} |
||||||
|
v.insert(v.begin() + i, x); |
||||||
|
}, |
||||||
|
arg("i"), |
||||||
|
arg("x"), |
||||||
|
"Insert an item at a given position."); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"pop", |
||||||
|
[](Vector &v) { |
||||||
|
if (v.empty()) { |
||||||
|
throw index_error(); |
||||||
|
} |
||||||
|
T t = std::move(v.back()); |
||||||
|
v.pop_back(); |
||||||
|
return t; |
||||||
|
}, |
||||||
|
"Remove and return the last item"); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"pop", |
||||||
|
[wrap_i](Vector &v, DiffType i) { |
||||||
|
i = wrap_i(i, v.size()); |
||||||
|
T t = std::move(v[(SizeType) i]); |
||||||
|
v.erase(std::next(v.begin(), i)); |
||||||
|
return t; |
||||||
|
}, |
||||||
|
arg("i"), |
||||||
|
"Remove and return the item at index ``i``"); |
||||||
|
|
||||||
|
cl.def("__setitem__", [wrap_i](Vector &v, DiffType i, const T &t) { |
||||||
|
i = wrap_i(i, v.size()); |
||||||
|
v[(SizeType) i] = t; |
||||||
|
}); |
||||||
|
|
||||||
|
/// Slicing protocol
|
||||||
|
cl.def( |
||||||
|
"__getitem__", |
||||||
|
[](const Vector &v, const slice &slice) -> Vector * { |
||||||
|
size_t start = 0, stop = 0, step = 0, slicelength = 0; |
||||||
|
|
||||||
|
if (!slice.compute(v.size(), &start, &stop, &step, &slicelength)) { |
||||||
|
throw error_already_set(); |
||||||
|
} |
||||||
|
|
||||||
|
auto *seq = new Vector(); |
||||||
|
seq->reserve((size_t) slicelength); |
||||||
|
|
||||||
|
for (size_t i = 0; i < slicelength; ++i) { |
||||||
|
seq->push_back(v[start]); |
||||||
|
start += step; |
||||||
|
} |
||||||
|
return seq; |
||||||
|
}, |
||||||
|
arg("s"), |
||||||
|
"Retrieve list elements using a slice object"); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"__setitem__", |
||||||
|
[](Vector &v, const slice &slice, const Vector &value) { |
||||||
|
size_t start = 0, stop = 0, step = 0, slicelength = 0; |
||||||
|
if (!slice.compute(v.size(), &start, &stop, &step, &slicelength)) { |
||||||
|
throw error_already_set(); |
||||||
|
} |
||||||
|
|
||||||
|
if (slicelength != value.size()) { |
||||||
|
throw std::runtime_error( |
||||||
|
"Left and right hand size of slice assignment have different sizes!"); |
||||||
|
} |
||||||
|
|
||||||
|
for (size_t i = 0; i < slicelength; ++i) { |
||||||
|
v[start] = value[i]; |
||||||
|
start += step; |
||||||
|
} |
||||||
|
}, |
||||||
|
"Assign list elements using a slice object"); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"__delitem__", |
||||||
|
[wrap_i](Vector &v, DiffType i) { |
||||||
|
i = wrap_i(i, v.size()); |
||||||
|
v.erase(v.begin() + i); |
||||||
|
}, |
||||||
|
"Delete the list elements at index ``i``"); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"__delitem__", |
||||||
|
[](Vector &v, const slice &slice) { |
||||||
|
size_t start = 0, stop = 0, step = 0, slicelength = 0; |
||||||
|
|
||||||
|
if (!slice.compute(v.size(), &start, &stop, &step, &slicelength)) { |
||||||
|
throw error_already_set(); |
||||||
|
} |
||||||
|
|
||||||
|
if (step == 1 && false) { |
||||||
|
v.erase(v.begin() + (DiffType) start, v.begin() + DiffType(start + slicelength)); |
||||||
|
} else { |
||||||
|
for (size_t i = 0; i < slicelength; ++i) { |
||||||
|
v.erase(v.begin() + DiffType(start)); |
||||||
|
start += step - 1; |
||||||
|
} |
||||||
|
} |
||||||
|
}, |
||||||
|
"Delete list elements using a slice object"); |
||||||
|
} |
||||||
|
|
||||||
|
// If the type has an operator[] that doesn't return a reference (most notably std::vector<bool>),
|
||||||
|
// we have to access by copying; otherwise we return by reference.
|
||||||
|
template <typename Vector> |
||||||
|
using vector_needs_copy |
||||||
|
= negation<std::is_same<decltype(std::declval<Vector>()[typename Vector::size_type()]), |
||||||
|
typename Vector::value_type &>>; |
||||||
|
|
||||||
|
// The usual case: access and iterate by reference
|
||||||
|
template <typename Vector, typename Class_> |
||||||
|
void vector_accessor(enable_if_t<!vector_needs_copy<Vector>::value, Class_> &cl) { |
||||||
|
using T = typename Vector::value_type; |
||||||
|
using SizeType = typename Vector::size_type; |
||||||
|
using DiffType = typename Vector::difference_type; |
||||||
|
using ItType = typename Vector::iterator; |
||||||
|
|
||||||
|
auto wrap_i = [](DiffType i, SizeType n) { |
||||||
|
if (i < 0) { |
||||||
|
i += n; |
||||||
|
} |
||||||
|
if (i < 0 || (SizeType) i >= n) { |
||||||
|
throw index_error(); |
||||||
|
} |
||||||
|
return i; |
||||||
|
}; |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"__getitem__", |
||||||
|
[wrap_i](Vector &v, DiffType i) -> T & { |
||||||
|
i = wrap_i(i, v.size()); |
||||||
|
return v[(SizeType) i]; |
||||||
|
}, |
||||||
|
return_value_policy::reference_internal // ref + keepalive
|
||||||
|
); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"__iter__", |
||||||
|
[](Vector &v) { |
||||||
|
return make_iterator<return_value_policy::reference_internal, ItType, ItType, T &>( |
||||||
|
v.begin(), v.end()); |
||||||
|
}, |
||||||
|
keep_alive<0, 1>() /* Essential: keep list alive while iterator exists */ |
||||||
|
); |
||||||
|
} |
||||||
|
|
||||||
|
// The case for special objects, like std::vector<bool>, that have to be returned-by-copy:
|
||||||
|
template <typename Vector, typename Class_> |
||||||
|
void vector_accessor(enable_if_t<vector_needs_copy<Vector>::value, Class_> &cl) { |
||||||
|
using T = typename Vector::value_type; |
||||||
|
using SizeType = typename Vector::size_type; |
||||||
|
using DiffType = typename Vector::difference_type; |
||||||
|
using ItType = typename Vector::iterator; |
||||||
|
cl.def("__getitem__", [](const Vector &v, DiffType i) -> T { |
||||||
|
if (i < 0 && (i += v.size()) < 0) { |
||||||
|
throw index_error(); |
||||||
|
} |
||||||
|
if ((SizeType) i >= v.size()) { |
||||||
|
throw index_error(); |
||||||
|
} |
||||||
|
return v[(SizeType) i]; |
||||||
|
}); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"__iter__", |
||||||
|
[](Vector &v) { |
||||||
|
return make_iterator<return_value_policy::copy, ItType, ItType, T>(v.begin(), v.end()); |
||||||
|
}, |
||||||
|
keep_alive<0, 1>() /* Essential: keep list alive while iterator exists */ |
||||||
|
); |
||||||
|
} |
||||||
|
|
||||||
|
template <typename Vector, typename Class_> |
||||||
|
auto vector_if_insertion_operator(Class_ &cl, std::string const &name) |
||||||
|
-> decltype(std::declval<std::ostream &>() << std::declval<typename Vector::value_type>(), |
||||||
|
void()) { |
||||||
|
using size_type = typename Vector::size_type; |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"__repr__", |
||||||
|
[name](Vector &v) { |
||||||
|
std::ostringstream s; |
||||||
|
s << name << '['; |
||||||
|
for (size_type i = 0; i < v.size(); ++i) { |
||||||
|
s << v[i]; |
||||||
|
if (i != v.size() - 1) { |
||||||
|
s << ", "; |
||||||
|
} |
||||||
|
} |
||||||
|
s << ']'; |
||||||
|
return s.str(); |
||||||
|
}, |
||||||
|
"Return the canonical string representation of this list."); |
||||||
|
} |
||||||
|
|
||||||
|
// Provide the buffer interface for vectors if we have data() and we have a format for it
|
||||||
|
// GCC seems to have "void std::vector<bool>::data()" - doing SFINAE on the existence of data()
|
||||||
|
// is insufficient, we need to check it returns an appropriate pointer
|
||||||
|
template <typename Vector, typename = void> |
||||||
|
struct vector_has_data_and_format : std::false_type {}; |
||||||
|
template <typename Vector> |
||||||
|
struct vector_has_data_and_format< |
||||||
|
Vector, |
||||||
|
enable_if_t<std::is_same<decltype(format_descriptor<typename Vector::value_type>::format(), |
||||||
|
std::declval<Vector>().data()), |
||||||
|
typename Vector::value_type *>::value>> : std::true_type {}; |
||||||
|
|
||||||
|
// [workaround(intel)] Separate function required here
|
||||||
|
// Workaround as the Intel compiler does not compile the enable_if_t part below
|
||||||
|
// (tested with icc (ICC) 2021.1 Beta 20200827)
|
||||||
|
template <typename... Args> |
||||||
|
constexpr bool args_any_are_buffer() { |
||||||
|
return detail::any_of<std::is_same<Args, buffer_protocol>...>::value; |
||||||
|
} |
||||||
|
|
||||||
|
// [workaround(intel)] Separate function required here
|
||||||
|
// [workaround(msvc)] Can't use constexpr bool in return type
|
||||||
|
|
||||||
|
// Add the buffer interface to a vector
|
||||||
|
template <typename Vector, typename Class_, typename... Args> |
||||||
|
void vector_buffer_impl(Class_ &cl, std::true_type) { |
||||||
|
using T = typename Vector::value_type; |
||||||
|
|
||||||
|
static_assert(vector_has_data_and_format<Vector>::value, |
||||||
|
"There is not an appropriate format descriptor for this vector"); |
||||||
|
|
||||||
|
// numpy.h declares this for arbitrary types, but it may raise an exception and crash hard
|
||||||
|
// at runtime if PYBIND11_NUMPY_DTYPE hasn't been called, so check here
|
||||||
|
format_descriptor<T>::format(); |
||||||
|
|
||||||
|
cl.def_buffer([](Vector &v) -> buffer_info { |
||||||
|
return buffer_info(v.data(), |
||||||
|
static_cast<ssize_t>(sizeof(T)), |
||||||
|
format_descriptor<T>::format(), |
||||||
|
1, |
||||||
|
{v.size()}, |
||||||
|
{sizeof(T)}); |
||||||
|
}); |
||||||
|
|
||||||
|
cl.def(init([](const buffer &buf) { |
||||||
|
auto info = buf.request(); |
||||||
|
if (info.ndim != 1 || info.strides[0] % static_cast<ssize_t>(sizeof(T))) { |
||||||
|
throw type_error("Only valid 1D buffers can be copied to a vector"); |
||||||
|
} |
||||||
|
if (!detail::compare_buffer_info<T>::compare(info) |
||||||
|
|| (ssize_t) sizeof(T) != info.itemsize) { |
||||||
|
throw type_error("Format mismatch (Python: " + info.format |
||||||
|
+ " C++: " + format_descriptor<T>::format() + ")"); |
||||||
|
} |
||||||
|
|
||||||
|
T *p = static_cast<T *>(info.ptr); |
||||||
|
ssize_t step = info.strides[0] / static_cast<ssize_t>(sizeof(T)); |
||||||
|
T *end = p + info.shape[0] * step; |
||||||
|
if (step == 1) { |
||||||
|
return Vector(p, end); |
||||||
|
} |
||||||
|
Vector vec; |
||||||
|
vec.reserve((size_t) info.shape[0]); |
||||||
|
for (; p != end; p += step) { |
||||||
|
vec.push_back(*p); |
||||||
|
} |
||||||
|
return vec; |
||||||
|
})); |
||||||
|
|
||||||
|
return; |
||||||
|
} |
||||||
|
|
||||||
|
template <typename Vector, typename Class_, typename... Args> |
||||||
|
void vector_buffer_impl(Class_ &, std::false_type) {} |
||||||
|
|
||||||
|
template <typename Vector, typename Class_, typename... Args> |
||||||
|
void vector_buffer(Class_ &cl) { |
||||||
|
vector_buffer_impl<Vector, Class_, Args...>( |
||||||
|
cl, detail::any_of<std::is_same<Args, buffer_protocol>...>{}); |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
|
||||||
|
//
|
||||||
|
// std::vector
|
||||||
|
//
|
||||||
|
template <typename Vector, typename holder_type = std::unique_ptr<Vector>, typename... Args> |
||||||
|
class_<Vector, holder_type> bind_vector(handle scope, std::string const &name, Args &&...args) { |
||||||
|
using Class_ = class_<Vector, holder_type>; |
||||||
|
|
||||||
|
// If the value_type is unregistered (e.g. a converting type) or is itself registered
|
||||||
|
// module-local then make the vector binding module-local as well:
|
||||||
|
using vtype = typename Vector::value_type; |
||||||
|
auto *vtype_info = detail::get_type_info(typeid(vtype)); |
||||||
|
bool local = !vtype_info || vtype_info->module_local; |
||||||
|
|
||||||
|
Class_ cl(scope, name.c_str(), pybind11::module_local(local), std::forward<Args>(args)...); |
||||||
|
|
||||||
|
// Declare the buffer interface if a buffer_protocol() is passed in
|
||||||
|
detail::vector_buffer<Vector, Class_, Args...>(cl); |
||||||
|
|
||||||
|
cl.def(init<>()); |
||||||
|
|
||||||
|
// Register copy constructor (if possible)
|
||||||
|
detail::vector_if_copy_constructible<Vector, Class_>(cl); |
||||||
|
|
||||||
|
// Register comparison-related operators and functions (if possible)
|
||||||
|
detail::vector_if_equal_operator<Vector, Class_>(cl); |
||||||
|
|
||||||
|
// Register stream insertion operator (if possible)
|
||||||
|
detail::vector_if_insertion_operator<Vector, Class_>(cl, name); |
||||||
|
|
||||||
|
// Modifiers require copyable vector value type
|
||||||
|
detail::vector_modifiers<Vector, Class_>(cl); |
||||||
|
|
||||||
|
// Accessor and iterator; return by value if copyable, otherwise we return by ref + keep-alive
|
||||||
|
detail::vector_accessor<Vector, Class_>(cl); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"__bool__", |
||||||
|
[](const Vector &v) -> bool { return !v.empty(); }, |
||||||
|
"Check whether the list is nonempty"); |
||||||
|
|
||||||
|
cl.def("__len__", &Vector::size); |
||||||
|
|
||||||
|
#if 0 |
||||||
|
// C++ style functions deprecated, leaving it here as an example
|
||||||
|
cl.def(init<size_type>()); |
||||||
|
|
||||||
|
cl.def("resize", |
||||||
|
(void (Vector::*) (size_type count)) & Vector::resize, |
||||||
|
"changes the number of elements stored"); |
||||||
|
|
||||||
|
cl.def("erase", |
||||||
|
[](Vector &v, SizeType i) { |
||||||
|
if (i >= v.size()) |
||||||
|
throw index_error(); |
||||||
|
v.erase(v.begin() + i); |
||||||
|
}, "erases element at index ``i``"); |
||||||
|
|
||||||
|
cl.def("empty", &Vector::empty, "checks whether the container is empty"); |
||||||
|
cl.def("size", &Vector::size, "returns the number of elements"); |
||||||
|
cl.def("push_back", (void (Vector::*)(const T&)) &Vector::push_back, "adds an element to the end"); |
||||||
|
cl.def("pop_back", &Vector::pop_back, "removes the last element"); |
||||||
|
|
||||||
|
cl.def("max_size", &Vector::max_size, "returns the maximum possible number of elements"); |
||||||
|
cl.def("reserve", &Vector::reserve, "reserves storage"); |
||||||
|
cl.def("capacity", &Vector::capacity, "returns the number of elements that can be held in currently allocated storage"); |
||||||
|
cl.def("shrink_to_fit", &Vector::shrink_to_fit, "reduces memory usage by freeing unused memory"); |
||||||
|
|
||||||
|
cl.def("clear", &Vector::clear, "clears the contents"); |
||||||
|
cl.def("swap", &Vector::swap, "swaps the contents"); |
||||||
|
|
||||||
|
cl.def("front", [](Vector &v) { |
||||||
|
if (v.size()) return v.front(); |
||||||
|
else throw index_error(); |
||||||
|
}, "access the first element"); |
||||||
|
|
||||||
|
cl.def("back", [](Vector &v) { |
||||||
|
if (v.size()) return v.back(); |
||||||
|
else throw index_error(); |
||||||
|
}, "access the last element "); |
||||||
|
|
||||||
|
#endif |
||||||
|
|
||||||
|
return cl; |
||||||
|
} |
||||||
|
|
||||||
|
//
|
||||||
|
// std::map, std::unordered_map
|
||||||
|
//
|
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_BEGIN(detail) |
||||||
|
|
||||||
|
/* Fallback functions */ |
||||||
|
template <typename, typename, typename... Args> |
||||||
|
void map_if_insertion_operator(const Args &...) {} |
||||||
|
template <typename, typename, typename... Args> |
||||||
|
void map_assignment(const Args &...) {} |
||||||
|
|
||||||
|
// Map assignment when copy-assignable: just copy the value
|
||||||
|
template <typename Map, typename Class_> |
||||||
|
void map_assignment( |
||||||
|
enable_if_t<is_copy_assignable<typename Map::mapped_type>::value, Class_> &cl) { |
||||||
|
using KeyType = typename Map::key_type; |
||||||
|
using MappedType = typename Map::mapped_type; |
||||||
|
|
||||||
|
cl.def("__setitem__", [](Map &m, const KeyType &k, const MappedType &v) { |
||||||
|
auto it = m.find(k); |
||||||
|
if (it != m.end()) { |
||||||
|
it->second = v; |
||||||
|
} else { |
||||||
|
m.emplace(k, v); |
||||||
|
} |
||||||
|
}); |
||||||
|
} |
||||||
|
|
||||||
|
// Not copy-assignable, but still copy-constructible: we can update the value by erasing and
|
||||||
|
// reinserting
|
||||||
|
template <typename Map, typename Class_> |
||||||
|
void map_assignment(enable_if_t<!is_copy_assignable<typename Map::mapped_type>::value |
||||||
|
&& is_copy_constructible<typename Map::mapped_type>::value, |
||||||
|
Class_> &cl) { |
||||||
|
using KeyType = typename Map::key_type; |
||||||
|
using MappedType = typename Map::mapped_type; |
||||||
|
|
||||||
|
cl.def("__setitem__", [](Map &m, const KeyType &k, const MappedType &v) { |
||||||
|
// We can't use m[k] = v; because value type might not be default constructable
|
||||||
|
auto r = m.emplace(k, v); |
||||||
|
if (!r.second) { |
||||||
|
// value type is not copy assignable so the only way to insert it is to erase it
|
||||||
|
// first...
|
||||||
|
m.erase(r.first); |
||||||
|
m.emplace(k, v); |
||||||
|
} |
||||||
|
}); |
||||||
|
} |
||||||
|
|
||||||
|
template <typename Map, typename Class_> |
||||||
|
auto map_if_insertion_operator(Class_ &cl, std::string const &name) |
||||||
|
-> decltype(std::declval<std::ostream &>() << std::declval<typename Map::key_type>() |
||||||
|
<< std::declval<typename Map::mapped_type>(), |
||||||
|
void()) { |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"__repr__", |
||||||
|
[name](Map &m) { |
||||||
|
std::ostringstream s; |
||||||
|
s << name << '{'; |
||||||
|
bool f = false; |
||||||
|
for (auto const &kv : m) { |
||||||
|
if (f) { |
||||||
|
s << ", "; |
||||||
|
} |
||||||
|
s << kv.first << ": " << kv.second; |
||||||
|
f = true; |
||||||
|
} |
||||||
|
s << '}'; |
||||||
|
return s.str(); |
||||||
|
}, |
||||||
|
"Return the canonical string representation of this map."); |
||||||
|
} |
||||||
|
|
||||||
|
template <typename KeyType> |
||||||
|
struct keys_view { |
||||||
|
virtual size_t len() = 0; |
||||||
|
virtual iterator iter() = 0; |
||||||
|
virtual bool contains(const KeyType &k) = 0; |
||||||
|
virtual bool contains(const object &k) = 0; |
||||||
|
virtual ~keys_view() = default; |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename MappedType> |
||||||
|
struct values_view { |
||||||
|
virtual size_t len() = 0; |
||||||
|
virtual iterator iter() = 0; |
||||||
|
virtual ~values_view() = default; |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename KeyType, typename MappedType> |
||||||
|
struct items_view { |
||||||
|
virtual size_t len() = 0; |
||||||
|
virtual iterator iter() = 0; |
||||||
|
virtual ~items_view() = default; |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename Map, typename KeysView> |
||||||
|
struct KeysViewImpl : public KeysView { |
||||||
|
explicit KeysViewImpl(Map &map) : map(map) {} |
||||||
|
size_t len() override { return map.size(); } |
||||||
|
iterator iter() override { return make_key_iterator(map.begin(), map.end()); } |
||||||
|
bool contains(const typename Map::key_type &k) override { return map.find(k) != map.end(); } |
||||||
|
bool contains(const object &) override { return false; } |
||||||
|
Map ↦ |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename Map, typename ValuesView> |
||||||
|
struct ValuesViewImpl : public ValuesView { |
||||||
|
explicit ValuesViewImpl(Map &map) : map(map) {} |
||||||
|
size_t len() override { return map.size(); } |
||||||
|
iterator iter() override { return make_value_iterator(map.begin(), map.end()); } |
||||||
|
Map ↦ |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename Map, typename ItemsView> |
||||||
|
struct ItemsViewImpl : public ItemsView { |
||||||
|
explicit ItemsViewImpl(Map &map) : map(map) {} |
||||||
|
size_t len() override { return map.size(); } |
||||||
|
iterator iter() override { return make_iterator(map.begin(), map.end()); } |
||||||
|
Map ↦ |
||||||
|
}; |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(detail) |
||||||
|
|
||||||
|
template <typename Map, typename holder_type = std::unique_ptr<Map>, typename... Args> |
||||||
|
class_<Map, holder_type> bind_map(handle scope, const std::string &name, Args &&...args) { |
||||||
|
using KeyType = typename Map::key_type; |
||||||
|
using MappedType = typename Map::mapped_type; |
||||||
|
using StrippedKeyType = detail::remove_cvref_t<KeyType>; |
||||||
|
using StrippedMappedType = detail::remove_cvref_t<MappedType>; |
||||||
|
using KeysView = detail::keys_view<StrippedKeyType>; |
||||||
|
using ValuesView = detail::values_view<StrippedMappedType>; |
||||||
|
using ItemsView = detail::items_view<StrippedKeyType, StrippedMappedType>; |
||||||
|
using Class_ = class_<Map, holder_type>; |
||||||
|
|
||||||
|
// If either type is a non-module-local bound type then make the map binding non-local as well;
|
||||||
|
// otherwise (e.g. both types are either module-local or converting) the map will be
|
||||||
|
// module-local.
|
||||||
|
auto *tinfo = detail::get_type_info(typeid(MappedType)); |
||||||
|
bool local = !tinfo || tinfo->module_local; |
||||||
|
if (local) { |
||||||
|
tinfo = detail::get_type_info(typeid(KeyType)); |
||||||
|
local = !tinfo || tinfo->module_local; |
||||||
|
} |
||||||
|
|
||||||
|
Class_ cl(scope, name.c_str(), pybind11::module_local(local), std::forward<Args>(args)...); |
||||||
|
static constexpr auto key_type_descr = detail::make_caster<KeyType>::name; |
||||||
|
static constexpr auto mapped_type_descr = detail::make_caster<MappedType>::name; |
||||||
|
std::string key_type_name(key_type_descr.text), mapped_type_name(mapped_type_descr.text); |
||||||
|
|
||||||
|
// If key type isn't properly wrapped, fall back to C++ names
|
||||||
|
if (key_type_name == "%") { |
||||||
|
key_type_name = detail::type_info_description(typeid(KeyType)); |
||||||
|
} |
||||||
|
// Similarly for value type:
|
||||||
|
if (mapped_type_name == "%") { |
||||||
|
mapped_type_name = detail::type_info_description(typeid(MappedType)); |
||||||
|
} |
||||||
|
|
||||||
|
// Wrap KeysView[KeyType] if it wasn't already wrapped
|
||||||
|
if (!detail::get_type_info(typeid(KeysView))) { |
||||||
|
class_<KeysView> keys_view( |
||||||
|
scope, ("KeysView[" + key_type_name + "]").c_str(), pybind11::module_local(local)); |
||||||
|
keys_view.def("__len__", &KeysView::len); |
||||||
|
keys_view.def("__iter__", |
||||||
|
&KeysView::iter, |
||||||
|
keep_alive<0, 1>() /* Essential: keep view alive while iterator exists */ |
||||||
|
); |
||||||
|
keys_view.def("__contains__", |
||||||
|
static_cast<bool (KeysView::*)(const KeyType &)>(&KeysView::contains)); |
||||||
|
// Fallback for when the object is not of the key type
|
||||||
|
keys_view.def("__contains__", |
||||||
|
static_cast<bool (KeysView::*)(const object &)>(&KeysView::contains)); |
||||||
|
} |
||||||
|
// Similarly for ValuesView:
|
||||||
|
if (!detail::get_type_info(typeid(ValuesView))) { |
||||||
|
class_<ValuesView> values_view(scope, |
||||||
|
("ValuesView[" + mapped_type_name + "]").c_str(), |
||||||
|
pybind11::module_local(local)); |
||||||
|
values_view.def("__len__", &ValuesView::len); |
||||||
|
values_view.def("__iter__", |
||||||
|
&ValuesView::iter, |
||||||
|
keep_alive<0, 1>() /* Essential: keep view alive while iterator exists */ |
||||||
|
); |
||||||
|
} |
||||||
|
// Similarly for ItemsView:
|
||||||
|
if (!detail::get_type_info(typeid(ItemsView))) { |
||||||
|
class_<ItemsView> items_view( |
||||||
|
scope, |
||||||
|
("ItemsView[" + key_type_name + ", ").append(mapped_type_name + "]").c_str(), |
||||||
|
pybind11::module_local(local)); |
||||||
|
items_view.def("__len__", &ItemsView::len); |
||||||
|
items_view.def("__iter__", |
||||||
|
&ItemsView::iter, |
||||||
|
keep_alive<0, 1>() /* Essential: keep view alive while iterator exists */ |
||||||
|
); |
||||||
|
} |
||||||
|
|
||||||
|
cl.def(init<>()); |
||||||
|
|
||||||
|
// Register stream insertion operator (if possible)
|
||||||
|
detail::map_if_insertion_operator<Map, Class_>(cl, name); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"__bool__", |
||||||
|
[](const Map &m) -> bool { return !m.empty(); }, |
||||||
|
"Check whether the map is nonempty"); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"__iter__", |
||||||
|
[](Map &m) { return make_key_iterator(m.begin(), m.end()); }, |
||||||
|
keep_alive<0, 1>() /* Essential: keep map alive while iterator exists */ |
||||||
|
); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"keys", |
||||||
|
[](Map &m) { |
||||||
|
return std::unique_ptr<KeysView>(new detail::KeysViewImpl<Map, KeysView>(m)); |
||||||
|
}, |
||||||
|
keep_alive<0, 1>() /* Essential: keep map alive while view exists */ |
||||||
|
); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"values", |
||||||
|
[](Map &m) { |
||||||
|
return std::unique_ptr<ValuesView>(new detail::ValuesViewImpl<Map, ValuesView>(m)); |
||||||
|
}, |
||||||
|
keep_alive<0, 1>() /* Essential: keep map alive while view exists */ |
||||||
|
); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"items", |
||||||
|
[](Map &m) { |
||||||
|
return std::unique_ptr<ItemsView>(new detail::ItemsViewImpl<Map, ItemsView>(m)); |
||||||
|
}, |
||||||
|
keep_alive<0, 1>() /* Essential: keep map alive while view exists */ |
||||||
|
); |
||||||
|
|
||||||
|
cl.def( |
||||||
|
"__getitem__", |
||||||
|
[](Map &m, const KeyType &k) -> MappedType & { |
||||||
|
auto it = m.find(k); |
||||||
|
if (it == m.end()) { |
||||||
|
throw key_error(); |
||||||
|
} |
||||||
|
return it->second; |
||||||
|
}, |
||||||
|
return_value_policy::reference_internal // ref + keepalive
|
||||||
|
); |
||||||
|
|
||||||
|
cl.def("__contains__", [](Map &m, const KeyType &k) -> bool { |
||||||
|
auto it = m.find(k); |
||||||
|
if (it == m.end()) { |
||||||
|
return false; |
||||||
|
} |
||||||
|
return true; |
||||||
|
}); |
||||||
|
// Fallback for when the object is not of the key type
|
||||||
|
cl.def("__contains__", [](Map &, const object &) -> bool { return false; }); |
||||||
|
|
||||||
|
// Assignment provided only if the type is copyable
|
||||||
|
detail::map_assignment<Map, Class_>(cl); |
||||||
|
|
||||||
|
cl.def("__delitem__", [](Map &m, const KeyType &k) { |
||||||
|
auto it = m.find(k); |
||||||
|
if (it == m.end()) { |
||||||
|
throw key_error(); |
||||||
|
} |
||||||
|
m.erase(it); |
||||||
|
}); |
||||||
|
|
||||||
|
cl.def("__len__", &Map::size); |
||||||
|
|
||||||
|
return cl; |
||||||
|
} |
||||||
|
|
||||||
|
PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
||||||
@ -0,0 +1,107 @@ |
|||||||
|
import os |
||||||
|
|
||||||
|
import nox |
||||||
|
|
||||||
|
nox.needs_version = ">=2022.1.7" |
||||||
|
nox.options.sessions = ["lint", "tests", "tests_packaging"] |
||||||
|
|
||||||
|
PYTHON_VERSIONS = [ |
||||||
|
"3.6", |
||||||
|
"3.7", |
||||||
|
"3.8", |
||||||
|
"3.9", |
||||||
|
"3.10", |
||||||
|
"3.11", |
||||||
|
"pypy3.7", |
||||||
|
"pypy3.8", |
||||||
|
"pypy3.9", |
||||||
|
] |
||||||
|
|
||||||
|
if os.environ.get("CI", None): |
||||||
|
nox.options.error_on_missing_interpreters = True |
||||||
|
|
||||||
|
|
||||||
|
@nox.session(reuse_venv=True) |
||||||
|
def lint(session: nox.Session) -> None: |
||||||
|
""" |
||||||
|
Lint the codebase (except for clang-format/tidy). |
||||||
|
""" |
||||||
|
session.install("pre-commit") |
||||||
|
session.run("pre-commit", "run", "-a", *session.posargs) |
||||||
|
|
||||||
|
|
||||||
|
@nox.session(python=PYTHON_VERSIONS) |
||||||
|
def tests(session: nox.Session) -> None: |
||||||
|
""" |
||||||
|
Run the tests (requires a compiler). |
||||||
|
""" |
||||||
|
tmpdir = session.create_tmp() |
||||||
|
session.install("cmake") |
||||||
|
session.install("-r", "tests/requirements.txt") |
||||||
|
session.run( |
||||||
|
"cmake", |
||||||
|
"-S.", |
||||||
|
f"-B{tmpdir}", |
||||||
|
"-DPYBIND11_WERROR=ON", |
||||||
|
"-DDOWNLOAD_CATCH=ON", |
||||||
|
"-DDOWNLOAD_EIGEN=ON", |
||||||
|
*session.posargs, |
||||||
|
) |
||||||
|
session.run("cmake", "--build", tmpdir) |
||||||
|
session.run("cmake", "--build", tmpdir, "--config=Release", "--target", "check") |
||||||
|
|
||||||
|
|
||||||
|
@nox.session |
||||||
|
def tests_packaging(session: nox.Session) -> None: |
||||||
|
""" |
||||||
|
Run the packaging tests. |
||||||
|
""" |
||||||
|
|
||||||
|
session.install("-r", "tests/requirements.txt", "--prefer-binary") |
||||||
|
session.run("pytest", "tests/extra_python_package", *session.posargs) |
||||||
|
|
||||||
|
|
||||||
|
@nox.session(reuse_venv=True) |
||||||
|
def docs(session: nox.Session) -> None: |
||||||
|
""" |
||||||
|
Build the docs. Pass "serve" to serve. |
||||||
|
""" |
||||||
|
|
||||||
|
session.install("-r", "docs/requirements.txt") |
||||||
|
session.chdir("docs") |
||||||
|
|
||||||
|
if "pdf" in session.posargs: |
||||||
|
session.run("sphinx-build", "-M", "latexpdf", ".", "_build") |
||||||
|
return |
||||||
|
|
||||||
|
session.run("sphinx-build", "-M", "html", ".", "_build") |
||||||
|
|
||||||
|
if "serve" in session.posargs: |
||||||
|
session.log("Launching docs at http://localhost:8000/ - use Ctrl-C to quit") |
||||||
|
session.run("python", "-m", "http.server", "8000", "-d", "_build/html") |
||||||
|
elif session.posargs: |
||||||
|
session.error("Unsupported argument to docs") |
||||||
|
|
||||||
|
|
||||||
|
@nox.session(reuse_venv=True) |
||||||
|
def make_changelog(session: nox.Session) -> None: |
||||||
|
""" |
||||||
|
Inspect the closed issues and make entries for a changelog. |
||||||
|
""" |
||||||
|
session.install("ghapi", "rich") |
||||||
|
session.run("python", "tools/make_changelog.py") |
||||||
|
|
||||||
|
|
||||||
|
@nox.session(reuse_venv=True) |
||||||
|
def build(session: nox.Session) -> None: |
||||||
|
""" |
||||||
|
Build SDists and wheels. |
||||||
|
""" |
||||||
|
|
||||||
|
session.install("build") |
||||||
|
session.log("Building normal files") |
||||||
|
session.run("python", "-m", "build", *session.posargs) |
||||||
|
session.log("Building pybind11-global files (PYBIND11_GLOBAL_SDIST=1)") |
||||||
|
session.run( |
||||||
|
"python", "-m", "build", *session.posargs, env={"PYBIND11_GLOBAL_SDIST": "1"} |
||||||
|
) |
||||||
@ -0,0 +1,17 @@ |
|||||||
|
import sys |
||||||
|
|
||||||
|
if sys.version_info < (3, 6): |
||||||
|
msg = "pybind11 does not support Python < 3.6. 2.9 was the last release supporting Python 2.7 and 3.5." |
||||||
|
raise ImportError(msg) |
||||||
|
|
||||||
|
|
||||||
|
from ._version import __version__, version_info |
||||||
|
from .commands import get_cmake_dir, get_include, get_pkgconfig_dir |
||||||
|
|
||||||
|
__all__ = ( |
||||||
|
"version_info", |
||||||
|
"__version__", |
||||||
|
"get_include", |
||||||
|
"get_cmake_dir", |
||||||
|
"get_pkgconfig_dir", |
||||||
|
) |
||||||
@ -0,0 +1,62 @@ |
|||||||
|
# pylint: disable=missing-function-docstring |
||||||
|
|
||||||
|
import argparse |
||||||
|
import sys |
||||||
|
import sysconfig |
||||||
|
|
||||||
|
from ._version import __version__ |
||||||
|
from .commands import get_cmake_dir, get_include, get_pkgconfig_dir |
||||||
|
|
||||||
|
|
||||||
|
def print_includes() -> None: |
||||||
|
dirs = [ |
||||||
|
sysconfig.get_path("include"), |
||||||
|
sysconfig.get_path("platinclude"), |
||||||
|
get_include(), |
||||||
|
] |
||||||
|
|
||||||
|
# Make unique but preserve order |
||||||
|
unique_dirs = [] |
||||||
|
for d in dirs: |
||||||
|
if d and d not in unique_dirs: |
||||||
|
unique_dirs.append(d) |
||||||
|
|
||||||
|
print(" ".join("-I" + d for d in unique_dirs)) |
||||||
|
|
||||||
|
|
||||||
|
def main() -> None: |
||||||
|
parser = argparse.ArgumentParser() |
||||||
|
parser.add_argument( |
||||||
|
"--version", |
||||||
|
action="version", |
||||||
|
version=__version__, |
||||||
|
help="Print the version and exit.", |
||||||
|
) |
||||||
|
parser.add_argument( |
||||||
|
"--includes", |
||||||
|
action="store_true", |
||||||
|
help="Include flags for both pybind11 and Python headers.", |
||||||
|
) |
||||||
|
parser.add_argument( |
||||||
|
"--cmakedir", |
||||||
|
action="store_true", |
||||||
|
help="Print the CMake module directory, ideal for setting -Dpybind11_ROOT in CMake.", |
||||||
|
) |
||||||
|
parser.add_argument( |
||||||
|
"--pkgconfigdir", |
||||||
|
action="store_true", |
||||||
|
help="Print the pkgconfig directory, ideal for setting $PKG_CONFIG_PATH.", |
||||||
|
) |
||||||
|
args = parser.parse_args() |
||||||
|
if not sys.argv[1:]: |
||||||
|
parser.print_help() |
||||||
|
if args.includes: |
||||||
|
print_includes() |
||||||
|
if args.cmakedir: |
||||||
|
print(get_cmake_dir()) |
||||||
|
if args.pkgconfigdir: |
||||||
|
print(get_pkgconfig_dir()) |
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__": |
||||||
|
main() |
||||||
@ -0,0 +1,12 @@ |
|||||||
|
from typing import Union |
||||||
|
|
||||||
|
|
||||||
|
def _to_int(s: str) -> Union[int, str]: |
||||||
|
try: |
||||||
|
return int(s) |
||||||
|
except ValueError: |
||||||
|
return s |
||||||
|
|
||||||
|
|
||||||
|
__version__ = "2.10.4" |
||||||
|
version_info = tuple(_to_int(s) for s in __version__.split(".")) |
||||||
@ -0,0 +1,37 @@ |
|||||||
|
import os |
||||||
|
|
||||||
|
DIR = os.path.abspath(os.path.dirname(__file__)) |
||||||
|
|
||||||
|
|
||||||
|
def get_include(user: bool = False) -> str: # pylint: disable=unused-argument |
||||||
|
""" |
||||||
|
Return the path to the pybind11 include directory. The historical "user" |
||||||
|
argument is unused, and may be removed. |
||||||
|
""" |
||||||
|
installed_path = os.path.join(DIR, "include") |
||||||
|
source_path = os.path.join(os.path.dirname(DIR), "include") |
||||||
|
return installed_path if os.path.exists(installed_path) else source_path |
||||||
|
|
||||||
|
|
||||||
|
def get_cmake_dir() -> str: |
||||||
|
""" |
||||||
|
Return the path to the pybind11 CMake module directory. |
||||||
|
""" |
||||||
|
cmake_installed_path = os.path.join(DIR, "share", "cmake", "pybind11") |
||||||
|
if os.path.exists(cmake_installed_path): |
||||||
|
return cmake_installed_path |
||||||
|
|
||||||
|
msg = "pybind11 not installed, installation required to access the CMake files" |
||||||
|
raise ImportError(msg) |
||||||
|
|
||||||
|
|
||||||
|
def get_pkgconfig_dir() -> str: |
||||||
|
""" |
||||||
|
Return the path to the pybind11 pkgconfig directory. |
||||||
|
""" |
||||||
|
pkgconfig_installed_path = os.path.join(DIR, "share", "pkgconfig") |
||||||
|
if os.path.exists(pkgconfig_installed_path): |
||||||
|
return pkgconfig_installed_path |
||||||
|
|
||||||
|
msg = "pybind11 not installed, installation required to access the pkgconfig files" |
||||||
|
raise ImportError(msg) |
||||||
@ -0,0 +1,503 @@ |
|||||||
|
""" |
||||||
|
This module provides helpers for C++11+ projects using pybind11. |
||||||
|
|
||||||
|
LICENSE: |
||||||
|
|
||||||
|
Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch>, 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. |
||||||
|
""" |
||||||
|
|
||||||
|
# IMPORTANT: If you change this file in the pybind11 repo, also review |
||||||
|
# setup_helpers.pyi for matching changes. |
||||||
|
# |
||||||
|
# If you copy this file in, you don't |
||||||
|
# need the .pyi file; it's just an interface file for static type checkers. |
||||||
|
|
||||||
|
import contextlib |
||||||
|
import os |
||||||
|
import platform |
||||||
|
import shlex |
||||||
|
import shutil |
||||||
|
import sys |
||||||
|
import sysconfig |
||||||
|
import tempfile |
||||||
|
import threading |
||||||
|
import warnings |
||||||
|
from functools import lru_cache |
||||||
|
from pathlib import Path |
||||||
|
from typing import ( |
||||||
|
Any, |
||||||
|
Callable, |
||||||
|
Dict, |
||||||
|
Iterable, |
||||||
|
Iterator, |
||||||
|
List, |
||||||
|
Optional, |
||||||
|
Tuple, |
||||||
|
TypeVar, |
||||||
|
Union, |
||||||
|
) |
||||||
|
|
||||||
|
try: |
||||||
|
from setuptools import Extension as _Extension |
||||||
|
from setuptools.command.build_ext import build_ext as _build_ext |
||||||
|
except ImportError: |
||||||
|
from distutils.command.build_ext import build_ext as _build_ext |
||||||
|
from distutils.extension import Extension as _Extension |
||||||
|
|
||||||
|
import distutils.ccompiler |
||||||
|
import distutils.errors |
||||||
|
|
||||||
|
WIN = sys.platform.startswith("win32") and "mingw" not in sysconfig.get_platform() |
||||||
|
MACOS = sys.platform.startswith("darwin") |
||||||
|
STD_TMPL = "/std:c++{}" if WIN else "-std=c++{}" |
||||||
|
|
||||||
|
|
||||||
|
# It is recommended to use PEP 518 builds if using this module. However, this |
||||||
|
# file explicitly supports being copied into a user's project directory |
||||||
|
# standalone, and pulling pybind11 with the deprecated setup_requires feature. |
||||||
|
# If you copy the file, remember to add it to your MANIFEST.in, and add the current |
||||||
|
# directory into your path if it sits beside your setup.py. |
||||||
|
|
||||||
|
|
||||||
|
class Pybind11Extension(_Extension): # type: ignore[misc] |
||||||
|
""" |
||||||
|
Build a C++11+ Extension module with pybind11. This automatically adds the |
||||||
|
recommended flags when you init the extension and assumes C++ sources - you |
||||||
|
can further modify the options yourself. |
||||||
|
|
||||||
|
The customizations are: |
||||||
|
|
||||||
|
* ``/EHsc`` and ``/bigobj`` on Windows |
||||||
|
* ``stdlib=libc++`` on macOS |
||||||
|
* ``visibility=hidden`` and ``-g0`` on Unix |
||||||
|
|
||||||
|
Finally, you can set ``cxx_std`` via constructor or afterwards to enable |
||||||
|
flags for C++ std, and a few extra helper flags related to the C++ standard |
||||||
|
level. It is _highly_ recommended you either set this, or use the provided |
||||||
|
``build_ext``, which will search for the highest supported extension for |
||||||
|
you if the ``cxx_std`` property is not set. Do not set the ``cxx_std`` |
||||||
|
property more than once, as flags are added when you set it. Set the |
||||||
|
property to None to disable the addition of C++ standard flags. |
||||||
|
|
||||||
|
If you want to add pybind11 headers manually, for example for an exact |
||||||
|
git checkout, then set ``include_pybind11=False``. |
||||||
|
""" |
||||||
|
|
||||||
|
# flags are prepended, so that they can be further overridden, e.g. by |
||||||
|
# ``extra_compile_args=["-g"]``. |
||||||
|
|
||||||
|
def _add_cflags(self, flags: List[str]) -> None: |
||||||
|
self.extra_compile_args[:0] = flags |
||||||
|
|
||||||
|
def _add_ldflags(self, flags: List[str]) -> None: |
||||||
|
self.extra_link_args[:0] = flags |
||||||
|
|
||||||
|
def __init__(self, *args: Any, **kwargs: Any) -> None: |
||||||
|
self._cxx_level = 0 |
||||||
|
cxx_std = kwargs.pop("cxx_std", 0) |
||||||
|
|
||||||
|
if "language" not in kwargs: |
||||||
|
kwargs["language"] = "c++" |
||||||
|
|
||||||
|
include_pybind11 = kwargs.pop("include_pybind11", True) |
||||||
|
|
||||||
|
super().__init__(*args, **kwargs) |
||||||
|
|
||||||
|
# Include the installed package pybind11 headers |
||||||
|
if include_pybind11: |
||||||
|
# If using setup_requires, this fails the first time - that's okay |
||||||
|
try: |
||||||
|
import pybind11 |
||||||
|
|
||||||
|
pyinc = pybind11.get_include() |
||||||
|
|
||||||
|
if pyinc not in self.include_dirs: |
||||||
|
self.include_dirs.append(pyinc) |
||||||
|
except ModuleNotFoundError: |
||||||
|
pass |
||||||
|
|
||||||
|
self.cxx_std = cxx_std |
||||||
|
|
||||||
|
cflags = [] |
||||||
|
ldflags = [] |
||||||
|
if WIN: |
||||||
|
cflags += ["/EHsc", "/bigobj"] |
||||||
|
else: |
||||||
|
cflags += ["-fvisibility=hidden"] |
||||||
|
env_cflags = os.environ.get("CFLAGS", "") |
||||||
|
env_cppflags = os.environ.get("CPPFLAGS", "") |
||||||
|
c_cpp_flags = shlex.split(env_cflags) + shlex.split(env_cppflags) |
||||||
|
if not any(opt.startswith("-g") for opt in c_cpp_flags): |
||||||
|
cflags += ["-g0"] |
||||||
|
if MACOS: |
||||||
|
cflags += ["-stdlib=libc++"] |
||||||
|
ldflags += ["-stdlib=libc++"] |
||||||
|
self._add_cflags(cflags) |
||||||
|
self._add_ldflags(ldflags) |
||||||
|
|
||||||
|
@property |
||||||
|
def cxx_std(self) -> int: |
||||||
|
""" |
||||||
|
The CXX standard level. If set, will add the required flags. If left at |
||||||
|
0, it will trigger an automatic search when pybind11's build_ext is |
||||||
|
used. If None, will have no effect. Besides just the flags, this may |
||||||
|
add a macos-min 10.9 or 10.14 flag if MACOSX_DEPLOYMENT_TARGET is |
||||||
|
unset. |
||||||
|
""" |
||||||
|
return self._cxx_level |
||||||
|
|
||||||
|
@cxx_std.setter |
||||||
|
def cxx_std(self, level: int) -> None: |
||||||
|
if self._cxx_level: |
||||||
|
warnings.warn( |
||||||
|
"You cannot safely change the cxx_level after setting it!", stacklevel=2 |
||||||
|
) |
||||||
|
|
||||||
|
# MSVC 2015 Update 3 and later only have 14 (and later 17) modes, so |
||||||
|
# force a valid flag here. |
||||||
|
if WIN and level == 11: |
||||||
|
level = 14 |
||||||
|
|
||||||
|
self._cxx_level = level |
||||||
|
|
||||||
|
if not level: |
||||||
|
return |
||||||
|
|
||||||
|
cflags = [STD_TMPL.format(level)] |
||||||
|
ldflags = [] |
||||||
|
|
||||||
|
if MACOS and "MACOSX_DEPLOYMENT_TARGET" not in os.environ: |
||||||
|
# C++17 requires a higher min version of macOS. An earlier version |
||||||
|
# (10.12 or 10.13) can be set manually via environment variable if |
||||||
|
# you are careful in your feature usage, but 10.14 is the safest |
||||||
|
# setting for general use. However, never set higher than the |
||||||
|
# current macOS version! |
||||||
|
current_macos = tuple(int(x) for x in platform.mac_ver()[0].split(".")[:2]) |
||||||
|
desired_macos = (10, 9) if level < 17 else (10, 14) |
||||||
|
macos_string = ".".join(str(x) for x in min(current_macos, desired_macos)) |
||||||
|
macosx_min = f"-mmacosx-version-min={macos_string}" |
||||||
|
cflags += [macosx_min] |
||||||
|
ldflags += [macosx_min] |
||||||
|
|
||||||
|
self._add_cflags(cflags) |
||||||
|
self._add_ldflags(ldflags) |
||||||
|
|
||||||
|
|
||||||
|
# Just in case someone clever tries to multithread |
||||||
|
tmp_chdir_lock = threading.Lock() |
||||||
|
|
||||||
|
|
||||||
|
@contextlib.contextmanager |
||||||
|
def tmp_chdir() -> Iterator[str]: |
||||||
|
"Prepare and enter a temporary directory, cleanup when done" |
||||||
|
|
||||||
|
# Threadsafe |
||||||
|
with tmp_chdir_lock: |
||||||
|
olddir = os.getcwd() |
||||||
|
try: |
||||||
|
tmpdir = tempfile.mkdtemp() |
||||||
|
os.chdir(tmpdir) |
||||||
|
yield tmpdir |
||||||
|
finally: |
||||||
|
os.chdir(olddir) |
||||||
|
shutil.rmtree(tmpdir) |
||||||
|
|
||||||
|
|
||||||
|
# cf http://bugs.python.org/issue26689 |
||||||
|
def has_flag(compiler: Any, flag: str) -> bool: |
||||||
|
""" |
||||||
|
Return the flag if a flag name is supported on the |
||||||
|
specified compiler, otherwise None (can be used as a boolean). |
||||||
|
If multiple flags are passed, return the first that matches. |
||||||
|
""" |
||||||
|
|
||||||
|
with tmp_chdir(): |
||||||
|
fname = Path("flagcheck.cpp") |
||||||
|
# Don't trigger -Wunused-parameter. |
||||||
|
fname.write_text("int main (int, char **) { return 0; }", encoding="utf-8") |
||||||
|
|
||||||
|
try: |
||||||
|
compiler.compile([str(fname)], extra_postargs=[flag]) |
||||||
|
except distutils.errors.CompileError: |
||||||
|
return False |
||||||
|
return True |
||||||
|
|
||||||
|
|
||||||
|
# Every call will cache the result |
||||||
|
cpp_flag_cache = None |
||||||
|
|
||||||
|
|
||||||
|
@lru_cache() |
||||||
|
def auto_cpp_level(compiler: Any) -> Union[str, int]: |
||||||
|
""" |
||||||
|
Return the max supported C++ std level (17, 14, or 11). Returns latest on Windows. |
||||||
|
""" |
||||||
|
|
||||||
|
if WIN: |
||||||
|
return "latest" |
||||||
|
|
||||||
|
levels = [17, 14, 11] |
||||||
|
|
||||||
|
for level in levels: |
||||||
|
if has_flag(compiler, STD_TMPL.format(level)): |
||||||
|
return level |
||||||
|
|
||||||
|
msg = "Unsupported compiler -- at least C++11 support is needed!" |
||||||
|
raise RuntimeError(msg) |
||||||
|
|
||||||
|
|
||||||
|
class build_ext(_build_ext): # type: ignore[misc] # noqa: N801 |
||||||
|
""" |
||||||
|
Customized build_ext that allows an auto-search for the highest supported |
||||||
|
C++ level for Pybind11Extension. This is only needed for the auto-search |
||||||
|
for now, and is completely optional otherwise. |
||||||
|
""" |
||||||
|
|
||||||
|
def build_extensions(self) -> None: |
||||||
|
""" |
||||||
|
Build extensions, injecting C++ std for Pybind11Extension if needed. |
||||||
|
""" |
||||||
|
|
||||||
|
for ext in self.extensions: |
||||||
|
if hasattr(ext, "_cxx_level") and ext._cxx_level == 0: |
||||||
|
ext.cxx_std = auto_cpp_level(self.compiler) |
||||||
|
|
||||||
|
super().build_extensions() |
||||||
|
|
||||||
|
|
||||||
|
def intree_extensions( |
||||||
|
paths: Iterable[str], package_dir: Optional[Dict[str, str]] = None |
||||||
|
) -> List[Pybind11Extension]: |
||||||
|
""" |
||||||
|
Generate Pybind11Extensions from source files directly located in a Python |
||||||
|
source tree. |
||||||
|
|
||||||
|
``package_dir`` behaves as in ``setuptools.setup``. If unset, the Python |
||||||
|
package root parent is determined as the first parent directory that does |
||||||
|
not contain an ``__init__.py`` file. |
||||||
|
""" |
||||||
|
exts = [] |
||||||
|
|
||||||
|
if package_dir is None: |
||||||
|
for path in paths: |
||||||
|
parent, _ = os.path.split(path) |
||||||
|
while os.path.exists(os.path.join(parent, "__init__.py")): |
||||||
|
parent, _ = os.path.split(parent) |
||||||
|
relname, _ = os.path.splitext(os.path.relpath(path, parent)) |
||||||
|
qualified_name = relname.replace(os.path.sep, ".") |
||||||
|
exts.append(Pybind11Extension(qualified_name, [path])) |
||||||
|
return exts |
||||||
|
|
||||||
|
for path in paths: |
||||||
|
for prefix, parent in package_dir.items(): |
||||||
|
if path.startswith(parent): |
||||||
|
relname, _ = os.path.splitext(os.path.relpath(path, parent)) |
||||||
|
qualified_name = relname.replace(os.path.sep, ".") |
||||||
|
if prefix: |
||||||
|
qualified_name = prefix + "." + qualified_name |
||||||
|
exts.append(Pybind11Extension(qualified_name, [path])) |
||||||
|
break |
||||||
|
else: |
||||||
|
msg = ( |
||||||
|
f"path {path} is not a child of any of the directories listed " |
||||||
|
f"in 'package_dir' ({package_dir})" |
||||||
|
) |
||||||
|
raise ValueError(msg) |
||||||
|
|
||||||
|
return exts |
||||||
|
|
||||||
|
|
||||||
|
def naive_recompile(obj: str, src: str) -> bool: |
||||||
|
""" |
||||||
|
This will recompile only if the source file changes. It does not check |
||||||
|
header files, so a more advanced function or Ccache is better if you have |
||||||
|
editable header files in your package. |
||||||
|
""" |
||||||
|
return os.stat(obj).st_mtime < os.stat(src).st_mtime |
||||||
|
|
||||||
|
|
||||||
|
def no_recompile(obg: str, src: str) -> bool: # pylint: disable=unused-argument |
||||||
|
""" |
||||||
|
This is the safest but slowest choice (and is the default) - will always |
||||||
|
recompile sources. |
||||||
|
""" |
||||||
|
return True |
||||||
|
|
||||||
|
|
||||||
|
S = TypeVar("S", bound="ParallelCompile") |
||||||
|
|
||||||
|
CCompilerMethod = Callable[ |
||||||
|
[ |
||||||
|
distutils.ccompiler.CCompiler, |
||||||
|
List[str], |
||||||
|
Optional[str], |
||||||
|
Optional[Union[Tuple[str], Tuple[str, Optional[str]]]], |
||||||
|
Optional[List[str]], |
||||||
|
bool, |
||||||
|
Optional[List[str]], |
||||||
|
Optional[List[str]], |
||||||
|
Optional[List[str]], |
||||||
|
], |
||||||
|
List[str], |
||||||
|
] |
||||||
|
|
||||||
|
|
||||||
|
# Optional parallel compile utility |
||||||
|
# inspired by: http://stackoverflow.com/questions/11013851/speeding-up-build-process-with-distutils |
||||||
|
# and: https://github.com/tbenthompson/cppimport/blob/stable/cppimport/build_module.py |
||||||
|
# and NumPy's parallel distutils module: |
||||||
|
# https://github.com/numpy/numpy/blob/master/numpy/distutils/ccompiler.py |
||||||
|
class ParallelCompile: |
||||||
|
""" |
||||||
|
Make a parallel compile function. Inspired by |
||||||
|
numpy.distutils.ccompiler.CCompiler.compile and cppimport. |
||||||
|
|
||||||
|
This takes several arguments that allow you to customize the compile |
||||||
|
function created: |
||||||
|
|
||||||
|
envvar: |
||||||
|
Set an environment variable to control the compilation threads, like |
||||||
|
NPY_NUM_BUILD_JOBS |
||||||
|
default: |
||||||
|
0 will automatically multithread, or 1 will only multithread if the |
||||||
|
envvar is set. |
||||||
|
max: |
||||||
|
The limit for automatic multithreading if non-zero |
||||||
|
needs_recompile: |
||||||
|
A function of (obj, src) that returns True when recompile is needed. No |
||||||
|
effect in isolated mode; use ccache instead, see |
||||||
|
https://github.com/matplotlib/matplotlib/issues/1507/ |
||||||
|
|
||||||
|
To use:: |
||||||
|
|
||||||
|
ParallelCompile("NPY_NUM_BUILD_JOBS").install() |
||||||
|
|
||||||
|
or:: |
||||||
|
|
||||||
|
with ParallelCompile("NPY_NUM_BUILD_JOBS"): |
||||||
|
setup(...) |
||||||
|
|
||||||
|
By default, this assumes all files need to be recompiled. A smarter |
||||||
|
function can be provided via needs_recompile. If the output has not yet |
||||||
|
been generated, the compile will always run, and this function is not |
||||||
|
called. |
||||||
|
""" |
||||||
|
|
||||||
|
__slots__ = ("envvar", "default", "max", "_old", "needs_recompile") |
||||||
|
|
||||||
|
def __init__( |
||||||
|
self, |
||||||
|
envvar: Optional[str] = None, |
||||||
|
default: int = 0, |
||||||
|
max: int = 0, # pylint: disable=redefined-builtin |
||||||
|
needs_recompile: Callable[[str, str], bool] = no_recompile, |
||||||
|
) -> None: |
||||||
|
self.envvar = envvar |
||||||
|
self.default = default |
||||||
|
self.max = max |
||||||
|
self.needs_recompile = needs_recompile |
||||||
|
self._old: List[CCompilerMethod] = [] |
||||||
|
|
||||||
|
def function(self) -> CCompilerMethod: |
||||||
|
""" |
||||||
|
Builds a function object usable as distutils.ccompiler.CCompiler.compile. |
||||||
|
""" |
||||||
|
|
||||||
|
def compile_function( |
||||||
|
compiler: distutils.ccompiler.CCompiler, |
||||||
|
sources: List[str], |
||||||
|
output_dir: Optional[str] = None, |
||||||
|
macros: Optional[Union[Tuple[str], Tuple[str, Optional[str]]]] = None, |
||||||
|
include_dirs: Optional[List[str]] = None, |
||||||
|
debug: bool = False, |
||||||
|
extra_preargs: Optional[List[str]] = None, |
||||||
|
extra_postargs: Optional[List[str]] = None, |
||||||
|
depends: Optional[List[str]] = None, |
||||||
|
) -> Any: |
||||||
|
# These lines are directly from distutils.ccompiler.CCompiler |
||||||
|
macros, objects, extra_postargs, pp_opts, build = compiler._setup_compile( # type: ignore[attr-defined] |
||||||
|
output_dir, macros, include_dirs, sources, depends, extra_postargs |
||||||
|
) |
||||||
|
cc_args = compiler._get_cc_args(pp_opts, debug, extra_preargs) # type: ignore[attr-defined] |
||||||
|
|
||||||
|
# The number of threads; start with default. |
||||||
|
threads = self.default |
||||||
|
|
||||||
|
# Determine the number of compilation threads, unless set by an environment variable. |
||||||
|
if self.envvar is not None: |
||||||
|
threads = int(os.environ.get(self.envvar, self.default)) |
||||||
|
|
||||||
|
def _single_compile(obj: Any) -> None: |
||||||
|
try: |
||||||
|
src, ext = build[obj] |
||||||
|
except KeyError: |
||||||
|
return |
||||||
|
|
||||||
|
if not os.path.exists(obj) or self.needs_recompile(obj, src): |
||||||
|
compiler._compile(obj, src, ext, cc_args, extra_postargs, pp_opts) # type: ignore[attr-defined] |
||||||
|
|
||||||
|
try: |
||||||
|
# Importing .synchronize checks for platforms that have some multiprocessing |
||||||
|
# capabilities but lack semaphores, such as AWS Lambda and Android Termux. |
||||||
|
import multiprocessing.synchronize |
||||||
|
from multiprocessing.pool import ThreadPool |
||||||
|
except ImportError: |
||||||
|
threads = 1 |
||||||
|
|
||||||
|
if threads == 0: |
||||||
|
try: |
||||||
|
threads = multiprocessing.cpu_count() |
||||||
|
threads = self.max if self.max and self.max < threads else threads |
||||||
|
except NotImplementedError: |
||||||
|
threads = 1 |
||||||
|
|
||||||
|
if threads > 1: |
||||||
|
with ThreadPool(threads) as pool: |
||||||
|
for _ in pool.imap_unordered(_single_compile, objects): |
||||||
|
pass |
||||||
|
else: |
||||||
|
for ob in objects: |
||||||
|
_single_compile(ob) |
||||||
|
|
||||||
|
return objects |
||||||
|
|
||||||
|
return compile_function |
||||||
|
|
||||||
|
def install(self: S) -> S: |
||||||
|
""" |
||||||
|
Installs the compile function into distutils.ccompiler.CCompiler.compile. |
||||||
|
""" |
||||||
|
distutils.ccompiler.CCompiler.compile = self.function() # type: ignore[assignment] |
||||||
|
return self |
||||||
|
|
||||||
|
def __enter__(self: S) -> S: |
||||||
|
self._old.append(distutils.ccompiler.CCompiler.compile) |
||||||
|
return self.install() |
||||||
|
|
||||||
|
def __exit__(self, *args: Any) -> None: |
||||||
|
distutils.ccompiler.CCompiler.compile = self._old.pop() # type: ignore[assignment] |
||||||
@ -0,0 +1,61 @@ |
|||||||
|
[build-system] |
||||||
|
requires = ["setuptools>=42", "cmake>=3.18", "ninja"] |
||||||
|
build-backend = "setuptools.build_meta" |
||||||
|
|
||||||
|
[tool.check-manifest] |
||||||
|
ignore = [ |
||||||
|
"tests/**", |
||||||
|
"docs/**", |
||||||
|
"tools/**", |
||||||
|
"include/**", |
||||||
|
".*", |
||||||
|
"pybind11/include/**", |
||||||
|
"pybind11/share/**", |
||||||
|
"CMakeLists.txt", |
||||||
|
"noxfile.py", |
||||||
|
] |
||||||
|
|
||||||
|
[tool.isort] |
||||||
|
# Needs the compiled .so modules and env.py from tests |
||||||
|
known_first_party = "env,pybind11_cross_module_tests,pybind11_tests," |
||||||
|
# For black compatibility |
||||||
|
profile = "black" |
||||||
|
|
||||||
|
[tool.mypy] |
||||||
|
files = ["pybind11"] |
||||||
|
python_version = "3.6" |
||||||
|
strict = true |
||||||
|
show_error_codes = true |
||||||
|
enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"] |
||||||
|
warn_unreachable = true |
||||||
|
|
||||||
|
[[tool.mypy.overrides]] |
||||||
|
module = ["ghapi.*", "setuptools.*"] |
||||||
|
ignore_missing_imports = true |
||||||
|
|
||||||
|
|
||||||
|
[tool.pytest.ini_options] |
||||||
|
minversion = "6.0" |
||||||
|
addopts = ["-ra", "--showlocals", "--strict-markers", "--strict-config"] |
||||||
|
xfail_strict = true |
||||||
|
filterwarnings = ["error"] |
||||||
|
log_cli_level = "info" |
||||||
|
testpaths = [ |
||||||
|
"tests", |
||||||
|
] |
||||||
|
timeout=300 |
||||||
|
|
||||||
|
|
||||||
|
[tool.pylint] |
||||||
|
master.py-version = "3.6" |
||||||
|
reports.output-format = "colorized" |
||||||
|
messages_control.disable = [ |
||||||
|
"design", |
||||||
|
"fixme", |
||||||
|
"imports", |
||||||
|
"line-too-long", |
||||||
|
"imports", |
||||||
|
"invalid-name", |
||||||
|
"protected-access", |
||||||
|
"missing-module-docstring", |
||||||
|
] |
||||||
@ -0,0 +1,50 @@ |
|||||||
|
[metadata] |
||||||
|
long_description = file: README.rst |
||||||
|
long_description_content_type = text/x-rst |
||||||
|
description = Seamless operability between C++11 and Python |
||||||
|
author = Wenzel Jakob |
||||||
|
author_email = wenzel.jakob@epfl.ch |
||||||
|
url = https://github.com/pybind/pybind11 |
||||||
|
license = BSD |
||||||
|
|
||||||
|
classifiers = |
||||||
|
Development Status :: 5 - Production/Stable |
||||||
|
Intended Audience :: Developers |
||||||
|
Topic :: Software Development :: Libraries :: Python Modules |
||||||
|
Topic :: Utilities |
||||||
|
Programming Language :: C++ |
||||||
|
Programming Language :: Python :: 3 :: Only |
||||||
|
Programming Language :: Python :: 3.6 |
||||||
|
Programming Language :: Python :: 3.7 |
||||||
|
Programming Language :: Python :: 3.8 |
||||||
|
Programming Language :: Python :: 3.9 |
||||||
|
Programming Language :: Python :: 3.10 |
||||||
|
Programming Language :: Python :: 3.11 |
||||||
|
License :: OSI Approved :: BSD License |
||||||
|
Programming Language :: Python :: Implementation :: PyPy |
||||||
|
Programming Language :: Python :: Implementation :: CPython |
||||||
|
Programming Language :: C++ |
||||||
|
Topic :: Software Development :: Libraries :: Python Modules |
||||||
|
|
||||||
|
keywords = |
||||||
|
C++11 |
||||||
|
Python bindings |
||||||
|
|
||||||
|
project_urls = |
||||||
|
Documentation = https://pybind11.readthedocs.io/ |
||||||
|
Bug Tracker = https://github.com/pybind/pybind11/issues |
||||||
|
Discussions = https://github.com/pybind/pybind11/discussions |
||||||
|
Changelog = https://pybind11.readthedocs.io/en/latest/changelog.html |
||||||
|
Chat = https://gitter.im/pybind/Lobby |
||||||
|
|
||||||
|
[options] |
||||||
|
python_requires = >=3.6 |
||||||
|
zip_safe = False |
||||||
|
|
||||||
|
|
||||||
|
[flake8] |
||||||
|
max-line-length = 120 |
||||||
|
show_source = True |
||||||
|
exclude = .git, __pycache__, build, dist, docs, tools, venv |
||||||
|
extend-ignore = E203, E722 |
||||||
|
extend-select = B902, B904 |
||||||
@ -0,0 +1,150 @@ |
|||||||
|
#!/usr/bin/env python3 |
||||||
|
|
||||||
|
# Setup script for PyPI; use CMakeFile.txt to build extension modules |
||||||
|
|
||||||
|
import contextlib |
||||||
|
import os |
||||||
|
import re |
||||||
|
import shutil |
||||||
|
import string |
||||||
|
import subprocess |
||||||
|
import sys |
||||||
|
from pathlib import Path |
||||||
|
from tempfile import TemporaryDirectory |
||||||
|
from typing import Dict, Iterator, List, Union |
||||||
|
|
||||||
|
import setuptools.command.sdist |
||||||
|
|
||||||
|
DIR = Path(__file__).parent.absolute() |
||||||
|
VERSION_REGEX = re.compile( |
||||||
|
r"^\s*#\s*define\s+PYBIND11_VERSION_([A-Z]+)\s+(.*)$", re.MULTILINE |
||||||
|
) |
||||||
|
VERSION_FILE = Path("pybind11/_version.py") |
||||||
|
COMMON_FILE = Path("include/pybind11/detail/common.h") |
||||||
|
|
||||||
|
|
||||||
|
def build_expected_version_hex(matches: Dict[str, str]) -> str: |
||||||
|
patch_level_serial = matches["PATCH"] |
||||||
|
serial = None |
||||||
|
major = int(matches["MAJOR"]) |
||||||
|
minor = int(matches["MINOR"]) |
||||||
|
flds = patch_level_serial.split(".") |
||||||
|
if flds: |
||||||
|
patch = int(flds[0]) |
||||||
|
if len(flds) == 1: |
||||||
|
level = "0" |
||||||
|
serial = 0 |
||||||
|
elif len(flds) == 2: |
||||||
|
level_serial = flds[1] |
||||||
|
for level in ("a", "b", "c", "dev"): |
||||||
|
if level_serial.startswith(level): |
||||||
|
serial = int(level_serial[len(level) :]) |
||||||
|
break |
||||||
|
if serial is None: |
||||||
|
msg = f'Invalid PYBIND11_VERSION_PATCH: "{patch_level_serial}"' |
||||||
|
raise RuntimeError(msg) |
||||||
|
version_hex_str = f"{major:02x}{minor:02x}{patch:02x}{level[:1]}{serial:x}" |
||||||
|
return f"0x{version_hex_str.upper()}" |
||||||
|
|
||||||
|
|
||||||
|
# PYBIND11_GLOBAL_SDIST will build a different sdist, with the python-headers |
||||||
|
# files, and the sys.prefix files (CMake and headers). |
||||||
|
|
||||||
|
global_sdist = os.environ.get("PYBIND11_GLOBAL_SDIST", False) |
||||||
|
|
||||||
|
setup_py = Path( |
||||||
|
"tools/setup_global.py.in" if global_sdist else "tools/setup_main.py.in" |
||||||
|
) |
||||||
|
extra_cmd = 'cmdclass["sdist"] = SDist\n' |
||||||
|
|
||||||
|
to_src = ( |
||||||
|
(Path("pyproject.toml"), Path("tools/pyproject.toml")), |
||||||
|
(Path("setup.py"), setup_py), |
||||||
|
) |
||||||
|
|
||||||
|
|
||||||
|
# Read the listed version |
||||||
|
loc: Dict[str, str] = {} |
||||||
|
code = compile(VERSION_FILE.read_text(encoding="utf-8"), "pybind11/_version.py", "exec") |
||||||
|
exec(code, loc) |
||||||
|
version = loc["__version__"] |
||||||
|
|
||||||
|
# Verify that the version matches the one in C++ |
||||||
|
matches = dict(VERSION_REGEX.findall(COMMON_FILE.read_text(encoding="utf8"))) |
||||||
|
cpp_version = "{MAJOR}.{MINOR}.{PATCH}".format(**matches) |
||||||
|
if version != cpp_version: |
||||||
|
msg = f"Python version {version} does not match C++ version {cpp_version}!" |
||||||
|
raise RuntimeError(msg) |
||||||
|
|
||||||
|
version_hex = matches.get("HEX", "MISSING") |
||||||
|
exp_version_hex = build_expected_version_hex(matches) |
||||||
|
if version_hex != exp_version_hex: |
||||||
|
msg = f"PYBIND11_VERSION_HEX {version_hex} does not match expected value {exp_version_hex}!" |
||||||
|
raise RuntimeError(msg) |
||||||
|
|
||||||
|
|
||||||
|
# TODO: use literals & overload (typing extensions or Python 3.8) |
||||||
|
def get_and_replace( |
||||||
|
filename: Path, binary: bool = False, **opts: str |
||||||
|
) -> Union[bytes, str]: |
||||||
|
if binary: |
||||||
|
contents = filename.read_bytes() |
||||||
|
return string.Template(contents.decode()).substitute(opts).encode() |
||||||
|
|
||||||
|
return string.Template(filename.read_text()).substitute(opts) |
||||||
|
|
||||||
|
|
||||||
|
# Use our input files instead when making the SDist (and anything that depends |
||||||
|
# on it, like a wheel) |
||||||
|
class SDist(setuptools.command.sdist.sdist): # type: ignore[misc] |
||||||
|
def make_release_tree(self, base_dir: str, files: List[str]) -> None: |
||||||
|
super().make_release_tree(base_dir, files) |
||||||
|
|
||||||
|
for to, src in to_src: |
||||||
|
txt = get_and_replace(src, binary=True, version=version, extra_cmd="") |
||||||
|
|
||||||
|
dest = Path(base_dir) / to |
||||||
|
|
||||||
|
# This is normally linked, so unlink before writing! |
||||||
|
dest.unlink() |
||||||
|
dest.write_bytes(txt) # type: ignore[arg-type] |
||||||
|
|
||||||
|
|
||||||
|
# Remove the CMake install directory when done |
||||||
|
@contextlib.contextmanager |
||||||
|
def remove_output(*sources: str) -> Iterator[None]: |
||||||
|
try: |
||||||
|
yield |
||||||
|
finally: |
||||||
|
for src in sources: |
||||||
|
shutil.rmtree(src) |
||||||
|
|
||||||
|
|
||||||
|
with remove_output("pybind11/include", "pybind11/share"): |
||||||
|
# Generate the files if they are not present. |
||||||
|
with TemporaryDirectory() as tmpdir: |
||||||
|
cmd = ["cmake", "-S", ".", "-B", tmpdir] + [ |
||||||
|
"-DCMAKE_INSTALL_PREFIX=pybind11", |
||||||
|
"-DBUILD_TESTING=OFF", |
||||||
|
"-DPYBIND11_NOPYTHON=ON", |
||||||
|
"-Dprefix_for_pc_file=${pcfiledir}/../../", |
||||||
|
] |
||||||
|
if "CMAKE_ARGS" in os.environ: |
||||||
|
fcommand = [ |
||||||
|
c |
||||||
|
for c in os.environ["CMAKE_ARGS"].split() |
||||||
|
if "DCMAKE_INSTALL_PREFIX" not in c |
||||||
|
] |
||||||
|
cmd += fcommand |
||||||
|
subprocess.run(cmd, check=True, cwd=DIR, stdout=sys.stdout, stderr=sys.stderr) |
||||||
|
subprocess.run( |
||||||
|
["cmake", "--install", tmpdir], |
||||||
|
check=True, |
||||||
|
cwd=DIR, |
||||||
|
stdout=sys.stdout, |
||||||
|
stderr=sys.stderr, |
||||||
|
) |
||||||
|
|
||||||
|
txt = get_and_replace(setup_py, version=version, extra_cmd=extra_cmd) |
||||||
|
code = compile(txt, setup_py, "exec") |
||||||
|
exec(code, {"SDist": SDist}) |
||||||
@ -0,0 +1,583 @@ |
|||||||
|
# CMakeLists.txt -- Build system for the pybind11 test suite |
||||||
|
# |
||||||
|
# Copyright (c) 2015 Wenzel Jakob <wenzel@inf.ethz.ch> |
||||||
|
# |
||||||
|
# All rights reserved. Use of this source code is governed by a |
||||||
|
# BSD-style license that can be found in the LICENSE file. |
||||||
|
|
||||||
|
cmake_minimum_required(VERSION 3.4) |
||||||
|
|
||||||
|
# The `cmake_minimum_required(VERSION 3.4...3.18)` syntax does not work with |
||||||
|
# some versions of VS that have a patched CMake 3.11. This forces us to emulate |
||||||
|
# the behavior using the following workaround: |
||||||
|
if(${CMAKE_VERSION} VERSION_LESS 3.21) |
||||||
|
cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}) |
||||||
|
else() |
||||||
|
cmake_policy(VERSION 3.21) |
||||||
|
endif() |
||||||
|
|
||||||
|
# Only needed for CMake < 3.5 support |
||||||
|
include(CMakeParseArguments) |
||||||
|
|
||||||
|
# Filter out items; print an optional message if any items filtered. This ignores extensions. |
||||||
|
# |
||||||
|
# Usage: |
||||||
|
# pybind11_filter_tests(LISTNAME file1.cpp file2.cpp ... MESSAGE "") |
||||||
|
# |
||||||
|
macro(pybind11_filter_tests LISTNAME) |
||||||
|
cmake_parse_arguments(ARG "" "MESSAGE" "" ${ARGN}) |
||||||
|
set(PYBIND11_FILTER_TESTS_FOUND OFF) |
||||||
|
# Make a list of the test without any extensions, for easier filtering. |
||||||
|
set(_TMP_ACTUAL_LIST "${${LISTNAME}};") # enforce ';' at the end to allow matching last item. |
||||||
|
string(REGEX REPLACE "\\.[^.;]*;" ";" LIST_WITHOUT_EXTENSIONS "${_TMP_ACTUAL_LIST}") |
||||||
|
foreach(filename IN LISTS ARG_UNPARSED_ARGUMENTS) |
||||||
|
string(REGEX REPLACE "\\.[^.]*$" "" filename_no_ext ${filename}) |
||||||
|
# Search in the list without extensions. |
||||||
|
list(FIND LIST_WITHOUT_EXTENSIONS ${filename_no_ext} _FILE_FOUND) |
||||||
|
if(_FILE_FOUND GREATER -1) |
||||||
|
list(REMOVE_AT ${LISTNAME} ${_FILE_FOUND}) # And remove from the list with extensions. |
||||||
|
list(REMOVE_AT LIST_WITHOUT_EXTENSIONS ${_FILE_FOUND} |
||||||
|
)# And our search list, to ensure it is in sync. |
||||||
|
set(PYBIND11_FILTER_TESTS_FOUND ON) |
||||||
|
endif() |
||||||
|
endforeach() |
||||||
|
if(PYBIND11_FILTER_TESTS_FOUND AND ARG_MESSAGE) |
||||||
|
message(STATUS "${ARG_MESSAGE}") |
||||||
|
endif() |
||||||
|
endmacro() |
||||||
|
|
||||||
|
macro(possibly_uninitialized) |
||||||
|
foreach(VARNAME ${ARGN}) |
||||||
|
if(NOT DEFINED "${VARNAME}") |
||||||
|
set("${VARNAME}" "") |
||||||
|
endif() |
||||||
|
endforeach() |
||||||
|
endmacro() |
||||||
|
|
||||||
|
# Function to add additional targets if any of the provided tests are found. |
||||||
|
# Needles; Specifies the test names to look for. |
||||||
|
# Additions; Specifies the additional test targets to add when any of the needles are found. |
||||||
|
macro(tests_extra_targets needles additions) |
||||||
|
# Add the index for this relation to the index extra targets map. |
||||||
|
list(LENGTH PYBIND11_TEST_EXTRA_TARGETS PYBIND11_TEST_EXTRA_TARGETS_LEN) |
||||||
|
list(APPEND PYBIND11_TEST_EXTRA_TARGETS ${PYBIND11_TEST_EXTRA_TARGETS_LEN}) |
||||||
|
# Add the test names to look for, and the associated test target additions. |
||||||
|
set(PYBIND11_TEST_EXTRA_TARGETS_NEEDLES_${PYBIND11_TEST_EXTRA_TARGETS_LEN} ${needles}) |
||||||
|
set(PYBIND11_TEST_EXTRA_TARGETS_ADDITION_${PYBIND11_TEST_EXTRA_TARGETS_LEN} ${additions}) |
||||||
|
endmacro() |
||||||
|
|
||||||
|
# New Python support |
||||||
|
if(DEFINED Python_EXECUTABLE) |
||||||
|
set(PYTHON_EXECUTABLE "${Python_EXECUTABLE}") |
||||||
|
set(PYTHON_VERSION "${Python_VERSION}") |
||||||
|
endif() |
||||||
|
|
||||||
|
# There's no harm in including a project in a project |
||||||
|
project(pybind11_tests CXX) |
||||||
|
|
||||||
|
# Access FindCatch and more |
||||||
|
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/../tools") |
||||||
|
|
||||||
|
option(PYBIND11_WERROR "Report all warnings as errors" OFF) |
||||||
|
option(DOWNLOAD_EIGEN "Download EIGEN (requires CMake 3.11+)" OFF) |
||||||
|
option(PYBIND11_CUDA_TESTS "Enable building CUDA tests (requires CMake 3.12+)" OFF) |
||||||
|
set(PYBIND11_TEST_OVERRIDE |
||||||
|
"" |
||||||
|
CACHE STRING "Tests from ;-separated list of *.cpp files will be built instead of all tests") |
||||||
|
set(PYBIND11_TEST_FILTER |
||||||
|
"" |
||||||
|
CACHE STRING "Tests from ;-separated list of *.cpp files will be removed from all tests") |
||||||
|
|
||||||
|
if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR) |
||||||
|
# We're being loaded directly, i.e. not via add_subdirectory, so make this |
||||||
|
# work as its own project and load the pybind11Config to get the tools we need |
||||||
|
find_package(pybind11 REQUIRED CONFIG) |
||||||
|
endif() |
||||||
|
|
||||||
|
if(NOT CMAKE_BUILD_TYPE AND NOT DEFINED CMAKE_CONFIGURATION_TYPES) |
||||||
|
message(STATUS "Setting tests build type to MinSizeRel as none was specified") |
||||||
|
set(CMAKE_BUILD_TYPE |
||||||
|
MinSizeRel |
||||||
|
CACHE STRING "Choose the type of build." FORCE) |
||||||
|
set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" |
||||||
|
"RelWithDebInfo") |
||||||
|
endif() |
||||||
|
|
||||||
|
if(PYBIND11_CUDA_TESTS) |
||||||
|
enable_language(CUDA) |
||||||
|
if(DEFINED CMAKE_CXX_STANDARD) |
||||||
|
set(CMAKE_CUDA_STANDARD ${CMAKE_CXX_STANDARD}) |
||||||
|
endif() |
||||||
|
set(CMAKE_CUDA_STANDARD_REQUIRED ON) |
||||||
|
endif() |
||||||
|
|
||||||
|
# Full set of test files (you can override these; see below, overrides ignore extension) |
||||||
|
# Any test that has no extension is both .py and .cpp, so 'foo' will add 'foo.cpp' and 'foo.py'. |
||||||
|
# Any test that has an extension is exclusively that and handled as such. |
||||||
|
set(PYBIND11_TEST_FILES |
||||||
|
test_async |
||||||
|
test_buffers |
||||||
|
test_builtin_casters |
||||||
|
test_call_policies |
||||||
|
test_callbacks |
||||||
|
test_chrono |
||||||
|
test_class |
||||||
|
test_const_name |
||||||
|
test_constants_and_functions |
||||||
|
test_copy_move |
||||||
|
test_custom_type_casters |
||||||
|
test_custom_type_setup |
||||||
|
test_docstring_options |
||||||
|
test_eigen_matrix |
||||||
|
test_eigen_tensor |
||||||
|
test_enum |
||||||
|
test_eval |
||||||
|
test_exceptions |
||||||
|
test_factory_constructors |
||||||
|
test_gil_scoped |
||||||
|
test_iostream |
||||||
|
test_kwargs_and_defaults |
||||||
|
test_local_bindings |
||||||
|
test_methods_and_attributes |
||||||
|
test_modules |
||||||
|
test_multiple_inheritance |
||||||
|
test_numpy_array |
||||||
|
test_numpy_dtypes |
||||||
|
test_numpy_vectorize |
||||||
|
test_opaque_types |
||||||
|
test_operator_overloading |
||||||
|
test_pickling |
||||||
|
test_pytypes |
||||||
|
test_sequences_and_iterators |
||||||
|
test_smart_ptr |
||||||
|
test_stl |
||||||
|
test_stl_binders |
||||||
|
test_tagbased_polymorphic |
||||||
|
test_thread |
||||||
|
test_union |
||||||
|
test_virtual_functions) |
||||||
|
|
||||||
|
# Invoking cmake with something like: |
||||||
|
# cmake -DPYBIND11_TEST_OVERRIDE="test_callbacks.cpp;test_pickling.cpp" .. |
||||||
|
# lets you override the tests that get compiled and run. You can restore to all tests with: |
||||||
|
# cmake -DPYBIND11_TEST_OVERRIDE= .. |
||||||
|
if(PYBIND11_TEST_OVERRIDE) |
||||||
|
# Instead of doing a direct override here, we iterate over the overrides without extension and |
||||||
|
# match them against entries from the PYBIND11_TEST_FILES, anything that not matches goes into the filter list. |
||||||
|
string(REGEX REPLACE "\\.[^.;]*;" ";" TEST_OVERRIDE_NO_EXT "${PYBIND11_TEST_OVERRIDE};") |
||||||
|
string(REGEX REPLACE "\\.[^.;]*;" ";" TEST_FILES_NO_EXT "${PYBIND11_TEST_FILES};") |
||||||
|
# This allows the override to be done with extensions, preserving backwards compatibility. |
||||||
|
foreach(test_name ${TEST_FILES_NO_EXT}) |
||||||
|
if(NOT ${test_name} IN_LIST TEST_OVERRIDE_NO_EXT |
||||||
|
)# If not in the allowlist, add to be filtered out. |
||||||
|
list(APPEND PYBIND11_TEST_FILTER ${test_name}) |
||||||
|
endif() |
||||||
|
endforeach() |
||||||
|
endif() |
||||||
|
|
||||||
|
# You can also filter tests: |
||||||
|
if(PYBIND11_TEST_FILTER) |
||||||
|
pybind11_filter_tests(PYBIND11_TEST_FILES ${PYBIND11_TEST_FILTER}) |
||||||
|
endif() |
||||||
|
|
||||||
|
# Skip tests for CUDA check: |
||||||
|
# /pybind11/tests/test_constants_and_functions.cpp(125): |
||||||
|
# error: incompatible exception specifications |
||||||
|
if(PYBIND11_CUDA_TESTS) |
||||||
|
pybind11_filter_tests( |
||||||
|
PYBIND11_TEST_FILES test_constants_and_functions.cpp MESSAGE |
||||||
|
"Skipping test_constants_and_functions due to incompatible exception specifications") |
||||||
|
endif() |
||||||
|
|
||||||
|
# Now that the test filtering is complete, we need to split the list into the test for PYTEST |
||||||
|
# and the list for the cpp targets. |
||||||
|
set(PYBIND11_CPPTEST_FILES "") |
||||||
|
set(PYBIND11_PYTEST_FILES "") |
||||||
|
|
||||||
|
foreach(test_name ${PYBIND11_TEST_FILES}) |
||||||
|
if(test_name MATCHES "\\.py$") # Ends in .py, purely python test. |
||||||
|
list(APPEND PYBIND11_PYTEST_FILES ${test_name}) |
||||||
|
elseif(test_name MATCHES "\\.cpp$") # Ends in .cpp, purely cpp test. |
||||||
|
list(APPEND PYBIND11_CPPTEST_FILES ${test_name}) |
||||||
|
elseif(NOT test_name MATCHES "\\.") # No extension specified, assume both, add extension. |
||||||
|
list(APPEND PYBIND11_PYTEST_FILES ${test_name}.py) |
||||||
|
list(APPEND PYBIND11_CPPTEST_FILES ${test_name}.cpp) |
||||||
|
else() |
||||||
|
message(WARNING "Unhanded test extension in test: ${test_name}") |
||||||
|
endif() |
||||||
|
endforeach() |
||||||
|
set(PYBIND11_TEST_FILES ${PYBIND11_CPPTEST_FILES}) |
||||||
|
list(SORT PYBIND11_PYTEST_FILES) |
||||||
|
|
||||||
|
# Contains the set of test files that require pybind11_cross_module_tests to be |
||||||
|
# built; if none of these are built (i.e. because TEST_OVERRIDE is used and |
||||||
|
# doesn't include them) the second module doesn't get built. |
||||||
|
tests_extra_targets("test_exceptions.py;test_local_bindings.py;test_stl.py;test_stl_binders.py" |
||||||
|
"pybind11_cross_module_tests") |
||||||
|
|
||||||
|
# And add additional targets for other tests. |
||||||
|
tests_extra_targets("test_exceptions.py" "cross_module_interleaved_error_already_set") |
||||||
|
tests_extra_targets("test_gil_scoped.py" "cross_module_gil_utils") |
||||||
|
|
||||||
|
set(PYBIND11_EIGEN_REPO |
||||||
|
"https://gitlab.com/libeigen/eigen.git" |
||||||
|
CACHE STRING "Eigen repository to use for tests") |
||||||
|
# Always use a hash for reconfigure speed and security reasons |
||||||
|
# Include the version number for pretty printing (keep in sync) |
||||||
|
set(PYBIND11_EIGEN_VERSION_AND_HASH |
||||||
|
"3.4.0;929bc0e191d0927b1735b9a1ddc0e8b77e3a25ec" |
||||||
|
CACHE STRING "Eigen version to use for tests, format: VERSION;HASH") |
||||||
|
|
||||||
|
list(GET PYBIND11_EIGEN_VERSION_AND_HASH 0 PYBIND11_EIGEN_VERSION_STRING) |
||||||
|
list(GET PYBIND11_EIGEN_VERSION_AND_HASH 1 PYBIND11_EIGEN_VERSION_HASH) |
||||||
|
|
||||||
|
# Check if Eigen is available; if not, remove from PYBIND11_TEST_FILES (but |
||||||
|
# keep it in PYBIND11_PYTEST_FILES, so that we get the "eigen is not installed" |
||||||
|
# skip message). |
||||||
|
list(FIND PYBIND11_TEST_FILES test_eigen_matrix.cpp PYBIND11_TEST_FILES_EIGEN_I) |
||||||
|
if(PYBIND11_TEST_FILES_EIGEN_I EQUAL -1) |
||||||
|
list(FIND PYBIND11_TEST_FILES test_eigen_tensor.cpp PYBIND11_TEST_FILES_EIGEN_I) |
||||||
|
endif() |
||||||
|
if(PYBIND11_TEST_FILES_EIGEN_I GREATER -1) |
||||||
|
# Try loading via newer Eigen's Eigen3Config first (bypassing tools/FindEigen3.cmake). |
||||||
|
# Eigen 3.3.1+ exports a cmake 3.0+ target for handling dependency requirements, but also |
||||||
|
# produces a fatal error if loaded from a pre-3.0 cmake. |
||||||
|
if(DOWNLOAD_EIGEN) |
||||||
|
if(CMAKE_VERSION VERSION_LESS 3.11) |
||||||
|
message(FATAL_ERROR "CMake 3.11+ required when using DOWNLOAD_EIGEN") |
||||||
|
endif() |
||||||
|
|
||||||
|
include(FetchContent) |
||||||
|
FetchContent_Declare( |
||||||
|
eigen |
||||||
|
GIT_REPOSITORY "${PYBIND11_EIGEN_REPO}" |
||||||
|
GIT_TAG "${PYBIND11_EIGEN_VERSION_HASH}") |
||||||
|
|
||||||
|
FetchContent_GetProperties(eigen) |
||||||
|
if(NOT eigen_POPULATED) |
||||||
|
message( |
||||||
|
STATUS |
||||||
|
"Downloading Eigen ${PYBIND11_EIGEN_VERSION_STRING} (${PYBIND11_EIGEN_VERSION_HASH}) from ${PYBIND11_EIGEN_REPO}" |
||||||
|
) |
||||||
|
FetchContent_Populate(eigen) |
||||||
|
endif() |
||||||
|
|
||||||
|
set(EIGEN3_INCLUDE_DIR ${eigen_SOURCE_DIR}) |
||||||
|
set(EIGEN3_FOUND TRUE) |
||||||
|
# When getting locally, the version is not visible from a superprojet, |
||||||
|
# so just force it. |
||||||
|
set(EIGEN3_VERSION "${PYBIND11_EIGEN_VERSION_STRING}") |
||||||
|
|
||||||
|
else() |
||||||
|
find_package(Eigen3 3.2.7 QUIET CONFIG) |
||||||
|
|
||||||
|
if(NOT EIGEN3_FOUND) |
||||||
|
# Couldn't load via target, so fall back to allowing module mode finding, which will pick up |
||||||
|
# tools/FindEigen3.cmake |
||||||
|
find_package(Eigen3 3.2.7 QUIET) |
||||||
|
endif() |
||||||
|
endif() |
||||||
|
|
||||||
|
if(EIGEN3_FOUND) |
||||||
|
if(NOT TARGET Eigen3::Eigen) |
||||||
|
add_library(Eigen3::Eigen IMPORTED INTERFACE) |
||||||
|
set_property(TARGET Eigen3::Eigen PROPERTY INTERFACE_INCLUDE_DIRECTORIES |
||||||
|
"${EIGEN3_INCLUDE_DIR}") |
||||||
|
endif() |
||||||
|
|
||||||
|
# Eigen 3.3.1+ cmake sets EIGEN3_VERSION_STRING (and hard codes the version when installed |
||||||
|
# rather than looking it up in the cmake script); older versions, and the |
||||||
|
# tools/FindEigen3.cmake, set EIGEN3_VERSION instead. |
||||||
|
if(NOT EIGEN3_VERSION AND EIGEN3_VERSION_STRING) |
||||||
|
set(EIGEN3_VERSION ${EIGEN3_VERSION_STRING}) |
||||||
|
endif() |
||||||
|
message(STATUS "Building tests with Eigen v${EIGEN3_VERSION}") |
||||||
|
|
||||||
|
if(NOT (CMAKE_CXX_COMPILER_ID STREQUAL "GNU" AND CMAKE_CXX_COMPILER_VERSION VERSION_LESS 5.0)) |
||||||
|
tests_extra_targets("test_eigen_tensor.py" "eigen_tensor_avoid_stl_array") |
||||||
|
endif() |
||||||
|
|
||||||
|
else() |
||||||
|
list(FIND PYBIND11_TEST_FILES test_eigen_matrix.cpp PYBIND11_TEST_FILES_EIGEN_I) |
||||||
|
if(PYBIND11_TEST_FILES_EIGEN_I GREATER -1) |
||||||
|
list(REMOVE_AT PYBIND11_TEST_FILES ${PYBIND11_TEST_FILES_EIGEN_I}) |
||||||
|
endif() |
||||||
|
|
||||||
|
list(FIND PYBIND11_TEST_FILES test_eigen_tensor.cpp PYBIND11_TEST_FILES_EIGEN_I) |
||||||
|
if(PYBIND11_TEST_FILES_EIGEN_I GREATER -1) |
||||||
|
list(REMOVE_AT PYBIND11_TEST_FILES ${PYBIND11_TEST_FILES_EIGEN_I}) |
||||||
|
endif() |
||||||
|
message( |
||||||
|
STATUS "Building tests WITHOUT Eigen, use -DDOWNLOAD_EIGEN=ON on CMake 3.11+ to download") |
||||||
|
endif() |
||||||
|
endif() |
||||||
|
|
||||||
|
# Some code doesn't support gcc 4 |
||||||
|
if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" AND CMAKE_CXX_COMPILER_VERSION VERSION_LESS 5.0) |
||||||
|
list(FIND PYBIND11_TEST_FILES test_eigen_tensor.cpp PYBIND11_TEST_FILES_EIGEN_I) |
||||||
|
if(PYBIND11_TEST_FILES_EIGEN_I GREATER -1) |
||||||
|
list(REMOVE_AT PYBIND11_TEST_FILES ${PYBIND11_TEST_FILES_EIGEN_I}) |
||||||
|
endif() |
||||||
|
endif() |
||||||
|
|
||||||
|
# Optional dependency for some tests (boost::variant is only supported with version >= 1.56) |
||||||
|
find_package(Boost 1.56) |
||||||
|
|
||||||
|
if(Boost_FOUND) |
||||||
|
if(NOT TARGET Boost::headers) |
||||||
|
add_library(Boost::headers IMPORTED INTERFACE) |
||||||
|
if(TARGET Boost::boost) |
||||||
|
# Classic FindBoost |
||||||
|
set_property(TARGET Boost::boost PROPERTY INTERFACE_LINK_LIBRARIES Boost::boost) |
||||||
|
else() |
||||||
|
# Very old FindBoost, or newer Boost than CMake in older CMakes |
||||||
|
set_property(TARGET Boost::headers PROPERTY INTERFACE_INCLUDE_DIRECTORIES |
||||||
|
${Boost_INCLUDE_DIRS}) |
||||||
|
endif() |
||||||
|
endif() |
||||||
|
endif() |
||||||
|
|
||||||
|
# Check if we need to add -lstdc++fs or -lc++fs or nothing |
||||||
|
if(DEFINED CMAKE_CXX_STANDARD AND CMAKE_CXX_STANDARD LESS 17) |
||||||
|
set(STD_FS_NO_LIB_NEEDED TRUE) |
||||||
|
elseif(MSVC) |
||||||
|
set(STD_FS_NO_LIB_NEEDED TRUE) |
||||||
|
else() |
||||||
|
file( |
||||||
|
WRITE ${CMAKE_CURRENT_BINARY_DIR}/main.cpp |
||||||
|
"#include <filesystem>\nint main(int argc, char ** argv) {\n std::filesystem::path p(argv[0]);\n return p.string().length();\n}" |
||||||
|
) |
||||||
|
try_compile( |
||||||
|
STD_FS_NO_LIB_NEEDED ${CMAKE_CURRENT_BINARY_DIR} |
||||||
|
SOURCES ${CMAKE_CURRENT_BINARY_DIR}/main.cpp |
||||||
|
COMPILE_DEFINITIONS -std=c++17) |
||||||
|
try_compile( |
||||||
|
STD_FS_NEEDS_STDCXXFS ${CMAKE_CURRENT_BINARY_DIR} |
||||||
|
SOURCES ${CMAKE_CURRENT_BINARY_DIR}/main.cpp |
||||||
|
COMPILE_DEFINITIONS -std=c++17 |
||||||
|
LINK_LIBRARIES stdc++fs) |
||||||
|
try_compile( |
||||||
|
STD_FS_NEEDS_CXXFS ${CMAKE_CURRENT_BINARY_DIR} |
||||||
|
SOURCES ${CMAKE_CURRENT_BINARY_DIR}/main.cpp |
||||||
|
COMPILE_DEFINITIONS -std=c++17 |
||||||
|
LINK_LIBRARIES c++fs) |
||||||
|
endif() |
||||||
|
|
||||||
|
if(${STD_FS_NEEDS_STDCXXFS}) |
||||||
|
set(STD_FS_LIB stdc++fs) |
||||||
|
elseif(${STD_FS_NEEDS_CXXFS}) |
||||||
|
set(STD_FS_LIB c++fs) |
||||||
|
elseif(${STD_FS_NO_LIB_NEEDED}) |
||||||
|
set(STD_FS_LIB "") |
||||||
|
else() |
||||||
|
message(WARNING "Unknown C++17 compiler - not passing -lstdc++fs") |
||||||
|
set(STD_FS_LIB "") |
||||||
|
endif() |
||||||
|
|
||||||
|
# Compile with compiler warnings turned on |
||||||
|
function(pybind11_enable_warnings target_name) |
||||||
|
if(MSVC) |
||||||
|
target_compile_options(${target_name} PRIVATE /W4 /wd4189) |
||||||
|
elseif(CMAKE_CXX_COMPILER_ID MATCHES "(GNU|Intel|Clang)" AND NOT PYBIND11_CUDA_TESTS) |
||||||
|
target_compile_options( |
||||||
|
${target_name} |
||||||
|
PRIVATE -Wall |
||||||
|
-Wextra |
||||||
|
-Wconversion |
||||||
|
-Wcast-qual |
||||||
|
-Wdeprecated |
||||||
|
-Wundef |
||||||
|
-Wnon-virtual-dtor) |
||||||
|
endif() |
||||||
|
|
||||||
|
if(PYBIND11_WERROR) |
||||||
|
if(MSVC) |
||||||
|
target_compile_options(${target_name} PRIVATE /WX) |
||||||
|
elseif(PYBIND11_CUDA_TESTS) |
||||||
|
target_compile_options(${target_name} PRIVATE "SHELL:-Werror all-warnings") |
||||||
|
elseif(CMAKE_CXX_COMPILER_ID MATCHES "(GNU|Clang|IntelLLVM)") |
||||||
|
target_compile_options(${target_name} PRIVATE -Werror) |
||||||
|
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "Intel") |
||||||
|
if(CMAKE_CXX_STANDARD EQUAL 17) # See PR #3570 |
||||||
|
target_compile_options(${target_name} PRIVATE -Wno-conversion) |
||||||
|
endif() |
||||||
|
target_compile_options( |
||||||
|
${target_name} |
||||||
|
PRIVATE |
||||||
|
-Werror-all |
||||||
|
# "Inlining inhibited by limit max-size", "Inlining inhibited by limit max-total-size" |
||||||
|
-diag-disable 11074,11076) |
||||||
|
endif() |
||||||
|
endif() |
||||||
|
endfunction() |
||||||
|
|
||||||
|
set(test_targets pybind11_tests) |
||||||
|
|
||||||
|
# Check if any tests need extra targets by iterating through the mappings registered. |
||||||
|
foreach(i ${PYBIND11_TEST_EXTRA_TARGETS}) |
||||||
|
foreach(needle ${PYBIND11_TEST_EXTRA_TARGETS_NEEDLES_${i}}) |
||||||
|
if(needle IN_LIST PYBIND11_PYTEST_FILES) |
||||||
|
# Add all the additional targets to the test list. List join in newer cmake. |
||||||
|
foreach(extra_target ${PYBIND11_TEST_EXTRA_TARGETS_ADDITION_${i}}) |
||||||
|
list(APPEND test_targets ${extra_target}) |
||||||
|
endforeach() |
||||||
|
break() # Breaks out of the needle search, continues with the next mapping. |
||||||
|
endif() |
||||||
|
endforeach() |
||||||
|
endforeach() |
||||||
|
|
||||||
|
# Support CUDA testing by forcing the target file to compile with NVCC |
||||||
|
if(PYBIND11_CUDA_TESTS) |
||||||
|
set_property(SOURCE ${PYBIND11_TEST_FILES} PROPERTY LANGUAGE CUDA) |
||||||
|
endif() |
||||||
|
|
||||||
|
foreach(target ${test_targets}) |
||||||
|
set(test_files ${PYBIND11_TEST_FILES}) |
||||||
|
if(NOT "${target}" STREQUAL "pybind11_tests") |
||||||
|
set(test_files "") |
||||||
|
endif() |
||||||
|
|
||||||
|
# Support CUDA testing by forcing the target file to compile with NVCC |
||||||
|
if(PYBIND11_CUDA_TESTS) |
||||||
|
set_property(SOURCE ${target}.cpp PROPERTY LANGUAGE CUDA) |
||||||
|
endif() |
||||||
|
|
||||||
|
# Create the binding library |
||||||
|
pybind11_add_module(${target} THIN_LTO ${target}.cpp ${test_files} ${PYBIND11_HEADERS}) |
||||||
|
pybind11_enable_warnings(${target}) |
||||||
|
|
||||||
|
if(NOT CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_CURRENT_BINARY_DIR) |
||||||
|
get_property( |
||||||
|
suffix |
||||||
|
TARGET ${target} |
||||||
|
PROPERTY SUFFIX) |
||||||
|
set(source_output "${CMAKE_CURRENT_SOURCE_DIR}/${target}${suffix}") |
||||||
|
if(suffix AND EXISTS "${source_output}") |
||||||
|
message(WARNING "Output file also in source directory; " |
||||||
|
"please remove to avoid confusion: ${source_output}") |
||||||
|
endif() |
||||||
|
endif() |
||||||
|
|
||||||
|
if(MSVC) |
||||||
|
target_compile_options(${target} PRIVATE /utf-8) |
||||||
|
endif() |
||||||
|
|
||||||
|
if(EIGEN3_FOUND) |
||||||
|
target_link_libraries(${target} PRIVATE Eigen3::Eigen) |
||||||
|
target_compile_definitions(${target} PRIVATE -DPYBIND11_TEST_EIGEN) |
||||||
|
endif() |
||||||
|
|
||||||
|
if(Boost_FOUND) |
||||||
|
target_link_libraries(${target} PRIVATE Boost::headers) |
||||||
|
target_compile_definitions(${target} PRIVATE -DPYBIND11_TEST_BOOST) |
||||||
|
endif() |
||||||
|
|
||||||
|
target_link_libraries(${target} PRIVATE ${STD_FS_LIB}) |
||||||
|
|
||||||
|
# Always write the output file directly into the 'tests' directory (even on MSVC) |
||||||
|
if(NOT CMAKE_LIBRARY_OUTPUT_DIRECTORY) |
||||||
|
set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY |
||||||
|
"${CMAKE_CURRENT_BINARY_DIR}") |
||||||
|
|
||||||
|
if(DEFINED CMAKE_CONFIGURATION_TYPES) |
||||||
|
foreach(config ${CMAKE_CONFIGURATION_TYPES}) |
||||||
|
string(TOUPPER ${config} config) |
||||||
|
set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY_${config} |
||||||
|
"${CMAKE_CURRENT_BINARY_DIR}") |
||||||
|
endforeach() |
||||||
|
endif() |
||||||
|
endif() |
||||||
|
endforeach() |
||||||
|
|
||||||
|
# Provide nice organisation in IDEs |
||||||
|
if(NOT CMAKE_VERSION VERSION_LESS 3.8) |
||||||
|
source_group( |
||||||
|
TREE "${CMAKE_CURRENT_SOURCE_DIR}/../include" |
||||||
|
PREFIX "Header Files" |
||||||
|
FILES ${PYBIND11_HEADERS}) |
||||||
|
endif() |
||||||
|
|
||||||
|
# Make sure pytest is found or produce a warning |
||||||
|
pybind11_find_import(pytest VERSION 3.1) |
||||||
|
|
||||||
|
if(NOT CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_CURRENT_BINARY_DIR) |
||||||
|
# This is not used later in the build, so it's okay to regenerate each time. |
||||||
|
configure_file("${CMAKE_CURRENT_SOURCE_DIR}/pytest.ini" "${CMAKE_CURRENT_BINARY_DIR}/pytest.ini" |
||||||
|
COPYONLY) |
||||||
|
file(APPEND "${CMAKE_CURRENT_BINARY_DIR}/pytest.ini" |
||||||
|
"\ntestpaths = \"${CMAKE_CURRENT_SOURCE_DIR}\"") |
||||||
|
|
||||||
|
endif() |
||||||
|
|
||||||
|
# cmake 3.12 added list(transform <list> prepend |
||||||
|
# but we can't use it yet |
||||||
|
string(REPLACE "test_" "${CMAKE_CURRENT_SOURCE_DIR}/test_" PYBIND11_ABS_PYTEST_FILES |
||||||
|
"${PYBIND11_PYTEST_FILES}") |
||||||
|
|
||||||
|
set(PYBIND11_TEST_PREFIX_COMMAND |
||||||
|
"" |
||||||
|
CACHE STRING "Put this before pytest, use for checkers and such") |
||||||
|
|
||||||
|
# A single command to compile and run the tests |
||||||
|
add_custom_target( |
||||||
|
pytest |
||||||
|
COMMAND ${PYBIND11_TEST_PREFIX_COMMAND} ${PYTHON_EXECUTABLE} -m pytest |
||||||
|
${PYBIND11_ABS_PYTEST_FILES} |
||||||
|
DEPENDS ${test_targets} |
||||||
|
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}" |
||||||
|
USES_TERMINAL) |
||||||
|
|
||||||
|
if(PYBIND11_TEST_OVERRIDE) |
||||||
|
add_custom_command( |
||||||
|
TARGET pytest |
||||||
|
POST_BUILD |
||||||
|
COMMAND ${CMAKE_COMMAND} -E echo |
||||||
|
"Note: not all tests run: -DPYBIND11_TEST_OVERRIDE is in effect") |
||||||
|
endif() |
||||||
|
|
||||||
|
# cmake-format: off |
||||||
|
add_custom_target( |
||||||
|
memcheck |
||||||
|
COMMAND |
||||||
|
PYTHONMALLOC=malloc |
||||||
|
valgrind |
||||||
|
--leak-check=full |
||||||
|
--show-leak-kinds=definite,indirect |
||||||
|
--errors-for-leak-kinds=definite,indirect |
||||||
|
--error-exitcode=1 |
||||||
|
--read-var-info=yes |
||||||
|
--track-origins=yes |
||||||
|
--suppressions="${CMAKE_CURRENT_SOURCE_DIR}/valgrind-python.supp" |
||||||
|
--suppressions="${CMAKE_CURRENT_SOURCE_DIR}/valgrind-numpy-scipy.supp" |
||||||
|
--gen-suppressions=all |
||||||
|
${PYTHON_EXECUTABLE} -m pytest ${PYBIND11_ABS_PYTEST_FILES} |
||||||
|
DEPENDS ${test_targets} |
||||||
|
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}" |
||||||
|
USES_TERMINAL) |
||||||
|
# cmake-format: on |
||||||
|
|
||||||
|
# Add a check target to run all the tests, starting with pytest (we add dependencies to this below) |
||||||
|
add_custom_target(check DEPENDS pytest) |
||||||
|
|
||||||
|
# The remaining tests only apply when being built as part of the pybind11 project, but not if the |
||||||
|
# tests are being built independently. |
||||||
|
if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR) |
||||||
|
return() |
||||||
|
endif() |
||||||
|
|
||||||
|
# Add a post-build comment to show the primary test suite .so size and, if a previous size, compare it: |
||||||
|
add_custom_command( |
||||||
|
TARGET pybind11_tests |
||||||
|
POST_BUILD |
||||||
|
COMMAND |
||||||
|
${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/../tools/libsize.py |
||||||
|
$<TARGET_FILE:pybind11_tests> |
||||||
|
${CMAKE_CURRENT_BINARY_DIR}/sosize-$<TARGET_FILE_NAME:pybind11_tests>.txt) |
||||||
|
|
||||||
|
if(NOT PYBIND11_CUDA_TESTS) |
||||||
|
# Test embedding the interpreter. Provides the `cpptest` target. |
||||||
|
add_subdirectory(test_embed) |
||||||
|
|
||||||
|
# Test CMake build using functions and targets from subdirectory or installed location |
||||||
|
add_subdirectory(test_cmake_build) |
||||||
|
endif() |
||||||
@ -0,0 +1,238 @@ |
|||||||
|
"""pytest configuration |
||||||
|
|
||||||
|
Extends output capture as needed by pybind11: ignore constructors, optional unordered lines. |
||||||
|
Adds docstring and exceptions message sanitizers. |
||||||
|
""" |
||||||
|
|
||||||
|
import contextlib |
||||||
|
import difflib |
||||||
|
import gc |
||||||
|
import multiprocessing |
||||||
|
import os |
||||||
|
import re |
||||||
|
import textwrap |
||||||
|
import traceback |
||||||
|
|
||||||
|
import pytest |
||||||
|
|
||||||
|
# Early diagnostic for failed imports |
||||||
|
try: |
||||||
|
import pybind11_tests |
||||||
|
except Exception: |
||||||
|
# pytest does not show the traceback without this. |
||||||
|
traceback.print_exc() |
||||||
|
raise |
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope="session", autouse=True) |
||||||
|
def always_forkserver_on_unix(): |
||||||
|
if os.name == "nt": |
||||||
|
return |
||||||
|
|
||||||
|
# Full background: https://github.com/pybind/pybind11/issues/4105#issuecomment-1301004592 |
||||||
|
# In a nutshell: fork() after starting threads == flakiness in the form of deadlocks. |
||||||
|
# It is actually a well-known pitfall, unfortunately without guard rails. |
||||||
|
# "forkserver" is more performant than "spawn" (~9s vs ~13s for tests/test_gil_scoped.py, |
||||||
|
# visit the issuecomment link above for details). |
||||||
|
# Windows does not have fork() and the associated pitfall, therefore it is best left |
||||||
|
# running with defaults. |
||||||
|
multiprocessing.set_start_method("forkserver") |
||||||
|
|
||||||
|
|
||||||
|
_long_marker = re.compile(r"([0-9])L") |
||||||
|
_hexadecimal = re.compile(r"0x[0-9a-fA-F]+") |
||||||
|
|
||||||
|
# Avoid collecting Python3 only files |
||||||
|
collect_ignore = [] |
||||||
|
|
||||||
|
|
||||||
|
def _strip_and_dedent(s): |
||||||
|
"""For triple-quote strings""" |
||||||
|
return textwrap.dedent(s.lstrip("\n").rstrip()) |
||||||
|
|
||||||
|
|
||||||
|
def _split_and_sort(s): |
||||||
|
"""For output which does not require specific line order""" |
||||||
|
return sorted(_strip_and_dedent(s).splitlines()) |
||||||
|
|
||||||
|
|
||||||
|
def _make_explanation(a, b): |
||||||
|
"""Explanation for a failed assert -- the a and b arguments are List[str]""" |
||||||
|
return ["--- actual / +++ expected"] + [ |
||||||
|
line.strip("\n") for line in difflib.ndiff(a, b) |
||||||
|
] |
||||||
|
|
||||||
|
|
||||||
|
class Output: |
||||||
|
"""Basic output post-processing and comparison""" |
||||||
|
|
||||||
|
def __init__(self, string): |
||||||
|
self.string = string |
||||||
|
self.explanation = [] |
||||||
|
|
||||||
|
def __str__(self): |
||||||
|
return self.string |
||||||
|
|
||||||
|
def __eq__(self, other): |
||||||
|
# Ignore constructor/destructor output which is prefixed with "###" |
||||||
|
a = [ |
||||||
|
line |
||||||
|
for line in self.string.strip().splitlines() |
||||||
|
if not line.startswith("###") |
||||||
|
] |
||||||
|
b = _strip_and_dedent(other).splitlines() |
||||||
|
if a == b: |
||||||
|
return True |
||||||
|
else: |
||||||
|
self.explanation = _make_explanation(a, b) |
||||||
|
return False |
||||||
|
|
||||||
|
|
||||||
|
class Unordered(Output): |
||||||
|
"""Custom comparison for output without strict line ordering""" |
||||||
|
|
||||||
|
def __eq__(self, other): |
||||||
|
a = _split_and_sort(self.string) |
||||||
|
b = _split_and_sort(other) |
||||||
|
if a == b: |
||||||
|
return True |
||||||
|
else: |
||||||
|
self.explanation = _make_explanation(a, b) |
||||||
|
return False |
||||||
|
|
||||||
|
|
||||||
|
class Capture: |
||||||
|
def __init__(self, capfd): |
||||||
|
self.capfd = capfd |
||||||
|
self.out = "" |
||||||
|
self.err = "" |
||||||
|
|
||||||
|
def __enter__(self): |
||||||
|
self.capfd.readouterr() |
||||||
|
return self |
||||||
|
|
||||||
|
def __exit__(self, *args): |
||||||
|
self.out, self.err = self.capfd.readouterr() |
||||||
|
|
||||||
|
def __eq__(self, other): |
||||||
|
a = Output(self.out) |
||||||
|
b = other |
||||||
|
if a == b: |
||||||
|
return True |
||||||
|
else: |
||||||
|
self.explanation = a.explanation |
||||||
|
return False |
||||||
|
|
||||||
|
def __str__(self): |
||||||
|
return self.out |
||||||
|
|
||||||
|
def __contains__(self, item): |
||||||
|
return item in self.out |
||||||
|
|
||||||
|
@property |
||||||
|
def unordered(self): |
||||||
|
return Unordered(self.out) |
||||||
|
|
||||||
|
@property |
||||||
|
def stderr(self): |
||||||
|
return Output(self.err) |
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture |
||||||
|
def capture(capsys): |
||||||
|
"""Extended `capsys` with context manager and custom equality operators""" |
||||||
|
return Capture(capsys) |
||||||
|
|
||||||
|
|
||||||
|
class SanitizedString: |
||||||
|
def __init__(self, sanitizer): |
||||||
|
self.sanitizer = sanitizer |
||||||
|
self.string = "" |
||||||
|
self.explanation = [] |
||||||
|
|
||||||
|
def __call__(self, thing): |
||||||
|
self.string = self.sanitizer(thing) |
||||||
|
return self |
||||||
|
|
||||||
|
def __eq__(self, other): |
||||||
|
a = self.string |
||||||
|
b = _strip_and_dedent(other) |
||||||
|
if a == b: |
||||||
|
return True |
||||||
|
else: |
||||||
|
self.explanation = _make_explanation(a.splitlines(), b.splitlines()) |
||||||
|
return False |
||||||
|
|
||||||
|
|
||||||
|
def _sanitize_general(s): |
||||||
|
s = s.strip() |
||||||
|
s = s.replace("pybind11_tests.", "m.") |
||||||
|
s = _long_marker.sub(r"\1", s) |
||||||
|
return s |
||||||
|
|
||||||
|
|
||||||
|
def _sanitize_docstring(thing): |
||||||
|
s = thing.__doc__ |
||||||
|
s = _sanitize_general(s) |
||||||
|
return s |
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture |
||||||
|
def doc(): |
||||||
|
"""Sanitize docstrings and add custom failure explanation""" |
||||||
|
return SanitizedString(_sanitize_docstring) |
||||||
|
|
||||||
|
|
||||||
|
def _sanitize_message(thing): |
||||||
|
s = str(thing) |
||||||
|
s = _sanitize_general(s) |
||||||
|
s = _hexadecimal.sub("0", s) |
||||||
|
return s |
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture |
||||||
|
def msg(): |
||||||
|
"""Sanitize messages and add custom failure explanation""" |
||||||
|
return SanitizedString(_sanitize_message) |
||||||
|
|
||||||
|
|
||||||
|
# noinspection PyUnusedLocal |
||||||
|
def pytest_assertrepr_compare(op, left, right): |
||||||
|
"""Hook to insert custom failure explanation""" |
||||||
|
if hasattr(left, "explanation"): |
||||||
|
return left.explanation |
||||||
|
|
||||||
|
|
||||||
|
@contextlib.contextmanager |
||||||
|
def suppress(exception): |
||||||
|
"""Suppress the desired exception""" |
||||||
|
try: |
||||||
|
yield |
||||||
|
except exception: |
||||||
|
pass |
||||||
|
|
||||||
|
|
||||||
|
def gc_collect(): |
||||||
|
"""Run the garbage collector twice (needed when running |
||||||
|
reference counting tests with PyPy)""" |
||||||
|
gc.collect() |
||||||
|
gc.collect() |
||||||
|
|
||||||
|
|
||||||
|
def pytest_configure(): |
||||||
|
pytest.suppress = suppress |
||||||
|
pytest.gc_collect = gc_collect |
||||||
|
|
||||||
|
|
||||||
|
def pytest_report_header(config): |
||||||
|
del config # Unused. |
||||||
|
assert ( |
||||||
|
pybind11_tests.compiler_info is not None |
||||||
|
), "Please update pybind11_tests.cpp if this assert fails." |
||||||
|
return ( |
||||||
|
"C++ Info:" |
||||||
|
f" {pybind11_tests.compiler_info}" |
||||||
|
f" {pybind11_tests.cpp_std}" |
||||||
|
f" {pybind11_tests.PYBIND11_INTERNALS_ID}" |
||||||
|
f" PYBIND11_SIMPLE_GIL_MANAGEMENT={pybind11_tests.PYBIND11_SIMPLE_GIL_MANAGEMENT}" |
||||||
|
) |
||||||
@ -0,0 +1,322 @@ |
|||||||
|
#pragma once |
||||||
|
/*
|
||||||
|
tests/constructor_stats.h -- framework for printing and tracking object |
||||||
|
instance lifetimes in example/test code. |
||||||
|
|
||||||
|
Copyright (c) 2016 Jason Rhinelander <jason@imaginary.ca> |
||||||
|
|
||||||
|
All rights reserved. Use of this source code is governed by a |
||||||
|
BSD-style license that can be found in the LICENSE file. |
||||||
|
|
||||||
|
This header provides a few useful tools for writing examples or tests that want to check and/or |
||||||
|
display object instance lifetimes. It requires that you include this header and add the following |
||||||
|
function calls to constructors: |
||||||
|
|
||||||
|
class MyClass { |
||||||
|
MyClass() { ...; print_default_created(this); } |
||||||
|
~MyClass() { ...; print_destroyed(this); } |
||||||
|
MyClass(const MyClass &c) { ...; print_copy_created(this); } |
||||||
|
MyClass(MyClass &&c) { ...; print_move_created(this); } |
||||||
|
MyClass(int a, int b) { ...; print_created(this, a, b); } |
||||||
|
MyClass &operator=(const MyClass &c) { ...; print_copy_assigned(this); } |
||||||
|
MyClass &operator=(MyClass &&c) { ...; print_move_assigned(this); } |
||||||
|
|
||||||
|
... |
||||||
|
} |
||||||
|
|
||||||
|
You can find various examples of these in several of the existing testing .cpp files. (Of course |
||||||
|
you don't need to add any of the above constructors/operators that you don't actually have, except |
||||||
|
for the destructor). |
||||||
|
|
||||||
|
Each of these will print an appropriate message such as: |
||||||
|
|
||||||
|
### MyClass @ 0x2801910 created via default constructor |
||||||
|
### MyClass @ 0x27fa780 created 100 200 |
||||||
|
### MyClass @ 0x2801910 destroyed |
||||||
|
### MyClass @ 0x27fa780 destroyed |
||||||
|
|
||||||
|
You can also include extra arguments (such as the 100, 200 in the output above, coming from the |
||||||
|
value constructor) for all of the above methods which will be included in the output. |
||||||
|
|
||||||
|
For testing, each of these also keeps track the created instances and allows you to check how many |
||||||
|
of the various constructors have been invoked from the Python side via code such as: |
||||||
|
|
||||||
|
from pybind11_tests import ConstructorStats |
||||||
|
cstats = ConstructorStats.get(MyClass) |
||||||
|
print(cstats.alive()) |
||||||
|
print(cstats.default_constructions) |
||||||
|
|
||||||
|
Note that `.alive()` should usually be the first thing you call as it invokes Python's garbage |
||||||
|
collector to actually destroy objects that aren't yet referenced. |
||||||
|
|
||||||
|
For everything except copy and move constructors and destructors, any extra values given to the |
||||||
|
print_...() function is stored in a class-specific values list which you can retrieve and inspect |
||||||
|
from the ConstructorStats instance `.values()` method. |
||||||
|
|
||||||
|
In some cases, when you need to track instances of a C++ class not registered with pybind11, you |
||||||
|
need to add a function returning the ConstructorStats for the C++ class; this can be done with: |
||||||
|
|
||||||
|
m.def("get_special_cstats", &ConstructorStats::get<SpecialClass>, |
||||||
|
py::return_value_policy::reference) |
||||||
|
|
||||||
|
Finally, you can suppress the output messages, but keep the constructor tracking (for |
||||||
|
inspection/testing in python) by using the functions with `print_` replaced with `track_` (e.g. |
||||||
|
`track_copy_created(this)`). |
||||||
|
|
||||||
|
*/ |
||||||
|
|
||||||
|
#include "pybind11_tests.h" |
||||||
|
|
||||||
|
#include <list> |
||||||
|
#include <sstream> |
||||||
|
#include <typeindex> |
||||||
|
#include <unordered_map> |
||||||
|
|
||||||
|
class ConstructorStats { |
||||||
|
protected: |
||||||
|
std::unordered_map<void *, int> _instances; // Need a map rather than set because members can
|
||||||
|
// shared address with parents
|
||||||
|
std::list<std::string> _values; // Used to track values
|
||||||
|
// (e.g. of value constructors)
|
||||||
|
public: |
||||||
|
int default_constructions = 0; |
||||||
|
int copy_constructions = 0; |
||||||
|
int move_constructions = 0; |
||||||
|
int copy_assignments = 0; |
||||||
|
int move_assignments = 0; |
||||||
|
|
||||||
|
void copy_created(void *inst) { |
||||||
|
created(inst); |
||||||
|
copy_constructions++; |
||||||
|
} |
||||||
|
|
||||||
|
void move_created(void *inst) { |
||||||
|
created(inst); |
||||||
|
move_constructions++; |
||||||
|
} |
||||||
|
|
||||||
|
void default_created(void *inst) { |
||||||
|
created(inst); |
||||||
|
default_constructions++; |
||||||
|
} |
||||||
|
|
||||||
|
void created(void *inst) { ++_instances[inst]; } |
||||||
|
|
||||||
|
void destroyed(void *inst) { |
||||||
|
if (--_instances[inst] < 0) { |
||||||
|
throw std::runtime_error("cstats.destroyed() called with unknown " |
||||||
|
"instance; potential double-destruction " |
||||||
|
"or a missing cstats.created()"); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
static void gc() { |
||||||
|
// Force garbage collection to ensure any pending destructors are invoked:
|
||||||
|
#if defined(PYPY_VERSION) |
||||||
|
PyObject *globals = PyEval_GetGlobals(); |
||||||
|
PyObject *result = PyRun_String("import gc\n" |
||||||
|
"for i in range(2):\n" |
||||||
|
" gc.collect()\n", |
||||||
|
Py_file_input, |
||||||
|
globals, |
||||||
|
globals); |
||||||
|
if (result == nullptr) |
||||||
|
throw py::error_already_set(); |
||||||
|
Py_DECREF(result); |
||||||
|
#else |
||||||
|
py::module_::import("gc").attr("collect")(); |
||||||
|
#endif |
||||||
|
} |
||||||
|
|
||||||
|
int alive() { |
||||||
|
gc(); |
||||||
|
int total = 0; |
||||||
|
for (const auto &p : _instances) { |
||||||
|
if (p.second > 0) { |
||||||
|
total += p.second; |
||||||
|
} |
||||||
|
} |
||||||
|
return total; |
||||||
|
} |
||||||
|
|
||||||
|
void value() {} // Recursion terminator
|
||||||
|
// Takes one or more values, converts them to strings, then stores them.
|
||||||
|
template <typename T, typename... Tmore> |
||||||
|
void value(const T &v, Tmore &&...args) { |
||||||
|
std::ostringstream oss; |
||||||
|
oss << v; |
||||||
|
_values.push_back(oss.str()); |
||||||
|
value(std::forward<Tmore>(args)...); |
||||||
|
} |
||||||
|
|
||||||
|
// Move out stored values
|
||||||
|
py::list values() { |
||||||
|
py::list l; |
||||||
|
for (const auto &v : _values) { |
||||||
|
l.append(py::cast(v)); |
||||||
|
} |
||||||
|
_values.clear(); |
||||||
|
return l; |
||||||
|
} |
||||||
|
|
||||||
|
// Gets constructor stats from a C++ type index
|
||||||
|
static ConstructorStats &get(std::type_index type) { |
||||||
|
static std::unordered_map<std::type_index, ConstructorStats> all_cstats; |
||||||
|
return all_cstats[type]; |
||||||
|
} |
||||||
|
|
||||||
|
// Gets constructor stats from a C++ type
|
||||||
|
template <typename T> |
||||||
|
static ConstructorStats &get() { |
||||||
|
#if defined(PYPY_VERSION) |
||||||
|
gc(); |
||||||
|
#endif |
||||||
|
return get(typeid(T)); |
||||||
|
} |
||||||
|
|
||||||
|
// Gets constructor stats from a Python class
|
||||||
|
static ConstructorStats &get(py::object class_) { |
||||||
|
auto &internals = py::detail::get_internals(); |
||||||
|
const std::type_index *t1 = nullptr, *t2 = nullptr; |
||||||
|
try { |
||||||
|
auto *type_info |
||||||
|
= internals.registered_types_py.at((PyTypeObject *) class_.ptr()).at(0); |
||||||
|
for (auto &p : internals.registered_types_cpp) { |
||||||
|
if (p.second == type_info) { |
||||||
|
if (t1) { |
||||||
|
t2 = &p.first; |
||||||
|
break; |
||||||
|
} |
||||||
|
t1 = &p.first; |
||||||
|
} |
||||||
|
} |
||||||
|
} catch (const std::out_of_range &) { |
||||||
|
} |
||||||
|
if (!t1) { |
||||||
|
throw std::runtime_error("Unknown class passed to ConstructorStats::get()"); |
||||||
|
} |
||||||
|
auto &cs1 = get(*t1); |
||||||
|
// If we have both a t1 and t2 match, one is probably the trampoline class; return
|
||||||
|
// whichever has more constructions (typically one or the other will be 0)
|
||||||
|
if (t2) { |
||||||
|
auto &cs2 = get(*t2); |
||||||
|
int cs1_total = cs1.default_constructions + cs1.copy_constructions |
||||||
|
+ cs1.move_constructions + (int) cs1._values.size(); |
||||||
|
int cs2_total = cs2.default_constructions + cs2.copy_constructions |
||||||
|
+ cs2.move_constructions + (int) cs2._values.size(); |
||||||
|
if (cs2_total > cs1_total) { |
||||||
|
return cs2; |
||||||
|
} |
||||||
|
} |
||||||
|
return cs1; |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
// To track construction/destruction, you need to call these methods from the various
|
||||||
|
// constructors/operators. The ones that take extra values record the given values in the
|
||||||
|
// constructor stats values for later inspection.
|
||||||
|
template <class T> |
||||||
|
void track_copy_created(T *inst) { |
||||||
|
ConstructorStats::get<T>().copy_created(inst); |
||||||
|
} |
||||||
|
template <class T> |
||||||
|
void track_move_created(T *inst) { |
||||||
|
ConstructorStats::get<T>().move_created(inst); |
||||||
|
} |
||||||
|
template <class T, typename... Values> |
||||||
|
void track_copy_assigned(T *, Values &&...values) { |
||||||
|
auto &cst = ConstructorStats::get<T>(); |
||||||
|
cst.copy_assignments++; |
||||||
|
cst.value(std::forward<Values>(values)...); |
||||||
|
} |
||||||
|
template <class T, typename... Values> |
||||||
|
void track_move_assigned(T *, Values &&...values) { |
||||||
|
auto &cst = ConstructorStats::get<T>(); |
||||||
|
cst.move_assignments++; |
||||||
|
cst.value(std::forward<Values>(values)...); |
||||||
|
} |
||||||
|
template <class T, typename... Values> |
||||||
|
void track_default_created(T *inst, Values &&...values) { |
||||||
|
auto &cst = ConstructorStats::get<T>(); |
||||||
|
cst.default_created(inst); |
||||||
|
cst.value(std::forward<Values>(values)...); |
||||||
|
} |
||||||
|
template <class T, typename... Values> |
||||||
|
void track_created(T *inst, Values &&...values) { |
||||||
|
auto &cst = ConstructorStats::get<T>(); |
||||||
|
cst.created(inst); |
||||||
|
cst.value(std::forward<Values>(values)...); |
||||||
|
} |
||||||
|
template <class T, typename... Values> |
||||||
|
void track_destroyed(T *inst) { |
||||||
|
ConstructorStats::get<T>().destroyed(inst); |
||||||
|
} |
||||||
|
template <class T, typename... Values> |
||||||
|
void track_values(T *, Values &&...values) { |
||||||
|
ConstructorStats::get<T>().value(std::forward<Values>(values)...); |
||||||
|
} |
||||||
|
|
||||||
|
/// Don't cast pointers to Python, print them as strings
|
||||||
|
inline const char *format_ptrs(const char *p) { return p; } |
||||||
|
template <typename T> |
||||||
|
py::str format_ptrs(T *p) { |
||||||
|
return "{:#x}"_s.format(reinterpret_cast<std::uintptr_t>(p)); |
||||||
|
} |
||||||
|
template <typename T> |
||||||
|
auto format_ptrs(T &&x) -> decltype(std::forward<T>(x)) { |
||||||
|
return std::forward<T>(x); |
||||||
|
} |
||||||
|
|
||||||
|
template <class T, typename... Output> |
||||||
|
void print_constr_details(T *inst, const std::string &action, Output &&...output) { |
||||||
|
py::print("###", |
||||||
|
py::type_id<T>(), |
||||||
|
"@", |
||||||
|
format_ptrs(inst), |
||||||
|
action, |
||||||
|
format_ptrs(std::forward<Output>(output))...); |
||||||
|
} |
||||||
|
|
||||||
|
// Verbose versions of the above:
|
||||||
|
template <class T, typename... Values> |
||||||
|
void print_copy_created(T *inst, |
||||||
|
Values &&...values) { // NB: this prints, but doesn't store, given values
|
||||||
|
print_constr_details(inst, "created via copy constructor", values...); |
||||||
|
track_copy_created(inst); |
||||||
|
} |
||||||
|
template <class T, typename... Values> |
||||||
|
void print_move_created(T *inst, |
||||||
|
Values &&...values) { // NB: this prints, but doesn't store, given values
|
||||||
|
print_constr_details(inst, "created via move constructor", values...); |
||||||
|
track_move_created(inst); |
||||||
|
} |
||||||
|
template <class T, typename... Values> |
||||||
|
void print_copy_assigned(T *inst, Values &&...values) { |
||||||
|
print_constr_details(inst, "assigned via copy assignment", values...); |
||||||
|
track_copy_assigned(inst, values...); |
||||||
|
} |
||||||
|
template <class T, typename... Values> |
||||||
|
void print_move_assigned(T *inst, Values &&...values) { |
||||||
|
print_constr_details(inst, "assigned via move assignment", values...); |
||||||
|
track_move_assigned(inst, values...); |
||||||
|
} |
||||||
|
template <class T, typename... Values> |
||||||
|
void print_default_created(T *inst, Values &&...values) { |
||||||
|
print_constr_details(inst, "created via default constructor", values...); |
||||||
|
track_default_created(inst, values...); |
||||||
|
} |
||||||
|
template <class T, typename... Values> |
||||||
|
void print_created(T *inst, Values &&...values) { |
||||||
|
print_constr_details(inst, "created", values...); |
||||||
|
track_created(inst, values...); |
||||||
|
} |
||||||
|
template <class T, typename... Values> |
||||||
|
void print_destroyed(T *inst, Values &&...values) { // Prints but doesn't store given values
|
||||||
|
print_constr_details(inst, "destroyed", values...); |
||||||
|
track_destroyed(inst); |
||||||
|
} |
||||||
|
template <class T, typename... Values> |
||||||
|
void print_values(T *inst, Values &&...values) { |
||||||
|
print_constr_details(inst, ":", values...); |
||||||
|
track_values(inst, values...); |
||||||
|
} |
||||||
@ -0,0 +1,108 @@ |
|||||||
|
/*
|
||||||
|
tests/cross_module_gil_utils.cpp -- tools for acquiring GIL from a different module |
||||||
|
|
||||||
|
Copyright (c) 2019 Google LLC |
||||||
|
|
||||||
|
All rights reserved. Use of this source code is governed by a |
||||||
|
BSD-style license that can be found in the LICENSE file. |
||||||
|
*/ |
||||||
|
#if defined(PYBIND11_INTERNALS_VERSION) |
||||||
|
# undef PYBIND11_INTERNALS_VERSION |
||||||
|
#endif |
||||||
|
#define PYBIND11_INTERNALS_VERSION 21814642 // Ensure this module has its own `internals` instance.
|
||||||
|
#include <pybind11/pybind11.h> |
||||||
|
|
||||||
|
#include <cstdint> |
||||||
|
#include <string> |
||||||
|
#include <thread> |
||||||
|
|
||||||
|
// This file mimics a DSO that makes pybind11 calls but does not define a
|
||||||
|
// PYBIND11_MODULE. The purpose is to test that such a DSO can create a
|
||||||
|
// py::gil_scoped_acquire when the running thread is in a GIL-released state.
|
||||||
|
//
|
||||||
|
// Note that we define a Python module here for convenience, but in general
|
||||||
|
// this need not be the case. The typical scenario would be a DSO that implements
|
||||||
|
// shared logic used internally by multiple pybind11 modules.
|
||||||
|
|
||||||
|
namespace { |
||||||
|
|
||||||
|
namespace py = pybind11; |
||||||
|
|
||||||
|
void gil_acquire() { py::gil_scoped_acquire gil; } |
||||||
|
|
||||||
|
std::string gil_multi_acquire_release(unsigned bits) { |
||||||
|
if ((bits & 0x1u) != 0u) { |
||||||
|
py::gil_scoped_acquire gil; |
||||||
|
} |
||||||
|
if ((bits & 0x2u) != 0u) { |
||||||
|
py::gil_scoped_release gil; |
||||||
|
} |
||||||
|
if ((bits & 0x4u) != 0u) { |
||||||
|
py::gil_scoped_acquire gil; |
||||||
|
} |
||||||
|
if ((bits & 0x8u) != 0u) { |
||||||
|
py::gil_scoped_release gil; |
||||||
|
} |
||||||
|
return PYBIND11_INTERNALS_ID; |
||||||
|
} |
||||||
|
|
||||||
|
struct CustomAutoGIL { |
||||||
|
CustomAutoGIL() : gstate(PyGILState_Ensure()) {} |
||||||
|
~CustomAutoGIL() { PyGILState_Release(gstate); } |
||||||
|
|
||||||
|
PyGILState_STATE gstate; |
||||||
|
}; |
||||||
|
struct CustomAutoNoGIL { |
||||||
|
CustomAutoNoGIL() : save(PyEval_SaveThread()) {} |
||||||
|
~CustomAutoNoGIL() { PyEval_RestoreThread(save); } |
||||||
|
|
||||||
|
PyThreadState *save; |
||||||
|
}; |
||||||
|
|
||||||
|
template <typename Acquire, typename Release> |
||||||
|
void gil_acquire_inner() { |
||||||
|
Acquire acquire_outer; |
||||||
|
Acquire acquire_inner; |
||||||
|
Release release; |
||||||
|
} |
||||||
|
|
||||||
|
template <typename Acquire, typename Release> |
||||||
|
void gil_acquire_nested() { |
||||||
|
Acquire acquire_outer; |
||||||
|
Acquire acquire_inner; |
||||||
|
Release release; |
||||||
|
auto thread = std::thread(&gil_acquire_inner<Acquire, Release>); |
||||||
|
thread.join(); |
||||||
|
} |
||||||
|
|
||||||
|
constexpr char kModuleName[] = "cross_module_gil_utils"; |
||||||
|
|
||||||
|
struct PyModuleDef moduledef = { |
||||||
|
PyModuleDef_HEAD_INIT, kModuleName, nullptr, 0, nullptr, nullptr, nullptr, nullptr, nullptr}; |
||||||
|
|
||||||
|
} // namespace
|
||||||
|
|
||||||
|
#define ADD_FUNCTION(Name, ...) \ |
||||||
|
PyModule_AddObject(m, Name, PyLong_FromVoidPtr(reinterpret_cast<void *>(&__VA_ARGS__))); |
||||||
|
|
||||||
|
extern "C" PYBIND11_EXPORT PyObject *PyInit_cross_module_gil_utils() { |
||||||
|
|
||||||
|
PyObject *m = PyModule_Create(&moduledef); |
||||||
|
|
||||||
|
if (m != nullptr) { |
||||||
|
static_assert(sizeof(&gil_acquire) == sizeof(void *), |
||||||
|
"Function pointer must have the same size as void*"); |
||||||
|
ADD_FUNCTION("gil_acquire_funcaddr", gil_acquire) |
||||||
|
ADD_FUNCTION("gil_multi_acquire_release_funcaddr", gil_multi_acquire_release) |
||||||
|
ADD_FUNCTION("gil_acquire_inner_custom_funcaddr", |
||||||
|
gil_acquire_inner<CustomAutoGIL, CustomAutoNoGIL>) |
||||||
|
ADD_FUNCTION("gil_acquire_nested_custom_funcaddr", |
||||||
|
gil_acquire_nested<CustomAutoGIL, CustomAutoNoGIL>) |
||||||
|
ADD_FUNCTION("gil_acquire_inner_pybind11_funcaddr", |
||||||
|
gil_acquire_inner<py::gil_scoped_acquire, py::gil_scoped_release>) |
||||||
|
ADD_FUNCTION("gil_acquire_nested_pybind11_funcaddr", |
||||||
|
gil_acquire_nested<py::gil_scoped_acquire, py::gil_scoped_release>) |
||||||
|
} |
||||||
|
|
||||||
|
return m; |
||||||
|
} |
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue