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
|
"""Test the EventManager class."""
from __future__ import annotations
from types import SimpleNamespace
from typing import TYPE_CHECKING
import pytest
from sphinx.errors import ExtensionError
from sphinx.events import EventManager
if TYPE_CHECKING:
from typing import NoReturn
from sphinx.application import Sphinx
def test_event_priority() -> None:
result = []
app = SimpleNamespace(pdb=False) # pass a dummy object as an app
events = EventManager(app) # type: ignore[arg-type]
events.connect('builder-inited', lambda app: result.append(1), priority=500)
events.connect('builder-inited', lambda app: result.append(2), priority=500)
# earlier
events.connect('builder-inited', lambda app: result.append(3), priority=200)
# later
events.connect('builder-inited', lambda app: result.append(4), priority=700)
events.connect('builder-inited', lambda app: result.append(5), priority=500)
events.emit('builder-inited')
assert result == [3, 1, 2, 5, 4]
def test_event_allowed_exceptions() -> None:
def raise_error(app: Sphinx) -> NoReturn:
raise RuntimeError
app = SimpleNamespace(pdb=False) # pass a dummy object as an app
events = EventManager(app) # type: ignore[arg-type]
events.connect('builder-inited', raise_error, priority=500)
# all errors are converted to ExtensionError
with pytest.raises(ExtensionError):
events.emit('builder-inited')
# Allow RuntimeError (pass-through)
with pytest.raises(RuntimeError):
events.emit('builder-inited', allowed_exceptions=(RuntimeError,))
def test_event_pdb() -> None:
def raise_error(app: Sphinx) -> NoReturn:
raise RuntimeError
app = SimpleNamespace(pdb=True) # pass a dummy object as an app
events = EventManager(app) # type: ignore[arg-type]
events.connect('builder-inited', raise_error, priority=500)
# errors aren't converted
with pytest.raises(RuntimeError):
events.emit('builder-inited')
# Allow RuntimeError (pass-through)
with pytest.raises(RuntimeError):
events.emit('builder-inited', allowed_exceptions=(RuntimeError,))
|
