Greg Ward | e1664bd | 2000-03-31 02:56:34 +0000 | [diff] [blame] | 1 | """distutils.command.bdist_dumb |
| 2 | |
| 3 | Implements the Distutils 'bdist_dumb' command (create a "dumb" built |
| 4 | distribution -- i.e., just an archive to be unpacked under $prefix or |
| 5 | $exec_prefix).""" |
| 6 | |
Andrew M. Kuchling | d448f66 | 2002-11-19 13:12:28 +0000 | [diff] [blame] | 7 | # This module should be kept compatible with Python 1.5.2. |
| 8 | |
Greg Ward | e1664bd | 2000-03-31 02:56:34 +0000 | [diff] [blame] | 9 | __revision__ = "$Id$" |
| 10 | |
| 11 | import os |
| 12 | from distutils.core import Command |
Greg Ward | ab3a0f3 | 2000-08-05 01:31:54 +0000 | [diff] [blame] | 13 | from distutils.util import get_platform |
Andrew M. Kuchling | acd5cb2 | 2002-11-26 17:45:19 +0000 | [diff] [blame] | 14 | from distutils.dir_util import create_tree, remove_tree, ensure_relative |
Greg Ward | 6ce94b7 | 2000-04-26 02:29:51 +0000 | [diff] [blame] | 15 | from distutils.errors import * |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 16 | from distutils import log |
Greg Ward | e1664bd | 2000-03-31 02:56:34 +0000 | [diff] [blame] | 17 | |
| 18 | class bdist_dumb (Command): |
| 19 | |
| 20 | description = "create a \"dumb\" built distribution" |
| 21 | |
Gregory P. Smith | ba0506b | 2000-05-13 03:06:56 +0000 | [diff] [blame] | 22 | user_options = [('bdist-dir=', 'd', |
| 23 | "temporary directory for creating the distribution"), |
Greg Ward | 20283e5 | 2000-09-11 00:47:35 +0000 | [diff] [blame] | 24 | ('plat-name=', 'p', |
| 25 | "platform name to embed in generated filenames " |
| 26 | "(default: %s)" % get_platform()), |
Gregory P. Smith | ba0506b | 2000-05-13 03:06:56 +0000 | [diff] [blame] | 27 | ('format=', 'f', |
Greg Ward | e1664bd | 2000-03-31 02:56:34 +0000 | [diff] [blame] | 28 | "archive format to create (tar, ztar, gztar, zip)"), |
Greg Ward | 8429036 | 2000-09-16 15:53:41 +0000 | [diff] [blame] | 29 | ('keep-temp', 'k', |
Greg Ward | b4c850c | 2000-03-31 05:22:47 +0000 | [diff] [blame] | 30 | "keep the pseudo-installation tree around after " + |
| 31 | "creating the distribution archive"), |
Greg Ward | c4eb84a | 2000-07-05 03:07:37 +0000 | [diff] [blame] | 32 | ('dist-dir=', 'd', |
| 33 | "directory to put final built distributions in"), |
Martin v. Löwis | 9668b93 | 2002-01-12 11:27:42 +0000 | [diff] [blame] | 34 | ('skip-build', None, |
| 35 | "skip rebuilding everything (for testing/debugging)"), |
Andrew M. Kuchling | acd5cb2 | 2002-11-26 17:45:19 +0000 | [diff] [blame] | 36 | ('relative', None, |
| 37 | "build the archive using relative paths" |
| 38 | "(default: false)"), |
Greg Ward | e1664bd | 2000-03-31 02:56:34 +0000 | [diff] [blame] | 39 | ] |
| 40 | |
Andrew M. Kuchling | acd5cb2 | 2002-11-26 17:45:19 +0000 | [diff] [blame] | 41 | boolean_options = ['keep-temp', 'skip-build', 'relative'] |
Greg Ward | 99b032e | 2000-09-25 01:41:15 +0000 | [diff] [blame] | 42 | |
Greg Ward | e1664bd | 2000-03-31 02:56:34 +0000 | [diff] [blame] | 43 | default_format = { 'posix': 'gztar', |
Marc-André Lemburg | 2544f51 | 2002-01-31 18:56:00 +0000 | [diff] [blame] | 44 | 'nt': 'zip', |
| 45 | 'os2': 'zip' } |
Greg Ward | e1664bd | 2000-03-31 02:56:34 +0000 | [diff] [blame] | 46 | |
| 47 | |
| 48 | def initialize_options (self): |
Gregory P. Smith | ba0506b | 2000-05-13 03:06:56 +0000 | [diff] [blame] | 49 | self.bdist_dir = None |
Greg Ward | 20283e5 | 2000-09-11 00:47:35 +0000 | [diff] [blame] | 50 | self.plat_name = None |
Greg Ward | e1664bd | 2000-03-31 02:56:34 +0000 | [diff] [blame] | 51 | self.format = None |
Greg Ward | 8429036 | 2000-09-16 15:53:41 +0000 | [diff] [blame] | 52 | self.keep_temp = 0 |
Greg Ward | c4eb84a | 2000-07-05 03:07:37 +0000 | [diff] [blame] | 53 | self.dist_dir = None |
Martin v. Löwis | 9668b93 | 2002-01-12 11:27:42 +0000 | [diff] [blame] | 54 | self.skip_build = 0 |
Andrew M. Kuchling | acd5cb2 | 2002-11-26 17:45:19 +0000 | [diff] [blame] | 55 | self.relative = 0 |
Tim Peters | 182b5ac | 2004-07-18 06:16:08 +0000 | [diff] [blame^] | 56 | |
Greg Ward | e1664bd | 2000-03-31 02:56:34 +0000 | [diff] [blame] | 57 | # initialize_options() |
| 58 | |
| 59 | |
| 60 | def finalize_options (self): |
Greg Ward | 20283e5 | 2000-09-11 00:47:35 +0000 | [diff] [blame] | 61 | |
Gregory P. Smith | ba0506b | 2000-05-13 03:06:56 +0000 | [diff] [blame] | 62 | if self.bdist_dir is None: |
Greg Ward | 4fb29e5 | 2000-05-27 17:27:23 +0000 | [diff] [blame] | 63 | bdist_base = self.get_finalized_command('bdist').bdist_base |
Gregory P. Smith | ba0506b | 2000-05-13 03:06:56 +0000 | [diff] [blame] | 64 | self.bdist_dir = os.path.join(bdist_base, 'dumb') |
| 65 | |
Greg Ward | e1664bd | 2000-03-31 02:56:34 +0000 | [diff] [blame] | 66 | if self.format is None: |
| 67 | try: |
| 68 | self.format = self.default_format[os.name] |
| 69 | except KeyError: |
| 70 | raise DistutilsPlatformError, \ |
| 71 | ("don't know how to create dumb built distributions " + |
| 72 | "on platform %s") % os.name |
| 73 | |
Greg Ward | 20283e5 | 2000-09-11 00:47:35 +0000 | [diff] [blame] | 74 | self.set_undefined_options('bdist', |
| 75 | ('dist_dir', 'dist_dir'), |
| 76 | ('plat_name', 'plat_name')) |
Greg Ward | c4eb84a | 2000-07-05 03:07:37 +0000 | [diff] [blame] | 77 | |
Greg Ward | e1664bd | 2000-03-31 02:56:34 +0000 | [diff] [blame] | 78 | # finalize_options() |
| 79 | |
| 80 | |
| 81 | def run (self): |
| 82 | |
Martin v. Löwis | 9668b93 | 2002-01-12 11:27:42 +0000 | [diff] [blame] | 83 | if not self.skip_build: |
| 84 | self.run_command('build') |
Greg Ward | e1664bd | 2000-03-31 02:56:34 +0000 | [diff] [blame] | 85 | |
Greg Ward | 24511d2 | 2000-09-16 15:30:47 +0000 | [diff] [blame] | 86 | install = self.reinitialize_command('install', reinit_subcommands=1) |
Gregory P. Smith | ba0506b | 2000-05-13 03:06:56 +0000 | [diff] [blame] | 87 | install.root = self.bdist_dir |
Martin v. Löwis | 9668b93 | 2002-01-12 11:27:42 +0000 | [diff] [blame] | 88 | install.skip_build = self.skip_build |
Thomas Heller | fd0e82a | 2002-04-09 14:14:38 +0000 | [diff] [blame] | 89 | install.warn_dir = 0 |
Greg Ward | e1664bd | 2000-03-31 02:56:34 +0000 | [diff] [blame] | 90 | |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 91 | log.info("installing to %s" % self.bdist_dir) |
Greg Ward | 24511d2 | 2000-09-16 15:30:47 +0000 | [diff] [blame] | 92 | self.run_command('install') |
Greg Ward | e1664bd | 2000-03-31 02:56:34 +0000 | [diff] [blame] | 93 | |
| 94 | # And make an archive relative to the root of the |
| 95 | # pseudo-installation tree. |
Greg Ward | 0ae7f76 | 2000-04-22 02:51:25 +0000 | [diff] [blame] | 96 | archive_basename = "%s.%s" % (self.distribution.get_fullname(), |
Greg Ward | 20283e5 | 2000-09-11 00:47:35 +0000 | [diff] [blame] | 97 | self.plat_name) |
Marc-André Lemburg | 2544f51 | 2002-01-31 18:56:00 +0000 | [diff] [blame] | 98 | |
| 99 | # OS/2 objects to any ":" characters in a filename (such as when |
| 100 | # a timestamp is used in a version) so change them to hyphens. |
| 101 | if os.name == "os2": |
| 102 | archive_basename = archive_basename.replace(":", "-") |
| 103 | |
Andrew M. Kuchling | acd5cb2 | 2002-11-26 17:45:19 +0000 | [diff] [blame] | 104 | pseudoinstall_root = os.path.join(self.dist_dir, archive_basename) |
| 105 | if not self.relative: |
| 106 | archive_root = self.bdist_dir |
| 107 | else: |
| 108 | if (self.distribution.has_ext_modules() and |
| 109 | (install.install_base != install.install_platbase)): |
| 110 | raise DistutilsPlatformError, \ |
| 111 | ("can't make a dumb built distribution where " |
| 112 | "base and platbase are different (%s, %s)" |
| 113 | % (repr(install.install_base), |
| 114 | repr(install.install_platbase))) |
| 115 | else: |
| 116 | archive_root = os.path.join(self.bdist_dir, |
| 117 | ensure_relative(install.install_base)) |
| 118 | |
| 119 | # Make the archive |
| 120 | self.make_archive(pseudoinstall_root, |
| 121 | self.format, root_dir=archive_root) |
Greg Ward | e1664bd | 2000-03-31 02:56:34 +0000 | [diff] [blame] | 122 | |
Greg Ward | 8429036 | 2000-09-16 15:53:41 +0000 | [diff] [blame] | 123 | if not self.keep_temp: |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 124 | remove_tree(self.bdist_dir, dry_run=self.dry_run) |
Greg Ward | b4c850c | 2000-03-31 05:22:47 +0000 | [diff] [blame] | 125 | |
Greg Ward | e1664bd | 2000-03-31 02:56:34 +0000 | [diff] [blame] | 126 | # run() |
| 127 | |
Greg Ward | e1664bd | 2000-03-31 02:56:34 +0000 | [diff] [blame] | 128 | # class bdist_dumb |