NoneType object is not iterable error when asyncio Server.close() called

[bitdancer]

BPO	22572
Nosy	@gvanrossum, @vstinner, @bitdancer, @1st1
Files	waiter_bug.py

^{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 2014-10-07.01:08:08.480>
created_at = <Date 2014-10-06.22:22:22.221>
labels = ['type-bug', 'invalid', 'expert-asyncio']
title = 'NoneType object is not iterable error when asyncio Server.close() called'
updated_at = <Date 2014-10-07.11:47:20.407>
user = 'https://github.com/bitdancer'

bugs.python.org fields:

activity = <Date 2014-10-07.11:47:20.407>
actor = 'r.david.murray'
assignee = 'none'
closed = True
closed_date = <Date 2014-10-07.01:08:08.480>
closer = 'r.david.murray'
components = ['asyncio']
creation = <Date 2014-10-06.22:22:22.221>
creator = 'r.david.murray'
dependencies = []
files = ['36830']
hgrepos = []
issue_num = 22572
keywords = []
message_count = 7.0
messages = ['228742', '228745', '228750', '228758', '228760', '228762', '228765']
nosy_count = 4.0
nosy_names = ['gvanrossum', 'vstinner', 'r.david.murray', 'yselivanov']
pr_nums = []
priority = 'normal'
resolution = 'not a bug'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue22572'
versions = ['Python 3.4', 'Python 3.5']

[bitdancer]

I'm writing a little web server using aiohttp. I tried to write a unit test...since this is a client server situation I launched the asyncio program in a thread and did a urlopen from the main thread. That all works fine...the problem is in the cleanup code. When I try to stop the server I created via create_server, I get the error in the title.

I've attached a stripped down version of my attempted unit test. It does require aiohttp...I'm not well enough versed in asyncio yet to rewrite it using more fundamental pieces.

I may be doing something stupid here, but it seems to me that even if I am close should not throw this error (the error implies that it is already shut down, so I'd think the close would be a no-op).

[1st1]

I think that the main problem is that '_stop_server' is called from a main thread (by unittest machinery via addCleanup), whereas the loop is in the other thread. asyncio code is not thread-safe in general.

If I change your code slightly to avoid using addCleanup, then everything works: https://gist.github.com/1st1/8dd0a2d4aa1ffd895c52

FWIW I couldn't reproduce the "NoneType object is not iterable" error. On my machine with python3.4.1 it crashes with another error "AssertionError: server did not stop" on line 35.

[bitdancer]

The 'Server did not stop' error was lying in wait for the NoneType bug to be fixed :) So, if you didn't the NoneType, my test case isn't reproducing the problem for you, which is odd. Using call_soon_threadsafe from an addCleanup in the _server method makes it work for me. (Seems to work even without the threadsafe, but I think I'll keep it!) Perhaps seeing the NoneType error is a timing issue, given that the problem is thread safety.

So, my apologies for the noise. I guess I'm too used to threads, where it is typical to call the close or stop method from another thread.

[vstinner]

Using call_soon_threadsafe from an addCleanup in the _server method makes it work for me.

Maybe the documentation on thread safety should be improved? More warnings should be put in the documentation?

https://docs.python.org/dev/library/asyncio-dev.html#concurrency-and-multithreading

[vstinner]

Maybe we should more checks in debug mode in the Server class? For example, loop.call_soon() raises an AssertionError if it is called from the "wrong" thread" in debug mode.

[vstinner]

Oh, I didn't notice that waiter_bug.py does nothing :-) I added "unittest.main()". With PYTHONASYNCIODEBUG=1, I get *two* errors, maybe we don't need to add more checks in debug mode.

Again, maybe the debug mode should be better documented?
https://docs.python.org/dev/library/asyncio-dev.html#debug-mode-of-asyncio

Currently, it's at the end of the documentation.

ERROR:asyncio:<CoroWrapper Server.wait_closed() running at /home/haypo/prog/python/default/Lib/asyncio/base_events.py:143, created at waiter_bug.py:32> was never yielded from
Coroutine object created at (most recent call last):
File "waiter_bug.py", line 43, in <module>
unittest.main()
File "/home/haypo/prog/python/default/Lib/unittest/main.py", line 93, in __init__
self.runTests()
File "/home/haypo/prog/python/default/Lib/unittest/main.py", line 244, in runTests
self.result = testRunner.run(self.test)
File "/home/haypo/prog/python/default/Lib/unittest/runner.py", line 168, in run
test(result)
File "/home/haypo/prog/python/default/Lib/unittest/suite.py", line 87, in __call__
return self.run(*args, **kwds)
File "/home/haypo/prog/python/default/Lib/unittest/suite.py", line 125, in run
test(result)
File "/home/haypo/prog/python/default/Lib/unittest/suite.py", line 87, in __call__
return self.run(*args, **kwds)
File "/home/haypo/prog/python/default/Lib/unittest/suite.py", line 125, in run
test(result)
File "/home/haypo/prog/python/default/Lib/unittest/case.py", line 625, in __call__
return self.run(*args, **kwds)
File "/home/haypo/prog/python/default/Lib/unittest/case.py", line 582, in run
self.doCleanups()
File "/home/haypo/prog/python/default/Lib/unittest/case.py", line 618, in doCleanups
function(*args, **kwargs)
File "waiter_bug.py", line 32, in _stop_server
self.server.wait_closed()
DEBUG:asyncio:Using selector: EpollSelector
E
======================================================================
ERROR: test_version (main.Test)
----------------------------------------------------------------------

Traceback (most recent call last):
  File "waiter_bug.py", line 33, in _stop_server
    self.server_loop.stop()
  File "/home/haypo/prog/python/default/Lib/asyncio/base_events.py", line 285, in stop
    self.call_soon(_raise_stop_error)
  File "/home/haypo/prog/python/default/Lib/asyncio/base_events.py", line 373, in call_soon
    handle = self._call_soon(callback, args, check_loop=True)
  File "/home/haypo/prog/python/default/Lib/asyncio/base_events.py", line 382, in _call_soon
    self._assert_is_current_event_loop()
  File "/home/haypo/prog/python/default/Lib/asyncio/base_events.py", line 404, in _assert_is_current_event_loop
    "Non-thread-safe operation invoked on an event loop other "
RuntimeError: Non-thread-safe operation invoked on an event loop other than the current one

[bitdancer]

Yes, documenting it at the beginning would be good. I haven't gotten to the end of the docs yet, I like to experiment as I go along :)