Fix bugs affecting exception wrapping in rmtree callback by EliahKagan · Pull Request #1700 · gitpython-developers/GitPython
from abc import abstractmethod import os.path as osp from .compat import is_win import contextlib from functools import wraps import getpass import logging import os import os.path as osp import pathlib import platform import subprocess import re import shutil import stat from sys import maxsize import subprocess import sys import time from urllib.parse import urlsplit, urlunsplit import warnings
# from git.objects.util import Traversable from .compat import is_win
# typing ---------------------------------------------------------
import pathlib
if TYPE_CHECKING: from git.remote import Remote from git.repo.base import Repo from git.config import GitConfigParser, SectionConstraint from git import Git
# from git.objects.base import IndexObject
from .types import ( Literal, SupportsIndex,
# ---------------------------------------------------------------------
from gitdb.util import ( # NOQA @IgnorePep8 make_sha, LockedFD, # @UnusedImport
# NOTE: Some of the unused imports might be used/imported by others. # Handle once test-cases are back up and running. # Most of these are unused here, but are for use by git-python modules so these
log = logging.getLogger(__name__)
# types############################################################
def _read_env_flag(name: str, default: bool) -> bool: try: value = os.environ[name] except KeyError: return default
log.warning( "The %s environment variable is deprecated. Its effect has never been documented and changes without warning.", name, )
adjusted_value = value.strip().lower()
if adjusted_value in {"", "0", "false", "no"}: return False if adjusted_value in {"1", "true", "yes"}: return True log.warning("%s has unrecognized value %r, treating as %r.", name, value, default) return default
#: We need an easy way to see if Appveyor TCs start failing, #: so the errors marked with this var are considered "acknowledged" ones, awaiting remedy, #: till then, we wish to hide them. HIDE_WINDOWS_KNOWN_ERRORS = is_win and os.environ.get("HIDE_WINDOWS_KNOWN_ERRORS", True) HIDE_WINDOWS_FREEZE_ERRORS = is_win and os.environ.get("HIDE_WINDOWS_FREEZE_ERRORS", True) HIDE_WINDOWS_KNOWN_ERRORS = is_win and _read_env_flag("HIDE_WINDOWS_KNOWN_ERRORS", True) HIDE_WINDOWS_FREEZE_ERRORS = is_win and _read_env_flag("HIDE_WINDOWS_FREEZE_ERRORS", True)
# { Utility Methods
def rmtree(path: PathLike) -> None: """Remove the given recursively. """Remove the given directory tree recursively.
:note: we use shutil rmtree but adjust its behaviour to see whether files that couldn't be deleted are read-only. Windows will not remove them in that case""" :note: We use :func:`shutil.rmtree` but adjust its behaviour to see whether files that couldn't be deleted are read-only. Windows will not remove them in that case."""
def onerror(func: Callable, path: PathLike, exc_info: str) -> None: # Is the error an access error ? def handler(function: Callable, path: PathLike, _excinfo: Any) -> None: """Callback for :func:`shutil.rmtree`. Works either as ``onexc`` or ``onerror``.""" # Is the error an access error? os.chmod(path, stat.S_IWUSR)
try: func(path) # Will scream if still not possible to delete. except Exception as ex: function(path) except PermissionError as ex: if HIDE_WINDOWS_KNOWN_ERRORS: from unittest import SkipTest
raise SkipTest("FIXME: fails with: PermissionError\n {}".format(ex)) from ex raise SkipTest(f"FIXME: fails with: PermissionError\n {ex}") from ex raise
return shutil.rmtree(path, False, onerror) if sys.version_info >= (3, 12): shutil.rmtree(path, onexc=handler) else: shutil.rmtree(path, onerror=handler)
def rmfile(path: PathLike) -> None: