diff --git a/build/Jamfile.v2 b/build/Jamfile.v2 index 7be77f1f..e01a27b7 100644 --- a/build/Jamfile.v2 +++ b/build/Jamfile.v2 @@ -7,6 +7,20 @@ import modules ; import python ; +if ! [ python.configured ] && ! ( --without-python in [ modules.peek : ARGV ] ) +{ + # Attempt default configuration of python + import toolset : using ; + using python ; + + if ! [ python.configured ] + { + ECHO "WARNING: No python installation configured and autoconfiguration" ; + ECHO " failed. See http://www.boost.org/libs/python/doc/building.html" ; + ECHO " for configuration instructions or pass --without-python to" ; + ECHO " suppress this message and silently skip all Boost.Python targets" ; + } +} project boost/python : source-location ../src @@ -25,7 +39,6 @@ lib boost_python str.cpp slice.cpp - aix_init_module.cpp converter/from_python.cpp converter/registry.cpp converter/type_id.cpp @@ -69,12 +82,13 @@ lib boost_python # as it's not possible anyway, and to cause dependents to # fail to build [ unless [ python.configured ] : no ] - + + on:BOOST_DEBUG_PYTHON : # default build shared : # usage requirements - static:BOOST_PYTHON_STATIC_LIB - shared:BOOST_PYTHON_DYNAMIC_LIB + static:BOOST_PYTHON_STATIC_LIB + on:BOOST_DEBUG_PYTHON ; boost-install boost_python ; diff --git a/doc/building.html b/doc/building.html index 94f39955..ad42d02b 100644 --- a/doc/building.html +++ b/doc/building.html @@ -9,60 +9,63 @@
-

Boost.Python Build and Test HOWTO

+

Boost.Python Build and Test HOWTO

-
-

Contents

+ -
-

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

+
    +

  1. Get Boost; see sections 1 and 2 [Unix/Linux, Windows] of the +Boost Getting Started Guide.

    +
    2. +

  2. Get the bjam build driver. See section 5 [Unix/Linux, +Windows] of the Boost Getting Started Guide.

    +
    3. +

  3. cd into the libs/python/example/quickstart/ directory of your +Boost installation, which contains a small example project.

    +
    4. +

  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:

    +
    +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
+
    +
    5. +
+
+

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:

+ +
+
+

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

+
    +
  1. copy the entire libs/python/example/quickstart/ directory +into a new directory.
    2. +
  2. 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.
    3. +
+

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:

+
    +
  1. the name in Jamroot immediately following python-extension, and
    2. +
  2. the name passed to BOOST_PYTHON_MODULE in extending.cpp.
    3. +
+

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.

-
-
-
-

5   Building an Extension Module

-
-
-

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:5

    bjam 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).
-
-

9   Notes for MinGW (and Cygwin with -mno-cygwin) GCC Users

+
+

7   #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. +
  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.
    3. +
+
+
+

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.

+
+
+

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.
- @@ -377,28 +593,33 @@ 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.
@@ -406,9 +627,9 @@ ECHO %HOMEDRIVE%%HOMEPATH%
-View document source. -Generated on: 2007-04-05 20:04 UTC. -Generated by Docutils from reStructuredText source. +View document source. +Generated on: 2007-07-02 13:46 UTC. +Generated by Docutils from reStructuredText source.
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 + +
+ +.. 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 - ```` 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/example/quickstart/Jamroot b/example/quickstart/Jamroot new file mode 100755 index 00000000..569dae13 --- /dev/null +++ b/example/quickstart/Jamroot @@ -0,0 +1,43 @@ +# Copyright David Abrahams 2006. 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) + +# Specify the path to the Boost project. If you move this project, +# adjust the path to refer to the Boost root directory. +use-project boost + : ../../../.. ; + +# Set up the project-wide requirements that everything uses the +# boost_python library defined in the project whose global ID is +# /boost/python. +project boost-python-quickstart + : requirements /boost/python//boost_python + ; + +# Make the definition of the python-extension rule available +import python ; + +# Declare a Python extension called hello. +python-extension extending : extending.cpp ; + +# Declare an executable called embedding that embeds Python +exe embedding : embedding.cpp /python//python ; + +import testing ; + +# Declare a test of the extension module +testing.make-test run-pyd : extending test_extending.py : : test_ext ; + +# Declare a test of the embedding application +testing.run embedding + : # any ordinary arguments + : script.py # any arguments that should be treated as relative paths + : # requirements + : test_embed ; # name of test + +# Create a "test" target that runs all the tests +alias test : test_ext test_embed ; + +# make sure the tests don't run by default +explicit test_ext test_embed test ; + diff --git a/example/quickstart/boost-build.jam b/example/quickstart/boost-build.jam new file mode 100644 index 00000000..a440ea9f --- /dev/null +++ b/example/quickstart/boost-build.jam @@ -0,0 +1,7 @@ +# Copyright David Abrahams 2006. 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) + +# Edit this path to point at the tools/build/v2 subdirectory of your +# Boost installation. Absolute paths work, too. +boost-build ../../../../tools/build/v2 ; diff --git a/example/quickstart/embedding.cpp b/example/quickstart/embedding.cpp new file mode 100644 index 00000000..65bcd16a --- /dev/null +++ b/example/quickstart/embedding.cpp @@ -0,0 +1,154 @@ +// Copyright Stefan Seefeld 2005. +// 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) + +#include + +#include +#include + +namespace python = boost::python; + +// An abstract base class +class Base : public boost::noncopyable +{ +public: + virtual ~Base() {}; + virtual std::string hello() = 0; +}; + +// C++ derived class +class CppDerived : public Base +{ +public: + virtual ~CppDerived() {} + virtual std::string hello() { return "Hello from C++!";} +}; + +// Familiar Boost.Python wrapper class for Base +struct BaseWrap : Base, python::wrapper +{ + virtual std::string hello() + { +#if BOOST_WORKAROUND(BOOST_MSVC, <= 1300) + // workaround for VC++ 6.x or 7.0, see + // http://boost.org/libs/python/doc/tutorial/doc/html/python/exposing.html#python.class_virtual_functions + return python::call(this->get_override("hello").ptr()); +#else + return this->get_override("hello")(); +#endif + } +}; + +// Pack the Base class wrapper into a module +BOOST_PYTHON_MODULE(embedded_hello) +{ + python::class_ base("Base"); +} + + +void exec_test() +{ + std::cout << "registering extension module embedded_hello..." << std::endl; + + // Register the module with the interpreter + if (PyImport_AppendInittab("embedded_hello", initembedded_hello) == -1) + throw std::runtime_error("Failed to add embedded_hello to the interpreter's " + "builtin modules"); + + std::cout << "defining Python class derived from Base..." << std::endl; + + // Retrieve the main module + python::object main = python::import("__main__"); + + // Retrieve the main module's namespace + python::object global(main.attr("__dict__")); + + // Define the derived class in Python. + python::object result = python::exec( + "from embedded_hello import * \n" + "class PythonDerived(Base): \n" + " def hello(self): \n" + " return 'Hello from Python!' \n", + global, global); + + python::object PythonDerived = global["PythonDerived"]; + + // Creating and using instances of the C++ class is as easy as always. + CppDerived cpp; + BOOST_TEST(cpp.hello() == "Hello from C++!"); + + std::cout << "testing derived class from C++..." << std::endl; + + // But now creating and using instances of the Python class is almost + // as easy! + python::object py_base = PythonDerived(); + Base& py = python::extract(py_base) BOOST_EXTRACT_WORKAROUND; + + // Make sure the right 'hello' method is called. + BOOST_TEST(py.hello() == "Hello from Python!"); + + std::cout << "success!" << std::endl; +} + +void exec_file_test(std::string const &script) +{ + std::cout << "running file " << script << "..." << std::endl; + + // Run a python script in an empty environment. + python::dict global; + python::object result = python::exec_file(script.c_str(), global, global); + + // Extract an object the script stored in the global dictionary. + BOOST_TEST(python::extract(global["number"]) == 42); + + std::cout << "success!" << std::endl; +} + +void exec_test_error() +{ + std::cout << "intentionally causing a python exception..." << std::endl; + + // Execute a statement that raises a python exception. + python::dict global; + python::object result = python::exec("print unknown \n", global, global); + + std::cout << "Oops! This statement should be skipped due to an exception" << std::endl; +} + +int main(int argc, char **argv) +{ + BOOST_TEST(argc == 2); + std::string script = argv[1]; + // Initialize the interpreter + Py_Initialize(); + + bool error_expected = false; + + if ( + python::handle_exception(exec_test) + || python::handle_exception(boost::bind(exec_file_test, script)) + || ( + (error_expected = true) + && python::handle_exception(exec_test_error) + ) + + ) + { + if (PyErr_Occurred()) + { + if (!error_expected) + BOOST_ERROR("Python Error detected"); + PyErr_Print(); + } + else + { + BOOST_ERROR("A C++ exception was thrown for which " + "there was no exception translator registered."); + } + } + + // Boost.Python doesn't support Py_Finalize yet, so don't call it! + return boost::report_errors(); +} diff --git a/example/quickstart/extending.cpp b/example/quickstart/extending.cpp new file mode 100644 index 00000000..a539d3b4 --- /dev/null +++ b/example/quickstart/extending.cpp @@ -0,0 +1,41 @@ +// Copyright Ralf W. Grosse-Kunstleve 2002-2004. 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) + +#include +#include +#include +#include +#include + +namespace { // Avoid cluttering the global namespace. + + // A friendly class. + class hello + { + public: + hello(const std::string& country) { this->country = country; } + std::string greet() const { return "Hello from " + country; } + private: + std::string country; + }; + + // A function taking a hello object as an argument. + std::string invite(const hello& w) { + return w.greet() + "! Please come soon!"; + } +} + +BOOST_PYTHON_MODULE(extending) +{ + using namespace boost::python; + class_("hello", init()) + // Add a regular member function. + .def("greet", &hello::greet) + // Add invite() as a member of hello! + .def("invite", invite) + ; + + // Also add invite() as a regular function to the module. + def("invite", invite); +} diff --git a/example/quickstart/script.py b/example/quickstart/script.py new file mode 100644 index 00000000..5a8faf79 --- /dev/null +++ b/example/quickstart/script.py @@ -0,0 +1,6 @@ +# Copyright Stefan Seefeld 2006. 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) + +print 'Hello World !' +number = 42 diff --git a/example/quickstart/test_extending.py b/example/quickstart/test_extending.py new file mode 100644 index 00000000..14616f7c --- /dev/null +++ b/example/quickstart/test_extending.py @@ -0,0 +1,36 @@ +# Copyright Ralf W. Grosse-Kunstleve 2006. 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) + +# Using the doctest module here to ensure that the results are as expected. +r'''>>> from extending import * + >>> hi = hello('California') + >>> hi.greet() + 'Hello from California' + >>> invite(hi) + 'Hello from California! Please come soon!' + >>> hi.invite() + 'Hello from California! Please come soon!' + + >>> class wordy(hello): + ... def greet(self): + ... return hello.greet(self) + ', where the weather is fine' + ... + >>> hi2 = wordy('Florida') + >>> hi2.greet() + 'Hello from Florida, where the weather is fine' + >>> invite(hi2) + 'Hello from Florida! Please come soon!' +''' + +def run(args = None): + if args is not None: + import sys + sys.argv = args + import doctest, test_extending + return doctest.testmod(test_extending, verbose=True) + +if __name__ == '__main__': + import sys + sys.exit(run()[0]) + diff --git a/include/boost/python/module_init.hpp b/include/boost/python/module_init.hpp index 7770f531..aaf2a0f9 100644 --- a/include/boost/python/module_init.hpp +++ b/include/boost/python/module_init.hpp @@ -26,23 +26,7 @@ extern "C" __declspec(dllexport) void init##name() \ } \ void init_module_##name() -# elif defined(_AIX) && !defined(BOOST_PYTHON_STATIC_MODULE) - -# include -# define BOOST_PYTHON_MODULE_INIT(name) \ -void init_module_##name(); \ -extern "C" \ -{ \ - extern PyObject* _PyImport_LoadDynamicModule(char*, char*, FILE *); \ - void init##name() \ - { \ - boost::python::detail::aix_init_module( \ - _PyImport_LoadDynamicModule, #name, &init_module_##name); \ - } \ -} \ -void init_module_##name() - -# elif BOOST_PYTHON_USE_GCC_SYMBOL_VISIBILITY +# elif BOOST_PYTHON_USE_GCC_SYMBOL_VISIBILITY # define BOOST_PYTHON_MODULE_INIT(name) \ void init_module_##name(); \ @@ -52,7 +36,7 @@ extern "C" __attribute__ ((visibility("default"))) void init##name() \ } \ void init_module_##name() -# else +# else # define BOOST_PYTHON_MODULE_INIT(name) \ void init_module_##name(); \ diff --git a/src/aix_init_module.cpp b/src/aix_init_module.cpp deleted file mode 100644 index 48ccc2c7..00000000 --- a/src/aix_init_module.cpp +++ /dev/null @@ -1,141 +0,0 @@ -// Copyright David Abrahams 2002. -// 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) -#ifdef _AIX -#include -#include - -extern "C" -{ -#include -#include -} - -# include -# include -# include -# include -# include - -namespace boost { namespace python { namespace detail { - -namespace -{ - static PyMethodDef initial_methods[] = { { 0, 0, 0, 0 } }; - extern "C" void initlibboost_python() - { - Py_InitModule("libboost_python", initial_methods); - } - - struct find_and_open_file - { - FILE* fp; - std::string libpath; // -- search path - std::string filename; // -- filename to look for - std::string fullpath; // -- full path to file - - find_and_open_file( - const std::string& libpath_env - , const std::string& file); - }; - - find_and_open_file::find_and_open_file( - const std::string& libpath_env - , const std::string& file) - : fp(0) - { - char* value = std::getenv(libpath_env.c_str()); - - if(value == 0) - return; - - libpath = value; - - if (libpath == "") - return; - - std::string::size_type pos = 0, prev_pos = 0; - - // -- loop through all search paths looking for file - while((pos = libpath.find_first_of(":",pos)) != std::string::npos) - { - fullpath = libpath.substr(prev_pos,pos - prev_pos) + "/" + file; - if (::access(fullpath.c_str(), R_OK) == 0) - { - struct stat filestat; - ::stat(fullpath.c_str(), &filestat); - if (!S_ISDIR(filestat.st_mode)) - { - fp = std::fopen(fullpath.c_str(), "r"); - if (fp) - { - filename = file; - } - return; - } - } - prev_pos = ++pos; - } - - // -- mop up odd path - if (libpath.find_first_of(":", prev_pos) == std::string::npos) - { - fullpath = libpath.substr(prev_pos, libpath.size() - prev_pos) + "/" + file; - if (::access(fullpath.c_str(), R_OK) == 0) - { - struct stat filestat; - ::stat(fullpath.c_str(),&filestat); - if (!S_ISDIR(filestat.st_mode)) - { - fp = std::fopen(fullpath.c_str(), "r"); - filename = file; - } - } - } - } -} - -void aix_init_module( - so_load_function load_dynamic_module - , char const* module_name - , void (*init_module)()) -{ - static bool initialized; - if (!initialized) - { - char const* const name = "libboost_python.so"; - find_and_open_file dynlib("LIBPATH", name); - if (dynlib.fp == 0) - { - fprintf(stderr, " Error: could not find %s\n", name); - return; - } - - std::string::size_type pos = pos = dynlib.filename.rfind(".so"); - if (pos != dynlib.filename.size() - 3) - { - fprintf(stderr, "dynamic library %s must end with .so\n", dynlib.filename.c_str()); - return; - } - - PyObject* m = - load_dynamic_module( - const_cast(dynlib.filename.substr(0,pos).c_str()), - const_cast(dynlib.fullpath.c_str()), - dynlib.fp); - - if (m == 0) - { - fprintf(stderr, "failed to load library %s\n", name); - return; - } - Py_DECREF(m); - - initialized = true; - } - python::detail::init_module(module_name, init_module); -} - -}}} // namespace boost::python -#endif diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index 950b0e7c..4ab785f0 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -35,25 +35,33 @@ rule py-compile-fail ( sources * ) } - -#template py-unit-test -# : -# : $(PYTHON_PROPERTIES) BOOST_PYTHON_SUPPRESS_REGISTRY_INITIALIZATION -# [ difference $(PYTHON_PROPERTIES) : BOOST_PYTHON_DYNAMIC_LIB ] BOOST_PYTHON_STATIC_LIB -# ; - - test-suite python : [ run exec.cpp ../build//boost_python/static $(PY) + : # program args + : exec.py # input files + : # requirements + : # target-name + ] + + [ + run exec.cpp ../build//boost_python/shared /python//python : # program args : exec.py : # requirements - BOOST_PYTHON_STATIC_MODULE + : exec-dynamic # target-name ] +# [ +# run import_.cpp ../build//boost_python /python//python +# : # program args +# : import_.py # input files +# : # requirements +# : # target-name +# ] + [ bpl-test crossmod_exception : crossmod_exception.py crossmod_exception_a.cpp crossmod_exception_b.cpp @@ -85,8 +93,8 @@ bpl-test crossmod_exception [ bpl-test keywords : keywords.cpp keywords_test.py ] -[ python-extension builtin_converters.ext : test_builtin_converters.cpp /boost/python//boost_python ] -[ bpl-test builtin_converters : test_builtin_converters.py builtin_converters.ext ] +[ python-extension builtin_converters_ext : test_builtin_converters.cpp /boost/python//boost_python ] +[ bpl-test builtin_converters : test_builtin_converters.py builtin_converters_ext ] [ bpl-test test_pointer_adoption ] [ bpl-test operators ] @@ -154,7 +162,7 @@ bpl-test crossmod_opaque # Whenever the cause for the failure of the polymorphism test is found # and fixed, this should be retested. hp_cxx:no ] - + [ python-extension map_indexing_suite_ext : map_indexing_suite.cpp int_map_indexing_suite.cpp a_map_indexing_suite.cpp /boost/python//boost_python ] diff --git a/test/args.cpp b/test/args.cpp index 38796057..238a471e 100644 --- a/test/args.cpp +++ b/test/args.cpp @@ -90,6 +90,7 @@ BOOST_PYTHON_MODULE(args_ext) .def("f1", &X::f, X_f_overloads(args("self", "x", "y", "z"))) .def("f2", &X::f, X_f_overloads(args("self", "x", "y", "z"), "f2's docstring")) + .def("f2", &X::f, X_f_overloads(args("x", "y", "z"), "f2's docstring")) ; def("inner", &X::inner, "docstring", args("self", "n"), return_internal_reference<>()); diff --git a/test/import_.cpp b/test/import_.cpp index ea4ff8c6..3e21de0b 100644 --- a/test/import_.cpp +++ b/test/import_.cpp @@ -9,7 +9,6 @@ #include #include #include -#include namespace bpl = boost::python; diff --git a/test/select_from_python_test.cpp b/test/select_from_python_test.cpp index e8333902..bb60962a 100644 --- a/test/select_from_python_test.cpp +++ b/test/select_from_python_test.cpp @@ -5,9 +5,10 @@ #include #include -// gcc 2.95.x and MIPSpro 7.3.1.3 linker seem to demand this definition -#if ((defined(__GNUC__) && __GNUC__ < 3)) \ - || (defined(__sgi) && defined(__EDG_VERSION__) && (__EDG_VERSION__ == 238)) +// gcc 2.95.x, MIPSpro 7.3.1.3 and IBM XL for Linux linker seem to demand this definition +#if (defined(__GNUC__) && (__GNUC__ < 3)) \ + || (defined(__sgi) && defined(__EDG_VERSION__) && (__EDG_VERSION__ == 238)) \ + || (defined(__IBMCPP__) && defined(__linux__)) namespace boost { namespace python { BOOST_PYTHON_DECL bool handle_exception_impl(function0) { diff --git a/test/test_builtin_converters.cpp b/test/test_builtin_converters.cpp index 2b20b719..daefe561 100644 --- a/test/test_builtin_converters.cpp +++ b/test/test_builtin_converters.cpp @@ -57,7 +57,7 @@ char const* rewrap_value_mutable_cstring(char* x) { return x; } object identity_(object x) { return x; } -BOOST_PYTHON_MODULE(builtin_converters) +BOOST_PYTHON_MODULE(builtin_converters_ext) { def("get_type", get_type); def("return_null_handle", return_null_handle); diff --git a/test/test_builtin_converters.py b/test/test_builtin_converters.py index 9dbbdc84..3bfce5b8 100644 --- a/test/test_builtin_converters.py +++ b/test/test_builtin_converters.py @@ -2,7 +2,7 @@ # Software License, Version 1.0. (See accompanying # file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) r""" ->>> from builtin_converters import * +>>> from builtin_converters_ext import * # Synthesize idendity functions in case long long not supported >>> if not 'rewrap_value_long_long' in dir(): @@ -250,9 +250,9 @@ Check that classic classes also work def run(args = None): import sys import doctest - import builtin_converters + import builtin_converters_ext - if 'rewrap_value_long_long' in dir(builtin_converters): + if 'rewrap_value_long_long' in dir(builtin_converters_ext): print 'LONG_LONG supported, testing...' else: print 'LONG_LONG not supported, skipping those tests...'