[Python-checkins] r73197 - in python/trunk/Lib/distutils: command/install.py tests/test_install.py

Thu Jun 4 09:31:53 CEST 2009

Author: tarek.ziade
Date: Thu Jun 4 09:31:52 2009
New Revision: 73197
Log:
improved test coverage for distutils.command.install and cleaned it up
Modified:
 python/trunk/Lib/distutils/command/install.py
 python/trunk/Lib/distutils/tests/test_install.py
Modified: python/trunk/Lib/distutils/command/install.py
==============================================================================

--- python/trunk/Lib/distutils/command/install.py	(original)
+++ python/trunk/Lib/distutils/command/install.py	Thu Jun 4 09:31:52 2009
@@ -2,12 +2,12 @@
 
 Implements the Distutils 'install' command."""
 
-from distutils import log
-
 __revision__ = "$Id$"
 
-import sys, os, string
-from types import *
+import sys
+import os
+
+from distutils import log
 from distutils.core import Command
 from distutils.debug import DEBUG
 from distutils.sysconfig import get_config_vars
@@ -117,7 +117,7 @@
 SCHEME_KEYS = ('purelib', 'platlib', 'headers', 'scripts', 'data')
 
 
-class install (Command):
+class install(Command):
 
 description = "install everything from build directory"
 
@@ -190,8 +190,8 @@
 negative_opt = {'no-compile' : 'compile'}
 
 
- def initialize_options (self):
-
+ def initialize_options(self):
+ """Initializes options."""
 # High-level options: these select both an installation base
 # and scheme.
 self.prefix = None
@@ -267,8 +267,8 @@
 # party Python modules on various platforms given a wide
 # array of user input is decided. Yes, it's quite complex!)
 
- def finalize_options (self):
-
+ def finalize_options(self):
+ """Finalizes options."""
 # This method (and its pliant slaves, like 'finalize_unix()',
 # 'finalize_other()', and 'select_scheme()') is where the default
 # installation directories for modules, extension modules, and
@@ -326,7 +326,7 @@
 # $platbase in the other installation directories and not worry
 # about needing recursive variable expansion (shudder).
 
- py_version = (string.split(sys.version))[0]
+ py_version = sys.version.split()[0]
 (prefix, exec_prefix) = get_config_vars('prefix', 'exec_prefix')
 self.config_vars = {'dist_name': self.distribution.get_name(),
 'dist_version': self.distribution.get_version(),
@@ -409,29 +409,27 @@
 # Punt on doc directories for now -- after all, we're punting on
 # documentation completely!
 
- # finalize_options ()
-
-
- def dump_dirs (self, msg):
- if DEBUG:
- from distutils.fancy_getopt import longopt_xlate
- print msg + ":"
- for opt in self.user_options:
- opt_name = opt[0]
- if opt_name[-1] == "=":
- opt_name = opt_name[0:-1]
- if opt_name in self.negative_opt:
- opt_name = string.translate(self.negative_opt[opt_name],
- longopt_xlate)
- val = not getattr(self, opt_name)
- else:
- opt_name = string.translate(opt_name, longopt_xlate)
- val = getattr(self, opt_name)
- print " %s: %s" % (opt_name, val)
-
-
- def finalize_unix (self):
+ def dump_dirs(self, msg):
+ """Dumps the list of user options."""
+ if not DEBUG:
+ return
+ from distutils.fancy_getopt import longopt_xlate
+ log.debug(msg + ":")
+ for opt in self.user_options:
+ opt_name = opt[0]
+ if opt_name[-1] == "=":
+ opt_name = opt_name[0:-1]
+ if opt_name in self.negative_opt:
+ opt_name = self.negative_opt[opt_name]
+ opt_name = opt_name.translate(longopt_xlate)
+ val = not getattr(self, opt_name)
+ else:
+ opt_name = opt_name.translate(longopt_xlate)
+ val = getattr(self, opt_name)
+ log.debug(" %s: %s" % (opt_name, val))
 
+ def finalize_unix(self):
+ """Finalizes options for posix platforms."""
 if self.install_base is not None or self.install_platbase is not None:
 if ((self.install_lib is None and
 self.install_purelib is None and
@@ -470,11 +468,8 @@
 self.install_platbase = self.exec_prefix
 self.select_scheme("unix_prefix")
 
- # finalize_unix ()
-
-
- def finalize_other (self): # Windows and Mac OS for now
-
+ def finalize_other(self):
+ """Finalizes options for non-posix platforms"""
 if self.user:
 if self.install_userbase is None:
 raise DistutilsPlatformError(
@@ -495,10 +490,8 @@
 raise DistutilsPlatformError, \
 "I don't know how to install stuff on '%s'" % os.name
 
- # finalize_other ()
-
-
- def select_scheme (self, name):
+ def select_scheme(self, name):
+ """Sets the install directories by applying the install schemes."""
 # it's the caller's problem if they supply a bad name!
 scheme = INSTALL_SCHEMES[name]
 for key in SCHEME_KEYS:
@@ -506,8 +499,7 @@
 if getattr(self, attrname) is None:
 setattr(self, attrname, scheme[key])
 
-
- def _expand_attrs (self, attrs):
+ def _expand_attrs(self, attrs):
 for attr in attrs:
 val = getattr(self, attr)
 if val is not None:
@@ -516,40 +508,36 @@
 val = subst_vars(val, self.config_vars)
 setattr(self, attr, val)
 
+ def expand_basedirs(self):
+ """Calls `os.path.expanduser` on install_base, install_platbase and
+ root."""
+ self._expand_attrs(['install_base', 'install_platbase', 'root'])
+
+ def expand_dirs(self):
+ """Calls `os.path.expanduser` on install dirs."""
+ self._expand_attrs(['install_purelib', 'install_platlib',
+ 'install_lib', 'install_headers',
+ 'install_scripts', 'install_data',])
 
- def expand_basedirs (self):
- self._expand_attrs(['install_base',
- 'install_platbase',
- 'root'])
-
- def expand_dirs (self):
- self._expand_attrs(['install_purelib',
- 'install_platlib',
- 'install_lib',
- 'install_headers',
- 'install_scripts',
- 'install_data',])
-
-
- def convert_paths (self, *names):
+ def convert_paths(self, *names):
+ """Call `convert_path` over `names`."""
 for name in names:
 attr = "install_" + name
 setattr(self, attr, convert_path(getattr(self, attr)))
 
-
- def handle_extra_path (self):
-
+ def handle_extra_path(self):
+ """Set `path_file` and `extra_dirs` using `extra_path`."""
 if self.extra_path is None:
 self.extra_path = self.distribution.extra_path
 
 if self.extra_path is not None:
- if type(self.extra_path) is StringType:
- self.extra_path = string.split(self.extra_path, ',')
+ if isinstance(self.extra_path, str):
+ self.extra_path = self.extra_path.split(',')
 
 if len(self.extra_path) == 1:
 path_file = extra_dirs = self.extra_path[0]
 elif len(self.extra_path) == 2:
- (path_file, extra_dirs) = self.extra_path
+ path_file, extra_dirs = self.extra_path
 else:
 raise DistutilsOptionError, \
 ("'extra_path' option must be a list, tuple, or "
@@ -558,7 +546,6 @@
 # convert to local form in case Unix notation used (as it
 # should be in setup scripts)
 extra_dirs = convert_path(extra_dirs)
-
 else:
 path_file = None
 extra_dirs = ''
@@ -568,17 +555,14 @@
 self.path_file = path_file
 self.extra_dirs = extra_dirs
 
- # handle_extra_path ()
-
-
- def change_roots (self, *names):
+ def change_roots(self, *names):
+ """Change the install direcories pointed by name using root."""
 for name in names:
 attr = "install_" + name
 setattr(self, attr, change_root(self.root, getattr(self, attr)))
 
 def create_home_path(self):
- """Create directories under ~
- """
+ """Create directories under ~."""
 if not self.user:
 return
 home = convert_path(os.path.expanduser("~"))
@@ -589,8 +573,8 @@
 
 # -- Command execution methods -------------------------------------
 
- def run (self):
-
+ def run(self):
+ """Runs the command."""
 # Obviously have to build before we can install
 if not self.skip_build:
 self.run_command('build')
@@ -633,9 +617,8 @@
 "you'll have to change the search path yourself"),
 self.install_lib)
 
- # run ()
-
- def create_path_file (self):
+ def create_path_file(self):
+ """Creates the .pth file"""
 filename = os.path.join(self.install_libbase,
 self.path_file + ".pth")
 if self.install_path_file:
@@ -648,8 +631,8 @@
 
 # -- Reporting methods ---------------------------------------------
 
- def get_outputs (self):
- # Assemble the outputs of all the sub-commands.
+ def get_outputs(self):
+ """Assembles the outputs of all the sub-commands."""
 outputs = []
 for cmd_name in self.get_sub_commands():
 cmd = self.get_finalized_command(cmd_name)
@@ -665,7 +648,8 @@
 
 return outputs
 
- def get_inputs (self):
+ def get_inputs(self):
+ """Returns the inputs of all the sub-commands"""
 # XXX gee, this looks familiar ;-(
 inputs = []
 for cmd_name in self.get_sub_commands():
@@ -674,25 +658,29 @@
 
 return inputs
 
-
 # -- Predicates for sub-command list -------------------------------
 
- def has_lib (self):
- """Return true if the current distribution has any Python
+ def has_lib(self):
+ """Returns true if the current distribution has any Python
 modules to install."""
 return (self.distribution.has_pure_modules() or
 self.distribution.has_ext_modules())
 
- def has_headers (self):
+ def has_headers(self):
+ """Returns true if the current distribution has any headers to
+ install."""
 return self.distribution.has_headers()
 
- def has_scripts (self):
+ def has_scripts(self):
+ """Returns true if the current distribution has any scripts to.
+ install."""
 return self.distribution.has_scripts()
 
- def has_data (self):
+ def has_data(self):
+ """Returns true if the current distribution has any data to.
+ install."""
 return self.distribution.has_data_files()
 
-
 # 'sub_commands': a list of commands this command might have to run to
 # get its work done. See cmd.py for more info.
 sub_commands = [('install_lib', has_lib),
@@ -701,5 +689,3 @@
 ('install_data', has_data),
 ('install_egg_info', lambda self:True),
 ]
-
-# class install
Modified: python/trunk/Lib/distutils/tests/test_install.py
==============================================================================
--- python/trunk/Lib/distutils/tests/test_install.py	(original)
+++ python/trunk/Lib/distutils/tests/test_install.py	Thu Jun 4 09:31:52 2009
@@ -10,11 +10,14 @@
 from distutils.command import install as install_module
 from distutils.command.install import INSTALL_SCHEMES
 from distutils.core import Distribution
+from distutils.errors import DistutilsOptionError
 
 from distutils.tests import support
 
 
-class InstallTestCase(support.TempdirManager, unittest.TestCase):
+class InstallTestCase(support.TempdirManager,
+ support.LoggingSilencer,
+ unittest.TestCase):
 
 def test_home_installation_scheme(self):
 # This ensure two things:
@@ -112,6 +115,74 @@
 self.assert_('userbase' in cmd.config_vars)
 self.assert_('usersite' in cmd.config_vars)
 
+ def test_handle_extra_path(self):
+ dist = Distribution({'name': 'xx', 'extra_path': 'path,dirs'})
+ cmd = install(dist)
+
+ # two elements
+ cmd.handle_extra_path()
+ self.assertEquals(cmd.extra_path, ['path', 'dirs'])
+ self.assertEquals(cmd.extra_dirs, 'dirs')
+ self.assertEquals(cmd.path_file, 'path')
+
+ # one element
+ cmd.extra_path = ['path']
+ cmd.handle_extra_path()
+ self.assertEquals(cmd.extra_path, ['path'])
+ self.assertEquals(cmd.extra_dirs, 'path')
+ self.assertEquals(cmd.path_file, 'path')
+
+ # none
+ dist.extra_path = cmd.extra_path = None
+ cmd.handle_extra_path()
+ self.assertEquals(cmd.extra_path, None)
+ self.assertEquals(cmd.extra_dirs, '')
+ self.assertEquals(cmd.path_file, None)
+
+ # three elements (no way !)
+ cmd.extra_path = 'path,dirs,again'
+ self.assertRaises(DistutilsOptionError, cmd.handle_extra_path)
+
+ def test_finalize_options(self):
+ dist = Distribution({'name': 'xx'})
+ cmd = install(dist)
+
+ # must supply either prefix/exec-prefix/home or
+ # install-base/install-platbase -- not both
+ cmd.prefix = 'prefix'
+ cmd.install_base = 'base'
+ self.assertRaises(DistutilsOptionError, cmd.finalize_options)
+
+ # must supply either home or prefix/exec-prefix -- not both
+ cmd.install_base = None
+ cmd.home = 'home'
+ self.assertRaises(DistutilsOptionError, cmd.finalize_options)
+
+ # can't combine user with with prefix/exec_prefix/home or
+ # install_(plat)base
+ cmd.prefix = None
+ cmd.user = 'user'
+ self.assertRaises(DistutilsOptionError, cmd.finalize_options)
+
+ def test_record(self):
+
+ install_dir = self.mkdtemp()
+ pkgdir, dist = self.create_dist()
+
+ dist = Distribution()
+ cmd = install(dist)
+ dist.command_obj['install'] = cmd
+ cmd.root = install_dir
+ cmd.record = os.path.join(pkgdir, 'RECORD')
+ cmd.ensure_finalized()
+
+ cmd.run()
+
+ # let's check the RECORD file was created with one
+ # line (the egg info file)
+ with open(cmd.record) as f:
+ self.assertEquals(len(f.readlines()), 1)
+
 def test_suite():
 return unittest.makeSuite(InstallTestCase)
 
