Skip to content

bpo-30508: Don't log exceptions if Task/Future "cancel()" method called #2050

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.

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

Merged
merged 5 commits into from
Jun 11, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions Lib/asyncio/futures.py
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ def cancel(self):
change the future's state to cancelled, schedule the callbacks and
return True.
"""
self._log_traceback = False
if self._state != _PENDING:
return False
self._state = _CANCELLED
Expand Down
1 change: 1 addition & 0 deletions Lib/asyncio/tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ def cancel(self):
terminates with a CancelledError exception (even if cancel()
was not called).
"""
self._log_traceback = False
if self.done():
return False
if self._fut_waiter is not None:
Expand Down
8 changes: 8 additions & 0 deletions Lib/test/test_asyncio/test_futures.py
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,14 @@ def test_tb_logger_abandoned(self, m_log):
del fut
self.assertFalse(m_log.error.called)

@mock.patch('asyncio.base_events.logger')
def test_tb_logger_not_called_after_cancel(self, m_log):
fut = self._new_future(loop=self.loop)
fut.set_exception(Exception())
fut.cancel()
del fut
self.assertFalse(m_log.error.called)

@mock.patch('asyncio.base_events.logger')
def test_tb_logger_result_unretrieved(self, m_log):
fut = self._new_future(loop=self.loop)
Expand Down
19 changes: 19 additions & 0 deletions Lib/test/test_asyncio/test_tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -1864,6 +1864,25 @@ def kill_me(loop):
})
mock_handler.reset_mock()

@mock.patch('asyncio.base_events.logger')
def test_tb_logger_not_called_after_cancel(self, m_log):
loop = asyncio.new_event_loop()
self.set_event_loop(loop)

@asyncio.coroutine
def coro():
raise TypeError

@asyncio.coroutine
def runner():
task = self.new_task(loop, coro())
yield from asyncio.sleep(0.05, loop=loop)
task.cancel()
task = None

loop.run_until_complete(runner())
self.assertFalse(m_log.error.called)

@mock.patch('asyncio.coroutines.logger')
def test_coroutine_never_yielded(self, m_log):
with set_coroutine_debug(True):
Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,9 @@ Extension Modules
Library
-------

- bpo-30508: Don't log exceptions if Task/Future "cancel()" method was
called.

- bpo-11822: The dis.dis() function now is able to disassemble nested
code objects.

Expand Down
18 changes: 17 additions & 1 deletion Modules/_asynciomodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,8 @@ future_add_done_callback(FutureObj *fut, PyObject *arg)
static PyObject *
future_cancel(FutureObj *fut)
{
fut->fut_log_tb = 0;

if (fut->fut_state != STATE_PENDING) {
Py_RETURN_FALSE;
}
Expand Down Expand Up @@ -639,6 +641,17 @@ FutureObj_get_log_traceback(FutureObj *fut)
}
}

static int
FutureObj_set_log_traceback(FutureObj *fut, PyObject *val)
{
int is_true = PyObject_IsTrue(val);
if (is_true < 0) {
return -1;
}
fut->fut_log_tb = is_true;
return 0;
}

static PyObject *
FutureObj_get_loop(FutureObj *fut)
{
Expand Down Expand Up @@ -883,7 +896,8 @@ static PyMethodDef FutureType_methods[] = {
{"_callbacks", (getter)FutureObj_get_callbacks, NULL, NULL}, \
{"_result", (getter)FutureObj_get_result, NULL, NULL}, \
{"_exception", (getter)FutureObj_get_exception, NULL, NULL}, \
{"_log_traceback", (getter)FutureObj_get_log_traceback, NULL, NULL}, \
{"_log_traceback", (getter)FutureObj_get_log_traceback, \
(setter)FutureObj_set_log_traceback, NULL}, \
{"_source_traceback", (getter)FutureObj_get_source_traceback, NULL, NULL},

static PyGetSetDef FutureType_getsetlist[] = {
Expand Down Expand Up @@ -1569,6 +1583,8 @@ static PyObject *
_asyncio_Task_cancel_impl(TaskObj *self)
/*[clinic end generated code: output=6bfc0479da9d5757 input=13f9bf496695cb52]*/
{
self->task_log_tb = 0;

if (self->task_state != STATE_PENDING) {
Py_RETURN_FALSE;
}
Expand Down