Table of Contents

Class: ISettingLoader ./src/peak/config/interfaces.py

Callable used to load configuration data

Base Classes   
Interface
Methods   
__call__
  __call__ 
__call__ (
        propertyMap,
        *args,
        *kw,
        )

Load settings into propertyMap

Loading functions can require whatever arguments are useful or desired. The value of each "Load Settings From" config file entry will be interpreted as part of a call to the loader. For example, this entry:

            [Load Settings From]
            mapping = importString('os.environ'), prefix='environ.*'

will be interpereted as:

            loader(propertyMap, importString('os.environ'), prefix='environ.*')

So it's up to the author of the loader to choose and document the arguments to be used in configuration files.

However, one keyword argument which all ISettingLoader functions must accept is includedFrom. This is an implementation-defined object which represents the state of the ISettingLoader which is the caller. Currently, this argument is only supplied by the default config.loadConfigFile() loader, and the value passed is a ConfigReader instance.


Table of Contents

This document was automatically generated on Mon May 6 01:11:03 2024 by HappyDoc version 2.1