Skip to content

Commit

Permalink
bpo-32650 Add support for async generators and more test for coroutin…
Browse files Browse the repository at this point in the history
…es in pdb (#5403)
  • Loading branch information
pablogsal authored and 1st1 committed Jan 29, 2018
1 parent 4687702 commit c7ab581
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 7 deletions.
14 changes: 8 additions & 6 deletions Lib/bdb.py
Expand Up @@ -3,10 +3,12 @@
import fnmatch
import sys
import os
from inspect import CO_GENERATOR, CO_COROUTINE
from inspect import CO_GENERATOR, CO_COROUTINE, CO_ASYNC_GENERATOR

__all__ = ["BdbQuit", "Bdb", "Breakpoint"]

GENERATOR_AND_COROUTINE_FLAGS = CO_GENERATOR | CO_COROUTINE | CO_ASYNC_GENERATOR


class BdbQuit(Exception):
"""Exception to give up completely."""
Expand Down Expand Up @@ -127,7 +129,7 @@ def dispatch_call(self, frame, arg):
# No need to trace this function
return # None
# Ignore call events in generator except when stepping.
if self.stopframe and frame.f_code.co_flags & (CO_GENERATOR | CO_COROUTINE):
if self.stopframe and frame.f_code.co_flags & GENERATOR_AND_COROUTINE_FLAGS:
return self.trace_dispatch
self.user_call(frame, arg)
if self.quitting: raise BdbQuit
Expand All @@ -142,7 +144,7 @@ def dispatch_return(self, frame, arg):
"""
if self.stop_here(frame) or frame == self.returnframe:
# Ignore return events in generator except when stepping.
if self.stopframe and frame.f_code.co_flags & (CO_GENERATOR | CO_COROUTINE):
if self.stopframe and frame.f_code.co_flags & GENERATOR_AND_COROUTINE_FLAGS:
return self.trace_dispatch
try:
self.frame_returning = frame
Expand All @@ -166,7 +168,7 @@ def dispatch_exception(self, frame, arg):
# When stepping with next/until/return in a generator frame, skip
# the internal StopIteration exception (with no traceback)
# triggered by a subiterator run with the 'yield from' statement.
if not (frame.f_code.co_flags & (CO_GENERATOR | CO_COROUTINE)
if not (frame.f_code.co_flags & GENERATOR_AND_COROUTINE_FLAGS
and arg[0] is StopIteration and arg[2] is None):
self.user_exception(frame, arg)
if self.quitting: raise BdbQuit
Expand All @@ -175,7 +177,7 @@ def dispatch_exception(self, frame, arg):
# next/until command at the last statement in the generator before the
# exception.
elif (self.stopframe and frame is not self.stopframe
and self.stopframe.f_code.co_flags & (CO_GENERATOR | CO_COROUTINE)
and self.stopframe.f_code.co_flags & GENERATOR_AND_COROUTINE_FLAGS
and arg[0] in (StopIteration, GeneratorExit)):
self.user_exception(frame, arg)
if self.quitting: raise BdbQuit
Expand Down Expand Up @@ -309,7 +311,7 @@ def set_next(self, frame):

def set_return(self, frame):
"""Stop when returning from the given frame."""
if frame.f_code.co_flags & (CO_GENERATOR | CO_COROUTINE):
if frame.f_code.co_flags & GENERATOR_AND_COROUTINE_FLAGS:
self._set_stopinfo(frame, None, -1)
else:
self._set_stopinfo(frame.f_back, frame)
Expand Down
43 changes: 42 additions & 1 deletion Lib/test/test_pdb.py
Expand Up @@ -742,7 +742,7 @@ def test_pdb_next_command_for_coroutine():
... await test_coro()
>>> def test_function():
... loop = asyncio.get_event_loop()
... loop = asyncio.new_event_loop()
... loop.run_until_complete(test_main())
... loop.close()
... print("finished")
Expand Down Expand Up @@ -837,6 +837,47 @@ def test_pdb_return_command_for_generator():
finished
"""

def test_pdb_return_command_for_coroutine():
"""Testing no unwindng stack on yield for coroutines for "return" command
>>> import asyncio
>>> async def test_coro():
... await asyncio.sleep(0)
... await asyncio.sleep(0)
... await asyncio.sleep(0)
>>> async def test_main():
... import pdb; pdb.Pdb(nosigint=True, readrc=False).set_trace()
... await test_coro()
>>> def test_function():
... loop = asyncio.new_event_loop()
... loop.run_until_complete(test_main())
... loop.close()
... print("finished")
>>> with PdbTestInput(['step',
... 'step',
... 'next',
... 'continue']):
... test_function()
> <doctest test.test_pdb.test_pdb_return_command_for_coroutine[2]>(3)test_main()
-> await test_coro()
(Pdb) step
--Call--
> <doctest test.test_pdb.test_pdb_return_command_for_coroutine[1]>(1)test_coro()
-> async def test_coro():
(Pdb) step
> <doctest test.test_pdb.test_pdb_return_command_for_coroutine[1]>(2)test_coro()
-> await asyncio.sleep(0)
(Pdb) next
> <doctest test.test_pdb.test_pdb_return_command_for_coroutine[1]>(3)test_coro()
-> await asyncio.sleep(0)
(Pdb) continue
finished
"""

def test_pdb_until_command_for_generator():
"""Testing no unwindng stack on yield for generators
for "until" command if target breakpoing is not reached
Expand Down

0 comments on commit c7ab581

Please sign in to comment.