-
+
-
Boost.Python Build and Test HOWTO
+
Boost.Python Build and Test HOWTO
-
-
+
-
-
1 Requirements
-Boost.Python requires Python 2.21 or newer.
+
+
-1 Requirements
+Boost.Python requires Python 2.21 or newer.
-
2 Background
+
+
-2 Background
There are two basic models for combining C++ and Python:
-
-
- extending, in which the end-user launches the Python interpreter +
- extending, in which the end-user launches the Python interpreter executable and imports Python “extension modules” written in C++. Think of taking a library written in C++ and giving it a Python interface so Python programmers can use it. From Python, these modules look just like regular Python modules. -
- embedding, in which the end-user launches a program written +
- embedding, in which the end-user launches a program written in C++ that in turn invokes the Python interpreter as a library subroutine. Think of adding scriptability to an existing application.
The key distinction between extending and embedding is the location -of C++' main() function: in the Python interpreter executable, +of the C++ main() function: in the Python interpreter executable, or in some other program, respectively. Note that even when -embedding Python in another program, extension modules are often +embedding Python in another program, extension modules are often the best way to make C/C++ functionality accessible to Python code, so the use of extension modules is really at the heart of both models.
@@ -71,127 +74,281 @@ dynamically-loaded libraries with a single entry point, which means you can change them without rebuilding either the other extension modules or the executable containing main().
-
3 Getting Boost.Python Binaries
-Since Boost.Python is a separately-compiled (as opposed to -header-only) library, its user relies on the services of a -Boost.Python library binary.
-
-
3.1 No-Install Quickstart
-If you just want to get started quickly building and testing -Boost.Python extension modules, or embedding Python in an -executable, you don't need to worry about installing Boost.Python -binaries explicitly. These instructions use Boost.Build projects, +
+
+
+
-3 No-Install Quickstart
+There is no need to “install Boost” in order to get started using +Boost.Python. These instructions use Boost.Build projects, which will build those binaries as soon as they're needed. Your first tests may take a little longer while you wait for Boost.Python to build, but doing things this way will save you from worrying about build intricacies like which library binaries to use -for a specific compiler configuration.
+for a specific compiler configuration and figuring out the right +compiler options to use yourself. +Note
Of course it's possible to use other build systems to build Boost.Python and its extensions, but they are not -officially supported by Boost and 99% of all “I can't build -Boost.Python” problems come from trying to use another build -system.
-If you want to use another system anyway, we suggest that you -follow these instructions, and then invoke bjam with the --a -ofilename option to dump the build commands it executes -to a file, so you can see what your build system needs to do.
+officially supported by Boost. Moreover 99% of all “I can't +build Boost.Python” problems come from trying to use another +build system without first following these instructions. +If you want to use another system anyway, we suggest that you +follow these instructions, and then invoke bjam with the
++-a -ofilename ++
options to dump the build commands it executes to a file, so +you can see what your alternate build system needs to do.
+
+
+3.1 Basic Procedure
+-
+
Get Boost; see sections 1 and 2 [Unix/Linux, Windows] of the +Boost Getting Started Guide.
+
+Get the bjam build driver. See section 5 [Unix/Linux, +Windows] of the Boost Getting Started Guide.
+
+cd into the libs/python/example/quickstart/ directory of your +Boost installation, which contains a small example project.
+
+Invoke bjam. Replace the “stage“ argument from the +example invocation from section 5 of the Getting Started +Guide with “test,“ to build all the test targets. Also add +the argument “--verbose-test” to see the output generated by +the tests when they are run.
+On Windows, your bjam invocation might look something like:
++C:\boost_1_34_0\…\quickstart> bjam toolset=msvc --verbose-test test +
+and on Unix variants, perhaps,
++~/boost_1_34_0/…/quickstart$ bjam toolset=gcc --verbose-test test +
+
+
+
+Note to Windows Users
+For the sake of concision, the rest of this guide will use +unix-style forward slashes in pathnames instead of the +backslashes with which you may be more familiar. The forward +slashes should work everywhere except in Command Prompt +windows, where you should use backslashes.
+If you followed this procedure successfully, you will have built an +extension module called extending and tested it by running a +Python script called test_extending.py. You will also have +built and run a simple application called embedding that embeds +python.
+
+
+3.2 In Case of Trouble
+If you're seeing lots of compiler and/or linker error messages, +it's probably because Boost.Build is having trouble finding your +Python installation. You might want to pass the +--debug-configuration option to bjam the first few times +you invoke it, to make sure that Boost.Build is correctly locating +all the parts of your Python installation. If it isn't, consider +Configuring Boost.Build as detailed below.
+If you're still having trouble, Someone on one of the following +mailing lists may be able to help:
+-
+
- The Boost.Build mailing list for issues related to Boost.Build +
- The Python C++ Sig for issues specifically related to Boost.Python +
+
+3.3 In Case Everything Seemed to Work
+Rejoice! If you're new to Boost.Python, at this point it might be +a good idea to ignore build issues for a while and concentrate on +learning the library by going through the tutorial and perhaps +some of the reference documentation, trying out what you've +learned about the API by modifying the quickstart project.
+
+
-3.4 Modifying the Example Project
+If you're content to keep your extension module forever in one +source file called extending.cpp, inside your Boost +distribution, and import it forever as extending, then you can +stop here. However, it's likely that you will want to make a few +changes. There are a few things you can do without having to learn +Boost.Build in depth.
+The project you just built is specified in two files in the current +directory: boost-build.jam, which tells bjam where it can +find the interpreted code of the Boost build system, and +Jamroot, which describes the targets you just built. These +files are heavily commented, so they should be easy to modify. +Take care, however, to preserve whitespace. Punctuation such as +; will not be recognized as intended by bjam if it is not +surrounded by whitespace.
+
+
+Relocate the Project
+You'll probably want to copy this project elsewhere so you can +change it without modifying your Boost distribution. To do that, +simply
+-
+
- copy the entire libs/python/example/quickstart/ directory +into a new directory. +
- In the new copies of boost-build.jam and Jamroot, locate +the relative path near the top of the file that is clearly +marked by a comment, and edit that path so that it refers to the +same directory your Boost distribution as it referred to when +the file was in its original location in the +libs/python/example/quickstart/ directory. +
For example, if you moved the project from +/home/dave/boost_1_34_0/libs/python/example/quickstart to +/home/dave/my-project, you could change the first path in +boost-build.jam from
++../../../../tools/build/v2 ++
to
++/home/dave/boost_1_34_0/tools/build/v2 ++
and change the first path in Jamroot from
++../../../.. ++
to
++/home/dave/boost_1_34_0 ++
+
+Add New or Change Names of Existing Source Files
+The names of additional source files involved in building your +extension module or embedding application can be listed in +Jamroot right alongside extending.cpp or embedding.cpp +respectively. Just be sure to leave whitespace around each +filename:
++… file1.cpp file2.cpp file3.cpp … ++
Naturally, if you want to change the name of a source file you can +tell Boost.Build about it by editing the name in Jamroot.
+
+
Change the Name of your Extension Module
+The name of the extension module is determined by two things:
+-
+
- the name in Jamroot immediately following python-extension, and +
- the name passed to BOOST_PYTHON_MODULE in extending.cpp. +
To change the name of the extension module from extending to +hello, you'd edit Jamroot, changing
++python-extension extending : extending.cpp ; ++
to
++python-extension hello : extending.cpp ; ++
and you'd edit extending.cpp, changing
++BOOST_PYTHON_MODULE(extending) ++
to
++BOOST_PYTHON_MODULE(hello) +
-
+3.2 Installing Boost.Python on your System
-If you need a regular, installation of the Boost.Python library -binaries on your system, the Boost Getting Started Guide will -walk you through the steps of installing one. If building binaries +
+
-4 Installing Boost.Python on your System
+Since Boost.Python is a separately-compiled (as opposed to +header-only) library, its user relies on the services of a +Boost.Python library binary.
+If you need a regular installation of the Boost.Python library +binaries on your system, the Boost Getting Started Guide will +walk you through the steps of creating one. If building binaries from source, you might want to supply the --with-python argument to bjam (or the --with-libraries=python argument to configure), so only the Boost.Python binary will be built, rather than all the Boost binaries.
-
4 Configuring Boost.Build
-As described in the Boost.Build reference manual, a file called -user-config.jam in your home -directory7 is used to -describe the build resources available to the build system. You'll -need to tell it about your Python installation.
+
+
-
-
-5 Configuring Boost.Build
+As described in the Boost.Build reference manual, a file called +user-config.jam in your home directory6 is used to +specify the tools and libraries available to the build system. You +may need to create or edit user-config.jam to tell Boost.Build +how to invoke Python, #include its headers, and link with its +libraries.
Users of Unix-Variant OSes
If you are using a unix-variant OS and you ran Boost's configure script, it may have generated a -user-config.jam for you.4 If your configure/make sequence was successful and Boost.Python binaries +user-config.jam for you.4 If your configure/make sequence was successful and Boost.Python binaries were built, your user-config.jam file is probably already correct.
If you have a fairly “standard” python installation for your -platform, there's very little you need to do to describe it. -Simply having
+If you have one fairly “standard” python installation for your +platform, you might not need to do anything special to describe it. If +you haven't configured python in user-config.jam (and you don't +specify --without-python on the Boost.Build command line), +Boost.Build will automatically execute the equivalent of
import toolset : using ; using python ;-
in a user-config.jam file in your home directory7 -should be enough.6 For more complicated setups, -see Advanced Configuration.
-
-
-Note
-You might want to pass the --debug-configuration -option to bjam the first few times you invoke it, to make -sure that Boost.Build is correctly locating all the parts of -your Python installation. If it isn't, consider passing some of -the optional Python configuration parameters detailed below.
-
-
-6 Testing
-
-
7 Advanced Configuration
+which automatically looks for Python in the most likely places. +However, that only happens when using the Boost.Python project file +(e.g. when referred to by another project as in the quickstart +method). If instead you are linking against separately-compiled +Boost.Python binaries, you should set up a user-config.jam file +with at least the minimal incantation above.
+
+
5.1 Python Configuration Parameters
If you have several versions of Python installed, or Python is installed in an unusual way, you may want to supply any or all of the following optional parameters to using python.
-
-
-7.1 Python Configuration Parameters
- version
- the version of Python to use. Should be in Major.Minor format, for example, 2.3. Do not include the subminor version (i.e. not 2.5.1). If you have multiple Python versions installed, the version will usually be the only -additional argument required. +configuration argument required.
- cmd-or-prefix -
- preferably, a command that invokes a Python -interpreter. Alternatively, the installation prefix for Python -libraries and header files. Use the alternative formulation if -there is no appropriate Python executable available. +
- preferably, a command that invokes a Python interpreter. +Alternatively, the installation prefix for Python libraries and +header files. Only use the alternative formulation if there is +no appropriate Python executable available.
- includes -
- the #include path for Python headers. +
- the #include paths for Python headers. Normally the correct +path(s) will be automatically deduced from version and/or +cmd-or-prefix.
- libraries
- the path to Python library binaries. On MacOS/Darwin, -you can also pass the path of the Python framework. +you can also pass the path of the Python framework. Normally the +correct path(s) will be automatically deduced from version +and/or cmd-or-prefix.
- condition
- if specified, should be a set of Boost.Build properties that are matched against the build configuration when -Boost.Build selects a Python configuration to use. +Boost.Build selects a Python configuration to use. See examples +below for details.
- extension-suffix
- A string to append to the name of extension modules before the true filename extension. You almost certainly don't need to use this. Usually this suffix is only used when targeting a Windows debug build of Python, and will be set automatically for you based on the value of the -<python-debugging> feature. However, at least one Linux +<python-debugging> feature. However, at least one Linux distribution (Ubuntu Feisty Fawn) has a specially configured -python-dbg package that claims to use such a suffix. +python-dbg package that claims to use such a suffix.
-
-7.2 Examples
+
+
5.2 Examples
Note that in the examples below, case and especially whitespace are significant.
-
@@ -229,8 +386,19 @@ using python
;
+
If you have downloaded the Python sources and built both the +normal and the “python debugging” builds from source on +Windows, you might see:
++using python : 2.5 : C:\\src\\Python-2.5\\PCBuild\\python ; +using python : 2.5 : C:\\src\\Python-2.5\\PCBuild\\python_d + : # includes + : # libs + : <python-debugging>on ; +
+You can set up your user-config.jam so a bjam built under Windows -can build/test both Windows and Cygwin python extensions. Just pass +can build/test both Windows and Cygwin python extensions. Just pass <target-os>cygwin in the condition parameter for the cygwin python installation:
@@ -241,16 +409,16 @@ using python ; using python : : c:\\cygwin\\bin\\python2.5 : : : <target-os>cygwin ;
when you put target-os=cygwin in your build request, it should build -with the cygwin version of python:5
+with the cygwin version of python:5bjam target-os=cygwin toolset=gcc
This is supposed to work the other way, too (targeting windows -python with a Cygwin bjam) but it seems as though the support in +python with a Cygwin bjam) but it seems as though the support in Boost.Build's toolsets for building that way is broken at the time of this writing.
-Note that because of the way Boost.Build currently selects target +
Note that because of the way Boost.Build currently selects target alternatives, you might have be very explicit in your build requests. For example, given:
@@ -269,35 +437,35 @@ bjam target-os=cygwin/python=2.4
-
8 Choosing a Boost.Python Library Binary
-If—instead of letting Boost.Build construct and link withthe right +
+
6 Choosing a Boost.Python Library Binary
+If—instead of letting Boost.Build construct and link with the right libraries automatically—you choose to use a pre-built Boost.Python library, you'll need to think about which one to link with. The Boost.Python binary comes in both static and dynamic flavors. Take -care to choose the right flavor for your application.2
-
-
8.1 The Dynamic Binary
+care to choose the right flavor for your application.2 +
+
-6.1 The Dynamic Binary
The dynamic library is the safest and most-versatile choice:
- A single copy of the library code is used by all extension -modules built with a given toolset.3 +modules built with a given toolset.3
- The library contains a type conversion registry. Because one registry is shared among all extension modules, instances of a class exposed to Python in one dynamically-loaded extension module can be passed to functions exposed in another such module.
-
-8.2 The Static Binary
+
+
6.2 The Static Binary
It might be appropriate to use the static Boost.Python library in any of the following cases:
-
-
- You are extending python and the types exposed in your +
- You are extending python and the types exposed in your dynamically-loaded extension module don't need to be used by any other Boost.Python extension modules, and you don't care if the core library code is duplicated among them. -
- You are embedding python in your application and either:
-
+
- You are embedding python in your application and either:
- You are targeting a Unix variant OS other than MacOS or AIX, where the dynamically-loaded extension modules can “see” the Boost.Python library symbols that are part of the executable. @@ -311,22 +479,73 @@ modules (and vice-versa).
- You are embedding python in your application and either:
-
9 Notes for MinGW (and Cygwin with -mno-cygwin) GCC Users
+
+
+7 #include Issues
+-
+
- If you should ever have occasion to #include "python.h" +directly in a translation unit of a program using Boost.Python, +use #include "boost/python/detail/wrap_python.hpp" instead. +It handles several issues necessary for use with Boost.Python, +one of which is mentioned in the next section. +
- Be sure not to #include any system headers before +wrap_python.hpp. This restriction is actually imposed by +Python, or more properly, by Python's interaction with your +operating system. See +http://docs.python.org/ext/simpleExample.html for details. +
+
+8 Python Debugging Builds
+Python can be built in a special “python debugging” configuration +that adds extra checks and instrumentation that can be very useful +for developers of extension modules. The data structures used by +the debugging configuration contain additional members, so a +Python executable built with python debugging enabled cannot be +used with an extension module or library compiled without it, and +vice-versa.
+Since pre-built “python debugging” versions of the Python +executable and libraries are not supplied with most distributions +of Python,7 and we didn't want to force our users +to build them, Boost.Build does not automatically enable python +debugging in its debug build variant (which is the default). +Instead there is a special build property called +python-debugging that, when used as a build property, will +define the right preprocessor symbols and select the right +libraries to link with.
+On unix-variant platforms, the debugging versions of Python's data +structures will only be used if the symbol Py_DEBUG is defined. +On many windows compilers, when extension modules are built with +the preprocessor symbol _DEBUG, Python defaults to force +linking with a special debugging version of the Python DLL. Since +that symbol is very commonly used even when Python is not present, +Boost.Python temporarily undefines _DEBUG when Python.h +is #included from boost/python/detail/wrap_python.hpp - unless +BOOST_DEBUG_PYTHON is defined. The upshot is that if you want +“python debugging”and you aren't using Boost.Build, you should make +sure BOOST_DEBUG_PYTHON is defined, or python debugging will be +suppressed.
+
+
+9 Testing Boost.Python
+To run the full test suite for Boost.Python, invoke bjam in the +libs/python/test subdirectory of your Boost distribution.
+
+
-
+
-
-
+
+
@@ -406,9 +627,9 @@ ECHO %HOMEDRIVE%%HOMEPATH%
diff --git a/doc/building.rst b/doc/building.rst
index 27bdf661..37700e35 100644
--- a/doc/building.rst
+++ b/doc/building.rst
@@ -7,7 +7,7 @@
|(logo)|__ Boost.Python Build and Test HOWTO
==============================================
-.. |(logo)| image:: ../boost.png
+.. |(logo)| image:: ../../../boost.png
:alt: Boost C++ Libraries:
:class: boost-logo
@@ -31,36 +31,6 @@ Boost.Python requires `Python 2.2`_ [#2.2]_ *or* |newer|__.
.. _Python 2.2: http://www.python.org/2.2
__ http://www.python.org
-No-Install Quickstart
-=====================
-
-There is no need to install Boost in order to get started using
-Boost.Python. These instructions use Boost.Build_ projects,
-which will build those binaries as soon as they're needed. Your
-first tests may take a little longer while you wait for
-Boost.Python to build, but doing things this way will save you from
-worrying about build intricacies like which library binaries to use
-for a specific compiler configuration.
-
-.. Note:: Of course it's possible to use other build systems to
- build Boost.Python and its extensions, but they are not
- officially supported by Boost. Moreover **99% of all “I can't
- build Boost.Python” problems come from trying to use another
- build system**.
-
- If you want to use another system anyway, we suggest that you
- follow these instructions, and then invoke ``bjam`` with the
- ``-a -o``\ *filename* option to dump the build commands it executes
- to a file, so you can see what your build system needs to do.
-
-1. Get Boost; see sections 1 and 2 of the Boost `Getting Started Guide`_.
-2. Get the ``bjam`` build driver. See sections 5.2.1-5.2.3 of the
- Boost `Getting Started Guide`_.
-3. cd into the ``libs/python/test/example`` directory.
-
-.. _Getting Started Guide: ../../../more/getting_started/index.html
-
-
Background
==========
@@ -81,7 +51,7 @@ There are two basic models for combining C++ and Python:
.. _embedding: http://www.python.org/doc/current/ext/embedding.html
The key distinction between extending and embedding is the location
-of C++' ``main()`` function: in the Python interpreter executable,
+of the C++ ``main()`` function: in the Python interpreter executable,
or in some other program, respectively. Note that even when
embedding Python in another program, `extension modules are often
the best way to make C/C++ functionality accessible to Python
@@ -95,8 +65,254 @@ dynamically-loaded libraries with a single entry point, which means
you can change them without rebuilding either the other extension
modules or the executable containing ``main()``.
-Getting Boost.Python Binaries
-=============================
+.. _quickstart:
+
+No-Install Quickstart
+=====================
+
+There is no need to “install Boost” in order to get started using
+Boost.Python. These instructions use Boost.Build_ projects,
+which will build those binaries as soon as they're needed. Your
+first tests may take a little longer while you wait for
+Boost.Python to build, but doing things this way will save you from
+worrying about build intricacies like which library binaries to use
+for a specific compiler configuration and figuring out the right
+compiler options to use yourself.
+
+.. .. raw:: html
+
+ `` feature. However, at least one Linux
+ |python-debugging|_ feature. However, at least one Linux
distribution (Ubuntu Feisty Fawn) has a specially configured
`python-dbg`__ package that claims to use such a suffix.
+.. |python-debugging| replace:: ````
+
__ https://wiki.ubuntu.com/PyDbgBuilds
@@ -247,6 +456,17 @@ significant.
: intel # condition
;
+
+- If you have downloaded the Python sources and built both the
+ normal and the “\ `python debugging`_\ ” builds from source on
+ Windows, you might see::
+
+ using python : 2.5 : C:\\src\\Python-2.5\\PCBuild\\python ;
+ using python : 2.5 : C:\\src\\Python-2.5\\PCBuild\\python_d
+ : # includes
+ : # libs
+ : on ;
+
- You can set up your user-config.jam so a bjam built under Windows
can build/test both Windows and Cygwin_ python extensions. Just pass
``cygwin`` in the ``condition`` parameter
@@ -290,7 +510,7 @@ __ http://zigzag.cs.msu.su/boost.build/wiki/AlternativeSelection
Choosing a Boost.Python Library Binary
======================================
-If—instead of letting Boost.Build construct and link withthe right
+If—instead of letting Boost.Build construct and link with the right
libraries automatically—you choose to use a pre-built Boost.Python
library, you'll need to think about which one to link with. The
Boost.Python binary comes in both static and dynamic flavors. Take
@@ -332,6 +552,64 @@ any of the following cases:
use the types exposed by your statically-linked extension
modules (and vice-versa).
+``#include`` Issues
+===================
+
+1. If you should ever have occasion to ``#include "python.h"``
+ directly in a translation unit of a program using Boost.Python,
+ use ``#include "boost/python/detail/wrap_python.hpp"`` instead.
+ It handles several issues necessary for use with Boost.Python,
+ one of which is mentioned in the next section.
+
+2. Be sure not to ``#include`` any system headers before
+ ``wrap_python.hpp``. This restriction is actually imposed by
+ Python, or more properly, by Python's interaction with your
+ operating system. See
+ http://docs.python.org/ext/simpleExample.html for details.
+
+.. _python-debugging:
+.. _python debugging:
+
+Python Debugging Builds
+=======================
+
+Python can be built in a special “python debugging” configuration
+that adds extra checks and instrumentation that can be very useful
+for developers of extension modules. The data structures used by
+the debugging configuration contain additional members, so **a
+Python executable built with python debugging enabled cannot be
+used with an extension module or library compiled without it, and
+vice-versa.**
+
+Since pre-built “python debugging” versions of the Python
+executable and libraries are not supplied with most distributions
+of Python, [#get-debug-build]_ and we didn't want to force our users
+to build them, Boost.Build does not automatically enable python
+debugging in its ``debug`` build variant (which is the default).
+Instead there is a special build property called
+``python-debugging`` that, when used as a build property, will
+define the right preprocessor symbols and select the right
+libraries to link with.
+
+On unix-variant platforms, the debugging versions of Python's data
+structures will only be used if the symbol ``Py_DEBUG`` is defined.
+On many windows compilers, when extension modules are built with
+the preprocessor symbol ``_DEBUG``, Python defaults to force
+linking with a special debugging version of the Python DLL. Since
+that symbol is very commonly used even when Python is not present,
+Boost.Python temporarily undefines _DEBUG when Python.h
+is #included from ``boost/python/detail/wrap_python.hpp`` - unless
+``BOOST_DEBUG_PYTHON`` is defined. The upshot is that if you want
+“python debugging”and you aren't using Boost.Build, you should make
+sure ``BOOST_DEBUG_PYTHON`` is defined, or python debugging will be
+suppressed.
+
+Testing Boost.Python
+====================
+
+To run the full test suite for Boost.Python, invoke ``bjam`` in the
+``libs/python/test`` subdirectory of your Boost distribution.
+
Notes for MinGW (and Cygwin with -mno-cygwin) GCC Users
=======================================================
@@ -365,13 +643,9 @@ __ http://www.python.org/doc/current/inst/index.html
__ ../../../more/getting_started/windows.html#library-naming
__ ../../../more/getting_started/unix-variants.html#library-naming
- Be sure to read this section even if your compiler supports
- auto-linking, as Boost.Python does not yet take advantage of
- that feature.
-
.. [#toolset-specific] Because of the way most \*nix platforms
- share symbols among dynamically-loaded objects, I'm not
- certainextension modules built with different compiler toolsets
+ share symbols among dynamically-loaded objects, I'm not certain
+ that extension modules built with different compiler toolsets
will always use different copies of the Boost.Python library
when loaded into the same Python instance. Not using different
libraries could be a good thing if the compilers have compatible
@@ -391,14 +665,16 @@ __ http://www.python.org/doc/current/inst/index.html
toolset, and you might need handle both explicitly if you also
have a MinGW GCC installed.
-.. [#user-config.jam] Create the ``user-config.jam`` file if you don't
- already have one.
-
.. [#home-dir] Windows users, your home directory can be
found by typing::
ECHO %HOMEDRIVE%%HOMEPATH%
- into a `Windows command prompt`__
+ into a `command prompt`_ window.
-__ ../../../more/getting_started/windows.html#or-build-from-the-command-prompt
+.. [#get-debug-build] On Unix and similar platforms, a debugging
+ python and associated libraries are built by adding
+ ``--with-pydebug`` when configuring the Python build. On
+ Windows, the debugging version of Python is generated by
+ the "Win32 Debug" target of the Visual Studio project in the
+ PCBuild subdirectory of a full Python source code distribution.
diff --git a/doc/index.html b/doc/index.html
index d8795e92..e5e16eb2 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -147,7 +147,9 @@
Frequently Asked Questions (FAQs)
- Pyste (Boost.Python code generator)
+ Py++ Boost.Python code generator
+
+ Pyste Boost.Python code generator (no longer maintained)
Internals Documentation
diff --git a/doc/news.html b/doc/news.html
index 6e637a04..45a5b2f5 100644
--- a/doc/news.html
+++ b/doc/news.html
@@ -32,7 +32,43 @@
10 Notes for MinGW (and Cygwin with -mno-cygwin) GCC Users
If you are using a version of Python prior to 2.4.1 with a MinGW prior to 3.0.0 (with binutils-2.13.90-20030111-1), you will need to create a MinGW-compatible version of the Python library; the one shipped with Python will only work with a Microsoft-compatible linker. Follow the instructions in the “Non-Microsoft” section of -the “Building Extensions: Tips And Tricks” chapter in Installing +the “Building Extensions: Tips And Tricks” chapter in Installing Python Modules to create libpythonXX.a, where XX corresponds to the major and minor version numbers of your Python installation.
-
| [1] | Note that although we tested earlier versions of + | ||||
| [1] | Note that although we tested earlier versions of Boost.Python with Python 2.2, and we don't think we've done anything to break compatibility, this release of Boost.Python may not have been tested with versions of Python earlier than @@ -337,24 +556,21 @@ supported. |
| [2] | Information about how to identify the + |
| [2] | Information about how to identify the static and dynamic builds of Boost.Python: -Be sure to read this section even if your compiler supports -auto-linking, as Boost.Python does not yet take advantage of -that feature. |
| [3] | Because of the way most *nix platforms -share symbols among dynamically-loaded objects, I'm not -certainextension modules built with different compiler toolsets + | ||||
| [3] | Because of the way most *nix platforms +share symbols among dynamically-loaded objects, I'm not certain +that extension modules built with different compiler toolsets will always use different copies of the Boost.Python library when loaded into the same Python instance. Not using different libraries could be a good thing if the compilers have compatible @@ -369,7 +585,7 @@ happens. |
| [4] | configure overwrites the existing + | ||||
| [4] | configure overwrites the existing user-config.jam in your home directory (if any) after making a backup of the old version. |
| [5] | Note that the <target-os>cygwin feature is + |
| [5] | Note that the <target-os>cygwin feature is different from the <flavor>cygwin subfeature of the gcc toolset, and you might need handle both explicitly if you also have a MinGW GCC installed. |
| [6] | Create the user-config.jam file if you don't -already have one. |
| [7] | (1, 2) Windows users, your home directory can be + |
| [6] | Windows users, your home directory can be found by typing: ECHO %HOMEDRIVE%%HOMEPATH%- into a Windows command prompt +into a command prompt window. + |
| [7] | On Unix and similar platforms, a debugging +python and associated libraries are built by adding +--with-pydebug when configuring the Python build. On +Windows, the debugging version of Python is generated by +the "Win32 Debug" target of the Visual Studio project in the +PCBuild subdirectory of a full Python source code distribution. |
+
+.. Note:: Of course it's possible to use other build systems to
+ build Boost.Python and its extensions, but they are not
+ officially supported by Boost. Moreover **99% of all “I can't
+ build Boost.Python” problems come from trying to use another
+ build system** without first following these instructions.
+
+ If you want to use another system anyway, we suggest that you
+ follow these instructions, and then invoke ``bjam`` with the
+
+ .. parsed-literal::
+
+ ``-a -o``\ *filename*
+
+ options to dump the build commands it executes to a file, so
+ you can see what your alternate build system needs to do.
+
+.. .. raw:: html
+
+
+
+.. _Boost.Build: ../../../tools/build/index.html
+
+Basic Procedure
+---------------
+
+1. Get Boost; see sections 1 and 2 [`Unix/Linux`__, `Windows`__\ ] of the
+ Boost `Getting Started Guide`_.
+
+ __ ../../../more/getting_started/unix-variants.html#get-boost
+ __ ../../../more/getting_started/windows.html#get-boost
+
+2. Get the ``bjam`` build driver. See section 5 [`Unix/Linux`__,
+ `Windows`__\ ] of the Boost `Getting Started Guide`_.
+
+ __ ../../../more/getting_started/unix-variants.html#prepare-to-use-a-boost-library-binary
+ __ ../../../more/getting_started/windows.html#prepare-to-use-a-boost-library-binary
+
+
+3. cd into the ``libs/python/example/quickstart/`` directory of your
+ Boost installation, which contains a small example project.
+
+4. Invoke ``bjam``. Replace the “\ ``stage``\ “ argument from the
+ example invocation from section 5 of the `Getting Started
+ Guide`_ with “\ ``test``\ ,“ to build all the test targets. Also add
+ the argument “\ ``--verbose-test``\ ” to see the output generated by
+ the tests when they are run.
+
+ On Windows, your ``bjam`` invocation might look something like:
+
+ .. parsed-literal::
+
+ C:\\boost_1_34_0\\…\\quickstart> **bjam toolset=msvc --verbose-test test**
+
+ and on Unix variants, perhaps,
+
+ .. parsed-literal::
+
+ ~/boost_1_34_0/…/quickstart$ **bjam toolset=gcc --verbose-test test**
+
+.. Admonition:: Note to Windows Users
+
+ For the sake of concision, the rest of this guide will use
+ unix-style forward slashes in pathnames instead of the
+ backslashes with which you may be more familiar. The forward
+ slashes should work everywhere except in `Command Prompt`_
+ windows, where you should use backslashes.
+
+ .. _Command Prompt: ../../../more/getting_started/windows.html#command-prompt
+
+If you followed this procedure successfully, you will have built an
+extension module called ``extending`` and tested it by running a
+Python script called ``test_extending.py``. You will also have
+built and run a simple application called ``embedding`` that embeds
+python.
+
+.. _Getting Started Guide: ../../../more/getting_started/index.html
+
+In Case of Trouble
+------------------
+
+If you're seeing lots of compiler and/or linker error messages,
+it's probably because Boost.Build is having trouble finding your
+Python installation. You might want to pass the
+``--debug-configuration`` option to ``bjam`` the first few times
+you invoke it, to make sure that Boost.Build is correctly locating
+all the parts of your Python installation. If it isn't, consider
+`Configuring Boost.Build`_ as detailed below.
+
+If you're still having trouble, Someone on one of the following
+mailing lists may be able to help:
+
+* The `Boost.Build mailing list`__ for issues related to Boost.Build
+* The Python `C++ Sig`__ for issues specifically related to Boost.Python
+
+__ ../../../more/mailing_lists.htm#jamboost
+__ ../../../more/mailing_lists.htm#cplussig
+
+In Case Everything Seemed to Work
+---------------------------------
+
+Rejoice! If you're new to Boost.Python, at this point it might be
+a good idea to ignore build issues for a while and concentrate on
+learning the library by going through the tutorial_ and perhaps
+some of the `reference documentation`_, trying out what you've
+learned about the API by modifying the quickstart project.
+
+.. _reference documentation: v2/reference.html
+.. _tutorial: tutorial/index.html
+
+Modifying the Example Project
+-----------------------------
+
+If you're content to keep your extension module forever in one
+source file called |extending.cpp|_, inside your Boost
+distribution, and import it forever as ``extending``, then you can
+stop here. However, it's likely that you will want to make a few
+changes. There are a few things you can do without having to learn
+Boost.Build_ in depth.
+
+The project you just built is specified in two files in the current
+directory: |boost-build.jam|_, which tells ``bjam`` where it can
+find the interpreted code of the Boost build system, and
+|Jamroot|_, which describes the targets you just built. These
+files are heavily commented, so they should be easy to modify.
+Take care, however, to preserve whitespace. Punctuation such as
+``;`` will not be recognized as intended by ``bjam`` if it is not
+surrounded by whitespace.
+
+.. |boost-build.jam| replace:: ``boost-build.jam``
+.. _boost-build.jam: ../example/quickstart/boost-build.jam
+
+.. |Jamroot| replace:: ``Jamroot``
+.. _Jamroot: ../example/quickstart/Jamroot
+
+.. |extending.cpp| replace:: ``extending.cpp``
+.. _extending.cpp: ../example/quickstart/extending.cpp
+
+Relocate the Project
+....................
+
+You'll probably want to copy this project elsewhere so you can
+change it without modifying your Boost distribution. To do that,
+simply
+
+a. copy the entire ``libs/python/example/quickstart/`` directory
+ into a new directory.
+
+b. In the new copies of |boost-build.jam|_ and |Jamroot|_, locate
+ the relative path near the top of the file that is clearly
+ marked by a comment, and edit that path so that it refers to the
+ same directory your Boost distribution as it referred to when
+ the file was in its original location in the
+ ``libs/python/example/quickstart/`` directory.
+
+For example, if you moved the project from
+``/home/dave/boost_1_34_0/libs/python/example/quickstart`` to
+``/home/dave/my-project``, you could change the first path in
+|boost-build.jam|_ from
+
+.. parsed-literal::
+
+ **../../../..**\ /tools/build/v2
+
+to
+
+.. parsed-literal::
+
+ **/home/dave/boost_1_34_0**\ /tools/build/v2
+
+and change the first path in |Jamroot|_ from
+
+.. parsed-literal::
+
+ **../../../..**
+
+to
+
+.. parsed-literal::
+
+ **/home/dave/boost_1_34_0**
+
+Add New or Change Names of Existing Source Files
+................................................
+
+The names of additional source files involved in building your
+extension module or embedding application can be listed in
+|Jamroot|_ right alongside ``extending.cpp`` or ``embedding.cpp``
+respectively. Just be sure to leave whitespace around each
+filename::
+
+ … file1.cpp file2.cpp file3.cpp …
+
+Naturally, if you want to change the name of a source file you can
+tell Boost.Build about it by editing the name in |Jamroot|_.
+
+Change the Name of your Extension Module
+........................................
+
+The name of the extension module is determined by two things:
+
+1. the name in |Jamroot|_ immediately following ``python-extension``, and
+2. the name passed to ``BOOST_PYTHON_MODULE`` in |extending.cpp|_.
+
+To change the name of the extension module from ``extending`` to
+``hello``, you'd edit |Jamroot|_, changing
+
+.. parsed-literal::
+
+ python-extension **extending** : extending.cpp ;
+
+to
+
+.. parsed-literal::
+
+ python-extension **hello** : extending.cpp ;
+
+and you'd edit extending.cpp, changing
+
+.. parsed-literal::
+
+ BOOST_PYTHON_MODULE(\ **extending**\ )
+
+to
+
+.. parsed-literal::
+
+ BOOST_PYTHON_MODULE(\ **hello**\ )
+
+Installing Boost.Python on your System
+======================================
Since Boost.Python is a separately-compiled (as opposed to
`header-only`_) library, its user relies on the services of a
@@ -104,25 +320,24 @@ Boost.Python library binary.
.. _header-only: ../../../more/getting_started/windows.html#header-only-libraries
-Installing Boost.Python on your System
---------------------------------------
-
-If you need a regular, installation of the Boost.Python library
+If you need a regular installation of the Boost.Python library
binaries on your system, the Boost `Getting Started Guide`_ will
-walk you through the steps of installing one. If building binaries
+walk you through the steps of creating one. If building binaries
from source, you might want to supply the ``--with-python``
argument to ``bjam`` (or the ``--with-libraries=python`` argument
to ``configure``), so only the Boost.Python binary will be built,
rather than all the Boost binaries.
+
Configuring Boost.Build
=======================
As described in the `Boost.Build reference manual`__, a file called
-``user-config.jam`` in your home
-directory [#home-dir]_ is used to
-describe the build resources available to the build system. You'll
-need to tell it about your Python installation.
+``user-config.jam`` in your home directory [#home-dir]_ is used to
+specify the tools and libraries available to the build system. You
+may need to create or edit ``user-config.jam`` to tell Boost.Build
+how to invoke Python, ``#include`` its headers, and link with its
+libraries.
__ http://www.boost.orgdoc/html/bbv2/advanced.html#bbv2.advanced.configuration
@@ -135,66 +350,58 @@ __ http://www.boost.orgdoc/html/bbv2/advanced.html#bbv2.advanced.configuration
were built, your ``user-config.jam`` file is probably already
correct.
-If you have a fairly “standard” python installation for your
-platform, there's very little you need to do to describe it.
-Simply having ::
+If you have one fairly “standard” python installation for your
+platform, you might not need to do anything special to describe it. If
+you haven't configured python in ``user-config.jam`` (and you don't
+specify ``--without-python`` on the Boost.Build command line),
+Boost.Build will automatically execute the equivalent of ::
-
import toolset : using ;
using python ;
-in a ``user-config.jam`` file in your home directory [#home-dir]_
-should be enough. [#user-config.jam]_ For more complicated setups,
-see `Advanced Configuration`_.
+which automatically looks for Python in the most likely places.
+However, that only happens when using the Boost.Python project file
+(e.g. when referred to by another project as in the quickstart_
+method). If instead you are linking against separately-compiled
+Boost.Python binaries, you should set up a ``user-config.jam`` file
+with at least the minimal incantation above.
-.. Note:: You might want to pass the ``--debug-configuration``
- option to ``bjam`` the first few times you invoke it, to make
- sure that Boost.Build is correctly locating all the parts of
- your Python installation. If it isn't, consider passing some of
- the optional `Python configuration parameters`_ detailed below.
-
-Building an Extension Module
-============================
-
-
-Testing
-=======
-
-
-Advanced Configuration
-======================
+Python Configuration Parameters
+-------------------------------
If you have several versions of Python installed, or Python is
installed in an unusual way, you may want to supply any or all of
the following optional parameters to ``using python``.
-Python Configuration Parameters
--------------------------------
-
version
the version of Python to use. Should be in Major.Minor
format, for example, ``2.3``. Do not include the subminor
version (i.e. *not* ``2.5.1``). If you have multiple Python
versions installed, the version will usually be the only
- additional argument required.
+ configuration argument required.
cmd-or-prefix
- preferably, a command that invokes a Python
- interpreter. Alternatively, the installation prefix for Python
- libraries and header files. Use the alternative formulation if
- there is no appropriate Python executable available.
+ preferably, a command that invokes a Python interpreter.
+ Alternatively, the installation prefix for Python libraries and
+ header files. Only use the alternative formulation if there is
+ no appropriate Python executable available.
includes
- the ``#include`` path for Python headers.
+ the ``#include`` paths for Python headers. Normally the correct
+ path(s) will be automatically deduced from ``version`` and/or
+ ``cmd-or-prefix``.
libraries
the path to Python library binaries. On MacOS/Darwin,
- you can also pass the path of the Python framework.
+ you can also pass the path of the Python framework. Normally the
+ correct path(s) will be automatically deduced from ``version``
+ and/or ``cmd-or-prefix``.
condition
if specified, should be a set of Boost.Build
properties that are matched against the build configuration when
- Boost.Build selects a Python configuration to use.
+ Boost.Build selects a Python configuration to use. See examples
+ below for details.
extension-suffix
A string to append to the name of extension
@@ -202,10 +409,12 @@ extension-suffix
don't need to use this. Usually this suffix is only used when
targeting a Windows debug build of Python, and will be set
automatically for you based on the value of the
- ``-
-
- Current CVS +
- Current SVN + +
-
+
-
+
- Pythonic signatures are now automatically appended to the + docstrings. + +
- Use
docstring_options.hppheader + control the content of docstrings. + + - This new feature increases the size of the modules by about 14%. + If this is not acceptable it can be turned off by defining the macro + BOOST_PYTHON_NO_PY_SIGNATURES. Modules compiled with and without the macro + defined are compatible. + +
- If BOOST_PYTHON_NO_PY_SIGNATURES is undefined, this version defines the + macro BOOST_PYTHON_SUPPORTS_PY_SIGNATURES. This allows writing code that will compile + with older version of Boost.Python (see here). + +
- By defining BOOST_PYTHON_PY_SIGNATURES_PROPER_INIT_SELF_TYPE, and at a cost + of another 14% size increase, proper pythonic type is generated for the "self" + parameter of the __init__ methods. + + +
- To support this new feature changes were made to the
+
to_python_converter.hpp, +default_call_policies, +ResultConverter, +CallPoliciesand some others. + Efforts were made not to have interface breaking changes. +
+
+
+
+ - 12 May 2007 - 1.34.0 release
-
-
diff --git a/doc/tutorial/doc/html/index.html b/doc/tutorial/doc/html/index.html
index 5188c77f..53096363 100644
--- a/doc/tutorial/doc/html/index.html
+++ b/doc/tutorial/doc/html/index.html
@@ -3,21 +3,21 @@
Chapter1.python 1.0 - + - + -+
+
Home Libraries People FAQ More -
-+
@@ -31,7 +31,7 @@
Copyright 2002-2005 Joel de Guzman, David Abrahams
-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 ) @@ -93,10 +93,10 @@ code takes on the look of a kind of declarative interface definition language (IDL).
-- +
++ Hello World -
Following C/C++ tradition, let's start with the "hello, world". A C++ Function: @@ -112,10 +112,10 @@
#include <boost/python.hpp> -using namespace boost::python; -BOOST_PYTHON_MODULE(hello) +BOOST_PYTHON_MODULE(hello_ext) { + using namespace boost::python; def("greet", greet); }
@@ -126,7 +126,7 @@->>> import hello +>>> import hello_ext >>> print hello.greet() hello, world
@@ -136,8 +136,8 @@- Next stop... Building your Hello World - module from start to finish... + Next stop... Building your Hello World + module from start to finish...
@@ -145,10 +145,10 @@- Last revised: May 18, 2007 at 15:46:01 GMT
Last revised: November 04, 2007 at 00:10:08 GMT
-+