SWAMPy

✎ CARVE FLESH

EDITING: __init__.py

"""
A platform independent file lock that supports the with-statement.

.. autodata:: filelock.__version__
   :no-value:

"""
from __future__ import annotations

import sys
import warnings

from ._api import AcquireReturnProxy, BaseFileLock
from ._error import Timeout
from ._soft import SoftFileLock
from ._unix import UnixFileLock, has_fcntl
from ._windows import WindowsFileLock
from .version import version

#: version of the project as a string
__version__: str = version

if sys.platform == "win32":  # pragma: win32 cover
    _FileLock: type[BaseFileLock] = WindowsFileLock
else:  # pragma: win32 no cover
    if has_fcntl:
        _FileLock: type[BaseFileLock] = UnixFileLock
    else:
        _FileLock = SoftFileLock
        if warnings is not None:
            warnings.warn("only soft file lock is available")

#: Alias for the lock, which should be used for the current platform. On Windows, this is an alias for
# :class:`WindowsFileLock`, on Unix for :class:`UnixFileLock` and otherwise for :class:`SoftFileLock`.
FileLock: type[BaseFileLock] = _FileLock

__all__ = [
    "__version__",
    "FileLock",
    "SoftFileLock",
    "Timeout",
    "UnixFileLock",
    "WindowsFileLock",
    "BaseFileLock",
    "AcquireReturnProxy",
]

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 __pycache__/	DIR	—	2025-02-17 05:50
📄 __init__.py	PY	1.2 KB	2021-12-26 17:13	EDIT
📄 _api.py	PY	8.2 KB	2021-12-26 17:13	EDIT
📄 _error.py	PY	399 B	2021-12-26 17:13	EDIT
📄 _soft.py	PY	1.6 KB	2021-12-26 17:13	EDIT
📄 _unix.py	PY	1.4 KB	2021-12-26 17:13	EDIT
📄 _util.py	PY	594 B	2021-12-26 17:13	EDIT
📄 _windows.py	PY	1.7 KB	2021-12-26 17:13	EDIT
📄 py.typed	TYPED	0 B	2021-12-26 17:13	EDIT
📄 version.py	PY	142 B	2021-12-26 17:13	EDIT