Boost C++ Libraries

“...one of the most highly regarded and expertly designed C++ library projects in the world.” — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

Boost.Python

Reference

Concepts

High Level Components

Object Wrappers

Function Invocation and Creation

Models of CallPolicies
Models of ResultConverter
Models of ResultConverterGenerator

To/From Python Type Conversion

Embedding

Utility and Infrastructure

Topics

Concepts

CallPolicies
Dereferenceable
Extractor
HolderGenerator
ResultConverter
ResultConverterGenerator
ObjectWrapper
TypeWrapper

High Level Components

class.hpp/class_fwd.hpp

Classes

class_
bases

def.hpp

Functions

def

def_visitor.hpp

Classes

docstring_options.hpp

Classes

enum.hpp

Classes

enum_

errors.hpp

Classes

error_already_set

Functions

handle_exception
expect_non_null
throw_error_already_set

exception_translator.hpp

Functions

register_exception_translator

init.hpp

Classes

init
optional

iterator.hpp

Classes

iterator
iterators

Functions

range

module.hpp

Macros

BOOST_PYTHON_MODULE

operators.hpp

Classes

self_t
other
operator_

Objects

self

scope.hpp

Classes

scope

stl_iterator.hpp

Classes

stl_input_iterator

wrapper.hpp

Classes

override
wrapper

Object Wrappers

dict.hpp

Classes

dict

list.hpp

Classes

list

long.hpp

Classes

long_

numeric.hpp

Classes

numeric::array

object.hpp

Classes

object

str.hpp

Classes

str

tuple.hpp

Classes

tuple

Functions

make_tuple

slice.hpp

Classes

slice

Function Invocation and Creation

args.hpp

Functions

args

call.hpp

Functions

call

call_method.hpp

Functions

call_method

data_members.hpp

Functions

make_getter
make_setter

make_function.hpp

Functions

make_function
make_constructor

overloads.hpp

macros

BOOST_PYTHON_FUNCTION_OVERLOADS
BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS

ptr.hpp

Functions

ptr

Classes

pointer_wrapper

MetaFunctions

is_pointer_wrapper
unwrap_pointer

raw_function.hpp

Functions

raw_function

To/From Python Type Conversion

extract.hpp

Classes

extract

implicit.hpp

Functions

implicitly_convertible

lvalue_from_pytype.hpp

Classes

lvalue_from_pytype
extract_identity
extract_member

opaque_pointer_converter.hpp

Classes

opaque

Macros

BOOST_PYTHON_OPAQUE_SPECIALIZED_TYPE_ID

to_python_converter.hpp

Classes

to_python_converter

register_ptr_to_python.hpp

Functions

register_ptr_to_python

Embedding

exec.hpp

Functions

eval
exec
exec_file

import.hpp

Functions

import

Utility and Infrastructure

has_back_reference.hpp

Classes

has_back_reference

instance_holder.hpp

Classes

instance_holder

pointee.hpp

Classes

class template pointee

<boost/python.hpp>

handle.hpp

Classes

handle

Functions

borrowed
allow_null

type_id.hpp

Functions

type_id

Classes

type_info

ssize_t.hpp

Typedefs
Constants

Topics

Calling Python Functions and Methods
Pickle Support Indexing Support

Revised 31 October, 2004

Reference

Contents

Models of CallPolicies

Models of ResultConverter

Models of ResultConverterGenerator