Загрузить файлы в «venv/Lib/site-packages/pip/_internal/utils»
This commit is contained in:
396
venv/Lib/site-packages/pip/_internal/utils/logging.py
Normal file
396
venv/Lib/site-packages/pip/_internal/utils/logging.py
Normal file
@@ -0,0 +1,396 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import contextlib
|
||||||
|
import errno
|
||||||
|
import logging
|
||||||
|
import logging.handlers
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
import threading
|
||||||
|
from collections.abc import Generator
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from io import StringIO, TextIOWrapper
|
||||||
|
from logging import Filter
|
||||||
|
from typing import Any, ClassVar
|
||||||
|
|
||||||
|
from pip._vendor.rich.console import (
|
||||||
|
Console,
|
||||||
|
ConsoleOptions,
|
||||||
|
ConsoleRenderable,
|
||||||
|
RenderableType,
|
||||||
|
RenderResult,
|
||||||
|
RichCast,
|
||||||
|
)
|
||||||
|
from pip._vendor.rich.highlighter import NullHighlighter
|
||||||
|
from pip._vendor.rich.logging import RichHandler
|
||||||
|
from pip._vendor.rich.segment import Segment
|
||||||
|
from pip._vendor.rich.style import Style
|
||||||
|
|
||||||
|
from pip._internal.utils._log import VERBOSE, getLogger
|
||||||
|
from pip._internal.utils.compat import WINDOWS
|
||||||
|
from pip._internal.utils.deprecation import DEPRECATION_MSG_PREFIX
|
||||||
|
from pip._internal.utils.misc import StreamWrapper, ensure_dir
|
||||||
|
|
||||||
|
_log_state = threading.local()
|
||||||
|
_stdout_console = None
|
||||||
|
_stderr_console = None
|
||||||
|
subprocess_logger = getLogger("pip.subprocessor")
|
||||||
|
|
||||||
|
|
||||||
|
class BrokenStdoutLoggingError(Exception):
|
||||||
|
"""
|
||||||
|
Raised if BrokenPipeError occurs for the stdout stream while logging.
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
def _is_broken_pipe_error(exc_class: type[BaseException], exc: BaseException) -> bool:
|
||||||
|
if exc_class is BrokenPipeError:
|
||||||
|
return True
|
||||||
|
|
||||||
|
# On Windows, a broken pipe can show up as EINVAL rather than EPIPE:
|
||||||
|
# https://bugs.python.org/issue19612
|
||||||
|
# https://bugs.python.org/issue30418
|
||||||
|
if not WINDOWS:
|
||||||
|
return False
|
||||||
|
|
||||||
|
return isinstance(exc, OSError) and exc.errno in (errno.EINVAL, errno.EPIPE)
|
||||||
|
|
||||||
|
|
||||||
|
@contextlib.contextmanager
|
||||||
|
def capture_logging() -> Generator[StringIO, None, None]:
|
||||||
|
"""Capture all pip logs in a buffer temporarily."""
|
||||||
|
# Patching sys.std(out|err) directly is not viable as the caller
|
||||||
|
# may want to emit non-logging output (e.g. a rich spinner). To
|
||||||
|
# avoid capturing that, temporarily patch the root logging handlers
|
||||||
|
# to use new rich consoles that write to a StringIO.
|
||||||
|
handlers = {}
|
||||||
|
for handler in logging.getLogger().handlers:
|
||||||
|
if isinstance(handler, RichPipStreamHandler):
|
||||||
|
# Also store the handler's original console so it can be
|
||||||
|
# restored on context exit.
|
||||||
|
handlers[handler] = handler.console
|
||||||
|
|
||||||
|
fake_stream = StreamWrapper.from_stream(sys.stdout)
|
||||||
|
if not handlers:
|
||||||
|
yield fake_stream
|
||||||
|
return
|
||||||
|
|
||||||
|
# HACK: grab no_color attribute from a random handler console since
|
||||||
|
# it's a global option anyway.
|
||||||
|
no_color = next(iter(handlers.values())).no_color
|
||||||
|
fake_console = PipConsole(file=fake_stream, no_color=no_color, soft_wrap=True)
|
||||||
|
try:
|
||||||
|
for handler in handlers:
|
||||||
|
handler.console = fake_console
|
||||||
|
yield fake_stream
|
||||||
|
finally:
|
||||||
|
for handler, original_console in handlers.items():
|
||||||
|
handler.console = original_console
|
||||||
|
|
||||||
|
|
||||||
|
@contextlib.contextmanager
|
||||||
|
def indent_log(num: int = 2) -> Generator[None, None, None]:
|
||||||
|
"""
|
||||||
|
A context manager which will cause the log output to be indented for any
|
||||||
|
log messages emitted inside it.
|
||||||
|
"""
|
||||||
|
# For thread-safety
|
||||||
|
_log_state.indentation = get_indentation()
|
||||||
|
_log_state.indentation += num
|
||||||
|
try:
|
||||||
|
yield
|
||||||
|
finally:
|
||||||
|
_log_state.indentation -= num
|
||||||
|
|
||||||
|
|
||||||
|
def get_indentation() -> int:
|
||||||
|
return getattr(_log_state, "indentation", 0)
|
||||||
|
|
||||||
|
|
||||||
|
class IndentingFormatter(logging.Formatter):
|
||||||
|
default_time_format = "%Y-%m-%dT%H:%M:%S"
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
*args: Any,
|
||||||
|
add_timestamp: bool = False,
|
||||||
|
**kwargs: Any,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
A logging.Formatter that obeys the indent_log() context manager.
|
||||||
|
|
||||||
|
:param add_timestamp: A bool indicating output lines should be prefixed
|
||||||
|
with their record's timestamp.
|
||||||
|
"""
|
||||||
|
self.add_timestamp = add_timestamp
|
||||||
|
super().__init__(*args, **kwargs)
|
||||||
|
|
||||||
|
def get_message_start(self, formatted: str, levelno: int) -> str:
|
||||||
|
"""
|
||||||
|
Return the start of the formatted log message (not counting the
|
||||||
|
prefix to add to each line).
|
||||||
|
"""
|
||||||
|
if levelno < logging.WARNING:
|
||||||
|
return ""
|
||||||
|
if formatted.startswith(DEPRECATION_MSG_PREFIX):
|
||||||
|
# Then the message already has a prefix. We don't want it to
|
||||||
|
# look like "WARNING: DEPRECATION: ...."
|
||||||
|
return ""
|
||||||
|
if levelno < logging.ERROR:
|
||||||
|
return "WARNING: "
|
||||||
|
|
||||||
|
return "ERROR: "
|
||||||
|
|
||||||
|
def format(self, record: logging.LogRecord) -> str:
|
||||||
|
"""
|
||||||
|
Calls the standard formatter, but will indent all of the log message
|
||||||
|
lines by our current indentation level.
|
||||||
|
"""
|
||||||
|
formatted = super().format(record)
|
||||||
|
message_start = self.get_message_start(formatted, record.levelno)
|
||||||
|
formatted = message_start + formatted
|
||||||
|
|
||||||
|
prefix = ""
|
||||||
|
if self.add_timestamp:
|
||||||
|
prefix = f"{self.formatTime(record)} "
|
||||||
|
prefix += " " * get_indentation()
|
||||||
|
formatted = "".join([prefix + line for line in formatted.splitlines(True)])
|
||||||
|
return formatted
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class IndentedRenderable:
|
||||||
|
renderable: RenderableType
|
||||||
|
indent: int
|
||||||
|
|
||||||
|
def __rich_console__(
|
||||||
|
self, console: Console, options: ConsoleOptions
|
||||||
|
) -> RenderResult:
|
||||||
|
segments = console.render(self.renderable, options)
|
||||||
|
lines = Segment.split_lines(segments)
|
||||||
|
for line in lines:
|
||||||
|
yield Segment(" " * self.indent)
|
||||||
|
yield from line
|
||||||
|
yield Segment("\n")
|
||||||
|
|
||||||
|
|
||||||
|
class PipConsole(Console):
|
||||||
|
def on_broken_pipe(self) -> None:
|
||||||
|
# Reraise the original exception, rich 13.8.0+ exits by default
|
||||||
|
# instead, preventing our handler from firing.
|
||||||
|
raise BrokenPipeError() from None
|
||||||
|
|
||||||
|
|
||||||
|
def get_console(*, stderr: bool = False) -> Console:
|
||||||
|
if stderr:
|
||||||
|
assert _stderr_console is not None, "stderr rich console is missing!"
|
||||||
|
return _stderr_console
|
||||||
|
else:
|
||||||
|
assert _stdout_console is not None, "stdout rich console is missing!"
|
||||||
|
return _stdout_console
|
||||||
|
|
||||||
|
|
||||||
|
class RichPipStreamHandler(RichHandler):
|
||||||
|
KEYWORDS: ClassVar[list[str] | None] = []
|
||||||
|
|
||||||
|
def __init__(self, console: Console) -> None:
|
||||||
|
super().__init__(
|
||||||
|
console=console,
|
||||||
|
show_time=False,
|
||||||
|
show_level=False,
|
||||||
|
show_path=False,
|
||||||
|
highlighter=NullHighlighter(),
|
||||||
|
)
|
||||||
|
|
||||||
|
# Our custom override on Rich's logger, to make things work as we need them to.
|
||||||
|
def emit(self, record: logging.LogRecord) -> None:
|
||||||
|
style: Style | None = None
|
||||||
|
|
||||||
|
# If we are given a diagnostic error to present, present it with indentation.
|
||||||
|
if getattr(record, "rich", False):
|
||||||
|
assert isinstance(record.args, tuple)
|
||||||
|
(rich_renderable,) = record.args
|
||||||
|
assert isinstance(
|
||||||
|
rich_renderable, (ConsoleRenderable, RichCast, str)
|
||||||
|
), f"{rich_renderable} is not rich-console-renderable"
|
||||||
|
|
||||||
|
renderable: RenderableType = IndentedRenderable(
|
||||||
|
rich_renderable, indent=get_indentation()
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
message = self.format(record)
|
||||||
|
renderable = self.render_message(record, message)
|
||||||
|
if record.levelno is not None:
|
||||||
|
if record.levelno >= logging.ERROR:
|
||||||
|
style = Style(color="red")
|
||||||
|
elif record.levelno >= logging.WARNING:
|
||||||
|
style = Style(color="yellow")
|
||||||
|
|
||||||
|
try:
|
||||||
|
self.console.print(renderable, overflow="ignore", crop=False, style=style)
|
||||||
|
except Exception:
|
||||||
|
self.handleError(record)
|
||||||
|
|
||||||
|
def handleError(self, record: logging.LogRecord) -> None:
|
||||||
|
"""Called when logging is unable to log some output."""
|
||||||
|
|
||||||
|
exc_class, exc = sys.exc_info()[:2]
|
||||||
|
# If a broken pipe occurred while calling write() or flush() on the
|
||||||
|
# stdout stream in logging's Handler.emit(), then raise our special
|
||||||
|
# exception so we can handle it in main() instead of logging the
|
||||||
|
# broken pipe error and continuing.
|
||||||
|
if (
|
||||||
|
exc_class
|
||||||
|
and exc
|
||||||
|
and self.console.file is sys.stdout
|
||||||
|
and _is_broken_pipe_error(exc_class, exc)
|
||||||
|
):
|
||||||
|
raise BrokenStdoutLoggingError()
|
||||||
|
|
||||||
|
return super().handleError(record)
|
||||||
|
|
||||||
|
|
||||||
|
class BetterRotatingFileHandler(logging.handlers.RotatingFileHandler):
|
||||||
|
def _open(self) -> TextIOWrapper:
|
||||||
|
ensure_dir(os.path.dirname(self.baseFilename))
|
||||||
|
return super()._open()
|
||||||
|
|
||||||
|
|
||||||
|
class MaxLevelFilter(Filter):
|
||||||
|
def __init__(self, level: int) -> None:
|
||||||
|
self.level = level
|
||||||
|
|
||||||
|
def filter(self, record: logging.LogRecord) -> bool:
|
||||||
|
return record.levelno < self.level
|
||||||
|
|
||||||
|
|
||||||
|
class ExcludeLoggerFilter(Filter):
|
||||||
|
"""
|
||||||
|
A logging Filter that excludes records from a logger (or its children).
|
||||||
|
"""
|
||||||
|
|
||||||
|
def filter(self, record: logging.LogRecord) -> bool:
|
||||||
|
# The base Filter class allows only records from a logger (or its
|
||||||
|
# children).
|
||||||
|
return not super().filter(record)
|
||||||
|
|
||||||
|
|
||||||
|
def setup_logging(verbosity: int, no_color: bool, user_log_file: str | None) -> int:
|
||||||
|
"""Configures and sets up all of the logging
|
||||||
|
|
||||||
|
Returns the requested logging level, as its integer value.
|
||||||
|
"""
|
||||||
|
|
||||||
|
# Determine the level to be logging at.
|
||||||
|
if verbosity >= 2:
|
||||||
|
level_number = logging.DEBUG
|
||||||
|
elif verbosity == 1:
|
||||||
|
level_number = VERBOSE
|
||||||
|
elif verbosity == -1:
|
||||||
|
level_number = logging.WARNING
|
||||||
|
elif verbosity == -2:
|
||||||
|
level_number = logging.ERROR
|
||||||
|
elif verbosity <= -3:
|
||||||
|
level_number = logging.CRITICAL
|
||||||
|
else:
|
||||||
|
level_number = logging.INFO
|
||||||
|
|
||||||
|
level = logging.getLevelName(level_number)
|
||||||
|
|
||||||
|
# The "root" logger should match the "console" level *unless* we also need
|
||||||
|
# to log to a user log file.
|
||||||
|
include_user_log = user_log_file is not None
|
||||||
|
if include_user_log:
|
||||||
|
additional_log_file = user_log_file
|
||||||
|
root_level = "DEBUG"
|
||||||
|
else:
|
||||||
|
additional_log_file = "/dev/null"
|
||||||
|
root_level = level
|
||||||
|
|
||||||
|
# Disable any logging besides WARNING unless we have DEBUG level logging
|
||||||
|
# enabled for vendored libraries.
|
||||||
|
vendored_log_level = "WARNING" if level in ["INFO", "ERROR"] else "DEBUG"
|
||||||
|
|
||||||
|
# Shorthands for clarity
|
||||||
|
handler_classes = {
|
||||||
|
"stream": "pip._internal.utils.logging.RichPipStreamHandler",
|
||||||
|
"file": "pip._internal.utils.logging.BetterRotatingFileHandler",
|
||||||
|
}
|
||||||
|
handlers = ["console", "console_errors", "console_subprocess"] + (
|
||||||
|
["user_log"] if include_user_log else []
|
||||||
|
)
|
||||||
|
global _stdout_console, stderr_console
|
||||||
|
_stdout_console = PipConsole(file=sys.stdout, no_color=no_color, soft_wrap=True)
|
||||||
|
_stderr_console = PipConsole(file=sys.stderr, no_color=no_color, soft_wrap=True)
|
||||||
|
|
||||||
|
logging.config.dictConfig(
|
||||||
|
{
|
||||||
|
"version": 1,
|
||||||
|
"disable_existing_loggers": False,
|
||||||
|
"filters": {
|
||||||
|
"exclude_warnings": {
|
||||||
|
"()": "pip._internal.utils.logging.MaxLevelFilter",
|
||||||
|
"level": logging.WARNING,
|
||||||
|
},
|
||||||
|
"restrict_to_subprocess": {
|
||||||
|
"()": "logging.Filter",
|
||||||
|
"name": subprocess_logger.name,
|
||||||
|
},
|
||||||
|
"exclude_subprocess": {
|
||||||
|
"()": "pip._internal.utils.logging.ExcludeLoggerFilter",
|
||||||
|
"name": subprocess_logger.name,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"formatters": {
|
||||||
|
"indent": {
|
||||||
|
"()": IndentingFormatter,
|
||||||
|
"format": "%(message)s",
|
||||||
|
},
|
||||||
|
"indent_with_timestamp": {
|
||||||
|
"()": IndentingFormatter,
|
||||||
|
"format": "%(message)s",
|
||||||
|
"add_timestamp": True,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"handlers": {
|
||||||
|
"console": {
|
||||||
|
"level": level,
|
||||||
|
"class": handler_classes["stream"],
|
||||||
|
"console": _stdout_console,
|
||||||
|
"filters": ["exclude_subprocess", "exclude_warnings"],
|
||||||
|
"formatter": "indent",
|
||||||
|
},
|
||||||
|
"console_errors": {
|
||||||
|
"level": "WARNING",
|
||||||
|
"class": handler_classes["stream"],
|
||||||
|
"console": _stderr_console,
|
||||||
|
"filters": ["exclude_subprocess"],
|
||||||
|
"formatter": "indent",
|
||||||
|
},
|
||||||
|
# A handler responsible for logging to the console messages
|
||||||
|
# from the "subprocessor" logger.
|
||||||
|
"console_subprocess": {
|
||||||
|
"level": level,
|
||||||
|
"class": handler_classes["stream"],
|
||||||
|
"console": _stderr_console,
|
||||||
|
"filters": ["restrict_to_subprocess"],
|
||||||
|
"formatter": "indent",
|
||||||
|
},
|
||||||
|
"user_log": {
|
||||||
|
"level": "DEBUG",
|
||||||
|
"class": handler_classes["file"],
|
||||||
|
"filename": additional_log_file,
|
||||||
|
"encoding": "utf-8",
|
||||||
|
"delay": True,
|
||||||
|
"formatter": "indent_with_timestamp",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"root": {
|
||||||
|
"level": root_level,
|
||||||
|
"handlers": handlers,
|
||||||
|
},
|
||||||
|
"loggers": {"pip._vendor": {"level": vendored_log_level}},
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
return level_number
|
||||||
771
venv/Lib/site-packages/pip/_internal/utils/misc.py
Normal file
771
venv/Lib/site-packages/pip/_internal/utils/misc.py
Normal file
@@ -0,0 +1,771 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import errno
|
||||||
|
import getpass
|
||||||
|
import hashlib
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import posixpath
|
||||||
|
import shutil
|
||||||
|
import stat
|
||||||
|
import sys
|
||||||
|
import sysconfig
|
||||||
|
import urllib.parse
|
||||||
|
from collections.abc import Generator, Iterable, Iterator, Mapping, Sequence
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from functools import partial
|
||||||
|
from io import StringIO
|
||||||
|
from itertools import filterfalse, tee, zip_longest
|
||||||
|
from pathlib import Path
|
||||||
|
from types import FunctionType, TracebackType
|
||||||
|
from typing import (
|
||||||
|
Any,
|
||||||
|
BinaryIO,
|
||||||
|
Callable,
|
||||||
|
Optional,
|
||||||
|
TextIO,
|
||||||
|
TypeVar,
|
||||||
|
cast,
|
||||||
|
)
|
||||||
|
|
||||||
|
from pip._vendor.packaging.requirements import Requirement
|
||||||
|
from pip._vendor.pyproject_hooks import BuildBackendHookCaller
|
||||||
|
|
||||||
|
from pip import __version__
|
||||||
|
from pip._internal.exceptions import CommandError, ExternallyManagedEnvironment
|
||||||
|
from pip._internal.locations import get_major_minor_version
|
||||||
|
from pip._internal.utils.compat import WINDOWS
|
||||||
|
from pip._internal.utils.retry import retry
|
||||||
|
from pip._internal.utils.virtualenv import running_under_virtualenv
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"rmtree",
|
||||||
|
"display_path",
|
||||||
|
"backup_dir",
|
||||||
|
"ask",
|
||||||
|
"splitext",
|
||||||
|
"format_size",
|
||||||
|
"is_installable_dir",
|
||||||
|
"normalize_path",
|
||||||
|
"renames",
|
||||||
|
"get_prog",
|
||||||
|
"ensure_dir",
|
||||||
|
"remove_auth_from_url",
|
||||||
|
"check_externally_managed",
|
||||||
|
"ConfiguredBuildBackendHookCaller",
|
||||||
|
]
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
T = TypeVar("T")
|
||||||
|
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]
|
||||||
|
|
||||||
|
FILE_CHUNK_SIZE = 1024 * 1024
|
||||||
|
|
||||||
|
|
||||||
|
def get_pip_version() -> str:
|
||||||
|
pip_pkg_dir = os.path.join(os.path.dirname(__file__), "..", "..")
|
||||||
|
pip_pkg_dir = os.path.abspath(pip_pkg_dir)
|
||||||
|
|
||||||
|
return f"pip {__version__} from {pip_pkg_dir} (python {get_major_minor_version()})"
|
||||||
|
|
||||||
|
|
||||||
|
def normalize_version_info(py_version_info: tuple[int, ...]) -> tuple[int, int, int]:
|
||||||
|
"""
|
||||||
|
Convert a tuple of ints representing a Python version to one of length
|
||||||
|
three.
|
||||||
|
|
||||||
|
:param py_version_info: a tuple of ints representing a Python version,
|
||||||
|
or None to specify no version. The tuple can have any length.
|
||||||
|
|
||||||
|
:return: a tuple of length three if `py_version_info` is non-None.
|
||||||
|
Otherwise, return `py_version_info` unchanged (i.e. None).
|
||||||
|
"""
|
||||||
|
if len(py_version_info) < 3:
|
||||||
|
py_version_info += (3 - len(py_version_info)) * (0,)
|
||||||
|
elif len(py_version_info) > 3:
|
||||||
|
py_version_info = py_version_info[:3]
|
||||||
|
|
||||||
|
return cast("VersionInfo", py_version_info)
|
||||||
|
|
||||||
|
|
||||||
|
def ensure_dir(path: str) -> None:
|
||||||
|
"""os.path.makedirs without EEXIST."""
|
||||||
|
try:
|
||||||
|
os.makedirs(path)
|
||||||
|
except OSError as e:
|
||||||
|
# Windows can raise spurious ENOTEMPTY errors. See #6426.
|
||||||
|
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY:
|
||||||
|
raise
|
||||||
|
|
||||||
|
|
||||||
|
def get_prog() -> str:
|
||||||
|
try:
|
||||||
|
prog = os.path.basename(sys.argv[0])
|
||||||
|
if prog in ("__main__.py", "-c"):
|
||||||
|
return f"{sys.executable} -m pip"
|
||||||
|
else:
|
||||||
|
return prog
|
||||||
|
except (AttributeError, TypeError, IndexError):
|
||||||
|
pass
|
||||||
|
return "pip"
|
||||||
|
|
||||||
|
|
||||||
|
# Retry every half second for up to 3 seconds
|
||||||
|
@retry(stop_after_delay=3, wait=0.5)
|
||||||
|
def rmtree(dir: str, ignore_errors: bool = False, onexc: OnExc | None = None) -> None:
|
||||||
|
if ignore_errors:
|
||||||
|
onexc = _onerror_ignore
|
||||||
|
if onexc is None:
|
||||||
|
onexc = _onerror_reraise
|
||||||
|
handler: OnErr = partial(rmtree_errorhandler, onexc=onexc)
|
||||||
|
if sys.version_info >= (3, 12):
|
||||||
|
# See https://docs.python.org/3.12/whatsnew/3.12.html#shutil.
|
||||||
|
shutil.rmtree(dir, onexc=handler) # type: ignore
|
||||||
|
else:
|
||||||
|
shutil.rmtree(dir, onerror=handler) # type: ignore
|
||||||
|
|
||||||
|
|
||||||
|
def _onerror_ignore(*_args: Any) -> None:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def _onerror_reraise(*_args: Any) -> None:
|
||||||
|
raise # noqa: PLE0704 - Bare exception used to reraise existing exception
|
||||||
|
|
||||||
|
|
||||||
|
def rmtree_errorhandler(
|
||||||
|
func: FunctionType,
|
||||||
|
path: Path,
|
||||||
|
exc_info: ExcInfo | BaseException,
|
||||||
|
*,
|
||||||
|
onexc: OnExc = _onerror_reraise,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
`rmtree` error handler to 'force' a file remove (i.e. like `rm -f`).
|
||||||
|
|
||||||
|
* If a file is readonly then it's write flag is set and operation is
|
||||||
|
retried.
|
||||||
|
|
||||||
|
* `onerror` is the original callback from `rmtree(... onerror=onerror)`
|
||||||
|
that is chained at the end if the "rm -f" still fails.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
st_mode = os.stat(path).st_mode
|
||||||
|
except OSError:
|
||||||
|
# it's equivalent to os.path.exists
|
||||||
|
return
|
||||||
|
|
||||||
|
if not st_mode & stat.S_IWRITE:
|
||||||
|
# convert to read/write
|
||||||
|
try:
|
||||||
|
os.chmod(path, st_mode | stat.S_IWRITE)
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
else:
|
||||||
|
# use the original function to repeat the operation
|
||||||
|
try:
|
||||||
|
func(path)
|
||||||
|
return
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
if not isinstance(exc_info, BaseException):
|
||||||
|
_, exc_info, _ = exc_info
|
||||||
|
onexc(func, path, exc_info)
|
||||||
|
|
||||||
|
|
||||||
|
def display_path(path: str) -> str:
|
||||||
|
"""Gives the display value for a given path, making it relative to cwd
|
||||||
|
if possible."""
|
||||||
|
try:
|
||||||
|
relative = Path(path).relative_to(Path.cwd())
|
||||||
|
except ValueError:
|
||||||
|
# If the path isn't relative to the CWD, leave it alone
|
||||||
|
return path
|
||||||
|
return os.path.join(".", relative)
|
||||||
|
|
||||||
|
|
||||||
|
def backup_dir(dir: str, ext: str = ".bak") -> str:
|
||||||
|
"""Figure out the name of a directory to back up the given dir to
|
||||||
|
(adding .bak, .bak2, etc)"""
|
||||||
|
n = 1
|
||||||
|
extension = ext
|
||||||
|
while os.path.exists(dir + extension):
|
||||||
|
n += 1
|
||||||
|
extension = ext + str(n)
|
||||||
|
return dir + extension
|
||||||
|
|
||||||
|
|
||||||
|
def ask_path_exists(message: str, options: Iterable[str]) -> str:
|
||||||
|
for action in os.environ.get("PIP_EXISTS_ACTION", "").split():
|
||||||
|
if action in options:
|
||||||
|
return action
|
||||||
|
return ask(message, options)
|
||||||
|
|
||||||
|
|
||||||
|
def _check_no_input(message: str) -> None:
|
||||||
|
"""Raise an error if no input is allowed."""
|
||||||
|
if os.environ.get("PIP_NO_INPUT"):
|
||||||
|
raise Exception(
|
||||||
|
f"No input was expected ($PIP_NO_INPUT set); question: {message}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def ask(message: str, options: Iterable[str]) -> str:
|
||||||
|
"""Ask the message interactively, with the given possible responses"""
|
||||||
|
while 1:
|
||||||
|
_check_no_input(message)
|
||||||
|
response = input(message)
|
||||||
|
response = response.strip().lower()
|
||||||
|
if response not in options:
|
||||||
|
print(
|
||||||
|
"Your response ({!r}) was not one of the expected responses: "
|
||||||
|
"{}".format(response, ", ".join(options))
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
return response
|
||||||
|
|
||||||
|
|
||||||
|
def ask_input(message: str) -> str:
|
||||||
|
"""Ask for input interactively."""
|
||||||
|
_check_no_input(message)
|
||||||
|
return input(message)
|
||||||
|
|
||||||
|
|
||||||
|
def ask_password(message: str) -> str:
|
||||||
|
"""Ask for a password interactively."""
|
||||||
|
_check_no_input(message)
|
||||||
|
return getpass.getpass(message)
|
||||||
|
|
||||||
|
|
||||||
|
def strtobool(val: str) -> int:
|
||||||
|
"""Convert a string representation of truth to true (1) or false (0).
|
||||||
|
|
||||||
|
True values are 'y', 'yes', 't', 'true', 'on', and '1'; false values
|
||||||
|
are 'n', 'no', 'f', 'false', 'off', and '0'. Raises ValueError if
|
||||||
|
'val' is anything else.
|
||||||
|
"""
|
||||||
|
val = val.lower()
|
||||||
|
if val in ("y", "yes", "t", "true", "on", "1"):
|
||||||
|
return 1
|
||||||
|
elif val in ("n", "no", "f", "false", "off", "0"):
|
||||||
|
return 0
|
||||||
|
else:
|
||||||
|
raise ValueError(f"invalid truth value {val!r}")
|
||||||
|
|
||||||
|
|
||||||
|
def format_size(bytes: float) -> str:
|
||||||
|
if bytes > 1000 * 1000:
|
||||||
|
return f"{bytes / 1000.0 / 1000:.1f} MB"
|
||||||
|
elif bytes > 10 * 1000:
|
||||||
|
return f"{int(bytes / 1000)} kB"
|
||||||
|
elif bytes > 1000:
|
||||||
|
return f"{bytes / 1000.0:.1f} kB"
|
||||||
|
else:
|
||||||
|
return f"{int(bytes)} bytes"
|
||||||
|
|
||||||
|
|
||||||
|
def tabulate(rows: Iterable[Iterable[Any]]) -> tuple[list[str], list[int]]:
|
||||||
|
"""Return a list of formatted rows and a list of column sizes.
|
||||||
|
|
||||||
|
For example::
|
||||||
|
|
||||||
|
>>> tabulate([['foobar', 2000], [0xdeadbeef]])
|
||||||
|
(['foobar 2000', '3735928559'], [10, 4])
|
||||||
|
"""
|
||||||
|
rows = [tuple(map(str, row)) for row in rows]
|
||||||
|
sizes = [max(map(len, col)) for col in zip_longest(*rows, fillvalue="")]
|
||||||
|
table = [" ".join(map(str.ljust, row, sizes)).rstrip() for row in rows]
|
||||||
|
return table, sizes
|
||||||
|
|
||||||
|
|
||||||
|
def is_installable_dir(path: str) -> bool:
|
||||||
|
"""Is path is a directory containing pyproject.toml or setup.py?
|
||||||
|
|
||||||
|
If pyproject.toml exists, this is a PEP 517 project. Otherwise we look for
|
||||||
|
a legacy setuptools layout by identifying setup.py. We don't check for the
|
||||||
|
setup.cfg because using it without setup.py is only available for PEP 517
|
||||||
|
projects, which are already covered by the pyproject.toml check.
|
||||||
|
"""
|
||||||
|
if not os.path.isdir(path):
|
||||||
|
return False
|
||||||
|
if os.path.isfile(os.path.join(path, "pyproject.toml")):
|
||||||
|
return True
|
||||||
|
if os.path.isfile(os.path.join(path, "setup.py")):
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def read_chunks(
|
||||||
|
file: BinaryIO, size: int = FILE_CHUNK_SIZE
|
||||||
|
) -> Generator[bytes, None, None]:
|
||||||
|
"""Yield pieces of data from a file-like object until EOF."""
|
||||||
|
while True:
|
||||||
|
chunk = file.read(size)
|
||||||
|
if not chunk:
|
||||||
|
break
|
||||||
|
yield chunk
|
||||||
|
|
||||||
|
|
||||||
|
def normalize_path(path: str, resolve_symlinks: bool = True) -> str:
|
||||||
|
"""
|
||||||
|
Convert a path to its canonical, case-normalized, absolute version.
|
||||||
|
|
||||||
|
"""
|
||||||
|
path = os.path.expanduser(path)
|
||||||
|
if resolve_symlinks:
|
||||||
|
path = os.path.realpath(path)
|
||||||
|
else:
|
||||||
|
path = os.path.abspath(path)
|
||||||
|
return os.path.normcase(path)
|
||||||
|
|
||||||
|
|
||||||
|
def splitext(path: str) -> tuple[str, str]:
|
||||||
|
"""Like os.path.splitext, but take off .tar too"""
|
||||||
|
base, ext = posixpath.splitext(path)
|
||||||
|
if base.lower().endswith(".tar"):
|
||||||
|
ext = base[-4:] + ext
|
||||||
|
base = base[:-4]
|
||||||
|
return base, ext
|
||||||
|
|
||||||
|
|
||||||
|
def renames(old: str, new: str) -> None:
|
||||||
|
"""Like os.renames(), but handles renaming across devices."""
|
||||||
|
# Implementation borrowed from os.renames().
|
||||||
|
head, tail = os.path.split(new)
|
||||||
|
if head and tail and not os.path.exists(head):
|
||||||
|
os.makedirs(head)
|
||||||
|
|
||||||
|
shutil.move(old, new)
|
||||||
|
|
||||||
|
head, tail = os.path.split(old)
|
||||||
|
if head and tail:
|
||||||
|
try:
|
||||||
|
os.removedirs(head)
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def is_local(path: str) -> bool:
|
||||||
|
"""
|
||||||
|
Return True if path is within sys.prefix, if we're running in a virtualenv.
|
||||||
|
|
||||||
|
If we're not in a virtualenv, all paths are considered "local."
|
||||||
|
|
||||||
|
Caution: this function assumes the head of path has been normalized
|
||||||
|
with normalize_path.
|
||||||
|
"""
|
||||||
|
if not running_under_virtualenv():
|
||||||
|
return True
|
||||||
|
return path.startswith(normalize_path(sys.prefix))
|
||||||
|
|
||||||
|
|
||||||
|
def write_output(msg: Any, *args: Any) -> None:
|
||||||
|
logger.info(msg, *args)
|
||||||
|
|
||||||
|
|
||||||
|
class StreamWrapper(StringIO):
|
||||||
|
orig_stream: TextIO
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def from_stream(cls, orig_stream: TextIO) -> StreamWrapper:
|
||||||
|
ret = cls()
|
||||||
|
ret.orig_stream = orig_stream
|
||||||
|
return ret
|
||||||
|
|
||||||
|
# compileall.compile_dir() needs stdout.encoding to print to stdout
|
||||||
|
# type ignore is because TextIOBase.encoding is writeable
|
||||||
|
@property
|
||||||
|
def encoding(self) -> str: # type: ignore
|
||||||
|
return self.orig_stream.encoding
|
||||||
|
|
||||||
|
|
||||||
|
# Simulates an enum
|
||||||
|
def enum(*sequential: Any, **named: Any) -> type[Any]:
|
||||||
|
enums = dict(zip(sequential, range(len(sequential))), **named)
|
||||||
|
reverse = {value: key for key, value in enums.items()}
|
||||||
|
enums["reverse_mapping"] = reverse
|
||||||
|
return type("Enum", (), enums)
|
||||||
|
|
||||||
|
|
||||||
|
def build_netloc(host: str, port: int | None) -> str:
|
||||||
|
"""
|
||||||
|
Build a netloc from a host-port pair
|
||||||
|
"""
|
||||||
|
if port is None:
|
||||||
|
return host
|
||||||
|
if ":" in host:
|
||||||
|
# Only wrap host with square brackets when it is IPv6
|
||||||
|
host = f"[{host}]"
|
||||||
|
return f"{host}:{port}"
|
||||||
|
|
||||||
|
|
||||||
|
def build_url_from_netloc(netloc: str, scheme: str = "https") -> str:
|
||||||
|
"""
|
||||||
|
Build a full URL from a netloc.
|
||||||
|
"""
|
||||||
|
if netloc.count(":") >= 2 and "@" not in netloc and "[" not in netloc:
|
||||||
|
# It must be a bare IPv6 address, so wrap it with brackets.
|
||||||
|
netloc = f"[{netloc}]"
|
||||||
|
return f"{scheme}://{netloc}"
|
||||||
|
|
||||||
|
|
||||||
|
def parse_netloc(netloc: str) -> tuple[str | None, int | None]:
|
||||||
|
"""
|
||||||
|
Return the host-port pair from a netloc.
|
||||||
|
"""
|
||||||
|
url = build_url_from_netloc(netloc)
|
||||||
|
parsed = urllib.parse.urlparse(url)
|
||||||
|
return parsed.hostname, parsed.port
|
||||||
|
|
||||||
|
|
||||||
|
def split_auth_from_netloc(netloc: str) -> NetlocTuple:
|
||||||
|
"""
|
||||||
|
Parse out and remove the auth information from a netloc.
|
||||||
|
|
||||||
|
Returns: (netloc, (username, password)).
|
||||||
|
"""
|
||||||
|
if "@" not in netloc:
|
||||||
|
return netloc, (None, None)
|
||||||
|
|
||||||
|
# Split from the right because that's how urllib.parse.urlsplit()
|
||||||
|
# behaves if more than one @ is present (which can be checked using
|
||||||
|
# the password attribute of urlsplit()'s return value).
|
||||||
|
auth, netloc = netloc.rsplit("@", 1)
|
||||||
|
pw: str | None = None
|
||||||
|
if ":" in auth:
|
||||||
|
# Split from the left because that's how urllib.parse.urlsplit()
|
||||||
|
# behaves if more than one : is present (which again can be checked
|
||||||
|
# using the password attribute of the return value)
|
||||||
|
user, pw = auth.split(":", 1)
|
||||||
|
else:
|
||||||
|
user, pw = auth, None
|
||||||
|
|
||||||
|
user = urllib.parse.unquote(user)
|
||||||
|
if pw is not None:
|
||||||
|
pw = urllib.parse.unquote(pw)
|
||||||
|
|
||||||
|
return netloc, (user, pw)
|
||||||
|
|
||||||
|
|
||||||
|
def redact_netloc(netloc: str) -> str:
|
||||||
|
"""
|
||||||
|
Replace the sensitive data in a netloc with "****", if it exists.
|
||||||
|
|
||||||
|
For example:
|
||||||
|
- "user:pass@example.com" returns "user:****@example.com"
|
||||||
|
- "accesstoken@example.com" returns "****@example.com"
|
||||||
|
"""
|
||||||
|
netloc, (user, password) = split_auth_from_netloc(netloc)
|
||||||
|
if user is None:
|
||||||
|
return netloc
|
||||||
|
if password is None:
|
||||||
|
user = "****"
|
||||||
|
password = ""
|
||||||
|
else:
|
||||||
|
user = urllib.parse.quote(user)
|
||||||
|
password = ":****"
|
||||||
|
return f"{user}{password}@{netloc}"
|
||||||
|
|
||||||
|
|
||||||
|
def _transform_url(
|
||||||
|
url: str, transform_netloc: Callable[[str], tuple[Any, ...]]
|
||||||
|
) -> tuple[str, NetlocTuple]:
|
||||||
|
"""Transform and replace netloc in a url.
|
||||||
|
|
||||||
|
transform_netloc is a function taking the netloc and returning a
|
||||||
|
tuple. The first element of this tuple is the new netloc. The
|
||||||
|
entire tuple is returned.
|
||||||
|
|
||||||
|
Returns a tuple containing the transformed url as item 0 and the
|
||||||
|
original tuple returned by transform_netloc as item 1.
|
||||||
|
"""
|
||||||
|
purl = urllib.parse.urlsplit(url)
|
||||||
|
netloc_tuple = transform_netloc(purl.netloc)
|
||||||
|
# stripped url
|
||||||
|
url_pieces = (purl.scheme, netloc_tuple[0], purl.path, purl.query, purl.fragment)
|
||||||
|
surl = urllib.parse.urlunsplit(url_pieces)
|
||||||
|
return surl, cast("NetlocTuple", netloc_tuple)
|
||||||
|
|
||||||
|
|
||||||
|
def _get_netloc(netloc: str) -> NetlocTuple:
|
||||||
|
return split_auth_from_netloc(netloc)
|
||||||
|
|
||||||
|
|
||||||
|
def _redact_netloc(netloc: str) -> tuple[str]:
|
||||||
|
return (redact_netloc(netloc),)
|
||||||
|
|
||||||
|
|
||||||
|
def split_auth_netloc_from_url(
|
||||||
|
url: str,
|
||||||
|
) -> tuple[str, str, tuple[str | None, str | None]]:
|
||||||
|
"""
|
||||||
|
Parse a url into separate netloc, auth, and url with no auth.
|
||||||
|
|
||||||
|
Returns: (url_without_auth, netloc, (username, password))
|
||||||
|
"""
|
||||||
|
url_without_auth, (netloc, auth) = _transform_url(url, _get_netloc)
|
||||||
|
return url_without_auth, netloc, auth
|
||||||
|
|
||||||
|
|
||||||
|
def remove_auth_from_url(url: str) -> str:
|
||||||
|
"""Return a copy of url with 'username:password@' removed."""
|
||||||
|
# username/pass params are passed to subversion through flags
|
||||||
|
# and are not recognized in the url.
|
||||||
|
return _transform_url(url, _get_netloc)[0]
|
||||||
|
|
||||||
|
|
||||||
|
def redact_auth_from_url(url: str) -> str:
|
||||||
|
"""Replace the password in a given url with ****."""
|
||||||
|
return _transform_url(url, _redact_netloc)[0]
|
||||||
|
|
||||||
|
|
||||||
|
def redact_auth_from_requirement(req: Requirement) -> str:
|
||||||
|
"""Replace the password in a given requirement url with ****."""
|
||||||
|
if not req.url:
|
||||||
|
return str(req)
|
||||||
|
return str(req).replace(req.url, redact_auth_from_url(req.url))
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class HiddenText:
|
||||||
|
secret: str
|
||||||
|
redacted: str
|
||||||
|
|
||||||
|
def __repr__(self) -> str:
|
||||||
|
return f"<HiddenText {str(self)!r}>"
|
||||||
|
|
||||||
|
def __str__(self) -> str:
|
||||||
|
return self.redacted
|
||||||
|
|
||||||
|
def __eq__(self, other: object) -> bool:
|
||||||
|
# Equality is particularly useful for testing.
|
||||||
|
if type(self) is type(other):
|
||||||
|
# The string being used for redaction doesn't also have to match,
|
||||||
|
# just the raw, original string.
|
||||||
|
return self.secret == cast(HiddenText, other).secret
|
||||||
|
return NotImplemented
|
||||||
|
|
||||||
|
# Disable hashing, since we have a custom __eq__ and don't need hash-ability
|
||||||
|
# (yet). The only required property of hashing is that objects which compare
|
||||||
|
# equal have the same hash value.
|
||||||
|
__hash__ = None # type: ignore[assignment]
|
||||||
|
|
||||||
|
|
||||||
|
def hide_value(value: str) -> HiddenText:
|
||||||
|
return HiddenText(value, redacted="****")
|
||||||
|
|
||||||
|
|
||||||
|
def hide_url(url: str) -> HiddenText:
|
||||||
|
redacted = redact_auth_from_url(url)
|
||||||
|
return HiddenText(url, redacted=redacted)
|
||||||
|
|
||||||
|
|
||||||
|
def protect_pip_from_modification_on_windows(modifying_pip: bool) -> None:
|
||||||
|
"""Protection of pip.exe from modification on Windows
|
||||||
|
|
||||||
|
On Windows, any operation modifying pip should be run as:
|
||||||
|
python -m pip ...
|
||||||
|
"""
|
||||||
|
pip_names = [
|
||||||
|
"pip",
|
||||||
|
f"pip{sys.version_info.major}",
|
||||||
|
f"pip{sys.version_info.major}.{sys.version_info.minor}",
|
||||||
|
]
|
||||||
|
|
||||||
|
# See https://github.com/pypa/pip/issues/1299 for more discussion
|
||||||
|
should_show_use_python_msg = (
|
||||||
|
modifying_pip and WINDOWS and os.path.basename(sys.argv[0]) in pip_names
|
||||||
|
)
|
||||||
|
|
||||||
|
if should_show_use_python_msg:
|
||||||
|
new_command = [sys.executable, "-m", "pip"] + sys.argv[1:]
|
||||||
|
raise CommandError(
|
||||||
|
"To modify pip, please run the following command:\n{}".format(
|
||||||
|
" ".join(new_command)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def check_externally_managed() -> None:
|
||||||
|
"""Check whether the current environment is externally managed.
|
||||||
|
|
||||||
|
If the ``EXTERNALLY-MANAGED`` config file is found, the current environment
|
||||||
|
is considered externally managed, and an ExternallyManagedEnvironment is
|
||||||
|
raised.
|
||||||
|
"""
|
||||||
|
if running_under_virtualenv():
|
||||||
|
return
|
||||||
|
marker = os.path.join(sysconfig.get_path("stdlib"), "EXTERNALLY-MANAGED")
|
||||||
|
if not os.path.isfile(marker):
|
||||||
|
return
|
||||||
|
raise ExternallyManagedEnvironment.from_config(marker)
|
||||||
|
|
||||||
|
|
||||||
|
def is_console_interactive() -> bool:
|
||||||
|
"""Is this console interactive?"""
|
||||||
|
return sys.stdin is not None and sys.stdin.isatty()
|
||||||
|
|
||||||
|
|
||||||
|
def hash_file(path: str, blocksize: int = 1 << 20) -> tuple[Any, int]:
|
||||||
|
"""Return (hash, length) for path using hashlib.sha256()"""
|
||||||
|
|
||||||
|
h = hashlib.sha256()
|
||||||
|
length = 0
|
||||||
|
with open(path, "rb") as f:
|
||||||
|
for block in read_chunks(f, size=blocksize):
|
||||||
|
length += len(block)
|
||||||
|
h.update(block)
|
||||||
|
return h, length
|
||||||
|
|
||||||
|
|
||||||
|
def pairwise(iterable: Iterable[Any]) -> Iterator[tuple[Any, Any]]:
|
||||||
|
"""
|
||||||
|
Return paired elements.
|
||||||
|
|
||||||
|
For example:
|
||||||
|
s -> (s0, s1), (s2, s3), (s4, s5), ...
|
||||||
|
"""
|
||||||
|
iterable = iter(iterable)
|
||||||
|
return zip_longest(iterable, iterable)
|
||||||
|
|
||||||
|
|
||||||
|
def partition(
|
||||||
|
pred: Callable[[T], bool], iterable: Iterable[T]
|
||||||
|
) -> tuple[Iterable[T], Iterable[T]]:
|
||||||
|
"""
|
||||||
|
Use a predicate to partition entries into false entries and true entries,
|
||||||
|
like
|
||||||
|
|
||||||
|
partition(is_odd, range(10)) --> 0 2 4 6 8 and 1 3 5 7 9
|
||||||
|
"""
|
||||||
|
t1, t2 = tee(iterable)
|
||||||
|
return filterfalse(pred, t1), filter(pred, t2)
|
||||||
|
|
||||||
|
|
||||||
|
class ConfiguredBuildBackendHookCaller(BuildBackendHookCaller):
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
config_holder: Any,
|
||||||
|
source_dir: str,
|
||||||
|
build_backend: str,
|
||||||
|
backend_path: str | None = None,
|
||||||
|
runner: Callable[..., None] | None = None,
|
||||||
|
python_executable: str | None = None,
|
||||||
|
):
|
||||||
|
super().__init__(
|
||||||
|
source_dir, build_backend, backend_path, runner, python_executable
|
||||||
|
)
|
||||||
|
self.config_holder = config_holder
|
||||||
|
|
||||||
|
def build_wheel(
|
||||||
|
self,
|
||||||
|
wheel_directory: str,
|
||||||
|
config_settings: Mapping[str, Any] | None = None,
|
||||||
|
metadata_directory: str | None = None,
|
||||||
|
) -> str:
|
||||||
|
cs = self.config_holder.config_settings
|
||||||
|
return super().build_wheel(
|
||||||
|
wheel_directory, config_settings=cs, metadata_directory=metadata_directory
|
||||||
|
)
|
||||||
|
|
||||||
|
def build_sdist(
|
||||||
|
self,
|
||||||
|
sdist_directory: str,
|
||||||
|
config_settings: Mapping[str, Any] | None = None,
|
||||||
|
) -> str:
|
||||||
|
cs = self.config_holder.config_settings
|
||||||
|
return super().build_sdist(sdist_directory, config_settings=cs)
|
||||||
|
|
||||||
|
def build_editable(
|
||||||
|
self,
|
||||||
|
wheel_directory: str,
|
||||||
|
config_settings: Mapping[str, Any] | None = None,
|
||||||
|
metadata_directory: str | None = None,
|
||||||
|
) -> str:
|
||||||
|
cs = self.config_holder.config_settings
|
||||||
|
return super().build_editable(
|
||||||
|
wheel_directory, config_settings=cs, metadata_directory=metadata_directory
|
||||||
|
)
|
||||||
|
|
||||||
|
def get_requires_for_build_wheel(
|
||||||
|
self, config_settings: Mapping[str, Any] | None = None
|
||||||
|
) -> Sequence[str]:
|
||||||
|
cs = self.config_holder.config_settings
|
||||||
|
return super().get_requires_for_build_wheel(config_settings=cs)
|
||||||
|
|
||||||
|
def get_requires_for_build_sdist(
|
||||||
|
self, config_settings: Mapping[str, Any] | None = None
|
||||||
|
) -> Sequence[str]:
|
||||||
|
cs = self.config_holder.config_settings
|
||||||
|
return super().get_requires_for_build_sdist(config_settings=cs)
|
||||||
|
|
||||||
|
def get_requires_for_build_editable(
|
||||||
|
self, config_settings: Mapping[str, Any] | None = None
|
||||||
|
) -> Sequence[str]:
|
||||||
|
cs = self.config_holder.config_settings
|
||||||
|
return super().get_requires_for_build_editable(config_settings=cs)
|
||||||
|
|
||||||
|
def prepare_metadata_for_build_wheel(
|
||||||
|
self,
|
||||||
|
metadata_directory: str,
|
||||||
|
config_settings: Mapping[str, Any] | None = None,
|
||||||
|
_allow_fallback: bool = True,
|
||||||
|
) -> str:
|
||||||
|
cs = self.config_holder.config_settings
|
||||||
|
return super().prepare_metadata_for_build_wheel(
|
||||||
|
metadata_directory=metadata_directory,
|
||||||
|
config_settings=cs,
|
||||||
|
_allow_fallback=_allow_fallback,
|
||||||
|
)
|
||||||
|
|
||||||
|
def prepare_metadata_for_build_editable(
|
||||||
|
self,
|
||||||
|
metadata_directory: str,
|
||||||
|
config_settings: Mapping[str, Any] | None = None,
|
||||||
|
_allow_fallback: bool = True,
|
||||||
|
) -> str | None:
|
||||||
|
cs = self.config_holder.config_settings
|
||||||
|
return super().prepare_metadata_for_build_editable(
|
||||||
|
metadata_directory=metadata_directory,
|
||||||
|
config_settings=cs,
|
||||||
|
_allow_fallback=_allow_fallback,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def warn_if_run_as_root() -> None:
|
||||||
|
"""Output a warning for sudo users on Unix.
|
||||||
|
|
||||||
|
In a virtual environment, sudo pip still writes to virtualenv.
|
||||||
|
On Windows, users may run pip as Administrator without issues.
|
||||||
|
This warning only applies to Unix root users outside of virtualenv.
|
||||||
|
"""
|
||||||
|
if running_under_virtualenv():
|
||||||
|
return
|
||||||
|
if not hasattr(os, "getuid"):
|
||||||
|
return
|
||||||
|
# On Windows, there are no "system managed" Python packages. Installing as
|
||||||
|
# Administrator via pip is the correct way of updating system environments.
|
||||||
|
#
|
||||||
|
# We choose sys.platform over utils.compat.WINDOWS here to enable Mypy platform
|
||||||
|
# checks: https://mypy.readthedocs.io/en/stable/common_issues.html
|
||||||
|
if sys.platform == "win32" or sys.platform == "cygwin":
|
||||||
|
return
|
||||||
|
|
||||||
|
if os.getuid() != 0:
|
||||||
|
return
|
||||||
|
|
||||||
|
logger.warning(
|
||||||
|
"Running pip as the 'root' user can result in broken permissions and "
|
||||||
|
"conflicting behaviour with the system package manager, possibly "
|
||||||
|
"rendering your system unusable. "
|
||||||
|
"It is recommended to use a virtual environment instead: "
|
||||||
|
"https://pip.pypa.io/warnings/venv. "
|
||||||
|
"Use the --root-user-action option if you know what you are doing and "
|
||||||
|
"want to suppress this warning."
|
||||||
|
)
|
||||||
44
venv/Lib/site-packages/pip/_internal/utils/packaging.py
Normal file
44
venv/Lib/site-packages/pip/_internal/utils/packaging.py
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import functools
|
||||||
|
import logging
|
||||||
|
|
||||||
|
from pip._vendor.packaging import specifiers, version
|
||||||
|
from pip._vendor.packaging.requirements import Requirement
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
@functools.lru_cache(maxsize=32)
|
||||||
|
def check_requires_python(
|
||||||
|
requires_python: str | None, version_info: tuple[int, ...]
|
||||||
|
) -> bool:
|
||||||
|
"""
|
||||||
|
Check if the given Python version matches a "Requires-Python" specifier.
|
||||||
|
|
||||||
|
:param version_info: A 3-tuple of ints representing a Python
|
||||||
|
major-minor-micro version to check (e.g. `sys.version_info[:3]`).
|
||||||
|
|
||||||
|
:return: `True` if the given Python version satisfies the requirement.
|
||||||
|
Otherwise, return `False`.
|
||||||
|
|
||||||
|
:raises InvalidSpecifier: If `requires_python` has an invalid format.
|
||||||
|
"""
|
||||||
|
if requires_python is None:
|
||||||
|
# The package provides no information
|
||||||
|
return True
|
||||||
|
requires_python_specifier = specifiers.SpecifierSet(requires_python)
|
||||||
|
|
||||||
|
python_version = version.parse(".".join(map(str, version_info)))
|
||||||
|
return python_version in requires_python_specifier
|
||||||
|
|
||||||
|
|
||||||
|
@functools.lru_cache(maxsize=10000)
|
||||||
|
def get_requirement(req_string: str) -> Requirement:
|
||||||
|
"""Construct a packaging.Requirement object with caching"""
|
||||||
|
# Parsing requirement strings is expensive, and is also expected to happen
|
||||||
|
# with a low diversity of different arguments (at least relative the number
|
||||||
|
# constructed). This method adds a cache to requirement object creation to
|
||||||
|
# minimize repeated parsing of the same string to construct equivalent
|
||||||
|
# Requirement objects.
|
||||||
|
return Requirement(req_string)
|
||||||
116
venv/Lib/site-packages/pip/_internal/utils/pylock.py
Normal file
116
venv/Lib/site-packages/pip/_internal/utils/pylock.py
Normal file
@@ -0,0 +1,116 @@
|
|||||||
|
from collections.abc import Iterable
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from pip._vendor.packaging.pylock import (
|
||||||
|
Package,
|
||||||
|
PackageArchive,
|
||||||
|
PackageDirectory,
|
||||||
|
PackageSdist,
|
||||||
|
PackageVcs,
|
||||||
|
PackageWheel,
|
||||||
|
Pylock,
|
||||||
|
)
|
||||||
|
from pip._vendor.packaging.version import Version
|
||||||
|
|
||||||
|
from pip._internal.models.direct_url import ArchiveInfo, DirInfo, VcsInfo
|
||||||
|
from pip._internal.models.link import Link
|
||||||
|
from pip._internal.req.req_install import InstallRequirement
|
||||||
|
from pip._internal.utils.urls import url_to_path
|
||||||
|
|
||||||
|
|
||||||
|
def _pylock_package_from_install_requirement(
|
||||||
|
ireq: InstallRequirement, base_dir: Path
|
||||||
|
) -> Package:
|
||||||
|
base_dir = base_dir.resolve()
|
||||||
|
dist = ireq.get_dist()
|
||||||
|
download_info = ireq.download_info
|
||||||
|
assert download_info
|
||||||
|
package_version = None
|
||||||
|
package_vcs = None
|
||||||
|
package_directory = None
|
||||||
|
package_archive = None
|
||||||
|
package_sdist = None
|
||||||
|
package_wheels = None
|
||||||
|
if ireq.is_direct:
|
||||||
|
if isinstance(download_info.info, VcsInfo):
|
||||||
|
package_vcs = PackageVcs(
|
||||||
|
type=download_info.info.vcs,
|
||||||
|
url=download_info.url,
|
||||||
|
path=None,
|
||||||
|
requested_revision=download_info.info.requested_revision,
|
||||||
|
commit_id=download_info.info.commit_id,
|
||||||
|
subdirectory=download_info.subdirectory,
|
||||||
|
)
|
||||||
|
elif isinstance(download_info.info, DirInfo):
|
||||||
|
package_directory = PackageDirectory(
|
||||||
|
path=(
|
||||||
|
Path(url_to_path(download_info.url))
|
||||||
|
.resolve()
|
||||||
|
.relative_to(base_dir)
|
||||||
|
.as_posix()
|
||||||
|
),
|
||||||
|
editable=(
|
||||||
|
download_info.info.editable if download_info.info.editable else None
|
||||||
|
),
|
||||||
|
subdirectory=download_info.subdirectory,
|
||||||
|
)
|
||||||
|
elif isinstance(download_info.info, ArchiveInfo):
|
||||||
|
if not download_info.info.hashes:
|
||||||
|
raise NotImplementedError()
|
||||||
|
package_archive = PackageArchive(
|
||||||
|
url=download_info.url,
|
||||||
|
path=None,
|
||||||
|
hashes=download_info.info.hashes,
|
||||||
|
subdirectory=download_info.subdirectory,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
# should never happen
|
||||||
|
raise NotImplementedError()
|
||||||
|
else:
|
||||||
|
package_version = dist.version
|
||||||
|
if isinstance(download_info.info, ArchiveInfo):
|
||||||
|
if not download_info.info.hashes:
|
||||||
|
raise NotImplementedError()
|
||||||
|
link = Link(download_info.url)
|
||||||
|
if link.is_wheel:
|
||||||
|
package_wheels = [
|
||||||
|
PackageWheel(
|
||||||
|
name=link.filename,
|
||||||
|
url=download_info.url,
|
||||||
|
hashes=download_info.info.hashes,
|
||||||
|
)
|
||||||
|
]
|
||||||
|
else:
|
||||||
|
package_sdist = PackageSdist(
|
||||||
|
name=link.filename,
|
||||||
|
url=download_info.url,
|
||||||
|
hashes=download_info.info.hashes,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
# should never happen
|
||||||
|
raise NotImplementedError()
|
||||||
|
return Package(
|
||||||
|
name=dist.canonical_name,
|
||||||
|
version=package_version,
|
||||||
|
vcs=package_vcs,
|
||||||
|
directory=package_directory,
|
||||||
|
archive=package_archive,
|
||||||
|
sdist=package_sdist,
|
||||||
|
wheels=package_wheels,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def pylock_from_install_requirements(
|
||||||
|
install_requirements: Iterable[InstallRequirement], base_dir: Path
|
||||||
|
) -> Pylock:
|
||||||
|
return Pylock(
|
||||||
|
lock_version=Version("1.0"),
|
||||||
|
created_by="pip",
|
||||||
|
packages=sorted(
|
||||||
|
(
|
||||||
|
_pylock_package_from_install_requirement(ireq, base_dir)
|
||||||
|
for ireq in install_requirements
|
||||||
|
),
|
||||||
|
key=lambda p: p.name,
|
||||||
|
),
|
||||||
|
)
|
||||||
45
venv/Lib/site-packages/pip/_internal/utils/retry.py
Normal file
45
venv/Lib/site-packages/pip/_internal/utils/retry.py
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import functools
|
||||||
|
from time import perf_counter, sleep
|
||||||
|
from typing import TYPE_CHECKING, Callable, TypeVar
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from typing_extensions import ParamSpec
|
||||||
|
|
||||||
|
T = TypeVar("T")
|
||||||
|
P = ParamSpec("P")
|
||||||
|
|
||||||
|
|
||||||
|
def retry(
|
||||||
|
wait: float, stop_after_delay: float
|
||||||
|
) -> Callable[[Callable[P, T]], Callable[P, T]]:
|
||||||
|
"""Decorator to automatically retry a function on error.
|
||||||
|
|
||||||
|
If the function raises, the function is recalled with the same arguments
|
||||||
|
until it returns or the time limit is reached. When the time limit is
|
||||||
|
surpassed, the last exception raised is reraised.
|
||||||
|
|
||||||
|
:param wait: The time to wait after an error before retrying, in seconds.
|
||||||
|
:param stop_after_delay: The time limit after which retries will cease,
|
||||||
|
in seconds.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def wrapper(func: Callable[P, T]) -> Callable[P, T]:
|
||||||
|
|
||||||
|
@functools.wraps(func)
|
||||||
|
def retry_wrapped(*args: P.args, **kwargs: P.kwargs) -> T:
|
||||||
|
# The performance counter is monotonic on all platforms we care
|
||||||
|
# about and has much better resolution than time.monotonic().
|
||||||
|
start_time = perf_counter()
|
||||||
|
while True:
|
||||||
|
try:
|
||||||
|
return func(*args, **kwargs)
|
||||||
|
except Exception:
|
||||||
|
if perf_counter() - start_time > stop_after_delay:
|
||||||
|
raise
|
||||||
|
sleep(wait)
|
||||||
|
|
||||||
|
return retry_wrapped
|
||||||
|
|
||||||
|
return wrapper
|
||||||
Reference in New Issue
Block a user