From: Tian Gao <gaogaotiantian@hotmail.com>
Date: Sat, 8 Feb 2025 23:35:28 +0000 (-0500)
Subject: Provide curframe_locals for backward compatibility but deprecate it (#125951)
X-Git-Tag: v3.14.0a5~37
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=29f8a67ae00081a36fdc97f2f2f96f971393a22a;p=thirdparty%2FPython%2Fcpython.git

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

diff --git a/Doc/whatsnew/3.14.rst b/Doc/whatsnew/3.14.rst
index ba7e8b42ef1f..23b1f5f2e0c6 100644
--- 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
index beef74d79225..4abf216b7737 100644
--- a/Lib/pdb.py
+++ b/Lib/pdb.py
@@ -90,6 +90,7 @@ import _colorize
 from contextlib import contextmanager
 from rlcompleter import Completer
 from types import CodeType
+from warnings import deprecated
 
 
 class Restart(Exception):
@@ -421,6 +422,16 @@ class Pdb(bdb.Bdb, cmd.Cmd):
             ]
             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
index 25b313f6c25a..749109805677 100644
--- a/Lib/test/test_pyclbr.py
+++ b/Lib/test/test_pyclbr.py
@@ -226,7 +226,7 @@ class PyclbrTest(TestCase):
         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
new file mode 100644
index 000000000000..31840da74a2d
--- /dev/null
+++ 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``