Undocumented
Method | add |
Add all the default files to self.filelist: - README or README.txt - setup.py - tests/test*.py and test/test*.py - all pure Python modules mentioned in setup script - all files pointed by package_data (build_py) - all files defined in data_files... |
Method | check |
Deprecated API. |
Method | checking |
Callable used for the check sub-command. |
Method | finalize |
Set final values for all the options that this command supports. This is always called as late as possible, ie. after any option assignments from the command-line or from other commands have been done... |
Method | get |
Return the list of archive files created when the command was run, or None if the command hasn't run yet. |
Method | get |
Figure out the list of files to include in the source distribution, and put it in 'self.filelist'. This might involve reading the manifest template (and writing the manifest), or just reading the manifest, or just using the default file set -- it all depends on the user's options. |
Method | initialize |
Set default values for all the options that this command supports. Note that these defaults may be overridden by other commands, by the setup script, by config files, or by the command-line. Thus, this is not the place to code dependencies between options; generally, 'initialize_options()' implementations are just a bunch of "self... |
Method | make |
Create the source distribution(s). First, we create the release tree with 'make_release_tree()'; then, we create all required archive files (according to 'self.formats') from the release tree. Finally, we clean up by blowing away the release tree (unless 'self... |
Method | make |
Create the directory tree that will become the source distribution archive. All directories implied by the filenames in 'files' are created under 'base_dir', and then we hard link or copy (if hard linking is unavailable) those files into place... |
Method | prune |
Prune off branches that might slip into the file list as created by 'read_template()', but really don't belong there: * the build tree (typically "build") * the release tree itself (only an issue if we ran "sdist" previously with --keep-temp, or it aborted) * any RCS, CVS,... |
Method | read |
Read the manifest file (named by 'self.manifest') and use it to fill in 'self.filelist', the list of files to include in the source distribution. |
Method | read |
Read and parse manifest template file named by self.template. |
Method | run |
A command's raison d'etre: carry out the action it exists to perform, controlled by the options initialized in 'initialize_options()', customized by other commands, the setup script, the command-line, and config files, and finalized in 'finalize_options()'... |
Method | write |
Write the file list in 'self.filelist' (presumably as filled in by 'add_defaults()' and 'read_template()') to the manifest file named by 'self.manifest'. |
Constant | READMES |
Undocumented |
Class Variable | boolean |
Undocumented |
Class Variable | description |
Undocumented |
Class Variable | help |
Undocumented |
Class Variable | negative |
Undocumented |
Class Variable | sub |
Undocumented |
Class Variable | user |
Undocumented |
Instance Variable | archive |
Undocumented |
Instance Variable | dist |
Undocumented |
Instance Variable | filelist |
Undocumented |
Instance Variable | force |
Undocumented |
Instance Variable | formats |
Undocumented |
Instance Variable | group |
Undocumented |
Instance Variable | keep |
Undocumented |
Instance Variable | manifest |
Undocumented |
Instance Variable | manifest |
Undocumented |
Instance Variable | metadata |
Undocumented |
Instance Variable | owner |
Undocumented |
Instance Variable | prune |
Undocumented |
Instance Variable | template |
Undocumented |
Instance Variable | use |
Undocumented |
Static Method | _cs |
Case-sensitive path existence check |
Method | _add |
Undocumented |
Method | _add |
Undocumented |
Method | _add |
Undocumented |
Method | _add |
Undocumented |
Method | _add |
Undocumented |
Method | _add |
Undocumented |
Method | _add |
Undocumented |
Method | _manifest |
Undocumented |
Inherited from Command
:
Method | __getattr__ |
Undocumented |
Method | __init__ |
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. |
Method | announce |
Undocumented |
Method | copy |
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.) |
Method | copy |
Copy an entire directory tree respecting verbose, dry-run, and force flags. |
Method | debug |
Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true. |
Method | dump |
Undocumented |
Method | ensure |
Undocumented |
Method | ensure |
Ensure that 'option' is the name of an existing file. |
Method | ensure |
Undocumented |
Method | ensure |
Ensure that 'option' is a string; if not defined, set it to 'default'. |
Method | ensure |
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"]. |
Method | execute |
Undocumented |
Method | get |
Undocumented |
Method | get |
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. |
Method | get |
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... |
Method | make |
Undocumented |
Method | make |
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'... |
Method | mkpath |
Undocumented |
Method | move |
Move a file respecting dry-run flag. |
Method | reinitialize |
Undocumented |
Method | run |
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. |
Method | set |
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()'... |
Method | spawn |
Spawn an external command respecting dry-run flag. |
Method | warn |
Undocumented |
Instance Variable | distribution |
Undocumented |
Instance Variable | finalized |
Undocumented |
Instance Variable | force |
Undocumented |
Instance Variable | help |
Undocumented |
Instance Variable | verbose |
Undocumented |
Method | _ensure |
Undocumented |
Method | _ensure |
Undocumented |
Instance Variable | _dry |
Undocumented |
Add all the default files to self.filelist: - README or README.txt - setup.py - tests/test*.py and test/test*.py - all pure Python modules mentioned in setup script - all files pointed by package_data (build_py) - all files defined in data_files. - all files defined as scripts. - all C sources listed as part of extensions or C libraries in the setup script (doesn't catch C headers!) Warns if (README or README.txt) or setup.py are missing; everything else is optional.
Set final values for all the options that this command supports. This is always called as late as possible, ie. after any option assignments from the command-line or from other commands have been done. Thus, this is the place to code option dependencies: if 'foo' depends on 'bar', then it is safe to set 'foo' from 'bar' as long as 'foo' still has the same value it was assigned in 'initialize_options()'. This method must be implemented by all command classes.
Return the list of archive files created when the command was run, or None if the command hasn't run yet.
Figure out the list of files to include in the source distribution, and put it in 'self.filelist'. This might involve reading the manifest template (and writing the manifest), or just reading the manifest, or just using the default file set -- it all depends on the user's options.
Set default values for all the options that this command supports. Note that these defaults may be overridden by other commands, by the setup script, by config files, or by the command-line. Thus, this is not the place to code dependencies between options; generally, 'initialize_options()' implementations are just a bunch of "self.foo = None" assignments. This method must be implemented by all command classes.
Create the source distribution(s). First, we create the release tree with 'make_release_tree()'; then, we create all required archive files (according to 'self.formats') from the release tree. Finally, we clean up by blowing away the release tree (unless 'self.keep_temp' is true). The list of archive files created is stored so it can be retrieved later by 'get_archive_files()'.
Create the directory tree that will become the source distribution archive. All directories implied by the filenames in 'files' are created under 'base_dir', and then we hard link or copy (if hard linking is unavailable) those files into place. Essentially, this duplicates the developer's source tree, but in a directory named after the distribution, containing only the files to be distributed.
Prune off branches that might slip into the file list as created by 'read_template()', but really don't belong there: * the build tree (typically "build") * the release tree itself (only an issue if we ran "sdist" previously with --keep-temp, or it aborted) * any RCS, CVS, .svn, .hg, .git, .bzr, _darcs directories
Read the manifest file (named by 'self.manifest') and use it to fill in 'self.filelist', the list of files to include in the source distribution.
Read and parse manifest template file named by self.template. (usually "MANIFEST.in") The parsing and processing is done by 'self.filelist', which updates itself accordingly.
setuptools._distutils.core.Command.run
A command's raison d'etre: carry out the action it exists to perform, controlled by the options initialized in 'initialize_options()', customized by other commands, the setup script, the command-line, and config files, and finalized in 'finalize_options()'. All terminal output and filesystem interaction should be done by 'run()'. This method must be implemented by all command classes.
Write the file list in 'self.filelist' (presumably as filled in by 'add_defaults()' and 'read_template()') to the manifest file named by 'self.manifest'.