OpenQuizz
Une application de gestion des contenus pédagogiques
sdist Class Reference
Inheritance diagram for sdist:
Collaboration diagram for sdist:

Public Member Functions

def checking_metadata (self)
 
def initialize_options (self)
 
def finalize_options (self)
 
def run (self)
 
def check_metadata (self)
 
def get_file_list (self)
 
def add_defaults (self)
 
def read_template (self)
 
def prune_file_list (self)
 
def write_manifest (self)
 
def read_manifest (self)
 
def make_release_tree (self, base_dir, files)
 
def make_distribution (self)
 
def get_archive_files (self)
 

Data Fields

 template
 
 manifest
 
 use_defaults
 
 prune
 
 manifest_only
 
 force_manifest
 
 formats
 
 keep_temp
 
 dist_dir
 
 archive_files
 
 metadata_check
 
 owner
 
 group
 
 filelist
 

Static Public Attributes

 description
 
 user_options
 
 boolean_options
 
 help_options
 
 negative_opt
 
 sub_commands
 
 READMES
 

Member Function Documentation

◆ add_defaults()

def 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 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.

◆ check_metadata()

def check_metadata (   self)
Deprecated API.

◆ checking_metadata()

def checking_metadata (   self)
Callable used for the check sub-command.

Placed here so user_options can view it

◆ finalize_options()

def finalize_options (   self)

◆ get_archive_files()

def 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_file_list()

def 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.

◆ initialize_options()

def initialize_options (   self)

◆ make_distribution()

def 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_temp' is true).  The list of archive files created is
stored so it can be retrieved later by 'get_archive_files()'.

◆ make_release_tree()

def 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.

◆ prune_file_list()

def 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-temp, or it aborted)
  * any RCS, CVS, .svn, .hg, .git, .bzr, _darcs directories

◆ read_manifest()

def 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()

def read_template (   self)
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.

◆ run()

def run (   self)

◆ write_manifest()

def 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'.

Field Documentation

◆ archive_files

archive_files

◆ boolean_options

boolean_options
static

◆ description

description
static

◆ dist_dir

dist_dir

◆ filelist

filelist

◆ force_manifest

force_manifest

◆ formats

formats

◆ group

group

◆ help_options

help_options
static

◆ keep_temp

keep_temp

◆ manifest

manifest

◆ manifest_only

manifest_only

◆ metadata_check

metadata_check

◆ negative_opt

negative_opt
static

◆ owner

owner

◆ prune

prune

◆ READMES

READMES
static

◆ sub_commands

sub_commands
static

◆ template

template

◆ use_defaults

use_defaults

◆ user_options

user_options
static

The documentation for this class was generated from the following file: