Allow pass an exception to the Event.set method

[pfreixes]

BPO	30490
Nosy	@1st1, @pfreixes
PRs	bpo-30490: Allow to the Event.set method pass an exception #1824

^{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 2017-07-19.20:48:00.009>
created_at = <Date 2017-05-26.20:59:34.365>
labels = ['3.7', 'expert-asyncio']
title = 'Allow pass an exception to the Event.set method'
updated_at = <Date 2017-07-19.20:48:00.007>
user = 'https://github.com/pfreixes'

bugs.python.org fields:

activity = <Date 2017-07-19.20:48:00.007>
actor = 'pfreixes'
assignee = 'none'
closed = True
closed_date = <Date 2017-07-19.20:48:00.009>
closer = 'pfreixes'
components = ['asyncio']
creation = <Date 2017-05-26.20:59:34.365>
creator = 'pfreixes'
dependencies = []
files = []
hgrepos = []
issue_num = 30490
keywords = []
message_count = 2.0
messages = ['294572', '298688']
nosy_count = 2.0
nosy_names = ['yselivanov', 'pfreixes']
pr_nums = ['1824']
priority = 'normal'
resolution = 'rejected'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue30490'
versions = ['Python 3.7']

[pfreixes]

Having the Event as the way to synchronize 1:N coroutines, the none happy path should be able to be expressed making possible call the set_exception for each future related to each waiter.

As an example the following code trying to implement a way to avoid the dogpile effect for a DNS cache. If the coro that holds the event fails, the original exception is also broadcasted to the waiters.

if key in throttle_dns_events:
    yield from throttle_dns_events[key].wait()
else:
    throttle_dns_events[key] = Event(loop=loop)
    try:
        addrs = yield from \
            resolver.resolve(host, port, family=family)
        cached_hosts.add(key, addrs)
        throttle_dns_events[key].set()
    except Exception as e:
        # any DNS exception, independently of the implementation
        # is set for the waiters to raise the same exception.
        throttle_dns_events[key].set(exc=e)
        raise
    finally:
        throttle_dns_events.pop(key)

[pfreixes]

More info about why here #1824 (comment)