spines.config.core

Core configuration subpackage functionality.

class spines.config.core.Config(*args, **kwargs)[source]

Bases: spines.config.base.BaseConfig

Primary configuration class for spines.

add_plugin(plugin: Union[str, spines.config.core.PluginConfig], update: bool = False) → None[source]

Adds a plugin configuration to this config object

Parameters
  • plugin (str or PluginConfig) – Plugin to add to this configuration.

  • update (bool, optional) – Whether or not to update the existing plugin configuration with the new one or to replace it (default is False, replace).

plugins

Plugin configurations in this configuration.

Type

dict

remove_plugin(plugin: str) → Optional[spines.config.core.PluginConfig][source]

Removes a plugin configuration from this config object

Parameters

plugin (str) – Name of the plugin to remove.

Returns

The plugin configuration removed from this configuration.

Return type

PluginConfig

class spines.config.core.PluginConfig(name: str, *args, **kwargs)[source]

Bases: spines.config.base.BaseConfig

Plugin configuration class for spines.

name

Name of the plugin this configuration is for.

Type

str