Provide curframe_locals for backward compatibility but deprecate it (#125951)

gaogaotiantian · web-flow · commit 29f8a67ae000 · 2025-02-08T23:35:28.000Z
diff --git a/Doc/whatsnew/3.14.rst b/Doc/whatsnew/3.14.rst
@@ -932,6 +932,14 @@ Deprecated
   write new code.  The :mod:`subprocess` module is recommended instead.
   (Contributed by Victor Stinner in :gh:`120743`.)
 
+* :mod:`pdb`:
+  The undocumented ``pdb.Pdb.curframe_locals`` attribtue is now a deprecated
+  read-only property. The low overhead dynamic frame locals access added in
+  Python 3.13 by PEP 667 means the frame locals cache reference previously
+  stored in this attribute is no longer needed. Derived debuggers should access
+  ``pdb.Pdb.curframe.f_locals`` directly in Python 3.13 and later versions.
+  (Contributed by Tian Gao in :gh:`124369` and :gh:`125951`.)
+
 * :mod:`symtable`:
   Deprecate :meth:`symtable.Class.get_methods` due to the lack of interest.
   (Contributed by Bénédikt Tran in :gh:`119698`.)
diff --git a/Lib/pdb.py b/Lib/pdb.py
@@ -90,6 +90,7 @@
 from contextlib import contextmanager
 from rlcompleter import Completer
 from types import CodeType
+from warnings import deprecated
 
 
 class Restart(Exception):
@@ -421,6 +422,16 @@ def setup(self, f, tb):
             ]
             self.rcLines = []
 
+    @property
+    @deprecated("The frame locals reference is no longer cached. Use 'curframe.f_locals' instead.")
+    def curframe_locals(self):
+        return self.curframe.f_locals
+
+    @curframe_locals.setter
+    @deprecated("Setting 'curframe_locals' no longer has any effect. Update the contents of 'curframe.f_locals' instead.")
+    def curframe_locals(self, value):
+        pass
+
     # Override Bdb methods
 
     def user_call(self, frame, argument_list):
diff --git a/Lib/test/test_pyclbr.py b/Lib/test/test_pyclbr.py
@@ -226,7 +226,7 @@ def test_others(self):
         cm(
             'pdb',
             # pyclbr does not handle elegantly `typing` or properties
-            ignore=('Union', '_ModuleTarget', '_ScriptTarget', '_ZipTarget'),
+            ignore=('Union', '_ModuleTarget', '_ScriptTarget', '_ZipTarget', 'curframe_locals'),
         )
         cm('pydoc', ignore=('input', 'output',)) # properties
 
diff --git a/Misc/NEWS.d/next/Library/2024-11-23-21-17-28.gh-issue-124369.Z0hQFQ.rst b/Misc/NEWS.d/next/Library/2024-11-23-21-17-28.gh-issue-124369.Z0hQFQ.rst
@@ -0,0 +1 @@
+Deprecate ``pdb.Pdb.curframe_locals``

Original file line number	Diff line number	Diff line change
`@@ -226,7 +226,7 @@ def test_others(self):`
`226`	`226`	`cm(`
`227`	`227`	`'pdb',`
`228`	`228`	# pyclbr does not handle elegantly `typing` or properties
`229`		`- ignore=('Union', '_ModuleTarget', '_ScriptTarget', '_ZipTarget'),`
	`229`	`+ ignore=('Union', '_ModuleTarget', '_ScriptTarget', '_ZipTarget', 'curframe_locals'),`
`230`	`230`	`)`
`231`	`231`	`cm('pydoc', ignore=('input', 'output',)) # properties`
`232`	`232`