feat: add CONFIG INTERACTIVE action

New hook Action that allows tutor plugins to interact with the configuration at the time of the interactive questionnaire that happens during `tutor local/dev launch`.
This commit is contained in:
Alejandro Cardenas 2023-12-15 04:31:35 -05:00 committed by GitHub
parent c51d02a8af
commit afb85aaab6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 1 deletions

View File

@ -0,0 +1 @@
- [Feature] add `CONFIG_INTERACTIVE` action that allows tutor plugins to interact with the configuration at the time of the interactive questionnaire that happens during tutor local launch. (by @Alec4r).

View File

@ -57,6 +57,12 @@ class Actions:
#: :parameter str name: docker-compose project name.
COMPOSE_PROJECT_STARTED: Action[[str, Config, str]] = Action()
#: Triggered after all interactive questions have been asked.
#: You should use this action if you want to add new questions.
#:
#: :parameter dict config: project configuration.
CONFIG_INTERACTIVE: Action[[Config]] = Action()
#: This action is called at the end of the tutor.config.load_full function.
#: Modifying this object will not trigger changes in the configuration.
#: For all purposes, it should be considered read-only.

View File

@ -3,7 +3,7 @@ from typing import List, Optional
import click
from . import config as tutor_config
from . import env, exceptions, fmt
from . import env, exceptions, fmt, hooks
from .types import Config, get_typed
@ -149,6 +149,8 @@ def ask_questions(config: Config, run_for_prod: Optional[bool] = None) -> None:
defaults,
)
hooks.Actions.CONFIG_INTERACTIVE.do(config)
def ask(question: str, key: str, config: Config, defaults: Config) -> None:
default = get_typed(defaults, key, str)