Add deprecation warnings to old stack trace functions

Author: living180

debug_toolbar/utils.py

@@ -2,6 +2,7 @@
 import linecache
 import os.path
 import sys
+import warnings
 from importlib import import_module
 from pprint import pformat
 
@@ -49,6 +50,15 @@ def omit_path(path):
     return any(path.startswith(hidden_path) for hidden_path in hidden_paths)
 
 
+def _stack_trace_deprecation_warning():
+    warnings.warn(
+        "get_stack() and tidy_stacktrace() are deprecated in favor of"
+        " get_stack_trace()",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+
+
 def tidy_stacktrace(stack):
     """
     Clean up stacktrace and remove all entries that are excluded by the
@@ -57,6 +67,8 @@ def tidy_stacktrace(stack):
     ``stack`` should be a list of frame tuples from ``inspect.stack()`` or
     ``debug_toolbar.utils.get_stack()``.
     """
+    _stack_trace_deprecation_warning()
+
     trace = []
     for frame, path, line_no, func_name, text in (f[:5] for f in stack):
         if omit_path(os.path.realpath(path)):
@@ -239,6 +251,8 @@ def get_stack(context=1):
 
     Modified version of ``inspect.stack()`` which calls our own ``getframeinfo()``
     """
+    _stack_trace_deprecation_warning()
+
     frame = sys._getframe(1)
     framelist = []
     while frame:

tests/test_utils.py

@@ -1,6 +1,11 @@
 import unittest
 
-from debug_toolbar.utils import get_name_from_obj, render_stacktrace
+from debug_toolbar.utils import (
+    get_name_from_obj,
+    get_stack,
+    render_stacktrace,
+    tidy_stacktrace,
+)
 
 
 class GetNameFromObjTestCase(unittest.TestCase):
@@ -47,3 +52,13 @@ def test_importlib_path_issue_1612(self):
             '<span class="djdt-file">&lt;frozen importlib._bootstrap&gt;</span> in',
             result,
         )
+
+
+class StackTraceTestCase(unittest.TestCase):
+    def test_deprecated_functions(self):
+        with self.assertWarns(DeprecationWarning):
+            stack = get_stack()
+        self.assertEqual(stack[0][1], __file__)
+        with self.assertWarns(DeprecationWarning):
+            stack_trace = tidy_stacktrace(reversed(stack))
+        self.assertEqual(stack_trace[-1][0], __file__)