home *** CD-ROM | disk | FTP | other *** search
/ Freelog 125 / Freelog_MarsAvril2015_No125.iso / Bureautique / LibreOffice / LibreOffice_4.3.5_Win_x86.msi / dist.py < prev    next >
Text File  |  2014-12-12  |  49KB  |  1,214 lines
  1. """distutils.dist
  2.  
  3. Provides the Distribution class, which represents the module distribution
  4. being built/installed/distributed.
  5. """
  6.  
  7. import sys, os, re
  8. from email import message_from_file
  9.  
  10. try:
  11.     import warnings
  12. except ImportError:
  13.     warnings = None
  14.  
  15. from distutils.errors import *
  16. from distutils.fancy_getopt import FancyGetopt, translate_longopt
  17. from distutils.util import check_environ, strtobool, rfc822_escape
  18. from distutils import log
  19. from distutils.debug import DEBUG
  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.
  25. command_re = re.compile (r'^[a-zA-Z]([a-zA-Z0-9_]*)$')
  26.  
  27.  
  28. class Distribution:
  29.     """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.
  32.  
  33.     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.     """
  41.  
  42.  
  43.     # 'global_options' describes the command-line options that may be
  44.     # supplied to the setup script prior to any actual commands.
  45.     # Eg. "./setup.py -n" or "./setup.py --quiet" both take advantage of
  46.     # 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.
  50.     # The fourth entry for verbose means that it can be repeated.
  51.     global_options = [('verbose', 'v', "run verbosely (default)", 1),
  52.                       ('quiet', 'q', "run quietly (turns verbosity off)"),
  53.                       ('dry-run', 'n', "don't actually do anything"),
  54.                       ('help', 'h', "show detailed help message"),
  55.                      ]
  56.  
  57.     # 'common_usage' is a short (2-3 line) string describing the common
  58.     # usage of the setup script.
  59.     common_usage = """\
  60. Common commands: (see '--help-commands' for more)
  61.  
  62.   setup.py build      will build the package underneath 'build/'
  63.   setup.py install    will install the package
  64. """
  65.  
  66.     # options that are not propagated to the commands
  67.     display_options = [
  68.         ('help-commands', None,
  69.          "list all available commands"),
  70.         ('name', None,
  71.          "print package name"),
  72.         ('version', 'V',
  73.          "print package version"),
  74.         ('fullname', None,
  75.          "print <package name>-<version>"),
  76.         ('author', None,
  77.          "print the author's name"),
  78.         ('author-email', None,
  79.          "print the author's email address"),
  80.         ('maintainer', None,
  81.          "print the maintainer's name"),
  82.         ('maintainer-email', None,
  83.          "print the maintainer's email address"),
  84.         ('contact', None,
  85.          "print the maintainer's name if known, else the author's"),
  86.         ('contact-email', None,
  87.          "print the maintainer's email address if known, else the author's"),
  88.         ('url', None,
  89.          "print the URL for this package"),
  90.         ('license', None,
  91.          "print the license of the package"),
  92.         ('licence', None,
  93.          "alias for --license"),
  94.         ('description', None,
  95.          "print the package description"),
  96.         ('long-description', None,
  97.          "print the long package description"),
  98.         ('platforms', None,
  99.          "print the list of platforms"),
  100.         ('classifiers', None,
  101.          "print the list of classifiers"),
  102.         ('keywords', None,
  103.          "print the list of keywords"),
  104.         ('provides', None,
  105.          "print the list of packages/modules provided"),
  106.         ('requires', None,
  107.          "print the list of packages/modules required"),
  108.         ('obsoletes', None,
  109.          "print the list of packages/modules made obsolete")
  110.         ]
  111.     display_option_names = [translate_longopt(x[0]) for x in display_options]
  112.  
  113.     # negative options are options that exclude other options
  114.     negative_opt = {'quiet': 'verbose'}
  115.  
  116.  
  117.     # -- Creation/initialization methods -------------------------------
  118.  
  119.     def __init__ (self, attrs=None):
  120.         """Construct a new Distribution instance: initialize all the
  121.         attributes of a Distribution, and then use 'attrs' (a dictionary
  122.         mapping attribute names to values) to assign some of those
  123.         attributes their "real" values.  (Any attributes not mentioned in
  124.         'attrs' will be assigned to some null value: 0, None, an empty list
  125.         or dictionary, etc.)  Most importantly, initialize the
  126.         'command_obj' attribute to the empty dictionary; this will be
  127.         filled in with real command objects by 'parse_command_line()'.
  128.         """
  129.  
  130.         # Default values for our command-line options
  131.         self.verbose = 1
  132.         self.dry_run = 0
  133.         self.help = 0
  134.         for attr in self.display_option_names:
  135.             setattr(self, attr, 0)
  136.  
  137.         # Store the distribution meta-data (name, version, author, and so
  138.         # forth) in a separate object -- we're getting to have enough
  139.         # information here (and enough command-line options) that it's
  140.         # worth it.  Also delegate 'get_XXX()' methods to the 'metadata'
  141.         # object in a sneaky and underhanded (but efficient!) way.
  142.         self.metadata = DistributionMetadata()
  143.         for basename in self.metadata._METHOD_BASENAMES:
  144.             method_name = "get_" + basename
  145.             setattr(self, method_name, getattr(self.metadata, method_name))
  146.  
  147.         # 'cmdclass' maps command names to class objects, so we
  148.         # can 1) quickly figure out which class to instantiate when
  149.         # we need to create a new command object, and 2) have a way
  150.         # for the setup script to override command classes
  151.         self.cmdclass = {}
  152.  
  153.         # 'command_packages' is a list of packages in which commands
  154.         # are searched for.  The factory for command 'foo' is expected
  155.         # to be named 'foo' in the module 'foo' in one of the packages
  156.         # named here.  This list is searched from the left; an error
  157.         # is raised if no named package provides the command being
  158.         # searched for.  (Always access using get_command_packages().)
  159.         self.command_packages = None
  160.  
  161.         # 'script_name' and 'script_args' are usually set to sys.argv[0]
  162.         # and sys.argv[1:], but they can be overridden when the caller is
  163.         # not necessarily a setup script run from the command-line.
  164.         self.script_name = None
  165.         self.script_args = None
  166.  
  167.         # 'command_options' is where we store command options between
  168.         # parsing them (from config files, the command-line, etc.) and when
  169.         # they are actually needed -- ie. when the command in question is
  170.         # instantiated.  It is a dictionary of dictionaries of 2-tuples:
  171.         #   command_options = { command_name : { option : (source, value) } }
  172.         self.command_options = {}
  173.  
  174.         # 'dist_files' is the list of (command, pyversion, file) that
  175.         # have been created by any dist commands run so far. This is
  176.         # filled regardless of whether the run is dry or not. pyversion
  177.         # gives sysconfig.get_python_version() if the dist file is
  178.         # specific to a Python version, 'any' if it is good for all
  179.         # Python versions on the target platform, and '' for a source
  180.         # file. pyversion should not be used to specify minimum or
  181.         # maximum required Python versions; use the metainfo for that
  182.         # instead.
  183.         self.dist_files = []
  184.  
  185.         # These options are really the business of various commands, rather
  186.         # than of the Distribution itself.  We provide aliases for them in
  187.         # Distribution as a convenience to the developer.
  188.         self.packages = None
  189.         self.package_data = {}
  190.         self.package_dir = None
  191.         self.py_modules = None
  192.         self.libraries = None
  193.         self.headers = None
  194.         self.ext_modules = None
  195.         self.ext_package = None
  196.         self.include_dirs = None
  197.         self.extra_path = None
  198.         self.scripts = None
  199.         self.data_files = None
  200.         self.password = ''
  201.  
  202.         # And now initialize bookkeeping stuff that can't be supplied by
  203.         # the caller at all.  'command_obj' maps command names to
  204.         # Command instances -- that's how we enforce that every command
  205.         # class is a singleton.
  206.         self.command_obj = {}
  207.  
  208.         # 'have_run' maps command names to boolean values; it keeps track
  209.         # of whether we have actually run a particular command, to make it
  210.         # cheap to "run" a command whenever we think we might need to -- if
  211.         # it's already been done, no need for expensive filesystem
  212.         # operations, we just check the 'have_run' dictionary and carry on.
  213.         # It's only safe to query 'have_run' for a command class that has
  214.         # been instantiated -- a false value will be inserted when the
  215.         # command object is created, and replaced with a true value when
  216.         # the command is successfully run.  Thus it's probably best to use
  217.         # '.get()' rather than a straight lookup.
  218.         self.have_run = {}
  219.  
  220.         # Now we'll use the attrs dictionary (ultimately, keyword args from
  221.         # the setup script) to possibly override any or all of these
  222.         # distribution options.
  223.  
  224.         if attrs:
  225.             # Pull out the set of command options and work on them
  226.             # specifically.  Note that this order guarantees that aliased
  227.             # command options will override any supplied redundantly
  228.             # through the general options dictionary.
  229.             options = attrs.get('options')
  230.             if options is not None:
  231.                 del attrs['options']
  232.                 for (command, cmd_options) in options.items():
  233.                     opt_dict = self.get_option_dict(command)
  234.                     for (opt, val) in cmd_options.items():
  235.                         opt_dict[opt] = ("setup script", val)
  236.  
  237.             if 'licence' in attrs:
  238.                 attrs['license'] = attrs['licence']
  239.                 del attrs['licence']
  240.                 msg = "'licence' distribution option is deprecated; use 'license'"
  241.                 if warnings is not None:
  242.                     warnings.warn(msg)
  243.                 else:
  244.                     sys.stderr.write(msg + "\n")
  245.  
  246.             # Now work on the rest of the attributes.  Any attribute that's
  247.             # not already defined is invalid!
  248.             for (key, val) in attrs.items():
  249.                 if hasattr(self.metadata, "set_" + key):
  250.                     getattr(self.metadata, "set_" + key)(val)
  251.                 elif hasattr(self.metadata, key):
  252.                     setattr(self.metadata, key, val)
  253.                 elif hasattr(self, key):
  254.                     setattr(self, key, val)
  255.                 else:
  256.                     msg = "Unknown distribution option: %s" % repr(key)
  257.                     if warnings is not None:
  258.                         warnings.warn(msg)
  259.                     else:
  260.                         sys.stderr.write(msg + "\n")
  261.  
  262.         self.finalize_options()
  263.  
  264.     def get_option_dict(self, command):
  265.         """Get the option dictionary for a given command.  If that
  266.         command's option dictionary hasn't been created yet, then create it
  267.         and return the new dictionary; otherwise, return the existing
  268.         option dictionary.
  269.         """
  270.         dict = self.command_options.get(command)
  271.         if dict is None:
  272.             dict = self.command_options[command] = {}
  273.         return dict
  274.  
  275.     def dump_option_dicts(self, header=None, commands=None, indent=""):
  276.         from pprint import pformat
  277.  
  278.         if commands is None:             # dump all command option dicts
  279.             commands = sorted(self.command_options.keys())
  280.  
  281.         if header is not None:
  282.             self.announce(indent + header)
  283.             indent = indent + "  "
  284.  
  285.         if not commands:
  286.             self.announce(indent + "no commands known yet")
  287.             return
  288.  
  289.         for cmd_name in commands:
  290.             opt_dict = self.command_options.get(cmd_name)
  291.             if opt_dict is None:
  292.                 self.announce(indent +
  293.                               "no option dict for '%s' command" % cmd_name)
  294.             else:
  295.                 self.announce(indent +
  296.                               "option dict for '%s' command:" % cmd_name)
  297.                 out = pformat(opt_dict)
  298.                 for line in out.split('\n'):
  299.                     self.announce(indent + "  " + line)
  300.  
  301.     # -- Config file finding/parsing methods ---------------------------
  302.  
  303.     def find_config_files(self):
  304.         """Find as many configuration files as should be processed for this
  305.         platform, and return a list of filenames in the order in which they
  306.         should be parsed.  The filenames returned are guaranteed to exist
  307.         (modulo nasty race conditions).
  308.  
  309.         There are three possible config files: distutils.cfg in the
  310.         Distutils installation directory (ie. where the top-level
  311.         Distutils __inst__.py file lives), a file in the user's home
  312.         directory named .pydistutils.cfg on Unix and pydistutils.cfg
  313.         on Windows/Mac, and setup.cfg in the current directory.
  314.         """
  315.         files = []
  316.         check_environ()
  317.  
  318.         # Where to look for the system-wide Distutils config file
  319.         sys_dir = os.path.dirname(sys.modules['distutils'].__file__)
  320.  
  321.         # Look for the system config file
  322.         sys_file = os.path.join(sys_dir, "distutils.cfg")
  323.         if os.path.isfile(sys_file):
  324.             files.append(sys_file)
  325.  
  326.         # What to call the per-user config file
  327.         if os.name == 'posix':
  328.             user_filename = ".pydistutils.cfg"
  329.         else:
  330.             user_filename = "pydistutils.cfg"
  331.  
  332.         # And look for the user config file
  333.         user_file = os.path.join(os.path.expanduser('~'), user_filename)
  334.         if os.path.isfile(user_file):
  335.             files.append(user_file)
  336.  
  337.         # All platforms support local setup.cfg
  338.         local_file = "setup.cfg"
  339.         if os.path.isfile(local_file):
  340.             files.append(local_file)
  341.  
  342.         return files
  343.  
  344.     def parse_config_files(self, filenames=None):
  345.         from configparser import ConfigParser
  346.  
  347.         # Ignore install directory options if we have a venv
  348.         if sys.prefix != sys.base_prefix:
  349.             ignore_options = [
  350.                 'install-base', 'install-platbase', 'install-lib',
  351.                 'install-platlib', 'install-purelib', 'install-headers',
  352.                 'install-scripts', 'install-data', 'prefix', 'exec-prefix',
  353.                 'home', 'user', 'root']
  354.         else:
  355.             ignore_options = []
  356.  
  357.         ignore_options = frozenset(ignore_options)
  358.  
  359.         if filenames is None:
  360.             filenames = self.find_config_files()
  361.  
  362.         if DEBUG:
  363.             self.announce("Distribution.parse_config_files():")
  364.  
  365.         parser = ConfigParser()
  366.         for filename in filenames:
  367.             if DEBUG:
  368.                 self.announce("  reading %s" % filename)
  369.             parser.read(filename)
  370.             for section in parser.sections():
  371.                 options = parser.options(section)
  372.                 opt_dict = self.get_option_dict(section)
  373.  
  374.                 for opt in options:
  375.                     if opt != '__name__' and opt not in ignore_options:
  376.                         val = parser.get(section,opt)
  377.                         opt = opt.replace('-', '_')
  378.                         opt_dict[opt] = (filename, val)
  379.  
  380.             # Make the ConfigParser forget everything (so we retain
  381.             # the original filenames that options come from)
  382.             parser.__init__()
  383.  
  384.         # If there was a "global" section in the config file, use it
  385.         # to set Distribution options.
  386.  
  387.         if 'global' in self.command_options:
  388.             for (opt, (src, val)) in self.command_options['global'].items():
  389.                 alias = self.negative_opt.get(opt)
  390.                 try:
  391.                     if alias:
  392.                         setattr(self, alias, not strtobool(val))
  393.                     elif opt in ('verbose', 'dry_run'): # ugh!
  394.                         setattr(self, opt, strtobool(val))
  395.                     else:
  396.                         setattr(self, opt, val)
  397.                 except ValueError as msg:
  398.                     raise DistutilsOptionError(msg)
  399.  
  400.     # -- Command-line parsing methods ----------------------------------
  401.  
  402.     def parse_command_line(self):
  403.         """Parse the setup script's command line, taken from the
  404.         'script_args' instance attribute (which defaults to 'sys.argv[1:]'
  405.         -- see 'setup()' in core.py).  This list is first processed for
  406.         "global options" -- options that set attributes of the Distribution
  407.         instance.  Then, it is alternately scanned for Distutils commands
  408.         and options for that command.  Each new command terminates the
  409.         options for the previous command.  The allowed options for a
  410.         command are determined by the 'user_options' attribute of the
  411.         command class -- thus, we have to be able to load command classes
  412.         in order to parse the command line.  Any error in that 'options'
  413.         attribute raises DistutilsGetoptError; any error on the
  414.         command-line raises DistutilsArgError.  If no Distutils commands
  415.         were found on the command line, raises DistutilsArgError.  Return
  416.         true if command-line was successfully parsed and we should carry
  417.         on with executing commands; false if no errors but we shouldn't
  418.         execute commands (currently, this only happens if user asks for
  419.         help).
  420.         """
  421.         #
  422.         # We now have enough information to show the Macintosh dialog
  423.         # that allows the user to interactively specify the "command line".
  424.         #
  425.         toplevel_options = self._get_toplevel_options()
  426.  
  427.         # We have to parse the command line a bit at a time -- global
  428.         # options, then the first command, then its options, and so on --
  429.         # because each command will be handled by a different class, and
  430.         # the options that are valid for a particular class aren't known
  431.         # until we have loaded the command class, which doesn't happen
  432.         # until we know what the command is.
  433.  
  434.         self.commands = []
  435.         parser = FancyGetopt(toplevel_options + self.display_options)
  436.         parser.set_negative_aliases(self.negative_opt)
  437.         parser.set_aliases({'licence': 'license'})
  438.         args = parser.getopt(args=self.script_args, object=self)
  439.         option_order = parser.get_option_order()
  440.         log.set_verbosity(self.verbose)
  441.  
  442.         # for display options we return immediately
  443.         if self.handle_display_options(option_order):
  444.             return
  445.         while args:
  446.             args = self._parse_command_opts(parser, args)
  447.             if args is None:            # user asked for help (and got it)
  448.                 return
  449.  
  450.         # Handle the cases of --help as a "global" option, ie.
  451.         # "setup.py --help" and "setup.py --help command ...".  For the
  452.         # former, we show global options (--verbose, --dry-run, etc.)
  453.         # and display-only options (--name, --version, etc.); for the
  454.         # latter, we omit the display-only options and show help for
  455.         # each command listed on the command line.
  456.         if self.help:
  457.             self._show_help(parser,
  458.                             display_options=len(self.commands) == 0,
  459.                             commands=self.commands)
  460.             return
  461.  
  462.         # Oops, no commands found -- an end-user error
  463.         if not self.commands:
  464.             raise DistutilsArgError("no commands supplied")
  465.  
  466.         # All is well: return true
  467.         return True
  468.  
  469.     def _get_toplevel_options(self):
  470.         """Return the non-display options recognized at the top level.
  471.  
  472.         This includes options that are recognized *only* at the top
  473.         level as well as options recognized for commands.
  474.         """
  475.         return self.global_options + [
  476.             ("command-packages=", None,
  477.              "list of packages that provide distutils commands"),
  478.             ]
  479.  
  480.     def _parse_command_opts(self, parser, args):
  481.         """Parse the command-line options for a single command.
  482.         'parser' must be a FancyGetopt instance; 'args' must be the list
  483.         of arguments, starting with the current command (whose options
  484.         we are about to parse).  Returns a new version of 'args' with
  485.         the next command at the front of the list; will be the empty
  486.         list if there are no more commands on the command line.  Returns
  487.         None if the user asked for help on this command.
  488.         """
  489.         # late import because of mutual dependence between these modules
  490.         from distutils.cmd import Command
  491.  
  492.         # Pull the current command from the head of the command line
  493.         command = args[0]
  494.         if not command_re.match(command):
  495.             raise SystemExit("invalid command name '%s'" % command)
  496.         self.commands.append(command)
  497.  
  498.         # Dig up the command class that implements this command, so we
  499.         # 1) know that it's a valid command, and 2) know which options
  500.         # it takes.
  501.         try:
  502.             cmd_class = self.get_command_class(command)
  503.         except DistutilsModuleError as msg:
  504.             raise DistutilsArgError(msg)
  505.  
  506.         # Require that the command class be derived from Command -- want
  507.         # to be sure that the basic "command" interface is implemented.
  508.         if not issubclass(cmd_class, Command):
  509.             raise DistutilsClassError(
  510.                   "command class %s must subclass Command" % cmd_class)
  511.  
  512.         # Also make sure that the command object provides a list of its
  513.         # known options.
  514.         if not (hasattr(cmd_class, 'user_options') and
  515.                 isinstance(cmd_class.user_options, list)):
  516.             raise DistutilsClassError(("command class %s must provide " +
  517.                    "'user_options' attribute (a list of tuples)") % \
  518.                   cmd_class)
  519.  
  520.         # If the command class has a list of negative alias options,
  521.         # merge it in with the global negative aliases.
  522.         negative_opt = self.negative_opt
  523.         if hasattr(cmd_class, 'negative_opt'):
  524.             negative_opt = negative_opt.copy()
  525.             negative_opt.update(cmd_class.negative_opt)
  526.  
  527.         # Check for help_options in command class.  They have a different
  528.         # format (tuple of four) so we need to preprocess them here.
  529.         if (hasattr(cmd_class, 'help_options') and
  530.             isinstance(cmd_class.help_options, list)):
  531.             help_options = fix_help_options(cmd_class.help_options)
  532.         else:
  533.             help_options = []
  534.  
  535.  
  536.         # All commands support the global options too, just by adding
  537.         # in 'global_options'.
  538.         parser.set_option_table(self.global_options +
  539.                                 cmd_class.user_options +
  540.                                 help_options)
  541.         parser.set_negative_aliases(negative_opt)
  542.         (args, opts) = parser.getopt(args[1:])
  543.         if hasattr(opts, 'help') and opts.help:
  544.             self._show_help(parser, display_options=0, commands=[cmd_class])
  545.             return
  546.  
  547.         if (hasattr(cmd_class, 'help_options') and
  548.             isinstance(cmd_class.help_options, list)):
  549.             help_option_found=0
  550.             for (help_option, short, desc, func) in cmd_class.help_options:
  551.                 if hasattr(opts, parser.get_attr_name(help_option)):
  552.                     help_option_found=1
  553.                     if callable(func):
  554.                         func()
  555.                     else:
  556.                         raise DistutilsClassError(
  557.                             "invalid help function %r for help option '%s': "
  558.                             "must be a callable object (function, etc.)"
  559.                             % (func, help_option))
  560.  
  561.             if help_option_found:
  562.                 return
  563.  
  564.         # Put the options from the command-line into their official
  565.         # holding pen, the 'command_options' dictionary.
  566.         opt_dict = self.get_option_dict(command)
  567.         for (name, value) in vars(opts).items():
  568.             opt_dict[name] = ("command line", value)
  569.  
  570.         return args
  571.  
  572.     def finalize_options(self):
  573.         """Set final values for all the options on the Distribution
  574.         instance, analogous to the .finalize_options() method of Command
  575.         objects.
  576.         """
  577.         for attr in ('keywords', 'platforms'):
  578.             value = getattr(self.metadata, attr)
  579.             if value is None:
  580.                 continue
  581.             if isinstance(value, str):
  582.                 value = [elm.strip() for elm in value.split(',')]
  583.                 setattr(self.metadata, attr, value)
  584.  
  585.     def _show_help(self, parser, global_options=1, display_options=1,
  586.                    commands=[]):
  587.         """Show help for the setup script command-line in the form of
  588.         several lists of command-line options.  'parser' should be a
  589.         FancyGetopt instance; do not expect it to be returned in the
  590.         same state, as its option table will be reset to make it
  591.         generate the correct help text.
  592.  
  593.         If 'global_options' is true, lists the global options:
  594.         --verbose, --dry-run, etc.  If 'display_options' is true, lists
  595.         the "display-only" options: --name, --version, etc.  Finally,
  596.         lists per-command help for every command name or command class
  597.         in 'commands'.
  598.         """
  599.         # late import because of mutual dependence between these modules
  600.         from distutils.core import gen_usage
  601.         from distutils.cmd import Command
  602.  
  603.         if global_options:
  604.             if display_options:
  605.                 options = self._get_toplevel_options()
  606.             else:
  607.                 options = self.global_options
  608.             parser.set_option_table(options)
  609.             parser.print_help(self.common_usage + "\nGlobal options:")
  610.             print('')
  611.  
  612.         if display_options:
  613.             parser.set_option_table(self.display_options)
  614.             parser.print_help(
  615.                 "Information display options (just display " +
  616.                 "information, ignore any commands)")
  617.             print('')
  618.  
  619.         for command in self.commands:
  620.             if isinstance(command, type) and issubclass(command, Command):
  621.                 klass = command
  622.             else:
  623.                 klass = self.get_command_class(command)
  624.             if (hasattr(klass, 'help_options') and
  625.                 isinstance(klass.help_options, list)):
  626.                 parser.set_option_table(klass.user_options +
  627.                                         fix_help_options(klass.help_options))
  628.             else:
  629.                 parser.set_option_table(klass.user_options)
  630.             parser.print_help("Options for '%s' command:" % klass.__name__)
  631.             print('')
  632.  
  633.         print(gen_usage(self.script_name))
  634.  
  635.     def handle_display_options(self, option_order):
  636.         """If there were any non-global "display-only" options
  637.         (--help-commands or the metadata display options) on the command
  638.         line, display the requested info and return true; else return
  639.         false.
  640.         """
  641.         from distutils.core import gen_usage
  642.  
  643.         # User just wants a list of commands -- we'll print it out and stop
  644.         # processing now (ie. if they ran "setup --help-commands foo bar",
  645.         # we ignore "foo bar").
  646.         if self.help_commands:
  647.             self.print_commands()
  648.             print('')
  649.             print(gen_usage(self.script_name))
  650.             return 1
  651.  
  652.         # If user supplied any of the "display metadata" options, then
  653.         # display that metadata in the order in which the user supplied the
  654.         # metadata options.
  655.         any_display_options = 0
  656.         is_display_option = {}
  657.         for option in self.display_options:
  658.             is_display_option[option[0]] = 1
  659.  
  660.         for (opt, val) in option_order:
  661.             if val and is_display_option.get(opt):
  662.                 opt = translate_longopt(opt)
  663.                 value = getattr(self.metadata, "get_"+opt)()
  664.                 if opt in ['keywords', 'platforms']:
  665.                     print(','.join(value))
  666.                 elif opt in ('classifiers', 'provides', 'requires',
  667.                              'obsoletes'):
  668.                     print('\n'.join(value))
  669.                 else:
  670.                     print(value)
  671.                 any_display_options = 1
  672.  
  673.         return any_display_options
  674.  
  675.     def print_command_list(self, commands, header, max_length):
  676.         """Print a subset of the list of all commands -- used by
  677.         'print_commands()'.
  678.         """
  679.         print(header + ":")
  680.  
  681.         for cmd in commands:
  682.             klass = self.cmdclass.get(cmd)
  683.             if not klass:
  684.                 klass = self.get_command_class(cmd)
  685.             try:
  686.                 description = klass.description
  687.             except AttributeError:
  688.                 description = "(no description available)"
  689.  
  690.             print("  %-*s  %s" % (max_length, cmd, description))
  691.  
  692.     def print_commands(self):
  693.         """Print out a help message listing all available commands with a
  694.         description of each.  The list is divided into "standard commands"
  695.         (listed in distutils.command.__all__) and "extra commands"
  696.         (mentioned in self.cmdclass, but not a standard command).  The
  697.         descriptions come from the command class attribute
  698.         'description'.
  699.         """
  700.         import distutils.command
  701.         std_commands = distutils.command.__all__
  702.         is_std = {}
  703.         for cmd in std_commands:
  704.             is_std[cmd] = 1
  705.  
  706.         extra_commands = []
  707.         for cmd in self.cmdclass.keys():
  708.             if not is_std.get(cmd):
  709.                 extra_commands.append(cmd)
  710.  
  711.         max_length = 0
  712.         for cmd in (std_commands + extra_commands):
  713.             if len(cmd) > max_length:
  714.                 max_length = len(cmd)
  715.  
  716.         self.print_command_list(std_commands,
  717.                                 "Standard commands",
  718.                                 max_length)
  719.         if extra_commands:
  720.             print()
  721.             self.print_command_list(extra_commands,
  722.                                     "Extra commands",
  723.                                     max_length)
  724.  
  725.     def get_command_list(self):
  726.         """Get a list of (command, description) tuples.
  727.         The list is divided into "standard commands" (listed in
  728.         distutils.command.__all__) and "extra commands" (mentioned in
  729.         self.cmdclass, but not a standard command).  The descriptions come
  730.         from the command class attribute 'description'.
  731.         """
  732.         # Currently this is only used on Mac OS, for the Mac-only GUI
  733.         # Distutils interface (by Jack Jansen)
  734.         import distutils.command
  735.         std_commands = distutils.command.__all__
  736.         is_std = {}
  737.         for cmd in std_commands:
  738.             is_std[cmd] = 1
  739.  
  740.         extra_commands = []
  741.         for cmd in self.cmdclass.keys():
  742.             if not is_std.get(cmd):
  743.                 extra_commands.append(cmd)
  744.  
  745.         rv = []
  746.         for cmd in (std_commands + extra_commands):
  747.             klass = self.cmdclass.get(cmd)
  748.             if not klass:
  749.                 klass = self.get_command_class(cmd)
  750.             try:
  751.                 description = klass.description
  752.             except AttributeError:
  753.                 description = "(no description available)"
  754.             rv.append((cmd, description))
  755.         return rv
  756.  
  757.     # -- Command class/object methods ----------------------------------
  758.  
  759.     def get_command_packages(self):
  760.         """Return a list of packages from which commands are loaded."""
  761.         pkgs = self.command_packages
  762.         if not isinstance(pkgs, list):
  763.             if pkgs is None:
  764.                 pkgs = ''
  765.             pkgs = [pkg.strip() for pkg in pkgs.split(',') if pkg != '']
  766.             if "distutils.command" not in pkgs:
  767.                 pkgs.insert(0, "distutils.command")
  768.             self.command_packages = pkgs
  769.         return pkgs
  770.  
  771.     def get_command_class(self, command):
  772.         """Return the class that implements the Distutils command named by
  773.         'command'.  First we check the 'cmdclass' dictionary; if the
  774.         command is mentioned there, we fetch the class object from the
  775.         dictionary and return it.  Otherwise we load the command module
  776.         ("distutils.command." + command) and fetch the command class from
  777.         the module.  The loaded class is also stored in 'cmdclass'
  778.         to speed future calls to 'get_command_class()'.
  779.  
  780.         Raises DistutilsModuleError if the expected module could not be
  781.         found, or if that module does not define the expected class.
  782.         """
  783.         klass = self.cmdclass.get(command)
  784.         if klass:
  785.             return klass
  786.  
  787.         for pkgname in self.get_command_packages():
  788.             module_name = "%s.%s" % (pkgname, command)
  789.             klass_name = command
  790.  
  791.             try:
  792.                 __import__ (module_name)
  793.                 module = sys.modules[module_name]
  794.             except ImportError:
  795.                 continue
  796.  
  797.             try:
  798.                 klass = getattr(module, klass_name)
  799.             except AttributeError:
  800.                 raise DistutilsModuleError(
  801.                       "invalid command '%s' (no class '%s' in module '%s')"
  802.                       % (command, klass_name, module_name))
  803.  
  804.             self.cmdclass[command] = klass
  805.             return klass
  806.  
  807.         raise DistutilsModuleError("invalid command '%s'" % command)
  808.  
  809.     def get_command_obj(self, command, create=1):
  810.         """Return the command object for 'command'.  Normally this object
  811.         is cached on a previous call to 'get_command_obj()'; if no command
  812.         object for 'command' is in the cache, then we either create and
  813.         return it (if 'create' is true) or return None.
  814.         """
  815.         cmd_obj = self.command_obj.get(command)
  816.         if not cmd_obj and create:
  817.             if DEBUG:
  818.                 self.announce("Distribution.get_command_obj(): " \
  819.                               "creating '%s' command object" % command)
  820.  
  821.             klass = self.get_command_class(command)
  822.             cmd_obj = self.command_obj[command] = klass(self)
  823.             self.have_run[command] = 0
  824.  
  825.             # Set any options that were supplied in config files
  826.             # or on the command line.  (NB. support for error
  827.             # reporting is lame here: any errors aren't reported
  828.             # until 'finalize_options()' is called, which means
  829.             # we won't report the source of the error.)
  830.             options = self.command_options.get(command)
  831.             if options:
  832.                 self._set_command_options(cmd_obj, options)
  833.  
  834.         return cmd_obj
  835.  
  836.     def _set_command_options(self, command_obj, option_dict=None):
  837.         """Set the options for 'command_obj' from 'option_dict'.  Basically
  838.         this means copying elements of a dictionary ('option_dict') to
  839.         attributes of an instance ('command').
  840.  
  841.         'command_obj' must be a Command instance.  If 'option_dict' is not
  842.         supplied, uses the standard option dictionary for this command
  843.         (from 'self.command_options').
  844.         """
  845.         command_name = command_obj.get_command_name()
  846.         if option_dict is None:
  847.             option_dict = self.get_option_dict(command_name)
  848.  
  849.         if DEBUG:
  850.             self.announce("  setting options for '%s' command:" % command_name)
  851.         for (option, (source, value)) in option_dict.items():
  852.             if DEBUG:
  853.                 self.announce("    %s = %s (from %s)" % (option, value,
  854.                                                          source))
  855.             try:
  856.                 bool_opts = [translate_longopt(o)
  857.                              for o in command_obj.boolean_options]
  858.             except AttributeError:
  859.                 bool_opts = []
  860.             try:
  861.                 neg_opt = command_obj.negative_opt
  862.             except AttributeError:
  863.                 neg_opt = {}
  864.  
  865.             try:
  866.                 is_string = isinstance(value, str)
  867.                 if option in neg_opt and is_string:
  868.                     setattr(command_obj, neg_opt[option], not strtobool(value))
  869.                 elif option in bool_opts and is_string:
  870.                     setattr(command_obj, option, strtobool(value))
  871.                 elif hasattr(command_obj, option):
  872.                     setattr(command_obj, option, value)
  873.                 else:
  874.                     raise DistutilsOptionError(
  875.                           "error in %s: command '%s' has no such option '%s'"
  876.                           % (source, command_name, option))
  877.             except ValueError as msg:
  878.                 raise DistutilsOptionError(msg)
  879.  
  880.     def reinitialize_command(self, command, reinit_subcommands=0):
  881.         """Reinitializes a command to the state it was in when first
  882.         returned by 'get_command_obj()': ie., initialized but not yet
  883.         finalized.  This provides the opportunity to sneak option
  884.         values in programmatically, overriding or supplementing
  885.         user-supplied values from the config files and command line.
  886.         You'll have to re-finalize the command object (by calling
  887.         'finalize_options()' or 'ensure_finalized()') before using it for
  888.         real.
  889.  
  890.         'command' should be a command name (string) or command object.  If
  891.         'reinit_subcommands' is true, also reinitializes the command's
  892.         sub-commands, as declared by the 'sub_commands' class attribute (if
  893.         it has one).  See the "install" command for an example.  Only
  894.         reinitializes the sub-commands that actually matter, ie. those
  895.         whose test predicates return true.
  896.  
  897.         Returns the reinitialized command object.
  898.         """
  899.         from distutils.cmd import Command
  900.         if not isinstance(command, Command):
  901.             command_name = command
  902.             command = self.get_command_obj(command_name)
  903.         else:
  904.             command_name = command.get_command_name()
  905.  
  906.         if not command.finalized:
  907.             return command
  908.         command.initialize_options()
  909.         command.finalized = 0
  910.         self.have_run[command_name] = 0
  911.         self._set_command_options(command)
  912.  
  913.         if reinit_subcommands:
  914.             for sub in command.get_sub_commands():
  915.                 self.reinitialize_command(sub, reinit_subcommands)
  916.  
  917.         return command
  918.  
  919.     # -- Methods that operate on the Distribution ----------------------
  920.  
  921.     def announce(self, msg, level=log.INFO):
  922.         log.log(level, msg)
  923.  
  924.     def run_commands(self):
  925.         """Run each command that was seen on the setup script command line.
  926.         Uses the list of commands found and cache of command objects
  927.         created by 'get_command_obj()'.
  928.         """
  929.         for cmd in self.commands:
  930.             self.run_command(cmd)
  931.  
  932.     # -- Methods that operate on its Commands --------------------------
  933.  
  934.     def run_command(self, command):
  935.         """Do whatever it takes to run a command (including nothing at all,
  936.         if the command has already been run).  Specifically: if we have
  937.         already created and run the command named by 'command', return
  938.         silently without doing anything.  If the command named by 'command'
  939.         doesn't even have a command object yet, create one.  Then invoke
  940.         'run()' on that command object (or an existing one).
  941.         """
  942.         # Already been here, done that? then return silently.
  943.         if self.have_run.get(command):
  944.             return
  945.  
  946.         log.info("running %s", command)
  947.         cmd_obj = self.get_command_obj(command)
  948.         cmd_obj.ensure_finalized()
  949.         cmd_obj.run()
  950.         self.have_run[command] = 1
  951.  
  952.  
  953.     # -- Distribution query methods ------------------------------------
  954.  
  955.     def has_pure_modules(self):
  956.         return len(self.packages or self.py_modules or []) > 0
  957.  
  958.     def has_ext_modules(self):
  959.         return self.ext_modules and len(self.ext_modules) > 0
  960.  
  961.     def has_c_libraries(self):
  962.         return self.libraries and len(self.libraries) > 0
  963.  
  964.     def has_modules(self):
  965.         return self.has_pure_modules() or self.has_ext_modules()
  966.  
  967.     def has_headers(self):
  968.         return self.headers and len(self.headers) > 0
  969.  
  970.     def has_scripts(self):
  971.         return self.scripts and len(self.scripts) > 0
  972.  
  973.     def has_data_files(self):
  974.         return self.data_files and len(self.data_files) > 0
  975.  
  976.     def is_pure(self):
  977.         return (self.has_pure_modules() and
  978.                 not self.has_ext_modules() and
  979.                 not self.has_c_libraries())
  980.  
  981.     # -- Metadata query methods ----------------------------------------
  982.  
  983.     # If you're looking for 'get_name()', 'get_version()', and so forth,
  984.     # they are defined in a sneaky way: the constructor binds self.get_XXX
  985.     # to self.metadata.get_XXX.  The actual code is in the
  986.     # DistributionMetadata class, below.
  987.  
  988. class DistributionMetadata:
  989.     """Dummy class to hold the distribution meta-data: name, version,
  990.     author, and so forth.
  991.     """
  992.  
  993.     _METHOD_BASENAMES = ("name", "version", "author", "author_email",
  994.                          "maintainer", "maintainer_email", "url",
  995.                          "license", "description", "long_description",
  996.                          "keywords", "platforms", "fullname", "contact",
  997.                          "contact_email", "license", "classifiers",
  998.                          "download_url",
  999.                          # PEP 314
  1000.                          "provides", "requires", "obsoletes",
  1001.                          )
  1002.  
  1003.     def __init__(self, path=None):
  1004.         if path is not None:
  1005.             self.read_pkg_file(open(path))
  1006.         else:
  1007.             self.name = None
  1008.             self.version = None
  1009.             self.author = None
  1010.             self.author_email = None
  1011.             self.maintainer = None
  1012.             self.maintainer_email = None
  1013.             self.url = None
  1014.             self.license = None
  1015.             self.description = None
  1016.             self.long_description = None
  1017.             self.keywords = None
  1018.             self.platforms = None
  1019.             self.classifiers = None
  1020.             self.download_url = None
  1021.             # PEP 314
  1022.             self.provides = None
  1023.             self.requires = None
  1024.             self.obsoletes = None
  1025.  
  1026.     def read_pkg_file(self, file):
  1027.         """Reads the metadata values from a file object."""
  1028.         msg = message_from_file(file)
  1029.  
  1030.         def _read_field(name):
  1031.             value = msg[name]
  1032.             if value == 'UNKNOWN':
  1033.                 return None
  1034.             return value
  1035.  
  1036.         def _read_list(name):
  1037.             values = msg.get_all(name, None)
  1038.             if values == []:
  1039.                 return None
  1040.             return values
  1041.  
  1042.         metadata_version = msg['metadata-version']
  1043.         self.name = _read_field('name')
  1044.         self.version = _read_field('version')
  1045.         self.description = _read_field('summary')
  1046.         # we are filling author only.
  1047.         self.author = _read_field('author')
  1048.         self.maintainer = None
  1049.         self.author_email = _read_field('author-email')
  1050.         self.maintainer_email = None
  1051.         self.url = _read_field('home-page')
  1052.         self.license = _read_field('license')
  1053.  
  1054.         if 'download-url' in msg:
  1055.             self.download_url = _read_field('download-url')
  1056.         else:
  1057.             self.download_url = None
  1058.  
  1059.         self.long_description = _read_field('description')
  1060.         self.description = _read_field('summary')
  1061.  
  1062.         if 'keywords' in msg:
  1063.             self.keywords = _read_field('keywords').split(',')
  1064.  
  1065.         self.platforms = _read_list('platform')
  1066.         self.classifiers = _read_list('classifier')
  1067.  
  1068.         # PEP 314 - these fields only exist in 1.1
  1069.         if metadata_version == '1.1':
  1070.             self.requires = _read_list('requires')
  1071.             self.provides = _read_list('provides')
  1072.             self.obsoletes = _read_list('obsoletes')
  1073.         else:
  1074.             self.requires = None
  1075.             self.provides = None
  1076.             self.obsoletes = None
  1077.  
  1078.     def write_pkg_info(self, base_dir):
  1079.         """Write the PKG-INFO file into the release tree.
  1080.         """
  1081.         with open(os.path.join(base_dir, 'PKG-INFO'), 'w',
  1082.                   encoding='UTF-8') as pkg_info:
  1083.             self.write_pkg_file(pkg_info)
  1084.  
  1085.     def write_pkg_file(self, file):
  1086.         """Write the PKG-INFO format data to a file object.
  1087.         """
  1088.         version = '1.0'
  1089.         if (self.provides or self.requires or self.obsoletes or
  1090.             self.classifiers or self.download_url):
  1091.             version = '1.1'
  1092.  
  1093.         file.write('Metadata-Version: %s\n' % version)
  1094.         file.write('Name: %s\n' % self.get_name() )
  1095.         file.write('Version: %s\n' % self.get_version() )
  1096.         file.write('Summary: %s\n' % self.get_description() )
  1097.         file.write('Home-page: %s\n' % self.get_url() )
  1098.         file.write('Author: %s\n' % self.get_contact() )
  1099.         file.write('Author-email: %s\n' % self.get_contact_email() )
  1100.         file.write('License: %s\n' % self.get_license() )
  1101.         if self.download_url:
  1102.             file.write('Download-URL: %s\n' % self.download_url)
  1103.  
  1104.         long_desc = rfc822_escape(self.get_long_description())
  1105.         file.write('Description: %s\n' % long_desc)
  1106.  
  1107.         keywords = ','.join(self.get_keywords())
  1108.         if keywords:
  1109.             file.write('Keywords: %s\n' % keywords )
  1110.  
  1111.         self._write_list(file, 'Platform', self.get_platforms())
  1112.         self._write_list(file, 'Classifier', self.get_classifiers())
  1113.  
  1114.         # PEP 314
  1115.         self._write_list(file, 'Requires', self.get_requires())
  1116.         self._write_list(file, 'Provides', self.get_provides())
  1117.         self._write_list(file, 'Obsoletes', self.get_obsoletes())
  1118.  
  1119.     def _write_list(self, file, name, values):
  1120.         for value in values:
  1121.             file.write('%s: %s\n' % (name, value))
  1122.  
  1123.     # -- Metadata query methods ----------------------------------------
  1124.  
  1125.     def get_name(self):
  1126.         return self.name or "UNKNOWN"
  1127.  
  1128.     def get_version(self):
  1129.         return self.version or "0.0.0"
  1130.  
  1131.     def get_fullname(self):
  1132.         return "%s-%s" % (self.get_name(), self.get_version())
  1133.  
  1134.     def get_author(self):
  1135.         return self.author or "UNKNOWN"
  1136.  
  1137.     def get_author_email(self):
  1138.         return self.author_email or "UNKNOWN"
  1139.  
  1140.     def get_maintainer(self):
  1141.         return self.maintainer or "UNKNOWN"
  1142.  
  1143.     def get_maintainer_email(self):
  1144.         return self.maintainer_email or "UNKNOWN"
  1145.  
  1146.     def get_contact(self):
  1147.         return self.maintainer or self.author or "UNKNOWN"
  1148.  
  1149.     def get_contact_email(self):
  1150.         return self.maintainer_email or self.author_email or "UNKNOWN"
  1151.  
  1152.     def get_url(self):
  1153.         return self.url or "UNKNOWN"
  1154.  
  1155.     def get_license(self):
  1156.         return self.license or "UNKNOWN"
  1157.     get_licence = get_license
  1158.  
  1159.     def get_description(self):
  1160.         return self.description or "UNKNOWN"
  1161.  
  1162.     def get_long_description(self):
  1163.         return self.long_description or "UNKNOWN"
  1164.  
  1165.     def get_keywords(self):
  1166.         return self.keywords or []
  1167.  
  1168.     def get_platforms(self):
  1169.         return self.platforms or ["UNKNOWN"]
  1170.  
  1171.     def get_classifiers(self):
  1172.         return self.classifiers or []
  1173.  
  1174.     def get_download_url(self):
  1175.         return self.download_url or "UNKNOWN"
  1176.  
  1177.     # PEP 314
  1178.     def get_requires(self):
  1179.         return self.requires or []
  1180.  
  1181.     def set_requires(self, value):
  1182.         import distutils.versionpredicate
  1183.         for v in value:
  1184.             distutils.versionpredicate.VersionPredicate(v)
  1185.         self.requires = value
  1186.  
  1187.     def get_provides(self):
  1188.         return self.provides or []
  1189.  
  1190.     def set_provides(self, value):
  1191.         value = [v.strip() for v in value]
  1192.         for v in value:
  1193.             import distutils.versionpredicate
  1194.             distutils.versionpredicate.split_provision(v)
  1195.         self.provides = value
  1196.  
  1197.     def get_obsoletes(self):
  1198.         return self.obsoletes or []
  1199.  
  1200.     def set_obsoletes(self, value):
  1201.         import distutils.versionpredicate
  1202.         for v in value:
  1203.             distutils.versionpredicate.VersionPredicate(v)
  1204.         self.obsoletes = value
  1205.  
  1206. def fix_help_options(options):
  1207.     """Convert a 4-tuple 'help_options' list as found in various command
  1208.     classes to the 3-tuple form required by FancyGetopt.
  1209.     """
  1210.     new_options = []
  1211.     for help_tuple in options:
  1212.         new_options.append(help_tuple[0:3])
  1213.     return new_options
  1214.