-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reconstruct tempfile logic in own class
- Loading branch information
Showing
3 changed files
with
189 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| import os | ||
| import platform | ||
| import shutil | ||
| import stat | ||
| import sys | ||
| import tempfile | ||
| import time | ||
| import warnings | ||
| from pathlib import Path | ||
| from threading import Thread | ||
|
|
||
|
|
||
| class TempDirWarning(UserWarning): | ||
| pass | ||
|
|
||
|
|
||
| # Python's built-in temporary directory functions are lacking | ||
| # In short, they don't handle removal well, and there's lots of API changes over recent versions. | ||
| # Here we have our own class to deal with it. | ||
| class TempDirectory: | ||
| def __init__(self, path=None, sneak=False): | ||
| self._with_onexc = bool(sys.version_info[:3] >= (3, 12)) | ||
| args = {} | ||
|
|
||
| if path: | ||
| args = dict(dir=path) | ||
| elif sneak: | ||
| args = dict(prefix=".choreographer-", dir=Path.home()) | ||
|
|
||
| if platform.system() != "Windows": | ||
| self.temp_dir = tempfile.TemporaryDirectory(**args) | ||
| else: # is windows | ||
| vinfo = sys.version_info[:3] | ||
| if vinfo >= (3, 12): | ||
| self.temp_dir = tempfile.TemporaryDirectory( | ||
| delete=False, | ||
| ignore_cleanup_errors=True, | ||
| **args, | ||
| ) | ||
| elif vinfo >= (3, 10): | ||
| self.temp_dir = tempfile.TemporaryDirectory( | ||
| ignore_cleanup_errors=True, | ||
| **args, | ||
| ) | ||
| else: | ||
| self.temp_dir = tempfile.TemporaryDirectory(**args) | ||
|
|
||
| self.path = self.temp_dir.name | ||
| self.exists = True | ||
| if self.debug: | ||
| print(f"TEMP DIR NAME: {self._temp_dir_name}", file=sys.stderr) | ||
|
|
||
| def delete_manually(self, check_only=False): | ||
| if not os.path.exists(self.path): | ||
| self.exists = False | ||
| if self.debug: | ||
| print( | ||
| "No retry delete manual necessary, path doesn't exist", | ||
| file=sys.stderr, | ||
| ) | ||
| return 0, 0, [] | ||
| n_dirs = 0 | ||
| n_files = 0 | ||
| errors = [] | ||
| for root, dirs, files in os.walk(self.path, topdown=False): | ||
| n_dirs += len(dirs) | ||
| n_files += len(files) | ||
| if not check_only: | ||
| for f in files: | ||
| fp = os.path.join(root, f) | ||
| if self.debug: | ||
| print(f"Removing file: {fp}", file=sys.stderr) | ||
| try: | ||
| os.chmod(fp, stat.S_IWUSR) | ||
| os.remove(fp) | ||
| if self.debug: | ||
| print("Success", file=sys.stderr) | ||
| except BaseException as e: | ||
| errors.append((fp, e)) | ||
| for d in dirs: | ||
| fp = os.path.join(root, d) | ||
| if self.debug: | ||
| print(f"Removing dir: {fp}", file=sys.stderr) | ||
| try: | ||
| os.chmod(fp, stat.S_IWUSR) | ||
| os.rmdir(fp) | ||
| if self.debug: | ||
| print("Success", file=sys.stderr) | ||
| except BaseException as e: | ||
| errors.append((fp, e)) | ||
|
|
||
| # clean up directory | ||
| if not check_only: | ||
| try: | ||
| os.chmod(self.path, stat.S_IWUSR) | ||
| os.rmdir(self.path) | ||
| except BaseException as e: | ||
| errors.append((self.path, e)) | ||
|
|
||
| if check_only: | ||
| if n_dirs or n_files: | ||
| self.exists = True | ||
| else: | ||
| self.exists = False | ||
| elif errors: | ||
| warnings.warn( | ||
| f"The temporary directory could not be deleted, execution will continue. errors: {errors}", | ||
| TempDirWarning, | ||
| ) | ||
| self.exists = True | ||
| else: | ||
| self.exists = False | ||
|
|
||
| return n_dirs, n_files, errors | ||
|
|
||
| def clean(self): | ||
| try: | ||
| # no faith in this python implementation, always fails with windows | ||
| # very unstable recently as well, lots new arguments in tempfile package | ||
| self.temp_dir.cleanup() | ||
| self.exists = False | ||
| return | ||
| except BaseException as e: | ||
| if self.debug: | ||
| print( | ||
| f"First tempdir deletion failed: TempDirWarning: {str(e)}", | ||
| file=sys.stderr, | ||
| ) | ||
|
|
||
| def remove_readonly(func, path, excinfo): | ||
| try: | ||
| os.chmod(path, stat.S_IWUSR) | ||
| func(path) | ||
| except FileNotFoundError: | ||
| pass | ||
|
|
||
| try: | ||
| if self._with_onexc: | ||
| shutil.rmtree(self.path, onexc=remove_readonly) | ||
| else: | ||
| shutil.rmtree(self.path, onerror=remove_readonly) | ||
| self.exists = False | ||
| del self.temp_dir | ||
| return | ||
| except FileNotFoundError: | ||
| pass # it worked! | ||
| except BaseException as e: | ||
| if self.debug: | ||
| print( | ||
| f"Second tmpdir deletion failed (shutil.rmtree): {str(e)}", | ||
| file=sys.stderr, | ||
| ) | ||
| self.delete_manually(check_only=True) | ||
| if not self.exists: | ||
| return | ||
|
|
||
| def extra_clean(): | ||
| time.sleep(3) | ||
| self.delete_manually() | ||
|
|
||
| t = Thread(target=extra_clean) | ||
| t.run() | ||
| if self.debug: | ||
| print( | ||
| f"Tempfile still exists?: {bool(os.path.exists(str(self.path)))}", | ||
| file=sys.stderr, | ||
| ) |