2023-01-06 11:47:44 +00:00
|
|
|
from __future__ import annotations
|
|
|
|
|
2023-04-12 13:51:13 +00:00
|
|
|
from typing import Any
|
|
|
|
|
2023-01-06 11:47:44 +00:00
|
|
|
|
2023-09-17 19:40:34 +00:00
|
|
|
class Timeout(TimeoutError): # noqa: N818
|
2023-01-06 11:47:44 +00:00
|
|
|
"""Raised when the lock could not be acquired in *timeout* seconds."""
|
|
|
|
|
|
|
|
def __init__(self, lock_file: str) -> None:
|
2023-04-12 13:51:13 +00:00
|
|
|
super().__init__()
|
|
|
|
self._lock_file = lock_file
|
|
|
|
|
|
|
|
def __reduce__(self) -> str | tuple[Any, ...]:
|
|
|
|
return self.__class__, (self._lock_file,) # Properly pickle the exception
|
2023-01-06 11:47:44 +00:00
|
|
|
|
|
|
|
def __str__(self) -> str:
|
2023-04-12 13:51:13 +00:00
|
|
|
return f"The file lock '{self._lock_file}' could not be acquired."
|
|
|
|
|
|
|
|
def __repr__(self) -> str:
|
|
|
|
return f"{self.__class__.__name__}({self.lock_file!r})"
|
|
|
|
|
|
|
|
@property
|
|
|
|
def lock_file(self) -> str:
|
|
|
|
""":return: The path of the file lock."""
|
|
|
|
return self._lock_file
|
2023-01-06 11:47:44 +00:00
|
|
|
|
|
|
|
|
|
|
|
__all__ = [
|
|
|
|
"Timeout",
|
|
|
|
]
|