Skip to content

Instantly share code, notes, and snippets.

@eestrada
Created February 12, 2021 23:38
Show Gist options
  • Save eestrada/41cb376db2ba19b1472253569590b774 to your computer and use it in GitHub Desktop.
Save eestrada/41cb376db2ba19b1472253569590b774 to your computer and use it in GitHub Desktop.
Safely clean up a newly created directory when an exception is raised.
# This is free and unencumbered software released into the public domain.
#
# Anyone is free to copy, modify, publish, use, compile, sell, or
# distribute this software, either in source code form or as a compiled
# binary, for any purpose, commercial or non-commercial, and by any
# means.
#
# In jurisdictions that recognize copyright laws, the author or authors
# of this software dedicate any and all copyright interest in the
# software to the public domain. We make this dedication for the benefit
# of the public at large and to the detriment of our heirs and
# successors. We intend this dedication to be an overt act of
# relinquishment in perpetuity of all present and future rights to this
# software under copyright law.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
#
# For more information, please refer to <http://unlicense.org/>
import shutil
import pathlib
class SafeMkdir(object):
"""SafeMkdir is a context manager that makes it safe to create new directories
If any exception is raised within the body of the context, the directory is
removed via `shutil.rmtree`. The kwargs for both `pathlib.Path.mkdir` and
`shutil.rmtree` (since there is no overlap in options) may be passed to the
constructor to control the behavior of both invocations.
with SafeMkdir('~/some_new_dir/') as home_dir:
print(home_dir)
print(home_dir.exists()) # True
raise Exception
# home_dir has been removed from disk at this point
"""
def __init__(self, *pathsegments, **kwargs):
super(SafeMkdir, self).__init__()
self._mkdir_kwargs = {key: kwargs[key] for key in kwargs.keys() & ('mode', 'parents', 'exist_ok')}
self._rmtree_kwargs = {key: kwargs[key] for key in kwargs.keys() & ('ignore_errors', 'onerror')}
self.path = pathlib.Path(*pathsegments)
self.path.mkdir(**self._mkdir_kwargs)
def __enter__(self):
return self.path
def __exit__(self, *exc_info):
if any(exc_info):
shutil.rmtree(str(self.path), **self._rmtree_kwargs)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment