pymlconf Package

config_manager Module

class pymlconf.config_manager.ConfigManager(init_value=None, dirs=None, files=None, filename_as_namespace=True, extension='.conf', root_file_name='root', missing_file_behavior=2)

Bases: pymlconf.config_nodes.ConfigDict

The main class which exposes pymlconf package.

Example:

from pymlconf import ConfigManager
from os import path
config =  ConfigManager('''
    server:
        host: localhost
        port: 4455
    ''','conf','builtins/defaults.conf')

print config.server.host
print config.server.port

Parameters

• init_value (str or dict) -- Initial configuration value that you can pass it before reading the files and directories.can be 'yaml string' or python dictionary.

• dirs (str or list) -- Python list or a string that contains semi-colon separated list of directories which contains configuration files with specified extension(default *.conf).

• files (str or list) -- Python list or a string that contains semi-colon separated list of files which contains yaml configuration entries.

• filename_as_namespace (bool) -- when loading dirs, use the filename as a namespace. default: true.

• extension (str) -- File extension to search for configuration files, in dirs parameter, default '.conf'

• root_file_name (str) -- Filename to treat as root configuration file, so it loads first, and do not uses the filename as namespaces.

• missing_file_behavior (integer 0:ignore, 1:throw error, 2:warning) -- What should do when a file was not found, set to 0 (zero) to ignore. default to 2:warning

default_extension = '.conf'

load_dirs(dirs, filename_as_namespace=True)

load directories which contains configuration files with specified extension, and merge it by current ConfigManager instance

Parameters

• dirs (list,string) -- Dirs to search for configuration files.

• filename_as_namespace (bool) -- when loading dirs, use the filename as a namespace. default: true.

load_files(files, filename_as_namespace=False)

load files which contains yaml configuration entries.and merge it by current ConfigManager instance

Parameters

• files (list) -- files to load and merge into existing configuration instance

• filename_as_namespace (bool) -- when loading files, use the filename as a namespace. default: false.

loaddirs(dirs, filename_as_namespace=True)

load directories which contains configuration files with specified extension, and merge it by current ConfigManager instance

Parameters

• dirs (list,string) -- Dirs to search for configuration files.

• filename_as_namespace (bool) -- when loading dirs, use the filename as a namespace. default: true.

loadfiles(files, filename_as_namespace=False)

load files which contains yaml configuration entries.and merge it by current ConfigManager instance

Parameters

• files (list) -- files to load and merge into existing configuration instance

• filename_as_namespace (bool) -- when loading files, use the filename as a namespace. default: false.

config_nodes Module

class pymlconf.config_nodes.ConfigDict(data=None)

Bases: collections.OrderedDict, pymlconf.config_nodes.Mergable

Configuration node that represents python dictionary data.

can_merge(data)

Determines whenever can merge with the passed argument or not.

Parameters

data (any) -- An object to test.

Returns

bool

copy() → a shallow copy of od

classmethod empty()

When implemented, returns an empty instance of drived Mergable class.

Returns

Mergable

class pymlconf.config_nodes.ConfigList(data=None)

Bases: list, pymlconf.config_nodes.Mergable

Configuration node that represents the python list data.

can_merge(data)

Determines whenever can merge with the passed argument or not.

Parameters

data (any) -- An object to test.

Returns

bool

copy()

Return a shallow copy of the list.

classmethod empty()

When implemented, returns an empty instance of drived Mergable class.

Returns

Mergable

class pymlconf.config_nodes.ConfigNamespace(data=None)

Bases: pymlconf.config_nodes.ConfigDict, pymlconf.config_nodes.Mergable

Configuration node that represents the configuration namespace node.

class pymlconf.config_nodes.Mergable(data=None)

Bases: object

Base class for all configuration nodes, so all configuration nodes are mergable

Parameters

data (list or dict) -- Initial value to constract a mergable instance. default: None.

abstract can_merge(data)

Determines whenever can merge with the passed argument or not.

Parameters

data (any) -- An object to test.

Returns

bool

abstract copy()

When implemented, returns copy of current config instance.

Returns

Mergable

abstract classmethod empty()

When implemented, returns an empty instance of drived Mergable class.

Returns

Mergable

classmethod make_mergable_if_possible(data)

Makes an object mergable if possible. Returns the virgin object if cannot convert it to a mergable instance.

Returns

Mergable or type(data)

merge(*args)

Merges this instance with new instances, in-place.

Parameters

*args (iterable) -- Configuration values to merge with current instance.

errors Module

exception pymlconf.errors.ConfigFileNotFoundError(filename)

Bases: pymlconf.errors.ConfigurationError

exception pymlconf.errors.ConfigKeyError(key)

Bases: pymlconf.errors.ConfigurationError, AttributeError

exception pymlconf.errors.ConfigurationError(message)

Bases: Exception

exception pymlconf.errors.ConfigurationMergeError(message)

Bases: pymlconf.errors.ConfigurationError, ValueError