Python: module simpleparse.setupstt

simpleparse.setupstt (version 2.1.1) | index /home/mcfletch/pylive/simpleparse/setupstt.pyc

`Distutils Extensions needed for the mx Extensions.
Copyright (c) 1997-2000, Marc-Andre Lemburg; mailto:mal@lemburg.com
Copyright (c) 2000-2003, eGenix.com Software GmbH; mailto:info@egenix.com
See the documentation for further information on copyrights,
or contact the author. All Rights Reserved.`

Modules
`` |  |
distutils glob | os re | string sys | types

Classes
`` |  | Command mx_build_unixlib mx_uninstall bdist_dumb(Command) mx_bdist_zope bdist_rpm(Command) mx_bdist_rpm build(Command) mx_build build_clib(Command) mx_build_clib build_py(Command) mx_build_py install(Command) mx_install install_data(Command) mx_install_data Distribution mx_Distribution Extension mx_Extension CompilerSupportMixin mx_autoconf(CompilerSupportMixin, config) mx_build_ext(CompilerSupportMixin, build_ext) UnixLibrary
class CompilerSupportMixin
`` | `Compiler support mixin which makes sure that the .compiler attribute is properly setup.`
| Methods defined here: prepare_compiler(self) Data and other attributes defined here: prepared_compiler = 0
class UnixLibrary
`` | `Container for library configuration data.`
| Methods defined here: __init__(self, libname, sourcetree, libfiles, configure=None, configure_options=None, make_options=None) get(self, option, alternative=None) Data and other attributes defined here: configure = 'configure' configure_options = None libfiles = None libname = '' make_options = None sourcetree = ''
class mx_Distribution(Distribution)
`` | `Distribution class which knows about our distutils extensions.`
| Methods defined here: has_unixlibs(self) Data and other attributes defined here: display_option_names = ['help_commands', 'name', 'version', 'fullname', 'author', 'author_email', 'maintainer', 'maintainer_email', 'contact', 'contact_email', 'url', 'license', 'licence', 'description', 'long_description', 'platforms', 'classifiers', 'keywords', 'classifiers'] display_options = [('help-commands', None, 'list all available commands'), ('name', None, 'print package name'), ('version', 'V', 'print package version'), ('fullname', None, 'print <package name>-<version>'), ('author', None, "print the author's name"), ('author-email', None, "print the author's email address"), ('maintainer', None, "print the maintainer's name"), ('maintainer-email', None, "print the maintainer's email address"), ('contact', None, "print the maintainer's name if known, else the author's"), ('contact-email', None, "print the maintainer's email address if known, else the author's"), ('url', None, 'print the URL for this package'), ('license', None, 'print the license of the package'), ('licence', None, 'alias for --license'), ('description', None, 'print the package description'), ('long-description', None, 'print the long package description'), ('platforms', None, 'print the list of platforms'), ('classifiers', None, 'print the list of classifiers'), ('keywords', None, 'print the list of keywords'), ('classifiers', None, 'print the list of classifiers (not yet supported)')] unixlibs = None Methods inherited from Distribution: __init__(self, attrs=None) `Construct a new Distribution instance: initialize all the attributes of a Distribution, and then use 'attrs' (a dictionary mapping attribute names to values) to assign some of those attributes their "real" values. (Any attributes not mentioned in 'attrs' will be assigned to some null value: 0, None, an empty list or dictionary, etc.) Most importantly, initialize the 'command_obj' attribute to the empty dictionary; this will be filled in with real command objects by 'parse_command_line()'.` announce(self, msg, level=1) dump_option_dicts(self, header=None, commands=None, indent='') finalize_options(self) `Set final values for all the options on the Distribution instance, analogous to the .finalize_options() method of Command objects.` find_config_files(self) `Find as many configuration files as should be processed for this platform, and return a list of filenames in the order in which they should be parsed. The filenames returned are guaranteed to exist (modulo nasty race conditions). There are three possible config files: distutils.cfg in the Distutils installation directory (ie. where the top-level Distutils __inst__.py file lives), a file in the user's home directory named .pydistutils.cfg on Unix and pydistutils.cfg on Windows/Mac, and setup.cfg in the current directory.` get_command_class(self, command) `Return the class that implements the Distutils command named by 'command'. First we check the 'cmdclass' dictionary; if the command is mentioned there, we fetch the class object from the dictionary and return it. Otherwise we load the command module ("distutils.command." + command) and fetch the command class from the module. The loaded class is also stored in 'cmdclass' to speed future calls to 'get_command_class()'. Raises DistutilsModuleError if the expected module could not be found, or if that module does not define the expected class.` get_command_list(self) `Get a list of (command, description) tuples. The list is divided into "standard commands" (listed in distutils.command.__all__) and "extra commands" (mentioned in self.cmdclass, but not a standard command). The descriptions come from the command class attribute 'description'.` get_command_obj(self, command, create=1) `Return the command object for 'command'. Normally this object is cached on a previous call to 'get_command_obj()'; if no command object for 'command' is in the cache, then we either create and return it (if 'create' is true) or return None.` get_command_packages(self) `Return a list of packages from which commands are loaded.` get_option_dict(self, command) `Get the option dictionary for a given command. If that command's option dictionary hasn't been created yet, then create it and return the new dictionary; otherwise, return the existing option dictionary.` handle_display_options(self, option_order) `If there were any non-global "display-only" options (--help-commands or the metadata display options) on the command line, display the requested info and return true; else return false.` has_c_libraries(self) has_data_files(self) has_ext_modules(self) has_headers(self) has_modules(self) has_pure_modules(self) has_scripts(self) is_pure(self) parse_command_line(self) `Parse the setup script's command line, taken from the 'script_args' instance attribute (which defaults to 'sys.argv[1:]' -- see 'setup()' in core.py). This list is first processed for "global options" -- options that set attributes of the Distribution instance. Then, it is alternately scanned for Distutils commands and options for that command. Each new command terminates the options for the previous command. The allowed options for a command are determined by the 'user_options' attribute of the command class -- thus, we have to be able to load command classes in order to parse the command line. Any error in that 'options' attribute raises DistutilsGetoptError; any error on the command-line raises DistutilsArgError. If no Distutils commands were found on the command line, raises DistutilsArgError. Return true if command-line was successfully parsed and we should carry on with executing commands; false if no errors but we shouldn't execute commands (currently, this only happens if user asks for help).` parse_config_files(self, filenames=None) print_command_list(self, commands, header, max_length) `Print a subset of the list of all commands -- used by 'print_commands()'.` print_commands(self) `Print out a help message listing all available commands with a description of each. The list is divided into "standard commands" (listed in distutils.command.__all__) and "extra commands" (mentioned in self.cmdclass, but not a standard command). The descriptions come from the command class attribute 'description'.` reinitialize_command(self, command, reinit_subcommands=0) `Reinitializes a command to the state it was in when first returned by 'get_command_obj()': ie., initialized but not yet finalized. This provides the opportunity to sneak option values in programmatically, overriding or supplementing user-supplied values from the config files and command line. You'll have to re-finalize the command object (by calling 'finalize_options()' or 'ensure_finalized()') before using it for real. 'command' should be a command name (string) or command object. If 'reinit_subcommands' is true, also reinitializes the command's sub-commands, as declared by the 'sub_commands' class attribute (if it has one). See the "install" command for an example. Only reinitializes the sub-commands that actually matter, ie. those whose test predicates return true. Returns the reinitialized command object.` run_command(self, command) `Do whatever it takes to run a command (including nothing at all, if the command has already been run). Specifically: if we have already created and run the command named by 'command', return silently without doing anything. If the command named by 'command' doesn't even have a command object yet, create one. Then invoke 'run()' on that command object (or an existing one).` run_commands(self) `Run each command that was seen on the setup script command line. Uses the list of commands found and cache of command objects created by 'get_command_obj()'.` Data and other attributes inherited from Distribution: global_options = [('verbose', 'v', 'run verbosely (default)', 1), ('quiet', 'q', 'run quietly (turns verbosity off)'), ('dry-run', 'n', "don't actually do anything"), ('help', 'h', 'show detailed help message')] negative_opt = {'quiet': 'verbose'}
class mx_Extension(Extension)
`` | `Extension class which allows specifying whether the extension is required to build or optional.`
| Methods defined here: __init__(self, *args, **kws) Data and other attributes defined here: data_files = () lib_types = ('shared', 'static') needed_includes = () needed_libraries = () optional_libraries = () packages = () required = 1 successfully_built = 0
class mx_autoconf(CompilerSupportMixin, config)
`` | `Auto-configuration class which adds some extra configuration settings to the packages.`
| Method resolution order: mx_autoconf CompilerSupportMixin config Command Methods defined here: check_bad_staticforward(self) `Check whether the compiler does not supports forward declaring static arrays. For documentation of the other arguments see the base class' .try_link().` check_compiler(self, sourcecode, headers=None, include_dirs=None, libraries=None, library_dirs=None) `Check whether sourcecode compiles and links with the current compiler and link environment. For documentation of the other arguments see the base class' .try_link().` check_function(self, function, headers=None, include_dirs=None, libraries=None, library_dirs=None, prototype=0, call=0) `Check whether function is available in the given compile and link environment. If prototype is true, a function prototype is included in the test. If call is true, a function call is generated (rather than just a reference of the function symbol). For documentation of the other arguments see the base class' .try_link().` check_library(self, library, library_dirs=None, headers=None, include_dirs=None, other_libraries=[]) `Check whether we can link against the given library. For documentation of the other arguments see the base class' .try_link().` finalize_options(self) find_include_file(self, filename, paths, pattern=None) `Find an include file of the given name. The search path is determined by the paths parameter, the compiler's .include_dirs attribute and the STDINCLPATH and FINDINCLPATH globals. The search is done in this order.` find_library_file(self, libname, paths, pattern=None, lib_types=('shared', 'static')) `Find a library of the given name. The search path is determined by the paths parameter, the compiler's .library_dirs attribute and the STDLIBPATH and FINDLIBPATH globals. The search is done in this order. Shared libraries are prefered over static ones if both types are given in lib_types.` initialize_options(self) prepare_compiler(self) run(self) Data and other attributes defined here: api_checks = (('strftime', ['time.h']), ('strptime', ['time.h']), ('timegm', ['time.h'])) description = 'auto-configuration build step (for internal use only)' enable_debugging = 0 user_options = [('compiler=', None, 'specify the compiler type'), ('cc=', None, 'specify the compiler executable'), ('include-dirs=', 'I', 'list of directories to search for header files'), ('define=', 'D', 'C preprocessor macros to define'), ('undef=', 'U', 'C preprocessor macros to undefine'), ('libraries=', 'l', 'external C libraries to link with'), ('library-dirs=', 'L', 'directories to search for external C libraries'), ('noisy', None, 'show every action (compile, link, run, ...) taken'), ('dump-source', None, 'dump generated source files before attempting to compile them'), ('enable-debugging', None, 'compile with debugging support')] Data and other attributes inherited from CompilerSupportMixin: prepared_compiler = 0 Methods inherited from config: check_func(self, func, headers=None, include_dirs=None, libraries=None, library_dirs=None, decl=0, call=0) `Determine if function 'func' is available by constructing a source file that refers to 'func', and compiles and links it. If everything succeeds, returns true; otherwise returns false. The constructed source file starts out by including the header files listed in 'headers'. If 'decl' is true, it then declares 'func' (as "int func()"); you probably shouldn't supply 'headers' and set 'decl' true in the same call, or you might get errors about a conflicting declarations for 'func'. Finally, the constructed 'main()' function either references 'func' or (if 'call' is true) calls it. 'libraries' and 'library_dirs' are used when linking.` check_header(self, header, include_dirs=None, library_dirs=None, lang='c') `Determine if the system header file named by 'header_file' exists and can be found by the preprocessor; return true if so, false otherwise.` check_lib(self, library, library_dirs=None, headers=None, include_dirs=None, other_libraries=[]) `Determine if 'library' is available to be linked against, without actually checking that any particular symbols are provided by it. 'headers' will be used in constructing the source file to be compiled, but the only effect of this is to check if all the header files listed are available. Any libraries listed in 'other_libraries' will be included in the link, in case 'library' has symbols that depend on other libraries.` search_cpp(self, pattern, body=None, headers=None, include_dirs=None, lang='c') `Construct a source file (just like 'try_cpp()'), run it through the preprocessor, and return true if any line of the output matches 'pattern'. 'pattern' should either be a compiled regex object or a string containing a regex. If both 'body' and 'headers' are None, preprocesses an empty file -- which can be useful to determine the symbols the preprocessor and compiler set by default.` try_compile(self, body, headers=None, include_dirs=None, lang='c') `Try to compile a source file built from 'body' and 'headers'. Return true on success, false otherwise.` try_cpp(self, body=None, headers=None, include_dirs=None, lang='c') `Construct a source file from 'body' (a string containing lines of C/C++ code) and 'headers' (a list of header files to include) and run it through the preprocessor. Return true if the preprocessor succeeded, false if there were any errors. ('body' probably isn't of much use, but what the heck.)` try_link(self, body, headers=None, include_dirs=None, libraries=None, library_dirs=None, lang='c') `Try to compile and link a source file, built from 'body' and 'headers', to executable form. Return true on success, false otherwise.` try_run(self, body, headers=None, include_dirs=None, libraries=None, library_dirs=None, lang='c') `Try to compile, link to an executable, and run a program built from 'body' and 'headers'. Return true on success, false otherwise.` Methods inherited from Command: __getattr__(self, attr) __init__(self, dist) `Create and initialize a new Command object. Most importantly, invokes the 'initialize_options()' method, which is the real initializer and depends on the actual command being instantiated.` announce(self, msg, level=1) `If the current verbosity level is of greater than or equal to 'level' print 'msg' to stdout.` copy_file(self, infile, outfile, preserve_mode=1, preserve_times=1, link=None, level=1) `Copy a file respecting verbose, dry-run and force flags. (The former two default to whatever is in the Distribution object, and the latter defaults to false for commands that don't define it.)` copy_tree(self, infile, outfile, preserve_mode=1, preserve_times=1, preserve_symlinks=0, level=1) `Copy an entire directory tree respecting verbose, dry-run, and force flags.` debug_print(self, msg) `Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true.` dump_options(self, header=None, indent='') ensure_dirname(self, option) ensure_filename(self, option) `Ensure that 'option' is the name of an existing file.` ensure_finalized(self) ensure_string(self, option, default=None) `Ensure that 'option' is a string; if not defined, set it to 'default'.` ensure_string_list(self, option) `Ensure that 'option' is a list of strings. If 'option' is currently a string, we split it either on /,\s*/ or /\s+/, so "foo bar baz", "foo,bar,baz", and "foo, bar baz" all become ["foo", "bar", "baz"].` execute(self, func, args, msg=None, level=1) get_command_name(self) get_finalized_command(self, command, create=1) `Wrapper around Distribution's 'get_command_obj()' method: find (create if necessary and 'create' is true) the command object for 'command', call its 'ensure_finalized()' method, and return the finalized command object.` get_sub_commands(self) `Determine the sub-commands that are relevant in the current distribution (ie., that need to be run). This is based on the 'sub_commands' class attribute: each tuple in that list may include a method that we call to determine if the subcommand needs to be run for the current distribution. Return a list of command names.` make_archive(self, base_name, format, root_dir=None, base_dir=None) make_file(self, infiles, outfile, func, args, exec_msg=None, skip_msg=None, level=1) `Special case of 'execute()' for operations that process one or more input files and generate one output file. Works just like 'execute()', except the operation is skipped and a different message printed if 'outfile' already exists and is newer than all files listed in 'infiles'. If the command defined 'self.force', and it is true, then the command is unconditionally run -- does no timestamp checks.` mkpath(self, name, mode=511) move_file(self, src, dst, level=1) `Move a file respectin dry-run flag.` reinitialize_command(self, command, reinit_subcommands=0) `# XXX rename to 'get_reinitialized_command()'? (should do the # same in dist.py, if so)` run_command(self, command) `Run some other command: uses the 'run_command()' method of Distribution, which creates and finalizes the command object if necessary and then invokes its 'run()' method.` set_undefined_options(self, src_cmd, *option_pairs) `Set the values of any "undefined" options from corresponding option values in some other command object. "Undefined" here means "is None", which is the convention used to indicate that an option has not been changed between 'initialize_options()' and 'finalize_options()'. Usually called from 'finalize_options()' for options that depend on some other command rather than another option of the same command. 'src_cmd' is the other command from which option values will be taken (a command object will be created for it if necessary); the remaining arguments are '(src_option,dst_option)' tuples which mean "take the value of 'src_option' in the 'src_cmd' command object, and copy it to 'dst_option' in the current command object".` spawn(self, cmd, search_path=1, level=1) `Spawn an external command respecting dry-run flag.` warn(self, msg) Data and other attributes inherited from Command: sub_commands = []
class mx_bdist_rpm(bdist_rpm)
`` | `bdist_rpm command which allows passing in distutils options.`
| Method resolution order: mx_bdist_rpm bdist_rpm Command Methods defined here: finalize_options(self) Data and other attributes defined here: distutils_build_options = None distutils_install_options = None user_options = [('bdist-base=', None, 'base directory for creating built distributions'), ('rpm-base=', None, 'base directory for creating RPMs (defaults to "rpm" under --bdist-base; must be specified for RPM 2)'), ('dist-dir=', 'd', 'directory to put final RPM files in (and .spec files if --spec-only)'), ('python=', None, 'path to Python interpreter to hard-code in the .spec file (default: "python")'), ('fix-python', None, 'hard-code the exact path to the current Python interpreter in the .spec file'), ('spec-only', None, 'only regenerate spec file'), ('source-only', None, 'only generate source RPM'), ('binary-only', None, 'only generate binary RPM'), ('use-bzip2', None, 'use bzip2 instead of gzip to create source distribution'), ('distribution-name=', None, 'name of the (Linux) distribution to which this R...lies (*not* the name of the module distribution!)'), ('group=', None, 'package classification [default: "Development/Libraries"]'), ('release=', None, 'RPM release number'), ('serial=', None, 'RPM serial number'), ('vendor=', None, 'RPM "vendor" (eg. "Joe Blow <joe@example.com>") [default: maintainer or author from setup script]'), ('packager=', None, 'RPM packager (eg. "Jane Doe <jane@example.net>")[default: vendor]'), ('doc-files=', None, 'list of documentation files (space or comma-separated)'), ('changelog=', None, 'RPM changelog'), ('icon=', None, 'name of icon file'), ('provides=', None, 'capabilities provided by this package'), ('requires=', None, 'capabilities required by this package'), ...] Methods inherited from bdist_rpm: finalize_package_data(self) initialize_options(self) run(self) Data and other attributes inherited from bdist_rpm: boolean_options = ['keep-temp', 'use-rpm-opt-flags', 'rpm3-mode', 'no-autoreq'] description = 'create an RPM distribution' negative_opt = {'no-keep-temp': 'keep-temp', 'no-rpm-opt-flags': 'use-rpm-opt-flags', 'rpm2-mode': 'rpm3-mode'} Methods inherited from Command: __getattr__(self, attr) __init__(self, dist) `Create and initialize a new Command object. Most importantly, invokes the 'initialize_options()' method, which is the real initializer and depends on the actual command being instantiated.` announce(self, msg, level=1) `If the current verbosity level is of greater than or equal to 'level' print 'msg' to stdout.` copy_file(self, infile, outfile, preserve_mode=1, preserve_times=1, link=None, level=1) `Copy a file respecting verbose, dry-run and force flags. (The former two default to whatever is in the Distribution object, and the latter defaults to false for commands that don't define it.)` copy_tree(self, infile, outfile, preserve_mode=1, preserve_times=1, preserve_symlinks=0, level=1) `Copy an entire directory tree respecting verbose, dry-run, and force flags.` debug_print(self, msg) `Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true.` dump_options(self, header=None, indent='') ensure_dirname(self, option) ensure_filename(self, option) `Ensure that 'option' is the name of an existing file.` ensure_finalized(self) ensure_string(self, option, default=None) `Ensure that 'option' is a string; if not defined, set it to 'default'.` ensure_string_list(self, option) `Ensure that 'option' is a list of strings. If 'option' is currently a string, we split it either on /,\s*/ or /\s+/, so "foo bar baz", "foo,bar,baz", and "foo, bar baz" all become ["foo", "bar", "baz"].` execute(self, func, args, msg=None, level=1) get_command_name(self) get_finalized_command(self, command, create=1) `Wrapper around Distribution's 'get_command_obj()' method: find (create if necessary and 'create' is true) the command object for 'command', call its 'ensure_finalized()' method, and return the finalized command object.` get_sub_commands(self) `Determine the sub-commands that are relevant in the current distribution (ie., that need to be run). This is based on the 'sub_commands' class attribute: each tuple in that list may include a method that we call to determine if the subcommand needs to be run for the current distribution. Return a list of command names.` make_archive(self, base_name, format, root_dir=None, base_dir=None) make_file(self, infiles, outfile, func, args, exec_msg=None, skip_msg=None, level=1) `Special case of 'execute()' for operations that process one or more input files and generate one output file. Works just like 'execute()', except the operation is skipped and a different message printed if 'outfile' already exists and is newer than all files listed in 'infiles'. If the command defined 'self.force', and it is true, then the command is unconditionally run -- does no timestamp checks.` mkpath(self, name, mode=511) move_file(self, src, dst, level=1) `Move a file respectin dry-run flag.` reinitialize_command(self, command, reinit_subcommands=0) `# XXX rename to 'get_reinitialized_command()'? (should do the # same in dist.py, if so)` run_command(self, command) `Run some other command: uses the 'run_command()' method of Distribution, which creates and finalizes the command object if necessary and then invokes its 'run()' method.` set_undefined_options(self, src_cmd, *option_pairs) `Set the values of any "undefined" options from corresponding option values in some other command object. "Undefined" here means "is None", which is the convention used to indicate that an option has not been changed between 'initialize_options()' and 'finalize_options()'. Usually called from 'finalize_options()' for options that depend on some other command rather than another option of the same command. 'src_cmd' is the other command from which option values will be taken (a command object will be created for it if necessary); the remaining arguments are '(src_option,dst_option)' tuples which mean "take the value of 'src_option' in the 'src_cmd' command object, and copy it to 'dst_option' in the current command object".` spawn(self, cmd, search_path=1, level=1) `Spawn an external command respecting dry-run flag.` warn(self, msg) Data and other attributes inherited from Command: sub_commands = []
class mx_bdist_zope(bdist_dumb)
`` | `Build binary Zope product distribution.`
| Method resolution order: mx_bdist_zope bdist_dumb Command Methods defined here: finalize_options(self) reinitialize_command(self, command, reinit_subcommands=0) Methods inherited from bdist_dumb: initialize_options(self) run(self) Data and other attributes inherited from bdist_dumb: boolean_options = ['keep-temp', 'skip-build', 'relative'] default_format = {'nt': 'zip', 'os2': 'zip', 'posix': 'gztar'} description = 'create a "dumb" built distribution' user_options = [('bdist-dir=', 'd', 'temporary directory for creating the distribution'), ('plat-name=', 'p', 'platform name to embed in generated filenames (default: linux-x86_64)'), ('format=', 'f', 'archive format to create (tar, ztar, gztar, zip)'), ('keep-temp', 'k', 'keep the pseudo-installation tree around after creating the distribution archive'), ('dist-dir=', 'd', 'directory to put final built distributions in'), ('skip-build', None, 'skip rebuilding everything (for testing/debugging)'), ('relative', None, 'build the archive using relative paths(default: false)')] Methods inherited from Command: __getattr__(self, attr) __init__(self, dist) `Create and initialize a new Command object. Most importantly, invokes the 'initialize_options()' method, which is the real initializer and depends on the actual command being instantiated.` announce(self, msg, level=1) `If the current verbosity level is of greater than or equal to 'level' print 'msg' to stdout.` copy_file(self, infile, outfile, preserve_mode=1, preserve_times=1, link=None, level=1) `Copy a file respecting verbose, dry-run and force flags. (The former two default to whatever is in the Distribution object, and the latter defaults to false for commands that don't define it.)` copy_tree(self, infile, outfile, preserve_mode=1, preserve_times=1, preserve_symlinks=0, level=1) `Copy an entire directory tree respecting verbose, dry-run, and force flags.` debug_print(self, msg) `Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true.` dump_options(self, header=None, indent='') ensure_dirname(self, option) ensure_filename(self, option) `Ensure that 'option' is the name of an existing file.` ensure_finalized(self) ensure_string(self, option, default=None) `Ensure that 'option' is a string; if not defined, set it to 'default'.` ensure_string_list(self, option) `Ensure that 'option' is a list of strings. If 'option' is currently a string, we split it either on /,\s*/ or /\s+/, so "foo bar baz", "foo,bar,baz", and "foo, bar baz" all become ["foo", "bar", "baz"].` execute(self, func, args, msg=None, level=1) get_command_name(self) get_finalized_command(self, command, create=1) `Wrapper around Distribution's 'get_command_obj()' method: find (create if necessary and 'create' is true) the command object for 'command', call its 'ensure_finalized()' method, and return the finalized command object.` get_sub_commands(self) `Determine the sub-commands that are relevant in the current distribution (ie., that need to be run). This is based on the 'sub_commands' class attribute: each tuple in that list may include a method that we call to determine if the subcommand needs to be run for the current distribution. Return a list of command names.` make_archive(self, base_name, format, root_dir=None, base_dir=None) make_file(self, infiles, outfile, func, args, exec_msg=None, skip_msg=None, level=1) `Special case of 'execute()' for operations that process one or more input files and generate one output file. Works just like 'execute()', except the operation is skipped and a different message printed if 'outfile' already exists and is newer than all files listed in 'infiles'. If the command defined 'self.force', and it is true, then the command is unconditionally run -- does no timestamp checks.` mkpath(self, name, mode=511) move_file(self, src, dst, level=1) `Move a file respectin dry-run flag.` run_command(self, command) `Run some other command: uses the 'run_command()' method of Distribution, which creates and finalizes the command object if necessary and then invokes its 'run()' method.` set_undefined_options(self, src_cmd, *option_pairs) `Set the values of any "undefined" options from corresponding option values in some other command object. "Undefined" here means "is None", which is the convention used to indicate that an option has not been changed between 'initialize_options()' and 'finalize_options()'. Usually called from 'finalize_options()' for options that depend on some other command rather than another option of the same command. 'src_cmd' is the other command from which option values will be taken (a command object will be created for it if necessary); the remaining arguments are '(src_option,dst_option)' tuples which mean "take the value of 'src_option' in the 'src_cmd' command object, and copy it to 'dst_option' in the current command object".` spawn(self, cmd, search_path=1, level=1) `Spawn an external command respecting dry-run flag.` warn(self, msg) Data and other attributes inherited from Command: sub_commands = []
class mx_build(build)
`` | `build command which knows about our distutils extensions.`
| Method resolution order: mx_build build Command Methods defined here: has_unixlibs(self) Data and other attributes defined here: sub_commands = [('build_clib', <unbound method build.has_c_libraries>), ('build_unixlib', <function has_unixlibs>), ('mx_autoconf', <unbound method build.has_ext_modules>), ('build_ext', <unbound method build.has_ext_modules>), ('build_py', <unbound method build.has_pure_modules>), ('build_scripts', <unbound method build.has_scripts>)] Methods inherited from build: finalize_options(self) has_c_libraries(self) has_ext_modules(self) has_pure_modules(self) has_scripts(self) initialize_options(self) run(self) Data and other attributes inherited from build: boolean_options = ['debug', 'force'] description = 'build everything needed to install' help_options = [('help-compiler', None, 'list available compilers', <function show_compilers>)] user_options = [('build-base=', 'b', 'base directory for build library'), ('build-purelib=', None, 'build directory for platform-neutral distributions'), ('build-platlib=', None, 'build directory for platform-specific distributions'), ('build-lib=', None, 'build directory for all distribution (defaults to either build-purelib or build-platlib'), ('build-scripts=', None, 'build directory for scripts'), ('build-temp=', 't', 'temporary build directory'), ('compiler=', 'c', 'specify the compiler type'), ('debug', 'g', 'compile extensions and libraries with debugging information'), ('force', 'f', 'forcibly build everything (ignore file timestamps)'), ('executable=', 'e', 'specify final destination interpreter path (build.py)')] Methods inherited from Command: __getattr__(self, attr) __init__(self, dist) `Create and initialize a new Command object. Most importantly, invokes the 'initialize_options()' method, which is the real initializer and depends on the actual command being instantiated.` announce(self, msg, level=1) `If the current verbosity level is of greater than or equal to 'level' print 'msg' to stdout.` copy_file(self, infile, outfile, preserve_mode=1, preserve_times=1, link=None, level=1) `Copy a file respecting verbose, dry-run and force flags. (The former two default to whatever is in the Distribution object, and the latter defaults to false for commands that don't define it.)` copy_tree(self, infile, outfile, preserve_mode=1, preserve_times=1, preserve_symlinks=0, level=1) `Copy an entire directory tree respecting verbose, dry-run, and force flags.` debug_print(self, msg) `Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true.` dump_options(self, header=None, indent='') ensure_dirname(self, option) ensure_filename(self, option) `Ensure that 'option' is the name of an existing file.` ensure_finalized(self) ensure_string(self, option, default=None) `Ensure that 'option' is a string; if not defined, set it to 'default'.` ensure_string_list(self, option) `Ensure that 'option' is a list of strings. If 'option' is currently a string, we split it either on /,\s*/ or /\s+/, so "foo bar baz", "foo,bar,baz", and "foo, bar baz" all become ["foo", "bar", "baz"].` execute(self, func, args, msg=None, level=1) get_command_name(self) get_finalized_command(self, command, create=1) `Wrapper around Distribution's 'get_command_obj()' method: find (create if necessary and 'create' is true) the command object for 'command', call its 'ensure_finalized()' method, and return the finalized command object.` get_sub_commands(self) `Determine the sub-commands that are relevant in the current distribution (ie., that need to be run). This is based on the 'sub_commands' class attribute: each tuple in that list may include a method that we call to determine if the subcommand needs to be run for the current distribution. Return a list of command names.` make_archive(self, base_name, format, root_dir=None, base_dir=None) make_file(self, infiles, outfile, func, args, exec_msg=None, skip_msg=None, level=1) `Special case of 'execute()' for operations that process one or more input files and generate one output file. Works just like 'execute()', except the operation is skipped and a different message printed if 'outfile' already exists and is newer than all files listed in 'infiles'. If the command defined 'self.force', and it is true, then the command is unconditionally run -- does no timestamp checks.` mkpath(self, name, mode=511) move_file(self, src, dst, level=1) `Move a file respectin dry-run flag.` reinitialize_command(self, command, reinit_subcommands=0) `# XXX rename to 'get_reinitialized_command()'? (should do the # same in dist.py, if so)` run_command(self, command) `Run some other command: uses the 'run_command()' method of Distribution, which creates and finalizes the command object if necessary and then invokes its 'run()' method.` set_undefined_options(self, src_cmd, *option_pairs) `Set the values of any "undefined" options from corresponding option values in some other command object. "Undefined" here means "is None", which is the convention used to indicate that an option has not been changed between 'initialize_options()' and 'finalize_options()'. Usually called from 'finalize_options()' for options that depend on some other command rather than another option of the same command. 'src_cmd' is the other command from which option values will be taken (a command object will be created for it if necessary); the remaining arguments are '(src_option,dst_option)' tuples which mean "take the value of 'src_option' in the 'src_cmd' command object, and copy it to 'dst_option' in the current command object".` spawn(self, cmd, search_path=1, level=1) `Spawn an external command respecting dry-run flag.` warn(self, msg)
class mx_build_clib(build_clib)
`` | `build_clib command which builds the libs using separate temp dirs`
| Method resolution order: mx_build_clib build_clib Command Methods defined here: build_libraries(self, libraries) build_library(self, lib_name, build_info) Methods inherited from build_clib: check_library_list(self, libraries) `Ensure that the list of libraries (presumably provided as a command option 'libraries') is valid, i.e. it is a list of 2-tuples, where the tuples are (library_name, build_info_dict). Raise DistutilsSetupError if the structure is invalid anywhere; just returns otherwise.` finalize_options(self) get_library_names(self) get_source_files(self) initialize_options(self) run(self) Data and other attributes inherited from build_clib: boolean_options = ['debug', 'force'] description = 'build C/C++ libraries used by Python extensions' help_options = [('help-compiler', None, 'list available compilers', <function show_compilers>)] user_options = [('build-clib', 'b', 'directory to build C/C++ libraries to'), ('build-temp', 't', 'directory to put temporary build by-products'), ('debug', 'g', 'compile with debugging information'), ('force', 'f', 'forcibly build everything (ignore file timestamps)'), ('compiler=', 'c', 'specify the compiler type')] Methods inherited from Command: __getattr__(self, attr) __init__(self, dist) `Create and initialize a new Command object. Most importantly, invokes the 'initialize_options()' method, which is the real initializer and depends on the actual command being instantiated.` announce(self, msg, level=1) `If the current verbosity level is of greater than or equal to 'level' print 'msg' to stdout.` copy_file(self, infile, outfile, preserve_mode=1, preserve_times=1, link=None, level=1) `Copy a file respecting verbose, dry-run and force flags. (The former two default to whatever is in the Distribution object, and the latter defaults to false for commands that don't define it.)` copy_tree(self, infile, outfile, preserve_mode=1, preserve_times=1, preserve_symlinks=0, level=1) `Copy an entire directory tree respecting verbose, dry-run, and force flags.` debug_print(self, msg) `Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true.` dump_options(self, header=None, indent='') ensure_dirname(self, option) ensure_filename(self, option) `Ensure that 'option' is the name of an existing file.` ensure_finalized(self) ensure_string(self, option, default=None) `Ensure that 'option' is a string; if not defined, set it to 'default'.` ensure_string_list(self, option) `Ensure that 'option' is a list of strings. If 'option' is currently a string, we split it either on /,\s*/ or /\s+/, so "foo bar baz", "foo,bar,baz", and "foo, bar baz" all become ["foo", "bar", "baz"].` execute(self, func, args, msg=None, level=1) get_command_name(self) get_finalized_command(self, command, create=1) `Wrapper around Distribution's 'get_command_obj()' method: find (create if necessary and 'create' is true) the command object for 'command', call its 'ensure_finalized()' method, and return the finalized command object.` get_sub_commands(self) `Determine the sub-commands that are relevant in the current distribution (ie., that need to be run). This is based on the 'sub_commands' class attribute: each tuple in that list may include a method that we call to determine if the subcommand needs to be run for the current distribution. Return a list of command names.` make_archive(self, base_name, format, root_dir=None, base_dir=None) make_file(self, infiles, outfile, func, args, exec_msg=None, skip_msg=None, level=1) `Special case of 'execute()' for operations that process one or more input files and generate one output file. Works just like 'execute()', except the operation is skipped and a different message printed if 'outfile' already exists and is newer than all files listed in 'infiles'. If the command defined 'self.force', and it is true, then the command is unconditionally run -- does no timestamp checks.` mkpath(self, name, mode=511) move_file(self, src, dst, level=1) `Move a file respectin dry-run flag.` reinitialize_command(self, command, reinit_subcommands=0) `# XXX rename to 'get_reinitialized_command()'? (should do the # same in dist.py, if so)` run_command(self, command) `Run some other command: uses the 'run_command()' method of Distribution, which creates and finalizes the command object if necessary and then invokes its 'run()' method.` set_undefined_options(self, src_cmd, *option_pairs) `Set the values of any "undefined" options from corresponding option values in some other command object. "Undefined" here means "is None", which is the convention used to indicate that an option has not been changed between 'initialize_options()' and 'finalize_options()'. Usually called from 'finalize_options()' for options that depend on some other command rather than another option of the same command. 'src_cmd' is the other command from which option values will be taken (a command object will be created for it if necessary); the remaining arguments are '(src_option,dst_option)' tuples which mean "take the value of 'src_option' in the 'src_cmd' command object, and copy it to 'dst_option' in the current command object".` spawn(self, cmd, search_path=1, level=1) `Spawn an external command respecting dry-run flag.` warn(self, msg) Data and other attributes inherited from Command: sub_commands = []
class mx_build_ext(CompilerSupportMixin, build_ext)
`` | `build_ext command which runs mx_autoconf command before trying to build anything.`
| Method resolution order: mx_build_ext CompilerSupportMixin build_ext Command Methods defined here: build_extension(self, ext) build_extensions(self) finalize_options(self) run(self) Data and other attributes defined here: autoconf = None disable_build = None enable_build = None user_options = [('build-lib=', 'b', 'directory for compiled extension modules'), ('build-temp=', 't', 'directory for temporary files (build by-products)'), ('inplace', 'i', 'ignore build-lib and put compiled extensions int...urce directory alongside your pure Python modules'), ('include-dirs=', 'I', "list of directories to search for header files (separated by ':')"), ('define=', 'D', 'C preprocessor macros to define'), ('undef=', 'U', 'C preprocessor macros to undefine'), ('libraries=', 'l', 'external C libraries to link with'), ('library-dirs=', 'L', "directories to search for external C libraries (separated by ':')"), ('rpath=', 'R', 'directories to search for shared C libraries at runtime'), ('link-objects=', 'O', 'extra explicit link objects to include in the link'), ('debug', 'g', 'compile/link with debugging information'), ('force', 'f', 'forcibly build everything (ignore file timestamps)'), ('compiler=', 'c', 'specify the compiler type'), ('swig-cpp', None, 'make SWIG create C++ files (default is C)'), ('swig-opts=', None, 'list of SWIG command line options'), ('swig=', None, 'path to the SWIG executable'), ('disable-build=', None, 'disable building an optional extensions (comma s...ed package names); default is to try building all'), ('enable-build=', None, 'if given, only these optional extensions are built (comma separated list of dotted package names)')] Methods inherited from CompilerSupportMixin: prepare_compiler(self) Data and other attributes inherited from CompilerSupportMixin: prepared_compiler = 0 Methods inherited from build_ext: check_extensions_list(self, extensions) `Ensure that the list of extensions (presumably provided as a command option 'extensions') is valid, i.e. it is a list of Extension objects. We also support the old-style list of 2-tuples, where the tuples are (ext_name, build_info), which are converted to Extension instances here. Raise DistutilsSetupError if the structure is invalid anywhere; just returns otherwise.` find_swig(self) `Return the name of the SWIG executable. On Unix, this is just "swig" -- it should be in the PATH. Tries a bit harder on Windows.` get_export_symbols(self, ext) `Return the list of symbols that a shared extension has to export. This either uses 'ext.export_symbols' or, if it's not provided, "init" + module_name. Only relevant on Windows, where the .pyd file (DLL) must export the module "init" function.` get_ext_filename(self, ext_name) `Convert the name of an extension (eg. "foo.bar") into the name of the file from which it will be loaded (eg. "foo/bar.so", or "foo\bar.pyd").` get_ext_fullname(self, ext_name) get_libraries(self, ext) `Return the list of libraries to link against when building a shared extension. On most platforms, this is just 'ext.libraries'; on Windows and OS/2, we add the Python library (eg. python20.dll).` get_outputs(self) get_source_files(self) initialize_options(self) swig_sources(self, sources, extension) `Walk the list of source files in 'sources', looking for SWIG interface (.i) files. Run SWIG on all that are found, and return a modified 'sources' list with SWIG source files replaced by the generated C (or C++) files.` Data and other attributes inherited from build_ext: boolean_options = ['inplace', 'debug', 'force', 'swig-cpp'] description = 'build C/C++ extensions (compile/link to build directory)' help_options = [('help-compiler', None, 'list available compilers', <function show_compilers>)] sep_by = " (separated by ':')" Methods inherited from Command: __getattr__(self, attr) __init__(self, dist) `Create and initialize a new Command object. Most importantly, invokes the 'initialize_options()' method, which is the real initializer and depends on the actual command being instantiated.` announce(self, msg, level=1) `If the current verbosity level is of greater than or equal to 'level' print 'msg' to stdout.` copy_file(self, infile, outfile, preserve_mode=1, preserve_times=1, link=None, level=1) `Copy a file respecting verbose, dry-run and force flags. (The former two default to whatever is in the Distribution object, and the latter defaults to false for commands that don't define it.)` copy_tree(self, infile, outfile, preserve_mode=1, preserve_times=1, preserve_symlinks=0, level=1) `Copy an entire directory tree respecting verbose, dry-run, and force flags.` debug_print(self, msg) `Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true.` dump_options(self, header=None, indent='') ensure_dirname(self, option) ensure_filename(self, option) `Ensure that 'option' is the name of an existing file.` ensure_finalized(self) ensure_string(self, option, default=None) `Ensure that 'option' is a string; if not defined, set it to 'default'.` ensure_string_list(self, option) `Ensure that 'option' is a list of strings. If 'option' is currently a string, we split it either on /,\s*/ or /\s+/, so "foo bar baz", "foo,bar,baz", and "foo, bar baz" all become ["foo", "bar", "baz"].` execute(self, func, args, msg=None, level=1) get_command_name(self) get_finalized_command(self, command, create=1) `Wrapper around Distribution's 'get_command_obj()' method: find (create if necessary and 'create' is true) the command object for 'command', call its 'ensure_finalized()' method, and return the finalized command object.` get_sub_commands(self) `Determine the sub-commands that are relevant in the current distribution (ie., that need to be run). This is based on the 'sub_commands' class attribute: each tuple in that list may include a method that we call to determine if the subcommand needs to be run for the current distribution. Return a list of command names.` make_archive(self, base_name, format, root_dir=None, base_dir=None) make_file(self, infiles, outfile, func, args, exec_msg=None, skip_msg=None, level=1) `Special case of 'execute()' for operations that process one or more input files and generate one output file. Works just like 'execute()', except the operation is skipped and a different message printed if 'outfile' already exists and is newer than all files listed in 'infiles'. If the command defined 'self.force', and it is true, then the command is unconditionally run -- does no timestamp checks.` mkpath(self, name, mode=511) move_file(self, src, dst, level=1) `Move a file respectin dry-run flag.` reinitialize_command(self, command, reinit_subcommands=0) `# XXX rename to 'get_reinitialized_command()'? (should do the # same in dist.py, if so)` run_command(self, command) `Run some other command: uses the 'run_command()' method of Distribution, which creates and finalizes the command object if necessary and then invokes its 'run()' method.` set_undefined_options(self, src_cmd, *option_pairs) `Set the values of any "undefined" options from corresponding option values in some other command object. "Undefined" here means "is None", which is the convention used to indicate that an option has not been changed between 'initialize_options()' and 'finalize_options()'. Usually called from 'finalize_options()' for options that depend on some other command rather than another option of the same command. 'src_cmd' is the other command from which option values will be taken (a command object will be created for it if necessary); the remaining arguments are '(src_option,dst_option)' tuples which mean "take the value of 'src_option' in the 'src_cmd' command object, and copy it to 'dst_option' in the current command object".` spawn(self, cmd, search_path=1, level=1) `Spawn an external command respecting dry-run flag.` warn(self, msg) Data and other attributes inherited from Command: sub_commands = []
class mx_build_py(build_py)
`` | `build_py command which also allows removing Python source code after the byte-code compile process.`
| Method resolution order: mx_build_py build_py Command Methods defined here: get_outputs(self, include_bytecode=1) run(self) Data and other attributes defined here: boolean_options = ['compile', 'force', 'without-source'] user_options = [('build-lib=', 'd', 'directory to "build" (copy) to'), ('compile', 'c', 'compile .py to .pyc'), ('no-compile', None, "don't compile .py files [default]"), ('optimize=', 'O', 'also compile with optimization: -O1 for "python ...r "python -OO", and -O0 to disable [default: -O0]'), ('force', 'f', 'forcibly build everything (ignore file timestamps)'), ('without-source', None, 'only include Python byte-code')] without_source = 0 Methods inherited from build_py: build_module(self, module, module_file, package) build_modules(self) build_package_data(self) `Copy data files into build directory` build_packages(self) byte_compile(self, files) check_module(self, module, module_file) check_package(self, package, package_dir) finalize_options(self) find_all_modules(self) `Compute the list of all modules that will be built, whether they are specified one-module-at-a-time ('self.py_modules') or by whole packages ('self.packages'). Return a list of tuples (package, module, module_file), just like 'find_modules()' and 'find_package_modules()' do.` find_data_files(self, package, src_dir) `Return filenames for package's data files in 'src_dir'` find_modules(self) `Finds individually-specified Python modules, ie. those listed by module name in 'self.py_modules'. Returns a list of tuples (package, module_base, filename): 'package' is a tuple of the path through package-space to the module; 'module_base' is the bare (no packages, no dots) module name, and 'filename' is the path to the ".py" file (relative to the distribution root) that implements the module.` find_package_modules(self, package, package_dir) get_data_files(self) `Generate list of '(package,src_dir,build_dir,filenames)' tuples` get_module_outfile(self, build_dir, package, module) get_package_dir(self, package) `Return the directory, relative to the top of the source distribution, where package 'package' should be found (at least according to the 'package_dir' option, if any).` get_source_files(self) initialize_options(self) Data and other attributes inherited from build_py: description = '"build" pure Python modules (copy to build directory)' negative_opt = {'no-compile': 'compile'} Methods inherited from Command: __getattr__(self, attr) __init__(self, dist) `Create and initialize a new Command object. Most importantly, invokes the 'initialize_options()' method, which is the real initializer and depends on the actual command being instantiated.` announce(self, msg, level=1) `If the current verbosity level is of greater than or equal to 'level' print 'msg' to stdout.` copy_file(self, infile, outfile, preserve_mode=1, preserve_times=1, link=None, level=1) `Copy a file respecting verbose, dry-run and force flags. (The former two default to whatever is in the Distribution object, and the latter defaults to false for commands that don't define it.)` copy_tree(self, infile, outfile, preserve_mode=1, preserve_times=1, preserve_symlinks=0, level=1) `Copy an entire directory tree respecting verbose, dry-run, and force flags.` debug_print(self, msg) `Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true.` dump_options(self, header=None, indent='') ensure_dirname(self, option) ensure_filename(self, option) `Ensure that 'option' is the name of an existing file.` ensure_finalized(self) ensure_string(self, option, default=None) `Ensure that 'option' is a string; if not defined, set it to 'default'.` ensure_string_list(self, option) `Ensure that 'option' is a list of strings. If 'option' is currently a string, we split it either on /,\s*/ or /\s+/, so "foo bar baz", "foo,bar,baz", and "foo, bar baz" all become ["foo", "bar", "baz"].` execute(self, func, args, msg=None, level=1) get_command_name(self) get_finalized_command(self, command, create=1) `Wrapper around Distribution's 'get_command_obj()' method: find (create if necessary and 'create' is true) the command object for 'command', call its 'ensure_finalized()' method, and return the finalized command object.` get_sub_commands(self) `Determine the sub-commands that are relevant in the current distribution (ie., that need to be run). This is based on the 'sub_commands' class attribute: each tuple in that list may include a method that we call to determine if the subcommand needs to be run for the current distribution. Return a list of command names.` make_archive(self, base_name, format, root_dir=None, base_dir=None) make_file(self, infiles, outfile, func, args, exec_msg=None, skip_msg=None, level=1) `Special case of 'execute()' for operations that process one or more input files and generate one output file. Works just like 'execute()', except the operation is skipped and a different message printed if 'outfile' already exists and is newer than all files listed in 'infiles'. If the command defined 'self.force', and it is true, then the command is unconditionally run -- does no timestamp checks.` mkpath(self, name, mode=511) move_file(self, src, dst, level=1) `Move a file respectin dry-run flag.` reinitialize_command(self, command, reinit_subcommands=0) `# XXX rename to 'get_reinitialized_command()'? (should do the # same in dist.py, if so)` run_command(self, command) `Run some other command: uses the 'run_command()' method of Distribution, which creates and finalizes the command object if necessary and then invokes its 'run()' method.` set_undefined_options(self, src_cmd, *option_pairs) `Set the values of any "undefined" options from corresponding option values in some other command object. "Undefined" here means "is None", which is the convention used to indicate that an option has not been changed between 'initialize_options()' and 'finalize_options()'. Usually called from 'finalize_options()' for options that depend on some other command rather than another option of the same command. 'src_cmd' is the other command from which option values will be taken (a command object will be created for it if necessary); the remaining arguments are '(src_option,dst_option)' tuples which mean "take the value of 'src_option' in the 'src_cmd' command object, and copy it to 'dst_option' in the current command object".` spawn(self, cmd, search_path=1, level=1) `Spawn an external command respecting dry-run flag.` warn(self, msg) Data and other attributes inherited from Command: sub_commands = []
class mx_build_unixlib(Command)
`` | `This command compiles external libs using the standard Unix procedure for this: ./configure make`
| Methods defined here: build_unixlib(self, unixlib) build_unixlibs(self, unixlibs) finalize_options(self) get_unixlib_lib_options(self) initialize_options(self) run(self) run_configure(self, options=[], dir=None, configure='configure') `Run the configure script using options is given. Options must be a list of tuples (optionname, optionvalue). If an option should not have a value, passing None as optionvalue will have the effect of using the option without value. dir can be given to have the configure script execute in that directory instead of the current one.` run_make(self, targets=[], dir=None, make='make', options=[]) `Run the make command for the given targets. Targets must be a list of valid Makefile targets. dir can be given to have the make program execute in that directory instead of the current one.` run_script(self, script, options=[]) Data and other attributes defined here: boolean_options = ['force'] description = 'build Unix libraries used by Python extensions' make = None user_options = [('build-lib=', 'b', 'directory to store built Unix libraries in'), ('build-temp=', 't', 'directory to build Unix libraries to'), ('make=', None, 'make program to use'), ('makefile=', None, 'makefile to use'), ('force', 'f', 'forcibly reconfigure')] Methods inherited from Command: __getattr__(self, attr) __init__(self, dist) `Create and initialize a new Command object. Most importantly, invokes the 'initialize_options()' method, which is the real initializer and depends on the actual command being instantiated.` announce(self, msg, level=1) `If the current verbosity level is of greater than or equal to 'level' print 'msg' to stdout.` copy_file(self, infile, outfile, preserve_mode=1, preserve_times=1, link=None, level=1) `Copy a file respecting verbose, dry-run and force flags. (The former two default to whatever is in the Distribution object, and the latter defaults to false for commands that don't define it.)` copy_tree(self, infile, outfile, preserve_mode=1, preserve_times=1, preserve_symlinks=0, level=1) `Copy an entire directory tree respecting verbose, dry-run, and force flags.` debug_print(self, msg) `Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true.` dump_options(self, header=None, indent='') ensure_dirname(self, option) ensure_filename(self, option) `Ensure that 'option' is the name of an existing file.` ensure_finalized(self) ensure_string(self, option, default=None) `Ensure that 'option' is a string; if not defined, set it to 'default'.` ensure_string_list(self, option) `Ensure that 'option' is a list of strings. If 'option' is currently a string, we split it either on /,\s*/ or /\s+/, so "foo bar baz", "foo,bar,baz", and "foo, bar baz" all become ["foo", "bar", "baz"].` execute(self, func, args, msg=None, level=1) get_command_name(self) get_finalized_command(self, command, create=1) `Wrapper around Distribution's 'get_command_obj()' method: find (create if necessary and 'create' is true) the command object for 'command', call its 'ensure_finalized()' method, and return the finalized command object.` get_sub_commands(self) `Determine the sub-commands that are relevant in the current distribution (ie., that need to be run). This is based on the 'sub_commands' class attribute: each tuple in that list may include a method that we call to determine if the subcommand needs to be run for the current distribution. Return a list of command names.` make_archive(self, base_name, format, root_dir=None, base_dir=None) make_file(self, infiles, outfile, func, args, exec_msg=None, skip_msg=None, level=1) `Special case of 'execute()' for operations that process one or more input files and generate one output file. Works just like 'execute()', except the operation is skipped and a different message printed if 'outfile' already exists and is newer than all files listed in 'infiles'. If the command defined 'self.force', and it is true, then the command is unconditionally run -- does no timestamp checks.` mkpath(self, name, mode=511) move_file(self, src, dst, level=1) `Move a file respectin dry-run flag.` reinitialize_command(self, command, reinit_subcommands=0) `# XXX rename to 'get_reinitialized_command()'? (should do the # same in dist.py, if so)` run_command(self, command) `Run some other command: uses the 'run_command()' method of Distribution, which creates and finalizes the command object if necessary and then invokes its 'run()' method.` set_undefined_options(self, src_cmd, *option_pairs) `Set the values of any "undefined" options from corresponding option values in some other command object. "Undefined" here means "is None", which is the convention used to indicate that an option has not been changed between 'initialize_options()' and 'finalize_options()'. Usually called from 'finalize_options()' for options that depend on some other command rather than another option of the same command. 'src_cmd' is the other command from which option values will be taken (a command object will be created for it if necessary); the remaining arguments are '(src_option,dst_option)' tuples which mean "take the value of 'src_option' in the 'src_cmd' command object, and copy it to 'dst_option' in the current command object".` spawn(self, cmd, search_path=1, level=1) `Spawn an external command respecting dry-run flag.` warn(self, msg) Data and other attributes inherited from Command: sub_commands = []
class mx_install(install)
`` | `We want install_data to default to install_purelib if it is not given.`
| Method resolution order: mx_install install Command Methods defined here: ensure_finalized(self) finalize_options(self) Methods inherited from install: change_roots(self, *names) convert_paths(self, *names) create_path_file(self) dump_dirs(self, msg) expand_basedirs(self) expand_dirs(self) finalize_other(self) finalize_unix(self) get_inputs(self) get_outputs(self) handle_extra_path(self) has_data(self) has_headers(self) has_lib(self) `Return true if the current distribution has any Python modules to install.` has_scripts(self) initialize_options(self) run(self) select_scheme(self, name) Data and other attributes inherited from install: boolean_options = ['compile', 'force', 'skip-build'] description = 'install everything from build directory' negative_opt = {'no-compile': 'compile'} sub_commands = [('install_lib', <function has_lib>), ('install_headers', <function has_headers>), ('install_scripts', <function has_scripts>), ('install_data', <function has_data>)] user_options = [('prefix=', None, 'installation prefix'), ('exec-prefix=', None, '(Unix only) prefix for platform-specific files'), ('home=', None, '(Unix only) home directory to install under'), ('install-base=', None, 'base installation directory (instead of --prefix or --home)'), ('install-platbase=', None, 'base installation directory for platform-specific files (instead of --exec-prefix or --home)'), ('root=', None, 'install everything relative to this alternate root directory'), ('install-purelib=', None, 'installation directory for pure Python module distributions'), ('install-platlib=', None, 'installation directory for non-pure module distributions'), ('install-lib=', None, 'installation directory for all module distributi...verrides --install-purelib and --install-platlib)'), ('install-headers=', None, 'installation directory for C/C++ headers'), ('install-scripts=', None, 'installation directory for Python scripts'), ('install-data=', None, 'installation directory for data files'), ('compile', 'c', 'compile .py to .pyc [default]'), ('no-compile', None, "don't compile .py files"), ('optimize=', 'O', 'also compile with optimization: -O1 for "python ...r "python -OO", and -O0 to disable [default: -O0]'), ('force', 'f', 'force installation (overwrite any existing files)'), ('skip-build', None, 'skip rebuilding everything (for testing/debugging)'), ('record=', None, 'filename in which to record list of installed files')] Methods inherited from Command: __getattr__(self, attr) __init__(self, dist) `Create and initialize a new Command object. Most importantly, invokes the 'initialize_options()' method, which is the real initializer and depends on the actual command being instantiated.` announce(self, msg, level=1) `If the current verbosity level is of greater than or equal to 'level' print 'msg' to stdout.` copy_file(self, infile, outfile, preserve_mode=1, preserve_times=1, link=None, level=1) `Copy a file respecting verbose, dry-run and force flags. (The former two default to whatever is in the Distribution object, and the latter defaults to false for commands that don't define it.)` copy_tree(self, infile, outfile, preserve_mode=1, preserve_times=1, preserve_symlinks=0, level=1) `Copy an entire directory tree respecting verbose, dry-run, and force flags.` debug_print(self, msg) `Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true.` dump_options(self, header=None, indent='') ensure_dirname(self, option) ensure_filename(self, option) `Ensure that 'option' is the name of an existing file.` ensure_string(self, option, default=None) `Ensure that 'option' is a string; if not defined, set it to 'default'.` ensure_string_list(self, option) `Ensure that 'option' is a list of strings. If 'option' is currently a string, we split it either on /,\s*/ or /\s+/, so "foo bar baz", "foo,bar,baz", and "foo, bar baz" all become ["foo", "bar", "baz"].` execute(self, func, args, msg=None, level=1) get_command_name(self) get_finalized_command(self, command, create=1) `Wrapper around Distribution's 'get_command_obj()' method: find (create if necessary and 'create' is true) the command object for 'command', call its 'ensure_finalized()' method, and return the finalized command object.` get_sub_commands(self) `Determine the sub-commands that are relevant in the current distribution (ie., that need to be run). This is based on the 'sub_commands' class attribute: each tuple in that list may include a method that we call to determine if the subcommand needs to be run for the current distribution. Return a list of command names.` make_archive(self, base_name, format, root_dir=None, base_dir=None) make_file(self, infiles, outfile, func, args, exec_msg=None, skip_msg=None, level=1) `Special case of 'execute()' for operations that process one or more input files and generate one output file. Works just like 'execute()', except the operation is skipped and a different message printed if 'outfile' already exists and is newer than all files listed in 'infiles'. If the command defined 'self.force', and it is true, then the command is unconditionally run -- does no timestamp checks.` mkpath(self, name, mode=511) move_file(self, src, dst, level=1) `Move a file respectin dry-run flag.` reinitialize_command(self, command, reinit_subcommands=0) `# XXX rename to 'get_reinitialized_command()'? (should do the # same in dist.py, if so)` run_command(self, command) `Run some other command: uses the 'run_command()' method of Distribution, which creates and finalizes the command object if necessary and then invokes its 'run()' method.` set_undefined_options(self, src_cmd, *option_pairs) `Set the values of any "undefined" options from corresponding option values in some other command object. "Undefined" here means "is None", which is the convention used to indicate that an option has not been changed between 'initialize_options()' and 'finalize_options()'. Usually called from 'finalize_options()' for options that depend on some other command rather than another option of the same command. 'src_cmd' is the other command from which option values will be taken (a command object will be created for it if necessary); the remaining arguments are '(src_option,dst_option)' tuples which mean "take the value of 'src_option' in the 'src_cmd' command object, and copy it to 'dst_option' in the current command object".` spawn(self, cmd, search_path=1, level=1) `Spawn an external command respecting dry-run flag.` warn(self, msg)
class mx_install_data(install_data)
`` | `Rework the install_data command to something more useful.`
| Method resolution order: mx_install_data install_data Command Methods defined here: finalize_options(self) run(self) Methods inherited from install_data: get_inputs(self) get_outputs(self) initialize_options(self) Data and other attributes inherited from install_data: boolean_options = ['force'] description = 'install data files' user_options = [('install-dir=', 'd', 'base directory for installing data files (default: installation base dir)'), ('root=', None, 'install everything relative to this alternate root directory'), ('force', 'f', 'force installation (overwrite existing files)')] Methods inherited from Command: __getattr__(self, attr) __init__(self, dist) `Create and initialize a new Command object. Most importantly, invokes the 'initialize_options()' method, which is the real initializer and depends on the actual command being instantiated.` announce(self, msg, level=1) `If the current verbosity level is of greater than or equal to 'level' print 'msg' to stdout.` copy_file(self, infile, outfile, preserve_mode=1, preserve_times=1, link=None, level=1) `Copy a file respecting verbose, dry-run and force flags. (The former two default to whatever is in the Distribution object, and the latter defaults to false for commands that don't define it.)` copy_tree(self, infile, outfile, preserve_mode=1, preserve_times=1, preserve_symlinks=0, level=1) `Copy an entire directory tree respecting verbose, dry-run, and force flags.` debug_print(self, msg) `Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true.` dump_options(self, header=None, indent='') ensure_dirname(self, option) ensure_filename(self, option) `Ensure that 'option' is the name of an existing file.` ensure_finalized(self) ensure_string(self, option, default=None) `Ensure that 'option' is a string; if not defined, set it to 'default'.` ensure_string_list(self, option) `Ensure that 'option' is a list of strings. If 'option' is currently a string, we split it either on /,\s*/ or /\s+/, so "foo bar baz", "foo,bar,baz", and "foo, bar baz" all become ["foo", "bar", "baz"].` execute(self, func, args, msg=None, level=1) get_command_name(self) get_finalized_command(self, command, create=1) `Wrapper around Distribution's 'get_command_obj()' method: find (create if necessary and 'create' is true) the command object for 'command', call its 'ensure_finalized()' method, and return the finalized command object.` get_sub_commands(self) `Determine the sub-commands that are relevant in the current distribution (ie., that need to be run). This is based on the 'sub_commands' class attribute: each tuple in that list may include a method that we call to determine if the subcommand needs to be run for the current distribution. Return a list of command names.` make_archive(self, base_name, format, root_dir=None, base_dir=None) make_file(self, infiles, outfile, func, args, exec_msg=None, skip_msg=None, level=1) `Special case of 'execute()' for operations that process one or more input files and generate one output file. Works just like 'execute()', except the operation is skipped and a different message printed if 'outfile' already exists and is newer than all files listed in 'infiles'. If the command defined 'self.force', and it is true, then the command is unconditionally run -- does no timestamp checks.` mkpath(self, name, mode=511) move_file(self, src, dst, level=1) `Move a file respectin dry-run flag.` reinitialize_command(self, command, reinit_subcommands=0) `# XXX rename to 'get_reinitialized_command()'? (should do the # same in dist.py, if so)` run_command(self, command) `Run some other command: uses the 'run_command()' method of Distribution, which creates and finalizes the command object if necessary and then invokes its 'run()' method.` set_undefined_options(self, src_cmd, *option_pairs) `Set the values of any "undefined" options from corresponding option values in some other command object. "Undefined" here means "is None", which is the convention used to indicate that an option has not been changed between 'initialize_options()' and 'finalize_options()'. Usually called from 'finalize_options()' for options that depend on some other command rather than another option of the same command. 'src_cmd' is the other command from which option values will be taken (a command object will be created for it if necessary); the remaining arguments are '(src_option,dst_option)' tuples which mean "take the value of 'src_option' in the 'src_cmd' command object, and copy it to 'dst_option' in the current command object".` spawn(self, cmd, search_path=1, level=1) `Spawn an external command respecting dry-run flag.` warn(self, msg) Data and other attributes inherited from Command: sub_commands = []
class mx_uninstall(Command)
`` |  | Methods defined here: finalize_options(self) initialize_options(self) run(self) Data and other attributes defined here: description = 'uninstall the package files and directories' user_options = [] Methods inherited from Command: __getattr__(self, attr) __init__(self, dist) `Create and initialize a new Command object. Most importantly, invokes the 'initialize_options()' method, which is the real initializer and depends on the actual command being instantiated.` announce(self, msg, level=1) `If the current verbosity level is of greater than or equal to 'level' print 'msg' to stdout.` copy_file(self, infile, outfile, preserve_mode=1, preserve_times=1, link=None, level=1) `Copy a file respecting verbose, dry-run and force flags. (The former two default to whatever is in the Distribution object, and the latter defaults to false for commands that don't define it.)` copy_tree(self, infile, outfile, preserve_mode=1, preserve_times=1, preserve_symlinks=0, level=1) `Copy an entire directory tree respecting verbose, dry-run, and force flags.` debug_print(self, msg) `Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true.` dump_options(self, header=None, indent='') ensure_dirname(self, option) ensure_filename(self, option) `Ensure that 'option' is the name of an existing file.` ensure_finalized(self) ensure_string(self, option, default=None) `Ensure that 'option' is a string; if not defined, set it to 'default'.` ensure_string_list(self, option) `Ensure that 'option' is a list of strings. If 'option' is currently a string, we split it either on /,\s*/ or /\s+/, so "foo bar baz", "foo,bar,baz", and "foo, bar baz" all become ["foo", "bar", "baz"].` execute(self, func, args, msg=None, level=1) get_command_name(self) get_finalized_command(self, command, create=1) `Wrapper around Distribution's 'get_command_obj()' method: find (create if necessary and 'create' is true) the command object for 'command', call its 'ensure_finalized()' method, and return the finalized command object.` get_sub_commands(self) `Determine the sub-commands that are relevant in the current distribution (ie., that need to be run). This is based on the 'sub_commands' class attribute: each tuple in that list may include a method that we call to determine if the subcommand needs to be run for the current distribution. Return a list of command names.` make_archive(self, base_name, format, root_dir=None, base_dir=None) make_file(self, infiles, outfile, func, args, exec_msg=None, skip_msg=None, level=1) `Special case of 'execute()' for operations that process one or more input files and generate one output file. Works just like 'execute()', except the operation is skipped and a different message printed if 'outfile' already exists and is newer than all files listed in 'infiles'. If the command defined 'self.force', and it is true, then the command is unconditionally run -- does no timestamp checks.` mkpath(self, name, mode=511) move_file(self, src, dst, level=1) `Move a file respectin dry-run flag.` reinitialize_command(self, command, reinit_subcommands=0) `# XXX rename to 'get_reinitialized_command()'? (should do the # same in dist.py, if so)` run_command(self, command) `Run some other command: uses the 'run_command()' method of Distribution, which creates and finalizes the command object if necessary and then invokes its 'run()' method.` set_undefined_options(self, src_cmd, *option_pairs) `Set the values of any "undefined" options from corresponding option values in some other command object. "Undefined" here means "is None", which is the convention used to indicate that an option has not been changed between 'initialize_options()' and 'finalize_options()'. Usually called from 'finalize_options()' for options that depend on some other command rather than another option of the same command. 'src_cmd' is the other command from which option values will be taken (a command object will be created for it if necessary); the remaining arguments are '(src_option,dst_option)' tuples which mean "take the value of 'src_option' in the 'src_cmd' command object, and copy it to 'dst_option' in the current command object".` spawn(self, cmd, search_path=1, level=1) `Spawn an external command respecting dry-run flag.` warn(self, msg) Data and other attributes inherited from Command: sub_commands = []

Functions
`` |  | add_dir(dir, pathlist, index=-1) build_path(dirs) `Builds a path list from a list of directories/paths. The dirs list may contain shell variable references and user dir references. These will get expanded automatically. Non-existing shell variables are replaced with an empty string. Path entries will get expanded to single directory entries. Empty string entries are removed from the list.` find_file(filename, paths, pattern=None) `Look for a file in the directories defined in the list paths. If pattern is given, the found files are additionally checked to include the given RE search pattern. Pattern matching is done case-insensitive per default. Returns the directory where the file can be found or None in case it was not found.` get_msvc_paths() `Return a tuple (libpath, inclpath) defining the search paths for library files and include files that the MS VC++ compiler uses per default. Both entries are lists of directories. Only available on Windows platforms with installed compiler.` mx_customize_compiler(compiler) mx_make_tarball(base_name, base_dir, compression='gzip', verbose=0, dry_run=0, tar_options='-chf') mx_msvccompiler__init__(self, *args, **kws) run_setup(configurations) `Run distutils setup. The parameters passed to setup() are extracted from the list of modules, classes or instances given in configurations. Names with leading underscore are removed from the parameters. Parameters which are not strings, lists or tuples are removed as well. Configurations which occur later in the configurations list override settings of configurations earlier in the list.` verify_path(path) `Verify the directories in path for existence and their directory nature. Also removes duplicates from the list.`

Data
`` |  | FINDINCLPATH = [] FINDLIBPATH = [] GenPPD = None INCLPATH = ['/usr/include'] LIBPATH = ['/usr/local/lib', '/usr/lib'] STDINCLPATH = ['/usr/include'] STDLIBPATH = ['/usr/lib'] _debug = 0 bdist_ppm = None compression_programs = {'bzip2': ('.bz2', 'f9'), 'compress': ('.Z', '-f'), 'gzip': ('.gz', '-f9')}