proj_flow.api.ctx

The proj_flow.api.ctx provides tools for preparing the project template.

class proj_flow.api.ctx.Setting(json_key: str, prompt: str = '', value: str | bool | List[str] | Callable[[], str | bool | List[str]] | Callable[[Dict[str, str | bool]], str | bool | List[str]] = '', fix: str | None = None, force_fix: bool = False, project: str | None = None)

json_key: str

prompt: str = ''

value: str | bool | List[str] | Callable[[], str | bool | List[str]] | Callable[[Dict[str, str | bool]], str | bool | List[str]] = ''

fix: str | None = None

force_fix: bool = False

project: str | None = None

calc_value(previous: Dict[str, str | bool])

proj_flow.api.ctx.register_init_setting(*settings: Setting, is_hidden=False, project: str | None)

proj_flow.api.ctx.register_common_init_setting(*setting: Setting, is_hidden=False)

proj_flow.api.ctx.register_switch(key: str, prompt: str, enabled: bool, project: str | None)

proj_flow.api.ctx.register_common_switch(key: str, prompt: str, enabled: bool)

proj_flow.api.ctx.register_internal(key: str, value: Any)

proj_flow.api.ctx.move_to_front(preferred: str, values: Iterable[str | None])