Boost.Python Reference Manual

David Abrahams

Stefan Seefeld

Copyright © 2002-2005, 2015 David Abrahams, Stefan Seefeld

Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt

Table of Contents

1. Concepts

CallPolicies
Dereferenceable
Extractor
HolderGenerator
ResultConverter
ObjectWrapper

2. High Level Components

boost/python/class.hpp
boost/python/def.hpp
boost/python/def_visitor.hpp
boost/python/docstring_options.hpp
boost/python/enum.hpp
boost/python/errors.hpp
boost/python/exception_translator.hpp
boost/python/init.hpp
boost/python/iterator.hpp
boost/python/module.hpp
boost/python/operators.hpp
boost/python/scope.hpp
boost/python/stl_iterator.hpp
boost/python/wrapper.hpp

3. Object Wrappers

boost/python/dict.hpp
boost_python_list.hpp
boost/python/long.hpp
boost/python/object.hpp
boost/python/str.hpp
boost/python/slice.hpp
boost/python/tuple.hpp

4. Function Invocation and Creation

boost/python/args.hpp
boost/python/call.hpp
boost/python/call_method.hpp
boost/python/data_members.hpp
boost/python/make_function.hpp
boost/python/overloads.hpp
boost/python/ptr.hpp
boost/python/raw_function.hpp
Function documentation
Models of CallPolicies
Models of ResultConverter
Models of ResultConverterGenerator

5. To/From Python Type Conversion

boost/python/extract.hpp
boost/python/implicit.hpp
boost/python/lvalue_from_pytype.hpp
boost/python/opaque_pointer_converter.hpp
boost/python/to_python_converter.hpp
boost/python/register_ptr_to_python.hpp

6. Embedding

boost/python/exec.hpp
boost/python/import.hpp

7. Utility and Infrastructure

boost/python/has_back_reference.hpp
boost/python/instance_holder.hpp
boost/python/pointee.hpp
boost/python/handle.hpp
boost/python/type_id.hpp
boost/python/ssize_t.hpp

Calling Python Functions and Methods
Pickle support
Indexing support

9. Glossary

Last revised: March 18, 2025 at 15:34:18 GMT