<!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>horizon.openstack.common.setup — Horizon 2012.2.3 documentation</title>
<link rel="stylesheet" href="../../../../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/tweaks.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../../',
VERSION: '2012.2.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../../_static/jquery.tweet.js"></script>
<link rel="top" title="Horizon 2012.2.3 documentation" href="../../../../index.html" />
<link rel="up" title="horizon" href="../../../horizon.html" />
</head>
<body>
<div id="header">
<h1 id="logo"><a href="http://www.openstack.org/">OpenStack</a></h1>
<ul id="navigation">
<li><a href="http://www.openstack.org/" title="Go to the Home page" class="link">Home</a></li>
<li><a href="http://www.openstack.org/projects/" title="Go to the OpenStack Projects page">Projects</a></li>
<li><a href="http://www.openstack.org/user-stories/" title="Go to the User Stories page" class="link">User Stories</a></li>
<li><a href="http://www.openstack.org/community/" title="Go to the Community page" class="link">Community</a></li>
<li><a href="http://www.openstack.org/blog/" title="Go to the OpenStack Blog">Blog</a></li>
<li><a href="http://wiki.openstack.org/" title="Go to the OpenStack Wiki">Wiki</a></li>
<li><a href="http://docs.openstack.org/" title="Go to OpenStack Documentation" class="current">Documentation</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for horizon.openstack.common.setup</h1><div class="highlight"><pre>
<span class="c"># vim: tabstop=4 shiftwidth=4 softtabstop=4</span>
<span class="c"># Copyright 2011 OpenStack LLC.</span>
<span class="c"># All Rights Reserved.</span>
<span class="c">#</span>
<span class="c"># Licensed under the Apache License, Version 2.0 (the "License"); you may</span>
<span class="c"># not use this file except in compliance with the License. You may obtain</span>
<span class="c"># a copy of the License at</span>
<span class="c">#</span>
<span class="c"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c">#</span>
<span class="c"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c"># distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</span>
<span class="c"># WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the</span>
<span class="c"># License for the specific language governing permissions and limitations</span>
<span class="c"># under the License.</span>
<span class="sd">"""</span>
<span class="sd">Utilities with minimum-depends for use in setup.py</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">subprocess</span>
<span class="kn">from</span> <span class="nn">setuptools.command</span> <span class="kn">import</span> <span class="n">sdist</span>
<div class="viewcode-block" id="parse_mailmap"><a class="viewcode-back" href="../../../../sourcecode/horizon/horizon.openstack.common.setup.html#horizon.openstack.common.setup.parse_mailmap">[docs]</a><span class="k">def</span> <span class="nf">parse_mailmap</span><span class="p">(</span><span class="n">mailmap</span><span class="o">=</span><span class="s">'.mailmap'</span><span class="p">):</span>
<span class="n">mapping</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">mailmap</span><span class="p">):</span>
<span class="n">fp</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">mailmap</span><span class="p">,</span> <span class="s">'r'</span><span class="p">)</span>
<span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">fp</span><span class="p">:</span>
<span class="n">l</span> <span class="o">=</span> <span class="n">l</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">l</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">'#'</span><span class="p">)</span> <span class="ow">and</span> <span class="s">' '</span> <span class="ow">in</span> <span class="n">l</span><span class="p">:</span>
<span class="n">canonical_email</span><span class="p">,</span> <span class="n">alias</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">l</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">' '</span><span class="p">)</span>
<span class="k">if</span> <span class="n">x</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">'<'</span><span class="p">)]</span>
<span class="n">mapping</span><span class="p">[</span><span class="n">alias</span><span class="p">]</span> <span class="o">=</span> <span class="n">canonical_email</span>
<span class="k">return</span> <span class="n">mapping</span>
</div>
<div class="viewcode-block" id="canonicalize_emails"><a class="viewcode-back" href="../../../../sourcecode/horizon/horizon.openstack.common.setup.html#horizon.openstack.common.setup.canonicalize_emails">[docs]</a><span class="k">def</span> <span class="nf">canonicalize_emails</span><span class="p">(</span><span class="n">changelog</span><span class="p">,</span> <span class="n">mapping</span><span class="p">):</span>
<span class="sd">"""Takes in a string and an email alias mapping and replaces all</span>
<span class="sd"> instances of the aliases in the string with their real email.</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="n">alias</span><span class="p">,</span> <span class="n">email</span> <span class="ow">in</span> <span class="n">mapping</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
<span class="n">changelog</span> <span class="o">=</span> <span class="n">changelog</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">alias</span><span class="p">,</span> <span class="n">email</span><span class="p">)</span>
<span class="k">return</span> <span class="n">changelog</span>
<span class="c"># Get requirements from the first file that exists</span></div>
<div class="viewcode-block" id="get_reqs_from_files"><a class="viewcode-back" href="../../../../sourcecode/horizon/horizon.openstack.common.setup.html#horizon.openstack.common.setup.get_reqs_from_files">[docs]</a><span class="k">def</span> <span class="nf">get_reqs_from_files</span><span class="p">(</span><span class="n">requirements_files</span><span class="p">):</span>
<span class="n">reqs_in</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">requirements_file</span> <span class="ow">in</span> <span class="n">requirements_files</span><span class="p">:</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">requirements_file</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">open</span><span class="p">(</span><span class="n">requirements_file</span><span class="p">,</span> <span class="s">'r'</span><span class="p">)</span><span class="o">.</span><span class="n">read</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'</span><span class="se">\n</span><span class="s">'</span><span class="p">)</span>
<span class="k">return</span> <span class="p">[]</span>
</div>
<div class="viewcode-block" id="parse_requirements"><a class="viewcode-back" href="../../../../sourcecode/horizon/horizon.openstack.common.setup.html#horizon.openstack.common.setup.parse_requirements">[docs]</a><span class="k">def</span> <span class="nf">parse_requirements</span><span class="p">(</span><span class="n">requirements_files</span><span class="o">=</span><span class="p">[</span><span class="s">'requirements.txt'</span><span class="p">,</span>
<span class="s">'tools/pip-requires'</span><span class="p">]):</span>
<span class="n">requirements</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">get_reqs_from_files</span><span class="p">(</span><span class="n">requirements_files</span><span class="p">):</span>
<span class="c"># For the requirements list, we need to inject only the portion</span>
<span class="c"># after egg= so that distutils knows the package it's looking for</span>
<span class="c"># such as:</span>
<span class="c"># -e git://github.com/openstack/nova/master#egg=nova</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">r'\s*-e\s+'</span><span class="p">,</span> <span class="n">line</span><span class="p">):</span>
<span class="n">requirements</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s">r'\s*-e\s+.*#egg=(.*)$'</span><span class="p">,</span> <span class="s">r'\1'</span><span class="p">,</span>
<span class="n">line</span><span class="p">))</span>
<span class="c"># such as:</span>
<span class="c"># http://github.com/openstack/nova/zipball/master#egg=nova</span>
<span class="k">elif</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">r'\s*https?:'</span><span class="p">,</span> <span class="n">line</span><span class="p">):</span>
<span class="n">requirements</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s">r'\s*https?:.*#egg=(.*)$'</span><span class="p">,</span> <span class="s">r'\1'</span><span class="p">,</span>
<span class="n">line</span><span class="p">))</span>
<span class="c"># -f lines are for index locations, and don't get used here</span>
<span class="k">elif</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">r'\s*-f\s+'</span><span class="p">,</span> <span class="n">line</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">requirements</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="k">return</span> <span class="n">requirements</span>
</div>
<div class="viewcode-block" id="parse_dependency_links"><a class="viewcode-back" href="../../../../sourcecode/horizon/horizon.openstack.common.setup.html#horizon.openstack.common.setup.parse_dependency_links">[docs]</a><span class="k">def</span> <span class="nf">parse_dependency_links</span><span class="p">(</span><span class="n">requirements_files</span><span class="o">=</span><span class="p">[</span><span class="s">'requirements.txt'</span><span class="p">,</span>
<span class="s">'tools/pip-requires'</span><span class="p">]):</span>
<span class="n">dependency_links</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c"># dependency_links inject alternate locations to find packages listed</span>
<span class="c"># in requirements</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">get_reqs_from_files</span><span class="p">(</span><span class="n">requirements_files</span><span class="p">):</span>
<span class="c"># skip comments and blank lines</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">r'(\s*#)|(\s*$)'</span><span class="p">,</span> <span class="n">line</span><span class="p">):</span>
<span class="k">continue</span>
<span class="c"># lines with -e or -f need the whole line, minus the flag</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">r'\s*-[ef]\s+'</span><span class="p">,</span> <span class="n">line</span><span class="p">):</span>
<span class="n">dependency_links</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s">r'\s*-[ef]\s+'</span><span class="p">,</span> <span class="s">''</span><span class="p">,</span> <span class="n">line</span><span class="p">))</span>
<span class="c"># lines that are only urls can go in unmolested</span>
<span class="k">elif</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">r'\s*https?:'</span><span class="p">,</span> <span class="n">line</span><span class="p">):</span>
<span class="n">dependency_links</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="k">return</span> <span class="n">dependency_links</span>
</div>
<div class="viewcode-block" id="write_requirements"><a class="viewcode-back" href="../../../../sourcecode/horizon/horizon.openstack.common.setup.html#horizon.openstack.common.setup.write_requirements">[docs]</a><span class="k">def</span> <span class="nf">write_requirements</span><span class="p">():</span>
<span class="n">venv</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'VIRTUAL_ENV'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">venv</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s">"requirements.txt"</span><span class="p">,</span> <span class="s">"w"</span><span class="p">)</span> <span class="k">as</span> <span class="n">req_file</span><span class="p">:</span>
<span class="n">output</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">([</span><span class="s">"pip"</span><span class="p">,</span> <span class="s">"-E"</span><span class="p">,</span> <span class="n">venv</span><span class="p">,</span> <span class="s">"freeze"</span><span class="p">,</span> <span class="s">"-l"</span><span class="p">],</span>
<span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">)</span>
<span class="n">requirements</span> <span class="o">=</span> <span class="n">output</span><span class="o">.</span><span class="n">communicate</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="n">req_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">requirements</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">_run_shell_command</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
<span class="n">output</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">([</span><span class="s">"/bin/sh"</span><span class="p">,</span> <span class="s">"-c"</span><span class="p">,</span> <span class="n">cmd</span><span class="p">],</span>
<span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">)</span>
<span class="k">return</span> <span class="n">output</span><span class="o">.</span><span class="n">communicate</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<div class="viewcode-block" id="write_vcsversion"><a class="viewcode-back" href="../../../../sourcecode/horizon/horizon.openstack.common.setup.html#horizon.openstack.common.setup.write_vcsversion">[docs]</a><span class="k">def</span> <span class="nf">write_vcsversion</span><span class="p">(</span><span class="n">location</span><span class="p">):</span>
<span class="sd">"""Produce a vcsversion dict that mimics the old one produced by bzr.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="s">'.git'</span><span class="p">):</span>
<span class="n">branch_nick_cmd</span> <span class="o">=</span> <span class="s">'git branch | grep -Ei "\* (.*)" | cut -f2 -d" "'</span>
<span class="n">branch_nick</span> <span class="o">=</span> <span class="n">_run_shell_command</span><span class="p">(</span><span class="n">branch_nick_cmd</span><span class="p">)</span>
<span class="n">revid_cmd</span> <span class="o">=</span> <span class="s">"git rev-parse HEAD"</span>
<span class="n">revid</span> <span class="o">=</span> <span class="n">_run_shell_command</span><span class="p">(</span><span class="n">revid_cmd</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">revno_cmd</span> <span class="o">=</span> <span class="s">"git log --oneline | wc -l"</span>
<span class="n">revno</span> <span class="o">=</span> <span class="n">_run_shell_command</span><span class="p">(</span><span class="n">revno_cmd</span><span class="p">)</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">location</span><span class="p">,</span> <span class="s">'w'</span><span class="p">)</span> <span class="k">as</span> <span class="n">version_file</span><span class="p">:</span>
<span class="n">version_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"""</span>
<span class="s"># This file is automatically generated by setup.py, So don't edit it. :)</span>
<span class="s">version_info = {</span>
<span class="s"> 'branch_nick': '</span><span class="si">%s</span><span class="s">',</span>
<span class="s"> 'revision_id': '</span><span class="si">%s</span><span class="s">',</span>
<span class="s"> 'revno': </span><span class="si">%s</span><span class="s"></span>
<span class="s">}</span>
<span class="s">"""</span> <span class="o">%</span> <span class="p">(</span><span class="n">branch_nick</span><span class="p">,</span> <span class="n">revid</span><span class="p">,</span> <span class="n">revno</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="write_git_changelog"><a class="viewcode-back" href="../../../../sourcecode/horizon/horizon.openstack.common.setup.html#horizon.openstack.common.setup.write_git_changelog">[docs]</a><span class="k">def</span> <span class="nf">write_git_changelog</span><span class="p">():</span>
<span class="sd">"""Write a changelog based on the git changelog."""</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="s">'.git'</span><span class="p">):</span>
<span class="n">git_log_cmd</span> <span class="o">=</span> <span class="s">'git log --stat'</span>
<span class="n">changelog</span> <span class="o">=</span> <span class="n">_run_shell_command</span><span class="p">(</span><span class="n">git_log_cmd</span><span class="p">)</span>
<span class="n">mailmap</span> <span class="o">=</span> <span class="n">parse_mailmap</span><span class="p">()</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s">"ChangeLog"</span><span class="p">,</span> <span class="s">"w"</span><span class="p">)</span> <span class="k">as</span> <span class="n">changelog_file</span><span class="p">:</span>
<span class="n">changelog_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">canonicalize_emails</span><span class="p">(</span><span class="n">changelog</span><span class="p">,</span> <span class="n">mailmap</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="generate_authors"><a class="viewcode-back" href="../../../../sourcecode/horizon/horizon.openstack.common.setup.html#horizon.openstack.common.setup.generate_authors">[docs]</a><span class="k">def</span> <span class="nf">generate_authors</span><span class="p">():</span>
<span class="sd">"""Create AUTHORS file using git commits."""</span>
<span class="n">jenkins_email</span> <span class="o">=</span> <span class="s">'jenkins@review.openstack.org'</span>
<span class="n">old_authors</span> <span class="o">=</span> <span class="s">'AUTHORS.in'</span>
<span class="n">new_authors</span> <span class="o">=</span> <span class="s">'AUTHORS'</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="s">'.git'</span><span class="p">):</span>
<span class="c"># don't include jenkins email address in AUTHORS file</span>
<span class="n">git_log_cmd</span> <span class="o">=</span> <span class="p">(</span><span class="s">"git log --format='%aN <%aE>' | sort -u | "</span>
<span class="s">"grep -v "</span> <span class="o">+</span> <span class="n">jenkins_email</span><span class="p">)</span>
<span class="n">changelog</span> <span class="o">=</span> <span class="n">_run_shell_command</span><span class="p">(</span><span class="n">git_log_cmd</span><span class="p">)</span>
<span class="n">mailmap</span> <span class="o">=</span> <span class="n">parse_mailmap</span><span class="p">()</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">new_authors</span><span class="p">,</span> <span class="s">'w'</span><span class="p">)</span> <span class="k">as</span> <span class="n">new_authors_fh</span><span class="p">:</span>
<span class="n">new_authors_fh</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">canonicalize_emails</span><span class="p">(</span><span class="n">changelog</span><span class="p">,</span> <span class="n">mailmap</span><span class="p">))</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">old_authors</span><span class="p">):</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">old_authors</span><span class="p">,</span> <span class="s">"r"</span><span class="p">)</span> <span class="k">as</span> <span class="n">old_authors_fh</span><span class="p">:</span>
<span class="n">new_authors_fh</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'</span><span class="se">\n</span><span class="s">'</span> <span class="o">+</span> <span class="n">old_authors_fh</span><span class="o">.</span><span class="n">read</span><span class="p">())</span>
</div>
<div class="viewcode-block" id="get_cmdclass"><a class="viewcode-back" href="../../../../sourcecode/horizon/horizon.openstack.common.setup.html#horizon.openstack.common.setup.get_cmdclass">[docs]</a><span class="k">def</span> <span class="nf">get_cmdclass</span><span class="p">():</span>
<span class="sd">"""Return dict of commands to run from setup.py."""</span>
<span class="n">cmdclass</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="k">class</span> <span class="nc">LocalSDist</span><span class="p">(</span><span class="n">sdist</span><span class="o">.</span><span class="n">sdist</span><span class="p">):</span>
<span class="sd">"""Builds the ChangeLog and Authors files from VC first."""</span>
<span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">write_git_changelog</span><span class="p">()</span>
<span class="n">generate_authors</span><span class="p">()</span>
<span class="c"># sdist.sdist is an old style class, can't use super()</span>
<span class="n">sdist</span><span class="o">.</span><span class="n">sdist</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">cmdclass</span><span class="p">[</span><span class="s">'sdist'</span><span class="p">]</span> <span class="o">=</span> <span class="n">LocalSDist</span>
<span class="c"># If Sphinx is installed on the box running setup.py,</span>
<span class="c"># enable setup.py to build the documentation, otherwise,</span>
<span class="c"># just ignore it</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">sphinx.setup_command</span> <span class="kn">import</span> <span class="n">BuildDoc</span>
<span class="k">class</span> <span class="nc">LocalBuildDoc</span><span class="p">(</span><span class="n">BuildDoc</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">for</span> <span class="n">builder</span> <span class="ow">in</span> <span class="p">[</span><span class="s">'html'</span><span class="p">,</span> <span class="s">'man'</span><span class="p">]:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">builder</span> <span class="o">=</span> <span class="n">builder</span>
<span class="bp">self</span><span class="o">.</span><span class="n">finalize_options</span><span class="p">()</span>
<span class="n">BuildDoc</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">cmdclass</span><span class="p">[</span><span class="s">'build_sphinx'</span><span class="p">]</span> <span class="o">=</span> <span class="n">LocalBuildDoc</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">return</span> <span class="n">cmdclass</span></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<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"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../../../index.html">Horizon 2012.2.3 documentation</a> »</li>
<li><a href="../../../index.html" >Module code</a> »</li>
<li><a href="../../../horizon.html" accesskey="U">horizon</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012, OpenStack, LLC.
Last updated on Feb 08, 2013.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
