Merge branch 'main' into fix-nested-cm

Author: ethanbb

.pre-commit-config.yaml

@@ -5,7 +5,7 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.6
+    rev: v2.3.0
     hooks:
       - id: codespell
         args: ["--write-changes"]
@@ -15,12 +15,12 @@ repos:
       - id: tox-ini-fmt
         args: ["-p", "fix"]
   - repo: https://github.com/tox-dev/pyproject-fmt
-    rev: "1.8.0"
+    rev: "2.1.3"
     hooks:
       - id: pyproject-fmt
         additional_dependencies: ["tox>=4.12.1"]
   - repo:  https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.4.1"
+    rev: "v0.4.8"
     hooks:
       - id: ruff-format
       - id: ruff

pyproject.toml

@@ -17,7 +17,9 @@ keywords = [
   "user",
 ]
 license = "Unlicense"
-maintainers = [{ name = "Bernát Gábor", email = "[email protected]" }]
+maintainers = [
+  { name = "Bernát Gábor", email = "[email protected]" },
+]
 requires-python = ">=3.8"
 classifiers = [
   "Development Status :: 5 - Production/Stable",
@@ -48,12 +50,13 @@ optional-dependencies.testing = [
   "coverage>=7.3.2",
   "diff-cover>=8.0.1",
   "pytest>=7.4.3",
+  "pytest-asyncio>=0.21",
   "pytest-cov>=4.1",
   "pytest-mock>=3.12",
   "pytest-timeout>=2.2",
 ]
 optional-dependencies.typing = [
-  'typing-extensions>=4.8; python_version < "3.11"',
+  "typing-extensions>=4.8; python_version<'3.11'",
 ]
 urls.Documentation = "https://py-filelock.readthedocs.io"
 urls.Homepage = "https://github.com/tox-dev/py-filelock"
@@ -62,39 +65,48 @@ urls.Tracker = "https://github.com/tox-dev/py-filelock/issues"
 
 [tool.hatch]
 build.hooks.vcs.version-file = "src/filelock/version.py"
-build.targets.sdist.include = ["/src", "/tests", "/tox.ini"]
+build.targets.sdist.include = [
+  "/src",
+  "/tests",
+  "/tox.ini",
+]
 version.source = "vcs"
 
 [tool.ruff]
-line-length = 120
 target-version = "py38"
-lint.isort = { known-first-party = ["filelock"], required-imports = ["from __future__ import annotations"] }
-lint.select = ["ALL"]
+line-length = 120
+format.preview = true
+format.docstring-code-line-length = 100
+format.docstring-code-format = true
+lint.select = [
+  "ALL",
+]
 lint.ignore = [
   "ANN101", # Missing type annotation for `self` in method
-  "D301",   #  Use `r"""` if any backslashes in a docstring
-  "D205",   # 1 blank line required between summary line and description
-  "D401",   # First line of docstring should be in imperative mood
+  "COM812", # Conflict with formatter
+  "CPY",    # No copyright statements
   "D203",   # `one-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible
+  "D205",   # 1 blank line required between summary line and description
   "D212",   # `multi-line-summary-first-line` (D212) and `multi-line-summary-second-line` (D213) are incompatible
-  "S104",   # Possible binding to all interface
-  "COM812", # Conflict with formatter
+  "D301",   #  Use `r"""` if any backslashes in a docstring
+  "D401",   # First line of docstring should be in imperative mood
   "ISC001", # Conflict with formatter
-  "CPY",    # No copyright statements
+  "S104",   # Possible binding to all interface
 ]
-lint.preview = true
-format.preview = true
-format.docstring-code-format = true
-format.docstring-code-line-length = 100
-[tool.ruff.lint.per-file-ignores]
-"tests/**/*.py" = [
-  "S101",    # asserts allowed in tests...
+lint.per-file-ignores."tests/**/*.py" = [
+  "D",       # don"t care about documentation in tests
   "FBT",     # don"t care about booleans as positional arguments in tests
   "INP001",  # no implicit namespace
-  "D",       # don"t care about documentation in tests
-  "S603",    # `subprocess` call: check for execution of untrusted input
   "PLR2004", # Magic value used in comparison, consider replacing with a constant variable
+  "S101",    # asserts allowed in tests...
+  "S603",    # `subprocess` call: check for execution of untrusted input
 ]
+lint.isort = { known-first-party = [
+  "filelock",
+], required-imports = [
+  "from __future__ import annotations",
+] }
+lint.preview = true
 
 [tool.codespell]
 builtin = "clear,usage,en-GB_to_en-US"
@@ -105,14 +117,31 @@ ignore-words-list = "master"
 [tool.coverage]
 html.show_contexts = true
 html.skip_covered = false
-paths.source = ["src", ".tox/*/lib/*/site-packages", ".tox\\*\\Lib\\site-packages", "**/src", "**\\src"]
-paths.other = [".", "*/filelock", "*\\filelock"]
+paths.source = [
+  "src",
+  ".tox/*/lib/*/site-packages",
+  ".tox\\*\\Lib\\site-packages",
+  "**/src",
+  "**\\src",
+]
+paths.other = [
+  ".",
+  "*/filelock",
+  "*\\filelock",
+]
 report.fail_under = 76
 run.parallel = true
-run.plugins = ["covdefaults"]
+run.plugins = [
+  "covdefaults",
+]
 
 [tool.mypy]
 python_version = "3.11"
 show_error_codes = true
 strict = true
-overrides = [{ module = ["appdirs.*", "jnius.*"], ignore_missing_imports = true }]
+overrides = [
+  { module = [
+    "appdirs.*",
+    "jnius.*",
+  ], ignore_missing_imports = true },
+]

src/filelock/__init__.py

@@ -17,6 +17,13 @@
 from ._soft import SoftFileLock
 from ._unix import UnixFileLock, has_fcntl
 from ._windows import WindowsFileLock
+from .asyncio import (
+    AsyncAcquireReturnProxy,
+    AsyncSoftFileLock,
+    AsyncUnixFileLock,
+    AsyncWindowsFileLock,
+    BaseAsyncFileLock,
+)
 from .version import version
 
 #: version of the project as a string
@@ -25,23 +32,34 @@
 
 if sys.platform == "win32":  # pragma: win32 cover
     _FileLock: type[BaseFileLock] = WindowsFileLock
+    _AsyncFileLock: type[BaseAsyncFileLock] = AsyncWindowsFileLock
 else:  # pragma: win32 no cover # noqa: PLR5501
     if has_fcntl:
         _FileLock: type[BaseFileLock] = UnixFileLock
+        _AsyncFileLock: type[BaseAsyncFileLock] = AsyncUnixFileLock
     else:
         _FileLock = SoftFileLock
+        _AsyncFileLock = AsyncSoftFileLock
         if warnings is not None:
             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",
+    "AsyncAcquireReturnProxy",
+    "AsyncFileLock",
+    "AsyncSoftFileLock",
+    "AsyncUnixFileLock",
+    "AsyncWindowsFileLock",
+    "BaseAsyncFileLock",
     "BaseFileLock",
     "FileLock",
     "SoftFileLock",

src/filelock/_api.py

@@ -91,7 +91,7 @@ def __new__(  # noqa: PLR0913
         *,
         blocking: bool = True,
         is_singleton: bool = False,
-        **kwargs: dict[str, Any],  # capture remaining kwargs for subclasses  # noqa: ARG003
+        **kwargs: Any,  # capture remaining kwargs for subclasses  # noqa: ARG003, ANN401
     ) -> Self:
         """Create a new lock object or if specified return the singleton instance for the lock file."""
         if not is_singleton: