JezK

Edit File: ch-programs.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">

<html>

<head>

<title>Debian Python Policy - Python Programs</title>

</head>

<body>

<p>
[ <a href="ch-module_packages.html">previous</a> ]
[ <a href="index.html#contents">Contents</a> ]
[ <a href="ch-python3.html">1</a> ]
[ <a href="ch-python.html">2</a> ]
[ <a href="ch-module_packages.html">3</a> ]
[ 4 ]
[ <a href="ch-embed.html">5</a> ]
[ <a href="ch-other.html">6</a> ]
[ <a href="ap-build_dependencies.html">A</a> ]
[ <a href="ap-packaging_tools.html">B</a> ]
[ <a href="ap-upgrade.html">C</a> ]
[ <a href="ch-embed.html">next</a> ]
</p>

<hr>

<h1>
Debian Python Policy
<br>Chapter 4 - Python Programs
</h1>

<hr>

<h2 id="s-interpreter-directive">4.1 Interpreter directive (“Shebang”)</h2>

<p>
Executables written for interpretation by Python must use an appropraite
interpreter directive, or “shebang”, as the first line of the program.
This line should be of the form <samp>#!<var>interpreter_location</var></samp>.
See <a href="ch-python.html#s-interpreter_name">Interpreter Name, Section
2.4.1</a> for the interpreter name to use.
</p>

<p>
As noted in <a href="ch-python.html#s-interpreter_loc">Interpreter Location,
Section 2.4.2</a>, the form <samp>#!/usr/bin/env
<var>interpreter_name</var></samp> is deprecated.
</p>

<hr>

<h2 id="s-version_indep_progs">4.2 Programs using the default Python</h2>

<p>
A package that installs a program that can be run by any version of Python 3
must declare a dependency on <code>python3</code>, with a versioned dependency
if necessary.
</p>

<p>
A package that installs a program that can be run by any version of Python 2
must declare a dependency on <code>python2</code>, with a versioned dependency
if necessary.
</p>

<p>
If the program needs the public Python module <samp>foo</samp>, the package
must depend on the binary package that installs the <samp>foo</samp> module.
See <a href="ch-module_packages.html#s-package_names">Module Package Names,
Section 3.3</a> for the naming of packages that install public Python modules.
</p>

<hr>

<h3 id="s-current_version_progs">4.2.1 Programs Shipping Private Modules</h3>

<p>
A program that specifies <code>python3</code> or <code>python</code> as its
interpreter may require its own private Python modules.  These modules should
be installed in <code>/usr/share/<var>module</var></code>, or
<code>/usr/lib/<var>module</var></code> if the modules are
architecture-dependent (e.g.  extensions).
</p>

<p>
The rules explained in <a
href="ch-module_packages.html#s-byte_compilation">Modules Byte-Compilation,
Section 3.7</a> apply to those private modules: the byte-compiled modules must
not be shipped with the binary package, they should be generated in the
package's post-install script using the current default Python version, and
removed in the pre-remove script.  Modules should be byte-compiled using the
current default Python version.
</p>

<p>
Programs that have private compiled extensions must either handle multiple
version support themselves, or declare a tight dependency on the current Python
version (e.g.  <samp>Depends: python3&nbsp;(&gt;=&nbsp;3.5),
python3&nbsp;(&lt;&lt;&nbsp;3.6)</samp>.
</p>

<hr>

<h2 id="s-version_dep_progs">4.3 Programs Using a Particular Python Version</h2>

<p>
A program which requires a specific minor version of Python must specify the
versioned interpreter <code>python<var>X</var>.<var>Y</var></code>.  The
package that installs the programs must also specify a dependency on
<code>python<var>X</var>.<var>Y</var></code> and on any packages that install
necessary modules.
</p>

<p>
The notes on installation directories and byte-compilation for programs that
support any version of Python also apply to programs supporting only a single
Python version.  Modules to be byte-compiled should use the same Python version
as the package itself.
</p>

<hr>

<p>
Debian Python Policy
</p>

<address>
version 0.10.1.1<br>
<br>
Neil Schemenauer <code><a href="mailto:nas@debian.org">mailto:nas@debian.org</a></code><br>
Matthias Klose <code><a href="mailto:doko@debian.org">mailto:doko@debian.org</a></code><br>
Gregor Hoffleit <code><a href="mailto:flight@debian.org">mailto:flight@debian.org</a></code><br>
Josselin Mouette <code><a href="mailto:joss@debian.org">mailto:joss@debian.org</a></code><br>
Joe Wreschnig <code><a href="mailto:piman@debian.org">mailto:piman@debian.org</a></code><br>
Lo&iuml;c Minier <code><a href="mailto:lool@debian.org">mailto:lool@debian.org</a></code><br>
Scott Kitterman <code><a href="mailto:scott@kitterman.com">mailto:scott@kitterman.com</a></code><br>
Barry Warsaw <code><a href="mailto:barry@debian.org">mailto:barry@debian.org</a></code><br>
Ben Finney <code><a href="mailto:ben+debian@benfinney.id.au">mailto:ben+debian@benfinney.id.au</a></code><br>
<br>
</address>
<hr>

</body>

</html>