diff --git a/news/12187.bugfix.rst b/news/12187.bugfix.rst new file mode 100644 index 00000000000..b4d106b974f --- /dev/null +++ b/news/12187.bugfix.rst @@ -0,0 +1 @@ +Fix improper handling of the new onexc argument of ``shutil.rmtree()`` in Python 3.12. diff --git a/src/pip/_internal/utils/misc.py b/src/pip/_internal/utils/misc.py index b7b32f0f8cf..9a6353fc8d3 100644 --- a/src/pip/_internal/utils/misc.py +++ b/src/pip/_internal/utils/misc.py @@ -14,7 +14,8 @@ from functools import partial from io import StringIO from itertools import filterfalse, tee, zip_longest -from types import TracebackType +from pathlib import Path +from types import FunctionType, TracebackType from typing import ( Any, BinaryIO, @@ -67,6 +68,8 @@ ExcInfo = Tuple[Type[BaseException], BaseException, TracebackType] VersionInfo = Tuple[int, int, int] NetlocTuple = Tuple[str, Tuple[Optional[str], Optional[str]]] +OnExc = Callable[[FunctionType, Path, BaseException], Any] +OnErr = Callable[[FunctionType, Path, ExcInfo], Any] def get_pip_version() -> str: @@ -127,16 +130,23 @@ def get_prog() -> str: def rmtree( dir: str, ignore_errors: bool = False, - onexc: Optional[Callable[[Any, Any, Any], Any]] = None, + onexc: Optional[OnExc] = None, ) -> None: if ignore_errors: onexc = _onerror_ignore - elif onexc is None: + if onexc is None: onexc = _onerror_reraise + handler: OnErr = partial( + # `[func, path, Union[ExcInfo, BaseException]] -> Any` is equivalent to + # `Union[([func, path, ExcInfo] -> Any), ([func, path, BaseException] -> Any)]`. + cast(Union[OnExc, OnErr], rmtree_errorhandler), + onexc=onexc, + ) if sys.version_info >= (3, 12): - shutil.rmtree(dir, onexc=partial(rmtree_errorhandler, onexc=onexc)) + # See https://docs.python.org/3.12/whatsnew/3.12.html#shutil. + shutil.rmtree(dir, onexc=handler) else: - shutil.rmtree(dir, onerror=partial(rmtree_errorhandler, onexc=onexc)) + shutil.rmtree(dir, onerror=handler) def _onerror_ignore(*_args: Any) -> None: @@ -148,11 +158,11 @@ def _onerror_reraise(*_args: Any) -> None: def rmtree_errorhandler( - func: Callable[..., Any], - path: str, + func: FunctionType, + path: Path, exc_info: Union[ExcInfo, BaseException], *, - onexc: Callable[..., Any] = _onerror_reraise, + onexc: OnExc = _onerror_reraise, ) -> None: """ `rmtree` error handler to 'force' a file remove (i.e. like `rm -f`). @@ -183,6 +193,8 @@ def rmtree_errorhandler( except OSError: pass + if not isinstance(exc_info, BaseException): + _, exc_info, _ = exc_info onexc(func, path, exc_info) diff --git a/src/pip/_internal/utils/temp_dir.py b/src/pip/_internal/utils/temp_dir.py index 99d1ba834ef..38c5f7c7c94 100644 --- a/src/pip/_internal/utils/temp_dir.py +++ b/src/pip/_internal/utils/temp_dir.py @@ -5,15 +5,14 @@ import tempfile import traceback from contextlib import ExitStack, contextmanager +from pathlib import Path +from types import FunctionType from typing import ( Any, - Callable, Dict, Generator, List, Optional, - Tuple, - Type, TypeVar, Union, ) @@ -188,22 +187,24 @@ def cleanup(self) -> None: errors: List[BaseException] = [] def onerror( - func: Callable[[str], Any], - path: str, - exc_info: Tuple[Type[BaseException], BaseException, Any], + func: FunctionType, + path: Path, + exc_val: BaseException, ) -> None: """Log a warning for a `rmtree` error and continue""" - exc_val = "\n".join(traceback.format_exception_only(*exc_info[:2])) - exc_val = exc_val.rstrip() # remove trailing new line + formatted_exc = "\n".join( + traceback.format_exception_only(type(exc_val), exc_val) + ) + formatted_exc = formatted_exc.rstrip() # remove trailing new line if func in (os.unlink, os.remove, os.rmdir): logger.debug( "Failed to remove a temporary file '%s' due to %s.\n", path, - exc_val, + formatted_exc, ) else: - logger.debug("%s failed with %s.", func.__qualname__, exc_val) - errors.append(exc_info[1]) + logger.debug("%s failed with %s.", func.__qualname__, formatted_exc) + errors.append(exc_val) if self.ignore_cleanup_errors: try: