yera.cli.context

CLI application context passed to every command.

Symbols

class AppContext — Container passed to every CLI command as ``ctx``.

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

__init__ — Ctor for the AppContext class.
require_active_credential_group — Return the active credential group selected by the project.
set_secret_store — Populate the protected secret-store boundary.
set_provider_data — Populate the provider configuration.
set_profile_data — Populate the profile configuration.
require_profiles — Return the configured profiles.
set_models_universe — Populate the model catalogue.
set_secret_store_data — Populate the protected store and active credential group atomically.

AppContext.__init__

__init__(
    settings: Settings | None,
    console: Console | None = None,
    error_console: Console | None = None,
) → None

Ctor for the AppContext class.

Parameters

settings
type: Settings | None

Settings object to be populated with.

console
type: Console | None = None

Console object to print to stdout with.

error_console
type: Console | None = None

Console object to print to stderr with.

AppContext.require_active_credential_group

require_active_credential_group() → ResolvedCredentialGroup

Return the active credential group selected by the project.

Returns

type: ResolvedCredentialGroup

The resolved active credential group.

Raises

CredentialGroupNotSpecifiedError

If the project does not select a credential group.

RuntimeError

If the command did not request credential resources.

AppContext.set_secret_store

set_secret_store(
    secret_store: CredentialStoreBackend,
) → None

Populate the protected secret-store boundary.

Parameters

secret_store
type: CredentialStoreBackend

Backend used for opaque credential values.

AppContext.set_provider_data

set_provider_data(
    providers: Providers,
) → None

Populate the provider configuration.

Parameters

providers
type: Providers

Loaded provider configuration.

AppContext.set_profile_data

set_profile_data(
    profiles: Profiles | None,
) → None

Populate the profile configuration.

Parameters

profiles
type: Profiles | None

Loaded profiles, or None when no profiles are configured.

AppContext.require_profiles

require_profiles() → Profiles

Return the configured profiles.

Returns

type: Profiles

The loaded profile configuration.

Raises

YeraError

If no profiles are configured.

RuntimeError

If the command did not request profile resources.

AppContext.set_models_universe

set_models_universe(
    models: ModelsUniverse,
) → None

Populate the model catalogue.

Parameters

models
type: ModelsUniverse

Loaded model universe.

AppContext.set_secret_store_data

set_secret_store_data(
    secret_store: CredentialStoreBackend,
    active_credential_group: ResolvedCredentialGroup | None,
) → None

Populate the protected store and active credential group atomically.

Parameters

secret_store
type: CredentialStoreBackend

Backend used for credential groups and opaque values.

active_credential_group
type: ResolvedCredentialGroup | None

Group selected by the current project.