Initial commit
This commit is contained in:
commit
57fc3525eb
7311 files changed
+1291398
No files matched your search
@@ -0,0 +1,90 @@
|
||||
from __future__ import annotations
|
||||
|
||||
__lazy_modules__ = ["typing"]
|
||||
|
||||
from typing import Final
|
||||
|
||||
|
||||
class Timeout(TimeoutError): # ruff:ignore[error-suffix-on-exception-name] # public exception name; renaming breaks the API
|
||||
"""Raised when the lock could not be acquired in *timeout* seconds."""
|
||||
|
||||
def __init__(self, lock_file: str, holder: str | None = None) -> None:
|
||||
super().__init__()
|
||||
self._lock_file = lock_file
|
||||
self._holder = holder
|
||||
|
||||
def __reduce__(self) -> tuple[type[Timeout], tuple[str], dict[str, object]]:
|
||||
# holder rides in the state so a subclass taking only lock_file, and a 4.0.12 reader, can still unpickle it.
|
||||
return self.__class__, (self._lock_file,), self.__dict__
|
||||
|
||||
def __str__(self) -> str: # pragma: needs hard-link
|
||||
message: Final = f"The file lock '{self._lock_file}' could not be acquired."
|
||||
if self._holder is None:
|
||||
return message
|
||||
return f"{message} It is held by {self._holder}, which this host cannot probe."
|
||||
|
||||
def __repr__(self) -> str:
|
||||
return f"{self.__class__.__name__}({self.lock_file!r})"
|
||||
|
||||
@property
|
||||
def lock_file(self) -> str:
|
||||
"""The path of the file lock."""
|
||||
return self._lock_file
|
||||
|
||||
|
||||
class SoftFileLockLifetimeWarning(FutureWarning):
|
||||
"""
|
||||
The configured soft-lock lifetime permits overlapping live holders after expiry.
|
||||
|
||||
A :class:`FutureWarning` shows by default wherever the lock is configured; a :class:`DeprecationWarning` shows only
|
||||
in ``__main__``.
|
||||
|
||||
"""
|
||||
|
||||
|
||||
class LeaseSettingsMismatch(ValueError): # ruff:ignore[error-suffix-on-exception-name] # public exception name; renaming breaks the API
|
||||
"""A lease contender disagrees with the published claim about how long the lease lasts."""
|
||||
|
||||
|
||||
class SoftFileLockProtocolError(OSError):
|
||||
"""Raised when strict soft-lock state cannot be interpreted without risking overlap."""
|
||||
|
||||
def __init__(self, lock_file: str, claim_name: str | None, reason: str) -> None:
|
||||
self._lock_file = lock_file
|
||||
self._claim_name = claim_name
|
||||
self._reason = reason
|
||||
super().__init__(self.__str__())
|
||||
|
||||
def __reduce__(
|
||||
self,
|
||||
) -> tuple[
|
||||
type[SoftFileLockProtocolError], tuple[str, str | None, str], dict[str, object]
|
||||
]: # pragma: needs hard-link
|
||||
return self.__class__, (self._lock_file, self._claim_name, self._reason), self.__dict__
|
||||
|
||||
def __str__(self) -> str:
|
||||
location = self._lock_file if self._claim_name is None else f"{self._lock_file}: claim {self._claim_name!r}"
|
||||
return f"Invalid strict soft-lock state at {location}: {self._reason}"
|
||||
|
||||
@property
|
||||
def lock_file(self) -> str: # pragma: needs hard-link
|
||||
"""The requested lock path."""
|
||||
return self._lock_file
|
||||
|
||||
@property
|
||||
def claim_name(self) -> str | None: # pragma: needs hard-link
|
||||
"""The claim that caused the error, if scanning identified one."""
|
||||
return self._claim_name
|
||||
|
||||
@property
|
||||
def reason(self) -> str: # pragma: needs hard-link
|
||||
"""The protocol validation failure."""
|
||||
return self._reason
|
||||
|
||||
|
||||
__all__ = [
|
||||
"LeaseSettingsMismatch",
|
||||
"SoftFileLockLifetimeWarning",
|
||||
"SoftFileLockProtocolError",
|
||||
"Timeout",
|
||||
]
|
||||
Reference in new issue
Block a user