File size: 3,996 Bytes
a1af790 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 | """
A platform independent file lock that supports the with-statement.
.. autodata:: filelock.__version__
:no-value:
.. autodata:: filelock.OwnerMode
.. autodata:: filelock.CompromiseReason
"""
from __future__ import annotations
import sys
import warnings
from typing import TYPE_CHECKING, Final
from ._api import AcquireReturnProxy, BaseFileLock, CloseErrorPolicy, ContextErrorPolicy, LockOptions
from ._descriptor import lock_descriptor, unlock_descriptor
from ._error import LeaseSettingsMismatch, SoftFileLockLifetimeWarning, SoftFileLockProtocolError, Timeout
from ._lease import CompromiseReason, LeaseCompromise, SoftFileLease
from ._marker import MarkerSoftFileLock, OwnerMode, OwnerRecord
if TYPE_CHECKING:
from ._async_read_write import (
AsyncAcquireReadWriteReturnProxy,
AsyncReadWriteLock,
)
from ._read_write import ReadWriteLock
else:
try:
from ._async_read_write import AsyncAcquireReadWriteReturnProxy, AsyncReadWriteLock
from ._read_write import ReadWriteLock
except ImportError: # pragma: lacks sqlite3
AsyncAcquireReadWriteReturnProxy = None
AsyncReadWriteLock = None
ReadWriteLock = None
from ._soft import SoftFileLock
from ._soft_rw import AsyncAcquireSoftReadWriteReturnProxy, AsyncSoftReadWriteLock, SoftReadWriteLock
from ._strict import StrictSoftFileClaim, StrictSoftFileClaimState, StrictSoftFileLock
from ._unix import UnixFileLock
from ._unix import has_fcntl as _has_fcntl
from ._windows import WindowsFileLock
from .asyncio import (
AsyncAcquireReturnProxy,
AsyncSoftFileLease,
AsyncSoftFileLock,
AsyncStrictSoftFileLock,
AsyncUnixFileLock,
AsyncWindowsFileLock,
BaseAsyncFileLock,
)
# Keeps ``filelock.version`` the string 4.0.12 exposed rather than the submodule.
from .version import version
#: version of the project as a string
__version__: Final[str] = version
#: ``True`` when :func:`fcntl.flock` is available. Off Windows, :data:`FileLock` then resolves to
#: :class:`UnixFileLock`, otherwise to :class:`SoftFileLock`. Always ``False`` on Windows.
#:
#: :meta hide-value:
has_fcntl: Final[bool] = _has_fcntl
if sys.platform == "win32": # pragma: win32 cover
_FileLock: type[BaseFileLock] = WindowsFileLock
_AsyncFileLock: type[BaseAsyncFileLock] = AsyncWindowsFileLock
else: # pragma: win32 no cover # ruff:ignore[collapsible-else-if] # the else carries the win32 no-cover pragma
if has_fcntl:
_FileLock: type[BaseFileLock] = UnixFileLock
_AsyncFileLock: type[BaseAsyncFileLock] = AsyncUnixFileLock
else:
_FileLock = SoftFileLock
_AsyncFileLock = AsyncSoftFileLock
warnings.warn("only soft file lock is available", stacklevel=2)
if TYPE_CHECKING:
FileLock = SoftFileLock
AsyncFileLock = AsyncSoftFileLock
else:
#: Alias for the lock, which should be used for the current platform.
FileLock = _FileLock
AsyncFileLock = _AsyncFileLock
__all__ = [
"AcquireReturnProxy",
"AsyncAcquireReadWriteReturnProxy",
"AsyncAcquireReturnProxy",
"AsyncAcquireSoftReadWriteReturnProxy",
"AsyncFileLock",
"AsyncReadWriteLock",
"AsyncSoftFileLease",
"AsyncSoftFileLock",
"AsyncSoftReadWriteLock",
"AsyncStrictSoftFileLock",
"AsyncUnixFileLock",
"AsyncWindowsFileLock",
"BaseAsyncFileLock",
"BaseFileLock",
"CloseErrorPolicy",
"CompromiseReason",
"ContextErrorPolicy",
"FileLock",
"LeaseCompromise",
"LeaseSettingsMismatch",
"LockOptions",
"MarkerSoftFileLock",
"OwnerMode",
"OwnerRecord",
"ReadWriteLock",
"SoftFileLease",
"SoftFileLock",
"SoftFileLockLifetimeWarning",
"SoftFileLockProtocolError",
"SoftReadWriteLock",
"StrictSoftFileClaim",
"StrictSoftFileClaimState",
"StrictSoftFileLock",
"Timeout",
"UnixFileLock",
"WindowsFileLock",
"__version__",
"has_fcntl",
"lock_descriptor",
"unlock_descriptor",
]
|