PyCC Documentation — PyCC 1.0.0 documentation

<!DOCTYPE html>   <html class="no-js" lang="en" >  <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyCC Documentation — PyCC 1.0.0 documentation</title> <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> <link rel="stylesheet" href="https://media.readthedocs.org/css/sphinx_rtd_theme.css" type="text/css" /> <link rel="stylesheet" href="https://media.readthedocs.org/css/readthedocs-doc-embed.css" type="text/css" /> <link rel="top" title="PyCC 1.0.0 documentation" href="#"/> <link rel="next" title="PyCC Usage Documentation" href="usage.html"/>   <link rel="canonical" href="http://pycc.readthedocs.org/en/latest/" /> <script type="text/javascript"> // This is included here because other places don't have access to the pagename variable. var READTHEDOCS_DATA = { project: "pycc", version: "latest", language: "en", page: "index", builder: "sphinx", theme: "sphinx_rtd_theme", docroot: "/docs/", source_suffix: ".rst", api_host: "https://readthedocs.org", commit: "69ba99d78a859ba61c2ce7ee35766e21c789db21" } // Old variables var doc_version = "latest"; var doc_slug = "pycc"; var page_name = "index"; var html_theme = "sphinx_rtd_theme"; </script>   <script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-17997319-1']); _gaq.push(['_trackPageview']); // User Analytics Code _gaq.push(['user._setAccount', 'None']); _gaq.push(['user._trackPageview']); // End User Analytics Code (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script>   <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script> <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="pycc" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/" /><meta name="readthedocs-http-status" content="200" /></head> <body class="wy-body-for-nav" role="document"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-nav-search"> <a href="#" class="fa fa-home"> PyCC</a> <div role="search"> <form id ="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <ul> <li class="toctree-l1"><a class="reference internal" href="usage.html">PyCC Usage Documentation</a><ul> <li class="toctree-l2"><a class="reference internal" href="usage.html#transforming-code">Transforming Code</a></li> <li class="toctree-l2"><a class="reference internal" href="usage.html#compiling-code">Compiling Code</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="optimizers.html">PyCC Optimizer Documentation</a><ul> <li class="toctree-l2"><a class="reference internal" href="optimizers.html#constant-in-lining">Constant In-lining</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="development.html">PyCC Developer Documentation</a><ul> <li class="toctree-l2"><a class="reference internal" href="development.html#contributing-to-the-project">Contributing To The Project</a></li> <li class="toctree-l2"><a class="reference internal" href="development.html#ast-tools">AST Tools</a></li> <li class="toctree-l2"><a class="reference internal" href="development.html#developing-third-party-extensions">Developing Third Party Extensions</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="api/modules.html">Auto-generated API Docs</a><ul> <li class="toctree-l2"><a class="reference internal" href="api/pycc.html">pycc package</a></li> </ul> </li> </ul> </div>   </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="#">PyCC</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> <li><a href="#">Docs</a> »</li> <li>PyCC Documentation</li> <li class="wy-breadcrumbs-aside"> <a href="https://github.com/kevinconway/pycc/blob/master/docs/index.rst" class="fa fa-github"> Edit on GitHub</a> </li> </ul> <hr/> </div> <div role="main" class="document"> <div class="section" id="pycc-documentation"> <h1>PyCC Documentation<a class="headerlink" href="#pycc-documentation" title="Permalink to this headline">露</a></h1> <p>PyCC is a Python code optimizer. It rewrites your code to make it faster.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="usage.html">PyCC Usage Documentation</a><ul> <li class="toctree-l2"><a class="reference internal" href="usage.html#transforming-code">Transforming Code</a></li> <li class="toctree-l2"><a class="reference internal" href="usage.html#compiling-code">Compiling Code</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="optimizers.html">PyCC Optimizer Documentation</a><ul> <li class="toctree-l2"><a class="reference internal" href="optimizers.html#constant-in-lining">Constant In-lining</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="development.html">PyCC Developer Documentation</a><ul> <li class="toctree-l2"><a class="reference internal" href="development.html#contributing-to-the-project">Contributing To The Project</a></li> <li class="toctree-l2"><a class="reference internal" href="development.html#ast-tools">AST Tools</a></li> <li class="toctree-l2"><a class="reference internal" href="development.html#developing-third-party-extensions">Developing Third Party Extensions</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="api/modules.html">Auto-generated API Docs</a><ul> <li class="toctree-l2"><a class="reference internal" href="api/pycc.html">pycc package</a></li> </ul> </li> </ul> </div> <div class="section" id="basic-example"> <h2>Basic Example<a class="headerlink" href="#basic-example" title="Permalink to this headline">露</a></h2> <p>Symbol table (variable) lookups don’t seem expensive at first.</p> <div class="highlight-python"><div class="highlight"><pre><span class="c"># awesome_module.py</span> <span class="n">MAGIC_NUMBER</span> <span class="o">=</span> <span class="mi">7</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="mi">10000000</span><span class="p">):</span> <span class="n">MAGIC_NUMBER</span> <span class="o">*</span> <span class="n">MAGIC_NUMBER</span> </pre></div> </div> <p>Now let’s make a crude benchmark.</p> <div class="highlight-bash"><div class="highlight"><pre><span class="c"># Generate bytecode file to skip compilation at runtime.</span> python -m compileall awesome_module.py <span class="c"># Now get a simple timer.</span> <span class="nb">time </span>python awesome_module.pyc <span class="c"># real 0m0.923s</span> <span class="c"># user 0m0.920s</span> <span class="c"># sys 0m0.004s</span> </pre></div> </div> <p>What does PyCC have to say about it?</p> <div class="highlight-bash"><div class="highlight"><pre>pycc-transform awesome_module.py --constants </pre></div> </div> <div class="highlight-python"><div class="highlight"><pre><span class="n">MAGIC_NUMBER</span> <span class="o">=</span> <span class="mi">7</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="mi">10000000</span><span class="p">):</span> <span class="p">(</span><span class="mi">7</span> <span class="o">*</span> <span class="mi">7</span><span class="p">)</span> </pre></div> </div> <p>Neat, but what good does that do?</p> <div class="highlight-bash"><div class="highlight"><pre>pycc-compile awesome_module.py -- constants <span class="nb">time </span>python awesome_module.pyc <span class="c"># real 0m0.473s</span> <span class="c"># user 0m0.469s</span> <span class="c"># sys 0m0.004s</span> </pre></div> </div> </div> <div class="section" id="how-to-get-it"> <h2>How To Get It<a class="headerlink" href="#how-to-get-it" title="Permalink to this headline">露</a></h2> <div class="highlight-bash"><div class="highlight"><pre>pip install pycc </pre></div> </div> </div> <div class="section" id="source"> <h2>Source?<a class="headerlink" href="#source" title="Permalink to this headline">露</a></h2> <p>If you want to file a bug, request an optimization, contribute a patch, or just read through the source then head over to the <a class="reference external" href="https://github.com/kevinconway/pycc">GitHub page</a>.</p> </div> <div class="section" id="license"> <h2>License<a class="headerlink" href="#license" title="Permalink to this headline">露</a></h2> <p>The project is licensed under the Apache 2 license.</p> </div> <div class="section" id="indices-and-tables"> <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">露</a></h2> <ul class="simple"> <li><a class="reference internal" href="genindex.html"><em>Index</em></a></li> <li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li> <li><a class="reference internal" href="search.html"><em>Search Page</em></a></li> </ul> </div> </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="usage.html" class="btn btn-neutral float-right" title="PyCC Usage Documentation">Next <span class="fa fa-arrow-circle-right"></span></a> </div> <hr/> <div role="contentinfo"> <p> © Copyright 2014, Kevin Conway. </p> </div> Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'1.0.0', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="https://media.readthedocs.org/javascript/jquery/jquery-2.0.3.min.js"></script> <script type="text/javascript" src="https://media.readthedocs.org/javascript/jquery/jquery-migrate-1.2.1.min.js"></script> <script type="text/javascript" src="https://media.readthedocs.org/javascript/underscore.js"></script> <script type="text/javascript" src="https://media.readthedocs.org/javascript/doctools.js"></script> <script type="text/javascript" src="https://media.readthedocs.org/javascript/readthedocs-doc-embed.js"></script> <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.StickyNav.enable(); }); </script> </body> </html>

CINXE.COM

PyCC Documentation — PyCC 1.0.0 documentation