Added support for defining command aliases in distutils configuration

files, under the "[aliases]" section.  To prevent recursion and to allow
aliases to call the command of the same name, a given alias can be expanded
only once per command-line invocation.  You can define new aliases with the
"alias" command, either for the local, global, or per-user configuration.

--HG--
branch : setuptools
extra : convert_revision : svn%3A6015fed2-1504-0410-9fe1-9d1591cc4771/sandbox/trunk/setuptools%4041094

EasyInstall.txt

@@ -495,7 +495,13 @@ Known Issues
    name or version).  Also, this means that if you use the various ``--tag``
    options of "egg_info", any distributions generated will use the tags in the
    version, not just egg distributions.
-   
+
+ * Added support for defining command aliases in distutils configuration files,
+   under the "[aliases]" section.  To prevent recursion and to allow aliases to
+   call the command of the same name, a given alias can be expanded only once
+   per command-line invocation.  You can define new aliases with the "alias"
+   command, either for the local, global, or per-user configuration.
+
  * Added "rotate" command to delete old distribution files, given a set of
    patterns to match and the number of files to keep.  (Keeps the most
    recently-modified distribution files matching each pattern.)

setuptools/command/__init__.py

 import distutils.command
 
-__all__ = ['test', 'develop', 'bdist_egg', 'saveopts', 'setopt', 'rotate']
+__all__ = [
+    'test', 'develop', 'bdist_egg', 'saveopts', 'setopt', 'rotate', 'alias'
+]
 
 
 # Make our commands available as though they were part of the distutils

setuptools/command/alias.py

+import distutils, os
+from setuptools import Command
+from distutils.util import convert_path
+from distutils import log
+from distutils.errors import *
+from setuptools.command.setopt import edit_config, option_base
+
+class alias(option_base):
+    """Abstract base class for commands that mess with config files"""
+    
+    description = "set an option in setup.cfg or another config file"
+
+    user_options = [
+        ('alias=',  'a',  'the name of the new pseudo-command'),
+        ('command=', 'c', 'command(s) and options to invoke when used'),
+        ('remove',   'r', 'remove (unset) the alias'), 
+    ] + option_base.user_options
+
+    boolean_options = option_base.boolean_options + ['remove']
+
+    def initialize_options(self):
+        option_base.initialize_options(self)
+        self.alias = None
+        self.command = None
+        self.remove = None
+
+    def finalize_options(self):
+        option_base.finalize_options(self)
+        if self.alias is None:
+            raise DistutilsOptionError("Must specify name (--alias/-a)")
+        if self.command is None and not self.remove:
+            raise DistutilsOptionError("Must specify --command or --remove")
+
+    def run(self):
+        edit_config(
+            self.filename, {'aliases': {self.alias:self.command}},
+            self.dry_run
+        )
+

setuptools/command/saveopts.py

@@ -7,21 +7,19 @@ class saveopts(option_base):
 
     description = "save supplied options to setup.cfg or other config file"
 
-    user_options = option_base.user_options + [
-    ]
-
-    boolean_options = option_base.boolean_options + [
-    ]    
-
     def run(self):
         dist = self.distribution
         commands = dist.command_options.keys()
         settings = {}
+
         for cmd in commands:
+
             if cmd=='saveopts':
-                continue
+                continue    # don't save our own options!
+
             for opt,(src,val) in dist.get_option_dict(cmd).items():
                 if src=="command line":
                     settings.setdefault(cmd,{})[opt] = val
+
         edit_config(self.filename, settings, self.dry_run)
 

setuptools/command/sdist.py

@@ -84,6 +84,7 @@ class sdist(_sdist):
     """Smart sdist that finds anything supported by revision control"""
 
     def run(self):
+        self.run_command('egg_info')
         _sdist.run(self)
         dist_files = getattr(self.distribution,'dist_files',[])
         for file in self.archive_files:
@@ -118,6 +119,5 @@ class sdist(_sdist):
 
 
 
-
 
 

setuptools/command/setopt.py

@@ -84,12 +84,12 @@ class option_base(Command):
     """Abstract base class for commands that mess with config files"""
     
     user_options = [
-        ('filename=', 'f',
-                 "set the file to use (default=setup.cfg)"),
         ('global-config', 'g',
                  "save options to the site-wide distutils.cfg file"),
         ('user-config', 'u',
                  "save options to the current user's pydistutils.cfg file"),
+        ('filename=', 'f',
+                 "configuration file to use (default=setup.cfg)"),
     ]
 
     boolean_options = [
@@ -126,12 +126,12 @@ class setopt(option_base):
 
     description = "set an option in setup.cfg or another config file"
 
-    user_options = option_base.user_options + [
+    user_options = [
         ('command=', 'c', 'command to set an option for'),
         ('option=',  'o',  'option to set'),
         ('set-value=',   's', 'value of the option'),
-        ('remove',   'r', 'unset the value'), 
-    ]
+        ('remove',   'r', 'remove (unset) the value'), 
+    ] + option_base.user_options
 
     boolean_options = option_base.boolean_options + ['remove']
 

setuptools/dist.py

@@ -372,10 +372,19 @@ class Distribution(_Distribution):
         self.global_options = self.__class__.global_options
         self.negative_opt = self.__class__.negative_opt
 
-        # Handle commands that want to consume all remaining arguments
+        # First, expand any aliases
         command = args[0]
+        aliases = self.get_option_dict('aliases')
+        while command in aliases:
+            src,alias = aliases[command]
+            del aliases[command]    # ensure each alias can expand only once!
+            import shlex
+            args[:1] = shlex.split(alias,True)            
+            command = args[0]
+
         nargs = _Distribution._parse_command_opts(self, parser, args)
 
+        # Handle commands that want to consume all remaining arguments
         cmd_class = self.get_command_class(command)
         if getattr(cmd_class,'command_consumes_arguments',None):
             self.get_option_dict(command)['args'] = ("command line", nargs)
@@ -384,6 +393,21 @@ class Distribution(_Distribution):
 
         return nargs
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
     def has_dependencies(self):
         return not not self.requires
 
@@ -408,6 +432,23 @@ class Distribution(_Distribution):
         self.have_run['install'] = 1
         setuptools.bootstrap_install_from = None
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
     def get_cmdline_options(self):
         """Return a '{cmd: {opt:val}}' map of all command-line options