Update FileLock constructor to accept pathlib.Path (#110)

Co-authored-by: Bernát Gábor <[email protected]>

Author: f-koehler

docs/changelog.rst

@@ -1,6 +1,10 @@
 Changelog
 =========
 
+v3.3.2 (2021-10-29)
+-------------------
+- Accept path types (like ``pathlib.Path`` and ``pathlib.PurePath``) in the constructor for ``FileLock`` objects.
+
 v3.3.1 (2021-10-15)
 -------------------
 - Add changelog to the documentation :pr:`108` - by :user:`gaborbernat`

src/filelock/_api.py

@@ -1,9 +1,10 @@
 import logging
+import os
 import time
 from abc import ABC, abstractmethod
 from threading import Lock
 from types import TracebackType
-from typing import Optional, Type, Union
+from typing import Any, Optional, Type, Union
 
 from ._error import Timeout
 
@@ -34,7 +35,7 @@ def __exit__(
 class BaseFileLock(ABC):
     """Abstract base class for a file lock object."""
 
-    def __init__(self, lock_file: str, timeout: float = -1) -> None:
+    def __init__(self, lock_file: Union[str, "os.PathLike[Any]"], timeout: float = -1) -> None:
         """
         Create a new lock object.
 
@@ -44,7 +45,7 @@ def __init__(self, lock_file: str, timeout: float = -1) -> None:
          A timeout of 0 means, that there is exactly one attempt to acquire the file lock.
         """
         # The path to the lock file.
-        self._lock_file: str = lock_file
+        self._lock_file: str = os.fspath(lock_file)
 
         # The file descriptor for the *_lock_file* as it is returned by the os.open() function.
         # This file lock is only NOT None, if the object currently holds the lock.

tests/test_filelock.py

@@ -2,7 +2,7 @@
 import sys
 import threading
 from contextlib import contextmanager
-from pathlib import Path
+from pathlib import Path, PurePath
 from stat import S_IWGRP, S_IWOTH, S_IWUSR
 from types import TracebackType
 from typing import Callable, Iterator, Optional, Tuple, Type, Union
@@ -13,12 +13,25 @@
 from filelock import BaseFileLock, FileLock, SoftFileLock, Timeout
 
 
-@pytest.mark.parametrize("lock_type", [FileLock, SoftFileLock])
-def test_simple(lock_type: Type[BaseFileLock], tmp_path: Path, caplog: LogCaptureFixture) -> None:
+@pytest.mark.parametrize(
+    ("lock_type", "path_type"),
+    [
+        (FileLock, str),
+        (FileLock, PurePath),
+        (FileLock, Path),
+        (SoftFileLock, str),
+        (SoftFileLock, PurePath),
+        (SoftFileLock, Path),
+    ],
+)
+def test_simple(
+    lock_type: Type[BaseFileLock], path_type: Union[Type[str], Type[Path]], tmp_path: Path, caplog: LogCaptureFixture
+) -> None:
     caplog.set_level(logging.DEBUG)
-    lock_path = tmp_path / "a"
-    lock = lock_type(str(lock_path))
 
+    # test lock creation by passing a `str`
+    lock_path = tmp_path / "a"
+    lock = lock_type(path_type(lock_path))
     with lock as locked:
         assert lock.is_locked
         assert lock is locked

whitelist.txt

@@ -12,6 +12,7 @@ favicon
 fcntl
 filelock
 fmt
+fspath
 intersphinx
 intervall
 iwgrp