v3 flag enabled
Inter-language C++03
Added in 1.19.0

Boost.Python

The Boost Python Library is a framework for interfacing Python and C++. It allows you to quickly and seamlessly expose C++ classes functions and objects to Python, and vice-versa, using no special tools -- just your C++ compiler.

Contributors: This Release


Documentation

logo

Synopsis

Welcome to Boost.Python, a C++ library which enables seamless interoperability between C++ and the Python programming language. The library includes support for:

  • References and Pointers
  • Globally Registered Type Coercions
  • Automatic Cross-Module Type Conversions
  • Efficient Function Overloading
  • C++ to Python Exception Translation
  • Default Arguments
  • Keyword Arguments
  • Manipulating Python objects in C++
  • Exporting C++ Iterators as Python Iterators
  • Documentation Strings

See the Boost.Python documentation for details.

Building Build Status

While Boost.Python is part of the Boost C++ Libraries super-project, and thus can be compiled as part of Boost, it can also be compiled and installed stand-alone, i.e. against a pre-installed Boost package.

Prerequisites

Configure

Simply run

scons config [options]

to prepare a build. See scons -h for a description of the available options. For example

scons config --boost=/path/to/boost --python=/path/to/python

will configure Boost.Python to be built against the two specific versions of Boost and Python.

Build

Run

scons

to build the library.

Test

Run

scons test

to run the tests.

Build docs

Run

scons doc

to build the documentation.

Latest Boost.Python posts

Join the Boost Developers Mailing List

Get the latest on releases, features, security patches, fixes and all major announcements.

All Contributors