mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-05-29 20:30:48 +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).
19 lines
882 B
ReStructuredText
19 lines
882 B
ReStructuredText
.. _actions:
|
|
|
|
=======
|
|
Actions
|
|
=======
|
|
|
|
Actions are one of the two types of hooks (the other being :ref:`filters`) that can be used to extend Tutor. Each action represents an event that can occur during the application life cycle. Each action has a name, and callback functions can be attached to it. When an action is triggered, these callback functions are called in sequence. Each callback function can trigger side effects, independently from one another.
|
|
|
|
.. autofunction:: tutor.hooks.actions::get
|
|
.. autofunction:: tutor.hooks.actions::get_template
|
|
.. autofunction:: tutor.hooks.actions::add
|
|
.. autofunction:: tutor.hooks.actions::do
|
|
.. autofunction:: tutor.hooks.actions::do_from_context
|
|
.. autofunction:: tutor.hooks.actions::clear
|
|
.. autofunction:: tutor.hooks.actions::clear_all
|
|
|
|
.. autoclass:: tutor.hooks.actions.Action
|
|
.. autoclass:: tutor.hooks.actions.ActionTemplate
|