pybind11 README

The project's README from github.com/pybind/pybind11. As one markdown file: README.md.

.. figure:: https://github.com/pybind/pybind11/raw/master/docs/pybind11-logo.png :alt: pybind11 logo

pybind11 (v3) — Seamless interoperability between C++ and Python

|Latest Documentation Status| |Stable Documentation Status| |Gitter chat| |GitHub Discussions|

|CI| |Build status| |SPEC 4 — Using and Creating Nightly Wheels|

|Repology| |PyPI package| |Conda-forge| |Python Versions|

Setuptools example <https://github.com/pybind/python_example>_ • Scikit-build example <https://github.com/pybind/scikit_build_example>_ • CMake example <https://github.com/pybind/cmake_example>_

.. start

pybind11 is a lightweight header-only library that exposes C++ types in Python and vice versa, mainly to create Python bindings of existing C++ code. Its goals and syntax are similar to the excellent Boost.Python <http://www.boost.org/doc/libs/1_58_0/libs/python/doc/>_ library by David Abrahams: to minimize boilerplate code in traditional extension modules by inferring type information using compile-time introspection.

The main issue with Boost.Python—and the reason for creating such a similar project—is Boost. Boost is an enormously large and complex suite of utility libraries that works with almost every C++ compiler in existence. This compatibility has its cost: arcane template tricks and workarounds are necessary to support the oldest and buggiest of compiler specimens. Now that C++11-compatible compilers are widely available, this heavy machinery has become an excessively large and unnecessary dependency.

Think of this library as a tiny self-contained version of Boost.Python with everything stripped away that isn't relevant for binding generation. Without comments, the core header files only require ~4K lines of code and depend on Python (CPython 3.9+, PyPy, or GraalPy) and the C++ standard library. This compact implementation was possible thanks to some C++11 language features (specifically: tuples, lambda functions and variadic templates). Since its creation, this library has grown beyond Boost.Python in many ways, leading to dramatically simpler binding code in many common situations.

Tutorial and reference documentation is provided at pybind11.readthedocs.io <https://pybind11.readthedocs.io/en/latest>. A PDF version of the manual is available here <https://pybind11.readthedocs.io/_/downloads/en/latest/pdf/>. And the source code is always available at github.com/pybind/pybind11 <https://github.com/pybind/pybind11>_.

Core features

pybind11 can map the following core C++ features to Python:

Goodies

In addition to the core functionality, pybind11 provides some extra goodies:

Supported platforms & compilers

pybind11 is exercised in continuous integration across a range of operating systems, Python versions, C++ standards, and toolchains. For an up-to-date view of the combinations we currently test, please see the pybind11 GitHub Actions <https://github.com/pybind/pybind11/actions?query=branch%3Amaster>_ and AppVeyor <https://ci.appveyor.com/project/wjakob/pybind11>_ logs.

The test matrix naturally evolves over time as older platforms and compilers fall out of use and new ones are added by the community. Closely related versions of a tested compiler or platform will often work as well in practice, but we cannot promise to validate every possible combination. If a configuration you rely on is missing from the matrix or regresses, issues and pull requests to extend coverage are very welcome. At the same time, we need to balance the size of the test matrix with the available CI resources, such as GitHub's limits on concurrent jobs under the free tier.

About

This project was created by Wenzel Jakob <http://rgl.epfl.ch/people/wjakob>_. Significant features and/or improvements to the code were contributed by Jonas Adler, Lori A. Burns, Sylvain Corlay, Eric Cousineau, Aaron Gokaslan, Ralf Grosse-Kunstleve, Trent Houliston, Axel Huebl, @hulucc, Yannick Jadoul, Sergey Lyskov, Johan Mabille, Tomasz Miąsko, Dean Moldovan, Ben Pritchard, Jason Rhinelander, Boris Schäling, Pim Schellart, Henry Schreiner, Ivan Smirnov, Dustin Spicuzza, Boris Staletic, Ethan Steinberg, Patrick Stewart, Ivor Wanders, and Xiaofei Wang.

We thank Google for a generous financial contribution to the continuous integration infrastructure used by this project.

Contributing


See the `contributing
guide <https://github.com/pybind/pybind11/blob/master/.github/CONTRIBUTING.md>`_
for information on building and contributing to pybind11.

License
~~~~~~~

pybind11 is provided under a BSD-style license that can be found in the
`LICENSE <https://github.com/pybind/pybind11/blob/master/LICENSE>`_
file. By using, distributing, or contributing to this project, you agree
to the terms and conditions of this license.

.. |Latest Documentation Status| image:: https://readthedocs.org/projects/pybind11/badge?version=latest
   :target: http://pybind11.readthedocs.org/en/latest
.. |Stable Documentation Status| image:: https://img.shields.io/badge/docs-stable-blue.svg
   :target: http://pybind11.readthedocs.org/en/stable
.. |Gitter chat| image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
   :target: https://gitter.im/pybind/Lobby
.. |CI| image:: https://github.com/pybind/pybind11/workflows/CI/badge.svg
   :target: https://github.com/pybind/pybind11/actions
.. |Build status| image:: https://ci.appveyor.com/api/projects/status/riaj54pn4h08xy40?svg=true
   :target: https://ci.appveyor.com/project/wjakob/pybind11
.. |PyPI package| image:: https://img.shields.io/pypi/v/pybind11.svg
   :target: https://pypi.org/project/pybind11/
.. |Conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/pybind11.svg
   :target: https://github.com/conda-forge/pybind11-feedstock
.. |Repology| image:: https://repology.org/badge/latest-versions/python:pybind11.svg
   :target: https://repology.org/project/python:pybind11/versions
.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/pybind11.svg
   :target: https://pypi.org/project/pybind11/
.. |GitHub Discussions| image:: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
   :target: https://github.com/pybind/pybind11/discussions
.. |SPEC 4 — Using and Creating Nightly Wheels| image:: https://img.shields.io/badge/SPEC-4-green?labelColor=%23004811&color=%235CA038
   :target: https://scientific-python.org/specs/spec-0004/

pybind11 (pybind/pybind11)

Searching Database…

Что это такое?pybind11 — это лёгкая C++-библиотека, состоящая только из заголовочных файлов, которая открывает C++-типы для Python и наоборот — в первую очередь для того, чтобы создавать Python-обёртки для уже существующего C++-кода.
Это библиотека, с которой я слинковываюсь во время выполнения, или что-то другое?Это header-only библиотека: сборка просто включает несколько C++-заголовков, и отдельно прилинковывать ничего не нужно.
Как добавить её в C++-проект?Подключите заголовки и настройте сборку — в README есть примеры для setuptools, scikit-build и CMake, а руководство и справочная документация лежат на pybind11.readthedocs.io.
Что должно быть установлено, чтобы я мог ею пользоваться?Нужны только компилятор с поддержкой C++11 и интерпретатор Python: ядро — это около 4 тысяч строк заголовков, которые зависят только от Python (CPython 3.9+, PyPy или GraalPy) и стандартной библиотеки C++ — Boost не требуется.
Будет ли она работать с моим интерпретатором и версией Python?Поддерживаются CPython 3.9+, PyPy3 7.3.17+ и GraalPy 24.1+ через один общий интерфейс, не зависящий от реализации; для более старых интерпретаторов нужны более старые версии pybind11.
Какие платформы и компиляторы реально протестированы?Непрерывная интеграция проверяет разные операционные системы, версии Python, стандарты C++ и наборы инструментов; близкие комбинации обычно тоже работают, но гарантий на них нет.
На каких условиях я могу её использовать?Под разрешающей лицензией в духе BSD — точные условия смотрите в файле LICENSE в репозитории.
Чем она отличается от Boost.Python?Она создавалась как крошечная самодостаточная альтернатива Boost.Python, избавленная от огромной зависимости от Boost. С тех пор она во многом её превзошла: бинарники обычно как минимум в 2 раза меньше — при переводе PyRosetta получили бинарники в 5,4 раза меньше, а компиляцию в 5,8 раз быстрее — и для типовых обёрток нужно заметно меньше кода.
Какие возможности C++ я могу отобразить в Python?Функции и методы (обычные, статические, перегруженные), пользовательские типы по значению, по ссылке или через указатель, атрибуты, любые типы исключений, перечисления, колбэки, итераторы, свои операторы, одиночное и множественное наследование, структуры данных STL и умные указатели вроде std::shared_ptr.
Как она работает с массивами NumPy?Поддержка NumPy встроена: функции можно автоматически векторизовать, чтобы они выполнялись для каждого элемента массива-аргумента, а буферные протоколы позволяют быстро преобразовывать данные между C++-классами матриц вроде Eigen и NumPy без затратных копирований.
Может ли код на Python наследовать мои C++-классы?Да — C++-классы с виртуальными (и чисто виртуальными) методами можно расширять из Python.
Creator
pybind
Size
13.6 MB
Stars
18K
Age
11y
Commits · 90 Days