Pdb raises exception when code is executed in a mapping that does not define `__contains__`

[pppery]

BPO	34782
Nosy	@serhiy-storchaka, @pppery, @tirkarthi, @scotchka, @iritkatriel
PRs	bpo-34782: Check locals is a mapping bdb.run* #11571 bpo-34782: Check locals is a mapping bdb.run* #11571 bpo-34782: Fix pdb failure when locals is an invalid mapping #27570

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2021-08-03.15:10:03.005>
created_at = <Date 2018-09-23.21:38:01.565>
labels = ['type-bug', '3.9', '3.10', '3.11', 'invalid', 'library']
title = 'Pdb raises exception when code is executed in a mapping that does not define `__contains__`'
updated_at = <Date 2021-08-03.15:10:03.004>
user = 'https://github.com/pppery'

bugs.python.org fields:

activity = <Date 2021-08-03.15:10:03.004>
actor = 'iritkatriel'
assignee = 'none'
closed = True
closed_date = <Date 2021-08-03.15:10:03.005>
closer = 'iritkatriel'
components = ['Library (Lib)']
creation = <Date 2018-09-23.21:38:01.565>
creator = 'ppperry'
dependencies = []
files = []
hgrepos = []
issue_num = 34782
keywords = ['patch', 'patch']
message_count = 10.0
messages = ['326186', '333763', '333781', '333785', '333812', '333813', '333833', '333988', '398830', '398831']
nosy_count = 5.0
nosy_names = ['serhiy.storchaka', 'ppperry', 'xtreak', 'scotchka', 'iritkatriel']
pr_nums = ['11571', '11571', '27570']
priority = 'normal'
resolution = 'not a bug'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue34782'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

[pppery]

class FakeContainer:
	def __getitem__(self, key)
		raise KeyError(key)
pdb.run("pass",{},FakeContainer())

Traceback (most recent call last):
  File "<pyshell#5>", line 1, in <module>
    pdb.run("pass",{},FakeContainer())
  File "C:\Program Files\Python37\lib\pdb.py", line 1590, in run
    Pdb().run(statement, globals, locals)
  File "C:\Program Files\Python37\lib\bdb.py", line 585, in run
    exec(cmd, globals, locals)
  File "<string>", line 1, in <module>
  File "<string>", line 1, in <module>
  File "C:\Program Files\Python37\lib\bdb.py", line 88, in trace_dispatch
    return self.dispatch_line(frame)
  File "C:\Program Files\Python37\lib\bdb.py", line 112, in dispatch_line
    self.user_line(frame)
  File "C:\Program Files\Python37\lib\pdb.py", line 261, in user_line
    self.interaction(frame, None)
  File "C:\Program Files\Python37\lib\pdb.py", line 351, in interaction
    self.print_stack_entry(self.stack[self.curindex])
  File "C:\Program Files\Python37\lib\pdb.py", line 1453, in print_stack_entry
    self.format_stack_entry(frame_lineno, prompt_prefix))
  File "C:\Program Files\Python37\lib\bdb.py", line 549, in format_stack_entry
    if '__args__' in frame.f_locals:
  File "<pyshell#3>", line 3, in __getitem__
    raise KeyError
KeyError: 0

Obviously, the debugger shouldn't crash in this case (running code outside of the debugger works as expected, producing a NameError on variable reads and a TypeError whenever a name is assigned).

[serhiy-storchaka]

There is no a crash. There is just an exception raised when you pass an inappropriate object as locals. This is an expected behavior, and I do not think that anything need to be changed.

[scotchka]

I agree that this behavior is normal, unless there is a use case for passing a partially implemented mapping object to pdb.run. However I cannot think of such a use case.

[pppery]

The thing is, though, that the same error occurs if a larger code being debugged calls exec or eval with such a mapping (`pdb.run("eval('1+1',{},FakeContainer())" also crashes with the same error), and the test suite contains code that evals other code in an incomplete mapping (test_var_annot_custom_maps in test_grammar)

[scotchka]

Hmm, the example works for me (Python 3.6.5):

>>> import pdb
>>> class FakeContainer:
...     def __getitem__(self, key):
...             raise KeyError(key)
...
>>> pdb.run("eval('1+1',{},FakeContainer())")
> <string>(1)<module>()
(Pdb) c
>>>

As for exec/eval accepting an incomplete mapping, that strikes me as a less than thorough checking on the part of exec/eval, perhaps for performance reasons(?)

[pppery]

You have to step into the eval for the error to be raised.

[serhiy-storchaka]

This looks to me like an error in the user code. What is the use case of passing an object that does not implement the mapping interface as locals to pdb.run()?

[scotchka]

An attempt to clarify the issue in my own mind:

def foo():
    # import pdb; pdb.set_trace()
    exec('pass', {}, FakeContainer())

This function runs successfully. But if you uncomment the pdb line and then step thru in the pdb console, there is an Exception.

I *think* the underlying principle is that code that runs normally should also run under pdb, which this example violates. However, to adhere to the principle 100% could be a very steep technical cost.

Alternatively, I'd argue that the function should NOT run even without pdb, since exec requires a (complete) mapping type according to the documentation. Perhaps the thing to do is to add more stringent type checking to exec and eval?