distutils.command.sdist
index
/usr/lib/python1.6/distutils/command/sdist.py

distutils.command.sdist
 
Implements the Distutils 'sdist' command (create a source distribution).

 
Modules
            
distutils.archive_util
distutils.dep_util
distutils.dir_util
distutils.file_util
os
string
sys

 
Classes
            
distutils.cmd.Command
sdist

 
class sdist(distutils.cmd.Command)
       
  
__getattr__(self, attr) from distutils.cmd.Command
__init__(self, dist) from distutils.cmd.Command
_ensure_stringlike(self, option, what, default=None) from distutils.cmd.Command
_ensure_tested_string(self, option, tester, what, error_fmt, default=None) from distutils.cmd.Command
add_defaults(self)
Add all the default files to self.filelist:
  - README or README.txt
  - setup.py
  - test/test*.py
  - all pure Python modules mentioned in setup script
  - 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.
announce(self, msg, level=1) from distutils.cmd.Command
check_metadata(self)
Ensure that all required elements of meta-data (name, version,
URL, (author and author_email) or (maintainer and
maintainer_email)) are supplied by the Distribution object; warn if
any are missing.
copy_file(self, infile, outfile, preserve_mode=1, preserve_times=1, link=None, level=1) from distutils.cmd.Command
copy_tree(self, infile, outfile, preserve_mode=1, preserve_times=1, preserve_symlinks=0, level=1) from distutils.cmd.Command
debug_print(self, msg) from distutils.cmd.Command
dump_options(self, header=None, indent='') from distutils.cmd.Command
ensure_dirname(self, option) from distutils.cmd.Command
ensure_filename(self, option) from distutils.cmd.Command
ensure_finalized(self) from distutils.cmd.Command
ensure_string(self, option, default=None) from distutils.cmd.Command
ensure_string_list(self, option) from distutils.cmd.Command
execute(self, func, args, msg=None, level=1) from distutils.cmd.Command
finalize_options(self)
get_archive_files(self)
Return the list of archive files created when the command
was run, or None if the command hasn't run yet.
get_command_name(self) from distutils.cmd.Command
get_file_list(self)
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 and the state of the filesystem.
get_finalized_command(self, command, create=1) from distutils.cmd.Command
initialize_options(self)
make_archive(self, base_name, format, root_dir=None, base_dir=None) from distutils.cmd.Command
make_distribution(self)
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_tree' is true).  The list of archive files created is
stored so it can be retrieved later by 'get_archive_files()'.
make_file(self, infiles, outfile, func, args, exec_msg=None, skip_msg=None, level=1) from distutils.cmd.Command
make_release_tree(self, base_dir, 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.
mkpath(self, name, mode=511) from distutils.cmd.Command
move_file(self, src, dst, level=1) from distutils.cmd.Command
prune_file_list(self)
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-tree, or it aborted)
  * any RCS or CVS directories
read_manifest(self)
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_template(self)
Read and parse the manifest template file named by
'self.template' (usually "MANIFEST.in").  The parsing and
processing is done by 'self.filelist', which updates itself
accordingly.
reinitialize_command(self, command) from distutils.cmd.Command
run(self)
run_command(self, command) from distutils.cmd.Command
set_undefined_options(self, src_cmd, *option_pairs) from distutils.cmd.Command
spawn(self, cmd, search_path=1, level=1) from distutils.cmd.Command
warn(self, msg) from distutils.cmd.Command
write_manifest(self)
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'.

 
Functions
            
show_formats()
Print all possible values for the 'formats' option (used by
the "--help-formats" command-line option).

 
Data
             BufferType = <type 'buffer'>
BuiltinFunctionType = <type 'builtin_function_or_method'>
BuiltinMethodType = <type 'builtin_function_or_method'>
ClassType = <type 'class'>
CodeType = <type 'code'>
ComplexType = <type 'complex'>
DictType = <type 'dictionary'>
DictionaryType = <type 'dictionary'>
EllipsisType = <type 'ellipsis'>
FileType = <type 'file'>
FloatType = <type 'float'>
FrameType = <type 'frame'>
FunctionType = <type 'function'>
InstanceType = <type 'instance'>
IntType = <type 'int'>
LambdaType = <type 'function'>
ListType = <type 'list'>
LongType = <type 'long int'>
MethodType = <type 'instance method'>
ModuleType = <type 'module'>
NoneType = <type 'None'>
SliceType = <type 'slice'>
StringType = <type 'string'>
TracebackType = <type 'traceback'>
TupleType = <type 'tuple'>
TypeType = <type 'type'>
UnboundMethodType = <type 'instance method'>
UnicodeType = <type 'unicode'>
XRangeType = <type 'xrange'>
__file__ = '/usr/lib/python1.6/distutils/command/sdist.pyc'
__name__ = 'distutils.command.sdist'
__revision__ = '$Id: sdist.py,v 1.42 2000/08/05 01:31:54 gward Exp $'