mirror of
https://github.com/boostorg/python.git
synced 2026-01-20 16:52:15 +00:00
80 lines
4.2 KiB
HTML
80 lines
4.2 KiB
HTML
<html>
|
|
<head>
|
|
<!-- Generated by the Spirit (http://spirit.sf.net) QuickDoc -->
|
|
<title>QuickStart</title>
|
|
<link rel="stylesheet" href="theme/style.css" type="text/css">
|
|
<link rel="next" href="building_hello_world.html">
|
|
</head>
|
|
<body>
|
|
<table width="100%" height="48" border="0" cellspacing="2">
|
|
<tr>
|
|
<td><img src="theme/c%2B%2Bboost.gif">
|
|
</td>
|
|
<td width="85%">
|
|
<font size="6" face="Verdana, Arial, Helvetica, sans-serif"><b>QuickStart</b></font>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
<table border="0">
|
|
<tr>
|
|
<td width="30"><a href="../index.html"><img src="theme/u_arr.gif" border="0"></a></td>
|
|
<td width="30"><img src="theme/l_arr_disabled.gif" border="0"></td>
|
|
<td width="20"><a href="building_hello_world.html"><img src="theme/r_arr.gif" border="0"></a></td>
|
|
</tr>
|
|
</table>
|
|
<p>
|
|
The Boost Python Library is a framework for interfacing Python and
|
|
C++. It allows you to quickly and seamlessly expose C++ classes
|
|
functions and objects to Python, and vice-versa, using no special
|
|
tools -- just your C++ compiler. It is designed to wrap C++ interfaces
|
|
non-intrusively, so that you should not have to change the C++ code at
|
|
all in order to wrap it, making Boost.Python ideal for exposing
|
|
3rd-party libraries to Python. The library's use of advanced
|
|
metaprogramming techniques simplifies its syntax for users, so that
|
|
wrapping code takes on the look of a kind of declarative interface
|
|
definition language (IDL).</p>
|
|
<a name="hello_world"></a><h2>Hello World</h2><p>
|
|
Following C/C++ tradition, let's start with the "hello, world". A C++
|
|
Function:</p>
|
|
<code><pre>
|
|
<span class=keyword>char </span><span class=keyword>const</span><span class=special>* </span><span class=identifier>greet</span><span class=special>()
|
|
{
|
|
</span><span class=keyword>return </span><span class=string>"hello, world"</span><span class=special>;
|
|
}
|
|
</span></pre></code>
|
|
<p>
|
|
can be exposed to Python by writing a Boost.Python wrapper:</p>
|
|
<code><pre>
|
|
<span class=preprocessor>#include </span><span class=special><</span><span class=identifier>boost</span><span class=special>/</span><span class=identifier>python</span><span class=special>.</span><span class=identifier>hpp</span><span class=special>>
|
|
</span><span class=keyword>using </span><span class=keyword>namespace </span><span class=identifier>boost</span><span class=special>::</span><span class=identifier>python</span><span class=special>;
|
|
|
|
</span><span class=identifier>BOOST_PYTHON_MODULE</span><span class=special>(</span><span class=identifier>hello</span><span class=special>)
|
|
{
|
|
</span><span class=identifier>def</span><span class=special>(</span><span class=string>"greet"</span><span class=special>, </span><span class=identifier>greet</span><span class=special>);
|
|
}
|
|
</span></pre></code>
|
|
<p>
|
|
That's it. We're done. We can now build this as a shared library. The
|
|
resulting DLL is now visible to Python. Here's a sample Python session:</p>
|
|
<code><pre>
|
|
<span class=special>>>> </span><span class=identifier>import </span><span class=identifier>hello
|
|
</span><span class=special>>>> </span><span class=identifier>print </span><span class=identifier>hello</span><span class=special>.</span><span class=identifier>greet</span><span class=special>()
|
|
</span><span class=identifier>hello</span><span class=special>, </span><span class=identifier>world
|
|
</span></pre></code>
|
|
<blockquote><p><i><b>Next stop... Building your Hello World module from start to finish...</b></i></p></blockquote><table border="0">
|
|
<tr>
|
|
<td width="30"><a href="../index.html"><img src="theme/u_arr.gif" border="0"></a></td>
|
|
<td width="30"><img src="theme/l_arr_disabled.gif" border="0"></td>
|
|
<td width="20"><a href="building_hello_world.html"><img src="theme/r_arr.gif" border="0"></a></td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
<hr size="1"><p class="copyright">Copyright © 2002-2003 David Abrahams<br>Copyright © 2002-2003 Joel de Guzman<br><br>
|
|
<font size="2">Permission to copy, use, modify, sell and distribute this document
|
|
is granted provided this copyright notice appears in all copies. This document
|
|
is provided "as is" without express or implied warranty, and with
|
|
no claim as to its suitability for any purpose. </font> </p>
|
|
</body>
|
|
</html>
|