Add tests and fix level

Author: vidartf

python/ipywidgets/ipywidgets/widgets/tests/test_utils.py

@@ -0,0 +1,56 @@
+
+from pathlib import Path
+from unittest.mock import patch
+
+import pytest
+
+from ipywidgets.widgets.utils import deprecation
+from ipywidgets.widgets.tests.utils import call_method
+
+@patch("ipywidgets.widgets.utils._IPYWIDGETS_INTERNAL", [])
+def test_deprecation_direct():
+    with pytest.warns(DeprecationWarning) as record:
+        deprecation("test message")
+    assert len(record) == 1
+    assert record[0].filename == __file__
+
+@patch("ipywidgets.widgets.utils._IPYWIDGETS_INTERNAL", [])
+def test_deprecation_indirect():
+    # If the line that calls "deprecation" is not internal, it is considered the source:
+    with pytest.warns(DeprecationWarning) as record:
+        call_method(deprecation, "test message")
+    assert len(record) == 1
+    assert Path(record[0].filename) == Path(__file__, '..', 'utils.py').resolve()
+
+@patch("ipywidgets.widgets.utils._IPYWIDGETS_INTERNAL", [str(Path(__file__, '..', 'utils.py').resolve())])
+def test_deprecation_indirect_internal():
+    # If the line that calls "deprecation" is internal, it is not considered the source:
+    with pytest.warns(DeprecationWarning) as record:
+        call_method(deprecation, "test message")
+    assert len(record) == 1
+    assert record[0].filename == __file__
+
+@patch("ipywidgets.widgets.utils._IPYWIDGETS_INTERNAL", [])
+def test_deprecation_nested1():
+    def level1():
+        deprecation("test message")
+
+    with pytest.warns(DeprecationWarning) as record:
+        call_method(level1)
+
+    assert len(record) == 1
+    assert record[0].filename == __file__
+
+@patch("ipywidgets.widgets.utils._IPYWIDGETS_INTERNAL", [])
+def test_deprecation_nested2():
+    def level2():
+        deprecation("test message")
+    def level1():
+        level2()
+
+    with pytest.warns(DeprecationWarning) as record:
+        call_method(level1)
+
+    assert len(record) == 1
+    assert record[0].filename == __file__
+

python/ipywidgets/ipywidgets/widgets/tests/utils.py

@@ -45,3 +45,6 @@ def setup():
 
 def teardown():
     teardown_test_comm()
+
+def call_method(method, *args, **kwargs):
+    method(*args, **kwargs)

python/ipywidgets/ipywidgets/widgets/utils.py

@@ -1,9 +1,12 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
+from pathlib import Path
 import sys
 import warnings
 
+_IPYWIDGETS_INTERNAL = ['ipywidgets/widgets/']
+
 # This function is from https://github.com/python/cpython/issues/67998
 # (https://bugs.python.org/file39550/deprecated_module_stacklevel.diff) and
 # calculates the appropriate stacklevel for deprecations to target the
@@ -20,19 +23,20 @@ def _external_stacklevel(internal):
     # Get the level of my caller's caller
     level = 2
     frame = sys._getframe(level)
-    while frame and any(s in frame.f_code.co_filename for s in internal):
+    # Normalize the path separators:
+    while frame and any(str(Path(s)) in str(Path(frame.f_code.co_filename)) for s in internal):
         level +=1
         frame = frame.f_back
     # the returned value will be used one level up from here, so subtract one
-    return level-1
+    return level
 
 def deprecation(message, internal=None):
     """Generate a deprecation warning targeting the first frame outside the ipywidgets library.
-    
+
     internal is a list of strings, which if they appear in filenames in the
     frames, the frames will also be considered internal. This can be useful if we know that ipywidgets
     is calling out to, for example, traitlets internally.
     """
     if internal is None:
         internal = []
-    warnings.warn(message, DeprecationWarning, stacklevel=_external_stacklevel(internal+['ipywidgets/widgets/']))
+    warnings.warn(message, DeprecationWarning, stacklevel=_external_stacklevel(internal + _IPYWIDGETS_INTERNAL))