[Checkins] SVN: zc.buildout/branches/help-api/src/zc/buildout/rmtree.py updated

[Godefroid Chapelle]

Log message for revision 98471:
  updated

Changed:
  A   zc.buildout/branches/help-api/src/zc/buildout/rmtree.py

-=-
Added: zc.buildout/branches/help-api/src/zc/buildout/rmtree.py
===================================================================
--- zc.buildout/branches/help-api/src/zc/buildout/rmtree.py	                        (rev 0)
+++ zc.buildout/branches/help-api/src/zc/buildout/rmtree.py	2009-03-29 21:17:30 UTC (rev 98471)
@@ -0,0 +1,72 @@
+##############################################################################
+#
+# Copyright (c) 2006 Zope Corporation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+
+
+import shutil
+import os
+import doctest
+
+def rmtree (path):
+    """
+    A variant of shutil.rmtree which tries hard to be successful
+    On windows shutil.rmtree aborts when it tries to delete a
+    read only file.
+    This tries to chmod the file to writeable and retries before giving up.
+
+    >>> import shutil
+    >>> from tempfile import mkdtemp
+
+    Let's make a directory ...
+    >>> d = mkdtemp()
+
+    and make sure it is actually there
+    >>> os.path.isdir (d)
+    1
+
+    Now create a file ...
+    >>> foo = os.path.join (d, 'foo')
+    >>> open (foo, 'w').write ('huhu')
+
+    and make it unwriteable
+    >>> os.chmod (foo, 0400)
+
+    now let's see how shutil.rmtree behaves
+
+    >>> shutil.rmtree (d) # doctest: +ELLIPSIS
+    Traceback (most recent call last):
+    ...
+    OSError: [Errno 13] Permission denied: '...foo'
+
+    the directory is still there!
+    >>> os.path.isdir (d)
+    1
+
+    the new function should be able to solve this for us
+    >>> rmtree (d)
+
+    and now the directory is gone
+    >>> os.path.isdir (d)
+    0
+    """
+    def retry_writeable (func, path, exc):
+        os.chmod (path, 0600)
+        func (path)
+
+    shutil.rmtree (path, onerror = retry_writeable)
+
+def test_suite():
+    return doctest.DocTestSuite()
+
+if "__main__" == __name__:
+    doctest.testmod()