tutor/docs/reference/api/hooks/index.rst

.. _hooks_api:

=========
Hooks API
=========

Types
=====

This is the Python documentation of the two types of hooks (actions and filters) as well as the contexts system which is used to instrument them. Understanding how Tutor hooks work is useful to create plugins that modify the behaviour of Tutor. However, plugin developers should almost certainly not import these hook types directly. Instead, use the reference :ref:`hooks catalog <hooks_catalog>`.

.. toctree::
   :maxdepth: 1

   actions
   filters
   contexts

Utilities
=========

Functions
---------

.. autofunction:: tutor.core.hooks::clear_all
.. autofunction:: tutor.hooks::lru_cache

Priorities
----------

.. automodule:: tutor.core.hooks.priorities
   :members: HIGH, DEFAULT, LOW
feat: refactor hooks API for simplification The hooks API had several issues which are summarized in this comment: https://github.com/openedx/wg-developer-experience/issues/125#issuecomment-1313553526 1. "consts" was a bad name 2. "hooks.filters" and "hooks.Filters" could easily be confused 3. docs made it difficult to understand that plugin developers should use the catalog To address these issues, we: 1. move "consts.py" to "catalog.py" 2. Remove "hooks.actions", "hooks.filters", "hooks.contexts" from the API. 3. re-organize the docs and give better usage examples in the catalog. This change is a partial fix for https://github.com/openedx/wg-developer-experience/issues/125 2023-01-06 19:02:17 +01:00			`.. _hooks_api:`

docs: extra hooks functions and utilities 2024-01-22 13:04:30 +01:00			`=========`
			`Hooks API`
			`=========`

			`Types`
			`=====`
feat: refactor hooks API for simplification The hooks API had several issues which are summarized in this comment: https://github.com/openedx/wg-developer-experience/issues/125#issuecomment-1313553526 1. "consts" was a bad name 2. "hooks.filters" and "hooks.Filters" could easily be confused 3. docs made it difficult to understand that plugin developers should use the catalog To address these issues, we: 1. move "consts.py" to "catalog.py" 2. Remove "hooks.actions", "hooks.filters", "hooks.contexts" from the API. 3. re-organize the docs and give better usage examples in the catalog. This change is a partial fix for https://github.com/openedx/wg-developer-experience/issues/125 2023-01-06 19:02:17 +01:00
			This is the Python documentation of the two types of hooks (actions and filters) as well as the contexts system which is used to instrument them. Understanding how Tutor hooks work is useful to create plugins that modify the behaviour of Tutor. However, plugin developers should almost certainly not import these hook types directly. Instead, use the reference :ref:`hooks catalog <hooks_catalog>`.
feat: migrate to plugins.v1 with filters & actions This is a very large refactoring which aims at making Tutor both more extendable and more generic. Historically, the Tutor plugin system was designed as an ad-hoc solution to allow developers to modify their own Open edX platforms without having to fork Tutor. The plugin API was simple, but limited, because of its ad-hoc nature. As a consequence, there were many things that plugin developers could not do, such as extending different parts of the CLI or adding custom template filters. Here, we refactor the whole codebase to make use of a generic plugin system. This system was inspired by the Wordpress plugin API and the Open edX "hooks and filters" API. The various components are added to a small core thanks to a set of actions and filters. Actions are callback functions that can be triggered at different points of the application lifecycle. Filters are functions that modify some data. Both actions and filters are collectively named as "hooks". Hooks can optionally be created within a certain context, which makes it easier to keep track of which application created which callback. This new hooks system allows us to provide a Python API that developers can use to extend their applications. The API reference is added to the documentation, along with a new plugin development tutorial. The plugin v0 API remains supported for backward compatibility of existing plugins. Done: - Do not load commands from plugins which are not enabled. - Load enabled plugins once on start. - Implement contexts for actions and filters, which allow us to keep track of the source of every hook. - Migrate patches - Migrate commands - Migrate plugin detection - Migrate templates_root - Migrate config - Migrate template environment globals and filters - Migrate hooks to tasks - Generate hook documentation - Generate patch reference documentation - Add the concept of action priority Close #499. 2022-02-07 18:11:43 +01:00
			`.. toctree::`
			`:maxdepth: 1`

			`actions`
			`filters`
			`contexts`
docs: extra hooks functions and utilities 2024-01-22 13:04:30 +01:00
			`Utilities`
			`=========`

			`Functions`
			`---------`

			`.. autofunction:: tutor.core.hooks::clear_all`
fix: save env on `plugins enable` Environment was not updated correctly on `tutor plugins enable ...` because of a caching issue. To bypass this issue, we improve the caching mechanism and introduce a new `lru_cache` decorator. Close #989. 2024-01-30 13:02:02 +01:00			`.. autofunction:: tutor.hooks::lru_cache`
docs: extra hooks functions and utilities 2024-01-22 13:04:30 +01:00
			`Priorities`
			`----------`

			`.. automodule:: tutor.core.hooks.priorities`
			`:members: HIGH, DEFAULT, LOW`