`abx_spec_config`

Submodules

Package Contents

Classes

`ConfigPluginSpec`
`ExpectedPluginSpec`

Data

`__order__`
`PLUGIN_SPEC`
`TypedPluginManager`
`pm`

API

abx_spec_config.__order__[source]: 100

class abx_spec_config.ConfigPluginSpec[source]

static get_collection_config_path() → pathlib.Path[source]

static get_system_config_path() → pathlib.Path[source]

static get_CONFIG() → dict[abx.PluginId, BaseConfigSet | ConstantsDict][source]

static get_CONFIGS() → dict[abx.PluginId, BaseConfigSet | ConstantsDict][source]: Get the config for all plugins by plugin_id -> {plugin_abc: PluginABCConfigSet(), plugin_xyz: PluginXYZConfigSet(), …}

static get_FLAT_CONFIG() → dict[abx_spec_config.base_configset.ConfigKeyStr, Any][source]: Get the flat config assembled from all plugins config -> {SOME_KEY: ‘someval’, ‘OTHER_KEY’: ‘otherval’, …}

static get_SCOPE_CONFIG(extra=None, archiveresult=None, snapshot=None, crawl=None, user=None, request=None, collection=..., environment=..., machine=..., default=...) → dict[abx_spec_config.base_configset.ConfigKeyStr, Any][source]: Get the config as it applies to you right now, based on the current context

static get_request_config(request=None) → dict[source]

static get_archiveresult_config(archiveresult=None) → dict[abx_spec_config.base_configset.ConfigKeyStr, Any][source]

static get_snapshot_config(snapshot) → dict[abx_spec_config.base_configset.ConfigKeyStr, Any][source]

static get_crawl_config(crawl=None) → dict[abx_spec_config.base_configset.ConfigKeyStr, Any][source]

static get_user_config(user=None) → dict[abx_spec_config.base_configset.ConfigKeyStr, Any][source]

static get_collection_config(collection=...) → dict[abx_spec_config.base_configset.ConfigKeyStr, Any][source]

static get_environment_config(environment=...) → dict[abx_spec_config.base_configset.ConfigKeyStr, Any][source]

static get_machine_config(machine=...) → dict[source]

static get_default_config(default=...) → dict[abx_spec_config.base_configset.ConfigKeyStr, Any][source]

abx_spec_config.PLUGIN_SPEC[source]: None

class abx_spec_config.ExpectedPluginSpec[source]: Bases: abx_spec_config.ConfigPluginSpec

abx_spec_config.TypedPluginManager[source]: None

abx_spec_config.pm[source]: ‘cast(…)’