distutils.core
index
/usr/lib/python2.1/distutils/core.py

distutils.core
 
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.

 
Modules
            
os
sys

 
Functions
            
gen_usage(script_name)
run_setup(script_name, script_args=None, stop_after='run')
Run a setup script in a somewhat controlled environment, and
return the Distribution instance that drives things.  This is useful
if you need to find out the distribution meta-data (passed as
keyword args from 'script' to 'setup()', or the contents of the
config files or command-line.
 
'script_name' is a file that will be run with 'execfile()';
'sys.argv[0]' will be replaced with 'script' for the duration of the
call.  'script_args' is a list of strings; if supplied,
'sys.argv[1:]' will be replaced by 'script_args' for the duration of
the call.
 
'stop_after' tells 'setup()' when to stop processing; possible
values:
  init
    stop after the Distribution instance has been created and
    populated with the keyword arguments to 'setup()'
  config
    stop after config files have been parsed (and their data
    stored in the Distribution instance)
  commandline
    stop after the command-line ('sys.argv[1:]' or 'script_args')
    have been parsed (and the data stored in the Distribution)
  run [default]
    stop after all commands have been run (the same as if 'setup()'
    had been called in the usual way
 
Returns the Distribution instance, which provides all information
used to drive the Distutils.
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; find and parse config files; parse the command
line; run each Distutils command found there, customized by 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.

 
Data
             BufferType = <type 'buffer'>
BuiltinFunctionType = <type 'builtin_function_or_method'>
BuiltinMethodType = <type 'builtin_function_or_method'>
ClassType = <type 'class'>
CodeType = <type 'code'>
ComplexType = <type 'complex'>
DEBUG = None
DictType = <type 'dictionary'>
DictionaryType = <type 'dictionary'>
EllipsisType = <type 'ellipsis'>
FileType = <type 'file'>
FloatType = <type 'float'>
FrameType = <type 'frame'>
FunctionType = <type 'function'>
InstanceType = <type 'instance'>
IntType = <type 'int'>
LambdaType = <type 'function'>
ListType = <type 'list'>
LongType = <type 'long int'>
MethodType = <type 'instance method'>
ModuleType = <type 'module'>
NoneType = <type 'None'>
SliceType = <type 'slice'>
StringType = <type 'string'>
TracebackType = <type 'traceback'>
TupleType = <type 'tuple'>
TypeType = <type 'type'>
USAGE = 'usage: %(script)s [global_opts] cmd1 [cmd1_opts]...t)s --help-commands\n or: %(script)s cmd --help\n'
UnboundMethodType = <type 'instance method'>
UnicodeType = <type 'unicode'>
XRangeType = <type 'xrange'>
__file__ = '/usr/lib/python2.1/distutils/core.pyc'
__name__ = 'distutils.core'
__revision__ = '$Id: core.py,v 1.46 2000/09/26 01:48:44 gward Exp $'
_setup_distribution = None
_setup_stop_after = None