yera.cli.context
CLI application context passed to every command.
Symbols
AppContext
Container passed to every CLI command as ctx.
settings is always populated (may be None when validation failed
and the command tolerates it).
credential_store and active_credential_group are only populated when the
command declares @requires(AppResource.SECRET_STORE); accessing them
without that declaration raises :class:RuntimeError.
Methods
AppContext.__init__
__init__(
settings: Settings | None,
console: Console | None = None,
error_console: Console | None = None,
) → NoneCtor for the AppContext class.
Parameters
Settings object to be populated with.
Console object to print to stdout with.
Console object to print to stderr with.
AppContext.require_active_credential_group
require_active_credential_group() → ResolvedCredentialGroupReturn the active credential group selected by the project.
Returns
The resolved active credential group.
Raises
If the project does not select a credential group.
If the command did not request credential resources.
AppContext.set_secret_store
set_secret_store(
secret_store: CredentialStoreBackend,
) → NonePopulate the protected secret-store boundary.
Parameters
Backend used for opaque credential values.
AppContext.set_provider_data
set_provider_data(
providers: Providers,
) → NonePopulate the provider configuration.
Parameters
Loaded provider configuration.
AppContext.set_profile_data
set_profile_data(
profiles: Profiles | None,
) → NonePopulate the profile configuration.
Parameters
Loaded profiles, or None when no profiles are
configured.
AppContext.require_profiles
require_profiles() → ProfilesReturn the configured profiles.
Returns
The loaded profile configuration.
Raises
If no profiles are configured.
If the command did not request profile resources.
AppContext.set_models_universe
set_models_universe(
models: ModelsUniverse,
) → NonePopulate the model catalogue.
Parameters
Loaded model universe.
AppContext.set_secret_store_data
set_secret_store_data(
secret_store: CredentialStoreBackend,
active_credential_group: ResolvedCredentialGroup | None,
) → NonePopulate the protected store and active credential group atomically.
Parameters
Backend used for credential groups and opaque values.
Group selected by the current project.