1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
|
# -*- coding: utf-8 -*-
from collections import OrderedDict
from pickle import dumps, loads
from unittest.mock import Mock
from pytest import raises
from pyee import EventEmitter
class PyeeTestException(Exception):
pass
def test_emit_sync():
"""Basic synchronous emission works"""
call_me = Mock()
ee = EventEmitter()
@ee.on("event")
def event_handler(data, **kwargs):
call_me()
assert data == "emitter is emitted!"
assert ee.event_names() == {"event"}
# Making sure data is passed propers
ee.emit("event", "emitter is emitted!", error=False)
call_me.assert_called_once()
def test_emit_error():
"""Errors raise with no event handler, otherwise emit on handler"""
call_me = Mock()
ee = EventEmitter()
test_exception = PyeeTestException("lololol")
with raises(PyeeTestException):
ee.emit("error", test_exception)
@ee.on("error")
def on_error(exc):
call_me()
assert ee.event_names() == {"error"}
# No longer raises and error instead return True indicating handled
assert ee.emit("error", test_exception) is True
call_me.assert_called_once()
def test_emit_return():
"""Emit returns True when handlers are registered on an event, and false
otherwise.
"""
call_me = Mock()
ee = EventEmitter()
assert ee.event_names() == set()
# make sure emitting without a callback returns False
assert not ee.emit("data")
# add a callback
ee.on("data")(call_me)
# should return True now
assert ee.emit("data")
def test_new_listener_event():
"""The 'new_listener' event fires whenever a new listener is added."""
call_me = Mock()
ee = EventEmitter()
ee.on("new_listener", call_me)
# Should fire new_listener event
@ee.on("event")
def event_handler(data):
pass
assert ee.event_names() == {"new_listener", "event"}
call_me.assert_called_once_with("event", event_handler)
def test_listener_removal():
"""Removing listeners removes the correct listener from an event."""
ee = EventEmitter()
# Some functions to pass to the EE
def first():
return 1
ee.on("event", first)
@ee.on("event")
def second():
return 2
@ee.on("event")
def third():
return 3
def fourth():
return 4
ee.on("event", fourth)
assert ee.event_names() == {"event"}
assert ee._events["event"] == OrderedDict(
[(first, first), (second, second), (third, third), (fourth, fourth)]
)
ee.remove_listener("event", second)
assert ee._events["event"] == OrderedDict(
[(first, first), (third, third), (fourth, fourth)]
)
ee.remove_listener("event", first)
assert ee._events["event"] == OrderedDict([(third, third), (fourth, fourth)])
ee.remove_all_listeners("event")
assert "event" not in ee._events["event"]
def test_listener_removal_on_emit():
"""Test that a listener removed during an emit is called inside the current
emit cycle.
"""
call_me = Mock()
ee = EventEmitter()
def should_remove():
ee.remove_listener("remove", call_me)
ee.on("remove", should_remove)
ee.on("remove", call_me)
assert ee.event_names() == {"remove"}
ee.emit("remove")
call_me.assert_called_once()
call_me.reset_mock()
# Also test with the listeners added in the opposite order
ee = EventEmitter()
ee.on("remove", call_me)
ee.on("remove", should_remove)
assert ee.event_names() == {"remove"}
ee.emit("remove")
call_me.assert_called_once()
def test_once():
"""Test that `once()` method works propers."""
# very similar to "test_emit" but also makes sure that the event
# gets removed afterwards
call_me = Mock()
ee = EventEmitter()
def once_handler(data):
assert data == "emitter is emitted!"
call_me()
# Tests to make sure that after event is emitted that it's gone.
ee.once("event", once_handler)
assert ee.event_names() == {"event"}
ee.emit("event", "emitter is emitted!")
call_me.assert_called_once()
assert ee.event_names() == set()
assert "event" not in ee._events
def test_once_removal():
"""Removal of once functions works"""
ee = EventEmitter()
def once_handler(data):
pass
handle = ee.once("event", once_handler)
assert handle == once_handler
assert ee.event_names() == {"event"}
ee.remove_listener("event", handle)
assert "event" not in ee._events
assert ee.event_names() == set()
def test_listeners():
"""`listeners()` returns a copied list of listeners."""
call_me = Mock()
ee = EventEmitter()
@ee.on("event")
def event_handler():
pass
@ee.once("event")
def once_handler():
pass
listeners = ee.listeners("event")
assert listeners[0] == event_handler
assert listeners[1] == once_handler
# listeners is a copy, you can't mutate the innards this way
listeners[0] = call_me
ee.emit("event")
call_me.assert_not_called()
def test_listeners_does_work_with_unknown_listeners():
"""`listeners()` should not throw."""
ee = EventEmitter()
listeners = ee.listeners("event")
assert listeners == []
def test_properties_preserved():
"""Test that the properties of decorated functions are preserved."""
call_me = Mock()
call_me_also = Mock()
ee = EventEmitter()
@ee.on("always")
def always_event_handler():
"""An event handler."""
call_me()
@ee.once("once")
def once_event_handler():
"""Another event handler."""
call_me_also()
assert always_event_handler.__doc__ == "An event handler."
assert once_event_handler.__doc__ == "Another event handler."
always_event_handler()
call_me.assert_called_once()
once_event_handler()
call_me_also.assert_called_once()
call_me_also.reset_mock()
# Calling the event handler directly doesn't clear the handler
ee.emit("once")
call_me_also.assert_called_once()
def test_if_serializable():
"""`pickle`ing should not throw."""
ee = EventEmitter()
ee_copy = loads(dumps(ee))
assert ee._lock
assert ee_copy._lock
|