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 set this option with the desired X.Y python
55 Do not use if you ship modules in /usr/lib/site-python.
57 =item B<-n>, B<--noscripts>
59 Do not modify postinst/postrm scripts.
65 Debian policy, version 3.5.7
67 Python policy, version 0.3.7
73 my $python = 'python';
75 # The current python major version
77 my $python_version = `$python -V 2>&1`;
78 if ("$python_version" eq "") {
79 error("Python is not installed, aborting. (Probably forgot to Build-Depend on python.)");
81 elsif ($python_version =~ m/^Python\s+(\d+)\.(\d+)(\.\d+)*/) {
82 $python_version = "$1.$2" ;
85 error("Unable to parse python version out of \"$python_version\".");
88 # The next python version
89 my $python_nextversion = $python_version + 0.1;
90 my $python_nextmajor = $python_major + 1;
92 my @python_allversions = ('1.5','2.1','2.2','2.3');
93 foreach (@python_allversions) {
98 my $usepython = "python$python_version";
100 $usepython = $dh{V_FLAG};
101 $usepython =~ s/^/python/;
104 # Cleaning the paths given on the command line
111 use constant PROGRAM => 1;
112 use constant PY_MODULE => 2;
113 use constant PY_MODULE_NONSTANDARD => 4;
114 use constant SO_MODULE => 8;
115 use constant SO_MODULE_NONSTANDARD => 16;
117 foreach my $package (@{$dh{DOPACKAGES}}) {
118 my $tmp = tmpdir($package);
120 delsubstvar($package, "python:Depends");
122 my @dirs = ("usr/lib/site-python", "usr/lib/$package", "usr/share/$package", "usr/lib/games/$package", "usr/share/games/$package", @ARGV );
123 my @dirs_so = ("usr/lib/site-python", @ARGV );
125 my $dep_on_python = 0;
127 my $look_for_pythonXY = 1;
129 # First, the case of python-foo and pythonX.Y-foo
130 if ($package =~ /^python-/) {
134 $pack =~ s/^python/python$python_version/;
135 if (grep { "$_" eq "$pack" } GetPackages()) {
136 addsubstvar($package, "python:Depends", $pack);
139 if ($package !~ /^python[0-9].[0-9]-/) {
140 push @dirs, "usr/lib/python$python_version/site-packages" ;
141 push @dirs_so, "usr/lib/python$python_version/site-packages" ;
142 $look_for_pythonXY = 0;
145 @dirs = grep -d, map "$tmp/$_", @dirs;
146 @dirs_so = grep -d, map "$tmp/$_", @dirs_so;
150 foreach (@python_allversions) {
156 return unless -f and (-x or /\.py$/);
158 return unless open F, $_;
159 if (read F, local $_, 32 and m%^#!\s*/usr/bin/(env\s+)?(python(\d+\.\d+)?)\s%) {
160 if ( "python" eq $2 ) {
162 } elsif(defined $verdeps{$2}) {
163 $verdeps{$2} |= PROGRAM;
169 # Look for python modules
172 foreach my $curdir (@dirs) {
174 $curdir =~ s%^$tmp/%%;
179 doit(("rm","-f",$_."c",$_."o"));
183 if ($dh{V_FLAG_SET}) {
184 $verdeps{$usepython} |= PY_MODULE_NONSTANDARD;
188 $dirlist="$dirlist /$curdir";
193 foreach my $curdir (@dirs_so) {
195 $curdir =~ s%^$tmp/%%;
198 $has_module = 1 if /\.so$/;
201 if ($dh{V_FLAG_SET}) {
202 $verdeps{$usepython} |= SO_MODULE_NONSTANDARD;
211 # Dependencies on current python
212 $dep_on_python = 1 if $deps;
213 $strong_dep = 1 if($deps & (PY_MODULE|SO_MODULE));
215 if ($dep_on_python) {
216 addsubstvar($package, "python:Depends", $python, ">= $python_version");
218 addsubstvar($package, "python:Depends", $python, "<< $python_nextversion");
220 addsubstvar($package, "python:Depends", $python, "<< $python_nextmajor");
226 # Look for specific pythonX.Y modules
227 foreach my $pyver (@python_allversions) {
228 my $pydir="/usr/lib/$pyver/site-packages";
229 if ($look_for_pythonXY) {
230 if (grep -d,"$tmp$pydir") {
234 $verdeps{$pyver} |= PY_MODULE;
235 doit(("rm","-f",$_."c",$_."o"));
237 $verdeps{$pyver} |= SO_MODULE if /\.so$/;
242 # Go for the dependencies
243 addsubstvar($package, "python:Depends", $pyver) if $verdeps{$pyver};
245 # And now, the postinst and prerm stuff
246 if ($pyver eq "$usepython") {
247 if ($verdeps{$pyver} & PY_MODULE) {
248 $pydir = $pydir.$dirlist;
252 $verdeps{$pyver} |= PY_MODULE if($deps & PY_MODULE);
254 if ($verdeps{$pyver} & (PY_MODULE|PY_MODULE_NONSTANDARD) && ! $dh{NOSCRIPTS}) {
255 autoscript($package,"postinst","postinst-python","s%#PYVER#%$pyver%;s%#DIRLIST#%$pydir%");
259 if ($need_prerm && ! $dh{NOSCRIPTS}) {
260 autoscript($package,"prerm","prerm-python","s%#PACKAGE#%$package%");
268 This program is a part of debhelper.
272 Josselin Mouette <joss@debian.org>
274 most ideas stolen from Brendan O'Dea <bod@debian.org>