EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS

[mirror_edk2.git] / AppPkg / Applications / Python / Python-2.7.2 / Lib / distutils / core.py

"""distutils.core\r
\r
The only module that needs to be imported to use the Distutils; provides\r
the 'setup' function (which is to be called from the setup script).  Also\r
indirectly provides the Distribution and Command classes, although they are\r
really defined in distutils.dist and distutils.cmd.\r
"""\r
\r
__revision__ = "$Id$"\r
\r
import sys\r
import os\r
\r
from distutils.debug import DEBUG\r
from distutils.errors import (DistutilsSetupError, DistutilsArgError,\r
                              DistutilsError, CCompilerError)\r
from distutils.util import grok_environment_error\r
\r
# Mainly import these so setup scripts can "from distutils.core import" them.\r
from distutils.dist import Distribution\r
from distutils.cmd import Command\r
from distutils.config import PyPIRCCommand\r
from distutils.extension import Extension\r
\r
# This is a barebones help message generated displayed when the user\r
# runs the setup script with no arguments at all.  More useful help\r
# is generated with various --help options: global help, list commands,\r
# and per-command help.\r
USAGE = """\\r
usage: %(script)s [global_opts] cmd1 [cmd1_opts] [cmd2 [cmd2_opts] ...]\r
   or: %(script)s --help [cmd1 cmd2 ...]\r
   or: %(script)s --help-commands\r
   or: %(script)s cmd --help\r
"""\r
\r
def gen_usage(script_name):\r
    script = os.path.basename(script_name)\r
    return USAGE % {'script': script}\r
\r
\r
# Some mild magic to control the behaviour of 'setup()' from 'run_setup()'.\r
_setup_stop_after = None\r
_setup_distribution = None\r
\r
# Legal keyword arguments for the setup() function\r
setup_keywords = ('distclass', 'script_name', 'script_args', 'options',\r
                  'name', 'version', 'author', 'author_email',\r
                  'maintainer', 'maintainer_email', 'url', 'license',\r
                  'description', 'long_description', 'keywords',\r
                  'platforms', 'classifiers', 'download_url',\r
                  'requires', 'provides', 'obsoletes',\r
                  )\r
\r
# Legal keyword arguments for the Extension constructor\r
extension_keywords = ('name', 'sources', 'include_dirs',\r
                      'define_macros', 'undef_macros',\r
                      'library_dirs', 'libraries', 'runtime_library_dirs',\r
                      'extra_objects', 'extra_compile_args', 'extra_link_args',\r
                      'swig_opts', 'export_symbols', 'depends', 'language')\r
\r
def setup(**attrs):\r
    """The gateway to the Distutils: do everything your setup script needs\r
    to do, in a highly flexible and user-driven way.  Briefly: create a\r
    Distribution instance; find and parse config files; parse the command\r
    line; run each Distutils command found there, customized by the options\r
    supplied to 'setup()' (as keyword arguments), in config files, and on\r
    the command line.\r
\r
    The Distribution instance might be an instance of a class supplied via\r
    the 'distclass' keyword argument to 'setup'; if no such class is\r
    supplied, then the Distribution class (in dist.py) is instantiated.\r
    All other arguments to 'setup' (except for 'cmdclass') are used to set\r
    attributes of the Distribution instance.\r
\r
    The 'cmdclass' argument, if supplied, is a dictionary mapping command\r
    names to command classes.  Each command encountered on the command line\r
    will be turned into a command class, which is in turn instantiated; any\r
    class found in 'cmdclass' is used in place of the default, which is\r
    (for command 'foo_bar') class 'foo_bar' in module\r
    'distutils.command.foo_bar'.  The command class must provide a\r
    'user_options' attribute which is a list of option specifiers for\r
    'distutils.fancy_getopt'.  Any command-line options between the current\r
    and the next command are used to set attributes of the current command\r
    object.\r
\r
    When the entire command-line has been successfully parsed, calls the\r
    'run()' method on each command object in turn.  This method will be\r
    driven entirely by the Distribution object (which each command object\r
    has a reference to, thanks to its constructor), and the\r
    command-specific options that became attributes of each command\r
    object.\r
    """\r
\r
    global _setup_stop_after, _setup_distribution\r
\r
    # Determine the distribution class -- either caller-supplied or\r
    # our Distribution (see below).\r
    klass = attrs.get('distclass')\r
    if klass:\r
        del attrs['distclass']\r
    else:\r
        klass = Distribution\r
\r
    if 'script_name' not in attrs:\r
        attrs['script_name'] = os.path.basename(sys.argv[0])\r
    if 'script_args' not in attrs:\r
        attrs['script_args'] = sys.argv[1:]\r
\r
    # Create the Distribution instance, using the remaining arguments\r
    # (ie. everything except distclass) to initialize it\r
    try:\r
        _setup_distribution = dist = klass(attrs)\r
    except DistutilsSetupError, msg:\r
        if 'name' in attrs:\r
            raise SystemExit, "error in %s setup command: %s" % \\r
                  (attrs['name'], msg)\r
        else:\r
            raise SystemExit, "error in setup command: %s" % msg\r
\r
    if _setup_stop_after == "init":\r
        return dist\r
\r
    # Find and parse the config file(s): they will override options from\r
    # the setup script, but be overridden by the command line.\r
    dist.parse_config_files()\r
\r
    if DEBUG:\r
        print "options (after parsing config files):"\r
        dist.dump_option_dicts()\r
\r
    if _setup_stop_after == "config":\r
        return dist\r
\r
    # Parse the command line and override config files; any\r
    # command-line errors are the end user's fault, so turn them into\r
    # SystemExit to suppress tracebacks.\r
    try:\r
        ok = dist.parse_command_line()\r
    except DistutilsArgError, msg:\r
        raise SystemExit, gen_usage(dist.script_name) + "\nerror: %s" % msg\r
\r
    if DEBUG:\r
        print "options (after parsing command line):"\r
        dist.dump_option_dicts()\r
\r
    if _setup_stop_after == "commandline":\r
        return dist\r
\r
    # And finally, run all the commands found on the command line.\r
    if ok:\r
        try:\r
            dist.run_commands()\r
        except KeyboardInterrupt:\r
            raise SystemExit, "interrupted"\r
        except (IOError, os.error), exc:\r
            error = grok_environment_error(exc)\r
\r
            if DEBUG:\r
                sys.stderr.write(error + "\n")\r
                raise\r
            else:\r
                raise SystemExit, error\r
\r
        except (DistutilsError,\r
                CCompilerError), msg:\r
            if DEBUG:\r
                raise\r
            else:\r
                raise SystemExit, "error: " + str(msg)\r
\r
    return dist\r
\r
\r
def run_setup(script_name, script_args=None, stop_after="run"):\r
    """Run a setup script in a somewhat controlled environment, and\r
    return the Distribution instance that drives things.  This is useful\r
    if you need to find out the distribution meta-data (passed as\r
    keyword args from 'script' to 'setup()', or the contents of the\r
    config files or command-line.\r
\r
    'script_name' is a file that will be run with 'execfile()';\r
    'sys.argv[0]' will be replaced with 'script' for the duration of the\r
    call.  'script_args' is a list of strings; if supplied,\r
    'sys.argv[1:]' will be replaced by 'script_args' for the duration of\r
    the call.\r
\r
    'stop_after' tells 'setup()' when to stop processing; possible\r
    values:\r
      init\r
        stop after the Distribution instance has been created and\r
        populated with the keyword arguments to 'setup()'\r
      config\r
        stop after config files have been parsed (and their data\r
        stored in the Distribution instance)\r
      commandline\r
        stop after the command-line ('sys.argv[1:]' or 'script_args')\r
        have been parsed (and the data stored in the Distribution)\r
      run [default]\r
        stop after all commands have been run (the same as if 'setup()'\r
        had been called in the usual way\r
\r
    Returns the Distribution instance, which provides all information\r
    used to drive the Distutils.\r
    """\r
    if stop_after not in ('init', 'config', 'commandline', 'run'):\r
        raise ValueError, "invalid value for 'stop_after': %r" % (stop_after,)\r
\r
    global _setup_stop_after, _setup_distribution\r
    _setup_stop_after = stop_after\r
\r
    save_argv = sys.argv\r
    g = {'__file__': script_name}\r
    l = {}\r
    try:\r
        try:\r
            sys.argv[0] = script_name\r
            if script_args is not None:\r
                sys.argv[1:] = script_args\r
            f = open(script_name)\r
            try:\r
                exec f.read() in g, l\r
            finally:\r
                f.close()\r
        finally:\r
            sys.argv = save_argv\r
            _setup_stop_after = None\r
    except SystemExit:\r
        # Hmm, should we do something if exiting with a non-zero code\r
        # (ie. error)?\r
        pass\r
    except:\r
        raise\r
\r
    if _setup_distribution is None:\r
        raise RuntimeError, \\r
              ("'distutils.core.setup()' was never called -- "\r
               "perhaps '%s' is not a Distutils setup script?") % \\r
              script_name\r
\r
    # I wonder if the setup script's namespace -- g and l -- would be of\r
    # any interest to callers?\r
    return _setup_distribution\r