diff options
Diffstat (limited to 'Lib/distutils/core.py')
| -rw-r--r-- | Lib/distutils/core.py | 64 |
1 files changed, 33 insertions, 31 deletions
diff --git a/Lib/distutils/core.py b/Lib/distutils/core.py index 8903603..9e390ac 100644 --- a/Lib/distutils/core.py +++ b/Lib/distutils/core.py @@ -3,7 +3,8 @@ The only module that needs to be imported to use the Distutils; provides the 'setup' function (which is to be called from the setup script). Also indirectly provides the Distribution and Command classes, although they are -really defined in distutils.dist and distutils.cmd.""" +really defined in distutils.dist and distutils.cmd. +""" # created 1999/03/01, Greg Ward @@ -37,36 +38,37 @@ DEBUG = os.environ.get('DISTUTILS_DEBUG') def setup (**attrs): - """The gateway to the Distutils: do everything your setup script - needs to do, in a highly flexible and user-driven way. Briefly: - create a Distribution instance; parse the command-line, creating - and customizing instances of the command class for each command - found on the command-line; run each of those commands. - - The Distribution instance might be an instance of a class - supplied via the 'distclass' keyword argument to 'setup'; if no - such class is supplied, then the 'Distribution' class (also in - this module) is instantiated. All other arguments to 'setup' - (except for 'cmdclass') are used to set attributes of the - Distribution instance. - - The 'cmdclass' argument, if supplied, is a dictionary mapping - command names to command classes. Each command encountered on - the command line will be turned into a command class, which is in - turn instantiated; any class found in 'cmdclass' is used in place - of the default, which is (for command 'foo_bar') class 'foo_bar' - in module 'distutils.command.foo_bar'. The command class must - provide a 'user_options' attribute which is a list of option - specifiers for 'distutils.fancy_getopt'. Any command-line - options between the current and the next command are used to set - attributes of the current command object. - - When the entire command-line has been successfully parsed, calls - the 'run()' method on each command object in turn. This method - will be driven entirely by the Distribution object (which each - command object has a reference to, thanks to its constructor), - and the command-specific options that became attributes of each - command object.""" + """The gateway to the Distutils: do everything your setup script needs + to do, in a highly flexible and user-driven way. Briefly: create a + Distribution instance; find and parse config files; parse the command + line; run each of those commands using the options supplied to + 'setup()' (as keyword arguments), in config files, and on the command + line. + + The Distribution instance might be an instance of a class supplied via + the 'distclass' keyword argument to 'setup'; if no such class is + supplied, then the Distribution class (in dist.py) is instantiated. + All other arguments to 'setup' (except for 'cmdclass') are used to set + attributes of the Distribution instance. + + The 'cmdclass' argument, if supplied, is a dictionary mapping command + names to command classes. Each command encountered on the command line + will be turned into a command class, which is in turn instantiated; any + class found in 'cmdclass' is used in place of the default, which is + (for command 'foo_bar') class 'foo_bar' in module + 'distutils.command.foo_bar'. The command class must provide a + 'user_options' attribute which is a list of option specifiers for + 'distutils.fancy_getopt'. Any command-line options between the current + and the next command are used to set attributes of the current command + object. + + When the entire command-line has been successfully parsed, calls the + 'run()' method on each command object in turn. This method will be + driven entirely by the Distribution object (which each command object + has a reference to, thanks to its constructor), and the + command-specific options that became attributes of each command + object. + """ from pprint import pprint # for debugging output |