weaver.config

Module Contents

weaver.config.LOGGER

class weaver.config.WeaverConfiguration

Configuration mode for which the Weaver instance should operate to provide different functionalities.

DEFAULT = 'DEFAULT'

ADES = 'ADES'

EMS = 'EMS'

HYBRID = 'HYBRID'

class weaver.config.WeaverFeature

Features enabled accordingly to different combinations of WeaverConfiguration modes.

REMOTE

QUOTING

weaver.config.WEAVER_DEFAULT_INI_CONFIG = 'weaver.ini'

weaver.config.WEAVER_DEFAULT_DATA_SOURCES_CONFIG = 'data_sources.yml'

weaver.config.WEAVER_DEFAULT_REQUEST_OPTIONS_CONFIG = 'request_options.yml'

weaver.config.WEAVER_DEFAULT_WPS_PROCESSES_CONFIG = 'wps_processes.yml'

weaver.config.WEAVER_DEFAULT_CONFIGS

weaver.config.get_weaver_configuration(container: weaver.typedefs.AnySettingsContainer) → str

Obtains the defined operation configuration mode.

Returns:

one value amongst weaver.config.WEAVER_CONFIGURATIONS.

weaver.config.get_weaver_config_file(file_path: str | None, default_config_file: str, generate_default_from_example: bool = True) → str

Validates that the specified configuration file can be found, or falls back to the default one.

Handles ‘relative’ paths for settings in WEAVER_DEFAULT_INI_CONFIG referring to other configuration files. Default file must be one of WEAVER_DEFAULT_CONFIGS.

If both the specified file and the default file cannot be found, default file under WEAVER_DEFAULT_INI_CONFIG is auto-generated from the corresponding .example file if generate_default_from_example is True. If it is False, an empty string is returned instead without generation since no existing file can be guaranteed, and it is up to the caller to handle this situation as it explicitly disabled generation.

Parameters:

• file_path – path to a configuration file (can be relative if resolvable or matching a default file name)

• default_config_file – one of WEAVER_DEFAULT_CONFIGS.

• generate_default_from_example – enable fallback copy of default configuration file from corresponding example.

Returns:

absolute path of the resolved file.

weaver.config.includeme(config: pyramid.config.Configurator) → None