anyconfig.backend.configobj

configobj backend.

anyconfig.backend.configobj.make_configobj(cnf, **kwargs)

Make a configobj.ConfigObj initalized with given config cnf.

Parameters:
  • cnf – Configuration data :: Parser.container
  • kwargs – optional keyword parameters passed to ConfigObj.__init__
Returns:

An initialized configobj.ConfigObj instance

class anyconfig.backend.configobj.Parser

Bases: anyconfig.backend.base.FromStreamLoader, anyconfig.backend.base.ToStreamDumper

Parser for Ini-like config files which configobj supports.

_type = 'configobj'
_priority = 10
_load_opts = ['cls', 'configspec', 'encoding', 'interpolation', 'raise_errors', 'list_values', 'create_empty', 'file_error', 'stringify', 'indent_type', 'default_encoding', 'unrepr', '_inspec']
_dump_opts = ['cls', 'encoding', 'list_values', 'indent_type', 'default_encoding', 'unrepr', 'write_empty_values']
_open_flags = ('rb', 'wb')
load_from_path(*args, **kwargs)

An object to read, create, and write config files.

load_from_stream(*args, **kwargs)

An object to read, create, and write config files.

dump_to_string(cnf, **kwargs)

Dump config cnf to a string.

Parameters:
  • cnf – Configuration data to dump :: self.container
  • kwargs – backend-specific optional keyword parameters :: dict
Returns:

string represents the configuration

dump_to_stream(cnf, stream, **kwargs)
Parameters:
  • cnf – Configuration data to dump :: self.container
  • stream – Config file or file-like object
  • kwargs – backend-specific optional keyword parameters :: dict
__module__ = 'anyconfig.backend.configobj'

Previous topic

anyconfig.backend.bson

Next topic

anyconfig.backend.ini

This Page