| """Create a source distribution.""" |
| |
| import os |
| import re |
| import sys |
| from io import StringIO |
| from shutil import get_archive_formats, rmtree |
| |
| from packaging import logger |
| from packaging.util import resolve_name |
| from packaging.errors import (PackagingPlatformError, PackagingOptionError, |
| PackagingModuleError, PackagingFileError) |
| from packaging.command import get_command_names |
| from packaging.command.cmd import Command |
| from packaging.manifest import Manifest |
| |
| |
| def show_formats(): |
| """Print all possible values for the 'formats' option (used by |
| the "--help-formats" command-line option). |
| """ |
| from packaging.fancy_getopt import FancyGetopt |
| formats = sorted(('formats=' + name, None, desc) |
| for name, desc in get_archive_formats()) |
| FancyGetopt(formats).print_help( |
| "List of available source distribution formats:") |
| |
| # a \ followed by some spaces + EOL |
| _COLLAPSE_PATTERN = re.compile('\\\w\n', re.M) |
| _COMMENTED_LINE = re.compile('^#.*\n$|^\w*\n$', re.M) |
| |
| |
| class sdist(Command): |
| |
| description = "create a source distribution (tarball, zip file, etc.)" |
| |
| user_options = [ |
| ('manifest=', 'm', |
| "name of manifest file [default: MANIFEST]"), |
| ('use-defaults', None, |
| "include the default file set in the manifest " |
| "[default; disable with --no-defaults]"), |
| ('no-defaults', None, |
| "don't include the default file set"), |
| ('prune', None, |
| "specifically exclude files/directories that should not be " |
| "distributed (build tree, RCS/CVS dirs, etc.) " |
| "[default; disable with --no-prune]"), |
| ('no-prune', None, |
| "don't automatically exclude anything"), |
| ('manifest-only', 'o', |
| "just regenerate the manifest and then stop "), |
| ('formats=', None, |
| "formats for source distribution (comma-separated list)"), |
| ('keep-temp', 'k', |
| "keep the distribution tree around after creating " + |
| "archive file(s)"), |
| ('dist-dir=', 'd', |
| "directory to put the source distribution archive(s) in " |
| "[default: dist]"), |
| ('check-metadata', None, |
| "Ensure that all required elements of metadata " |
| "are supplied. Warn if any missing. [default]"), |
| ('owner=', 'u', |
| "Owner name used when creating a tar file [default: current user]"), |
| ('group=', 'g', |
| "Group name used when creating a tar file [default: current group]"), |
| ('manifest-builders=', None, |
| "manifest builders (comma-separated list)"), |
| ] |
| |
| boolean_options = ['use-defaults', 'prune', |
| 'manifest-only', 'keep-temp', 'check-metadata'] |
| |
| help_options = [ |
| ('help-formats', None, |
| "list available distribution formats", show_formats), |
| ] |
| |
| negative_opt = {'no-defaults': 'use-defaults', |
| 'no-prune': 'prune'} |
| |
| default_format = {'posix': 'gztar', |
| 'nt': 'zip'} |
| |
| def initialize_options(self): |
| self.manifest = None |
| # 'use_defaults': if true, we will include the default file set |
| # in the manifest |
| self.use_defaults = True |
| self.prune = True |
| self.manifest_only = False |
| self.formats = None |
| self.keep_temp = False |
| self.dist_dir = None |
| |
| self.archive_files = None |
| self.metadata_check = True |
| self.owner = None |
| self.group = None |
| self.filelist = None |
| self.manifest_builders = None |
| |
| def _check_archive_formats(self, formats): |
| supported_formats = [name for name, desc in get_archive_formats()] |
| for format in formats: |
| if format not in supported_formats: |
| return format |
| return None |
| |
| def finalize_options(self): |
| if self.manifest is None: |
| self.manifest = "MANIFEST" |
| |
| self.ensure_string_list('formats') |
| if self.formats is None: |
| try: |
| self.formats = [self.default_format[os.name]] |
| except KeyError: |
| raise PackagingPlatformError("don't know how to create source " |
| "distributions on platform %s" % os.name) |
| |
| bad_format = self._check_archive_formats(self.formats) |
| if bad_format: |
| raise PackagingOptionError("unknown archive format '%s'" \ |
| % bad_format) |
| |
| if self.dist_dir is None: |
| self.dist_dir = "dist" |
| |
| if self.filelist is None: |
| self.filelist = Manifest() |
| |
| if self.manifest_builders is None: |
| self.manifest_builders = [] |
| else: |
| if isinstance(self.manifest_builders, str): |
| self.manifest_builders = self.manifest_builders.split(',') |
| builders = [] |
| for builder in self.manifest_builders: |
| builder = builder.strip() |
| if builder == '': |
| continue |
| try: |
| builder = resolve_name(builder) |
| except ImportError as e: |
| raise PackagingModuleError(e) |
| |
| builders.append(builder) |
| |
| self.manifest_builders = builders |
| |
| def run(self): |
| # 'filelist' contains the list of files that will make up the |
| # manifest |
| self.filelist.clear() |
| |
| # Check the package metadata |
| if self.metadata_check: |
| self.run_command('check') |
| |
| # Do whatever it takes to get the list of files to process |
| # (process the manifest template, read an existing manifest, |
| # whatever). File list is accumulated in 'self.filelist'. |
| self.get_file_list() |
| |
| # If user just wanted us to regenerate the manifest, stop now. |
| if self.manifest_only: |
| return |
| |
| # Otherwise, go ahead and create the source distribution tarball, |
| # or zipfile, or whatever. |
| self.make_distribution() |
| |
| 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. |
| """ |
| template_exists = len(self.distribution.extra_files) > 0 |
| if not template_exists: |
| logger.warning('%s: using default file list', |
| self.get_command_name()) |
| self.filelist.findall() |
| |
| if self.use_defaults: |
| self.add_defaults() |
| if template_exists: |
| template = '\n'.join(self.distribution.extra_files) |
| self.filelist.read_template(StringIO(template)) |
| |
| # call manifest builders, if any. |
| for builder in self.manifest_builders: |
| builder(self.distribution, self.filelist) |
| |
| if self.prune: |
| self.prune_file_list() |
| |
| self.filelist.write(self.manifest) |
| |
| def add_defaults(self): |
| """Add all default files to self.filelist. |
| |
| In addition to the setup.cfg file, this will include all files returned |
| by the get_source_files of every registered command. This will find |
| Python modules and packages, data files listed in package_data_, |
| data_files and extra_files, scripts, C sources of extension modules or |
| C libraries (headers are missing). |
| """ |
| if os.path.exists('setup.cfg'): |
| self.filelist.append('setup.cfg') |
| else: |
| logger.warning("%s: standard 'setup.cfg' file not found", |
| self.get_command_name()) |
| |
| for cmd_name in get_command_names(): |
| try: |
| cmd_obj = self.get_finalized_command(cmd_name) |
| except PackagingOptionError: |
| pass |
| else: |
| self.filelist.extend(cmd_obj.get_source_files()) |
| |
| 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 |
| """ |
| build = self.get_finalized_command('build') |
| base_dir = self.distribution.get_fullname() |
| |
| self.filelist.exclude_pattern(None, prefix=build.build_base) |
| self.filelist.exclude_pattern(None, prefix=base_dir) |
| |
| # pruning out vcs directories |
| # both separators are used under win32 |
| if sys.platform == 'win32': |
| seps = r'/|\\' |
| else: |
| seps = '/' |
| |
| vcs_dirs = ['RCS', 'CVS', r'\.svn', r'\.hg', r'\.git', r'\.bzr', |
| '_darcs'] |
| vcs_ptrn = r'(^|%s)(%s)(%s).*' % (seps, '|'.join(vcs_dirs), seps) |
| self.filelist.exclude_pattern(vcs_ptrn, is_regex=True) |
| |
| 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. |
| """ |
| # Create all the directories under 'base_dir' necessary to |
| # put 'files' there; the 'mkpath()' is just so we don't die |
| # if the manifest happens to be empty. |
| self.mkpath(base_dir) |
| self.create_tree(base_dir, files, dry_run=self.dry_run) |
| |
| # And walk over the list of files, either making a hard link (if |
| # os.link exists) to each one that doesn't already exist in its |
| # corresponding location under 'base_dir', or copying each file |
| # that's out-of-date in 'base_dir'. (Usually, all files will be |
| # out-of-date, because by default we blow away 'base_dir' when |
| # we're done making the distribution archives.) |
| |
| if hasattr(os, 'link'): # can make hard links on this system |
| link = 'hard' |
| msg = "making hard links in %s..." % base_dir |
| else: # nope, have to copy |
| link = None |
| msg = "copying files to %s..." % base_dir |
| |
| if not files: |
| logger.warning("no files to distribute -- empty manifest?") |
| else: |
| logger.info(msg) |
| |
| for file in self.distribution.metadata.requires_files: |
| if file not in files: |
| msg = "'%s' must be included explicitly in 'extra_files'" \ |
| % file |
| raise PackagingFileError(msg) |
| |
| for file in files: |
| if not os.path.isfile(file): |
| logger.warning("'%s' not a regular file -- skipping", file) |
| else: |
| dest = os.path.join(base_dir, file) |
| self.copy_file(file, dest, link=link) |
| |
| self.distribution.metadata.write(os.path.join(base_dir, 'PKG-INFO')) |
| |
| 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()'. |
| """ |
| # Don't warn about missing metadata here -- should be (and is!) |
| # done elsewhere. |
| base_dir = self.distribution.get_fullname() |
| base_name = os.path.join(self.dist_dir, base_dir) |
| |
| self.make_release_tree(base_dir, self.filelist.files) |
| archive_files = [] # remember names of files we create |
| # tar archive must be created last to avoid overwrite and remove |
| if 'tar' in self.formats: |
| self.formats.append(self.formats.pop(self.formats.index('tar'))) |
| |
| for fmt in self.formats: |
| file = self.make_archive(base_name, fmt, base_dir=base_dir, |
| owner=self.owner, group=self.group) |
| archive_files.append(file) |
| self.distribution.dist_files.append(('sdist', '', file)) |
| |
| self.archive_files = archive_files |
| |
| if not self.keep_temp: |
| if self.dry_run: |
| logger.info('removing %s', base_dir) |
| else: |
| rmtree(base_dir) |
| |
| 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. |
| """ |
| return self.archive_files |
| |
| def create_tree(self, base_dir, files, mode=0o777, verbose=1, |
| dry_run=False): |
| need_dir = set() |
| for file in files: |
| need_dir.add(os.path.join(base_dir, os.path.dirname(file))) |
| |
| # Now create them |
| for dir in sorted(need_dir): |
| self.mkpath(dir, mode, verbose=verbose, dry_run=dry_run) |