blob: 64f63add57f1750dc14b19dbc2b3c5a238739629 [file] [log] [blame]
Greg Wardfe6462c2000-04-04 01:40:52 +00001"""distutils.dist
2
3Provides the Distribution class, which represents the module distribution
Greg Ward8ff5a3f2000-06-02 00:44:53 +00004being built/installed/distributed.
5"""
Greg Wardfe6462c2000-04-04 01:40:52 +00006
7# created 2000/04/03, Greg Ward
8# (extricated from core.py; actually dates back to the beginning)
9
10__revision__ = "$Id$"
11
Gregory P. Smith14263542000-05-12 00:41:33 +000012import sys, os, string, re
Greg Wardfe6462c2000-04-04 01:40:52 +000013from types import *
14from copy import copy
15from distutils.errors import *
Greg Ward36c36fe2000-05-20 14:07:59 +000016from distutils import sysconfig
Greg Ward82715e12000-04-21 02:28:14 +000017from distutils.fancy_getopt import FancyGetopt, longopt_xlate
Gregory P. Smith14263542000-05-12 00:41:33 +000018from distutils.util import check_environ
Greg Wardfe6462c2000-04-04 01:40:52 +000019
20
21# Regex to define acceptable Distutils command names. This is not *quite*
22# the same as a Python NAME -- I don't allow leading underscores. The fact
23# that they're very similar is no coincidence; the default naming scheme is
24# to look for a Python module named after the command.
25command_re = re.compile (r'^[a-zA-Z]([a-zA-Z0-9_]*)$')
26
27
28class Distribution:
Greg Ward8ff5a3f2000-06-02 00:44:53 +000029 """The core of the Distutils. Most of the work hiding behind 'setup'
30 is really done within a Distribution instance, which farms the work out
31 to the Distutils commands specified on the command line.
Greg Wardfe6462c2000-04-04 01:40:52 +000032
Greg Ward8ff5a3f2000-06-02 00:44:53 +000033 Setup scripts will almost never instantiate Distribution directly,
34 unless the 'setup()' function is totally inadequate to their needs.
35 However, it is conceivable that a setup script might wish to subclass
36 Distribution for some specialized purpose, and then pass the subclass
37 to 'setup()' as the 'distclass' keyword argument. If so, it is
38 necessary to respect the expectations that 'setup' has of Distribution.
39 See the code for 'setup()', in core.py, for details.
40 """
Greg Wardfe6462c2000-04-04 01:40:52 +000041
42
43 # 'global_options' describes the command-line options that may be
Greg Ward82715e12000-04-21 02:28:14 +000044 # supplied to the setup script prior to any actual commands.
45 # Eg. "./setup.py -n" or "./setup.py --quiet" both take advantage of
Greg Wardfe6462c2000-04-04 01:40:52 +000046 # these global options. This list should be kept to a bare minimum,
47 # since every global option is also valid as a command option -- and we
48 # don't want to pollute the commands with too many options that they
49 # have minimal control over.
Greg Wardd5d8a992000-05-23 01:42:17 +000050 global_options = [('verbose', 'v', "run verbosely (default)"),
51 ('quiet', 'q', "run quietly (turns verbosity off)"),
52 ('dry-run', 'n', "don't actually do anything"),
53 ('help', 'h', "show detailed help message"),
Greg Wardfe6462c2000-04-04 01:40:52 +000054 ]
Greg Ward82715e12000-04-21 02:28:14 +000055
56 # options that are not propagated to the commands
57 display_options = [
58 ('help-commands', None,
59 "list all available commands"),
60 ('name', None,
61 "print package name"),
62 ('version', 'V',
63 "print package version"),
64 ('fullname', None,
65 "print <package name>-<version>"),
66 ('author', None,
67 "print the author's name"),
68 ('author-email', None,
69 "print the author's email address"),
70 ('maintainer', None,
71 "print the maintainer's name"),
72 ('maintainer-email', None,
73 "print the maintainer's email address"),
74 ('contact', None,
Greg Wardd5d8a992000-05-23 01:42:17 +000075 "print the maintainer's name if known, else the author's"),
Greg Ward82715e12000-04-21 02:28:14 +000076 ('contact-email', None,
Greg Wardd5d8a992000-05-23 01:42:17 +000077 "print the maintainer's email address if known, else the author's"),
Greg Ward82715e12000-04-21 02:28:14 +000078 ('url', None,
79 "print the URL for this package"),
80 ('licence', None,
81 "print the licence of the package"),
82 ('license', None,
83 "alias for --licence"),
84 ('description', None,
85 "print the package description"),
Greg Warde5a584e2000-04-26 02:26:55 +000086 ('long-description', None,
87 "print the long package description"),
Greg Ward82715e12000-04-21 02:28:14 +000088 ]
89 display_option_names = map(lambda x: string.translate(x[0], longopt_xlate),
90 display_options)
91
92 # negative options are options that exclude other options
Greg Wardfe6462c2000-04-04 01:40:52 +000093 negative_opt = {'quiet': 'verbose'}
94
95
96 # -- Creation/initialization methods -------------------------------
97
98 def __init__ (self, attrs=None):
99 """Construct a new Distribution instance: initialize all the
Greg Ward8ff5a3f2000-06-02 00:44:53 +0000100 attributes of a Distribution, and then use 'attrs' (a dictionary
101 mapping attribute names to values) to assign some of those
102 attributes their "real" values. (Any attributes not mentioned in
103 'attrs' will be assigned to some null value: 0, None, an empty list
104 or dictionary, etc.) Most importantly, initialize the
105 'command_obj' attribute to the empty dictionary; this will be
106 filled in with real command objects by 'parse_command_line()'.
107 """
Greg Wardfe6462c2000-04-04 01:40:52 +0000108
109 # Default values for our command-line options
110 self.verbose = 1
111 self.dry_run = 0
Greg Wardfe6462c2000-04-04 01:40:52 +0000112 self.help = 0
Greg Ward82715e12000-04-21 02:28:14 +0000113 for attr in self.display_option_names:
114 setattr(self, attr, 0)
Greg Wardfe6462c2000-04-04 01:40:52 +0000115
Greg Ward82715e12000-04-21 02:28:14 +0000116 # Store the distribution meta-data (name, version, author, and so
117 # forth) in a separate object -- we're getting to have enough
118 # information here (and enough command-line options) that it's
119 # worth it. Also delegate 'get_XXX()' methods to the 'metadata'
120 # object in a sneaky and underhanded (but efficient!) way.
121 self.metadata = DistributionMetadata ()
Greg Ward4982f982000-04-22 02:52:44 +0000122 method_basenames = dir(self.metadata) + \
123 ['fullname', 'contact', 'contact_email']
124 for basename in method_basenames:
125 method_name = "get_" + basename
126 setattr(self, method_name, getattr(self.metadata, method_name))
Greg Wardfe6462c2000-04-04 01:40:52 +0000127
128 # 'cmdclass' maps command names to class objects, so we
129 # can 1) quickly figure out which class to instantiate when
130 # we need to create a new command object, and 2) have a way
Greg Ward82715e12000-04-21 02:28:14 +0000131 # for the setup script to override command classes
Greg Wardfe6462c2000-04-04 01:40:52 +0000132 self.cmdclass = {}
133
Greg Wardd5d8a992000-05-23 01:42:17 +0000134 # 'command_options' is where we store command options between
135 # parsing them (from config files, the command-line, etc.) and when
136 # they are actually needed -- ie. when the command in question is
137 # instantiated. It is a dictionary of dictionaries of 2-tuples:
138 # command_options = { command_name : { option : (source, value) } }
Gregory P. Smith14263542000-05-12 00:41:33 +0000139 self.command_options = {}
140
Greg Wardfe6462c2000-04-04 01:40:52 +0000141 # These options are really the business of various commands, rather
142 # than of the Distribution itself. We provide aliases for them in
143 # Distribution as a convenience to the developer.
Greg Wardfe6462c2000-04-04 01:40:52 +0000144 self.packages = None
145 self.package_dir = None
146 self.py_modules = None
147 self.libraries = None
Greg Ward51def7d2000-05-27 01:36:14 +0000148 self.headers = None
Greg Wardfe6462c2000-04-04 01:40:52 +0000149 self.ext_modules = None
150 self.ext_package = None
151 self.include_dirs = None
152 self.extra_path = None
Gregory P. Smithb2e3bb32000-05-12 00:52:23 +0000153 self.scripts = None
Gregory P. Smith6a901dd2000-05-13 03:09:50 +0000154 self.data_files = None
Greg Wardfe6462c2000-04-04 01:40:52 +0000155
156 # And now initialize bookkeeping stuff that can't be supplied by
157 # the caller at all. 'command_obj' maps command names to
158 # Command instances -- that's how we enforce that every command
159 # class is a singleton.
160 self.command_obj = {}
161
162 # 'have_run' maps command names to boolean values; it keeps track
163 # of whether we have actually run a particular command, to make it
164 # cheap to "run" a command whenever we think we might need to -- if
165 # it's already been done, no need for expensive filesystem
166 # operations, we just check the 'have_run' dictionary and carry on.
167 # It's only safe to query 'have_run' for a command class that has
168 # been instantiated -- a false value will be inserted when the
169 # command object is created, and replaced with a true value when
170 # the command is succesfully run. Thus it's probably best to use
171 # '.get()' rather than a straight lookup.
172 self.have_run = {}
173
174 # Now we'll use the attrs dictionary (ultimately, keyword args from
Greg Ward82715e12000-04-21 02:28:14 +0000175 # the setup script) to possibly override any or all of these
176 # distribution options.
177
Greg Wardfe6462c2000-04-04 01:40:52 +0000178 if attrs:
179
180 # Pull out the set of command options and work on them
181 # specifically. Note that this order guarantees that aliased
182 # command options will override any supplied redundantly
183 # through the general options dictionary.
184 options = attrs.get ('options')
185 if options:
186 del attrs['options']
187 for (command, cmd_options) in options.items():
Greg Ward0e48cfd2000-05-26 01:00:15 +0000188 opt_dict = self.get_option_dict(command)
189 for (opt, val) in cmd_options.items():
190 opt_dict[opt] = ("setup script", val)
Greg Wardfe6462c2000-04-04 01:40:52 +0000191
192 # Now work on the rest of the attributes. Any attribute that's
193 # not already defined is invalid!
194 for (key,val) in attrs.items():
Greg Ward82715e12000-04-21 02:28:14 +0000195 if hasattr (self.metadata, key):
196 setattr (self.metadata, key, val)
197 elif hasattr (self, key):
Greg Wardfe6462c2000-04-04 01:40:52 +0000198 setattr (self, key, val)
199 else:
Greg Ward02a1a2b2000-04-15 22:15:07 +0000200 raise DistutilsSetupError, \
Greg Wardfe6462c2000-04-04 01:40:52 +0000201 "invalid distribution option '%s'" % key
202
203 # __init__ ()
204
205
Greg Ward0e48cfd2000-05-26 01:00:15 +0000206 def get_option_dict (self, command):
207 """Get the option dictionary for a given command. If that
208 command's option dictionary hasn't been created yet, then create it
209 and return the new dictionary; otherwise, return the existing
210 option dictionary.
211 """
212
213 dict = self.command_options.get(command)
214 if dict is None:
215 dict = self.command_options[command] = {}
216 return dict
217
218
Greg Wardc32d9a62000-05-28 23:53:06 +0000219 def dump_option_dicts (self, header=None, commands=None, indent=""):
220 from pprint import pformat
221
222 if commands is None: # dump all command option dicts
223 commands = self.command_options.keys()
224 commands.sort()
225
226 if header is not None:
227 print indent + header
228 indent = indent + " "
229
230 if not commands:
231 print indent + "no commands known yet"
232 return
233
234 for cmd_name in commands:
235 opt_dict = self.command_options.get(cmd_name)
236 if opt_dict is None:
237 print indent + "no option dict for '%s' command" % cmd_name
238 else:
239 print indent + "option dict for '%s' command:" % cmd_name
240 out = pformat(opt_dict)
241 for line in string.split(out, "\n"):
242 print indent + " " + line
243
244 # dump_option_dicts ()
245
246
247
Greg Wardd5d8a992000-05-23 01:42:17 +0000248 # -- Config file finding/parsing methods ---------------------------
249
Gregory P. Smith14263542000-05-12 00:41:33 +0000250 def find_config_files (self):
251 """Find as many configuration files as should be processed for this
252 platform, and return a list of filenames in the order in which they
253 should be parsed. The filenames returned are guaranteed to exist
254 (modulo nasty race conditions).
255
256 On Unix, there are three possible config files: pydistutils.cfg in
257 the Distutils installation directory (ie. where the top-level
258 Distutils __inst__.py file lives), .pydistutils.cfg in the user's
259 home directory, and setup.cfg in the current directory.
260
261 On Windows and Mac OS, there are two possible config files:
262 pydistutils.cfg in the Python installation directory (sys.prefix)
Greg Wardd5d8a992000-05-23 01:42:17 +0000263 and setup.cfg in the current directory.
264 """
Gregory P. Smith14263542000-05-12 00:41:33 +0000265 files = []
266 if os.name == "posix":
267 check_environ()
268
269 sys_dir = os.path.dirname(sys.modules['distutils'].__file__)
270 sys_file = os.path.join(sys_dir, "pydistutils.cfg")
271 if os.path.isfile(sys_file):
272 files.append(sys_file)
273
274 user_file = os.path.join(os.environ.get('HOME'),
275 ".pydistutils.cfg")
276 if os.path.isfile(user_file):
277 files.append(user_file)
278
279 else:
280 sys_file = os.path.join (sysconfig.PREFIX, "pydistutils.cfg")
281 if os.path.isfile(sys_file):
282 files.append(sys_file)
283
284 # All platforms support local setup.cfg
285 local_file = "setup.cfg"
286 if os.path.isfile(local_file):
287 files.append(local_file)
288
289 return files
290
291 # find_config_files ()
292
293
294 def parse_config_files (self, filenames=None):
295
296 from ConfigParser import ConfigParser
Greg Ward2bd3f422000-06-02 01:59:33 +0000297 from distutils.core import DEBUG
Gregory P. Smith14263542000-05-12 00:41:33 +0000298
299 if filenames is None:
300 filenames = self.find_config_files()
301
Greg Ward2bd3f422000-06-02 01:59:33 +0000302 if DEBUG: print "Distribution.parse_config_files():"
Greg Ward47460772000-05-23 03:47:35 +0000303
Gregory P. Smith14263542000-05-12 00:41:33 +0000304 parser = ConfigParser()
Greg Wardd5d8a992000-05-23 01:42:17 +0000305 for filename in filenames:
Greg Ward2bd3f422000-06-02 01:59:33 +0000306 if DEBUG: print " reading", filename
Greg Wardd5d8a992000-05-23 01:42:17 +0000307 parser.read(filename)
308 for section in parser.sections():
309 options = parser.options(section)
Greg Ward0e48cfd2000-05-26 01:00:15 +0000310 opt_dict = self.get_option_dict(section)
Gregory P. Smith14263542000-05-12 00:41:33 +0000311
Greg Wardd5d8a992000-05-23 01:42:17 +0000312 for opt in options:
313 if opt != '__name__':
Greg Ward0e48cfd2000-05-26 01:00:15 +0000314 opt_dict[opt] = (filename, parser.get(section,opt))
Gregory P. Smith14263542000-05-12 00:41:33 +0000315
Greg Ward47460772000-05-23 03:47:35 +0000316 # Make the ConfigParser forget everything (so we retain
317 # the original filenames that options come from) -- gag,
318 # retch, puke -- another good reason for a distutils-
319 # specific config parser (sigh...)
320 parser.__init__()
Gregory P. Smith14263542000-05-12 00:41:33 +0000321
322
Greg Wardd5d8a992000-05-23 01:42:17 +0000323 # -- Command-line parsing methods ----------------------------------
324
Greg Wardfe6462c2000-04-04 01:40:52 +0000325 def parse_command_line (self, args):
Greg Wardd5d8a992000-05-23 01:42:17 +0000326 """Parse the setup script's command line. 'args' must be a list
327 of command-line arguments, most likely 'sys.argv[1:]' (see the
328 'setup()' function). This list is first processed for "global
329 options" -- options that set attributes of the Distribution
330 instance. Then, it is alternately scanned for Distutils
331 commands and options for that command. Each new command
332 terminates the options for the previous command. The allowed
333 options for a command are determined by the 'user_options'
334 attribute of the command class -- thus, we have to be able to
335 load command classes in order to parse the command line. Any
336 error in that 'options' attribute raises DistutilsGetoptError;
337 any error on the command-line raises DistutilsArgError. If no
338 Distutils commands were found on the command line, raises
339 DistutilsArgError. Return true if command-line were
340 successfully parsed and we should carry on with executing
341 commands; false if no errors but we shouldn't execute commands
342 (currently, this only happens if user asks for help).
343 """
Greg Wardfe6462c2000-04-04 01:40:52 +0000344 # We have to parse the command line a bit at a time -- global
345 # options, then the first command, then its options, and so on --
346 # because each command will be handled by a different class, and
Greg Wardd5d8a992000-05-23 01:42:17 +0000347 # the options that are valid for a particular class aren't known
348 # until we have loaded the command class, which doesn't happen
349 # until we know what the command is.
Greg Wardfe6462c2000-04-04 01:40:52 +0000350
351 self.commands = []
Greg Ward82715e12000-04-21 02:28:14 +0000352 parser = FancyGetopt (self.global_options + self.display_options)
353 parser.set_negative_aliases (self.negative_opt)
Greg Ward58ec6ed2000-04-21 04:22:49 +0000354 parser.set_aliases ({'license': 'licence'})
Greg Ward82715e12000-04-21 02:28:14 +0000355 args = parser.getopt (object=self)
356 option_order = parser.get_option_order()
Greg Wardfe6462c2000-04-04 01:40:52 +0000357
Greg Ward82715e12000-04-21 02:28:14 +0000358 # for display options we return immediately
359 if self.handle_display_options(option_order):
Greg Wardfe6462c2000-04-04 01:40:52 +0000360 return
361
362 while args:
Greg Wardd5d8a992000-05-23 01:42:17 +0000363 args = self._parse_command_opts(parser, args)
364 if args is None: # user asked for help (and got it)
Greg Wardfe6462c2000-04-04 01:40:52 +0000365 return
Greg Wardfe6462c2000-04-04 01:40:52 +0000366
Greg Wardd5d8a992000-05-23 01:42:17 +0000367 # Handle the cases of --help as a "global" option, ie.
368 # "setup.py --help" and "setup.py --help command ...". For the
369 # former, we show global options (--verbose, --dry-run, etc.)
370 # and display-only options (--name, --version, etc.); for the
371 # latter, we omit the display-only options and show help for
372 # each command listed on the command line.
Greg Wardfe6462c2000-04-04 01:40:52 +0000373 if self.help:
Greg Wardd5d8a992000-05-23 01:42:17 +0000374 self._show_help(parser,
375 display_options=len(self.commands) == 0,
376 commands=self.commands)
Greg Wardfe6462c2000-04-04 01:40:52 +0000377 return
378
379 # Oops, no commands found -- an end-user error
380 if not self.commands:
381 raise DistutilsArgError, "no commands supplied"
382
383 # All is well: return true
384 return 1
385
386 # parse_command_line()
387
Greg Wardd5d8a992000-05-23 01:42:17 +0000388 def _parse_command_opts (self, parser, args):
Greg Wardd5d8a992000-05-23 01:42:17 +0000389 """Parse the command-line options for a single command.
390 'parser' must be a FancyGetopt instance; 'args' must be the list
391 of arguments, starting with the current command (whose options
392 we are about to parse). Returns a new version of 'args' with
393 the next command at the front of the list; will be the empty
394 list if there are no more commands on the command line. Returns
395 None if the user asked for help on this command.
396 """
397 # late import because of mutual dependence between these modules
398 from distutils.cmd import Command
399
400 # Pull the current command from the head of the command line
401 command = args[0]
402 if not command_re.match (command):
403 raise SystemExit, "invalid command name '%s'" % command
404 self.commands.append (command)
405
406 # Dig up the command class that implements this command, so we
407 # 1) know that it's a valid command, and 2) know which options
408 # it takes.
409 try:
410 cmd_class = self.get_command_class (command)
411 except DistutilsModuleError, msg:
412 raise DistutilsArgError, msg
413
414 # Require that the command class be derived from Command -- want
415 # to be sure that the basic "command" interface is implemented.
416 if not issubclass (cmd_class, Command):
417 raise DistutilsClassError, \
418 "command class %s must subclass Command" % cmd_class
419
420 # Also make sure that the command object provides a list of its
421 # known options.
422 if not (hasattr (cmd_class, 'user_options') and
423 type (cmd_class.user_options) is ListType):
424 raise DistutilsClassError, \
425 ("command class %s must provide " +
426 "'user_options' attribute (a list of tuples)") % \
427 cmd_class
428
429 # If the command class has a list of negative alias options,
430 # merge it in with the global negative aliases.
431 negative_opt = self.negative_opt
432 if hasattr (cmd_class, 'negative_opt'):
433 negative_opt = copy (negative_opt)
434 negative_opt.update (cmd_class.negative_opt)
435
436 # All commands support the global options too, just by adding
437 # in 'global_options'.
438 parser.set_option_table (self.global_options +
439 cmd_class.user_options)
440 parser.set_negative_aliases (negative_opt)
441 (args, opts) = parser.getopt (args[1:])
Greg Ward47460772000-05-23 03:47:35 +0000442 if hasattr(opts, 'help') and opts.help:
Greg Wardd5d8a992000-05-23 01:42:17 +0000443 self._show_help(parser, display_options=0, commands=[cmd_class])
444 return
445
446 # Put the options from the command-line into their official
447 # holding pen, the 'command_options' dictionary.
Greg Ward0e48cfd2000-05-26 01:00:15 +0000448 opt_dict = self.get_option_dict(command)
Greg Wardd5d8a992000-05-23 01:42:17 +0000449 for (name, value) in vars(opts).items():
Greg Ward0e48cfd2000-05-26 01:00:15 +0000450 opt_dict[name] = ("command line", value)
Greg Wardd5d8a992000-05-23 01:42:17 +0000451
452 return args
453
454 # _parse_command_opts ()
455
456
457 def _show_help (self,
458 parser,
459 global_options=1,
460 display_options=1,
461 commands=[]):
462 """Show help for the setup script command-line in the form of
463 several lists of command-line options. 'parser' should be a
464 FancyGetopt instance; do not expect it to be returned in the
465 same state, as its option table will be reset to make it
466 generate the correct help text.
467
468 If 'global_options' is true, lists the global options:
469 --verbose, --dry-run, etc. If 'display_options' is true, lists
470 the "display-only" options: --name, --version, etc. Finally,
471 lists per-command help for every command name or command class
472 in 'commands'.
473 """
474 # late import because of mutual dependence between these modules
475 from distutils.core import usage
476 from distutils.cmd import Command
477
478 if global_options:
479 parser.set_option_table (self.global_options)
480 parser.print_help ("Global options:")
481 print
482
483 if display_options:
484 parser.set_option_table (self.display_options)
485 parser.print_help (
486 "Information display options (just display " +
487 "information, ignore any commands)")
488 print
489
490 for command in self.commands:
491 if type(command) is ClassType and issubclass(klass, Command):
492 klass = command
493 else:
494 klass = self.get_command_class (command)
495 parser.set_option_table (klass.user_options)
496 parser.print_help ("Options for '%s' command:" % klass.__name__)
497 print
498
499 print usage
500 return
501
502 # _show_help ()
503
504
Greg Ward82715e12000-04-21 02:28:14 +0000505 def handle_display_options (self, option_order):
506 """If there were any non-global "display-only" options
Greg Wardd5d8a992000-05-23 01:42:17 +0000507 (--help-commands or the metadata display options) on the command
508 line, display the requested info and return true; else return
509 false.
510 """
Greg Ward82715e12000-04-21 02:28:14 +0000511 from distutils.core import usage
512
513 # User just wants a list of commands -- we'll print it out and stop
514 # processing now (ie. if they ran "setup --help-commands foo bar",
515 # we ignore "foo bar").
516 if self.help_commands:
517 self.print_commands ()
518 print
519 print usage
520 return 1
521
522 # If user supplied any of the "display metadata" options, then
523 # display that metadata in the order in which the user supplied the
524 # metadata options.
525 any_display_options = 0
526 is_display_option = {}
527 for option in self.display_options:
528 is_display_option[option[0]] = 1
529
530 for (opt, val) in option_order:
531 if val and is_display_option.get(opt):
532 opt = string.translate (opt, longopt_xlate)
533 print getattr(self.metadata, "get_"+opt)()
534 any_display_options = 1
535
536 return any_display_options
537
538 # handle_display_options()
Greg Wardfe6462c2000-04-04 01:40:52 +0000539
540 def print_command_list (self, commands, header, max_length):
541 """Print a subset of the list of all commands -- used by
Greg Wardd5d8a992000-05-23 01:42:17 +0000542 'print_commands()'.
543 """
Greg Wardfe6462c2000-04-04 01:40:52 +0000544
545 print header + ":"
546
547 for cmd in commands:
548 klass = self.cmdclass.get (cmd)
549 if not klass:
Greg Wardd5d8a992000-05-23 01:42:17 +0000550 klass = self.get_command_class (cmd)
Greg Wardfe6462c2000-04-04 01:40:52 +0000551 try:
552 description = klass.description
553 except AttributeError:
554 description = "(no description available)"
555
556 print " %-*s %s" % (max_length, cmd, description)
557
558 # print_command_list ()
559
560
561 def print_commands (self):
Greg Wardd5d8a992000-05-23 01:42:17 +0000562 """Print out a help message listing all available commands with a
563 description of each. The list is divided into "standard commands"
564 (listed in distutils.command.__all__) and "extra commands"
565 (mentioned in self.cmdclass, but not a standard command). The
566 descriptions come from the command class attribute
567 'description'.
568 """
Greg Wardfe6462c2000-04-04 01:40:52 +0000569
570 import distutils.command
571 std_commands = distutils.command.__all__
572 is_std = {}
573 for cmd in std_commands:
574 is_std[cmd] = 1
575
576 extra_commands = []
577 for cmd in self.cmdclass.keys():
578 if not is_std.get(cmd):
579 extra_commands.append (cmd)
580
581 max_length = 0
582 for cmd in (std_commands + extra_commands):
583 if len (cmd) > max_length:
584 max_length = len (cmd)
585
586 self.print_command_list (std_commands,
587 "Standard commands",
588 max_length)
589 if extra_commands:
590 print
591 self.print_command_list (extra_commands,
592 "Extra commands",
593 max_length)
594
595 # print_commands ()
Greg Wardfe6462c2000-04-04 01:40:52 +0000596
597
598 # -- Command class/object methods ----------------------------------
599
Greg Wardd5d8a992000-05-23 01:42:17 +0000600 def get_command_class (self, command):
601 """Return the class that implements the Distutils command named by
602 'command'. First we check the 'cmdclass' dictionary; if the
603 command is mentioned there, we fetch the class object from the
604 dictionary and return it. Otherwise we load the command module
605 ("distutils.command." + command) and fetch the command class from
606 the module. The loaded class is also stored in 'cmdclass'
607 to speed future calls to 'get_command_class()'.
Greg Wardfe6462c2000-04-04 01:40:52 +0000608
Gregory P. Smith14263542000-05-12 00:41:33 +0000609 Raises DistutilsModuleError if the expected module could not be
Greg Wardd5d8a992000-05-23 01:42:17 +0000610 found, or if that module does not define the expected class.
611 """
612 klass = self.cmdclass.get(command)
613 if klass:
614 return klass
Greg Wardfe6462c2000-04-04 01:40:52 +0000615
616 module_name = 'distutils.command.' + command
617 klass_name = command
618
619 try:
620 __import__ (module_name)
621 module = sys.modules[module_name]
622 except ImportError:
623 raise DistutilsModuleError, \
624 "invalid command '%s' (no module named '%s')" % \
625 (command, module_name)
626
627 try:
Greg Wardd5d8a992000-05-23 01:42:17 +0000628 klass = getattr(module, klass_name)
629 except AttributeError:
Greg Wardfe6462c2000-04-04 01:40:52 +0000630 raise DistutilsModuleError, \
631 "invalid command '%s' (no class '%s' in module '%s')" \
632 % (command, klass_name, module_name)
633
Greg Wardd5d8a992000-05-23 01:42:17 +0000634 self.cmdclass[command] = klass
Greg Wardfe6462c2000-04-04 01:40:52 +0000635 return klass
636
Greg Wardd5d8a992000-05-23 01:42:17 +0000637 # get_command_class ()
Greg Wardfe6462c2000-04-04 01:40:52 +0000638
Greg Wardd5d8a992000-05-23 01:42:17 +0000639 def get_command_obj (self, command, create=1):
640 """Return the command object for 'command'. Normally this object
641 is cached on a previous call to 'get_command_obj()'; if no comand
642 object for 'command' is in the cache, then we either create and
643 return it (if 'create' is true) or return None.
644 """
Greg Ward2bd3f422000-06-02 01:59:33 +0000645 from distutils.core import DEBUG
Greg Wardd5d8a992000-05-23 01:42:17 +0000646 cmd_obj = self.command_obj.get(command)
Greg Wardfe6462c2000-04-04 01:40:52 +0000647 if not cmd_obj and create:
Greg Ward2bd3f422000-06-02 01:59:33 +0000648 if DEBUG:
649 print "Distribution.get_command_obj(): " \
650 "creating '%s' command object" % command
Greg Ward47460772000-05-23 03:47:35 +0000651
Greg Wardd5d8a992000-05-23 01:42:17 +0000652 klass = self.get_command_class(command)
Greg Ward47460772000-05-23 03:47:35 +0000653 cmd_obj = self.command_obj[command] = klass(self)
654 self.have_run[command] = 0
655
656 # Set any options that were supplied in config files
657 # or on the command line. (NB. support for error
658 # reporting is lame here: any errors aren't reported
659 # until 'finalize_options()' is called, which means
660 # we won't report the source of the error.)
661 options = self.command_options.get(command)
662 if options:
Greg Wardc32d9a62000-05-28 23:53:06 +0000663 self._set_command_options(cmd_obj, options)
Greg Wardfe6462c2000-04-04 01:40:52 +0000664
665 return cmd_obj
666
Greg Wardc32d9a62000-05-28 23:53:06 +0000667 def _set_command_options (self, command_obj, option_dict=None):
Greg Wardc32d9a62000-05-28 23:53:06 +0000668 """Set the options for 'command_obj' from 'option_dict'. Basically
669 this means copying elements of a dictionary ('option_dict') to
670 attributes of an instance ('command').
671
672 'command_obj' must be a Commnd instance. If 'option_dict' is not
673 supplied, uses the standard option dictionary for this command
674 (from 'self.command_options').
675 """
676 from distutils.core import DEBUG
677
678 command_name = command_obj.get_command_name()
679 if option_dict is None:
680 option_dict = self.get_option_dict(command_name)
681
682 if DEBUG: print " setting options for '%s' command:" % command_name
683 for (option, (source, value)) in option_dict.items():
684 if DEBUG: print " %s = %s (from %s)" % (option, value, source)
685 if not hasattr(command_obj, option):
686 raise DistutilsOptionError, \
687 ("error in %s: command '%s' has no such option '%s'") % \
688 (source, command_name, option)
689 setattr(command_obj, option, value)
690
691 def reinitialize_command (self, command):
692 """Reinitializes a command to the state it was in when first
693 returned by 'get_command_obj()': ie., initialized but not yet
694 finalized. This gives provides the opportunity to sneak option
695 values in programmatically, overriding or supplementing
696 user-supplied values from the config files and command line.
697 You'll have to re-finalize the command object (by calling
698 'finalize_options()' or 'ensure_finalized()') before using it for
699 real.
700
701 'command' should be a command name (string) or command object.
702 Returns the reinitialized command object.
703 """
704 from distutils.cmd import Command
705 if not isinstance(command, Command):
706 command_name = command
707 command = self.get_command_obj(command_name)
708 else:
709 command_name = command.get_command_name()
710
711 if not command.finalized:
Greg Ward282c7a02000-06-01 01:09:47 +0000712 return command
Greg Wardc32d9a62000-05-28 23:53:06 +0000713 command.initialize_options()
714 command.finalized = 0
715 self._set_command_options(command)
716 return command
717
Greg Wardfe6462c2000-04-04 01:40:52 +0000718
719 # -- Methods that operate on the Distribution ----------------------
720
721 def announce (self, msg, level=1):
722 """Print 'msg' if 'level' is greater than or equal to the verbosity
Greg Wardd5d8a992000-05-23 01:42:17 +0000723 level recorded in the 'verbose' attribute (which, currently, can be
724 only 0 or 1).
725 """
Greg Wardfe6462c2000-04-04 01:40:52 +0000726 if self.verbose >= level:
727 print msg
728
729
730 def run_commands (self):
Greg Ward82715e12000-04-21 02:28:14 +0000731 """Run each command that was seen on the setup script command line.
Greg Wardd5d8a992000-05-23 01:42:17 +0000732 Uses the list of commands found and cache of command objects
733 created by 'get_command_obj()'."""
Greg Wardfe6462c2000-04-04 01:40:52 +0000734
735 for cmd in self.commands:
736 self.run_command (cmd)
737
738
Greg Wardfe6462c2000-04-04 01:40:52 +0000739 # -- Methods that operate on its Commands --------------------------
740
741 def run_command (self, command):
Greg Wardfe6462c2000-04-04 01:40:52 +0000742 """Do whatever it takes to run a command (including nothing at all,
Greg Wardd5d8a992000-05-23 01:42:17 +0000743 if the command has already been run). Specifically: if we have
744 already created and run the command named by 'command', return
745 silently without doing anything. If the command named by 'command'
746 doesn't even have a command object yet, create one. Then invoke
747 'run()' on that command object (or an existing one).
748 """
Greg Wardfe6462c2000-04-04 01:40:52 +0000749
750 # Already been here, done that? then return silently.
751 if self.have_run.get (command):
752 return
753
754 self.announce ("running " + command)
Greg Wardd5d8a992000-05-23 01:42:17 +0000755 cmd_obj = self.get_command_obj (command)
Greg Ward4fb29e52000-05-27 17:27:23 +0000756 cmd_obj.ensure_finalized ()
Greg Wardfe6462c2000-04-04 01:40:52 +0000757 cmd_obj.run ()
758 self.have_run[command] = 1
759
760
Greg Wardfe6462c2000-04-04 01:40:52 +0000761 # -- Distribution query methods ------------------------------------
762
763 def has_pure_modules (self):
764 return len (self.packages or self.py_modules or []) > 0
765
766 def has_ext_modules (self):
767 return self.ext_modules and len (self.ext_modules) > 0
768
769 def has_c_libraries (self):
770 return self.libraries and len (self.libraries) > 0
771
772 def has_modules (self):
773 return self.has_pure_modules() or self.has_ext_modules()
774
Greg Ward51def7d2000-05-27 01:36:14 +0000775 def has_headers (self):
776 return self.headers and len(self.headers) > 0
777
Greg Ward44a61bb2000-05-20 15:06:48 +0000778 def has_scripts (self):
779 return self.scripts and len(self.scripts) > 0
780
781 def has_data_files (self):
782 return self.data_files and len(self.data_files) > 0
783
Greg Wardfe6462c2000-04-04 01:40:52 +0000784 def is_pure (self):
785 return (self.has_pure_modules() and
786 not self.has_ext_modules() and
787 not self.has_c_libraries())
788
Greg Ward82715e12000-04-21 02:28:14 +0000789 # -- Metadata query methods ----------------------------------------
790
791 # If you're looking for 'get_name()', 'get_version()', and so forth,
792 # they are defined in a sneaky way: the constructor binds self.get_XXX
793 # to self.metadata.get_XXX. The actual code is in the
794 # DistributionMetadata class, below.
795
796# class Distribution
797
798
799class DistributionMetadata:
800 """Dummy class to hold the distribution meta-data: name, version,
801 author, and so forth."""
802
803 def __init__ (self):
804 self.name = None
805 self.version = None
806 self.author = None
807 self.author_email = None
808 self.maintainer = None
809 self.maintainer_email = None
810 self.url = None
811 self.licence = None
812 self.description = None
Greg Warde5a584e2000-04-26 02:26:55 +0000813 self.long_description = None
Greg Ward82715e12000-04-21 02:28:14 +0000814
815 # -- Metadata query methods ----------------------------------------
816
Greg Wardfe6462c2000-04-04 01:40:52 +0000817 def get_name (self):
818 return self.name or "UNKNOWN"
819
Greg Ward82715e12000-04-21 02:28:14 +0000820 def get_version(self):
821 return self.version or "???"
Greg Wardfe6462c2000-04-04 01:40:52 +0000822
Greg Ward82715e12000-04-21 02:28:14 +0000823 def get_fullname (self):
824 return "%s-%s" % (self.get_name(), self.get_version())
825
826 def get_author(self):
827 return self.author or "UNKNOWN"
828
829 def get_author_email(self):
830 return self.author_email or "UNKNOWN"
831
832 def get_maintainer(self):
833 return self.maintainer or "UNKNOWN"
834
835 def get_maintainer_email(self):
836 return self.maintainer_email or "UNKNOWN"
837
838 def get_contact(self):
839 return (self.maintainer or
840 self.author or
841 "UNKNOWN")
842
843 def get_contact_email(self):
844 return (self.maintainer_email or
845 self.author_email or
846 "UNKNOWN")
847
848 def get_url(self):
849 return self.url or "UNKNOWN"
850
851 def get_licence(self):
852 return self.licence or "UNKNOWN"
853
854 def get_description(self):
855 return self.description or "UNKNOWN"
Greg Warde5a584e2000-04-26 02:26:55 +0000856
857 def get_long_description(self):
858 return self.long_description or "UNKNOWN"
859
Greg Ward82715e12000-04-21 02:28:14 +0000860# class DistributionMetadata
Greg Wardfe6462c2000-04-04 01:40:52 +0000861
862if __name__ == "__main__":
863 dist = Distribution ()
864 print "ok"