Add stacklevel to deprecation warnings for argument name change (#121)

Author: XuehaiPan

src/filelock/_api.py

@@ -111,6 +111,7 @@ def acquire(
         self,
         timeout: Optional[float] = None,
         poll_interval: float = 0.05,
+        *,
         poll_intervall: Optional[float] = None,
     ) -> AcquireReturnProxy:
         """
@@ -138,8 +139,8 @@ def acquire(
 
         .. versionchanged:: 2.0.0
 
-            This method returns now a *proxy* object instead of *self*, so that it can be used in a with statement \
-            without side effects.
+            This method returns now a *proxy* object instead of *self*,
+            so that it can be used in a with statement without side effects.
 
         """
         # Use the default timeout, if no timeout is provided.
@@ -148,7 +149,7 @@ def acquire(
 
         if poll_intervall is not None:
             msg = "use poll_interval instead of poll_intervall"
-            warnings.warn(msg, DeprecationWarning)
+            warnings.warn(msg, DeprecationWarning, stacklevel=2)
             poll_interval = poll_intervall
 
         # Increment the number right at the beginning. We can still undo it, if something fails.

tests/test_filelock.py

@@ -2,6 +2,7 @@
 import sys
 import threading
 from contextlib import contextmanager
+from inspect import getframeinfo, stack
 from pathlib import Path, PurePath
 from stat import S_IWGRP, S_IWOTH, S_IWUSR
 from types import TracebackType
@@ -357,5 +358,11 @@ def test_poll_intervall_deprecated(lock_type: Type[BaseFileLock], tmp_path: Path
     lock_path = tmp_path / "a"
     lock = lock_type(str(lock_path))
 
-    with pytest.deprecated_call(match="use poll_interval instead of poll_intervall"):
-        lock.acquire(poll_intervall=0.05)
+    with pytest.deprecated_call(match="use poll_interval instead of poll_intervall") as checker:
+        lock.acquire(poll_intervall=0.05)  # the deprecation warning will be captured by the checker
+        frameinfo = getframeinfo(stack()[0][0])  # get frameinfo of current file and lineno (+1 than the above lineno)
+        for warning in checker:
+            if warning.filename == frameinfo.filename and warning.lineno + 1 == frameinfo.lineno:  # pragma: no cover
+                break
+        else:  # pragma: no cover
+            pytest.fail("No warnings of stacklevel=2 matching.")

whitelist.txt

@@ -39,3 +39,7 @@ unlck
 util
 win32
 wronly
+stacklevel
+frameinfo
+getframeinfo
+lineno