Add support for cleaning up after sdist.

Author: dave-shawley

README.rst

@@ -25,8 +25,50 @@ keeping targets such as *clean*, *dist-clean*, and *maintainer-clean*.
 This extension is inspired by the same desire for a clean working
 environment.
 
-Ok... Where?
-------------
+Installation
+~~~~~~~~~~~~
+The ``setuptools`` package contains a number of interesting ways in which
+it can be extended.  If you develop Python packages, then you can include
+extension packages using the ``setup_requires`` and ``cmdclass`` keyword
+parameters to the ``setup`` function call.  This is a little more
+difficult than it should be since the ``setupext`` package needs to be
+imported into *setup.py* so that it can be passed as a keyword parameter
+**before** it is downloaded.  The easiest way to do this is to catch the
+``ImportError`` that happens if it is not already downloaded::
+
+   import setuptools
+   try:
+      from setupext import janitor
+      CleanCommand = janitor.CleanCommand
+   except ImportError:
+      CleanCommand = None
+
+   cmd_classes = {}
+   if CleanCommand is not None:
+      cmd_classes['clean'] = CleanCommand
+
+   setup(
+      # normal parameters
+      setup_requires=['setupext.janitor'],
+      cmdclass=cmd_classes,
+   )
+
+You can use a different approach if you are simply a developer that wants
+to have this functionality available for your own use, then you can install
+it into your working environment.  This package installs itself into the
+environment as a `distutils extension`_ so that it is available to any
+*setup.py* script as if by magic.
+
+Usage
+~~~~~
+Once the extension is installed, the ``clean`` command will accept a
+few new command line parameters.
+
+``setup.py clean --dist``
+   Removes directories that the various *dist* commands produce.
+
+Where can I get this extension from?
+------------------------------------
 +---------------+-----------------------------------------------------+
 | Source        | https://github.com/dave-shawley/setupext-janitor    |
 +---------------+-----------------------------------------------------+
@@ -39,7 +81,10 @@ Ok... Where?
 | Issues        | https://github.com/dave-shawley/setupext-janitor    |
 +---------------+-----------------------------------------------------+
 
+.. _distutils extension: https://pythonhosted.org/setuptools/setuptools.html
+   #extending-and-reusing-setuptools
 .. _setuptools: https://pythonhosted.org/setuptools/
+
 .. |Version| image:: https://badge.fury.io/py/setupext-janitor.svg
    :target: https://badge.fury.io/
 .. |Downloads| image:: https://pypip.in/d/setupext-janitor/badge.svg?
@@ -48,4 +93,3 @@ Ok... Where?
    :target: https://travis-ci.org/dave-shawley/setupext-janitor
 .. |License| image:: https://pypip.in/license/dave-shawley/badge.svg?
    :target: https://setupext-dave-shawley.readthedocs.org/
-

setup.py

@@ -41,6 +41,7 @@
     ],
     entry_points={
         'distutils.commands': [
+            'clean = setupext.janitor:CleanCommand',
         ],
     },
 )

setupext/janitor/__init__.py

@@ -1,4 +1,6 @@
+from distutils import log
 from distutils.command.clean import clean as _CleanCommand
+import shutil
 
 
 version_info = (0, 0, 0)
@@ -33,7 +35,28 @@ class CleanCommand(_CleanCommand):
     """
 
     # See _set_options for `user_options`
-    pass
+
+    def __init__(self, *args, **kwargs):
+        _CleanCommand.__init__(self, *args, **kwargs)
+        self.dist = None
+
+    def initialize_options(self):
+        _CleanCommand.initialize_options(self)
+        self.dist = False
+
+    def run(self):
+        _CleanCommand.run(self)
+        dist_dirs = set()
+        for cmd_name in self.distribution.commands:
+            if cmd_name == 'sdist':
+                command = self.distribution.get_command_obj(cmd_name)
+                command.ensure_finalized()
+                if getattr(command, 'dist_dir', None):
+                    dist_dirs.add(command.dist_dir)
+
+        for dir_name in dist_dirs:
+            self.announce('removing {0}'.format(dir_name), level=log.DEBUG)
+            shutil.rmtree(dir_name, ignore_errors=True)
 
 
 def _set_options():
@@ -56,5 +79,7 @@ def _set_options():
     CleanCommand.user_options.extend([
         ('dist', 'd', 'remove distribution directory'),
     ])
+    CleanCommand.boolean_options = _CleanCommand.boolean_options[:]
+    CleanCommand.boolean_options.append('dist')
 
 _set_options()

tests.py

@@ -1,14 +1,59 @@
+from distutils import core, dist
 from distutils.command import clean
+import atexit
+import os.path
+import shutil
 import sys
+import tempfile
 
 if sys.version_info >= (2, 7):
     import unittest
-else:
+else:  # noinspection PyPackageRequirements,PyUnresolvedReferences
     import unittest2 as unittest
 
 from setupext import janitor
 
 
+def run_setup(*command_line):
+    """
+    Run the setup command with `command_line`.
+
+    :param command_line: the command line arguments to pass
+        as the simulated command line
+
+    This function runs :func:`distutils.core.setup` after it
+    configures an environment that mimics passing the specified
+    command line arguments.  The ``distutils`` internals are
+    replaced with a :class:`~distutils.dist.Distribution`
+    instance that will only execute the clean command.  Other
+    commands can be passed freely to simulate command line usage
+    patterns.
+
+    """
+    class FakeDistribution(dist.Distribution):
+
+        def __init__(self, *args, **kwargs):
+            """Enable verbose output to make tests easier to debug."""
+            dist.Distribution.__init__(self, *args, **kwargs)
+            self.verbose = 3
+
+        def run_command(self, command):
+            """Only run the clean command."""
+            if command == 'clean':
+                dist.Distribution.run_command(self, command)
+
+        def parse_config_files(self, filenames=None):
+            """Skip processing of configuration files."""
+            pass
+
+    core.setup(
+        distclass=FakeDistribution,
+        script_name='testsetup.py',
+        script_args=command_line,
+        cmdclass={'clean': janitor.CleanCommand},
+    )
+
+
 class CommandOptionTests(unittest.TestCase):
 
     def test_that_distutils_options_are_present(self):
@@ -24,3 +69,30 @@ def test_that_janitor_defines_dist_command(self):
         self.assertIn(
             ('dist', 'd', 'remove distribution directory'),
             janitor.CleanCommand.user_options)
+
+
+class DirectoryCleanupTests(unittest.TestCase):
+    temp_dir = tempfile.mkdtemp()
+
+    @classmethod
+    def setUpClass(cls):
+        super(DirectoryCleanupTests, cls).setUpClass()
+        atexit.register(shutil.rmtree, cls.temp_dir)
+
+    @classmethod
+    def create_directory(cls, dir_name):
+        full_path = os.path.join(cls.temp_dir, dir_name)
+        os.mkdir(full_path)
+        return full_path
+
+    def assert_path_does_not_exist(self, full_path):
+        if os.path.exists(full_path):
+            raise AssertionError('{0} should not exist'.format(full_path))
+
+    def test_that_dist_directory_is_removed_for_sdist(self):
+        dist_dir = self.create_directory('dist-dir')
+        run_setup(
+            'sdist', '--dist-dir={0}'.format(dist_dir),
+            'clean', '--dist',
+        )
+        self.assert_path_does_not_exist(dist_dir)