annotate Lib/distutils/command/install_lib.py @ 74135:9c19df6c8ea0 3.2

News entry for Issue12798
author Senthil Kumaran <senthil@uthcode.com>
date Fri, 23 Dec 2011 11:11:21 +0800
parents 3e4c0caf56a8
children 30aa032c4bd0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
51195
e67dc4db964c Merged revisions 68840,68881,68943,68945 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 43026
diff changeset
1 """distutils.command.install_lib
e67dc4db964c Merged revisions 68840,68881,68943,68945 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 43026
diff changeset
2
e67dc4db964c Merged revisions 68840,68881,68943,68945 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 43026
diff changeset
3 Implements the Distutils 'install_lib' command
e67dc4db964c Merged revisions 68840,68881,68943,68945 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 43026
diff changeset
4 (install all Python modules)."""
e67dc4db964c Merged revisions 68840,68881,68943,68945 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 43026
diff changeset
5
53974
5224a258d5bb Merged revisions 72535 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 51195
diff changeset
6 import os
73322
ea926dff958f More fixes for PEP 3147 compliance in distutils (#11254)
Éric Araujo <merwok@netwok.org>
parents: 71540
diff changeset
7 import imp
56741
a3cb812d80f9 Merged revisions 75704 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54015
diff changeset
8 import sys
a3cb812d80f9 Merged revisions 75704 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54015
diff changeset
9
10437
3bc8f53041c0 First checkin of real Distutils command modules.
Greg Ward <gward@python.net>
parents:
diff changeset
10 from distutils.core import Command
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
11 from distutils.errors import DistutilsOptionError
10437
3bc8f53041c0 First checkin of real Distutils command modules.
Greg Ward <gward@python.net>
parents:
diff changeset
12
32841
0856d98e2a68 Since build_py handles package data installation, the list of outputs
Fred Drake <fdrake@acm.org>
parents: 26285
diff changeset
13
0856d98e2a68 Since build_py handles package data installation, the list of outputs
Fred Drake <fdrake@acm.org>
parents: 26285
diff changeset
14 # Extension for Python source files.
42622
4d2aa4bfb2d6 Remove RISCOS support
Skip Montanaro <skip@pobox.com>
parents: 41480
diff changeset
15 PYTHON_SOURCE_EXTENSION = ".py"
32841
0856d98e2a68 Since build_py handles package data installation, the list of outputs
Fred Drake <fdrake@acm.org>
parents: 26285
diff changeset
16
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42622
diff changeset
17 class install_lib(Command):
10437
3bc8f53041c0 First checkin of real Distutils command modules.
Greg Ward <gward@python.net>
parents:
diff changeset
18
12730
147d0b4144ea Fixed command description.
Greg Ward <gward@python.net>
parents: 12721
diff changeset
19 description = "install all Python modules (extensions and pure Python)"
11683
47f75a17b103 Added 'description' class attribute to every command class (to help the
Greg Ward <gward@python.net>
parents: 11680
diff changeset
20
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
21 # The byte-compilation options are a tad confusing. Here are the
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
22 # possible scenarios:
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
23 # 1) no compilation at all (--no-compile --no-optimize)
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
24 # 2) compile .pyc only (--compile --no-optimize; default)
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
25 # 3) compile .pyc and "level 1" .pyo (--compile --optimize)
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
26 # 4) compile "level 1" .pyo only (--no-compile --optimize)
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
27 # 5) compile .pyc and "level 2" .pyo (--compile --optimize-more)
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
28 # 6) compile "level 2" .pyo only (--no-compile --optimize-more)
21268
d296e6bb17e5 Whitespace normalization.
Fred Drake <fdrake@acm.org>
parents: 14984
diff changeset
29 #
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
30 # The UI for this is two option, 'compile' and 'optimize'.
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
31 # 'compile' is strictly boolean, and only decides whether to
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
32 # generate .pyc files. 'optimize' is three-way (0, 1, or 2), and
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
33 # decides both whether to generate .pyo files and what level of
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
34 # optimization to use.
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
35
11815
03902bc0214a Renamed all 'options' class attributes to 'user_options'.
Greg Ward <gward@python.net>
parents: 11813
diff changeset
36 user_options = [
03902bc0214a Renamed all 'options' class attributes to 'user_options'.
Greg Ward <gward@python.net>
parents: 11813
diff changeset
37 ('install-dir=', 'd', "directory to install to"),
03902bc0214a Renamed all 'options' class attributes to 'user_options'.
Greg Ward <gward@python.net>
parents: 11813
diff changeset
38 ('build-dir=','b', "build directory (where to install from)"),
14540
35ae8dff8ed0 Added --force (-f) option to force installation (including bytecode
Greg Ward <gward@python.net>
parents: 13871
diff changeset
39 ('force', 'f', "force installation (overwrite existing files)"),
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
40 ('compile', 'c', "compile .py to .pyc [default]"),
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
41 ('no-compile', None, "don't compile .py files"),
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
42 ('optimize=', 'O',
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
43 "also compile with optimization: -O1 for \"python -O\", "
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
44 "-O2 for \"python -OO\", and -O0 to disable [default: -O0]"),
12680
b89da202d18d Added --skip-build option, so lazy debuggers/testers (mainly me) don't
Gregory P. Smith <greg@mad-scientist.com>
parents: 12603
diff changeset
45 ('skip-build', None, "skip the build steps"),
11815
03902bc0214a Renamed all 'options' class attributes to 'user_options'.
Greg Ward <gward@python.net>
parents: 11813
diff changeset
46 ]
21268
d296e6bb17e5 Whitespace normalization.
Fred Drake <fdrake@acm.org>
parents: 14984
diff changeset
47
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
48 boolean_options = ['force', 'compile', 'skip-build']
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
49 negative_opt = {'no-compile' : 'compile'}
14829
b1f220f636ed Added 'boolean_options' list to support config file parsing.
Greg Ward <gward@python.net>
parents: 14780
diff changeset
50
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42622
diff changeset
51 def initialize_options(self):
10437
3bc8f53041c0 First checkin of real Distutils command modules.
Greg Ward <gward@python.net>
parents:
diff changeset
52 # let the 'install' command dictate our installation directory
11338
42941e2eb9d8 Renamed many options to be consistent across commands.
Greg Ward <gward@python.net>
parents: 11283
diff changeset
53 self.install_dir = None
10437
3bc8f53041c0 First checkin of real Distutils command modules.
Greg Ward <gward@python.net>
parents:
diff changeset
54 self.build_dir = None
14540
35ae8dff8ed0 Added --force (-f) option to force installation (including bytecode
Greg Ward <gward@python.net>
parents: 13871
diff changeset
55 self.force = 0
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
56 self.compile = None
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
57 self.optimize = None
12680
b89da202d18d Added --skip-build option, so lazy debuggers/testers (mainly me) don't
Gregory P. Smith <greg@mad-scientist.com>
parents: 12603
diff changeset
58 self.skip_build = None
10437
3bc8f53041c0 First checkin of real Distutils command modules.
Greg Ward <gward@python.net>
parents:
diff changeset
59
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42622
diff changeset
60 def finalize_options(self):
11283
cdd928d2293c Changed selection of installation directories (in 'set_final_options()')
Greg Ward <gward@python.net>
parents: 11248
diff changeset
61 # Get all the information we need to install pure Python modules
cdd928d2293c Changed selection of installation directories (in 'set_final_options()')
Greg Ward <gward@python.net>
parents: 11248
diff changeset
62 # from the umbrella 'install' command -- build (source) directory,
cdd928d2293c Changed selection of installation directories (in 'set_final_options()')
Greg Ward <gward@python.net>
parents: 11248
diff changeset
63 # install (target) directory, and whether to compile .py files.
14779
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
64 self.set_undefined_options('install',
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
65 ('build_lib', 'build_dir'),
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
66 ('install_lib', 'install_dir'),
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
67 ('force', 'force'),
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
68 ('compile', 'compile'),
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
69 ('optimize', 'optimize'),
14779
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
70 ('skip_build', 'skip_build'),
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
71 )
10437
3bc8f53041c0 First checkin of real Distutils command modules.
Greg Ward <gward@python.net>
parents:
diff changeset
72
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
73 if self.compile is None:
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42622
diff changeset
74 self.compile = True
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
75 if self.optimize is None:
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42622
diff changeset
76 self.optimize = False
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
77
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42622
diff changeset
78 if not isinstance(self.optimize, int):
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
79 try:
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
80 self.optimize = int(self.optimize)
54015
54604688b3e9 Merged revisions 72577 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 53974
diff changeset
81 if self.optimize not in (0, 1, 2):
54604688b3e9 Merged revisions 72577 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 53974
diff changeset
82 raise AssertionError
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
83 except (ValueError, AssertionError):
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42622
diff changeset
84 raise DistutilsOptionError("optimize must be 0, 1, or 2")
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
85
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42622
diff changeset
86 def run(self):
12098
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
87 # Make sure we have built everything we need first
14780
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
88 self.build()
21268
d296e6bb17e5 Whitespace normalization.
Fred Drake <fdrake@acm.org>
parents: 14984
diff changeset
89
14780
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
90 # Install everything: simply dump the entire contents of the build
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
91 # directory to the installation directory (that's the beauty of
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
92 # having a build directory!)
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
93 outfiles = self.install()
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
94
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
95 # (Optionally) compile .py to .pyc
14959
b031abca3e91 From 'run()', only call 'bytecompile()' if we actually have
Greg Ward <gward@python.net>
parents: 14952
diff changeset
96 if outfiles is not None and self.distribution.has_pure_modules():
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
97 self.byte_compile(outfiles)
14780
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
98
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
99 # -- Top-level worker functions ------------------------------------
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
100 # (called from 'run()')
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
101
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42622
diff changeset
102 def build(self):
12680
b89da202d18d Added --skip-build option, so lazy debuggers/testers (mainly me) don't
Gregory P. Smith <greg@mad-scientist.com>
parents: 12603
diff changeset
103 if not self.skip_build:
b89da202d18d Added --skip-build option, so lazy debuggers/testers (mainly me) don't
Gregory P. Smith <greg@mad-scientist.com>
parents: 12603
diff changeset
104 if self.distribution.has_pure_modules():
14779
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
105 self.run_command('build_py')
12680
b89da202d18d Added --skip-build option, so lazy debuggers/testers (mainly me) don't
Gregory P. Smith <greg@mad-scientist.com>
parents: 12603
diff changeset
106 if self.distribution.has_ext_modules():
14779
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
107 self.run_command('build_ext')
21268
d296e6bb17e5 Whitespace normalization.
Fred Drake <fdrake@acm.org>
parents: 14984
diff changeset
108
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42622
diff changeset
109 def install(self):
12721
a598ace01943 Check if the claimed build directory doesn't exist, and warn that we don't
Greg Ward <gward@python.net>
parents: 12696
diff changeset
110 if os.path.isdir(self.build_dir):
14779
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
111 outfiles = self.copy_tree(self.build_dir, self.install_dir)
12721
a598ace01943 Check if the claimed build directory doesn't exist, and warn that we don't
Greg Ward <gward@python.net>
parents: 12696
diff changeset
112 else:
a598ace01943 Check if the claimed build directory doesn't exist, and warn that we don't
Greg Ward <gward@python.net>
parents: 12696
diff changeset
113 self.warn("'%s' does not exist -- no Python modules to install" %
a598ace01943 Check if the claimed build directory doesn't exist, and warn that we don't
Greg Ward <gward@python.net>
parents: 12696
diff changeset
114 self.build_dir)
a598ace01943 Check if the claimed build directory doesn't exist, and warn that we don't
Greg Ward <gward@python.net>
parents: 12696
diff changeset
115 return
14780
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
116 return outfiles
12098
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
117
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42622
diff changeset
118 def byte_compile(self, files):
56741
a3cb812d80f9 Merged revisions 75704 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54015
diff changeset
119 if sys.dont_write_bytecode:
a3cb812d80f9 Merged revisions 75704 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54015
diff changeset
120 self.warn('byte-compiling is disabled, skipping.')
a3cb812d80f9 Merged revisions 75704 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54015
diff changeset
121 return
a3cb812d80f9 Merged revisions 75704 via svnmerge from
Tarek Ziadé <ziade.tarek@gmail.com>
parents: 54015
diff changeset
122
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
123 from distutils.util import byte_compile
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
124
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
125 # Get the "--root" directory supplied to the "install" command,
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
126 # and use it as a prefix to strip off the purported filename
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
127 # encoded in bytecode files. This is far from complete, but it
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
128 # should at least generate usable bytecode in RPM distributions.
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
129 install_root = self.get_finalized_command('install').root
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
130
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
131 if self.compile:
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
132 byte_compile(files, optimize=0,
23668
ca87119255eb Make setup.py less chatty by default.
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 23587
diff changeset
133 force=self.force, prefix=install_root,
ca87119255eb Make setup.py less chatty by default.
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 23587
diff changeset
134 dry_run=self.dry_run)
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
135 if self.optimize > 0:
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
136 byte_compile(files, optimize=self.optimize,
23668
ca87119255eb Make setup.py less chatty by default.
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 23587
diff changeset
137 force=self.force, prefix=install_root,
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
138 verbose=self.verbose, dry_run=self.dry_run)
14780
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
139
10437
3bc8f53041c0 First checkin of real Distutils command modules.
Greg Ward <gward@python.net>
parents:
diff changeset
140
14780
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
141 # -- Utility methods -----------------------------------------------
12098
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
142
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42622
diff changeset
143 def _mutate_outputs(self, has_any, build_cmd, cmd_option, output_dir):
12098
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
144 if not has_any:
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
145 return []
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
146
14779
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
147 build_cmd = self.get_finalized_command(build_cmd)
12098
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
148 build_files = build_cmd.get_outputs()
14779
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
149 build_dir = getattr(build_cmd, cmd_option)
12098
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
150
14779
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
151 prefix_len = len(build_dir) + len(os.sep)
12098
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
152 outputs = []
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
153 for file in build_files:
14779
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
154 outputs.append(os.path.join(output_dir, file[prefix_len:]))
12098
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
155
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
156 return outputs
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
157
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42622
diff changeset
158 def _bytecode_filenames(self, py_filenames):
12696
a49e450688e2 Added '_bytecode_filenames()' method, and use it in 'get_outputs()'
Gregory P. Smith <greg@mad-scientist.com>
parents: 12680
diff changeset
159 bytecode_files = []
a49e450688e2 Added '_bytecode_filenames()' method, and use it in 'get_outputs()'
Gregory P. Smith <greg@mad-scientist.com>
parents: 12680
diff changeset
160 for py_file in py_filenames:
32841
0856d98e2a68 Since build_py handles package data installation, the list of outputs
Fred Drake <fdrake@acm.org>
parents: 26285
diff changeset
161 # Since build_py handles package data installation, the
0856d98e2a68 Since build_py handles package data installation, the list of outputs
Fred Drake <fdrake@acm.org>
parents: 26285
diff changeset
162 # list of outputs can contain more than just .py files.
0856d98e2a68 Since build_py handles package data installation, the list of outputs
Fred Drake <fdrake@acm.org>
parents: 26285
diff changeset
163 # Make sure we only report bytecode for the .py files.
0856d98e2a68 Since build_py handles package data installation, the list of outputs
Fred Drake <fdrake@acm.org>
parents: 26285
diff changeset
164 ext = os.path.splitext(os.path.normcase(py_file))[1]
0856d98e2a68 Since build_py handles package data installation, the list of outputs
Fred Drake <fdrake@acm.org>
parents: 26285
diff changeset
165 if ext != PYTHON_SOURCE_EXTENSION:
0856d98e2a68 Since build_py handles package data installation, the list of outputs
Fred Drake <fdrake@acm.org>
parents: 26285
diff changeset
166 continue
14961
ebaeb19e0380 Finished the overhaul of byte-compilation options: there's now a 6-way
Greg Ward <gward@python.net>
parents: 14959
diff changeset
167 if self.compile:
73322
ea926dff958f More fixes for PEP 3147 compliance in distutils (#11254)
Éric Araujo <merwok@netwok.org>
parents: 71540
diff changeset
168 bytecode_files.append(imp.cache_from_source(
ea926dff958f More fixes for PEP 3147 compliance in distutils (#11254)
Éric Araujo <merwok@netwok.org>
parents: 71540
diff changeset
169 py_file, debug_override=True))
14964
54ec5ec32352 Typo fix.
Greg Ward <gward@python.net>
parents: 14961
diff changeset
170 if self.optimize > 0:
73322
ea926dff958f More fixes for PEP 3147 compliance in distutils (#11254)
Éric Araujo <merwok@netwok.org>
parents: 71540
diff changeset
171 bytecode_files.append(imp.cache_from_source(
ea926dff958f More fixes for PEP 3147 compliance in distutils (#11254)
Éric Araujo <merwok@netwok.org>
parents: 71540
diff changeset
172 py_file, debug_override=False))
12696
a49e450688e2 Added '_bytecode_filenames()' method, and use it in 'get_outputs()'
Gregory P. Smith <greg@mad-scientist.com>
parents: 12680
diff changeset
173
a49e450688e2 Added '_bytecode_filenames()' method, and use it in 'get_outputs()'
Gregory P. Smith <greg@mad-scientist.com>
parents: 12680
diff changeset
174 return bytecode_files
21268
d296e6bb17e5 Whitespace normalization.
Fred Drake <fdrake@acm.org>
parents: 14984
diff changeset
175
14780
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
176
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
177 # -- External interface --------------------------------------------
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
178 # (called by outsiders)
064e434e744f Split 'run()' up into 'build()', 'install()', and 'bytecompile()' (for
Greg Ward <gward@python.net>
parents: 14779
diff changeset
179
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42622
diff changeset
180 def get_outputs(self):
12098
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
181 """Return the list of files that would be installed if this command
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
182 were actually run. Not affected by the "dry-run" flag or whether
14779
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
183 modules have actually been built yet.
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
184 """
12098
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
185 pure_outputs = \
14779
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
186 self._mutate_outputs(self.distribution.has_pure_modules(),
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
187 'build_py', 'build_lib',
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
188 self.install_dir)
12696
a49e450688e2 Added '_bytecode_filenames()' method, and use it in 'get_outputs()'
Gregory P. Smith <greg@mad-scientist.com>
parents: 12680
diff changeset
189 if self.compile:
a49e450688e2 Added '_bytecode_filenames()' method, and use it in 'get_outputs()'
Gregory P. Smith <greg@mad-scientist.com>
parents: 12680
diff changeset
190 bytecode_outputs = self._bytecode_filenames(pure_outputs)
a49e450688e2 Added '_bytecode_filenames()' method, and use it in 'get_outputs()'
Gregory P. Smith <greg@mad-scientist.com>
parents: 12680
diff changeset
191 else:
a49e450688e2 Added '_bytecode_filenames()' method, and use it in 'get_outputs()'
Gregory P. Smith <greg@mad-scientist.com>
parents: 12680
diff changeset
192 bytecode_outputs = []
12098
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
193
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
194 ext_outputs = \
14779
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
195 self._mutate_outputs(self.distribution.has_ext_modules(),
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
196 'build_ext', 'build_lib',
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
197 self.install_dir)
12098
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
198
12696
a49e450688e2 Added '_bytecode_filenames()' method, and use it in 'get_outputs()'
Gregory P. Smith <greg@mad-scientist.com>
parents: 12680
diff changeset
199 return pure_outputs + bytecode_outputs + ext_outputs
12098
881257d1e854 Be sure to run both 'build_py' and 'build_ext', now that this command
Greg Ward <gward@python.net>
parents: 12042
diff changeset
200
43026
a6d3930b5613 General cleanup, raise normalization in Lib/distutils.
Collin Winter <collinw@gmail.com>
parents: 42622
diff changeset
201 def get_inputs(self):
12154
78e36e06e536 Added 'get_inputs()'.
Greg Ward <gward@python.net>
parents: 12106
diff changeset
202 """Get the list of files that are input to this command, ie. the
78e36e06e536 Added 'get_inputs()'.
Greg Ward <gward@python.net>
parents: 12106
diff changeset
203 files that get installed as they are named in the build tree.
78e36e06e536 Added 'get_inputs()'.
Greg Ward <gward@python.net>
parents: 12106
diff changeset
204 The files in this list correspond one-to-one to the output
14779
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
205 filenames returned by 'get_outputs()'.
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
206 """
12154
78e36e06e536 Added 'get_inputs()'.
Greg Ward <gward@python.net>
parents: 12106
diff changeset
207 inputs = []
21268
d296e6bb17e5 Whitespace normalization.
Fred Drake <fdrake@acm.org>
parents: 14984
diff changeset
208
12154
78e36e06e536 Added 'get_inputs()'.
Greg Ward <gward@python.net>
parents: 12106
diff changeset
209 if self.distribution.has_pure_modules():
14779
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
210 build_py = self.get_finalized_command('build_py')
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
211 inputs.extend(build_py.get_outputs())
12154
78e36e06e536 Added 'get_inputs()'.
Greg Ward <gward@python.net>
parents: 12106
diff changeset
212
78e36e06e536 Added 'get_inputs()'.
Greg Ward <gward@python.net>
parents: 12106
diff changeset
213 if self.distribution.has_ext_modules():
14779
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
214 build_ext = self.get_finalized_command('build_ext')
7ba493bc24a0 Whitespace tweaks.
Greg Ward <gward@python.net>
parents: 14540
diff changeset
215 inputs.extend(build_ext.get_outputs())
12154
78e36e06e536 Added 'get_inputs()'.
Greg Ward <gward@python.net>
parents: 12106
diff changeset
216
78e36e06e536 Added 'get_inputs()'.
Greg Ward <gward@python.net>
parents: 12106
diff changeset
217 return inputs