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
|
from . import __about__, constants, exceptions, portalocker
from .utils import (
BoundedSemaphore,
Lock,
RLock,
TemporaryFileLock,
open_atomic,
)
try: # pragma: no cover
from .redis import RedisLock
except ImportError: # pragma: no cover
RedisLock = None # type: ignore[assignment,misc]
#: The package name on Pypi
__package_name__ = __about__.__package_name__
#: Current author and maintainer, view the git history for the previous ones
__author__ = __about__.__author__
#: Current author's email address
__email__ = __about__.__email__
#: Version number
__version__ = '3.2.0'
#: Package description for Pypi
__description__ = __about__.__description__
#: Package homepage
__url__ = __about__.__url__
#: Exception thrown when the file is already locked by someone else
AlreadyLocked = exceptions.AlreadyLocked
#: Exception thrown if an error occurred during locking
LockException = exceptions.LockException
#: Lock a file. Note that this is an advisory lock on Linux/Unix systems
lock = portalocker.lock
#: Unlock a file
unlock = portalocker.unlock
#: Place an exclusive lock.
#: Only one process may hold an exclusive lock for a given file at a given
#: time.
LOCK_EX: constants.LockFlags = constants.LockFlags.EXCLUSIVE
#: Place a shared lock.
#: More than one process may hold a shared lock for a given file at a given
#: time.
LOCK_SH: constants.LockFlags = constants.LockFlags.SHARED
#: Acquire the lock in a non-blocking fashion.
LOCK_NB: constants.LockFlags = constants.LockFlags.NON_BLOCKING
#: Remove an existing lock held by this process.
LOCK_UN: constants.LockFlags = constants.LockFlags.UNBLOCK
#: Locking flags enum
LockFlags = constants.LockFlags
#: Locking utility class to automatically handle opening with timeouts and
#: context wrappers
__all__ = [
'LOCK_EX',
'LOCK_NB',
'LOCK_SH',
'LOCK_UN',
'AlreadyLocked',
'BoundedSemaphore',
'Lock',
'LockException',
'LockFlags',
'RLock',
'RedisLock',
'TemporaryFileLock',
'lock',
'open_atomic',
'unlock',
]
|
