mirror of
https://github.com/boostorg/python.git
synced 2026-01-20 16:52:15 +00:00
161 lines
6.1 KiB
HTML
161 lines
6.1 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN"
|
|
"http://www.w3.org/TR/REC-html40/strict.dtd">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
|
|
<title>
|
|
The Boost Python Library (BPL)
|
|
</title>
|
|
<h1>
|
|
<img src="../../../c++boost.gif" alt="c++boost.gif (8819 bytes)" width="277"
|
|
align="center" height="86">The Boost Python Library (BPL)
|
|
</h1>
|
|
|
|
<h2>Synopsis</h2>
|
|
<p>
|
|
Use the Boost Python Library to quickly and easily export a C++ library to <a
|
|
href="http://www.python.org">Python</a> such that the Python interface is
|
|
very similar to the C++ interface. It is designed to be minimally
|
|
intrusive on your C++ design. In most cases, you should not have to alter
|
|
your C++ classes in any way in order to use them with BPL. The system
|
|
<em>should</em> simply ``reflect'' your C++ classes and functions into
|
|
Python. The major features of BPL include support for:
|
|
<ul>
|
|
<li><a href="inheritance.html">Subclassing extension types in Python</a>
|
|
<li><a href="overriding.html">Overriding virtual functions in Python</a>
|
|
<li><a href="overloading.html">[Member] function Overloading</a>
|
|
<li><a href="special.html#numeric_auto">Automatic wrapping of numeric operators</a>
|
|
</ul>
|
|
among others.
|
|
|
|
|
|
<h2>Supported Platforms</h2>
|
|
<p>BPL has been tested in the following configurations:
|
|
|
|
<ul>
|
|
<li>Against Python 1.5.2 using the following compiler/library:
|
|
|
|
<ul>
|
|
<li><a
|
|
href="http://msdn.microsoft.com/vstudio/sp/vs6sp4/dnldoverview.asp">MSVC++6sp4</a>
|
|
|
|
<li><a
|
|
href="http://msdn.microsoft.com/vstudio/sp/vs6sp4/dnldoverview.asp">MSVC++6sp4</a>/<a
|
|
href="http://www.stlport.org">STLport 4.0</a>
|
|
|
|
<li><a href="http://gcc.gnu.org/">GCC 2.95.2</a> [by <a href="mailto:koethe@informatik.uni-hamburg.de">Ullrich
|
|
Koethe</a>]
|
|
|
|
<li><a href="http://gcc.gnu.org/">GCC 2.95.2</a>/<a href="http://www.stlport.org">STLport 4.0</a>
|
|
|
|
<li>Compaq C++ V6.2-024 for Digital UNIX V5.0 Rev. 910 (an <a
|
|
href="http://www.edg.com/">EDG</a>-based compiler) with <a
|
|
href="http://www.stlport.org/beta.html">STLport-4.1b3</a> [by <a
|
|
href="mailto:rwgk@cci.lbl.gov">Ralf W. Grosse-Kunstleve</a>]
|
|
|
|
<li>An upcoming release of <a href="http://www.metrowerks.com/products/windows/">Metrowerks CodeWarrior
|
|
Pro6 for Windows</a> (the first release has a bug that's fatal to BPL)
|
|
</ul>
|
|
<br>
|
|
<li>Against Python 2.0 using the following compiler/library combinations:
|
|
<ul>
|
|
<li><a
|
|
href="http://msdn.microsoft.com/vstudio/sp/vs6sp4/dnldoverview.asp">MSVC++6sp4</a> [by
|
|
<a href="mailto:aleaxit@yahoo.com">Alex Martelli</a>]
|
|
</ul>
|
|
</ul>
|
|
|
|
<h2>Credits</h2>
|
|
<ul>
|
|
<li><a href="../../../people/dave_abrahams.htm">David Abrahams</a> originated
|
|
and wrote the library.
|
|
|
|
<li><a href="mailto:koethe@informatik.uni-hamburg.de">Ullrich Koethe</a>
|
|
had independently developed a similar system. When he discovered BPL,
|
|
he generously contributed countless hours of coding and much insight into
|
|
improving it. He is responsible for an early version of the support for <a
|
|
href="overloading.html">function overloading</a> and wrote the support for
|
|
<a href="inheritance.html#implicit_conversion">reflecting C++ inheritance
|
|
relationships</a>. He has helped to improve error-reporting from both
|
|
Python and C++, and has designed an extremely easy-to-use way of
|
|
exposing <a href="special.html#numeric">numeric operators</a>, including
|
|
a way to avoid explicit coercion by means of overloading.
|
|
|
|
<li>The members of the boost mailing list and the Python community
|
|
supplied invaluable early feedback. In particular, Ron Clarke, Mark Evans,
|
|
Anton Gluck, Ralf W. Grosse-Kunstleve, Chuck Ingold, Prabhu Ramachandran,
|
|
and Barry Scott took the brave step of trying to use BPL while it was
|
|
still in early stages of development.
|
|
|
|
<li>The development of BPL wouldn't have been
|
|
possible without the generous support of <a href="http://www.dragonsys.com/">Dragon Systems/Lernout and
|
|
Hauspie, Inc</a> who supported its development as an open-source project.
|
|
</ul>
|
|
|
|
<h2>Table of Contents</h2>
|
|
|
|
<ol>
|
|
<li><a href="extending.html">A Brief Introduction to writing Python
|
|
extension modules</a>
|
|
|
|
<li><a href="comparisons.html">Comparisons between BPL and other
|
|
systems for extending Python</a>
|
|
|
|
<li><a href="example1.html">A Simple Example</a>
|
|
|
|
<li><a href="overriding.html">Overridable Virtual Functions</a>
|
|
|
|
<li><a href="overloading.html">Function Overloading</a>
|
|
|
|
<li><a href="inheritance.html">Inheritance</a>
|
|
|
|
<li><a href="special.html">Special Method and Operator Support</a>
|
|
|
|
<li><a href="under-the-hood.html">A Peek Under the Hood</a>
|
|
|
|
<li><a href="building.html">Building an Extension Module</a>
|
|
|
|
<li>Advanced Topics
|
|
|
|
<ol>
|
|
<li><a href="pickle.html">Pickle Support</a>
|
|
|
|
<li>class_builder<>
|
|
|
|
<li><a href="enums.html">enums</a>
|
|
|
|
<li>References
|
|
|
|
<li><a href="pointers.html">Pointers and Smart Pointers</a>
|
|
|
|
<li>Built-in Python Types
|
|
|
|
<li>Other Extension Types
|
|
|
|
<li>Templates
|
|
|
|
<li><a href="data_structures.txt">Internal Data Structures</a>
|
|
</ol>
|
|
|
|
</ol>
|
|
|
|
<p>
|
|
Documentation is a major ongoing project; assistance is greatly
|
|
appreciated! In the meantime, useful examples of every BPL feature should
|
|
be evident in the regression test files <code>test/comprehensive.[<a
|
|
href="../test/comprehensive.py">py</a>/<a
|
|
href="../test/comprehensive.hpp">hpp</a>/<a
|
|
href="../test/comprehensive.cpp">cpp</a>]</code>
|
|
|
|
<p>
|
|
Questions should be directed to <a href=
|
|
"http://www.egroups.com/list/boost">the boost mailing list</a>.
|
|
|
|
<p>
|
|
© Copyright David Abrahams 2000. Permission to copy, use, modify,
|
|
sell and distribute this document is granted provided this copyright
|
|
notice appears in all copies. This document is provided ``as is'' without
|
|
express or implied warranty, and with no claim as to its suitability for
|
|
any purpose.
|
|
<p>
|
|
Updated: Nov 26, 2000
|
|
|