<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>32.10. py_compile — Compile Python source files — Python v2.6.5 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.6.5',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Python v2.6.5 documentation"
href="../_static/opensearch.xml"/>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
<link rel="top" title="Python v2.6.5 documentation" href="../index.html" />
<link rel="up" title="32. Python Language Services" href="language.html" />
<link rel="next" title="32.11. compileall — Byte-compile Python libraries" href="compileall.html" />
<link rel="prev" title="32.9. pyclbr — Python class browser support" href="pyclbr.html" />
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
</head>
<body>
<div class="related">
<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="../modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="compileall.html" title="32.11. compileall — Byte-compile Python libraries"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="pyclbr.html" title="32.9. pyclbr — Python class browser support"
accesskey="P">previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="../index.html">Python v2.6.5 documentation</a> »</li>
<li><a href="index.html" >The Python Standard Library</a> »</li>
<li><a href="language.html" accesskey="U">32. Python Language Services</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-py_compile">
<h1>32.10. <tt class="xref docutils literal"><span class="pre">py_compile</span></tt> — Compile Python source files<a class="headerlink" href="#module-py_compile" title="Permalink to this headline">¶</a></h1>
<p id="index-509">The <tt class="xref docutils literal"><span class="pre">py_compile</span></tt> module provides a function to generate a byte-code file
from a source file, and another function used when the module source file is
invoked as a script.</p>
<p>Though not often needed, this function can be useful when installing modules for
shared use, especially if some of the users may not have permission to write the
byte-code cache files in the directory containing the source code.</p>
<dl class="exception">
<dt id="py_compile.PyCompileError">
<em class="property">exception </em><tt class="descclassname">py_compile.</tt><tt class="descname">PyCompileError</tt><a class="headerlink" href="#py_compile.PyCompileError" title="Permalink to this definition">¶</a></dt>
<dd>Exception raised when an error occurs while attempting to compile the file.</dd></dl>
<dl class="function">
<dt id="py_compile.compile">
<tt class="descclassname">py_compile.</tt><tt class="descname">compile</tt><big>(</big><em>file</em><span class="optional">[</span>, <em>cfile</em><span class="optional">[</span>, <em>dfile</em><span class="optional">[</span>, <em>doraise</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#py_compile.compile" title="Permalink to this definition">¶</a></dt>
<dd>Compile a source file to byte-code and write out the byte-code cache file. The
source code is loaded from the file name <em>file</em>. The byte-code is written to
<em>cfile</em>, which defaults to <em>file</em> <tt class="docutils literal"><span class="pre">+</span></tt> <tt class="docutils literal"><span class="pre">'c'</span></tt> (<tt class="docutils literal"><span class="pre">'o'</span></tt> if optimization is
enabled in the current interpreter). If <em>dfile</em> is specified, it is used as the
name of the source file in error messages instead of <em>file</em>. If <em>doraise</em> is
true, a <a title="py_compile.PyCompileError" class="reference internal" href="#py_compile.PyCompileError"><tt class="xref docutils literal"><span class="pre">PyCompileError</span></tt></a> is raised when an error is encountered while
compiling <em>file</em>. If <em>doraise</em> is false (the default), an error string is
written to <tt class="docutils literal"><span class="pre">sys.stderr</span></tt>, but no exception is raised.</dd></dl>
<dl class="function">
<dt id="py_compile.main">
<tt class="descclassname">py_compile.</tt><tt class="descname">main</tt><big>(</big><span class="optional">[</span><em>args</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#py_compile.main" title="Permalink to this definition">¶</a></dt>
<dd>Compile several source files. The files named in <em>args</em> (or on the command
line, if <em>args</em> is not specified) are compiled and the resulting bytecode is
cached in the normal manner. This function does not search a directory
structure to locate source files; it only compiles files named explicitly.</dd></dl>
<p>When this module is run as a script, the <a title="py_compile.main" class="reference internal" href="#py_compile.main"><tt class="xref docutils literal"><span class="pre">main()</span></tt></a> is used to compile all the
files named on the command line. The exit status is nonzero if one of the files
could not be compiled.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.6: </span>Added the nonzero exit status when module is run as a script.</p>
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt>Module <a title="Tools for byte-compiling all Python source files in a directory tree." class="reference external" href="compileall.html#module-compileall"><tt class="xref docutils literal"><span class="pre">compileall</span></tt></a></dt>
<dd>Utilities to compile all Python source files in a directory tree.</dd>
</dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="pyclbr.html"
title="previous chapter">32.9. <tt class="docutils literal"><span class="pre">pyclbr</span></tt> — Python class browser support</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="compileall.html"
title="next chapter">32.11. <tt class="docutils literal docutils literal docutils literal"><span class="pre">compileall</span></tt> — Byte-compile Python libraries</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/library/py_compile.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<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="../modindex.html" title="Global Module Index"
>modules</a> |</li>
<li class="right" >
<a href="compileall.html" title="32.11. compileall — Byte-compile Python libraries"
>next</a> |</li>
<li class="right" >
<a href="pyclbr.html" title="32.9. pyclbr — Python class browser support"
>previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="../index.html">Python v2.6.5 documentation</a> »</li>
<li><a href="index.html" >The Python Standard Library</a> »</li>
<li><a href="language.html" >32. Python Language Services</a> »</li>
</ul>
</div>
<div class="footer">
© <a href="../copyright.html">Copyright</a> 1990-2010, Python Software Foundation.
<br />
The Python Software Foundation is a non-profit corporation.
<a href="http://www.python.org/psf/donations/">Please donate.</a>
<br />
Last updated on Mar 19, 2010.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.5.
</div>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
8f1462e52e1797a02c97073eed0b7f92
>
files
>
851
