Gecko [ v99win.today ]

Name	Size	Permission
building.html	20.35 KB	-rw-r--r--
embedding.html	32.19 KB	-rw-r--r--
extending.html	127.76 KB	-rw-r--r--
index.html	12.51 KB	-rw-r--r--
newtypes.html	199.58 KB	-rw-r--r--
windows.html	18.64 KB	-rw-r--r--

Code Editor : building.html

<!DOCTYPE html>

<title>3. Building C and C++ Extensions with distutils &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="4. Building C and C++ Extensions on Windows" href="windows.html" />
 <link rel="prev" title="2. Defining New Types" href="newtypes.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/extending/building.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/extending/building.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="windows.html" title="4. Building C and C++ Extensions on Windows"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="newtypes.html" title="2. Defining New Types"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Extending and Embedding the Python Interpreter</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">3. Building C and C++ Extensions with distutils</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="building-c-and-c-extensions-with-distutils">
<h1>3. Building C and C++ Extensions with distutils<a class="headerlink" href="#building-c-and-c-extensions-with-distutils" title="Permalink to this headline">¶</a></h1>
Starting in Python 1.4, Python provides, on Unix, a special make file for
building make files for building dynamically-linked extensions and custom
interpreters. Starting with Python 2.0, this mechanism (known as related to
Makefile.pre.in, and Setup files) is no longer supported. Building custom
interpreters was rarely used, and extension modules can be built using
distutils.
Building an extension module using distutils requires that distutils is
installed on the build machine, which is included in Python 2.x and available
separately for Python 1.5. Since distutils also supports creation of binary
packages, users don’t necessarily need a compiler and distutils to install the
extension.
A distutils package contains a driver script, <code class="file docutils literal notranslate">setup.py</code>. This is a plain
Python file, which, in the most simple case, could look like this:
<div class="highlight-python notranslate"><div class="highlight"><pre>from distutils.core import setup, Extension

setup (name = &#39;PackageName&#39;,
 version = &#39;1.0&#39;,
 description = &#39;This is a demo package&#39;,
 ext_modules = [module1])
</pre></div>
</div>
With this <code class="file docutils literal notranslate">setup.py</code>, and a file <code class="file docutils literal notranslate">demo.c</code>, running
<div class="highlight-default notranslate"><div class="highlight"><pre>python setup.py build
</pre></div>
</div>
will compile <code class="file docutils literal notranslate">demo.c</code>, and produce an extension module named <code class="docutils literal notranslate">demo</code> in
the <code class="file docutils literal notranslate">build</code> directory. Depending on the system, the module file will end
up in a subdirectory <code class="file docutils literal notranslate">build/lib.system</code>, and may have a name like
<code class="file docutils literal notranslate">demo.so</code> or <code class="file docutils literal notranslate">demo.pyd</code>.
In the <code class="file docutils literal notranslate">setup.py</code>, all execution is performed by calling the <code class="docutils literal notranslate">setup</code>
function. This takes a variable number of keyword arguments, of which the
example above uses only a subset. Specifically, the example specifies
meta-information to build packages, and it specifies the contents of the
package. Normally, a package will contain of addition modules, like Python
source modules, documentation, subpackages, etc. Please refer to the distutils
documentation in <a class="reference internal" href="../distutils/index.html#distutils-index">Distributing Python Modules (Legacy version)</a> to learn more about the features of
distutils; this section explains building extension modules only.
It is common to pre-compute arguments to <code class="xref py py-func docutils literal notranslate">setup()</code>, to better structure the
driver script. In the example above, the <code class="docutils literal notranslate">ext_modules</code> argument to
<code class="xref py py-func docutils literal notranslate">setup()</code> is a list of extension modules, each of which is an instance of
the <code class="xref py py-class docutils literal notranslate">Extension</code>. In the example, the instance
defines an extension named <code class="docutils literal notranslate">demo</code> which is build by compiling a single source
file, <code class="file docutils literal notranslate">demo.c</code>.
In many cases, building an extension is more complex, since additional
preprocessor defines and libraries may be needed. This is demonstrated in the
example below.
<div class="highlight-python notranslate"><div class="highlight"><pre>from distutils.core import setup, Extension

module1 = Extension(&#39;demo&#39;,
 define_macros = [(&#39;MAJOR_VERSION&#39;, &#39;1&#39;),
 (&#39;MINOR_VERSION&#39;, &#39;0&#39;)],
 include_dirs = [&#39;/usr/local/include&#39;],
 libraries = [&#39;tcl83&#39;],
 library_dirs = [&#39;/usr/local/lib&#39;],
 sources = [&#39;demo.c&#39;])

setup (name = &#39;PackageName&#39;,
 version = &#39;1.0&#39;,
 description = &#39;This is a demo package&#39;,
 author = &#39;Martin v. Loewis&#39;,
 author_email = &#39;martin@v.loewis.de&#39;,
 url = &#39;https://docs.python.org/extending/building&#39;,
 long_description = &#39;&#39;&#39;
This is really just a demo package.
&#39;&#39;&#39;,
 ext_modules = [module1])
</pre></div>
</div>
In this example, <code class="xref py py-func docutils literal notranslate">setup()</code> is called with additional meta-information, which
is recommended when distribution packages have to be built. For the extension
itself, it specifies preprocessor defines, include directories, library
directories, and libraries. Depending on the compiler, distutils passes this
information in different ways to the compiler. For example, on Unix, this may
result in the compilation commands
<div class="highlight-default notranslate"><div class="highlight"><pre>gcc -DNDEBUG -g -O3 -Wall -Wstrict-prototypes -fPIC -DMAJOR_VERSION=1 -DMINOR_VERSION=0 -I/usr/local/include -I/usr/local/include/python2.2 -c demo.c -o build/temp.linux-i686-2.2/demo.o

gcc -shared build/temp.linux-i686-2.2/demo.o -L/usr/local/lib -ltcl83 -o build/lib.linux-i686-2.2/demo.so
</pre></div>
</div>
These lines are for demonstration purposes only; distutils users should trust
that distutils gets the invocations right.
<section id="distributing-your-extension-modules">
<h2>3.1. Distributing your extension modules<a class="headerlink" href="#distributing-your-extension-modules" title="Permalink to this headline">¶</a></h2>
When an extension has been successfully build, there are three ways to use it.
End-users will typically want to install the module, they do so by running
<div class="highlight-default notranslate"><div class="highlight"><pre>python setup.py install
</pre></div>
</div>
Module maintainers should produce source packages; to do so, they run
<div class="highlight-default notranslate"><div class="highlight"><pre>python setup.py sdist
</pre></div>
</div>
In some cases, additional files need to be included in a source distribution;
this is done through a <code class="file docutils literal notranslate">MANIFEST.in</code> file; see the distutils documentation
for details.
If the source distribution has been build successfully, maintainers can also
create binary distributions. Depending on the platform, one of the following
commands can be used to do so.
<div class="highlight-default notranslate"><div class="highlight"><pre>python setup.py bdist_wininst
python setup.py bdist_rpm
python setup.py bdist_dumb
</pre></div>
</div>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">3. Building C and C++ Extensions with distutils</a><ul>
<li><a class="reference internal" href="#distributing-your-extension-modules">3.1. Distributing your extension modules</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="newtypes.html"
 title="previous chapter">2. Defining New Types</a>
 <h4>Next topic</h4>
 <a href="windows.html"
 title="next chapter">4. Building C and C++ Extensions on Windows</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/extending/building.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="windows.html" title="4. Building C and C++ Extensions on Windows"
 >next</a> |</li>
 <li class="right" >
 <a href="newtypes.html" title="2. Defining New Types"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >Extending and Embedding the Python Interpreter</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">3. Building C and C++ Extensions with distutils</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on December 09, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : building.html