<!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>28.4. zipapp — Manage executable python zip archives — Python 3.5.3 documentation</title>
<link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '3.5.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/sidebar.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Python 3.5.3 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 3.5.3 documentation" href="../contents.html" />
<link rel="up" title="28. Software Packaging and Distribution" href="distribution.html" />
<link rel="next" title="29. Python Runtime Services" href="python.html" />
<link rel="prev" title="28.3. venv — Creation of virtual environments" href="venv.html" />
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
<script type="text/javascript" src="../_static/copybutton.js"></script>
<script type="text/javascript" src="../_static/version_switch.js"></script>
</head>
<body role="document">
<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="python.html" title="29. Python Runtime Services"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="venv.html" title="28.3. venv — Creation of virtual environments"
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> »</li>
<li>
<span class="version_switcher_placeholder">3.5.3</span>
<a href="../index.html">Documentation </a> »
</li>
<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>
<li class="nav-item nav-item-2"><a href="distribution.html" accesskey="U">28. Software Packaging and Distribution</a> »</li>
<li class="right">
<div class="inline-search" style="display: none" role="search">
<form class="inline-search" action="../search.html" method="get">
<input placeholder="Quick search" 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>
<script type="text/javascript">$('.inline-search').show(0);</script>
|
</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-zipapp">
<span id="zipapp-manage-executable-python-zip-archives"></span><h1>28.4. <a class="reference internal" href="#module-zipapp" title="zipapp: Manage executable python zip archives"><code class="xref py py-mod docutils literal"><span class="pre">zipapp</span></code></a> — Manage executable python zip archives<a class="headerlink" href="#module-zipapp" title="Permalink to this headline">¶</a></h1>
<div class="versionadded">
<p><span class="versionmodified">New in version 3.5.</span></p>
</div>
<p><strong>Source code:</strong> <a class="reference external" href="https://hg.python.org/cpython/file/3.5/Lib/zipapp.py">Lib/zipapp.py</a></p>
<hr class="docutils" id="index-0" />
<p>This module provides tools to manage the creation of zip files containing
Python code, which can be <a class="reference internal" href="../using/cmdline.html#using-on-interface-options"><span>executed directly by the Python interpreter</span></a>. The module provides both a
<a class="reference internal" href="#zipapp-command-line-interface"><span>Command-Line Interface</span></a> and a <a class="reference internal" href="#zipapp-python-api"><span>Python API</span></a>.</p>
<div class="section" id="basic-example">
<h2>28.4.1. Basic Example<a class="headerlink" href="#basic-example" title="Permalink to this headline">¶</a></h2>
<p>The following example shows how the <a class="reference internal" href="#zipapp-command-line-interface"><span>Command-Line Interface</span></a>
can be used to create an executable archive from a directory containing
Python code. When run, the archive will execute the <code class="docutils literal"><span class="pre">main</span></code> function from
the module <code class="docutils literal"><span class="pre">myapp</span></code> in the archive.</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ python -m zipapp myapp -m <span class="s2">"myapp:main"</span>
$ python myapp.pyz
<output from myapp>
</pre></div>
</div>
</div>
<div class="section" id="command-line-interface">
<span id="zipapp-command-line-interface"></span><h2>28.4.2. Command-Line Interface<a class="headerlink" href="#command-line-interface" title="Permalink to this headline">¶</a></h2>
<p>When called as a program from the command line, the following form is used:</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ python -m zipapp <span class="nb">source</span> <span class="o">[</span>options<span class="o">]</span>
</pre></div>
</div>
<p>If <em>source</em> is a directory, this will create an archive from the contents of
<em>source</em>. If <em>source</em> is a file, it should be an archive, and it will be
copied to the target archive (or the contents of its shebang line will be
displayed if the –info option is specified).</p>
<p>The following options are understood:</p>
<dl class="cmdoption">
<dt id="cmdoption-zipapp-o">
<span id="cmdoption-zipapp--output"></span><code class="descname">-o</code><code class="descclassname"> <output></code><code class="descclassname">, </code><code class="descname">--output</code><code class="descclassname">=<output></code><a class="headerlink" href="#cmdoption-zipapp-o" title="Permalink to this definition">¶</a></dt>
<dd><p>Write the output to a file named <em>output</em>. If this option is not specified,
the output filename will be the same as the input <em>source</em>, with the
extension <code class="docutils literal"><span class="pre">.pyz</span></code> added. If an explicit filename is given, it is used as
is (so a <code class="docutils literal"><span class="pre">.pyz</span></code> extension should be included if required).</p>
<p>An output filename must be specified if the <em>source</em> is an archive (and in
that case, <em>output</em> must not be the same as <em>source</em>).</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-zipapp-p">
<span id="cmdoption-zipapp--python"></span><code class="descname">-p</code><code class="descclassname"> <interpreter></code><code class="descclassname">, </code><code class="descname">--python</code><code class="descclassname">=<interpreter></code><a class="headerlink" href="#cmdoption-zipapp-p" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a <code class="docutils literal"><span class="pre">#!</span></code> line to the archive specifying <em>interpreter</em> as the command
to run. Also, on POSIX, make the archive executable. The default is to
write no <code class="docutils literal"><span class="pre">#!</span></code> line, and not make the file executable.</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-zipapp-m">
<span id="cmdoption-zipapp--main"></span><code class="descname">-m</code><code class="descclassname"> <mainfn></code><code class="descclassname">, </code><code class="descname">--main</code><code class="descclassname">=<mainfn></code><a class="headerlink" href="#cmdoption-zipapp-m" title="Permalink to this definition">¶</a></dt>
<dd><p>Write a <code class="docutils literal"><span class="pre">__main__.py</span></code> file to the archive that executes <em>mainfn</em>. The
<em>mainfn</em> argument should have the form “pkg.mod:fn”, where “pkg.mod” is a
package/module in the archive, and “fn” is a callable in the given module.
The <code class="docutils literal"><span class="pre">__main__.py</span></code> file will execute that callable.</p>
<p><a class="reference internal" href="#cmdoption-zipapp--main"><code class="xref std std-option docutils literal"><span class="pre">--main</span></code></a> cannot be specified when copying an archive.</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-zipapp--info">
<code class="descname">--info</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-zipapp--info" title="Permalink to this definition">¶</a></dt>
<dd><p>Display the interpreter embedded in the archive, for diagnostic purposes. In
this case, any other options are ignored and SOURCE must be an archive, not a
directory.</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-zipapp-h">
<span id="cmdoption-zipapp--help"></span><code class="descname">-h</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--help</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-zipapp-h" title="Permalink to this definition">¶</a></dt>
<dd><p>Print a short usage message and exit.</p>
</dd></dl>
</div>
<div class="section" id="python-api">
<span id="zipapp-python-api"></span><h2>28.4.3. Python API<a class="headerlink" href="#python-api" title="Permalink to this headline">¶</a></h2>
<p>The module defines two convenience functions:</p>
<dl class="function">
<dt id="zipapp.create_archive">
<code class="descclassname">zipapp.</code><code class="descname">create_archive</code><span class="sig-paren">(</span><em>source</em>, <em>target=None</em>, <em>interpreter=None</em>, <em>main=None</em><span class="sig-paren">)</span><a class="headerlink" href="#zipapp.create_archive" title="Permalink to this definition">¶</a></dt>
<dd><p>Create an application archive from <em>source</em>. The source can be any
of the following:</p>
<ul class="simple">
<li>The name of a directory, or a <a class="reference internal" href="pathlib.html#pathlib.Path" title="pathlib.Path"><code class="xref py py-class docutils literal"><span class="pre">pathlib.Path</span></code></a> object referring
to a directory, in which case a new application archive will be
created from the content of that directory.</li>
<li>The name of an existing application archive file, or a <a class="reference internal" href="pathlib.html#pathlib.Path" title="pathlib.Path"><code class="xref py py-class docutils literal"><span class="pre">pathlib.Path</span></code></a>
object referring to such a file, in which case the file is copied to
the target (modifying it to reflect the value given for the <em>interpreter</em>
argument). The file name should include the <code class="docutils literal"><span class="pre">.pyz</span></code> extension, if required.</li>
<li>A file object open for reading in bytes mode. The content of the
file should be an application archive, and the file object is
assumed to be positioned at the start of the archive.</li>
</ul>
<p>The <em>target</em> argument determines where the resulting archive will be
written:</p>
<ul class="simple">
<li>If it is the name of a file, or a <code class="xref py py-class docutils literal"><span class="pre">pathlb.Path</span></code> object,
the archive will be written to that file.</li>
<li>If it is an open file object, the archive will be written to that
file object, which must be open for writing in bytes mode.</li>
<li>If the target is omitted (or <code class="docutils literal"><span class="pre">None</span></code>), the source must be a directory
and the target will be a file with the same name as the source, with
a <code class="docutils literal"><span class="pre">.pyz</span></code> extension added.</li>
</ul>
<p>The <em>interpreter</em> argument specifies the name of the Python
interpreter with which the archive will be executed. It is written as
a “shebang” line at the start of the archive. On POSIX, this will be
interpreted by the OS, and on Windows it will be handled by the Python
launcher. Omitting the <em>interpreter</em> results in no shebang line being
written. If an interpreter is specified, and the target is a
filename, the executable bit of the target file will be set.</p>
<p>The <em>main</em> argument specifies the name of a callable which will be
used as the main program for the archive. It can only be specified if
the source is a directory, and the source does not already contain a
<code class="docutils literal"><span class="pre">__main__.py</span></code> file. The <em>main</em> argument should take the form
“pkg.module:callable” and the archive will be run by importing
“pkg.module” and executing the given callable with no arguments. It
is an error to omit <em>main</em> if the source is a directory and does not
contain a <code class="docutils literal"><span class="pre">__main__.py</span></code> file, as otherwise the resulting archive
would not be executable.</p>
<p>If a file object is specified for <em>source</em> or <em>target</em>, it is the
caller’s responsibility to close it after calling create_archive.</p>
<p>When copying an existing archive, file objects supplied only need
<code class="docutils literal"><span class="pre">read</span></code> and <code class="docutils literal"><span class="pre">readline</span></code>, or <code class="docutils literal"><span class="pre">write</span></code> methods. When creating an
archive from a directory, if the target is a file object it will be
passed to the <code class="docutils literal"><span class="pre">zipfile.ZipFile</span></code> class, and must supply the methods
needed by that class.</p>
</dd></dl>
<dl class="function">
<dt id="zipapp.get_interpreter">
<code class="descclassname">zipapp.</code><code class="descname">get_interpreter</code><span class="sig-paren">(</span><em>archive</em><span class="sig-paren">)</span><a class="headerlink" href="#zipapp.get_interpreter" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the interpreter specified in the <code class="docutils literal"><span class="pre">#!</span></code> line at the start of the
archive. If there is no <code class="docutils literal"><span class="pre">#!</span></code> line, return <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal"><span class="pre">None</span></code></a>.
The <em>archive</em> argument can be a filename or a file-like object open
for reading in bytes mode. It is assumed to be at the start of the archive.</p>
</dd></dl>
</div>
<div class="section" id="examples">
<span id="zipapp-examples"></span><h2>28.4.4. Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<p>Pack up a directory into an archive, and run it.</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ python -m zipapp myapp
$ python myapp.pyz
<output from myapp>
</pre></div>
</div>
<p>The same can be done using the <a class="reference internal" href="#zipapp.create_archive" title="zipapp.create_archive"><code class="xref py py-func docutils literal"><span class="pre">create_archive()</span></code></a> functon:</p>
<div class="highlight-python3"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">zipapp</span>
<span class="gp">>>> </span><span class="n">zipapp</span><span class="o">.</span><span class="n">create_archive</span><span class="p">(</span><span class="s1">'myapp.pyz'</span><span class="p">,</span> <span class="s1">'myapp'</span><span class="p">)</span>
</pre></div>
</div>
<p>To make the application directly executable on POSIX, specify an interpreter
to use.</p>
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ python -m zipapp myapp -p <span class="s2">"/usr/bin/env python"</span>
$ ./myapp.pyz
<output from myapp>
</pre></div>
</div>
<p>To replace the shebang line on an existing archive, create a modified archive
using the <a class="reference internal" href="#zipapp.create_archive" title="zipapp.create_archive"><code class="xref py py-func docutils literal"><span class="pre">create_archive()</span></code></a> function:</p>
<div class="highlight-python3"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">zipapp</span>
<span class="gp">>>> </span><span class="n">zipapp</span><span class="o">.</span><span class="n">create_archive</span><span class="p">(</span><span class="s1">'old_archive.pyz'</span><span class="p">,</span> <span class="s1">'new_archive.pyz'</span><span class="p">,</span> <span class="s1">'/usr/bin/python3'</span><span class="p">)</span>
</pre></div>
</div>
<p>To update the file in place, do the replacement in memory using a <code class="xref py py-class docutils literal"><span class="pre">BytesIO</span></code>
object, and then overwrite the source afterwards. Note that there is a risk
when overwriting a file in place that an error will result in the loss of
the original file. This code does not protect against such errors, but
production code should do so. Also, this method will only work if the archive
fits in memory:</p>
<div class="highlight-python3"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">zipapp</span>
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">io</span>
<span class="gp">>>> </span><span class="n">temp</span> <span class="o">=</span> <span class="n">io</span><span class="o">.</span><span class="n">BytesIO</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">zipapp</span><span class="o">.</span><span class="n">create_archive</span><span class="p">(</span><span class="s1">'myapp.pyz'</span><span class="p">,</span> <span class="n">temp</span><span class="p">,</span> <span class="s1">'/usr/bin/python2'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'myapp.pyz'</span><span class="p">,</span> <span class="s1">'wb'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="gp">>>> </span> <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">temp</span><span class="o">.</span><span class="n">getvalue</span><span class="p">())</span>
</pre></div>
</div>
<p>Note that if you specify an interpreter and then distribute your application
archive, you need to ensure that the interpreter used is portable. The Python
launcher for Windows supports most common forms of POSIX <code class="docutils literal"><span class="pre">#!</span></code> line, but there
are other issues to consider:</p>
<ul class="simple">
<li>If you use “/usr/bin/env python” (or other forms of the “python” command,
such as “/usr/bin/python”), you need to consider that your users may have
either Python 2 or Python 3 as their default, and write your code to work
under both versions.</li>
<li>If you use an explicit version, for example “/usr/bin/env python3” your
application will not work for users who do not have that version. (This
may be what you want if you have not made your code Python 2 compatible).</li>
<li>There is no way to say “python X.Y or later”, so be careful of using an
exact version like “/usr/bin/env python3.4” as you will need to change your
shebang line for users of Python 3.5, for example.</li>
</ul>
</div>
<div class="section" id="the-python-zip-application-archive-format">
<h2>28.4.5. The Python Zip Application Archive Format<a class="headerlink" href="#the-python-zip-application-archive-format" title="Permalink to this headline">¶</a></h2>
<p>Python has been able to execute zip files which contain a <code class="docutils literal"><span class="pre">__main__.py</span></code> file
since version 2.6. In order to be executed by Python, an application archive
simply has to be a standard zip file containing a <code class="docutils literal"><span class="pre">__main__.py</span></code> file which
will be run as the entry point for the application. As usual for any Python
script, the parent of the script (in this case the zip file) will be placed on
<a class="reference internal" href="sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal"><span class="pre">sys.path</span></code></a> and thus further modules can be imported from the zip file.</p>
<p>The zip file format allows arbitrary data to be prepended to a zip file. The
zip application format uses this ability to prepend a standard POSIX “shebang”
line to the file (<code class="docutils literal"><span class="pre">#!/path/to/interpreter</span></code>).</p>
<p>Formally, the Python zip application format is therefore:</p>
<ol class="arabic simple">
<li>An optional shebang line, containing the characters <code class="docutils literal"><span class="pre">b'#!'</span></code> followed by an
interpreter name, and then a newline (<code class="docutils literal"><span class="pre">b'\n'</span></code>) character. The interpreter
name can be anything acceptable to the OS “shebang” processing, or the Python
launcher on Windows. The interpreter should be encoded in UTF-8 on Windows,
and in <a class="reference internal" href="sys.html#sys.getfilesystemencoding" title="sys.getfilesystemencoding"><code class="xref py py-func docutils literal"><span class="pre">sys.getfilesystemencoding()</span></code></a> on POSIX.</li>
<li>Standard zipfile data, as generated by the <a class="reference internal" href="zipfile.html#module-zipfile" title="zipfile: Read and write ZIP-format archive files."><code class="xref py py-mod docutils literal"><span class="pre">zipfile</span></code></a> module. The
zipfile content <em>must</em> include a file called <code class="docutils literal"><span class="pre">__main__.py</span></code> (which must be
in the “root” of the zipfile - i.e., it cannot be in a subdirectory). The
zipfile data can be compressed or uncompressed.</li>
</ol>
<p>If an application archive has a shebang line, it may have the executable bit set
on POSIX systems, to allow it to be executed directly.</p>
<p>There is no requirement that the tools in this module are used to create
application archives - the module is a convenience, but archives in the above
format created by any means are acceptable to Python.</p>
</div>
</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="#">28.4. <code class="docutils literal"><span class="pre">zipapp</span></code> — Manage executable python zip archives</a><ul>
<li><a class="reference internal" href="#basic-example">28.4.1. Basic Example</a></li>
<li><a class="reference internal" href="#command-line-interface">28.4.2. Command-Line Interface</a></li>
<li><a class="reference internal" href="#python-api">28.4.3. Python API</a></li>
<li><a class="reference internal" href="#examples">28.4.4. Examples</a></li>
<li><a class="reference internal" href="#the-python-zip-application-archive-format">28.4.5. The Python Zip Application Archive Format</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="venv.html"
title="previous chapter">28.3. <code class="docutils literal"><span class="pre">venv</span></code> — Creation of virtual environments</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="python.html"
title="next chapter">29. Python Runtime Services</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../bugs.html">Report a Bug</a></li>
<li><a href="../_sources/library/zipapp.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</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="python.html" title="29. Python Runtime Services"
>next</a> |</li>
<li class="right" >
<a href="venv.html" title="28.3. venv — Creation of virtual environments"
>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> »</li>
<li>
<span class="version_switcher_placeholder">3.5.3</span>
<a href="../index.html">Documentation </a> »
</li>
<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>
<li class="nav-item nav-item-2"><a href="distribution.html" >28. Software Packaging and Distribution</a> »</li>
<li class="right">
<div class="inline-search" style="display: none" role="search">
<form class="inline-search" action="../search.html" method="get">
<input placeholder="Quick search" 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>
<script type="text/javascript">$('.inline-search').show(0);</script>
|
</li>
</ul>
</div>
<div class="footer">
© <a href="../copyright.html">Copyright</a> 2001-2017, Python Software Foundation.
<br />
The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>
<br />
Last updated on Jan 20, 2017.
<a href="../bugs.html">Found a bug</a>?
<br />
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.3.3.
</div>
</body>
</html>
