5
dh_python - calculates python dependencies and adds postinst and prerm python scripts
11
use Debian::Debhelper::Dh_Lib;
15
B<dh_python> [S<I<debhelper options>>] [B<-n>] [B<-V> I<version>] [S<I<module dirs ...>>]
19
dh_python is a debhelper program that is responsible for generating the
20
${python:Depends} substitutions and adding them to substvars files. It
21
will also add a postinst and a prerm script if required.
23
The program will look at python scripts and modules in your package, and
24
will use this information to generate a dependency on python, with the
25
current major version, or on pythonX.Y if your scripts or modules need a
26
specific python version. The dependency will be substituted into your
27
package's control file wherever you place the token "${python:Depends}".
29
If some modules need to be byte-compiled at install time, appropriate
30
postinst and prerm scripts will be generated. If already byte-compiled
31
modules are found, they are removed.
33
If you use this program, your package should build-depend on python.
41
If your package installs python modules in non-standard directories, you
42
can make dh_python check those directories by passing their names on the
43
command line. By default, it will check /usr/lib/site-python,
44
/usr/lib/$PACKAGE, /usr/share/$PACKAGE, /usr/lib/games/$PACKAGE,
45
/usr/share/games/$PACKAGE and /usr/lib/python?.?/site-packages.
47
Note: only /usr/lib/site-python, /usr/lib/python?.?/site-packages and the
48
extra names on the command line are searched for binary (.so) modules.
50
=item B<-V> I<version>
52
If the .py files your package ships are meant to be used by a specific
53
pythonX.Y version, you can use this option to specify the desired version,
54
such as 2.3. Do not use if you ship modules in /usr/lib/site-python.
56
=item B<-n>, B<--noscripts>
58
Do not modify postinst/postrm scripts.
64
Debian policy, version 3.5.7
66
Python policy, version 0.3.7
72
my $python = 'python';
74
# The current python major version
76
my $python_version = `$python -V 2>&1`;
77
if (! defined $python_version || $python_version eq "") {
78
error("Python is not installed, aborting. (Probably forgot to Build-Depend on python.)");
80
elsif ($python_version =~ m/^Python\s+(\d+)\.(\d+)(\.\d+)*/) {
81
$python_version = "$1.$2" ;
84
error("Unable to parse python version out of \"$python_version\".");
87
# The next python version
88
my $python_nextversion = $python_version + 0.1;
89
my $python_nextmajor = $python_major + 1;
91
my @python_allversions = ('1.5','2.1','2.2','2.3','2.4');
92
foreach (@python_allversions) {
97
my $usepython = "python$python_version";
99
$usepython = $dh{V_FLAG};
100
$usepython =~ s/^/python/;
101
if (! grep { $_ eq $usepython } @python_allversions) {
102
error("Unknown python version $dh{V_FLAG}");
106
# Cleaning the paths given on the command line
113
use constant PROGRAM => 1;
114
use constant PY_MODULE => 2;
115
use constant PY_MODULE_NONSTANDARD => 4;
116
use constant SO_MODULE => 8;
117
use constant SO_MODULE_NONSTANDARD => 16;
119
foreach my $package (@{$dh{DOPACKAGES}}) {
120
my $tmp = tmpdir($package);
122
delsubstvar($package, "python:Depends");
124
my @dirs = ("usr/lib/site-python", "usr/lib/$package", "usr/share/$package", "usr/lib/games/$package", "usr/share/games/$package", @ARGV );
125
my @dirs_so = ("usr/lib/site-python", @ARGV );
127
my $dep_on_python = 0;
129
my $look_for_pythonXY = 1;
131
# First, the case of python-foo and pythonX.Y-foo
132
if ($package =~ /^python-/) {
136
$pack =~ s/^python/python$python_version/;
137
if (grep { "$_" eq "$pack" } getpackages()) {
138
addsubstvar($package, "python:Depends", $pack);
141
if ($package !~ /^python[0-9].[0-9]-/) {
142
push @dirs, "usr/lib/$usepython/site-packages";
143
push @dirs_so, "usr/lib/$usepython/site-packages";
144
$look_for_pythonXY = 0;
147
@dirs = grep -d, map "$tmp/$_", @dirs;
148
@dirs_so = grep -d, map "$tmp/$_", @dirs_so;
152
foreach (@python_allversions) {
158
return unless -f and (-x or /\.py$/);
160
return unless open F, $_;
161
if (read F, local $_, 32 and m%^#!\s*/usr/bin/(env\s+)?(python(\d+\.\d+)?)\s%) {
162
if ( "python" eq $2 ) {
164
} elsif(defined $verdeps{$2}) {
165
$verdeps{$2} |= PROGRAM;
171
# Look for python modules
174
foreach my $curdir (@dirs) {
176
$curdir =~ s%^$tmp/%%;
181
doit(("rm","-f",$_."c",$_."o"));
185
if ($dh{V_FLAG_SET}) {
186
$verdeps{$usepython} |= PY_MODULE_NONSTANDARD;
190
$dirlist="$dirlist /$curdir";
195
foreach my $curdir (@dirs_so) {
197
$curdir =~ s%^$tmp/%%;
200
$has_module = 1 if /\.so$/;
203
if ($dh{V_FLAG_SET}) {
204
$verdeps{$usepython} |= SO_MODULE_NONSTANDARD;
213
# Dependencies on current python
214
$dep_on_python = 1 if $deps;
215
$strong_dep = 1 if($deps & (PY_MODULE|SO_MODULE));
217
if ($dep_on_python) {
218
addsubstvar($package, "python:Depends", $python, ">= $python_version");
220
addsubstvar($package, "python:Depends", $python, "<< $python_nextversion");
222
addsubstvar($package, "python:Depends", $python, "<< $python_nextmajor");
228
# Look for specific pythonX.Y modules
229
foreach my $pyver (@python_allversions) {
230
my $pydir="/usr/lib/$pyver/site-packages";
231
if ($look_for_pythonXY) {
232
if (grep -d,"$tmp$pydir") {
236
$verdeps{$pyver} |= PY_MODULE;
237
doit(("rm","-f",$_."c",$_."o"));
239
$verdeps{$pyver} |= SO_MODULE if /\.so$/;
244
# Go for the dependencies
245
addsubstvar($package, "python:Depends", $pyver) if $verdeps{$pyver};
247
# And now, the postinst and prerm stuff
248
if ($pyver eq "$usepython") {
249
if ($verdeps{$pyver} & PY_MODULE) {
250
$pydir = $pydir.$dirlist;
254
$verdeps{$pyver} |= PY_MODULE if($deps & PY_MODULE);
256
if ($verdeps{$pyver} & (PY_MODULE|PY_MODULE_NONSTANDARD) && ! $dh{NOSCRIPTS}) {
257
autoscript($package,"postinst","postinst-python","s%#PYVER#%$pyver%;s%#DIRLIST#%$pydir%");
261
if ($need_prerm && ! $dh{NOSCRIPTS}) {
262
autoscript($package,"prerm","prerm-python","s%#PACKAGE#%$package%");
270
This program is a part of debhelper.
274
Josselin Mouette <joss@debian.org>
276
most ideas stolen from Brendan O'Dea <bod@debian.org>