<!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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Distribution Types — pkginfo 1.2 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Metadata Versions" href="metadata.html" />
<link rel="prev" title="pkginfo documentation" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="distribution-types">
<h1>Distribution Types<a class="headerlink" href="#distribution-types" title="Permalink to this headline">¶</a></h1>
<p>The fundamental abstraction provided by this pacakge is the <code class="docutils literal notranslate"><span class="pre">Distribution</span></code>
base class. Implementations exist for specific cases: source distributions,
binary distributions, installed pakcages, and development checkouts.</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pkginfo</span> <span class="kn">import</span> <span class="n">Distribution</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pkginfo</span> <span class="kn">import</span> <span class="n">SDist</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">SDist</span><span class="p">,</span> <span class="n">Distribution</span><span class="p">)</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pkginfo</span> <span class="kn">import</span> <span class="n">UnpackedSDist</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">UnpackedSDist</span><span class="p">,</span> <span class="n">SDist</span><span class="p">)</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pkginfo</span> <span class="kn">import</span> <span class="n">BDist</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">BDist</span><span class="p">,</span> <span class="n">Distribution</span><span class="p">)</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pkginfo</span> <span class="kn">import</span> <span class="n">Wheel</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">Wheel</span><span class="p">,</span> <span class="n">Distribution</span><span class="p">)</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pkginfo</span> <span class="kn">import</span> <span class="n">Installed</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">Installed</span><span class="p">,</span> <span class="n">Distribution</span><span class="p">)</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pkginfo</span> <span class="kn">import</span> <span class="n">Develop</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">Develop</span><span class="p">,</span> <span class="n">Distribution</span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="introspecting-source-distributions">
<h2>Introspecting Source Distributions<a class="headerlink" href="#introspecting-source-distributions" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">SDist</span></code> objects are created from a filesystem path to the corresponding
archive, which should have been created via the <code class="docutils literal notranslate"><span class="pre">sdist</span></code> command from
distutils:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mypackage</span> <span class="o">=</span> <span class="n">SDist</span><span class="p">(</span><span class="s1">'docs/examples/mypackage-0.1.tar.gz'</span><span class="p">)</span>
</pre></div>
</div>
<p>After creation, the <code class="docutils literal notranslate"><span class="pre">SDist</span></code> instance will have attributes corrsponding
the the fields defined in the PEP corresponding to the metadata version,
lower-cased and transliterated into valid Python identifiers by mapping
hyphens to underscores. E.g.:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">print</span> <span class="n">mypackage</span><span class="o">.</span><span class="n">metadata_version</span>
<span class="go">1.0</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">mypackage</span><span class="o">.</span><span class="n">name</span>
<span class="go">mypackage</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">mypackage</span><span class="o">.</span><span class="n">version</span>
<span class="go">0.1</span>
</pre></div>
</div>
<p>Fields which are optional under the PEP, and which have no value set
in their <code class="docutils literal notranslate"><span class="pre">PKG-INFO</span></code>, will map to the value <code class="docutils literal notranslate"><span class="pre">None</span></code>:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">print</span> <span class="n">mypackage</span><span class="o">.</span><span class="n">keywords</span>
<span class="go">None</span>
</pre></div>
</div>
<p>Fields which are marked “multiple use” under the PEP map onto sequences;
their names are pluralized to indicate the sequence. “Multiple use” fields
with no occurences in the <code class="docutils literal notranslate"><span class="pre">PKG-INFO</span></code> file will map onto an empty sequence:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">print</span> <span class="nb">list</span><span class="p">(</span><span class="n">mypackage</span><span class="o">.</span><span class="n">supported_platforms</span><span class="p">)</span>
<span class="go">[]</span>
</pre></div>
</div>
<p>See <a class="reference external" href="metadata.html">Metadata Versions</a> for an example with a non-empty,
“multiple-use” field.</p>
</div>
<div class="section" id="introspecting-unpacked-source-distributions">
<h2>Introspecting Unpacked Source Distributions<a class="headerlink" href="#introspecting-unpacked-source-distributions" title="Permalink to this headline">¶</a></h2>
<p>You can also introspect a previously-unpacked package with <code class="docutils literal notranslate"><span class="pre">UnpackedSDist</span></code>
either by passing it the path to the unpacked package, or by passing it the
setup.py at the top level:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mypackage</span> <span class="o">=</span> <span class="n">UnpackedSDist</span><span class="p">(</span><span class="s1">'docs/examples/mypackage-0.1'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">mypackage</span><span class="o">.</span><span class="n">name</span>
<span class="go">mypackage</span>
<span class="gp">>>> </span><span class="n">myotherpackage</span> <span class="o">=</span> <span class="n">UnpackedSDist</span><span class="p">(</span><span class="s1">'docs/examples/mypackage-0.1/setup.py'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">myotherpackage</span><span class="o">.</span><span class="n">name</span>
<span class="go">mypackage</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">UnpackedSDist</span></code> objects are most useful in conjuction with distutils to
produce sdists that want complex behavior for determining what metadata to use;
these sdists normally break when installed with <code class="docutils literal notranslate"><span class="pre">pip</span></code>, because metadata in an
sdist is regenerated when pip installed. You can achieve this in your
<cite>setup.py</cite> as follows:</p>
<div class="code highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">setuptools</span> <span class="k">import</span> <span class="n">dist</span><span class="p">,</span> <span class="n">setup</span>
<span class="gp">>>> </span><span class="n">dist</span><span class="o">.</span><span class="n">Distribution</span><span class="p">(</span><span class="nb">dict</span><span class="p">(</span><span class="n">setup_requires</span><span class="o">=</span><span class="s1">'pkginfo'</span><span class="p">))</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pkginfo</span> <span class="k">import</span> <span class="n">UnpackedSDist</span>
<span class="gp">>>> </span><span class="k">try</span><span class="p">:</span>
<span class="gp">... </span> <span class="n">d</span> <span class="o">=</span> <span class="n">UnpackedSDist</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)</span>
<span class="gp">... </span> <span class="n">VERSION</span> <span class="o">=</span> <span class="n">d</span><span class="o">.</span><span class="n">version</span>
<span class="gp">... </span><span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="gp">... </span> <span class="n">VERSION</span> <span class="o">=</span> <span class="p">(</span><span class="n">version_from_source_control</span><span class="p">()</span> <span class="ow">or</span>
<span class="gp">... </span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s1">'VERSION'</span><span class="p">,</span> <span class="s1">'1.0'</span><span class="p">))</span>
<span class="gp">>>> </span><span class="n">setup</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'mypackage'</span><span class="p">,</span> <span class="n">version</span><span class="o">=</span><span class="n">VERSION</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="introspecting-binary-distributions">
<h2>Introspecting Binary Distributions<a class="headerlink" href="#introspecting-binary-distributions" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">BDist</span></code> objects are created from the filename, which should have been
generated via <code class="docutils literal notranslate"><span class="pre">setup.py</span> <span class="pre">bdist_egg</span></code>.</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mypackage</span> <span class="o">=</span> <span class="n">BDist</span><span class="p">(</span><span class="s1">'docs/examples/mypackage-0.1-py2.6.egg'</span><span class="p">)</span>
</pre></div>
</div>
<p>After that, they have the same metadata as other <code class="docutils literal notranslate"><span class="pre">Distribution</span></code> objects,</p>
</div>
<div class="section" id="introspecting-wheels">
<h2>Introspecting Wheels<a class="headerlink" href="#introspecting-wheels" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">Wheel</span></code> objects are created from the filename, which should have been
generated via <code class="docutils literal notranslate"><span class="pre">setup.py</span> <span class="pre">bdist_wheel</span></code>.</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mypackage</span> <span class="o">=</span> <span class="n">Wheel</span><span class="p">(</span><span class="s1">'docs/examples/mypackage-0.1-cp26-none-linux_x86_64.whl'</span><span class="p">)</span>
</pre></div>
</div>
<p>After that, they have the same metadata as other <code class="docutils literal notranslate"><span class="pre">Distribution</span></code> objects,</p>
</div>
<div class="section" id="introspecting-installed-packages">
<h2>Introspecting Installed Packages<a class="headerlink" href="#introspecting-installed-packages" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">Installed</span></code> objects are created from either a module object or its
dotted name. Note that this feature only works in Python 2.6 or later:
earlier Python versions did not record <code class="docutils literal notranslate"><span class="pre">PKG-INFO</span></code> for installed packages.</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">sys</span>
<span class="gp">>>> </span><span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o">>=</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="mi">6</span><span class="p">):</span>
<span class="gp">... </span> <span class="n">dotted</span> <span class="o">=</span> <span class="n">Installed</span><span class="p">(</span><span class="s1">'pkginfo'</span><span class="p">)</span>
<span class="gp">... </span> <span class="kn">import</span> <span class="nn">pkginfo</span>
<span class="gp">... </span> <span class="n">direct</span> <span class="o">=</span> <span class="n">Installed</span><span class="p">(</span><span class="n">pkginfo</span><span class="p">)</span>
</pre></div>
</div>
<p>After that, they have the same metadata as other <code class="docutils literal notranslate"><span class="pre">Distribution</span></code> objects,
assuming that the package on which they were based has a discoverable
‘.egg-info’ file / directory. To be discoverable, the ‘.egg-info’ must
either be located inside the package (e.g., created via <code class="docutils literal notranslate"><span class="pre">setup.py</span> <span class="pre">develop</span></code>
under setuptools), or adjacent to the package (e.g., created via
<code class="docutils literal notranslate"><span class="pre">setup.py</span> <span class="pre">instlall</span></code>).</p>
</div>
<div class="section" id="introspecting-development-checkouts">
<h2>Introspecting Development Checkouts<a class="headerlink" href="#introspecting-development-checkouts" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">Develop</span></code> objects are created from a path to a checkout containing
a <code class="docutils literal notranslate"><span class="pre">PKG-iNFO</span></code> file, e.g., created by running <code class="docutils literal notranslate"><span class="pre">setup.py</span> <span class="pre">develop</span></code> under
setuptools.</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">develop</span> <span class="o">=</span> <span class="n">Develop</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)</span>
</pre></div>
</div>
<p>After that, they have the same metadata as other <code class="docutils literal notranslate"><span class="pre">Distribution</span></code> objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">pkginfo</a></h1>
<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Distribution Types</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#introspecting-source-distributions">Introspecting Source Distributions</a></li>
<li class="toctree-l2"><a class="reference internal" href="#introspecting-unpacked-source-distributions">Introspecting Unpacked Source Distributions</a></li>
<li class="toctree-l2"><a class="reference internal" href="#introspecting-binary-distributions">Introspecting Binary Distributions</a></li>
<li class="toctree-l2"><a class="reference internal" href="#introspecting-wheels">Introspecting Wheels</a></li>
<li class="toctree-l2"><a class="reference internal" href="#introspecting-installed-packages">Introspecting Installed Packages</a></li>
<li class="toctree-l2"><a class="reference internal" href="#introspecting-development-checkouts">Introspecting Development Checkouts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="metadata.html">Metadata Versions</a></li>
<li class="toctree-l1"><a class="reference internal" href="indexes.html">Distribution Indexes</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">pkginfo</span></code> documentation</a></li>
<li>Next: <a href="metadata.html" title="next chapter">Metadata Versions</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2009-2013, Tres Seaver.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.3</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
<a href="_sources/distributions.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
