tutor/tutor/core/hooks/__init__.py

import typing as t

from .actions import Action
from .contexts import Context
from .filters import Filter


def clear_all(context: t.Optional[str] = None) -> None:
    """
    Clear both actions and filters.
    """
    Action.clear_all(context=context)
    Filter.clear_all(context=context)
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 18:02:17 +00:00			`import typing as t`

depr: templated hooks Templated hooks we almost completely useless, so we get rid of them. This allows us to get rid entirely of hook names and hook indexes, which makes the whole implementation much simpler. Hook removal (with `clear_all`) is achieved thanks to weak references. 2023-04-28 15:11:14 +00:00			`from .actions import Action`
			`from .contexts import Context`
			`from .filters import Filter`
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 18:02:17 +00:00

			`def clear_all(context: t.Optional[str] = None) -> None:`
			`"""`
			`Clear both actions and filters.`
			`"""`
depr: templated hooks Templated hooks we almost completely useless, so we get rid of them. This allows us to get rid entirely of hook names and hook indexes, which makes the whole implementation much simpler. Hook removal (with `clear_all`) is achieved thanks to weak references. 2023-04-28 15:11:14 +00:00			`Action.clear_all(context=context)`
			`Filter.clear_all(context=context)`