Merge pull request #3 from dave-shawley/add-venv-cleanup

Remove virtual environments

Author: dave-shawley

HISTORY

@@ -1,6 +1,10 @@
 Changelog
 =========
 
+* 0.0.3
+
+  - Support removal of virtual environment directories.
+
 * 0.0.2 (17-Nov-2014)
 
   - Support removal of .egg-info and .egg directories.

README.rst

@@ -70,6 +70,11 @@ few new command line parameters.
 ``setup.py clean --egg``
    Removes *.egg* and *.egg-info* directories.
 
+``setup.py clean --environment``
+   Removes the currently active virtual environment as indicated by the
+   ``$VIRTUAL_ENV`` environment variable.  The name of the directory can
+   also be specified using the ``--virtualenv-dir`` command line option.
+
 Where can I get this extension from?
 ------------------------------------
 +---------------+-----------------------------------------------------+

setup.py

@@ -37,7 +37,7 @@
         'Operating System :: OS Independent',
         'Programming Language :: Python',
         'Framework :: Setuptools Plugin',
-        'Development Status :: 1 - Planning',
+        'Development Status :: 3 - Alpha',
     ],
     entry_points={
         'distutils.commands': [

setupext/janitor/__init__.py setupext/janitor.pysetupext/janitor/__init__.py renamed to setupext/janitor.py

@@ -3,7 +3,7 @@
 import os.path
 
 
-version_info = (0, 0, 2)
+version_info = (0, 0, 3)
 __version__ = '.'.join(str(v) for v in version_info)
 
 
@@ -41,6 +41,8 @@ def initialize_options(self):
         self.dist = False
         self.eggs = False
         self.egg_base = None
+        self.environment = False
+        self.virtualenv_dir = None
 
     def finalize_options(self):
         _CleanCommand.finalize_options(self)
@@ -53,6 +55,9 @@ def finalize_options(self):
         if self.egg_base is None:
             self.egg_base = os.curdir
 
+        if self.environment and self.virtualenv_dir is None:
+            self.virtualenv_dir = os.environ.get('VIRTUAL_ENV', None)
+
     def run(self):
         _CleanCommand.run(self)
 
@@ -73,6 +78,9 @@ def run(self):
                 if name.endswith('.egg'):
                     dir_names.add(name)
 
+        if self.environment and self.virtualenv_dir:
+            dir_names.add(self.virtualenv_dir)
+
         for dir_name in dir_names:
             if os.path.exists(dir_name):
                 dir_util.remove_tree(dir_name, dry_run=self.dry_run)
@@ -101,12 +109,16 @@ def _set_options():
     CleanCommand.user_options.extend([
         ('dist', 'd', 'remove distribution directory'),
         ('eggs', None, 'remove egg and egg-info directories'),
+        ('environment', 'E', 'remove virtual environment directory'),
 
         ('egg-base=', 'e',
          'directory containing .egg-info directories '
          '(default: top of the source tree)'),
+        ('virtualenv-dir=', None,
+         'root directory for the virtual directory '
+         '(default: value of VIRTUAL_ENV environment variable)'),
     ])
     CleanCommand.boolean_options = _CleanCommand.boolean_options[:]
-    CleanCommand.boolean_options.extend(['dist', 'eggs'])
+    CleanCommand.boolean_options.extend(['dist', 'eggs', 'environment'])
 
 _set_options()

tests.py

@@ -181,3 +181,38 @@ def test_that_directories_are_not_removed_in_dry_run_mode(self):
             os.rmdir(installed_egg)
             raise
         os.rmdir(installed_egg)
+
+
+class VirtualEnvironmentCleanupTests(DirectoryCleanupMixin, unittest.TestCase):
+    def setUp(self):
+        super(VirtualEnvironmentCleanupTests, self).setUp()
+        self._saved_venv = os.environ.get('VIRTUAL_ENV', None)
+
+    def tearDown(self):
+        super(VirtualEnvironmentCleanupTests, self).tearDown()
+        if self._saved_venv is not None:
+            os.environ['VIRTUAL_ENV'] = self._saved_venv
+        else:
+            os.environ.pop('VIRTUAL_ENV', None)
+
+    def test_that_virtualenv_is_removed_when_dir_is_specified(self):
+        venv_dir = self.create_directory('venv')
+        run_setup(
+            'clean', '--environment', '--virtualenv-dir={0}'.format(venv_dir))
+        self.assert_path_does_not_exist(venv_dir)
+
+    def test_that_virtualenv_is_removed_based_on_envvar(self):
+        venv_dir = self.create_directory('venv')
+        os.environ['VIRTUAL_ENV'] = venv_dir
+        run_setup('clean', '--environment')
+        self.assert_path_does_not_exist(venv_dir)
+
+    def test_that_janitor_does_not_fail_when_envdir_is_missing(self):
+        venv_dir = self.create_directory('venv')
+        os.environ['VIRTUAL_ENV'] = venv_dir
+        os.rmdir(venv_dir)
+        run_setup('clean', '--environment')
+
+    def test_that_janitor_does_not_fail_when_no_dir_specified(self):
+        os.environ.pop('VIRTUAL_ENV', None)
+        run_setup('clean', '--environment')