mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-09-28 04:09:01 +00:00
33e4f33afe
Now that the mypy bugs have been resolved, we are able to define more precisely and cleanly the types of Actions and Filters. Moreover, can now strongly type named actions and hooks (in consts.py). With such a strong typing, we get early alerts of hooks called with incorrect arguments, which is nothing short of awesome :) This change breaks the hooks API by removing the `context=...` argument. The reason for that is that we cannot insert arbitrary arguments between `P.args, P.kwargs`: https://peps.python.org/pep-0612/#the-components-of-a-paramspec > A function declared as def inner(a: A, b: B, *args: P.args, **kwargs: > P.kwargs) -> R has type Callable[Concatenate[A, B, P], R]. Placing > keyword-only parameters between the *args and **kwargs is forbidden. Getting the documentation to build in nitpicky mode is quite difficult... We need to add `nitpick_ignore` to the docs conf.py, otherwise sphinx complains about many missing class references. This, despite upgrading almost all doc requirements (except docutils).
60 lines
1.8 KiB
Python
60 lines
1.8 KiB
Python
import typing as t
|
|
import unittest
|
|
|
|
from tutor import hooks
|
|
|
|
|
|
class PluginActionsTests(unittest.TestCase):
|
|
def setUp(self) -> None:
|
|
self.side_effect_int = 0
|
|
|
|
def tearDown(self) -> None:
|
|
super().tearDown()
|
|
hooks.actions.clear_all(context="tests")
|
|
|
|
def run(self, result: t.Any = None) -> t.Any:
|
|
with hooks.contexts.enter("tests"):
|
|
return super().run(result=result)
|
|
|
|
def test_do(self) -> None:
|
|
action: hooks.actions.Action[int] = hooks.actions.get("test-action")
|
|
|
|
@action.add()
|
|
def _test_action_1(increment: int) -> None:
|
|
self.side_effect_int += increment
|
|
|
|
@action.add()
|
|
def _test_action_2(increment: int) -> None:
|
|
self.side_effect_int += increment * 2
|
|
|
|
action.do(1)
|
|
self.assertEqual(3, self.side_effect_int)
|
|
|
|
def test_priority(self) -> None:
|
|
@hooks.actions.add("test-action", priority=2)
|
|
def _test_action_1() -> None:
|
|
self.side_effect_int += 4
|
|
|
|
@hooks.actions.add("test-action", priority=1)
|
|
def _test_action_2() -> None:
|
|
self.side_effect_int = self.side_effect_int // 2
|
|
|
|
# Action 2 must be performed before action 1
|
|
self.side_effect_int = 4
|
|
hooks.actions.do("test-action")
|
|
self.assertEqual(6, self.side_effect_int)
|
|
|
|
def test_equal_priority(self) -> None:
|
|
@hooks.actions.add("test-action", priority=2)
|
|
def _test_action_1() -> None:
|
|
self.side_effect_int += 4
|
|
|
|
@hooks.actions.add("test-action", priority=2)
|
|
def _test_action_2() -> None:
|
|
self.side_effect_int = self.side_effect_int // 2
|
|
|
|
# Action 2 must be performed after action 1
|
|
self.side_effect_int = 4
|
|
hooks.actions.do("test-action")
|
|
self.assertEqual(4, self.side_effect_int)
|