Skip to content

gh-61448: Fix inspect.formatargvalues for deleted arguments #144854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RoryGlenn wants to merge 1 commit into
base: main
Choose a base branch
from
+35 −3
Open

gh-61448: Fix inspect.formatargvalues for deleted arguments #144854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions Lib/inspect.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1385,6 +1385,16 @@ def _formatannotation(annotation):
return _formatannotation


class _Deleted:
"""Sentinel for arguments that are no longer bound in the frame locals."""
__slots__ = ()
def __repr__(self):
return '<deleted>'

_DELETED = _Deleted()
del _Deleted


def formatargvalues(args, varargs, varkw, locals,
formatarg=str,
formatvarargs=lambda name: '*' + name,
Expand All @@ -1398,14 +1408,14 @@ def formatargvalues(args, varargs, varkw, locals,
argument is an optional function to format the sequence of arguments."""
def convert(name, locals=locals,
formatarg=formatarg, formatvalue=formatvalue):
return formatarg(name) + formatvalue(locals[name])
return formatarg(name) + formatvalue(locals.get(name, _DELETED))
specs = []
for i in range(len(args)):
specs.append(convert(args[i]))
if varargs:
specs.append(formatvarargs(varargs) + formatvalue(locals[varargs]))
specs.append(formatvarargs(varargs) + formatvalue(locals.get(varargs, _DELETED)))
if varkw:
specs.append(formatvarkw(varkw) + formatvalue(locals[varkw]))
specs.append(formatvarkw(varkw) + formatvalue(locals.get(varkw, _DELETED)))
return '(' + ', '.join(specs) + ')'

def _missing_arguments(f_name, argnames, pos, values):
Expand Down
19 changes: 19 additions & 0 deletions Lib/test/test_inspect/test_inspect.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,25 @@ def test_frame(self):
self.assertEqual(inspect.formatargvalues(args, varargs, varkw, locals),
'(x=11, y=14)')

def test_formatargvalues_deleted_args(self):
# gh-61448: formatargvalues should not raise KeyError when
# argument names are no longer bound in the frame locals.
def fun(a, b, x, y):
del b, y
return inspect.currentframe()

result = inspect.formatargvalues(*inspect.getargvalues(fun(2, 4, 8, 16)))
self.assertEqual(result, '(a=2, b=<deleted>, x=8, y=<deleted>)')

def test_formatargvalues_deleted_varargs_varkw(self):
# gh-61448: formatargvalues should handle deleted *args and **kwargs.
def fun(a, *args, **kwargs):
del args, kwargs
return inspect.currentframe()

result = inspect.formatargvalues(*inspect.getargvalues(fun(1, 2, k=3)))
self.assertEqual(result, '(a=1, *args=<deleted>, **kwargs=<deleted>)')

def test_previous_frame(self):
args, varargs, varkw, locals = inspect.getargvalues(mod.fr.f_back)
self.assertEqual(args, ['a', 'b', 'c', 'd', 'e', 'f'])
Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Library/2026-02-15-22-53-30.gh-issue-61448.OmH86g.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Fix :func:`inspect.formatargvalues` to handle deleted arguments gracefully
instead of raising :exc:`KeyError`. When an argument is no longer bound in
the frame locals (e.g. after ``del``), it is now shown as ``<deleted>``.
Loading