ConfigStorage#

class phalanx.storage.config.ConfigStorage(path)#

Bases: object

Analyze Phalanx configuration and convert it to models.

Parameters:: path (Path) – Path to the root of the Phalanx configuration.

Methods Summary

`load_environment`(environment_name)	Load the configuration of a Phalanx environment from disk.
`load_environment_config`(environment_name)	Load the top-level configuration for a Phalanx environment.
`load_phalanx_config`()	Load the full Phalanx configuration.

Methods Documentation

load_environment(environment_name)#

Load the configuration of a Phalanx environment from disk.

Parameters:: environment_name (str) – Name of the environment.
Returns:: Environment configuration.
Return type:: Environment
Raises:: UnknownEnvironmentError – Raised if the named environment has no configuration.

load_environment_config(environment_name)#

Load the top-level configuration for a Phalanx environment.

Unlike load_environment, this only loads the top-level environment configuration and its list of enabled applications. It does not load the configuration for all of the applications themselves.

Parameters:

environment_name (str) – Name of the environent.

Returns:

Loaded environment.

Return type:

Environment

Raises:

InvalidEnvironmentConfigError – Raised if the configuration for an environment is invalid.
UnknownEnvironmentError – Raised if the named environment has no configuration.

load_phalanx_config()#

Load the full Phalanx configuration.

Used primarily for generating docuemntation.

Returns:

Phalanx configuration for all environments.

Return type:

PhalanxConfig

Raises:

InvalidApplicationConfigError – Raised if the namespace for the application could not be found.
InvalidEnvironmentConfigError – Raised if the configuration for an environment is invalid.