Merge branch 'stacklevel' of github.com:jasongrout/ipywidgets into stacklevel

Author: jasongrout

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

@@ -1,22 +1,72 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
+import inspect
 import pytest
 
 from ..utils import deprecation
+from .utils import call_method
+
+PYTEST_PATH = inspect.getfile(pytest.Function)
+CALL_PATH = inspect.getfile(call_method)
 
 def test_deprecation():
-    with pytest.deprecated_call() as w:
+    with pytest.deprecated_call() as record:
         deprecation('Deprecated call')
-        # Make sure the deprecation pointed to the external function calling this test function
-        assert w[0].filename.endswith('_pytest/python.py')
+    # Make sure the deprecation pointed to the external function calling this test function
+    assert len(record) == 1
+    assert record[0].filename == PYTEST_PATH
 
-    with pytest.deprecated_call() as w:
+    with pytest.deprecated_call() as record:
         deprecation('Deprecated call', ['ipywidgets/widgets/tests'])
-        # Make sure the deprecation pointed to the external function calling this test function
-        assert w[0].filename.endswith('_pytest/python.py')
+    # Make sure the deprecation pointed to the external function calling this test function
+    assert len(record) == 1
+    assert record[0].filename == PYTEST_PATH
 
-    with pytest.deprecated_call() as w:
+    with pytest.deprecated_call() as record:
         deprecation('Deprecated call', 'ipywidgets/widgets/tests')
-        # Make sure the deprecation pointed to the external function calling this test function
-        assert w[0].filename.endswith('_pytest/python.py')
+    # Make sure the deprecation pointed to the external function calling this test function
+    assert len(record) == 1
+    assert record[0].filename == PYTEST_PATH
+
+    with pytest.deprecated_call() as record:
+        deprecation('Deprecated call', [])
+    # Make sure the deprecation pointed to *this* file
+    assert len(record) == 1
+    assert record[0].filename == __file__
+
+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 record[0].filename == CALL_PATH
+
+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", [CALL_PATH])
+    assert len(record) == 1
+    assert record[0].filename == __file__
+
+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__
+
+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/test_button.py renamed to python/ipywidgets/ipywidgets/widgets/tests/test_widget_button.py

@@ -1,9 +1,14 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
+import inspect
 import pytest
 from ipywidgets import Button
 
+PYTEST_PATH = inspect.getfile(pytest.Function)
+
 def test_deprecation_fa_icons():
-    with pytest.deprecated_call():
+    with pytest.deprecated_call() as record:
         Button(icon='fa-home')
+    assert len(record) == 1
+    assert record[0].filename == PYTEST_PATH

python/ipywidgets/ipywidgets/widgets/tests/test_widget_string.py

@@ -1,9 +1,15 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-from ..widget_string import Combobox, Text
+import inspect
 import pytest
 
+from ..widget_string import Combobox, Text
+
+
+PYTEST_PATH = inspect.getfile(pytest.Function)
+
+
 
 def test_combobox_creation_blank():
     w = Combobox()
@@ -34,18 +40,30 @@ def test_combobox_creation_kwargs():
         )
     assert w.ensure_option == True
 
-def test_deprecation_description_tooltip():
-    with pytest.deprecated_call():
-        Text(description_tooltip='tooltip')
-
-    with pytest.deprecated_call():
-        Text().description_tooltip
+def test_tooltip_deprecation():
+    with pytest.deprecated_call() as record:
+        w = Text(description_tooltip="testing")
+    assert len(record) == 1
+    assert record[0].filename == PYTEST_PATH
 
+    with pytest.deprecated_call() as record:
+        w.description_tooltip
+    assert len(record) == 1
+    assert record[0].filename == PYTEST_PATH
 
-    with pytest.deprecated_call():
-        Text().description_tooltip = 'tooltip'
+    with pytest.deprecated_call() as record:
+        w.description_tooltip == "testing"
+    assert len(record) == 1
+    assert record[0].filename == PYTEST_PATH
 
+    with pytest.deprecated_call() as record:
+        w.description_tooltip = "second value"
+    assert len(record) == 1
+    assert record[0].filename == PYTEST_PATH
+    assert w.tooltip == "second value"
 
-def test_deprecation_on_submit():
-    with pytest.deprecated_call():
+def test_on_submit_deprecation():
+    with pytest.deprecated_call() as record:
         Text().on_submit(lambda *args: ...)
+    assert len(record) == 1
+    assert record[0].filename == PYTEST_PATH

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,6 +1,7 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
+from pathlib import Path
 import sys
 import inspect
 import warnings
@@ -13,7 +14,7 @@
 # __init__ below, the appropriate stacklevel will change depending on how deep
 # the inheritance hierarchy is.
 def _external_stacklevel(internal):
-    """Find the first frame that doesn't any of the given internal strings
+    """Find the stacklevel of the first frame that doesn't contain any of the given internal strings
 
     The depth will be 1 at minimum in order to start checking at the caller of
     the function that called this utility method.
@@ -28,8 +29,11 @@ def _external_stacklevel(internal):
     else:
         frame = inspect.stack(context=0)[level].frame
 
+    # Normalize the path separators:
+    normalized_internal = [str(Path(s)) for s in internal]
+
     # climb the stack frames while we see internal frames
-    while frame and any(s in frame.f_code.co_filename for s in internal):
+    while frame and any(s in str(Path(frame.f_code.co_filename)) for s in normalized_internal):
         level +=1
         frame = frame.f_back