MultiOrderedConfigParser Class Reference

Inheritance diagram for MultiOrderedConfigParser:

Public Member Functions
	__init__ (self, parent=None)
	add_default (self, key, template_keys=None)
	add_include (self, filename, parser=None)
	add_section (self, key, template_keys=None, mdicts=None)
	default (self, key)
	defaults (self)
	find_value (self, sections, key)
	get (self, section, key)
	get_defaults (self, key)
	get_sections (self, key, attr='_sections', searched=None)
	includes (self)
	multi_get (self, section, key_list)
	read (self, filename, sect=None)
	section (self, key)
	sections (self)
	set (self, section, key, val)
	write (self, config_file)

Protected Member Functions
	_read (self, config_file, sect)

Protected Attributes
	_defaults
	_includes
	_parent
	_sections

Detailed Description

Definition at line 323 of file astconfigparser.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			parent = None
	)

Reimplemented in SqlConfigParser.

Definition at line 324 of file astconfigparser.py.

    def __init__(self, parent=None):
        self._parent = parent
        self._defaults = MultiOrderedDict()
        self._sections = MultiOrderedDict()
        self._includes = OrderedDict()
 

Member Function Documentation

_read()

_read (   self,   config_file,   sect  )

protected

Parse configuration information from the config_file

Definition at line 484 of file astconfigparser.py.

    def _read(self, config_file, sect):
        """Parse configuration information from the config_file"""
        is_comment = False  # used for multi-lined comments
        for line in config_file:
            line, is_comment = remove_comment(line, is_comment)
            if not line:
                # line was empty or was a comment
                continue
 
            include_name = try_include(line)
            if include_name:
                for incl in sorted(glob.iglob(include_name)):
                    parser = self.add_include(incl)
                    parser.read(incl, sect)
                continue
 
            section, is_template, templates = try_section(line)
            if section:
                if section == DEFAULTSECT or is_template:
                    sect = self.add_default(section, templates)
                else:
                    sect = self.add_section(section, templates)
                continue
 
            key, val = try_option(line)
            if sect is None:
                raise Exception("Section not defined before assignment")
            sect[key] = val
 

References MultiOrderedConfigParser.add_default(), MultiOrderedConfigParser.add_include(), MultiOrderedConfigParser.add_section(), astconfigparser.remove_comment(), astconfigparser.try_include(), astconfigparser.try_option(), and astconfigparser.try_section().

Referenced by MultiOrderedConfigParser.read().

add_default()

add_default	(		self,
			key,
			template_keys = None
	)

Adds a default section to defaults, returning the
default Section object.

Definition at line 359 of file astconfigparser.py.

    def add_default(self, key, template_keys=None):
        """
        Adds a default section to defaults, returning the
        default Section object.
        """
        if template_keys is None:
            template_keys = []
        return self.add_section(key, template_keys, self._defaults)
 

References Section._defaults, MultiOrderedConfigParser._defaults, and MultiOrderedConfigParser.add_section().

Referenced by MultiOrderedConfigParser._read().

add_include()

add_include	(		self,
			filename,
			parser = None
	)

Add a new #include file to the configuration.

Definition at line 422 of file astconfigparser.py.

    def add_include(self, filename, parser=None):
        """
        Add a new #include file to the configuration.
        """
        if filename in self._includes:
            return self._includes[filename]
 
        self._includes[filename] = res = \
            MultiOrderedConfigParser(self) if parser is None else parser
        return res
 

References MultiOrderedConfigParser._includes.

Referenced by MultiOrderedConfigParser._read().

add_section()

add_section	(		self,
			key,
			template_keys = None,
			mdicts = None
	)

Create a new section in the configuration. The name of the
new section is the 'key' parameter.

Definition at line 403 of file astconfigparser.py.

    def add_section(self, key, template_keys=None, mdicts=None):
        """
        Create a new section in the configuration. The name of the
        new section is the 'key' parameter.
        """
        if template_keys is None:
            template_keys = []
        if mdicts is None:
            mdicts = self._sections
        res = Section()
        for t in template_keys:
            res.add_templates(self.get_defaults(t))
        res.add_defaults(self.get_defaults(DEFAULTSECT))
        mdicts.insert(0, key, res)
        return res
 

References MultiOrderedConfigParser._sections, SqlConfigParser._sections, and MultiOrderedConfigParser.get_defaults().

Referenced by MultiOrderedConfigParser._read(), MultiOrderedConfigParser.add_default(), and SqlConfigParser.read().

default()

default	(		self,
			key
	)

Retrieves a list of dictionaries for a default section.

Definition at line 355 of file astconfigparser.py.

    def default(self, key):
        """Retrieves a list of dictionaries for a default section."""
        return self.get_defaults(key)
 

References MultiOrderedConfigParser.get_defaults().

Referenced by MultiOrderedConfigParser.get().

defaults()

defaults

(

self

)

Definition at line 352 of file astconfigparser.py.

    def defaults(self):
        return self._defaults
 

References Section._defaults, and MultiOrderedConfigParser._defaults.

Referenced by MultiOrderedConfigParser.set().

find_value()

find_value	(		self,
			sections,
			key
	)

Given a list of sections, try to find value(s) for the given key.

Definition at line 330 of file astconfigparser.py.

    def find_value(self, sections, key):
        """Given a list of sections, try to find value(s) for the given key."""
        # always start looking in the last one added
        sections.sort(reverse=True)
        for s in sections:
            try:
                # try to find in section and section's templates
                return s.get(key, from_defaults=False)
            except KeyError:
                pass
 
        # wasn't found in sections or a section's templates so check in
        # defaults
        for s in sections:
            try:
                # try to find in section's defaultsects
                return s.get(key, from_self=False, from_templates=False)
            except KeyError:
                pass
 
        raise KeyError(key)
 

Referenced by MultiOrderedConfigParser.get().

get()

get	(		self,
			section,
			key
	)

Retrieves the list of values from a section for a key.

Definition at line 433 of file astconfigparser.py.

    def get(self, section, key):
        """Retrieves the list of values from a section for a key."""
        try:
            # search for the value in the list of sections
            return self.find_value(self.section(section), key)
        except KeyError:
            pass
 
        try:
            # section may be a default section so, search
            # for the value in the list of defaults
            return self.find_value(self.default(section), key)
        except KeyError:
            raise LookupError("key %r not found for section %r"
                              % (key, section))
 

References MultiOrderedConfigParser.default(), MultiOrderedConfigParser.find_value(), and MultiOrderedConfigParser.section().

Referenced by Section.__getitem__(), and MultiOrderedConfigParser.multi_get().

get_defaults()

get_defaults	(		self,
			key
	)

Retrieve a list of defaults that have values for the given key.

Definition at line 397 of file astconfigparser.py.

    def get_defaults(self, key):
        """
        Retrieve a list of defaults that have values for the given key.
        """
        return self.get_sections(key, '_defaults')
 

References MultiOrderedConfigParser.get_sections().

Referenced by MultiOrderedConfigParser.add_section(), and MultiOrderedConfigParser.default().

get_sections()

get_sections	(		self,
			key,
			attr = '_sections',
			searched = None
	)

Retrieve a list of sections that have values for the given key.
The attr parameter can be used to control what part of the parser
to retrieve values from.

Definition at line 375 of file astconfigparser.py.

    def get_sections(self, key, attr='_sections', searched=None):
        """
        Retrieve a list of sections that have values for the given key.
        The attr parameter can be used to control what part of the parser
        to retrieve values from.
        """
        if searched is None:
            searched = []
        if self in searched:
            return []
 
        sections = getattr(self, attr)
        res = sections[key] if key in sections else []
        searched.append(self)
        if self._includes:
            res.extend(list(itertools.chain(*[
                incl.get_sections(key, attr, searched)
                for incl in self._includes.itervalues()])))
        if self._parent:
            res += self._parent.get_sections(key, attr, searched)
        return res
 

References MultiOrderedConfigParser._includes, MultiOrderedConfigParser._parent, and MultiOrderedConfigParser.get_sections().

Referenced by MultiOrderedConfigParser.get_defaults(), MultiOrderedConfigParser.get_sections(), and MultiOrderedConfigParser.section().

includes()

includes

(

self

)

Definition at line 419 of file astconfigparser.py.

    def includes(self):
        return self._includes
 

References MultiOrderedConfigParser._includes.

multi_get()

multi_get	(		self,
			section,
			key_list
	)

Retrieves the list of values from a section for a list of keys.
This method is intended to be used for equivalent keys. Thus, as soon
as any match is found for any key in the key_list, the match is
returned. This does not concatenate the lookups of all of the keys
together.

Definition at line 449 of file astconfigparser.py.

    def multi_get(self, section, key_list):
        """
        Retrieves the list of values from a section for a list of keys.
        This method is intended to be used for equivalent keys. Thus, as soon
        as any match is found for any key in the key_list, the match is
        returned. This does not concatenate the lookups of all of the keys
        together.
        """
        for i in key_list:
            try:
                return self.get(section, i)
            except LookupError:
                pass
 
        # Making it here means all lookups failed.
        raise LookupError("keys %r not found for section %r" %
                          (key_list, section))
 

References Section.get(), MultiOrderedConfigParser.get(), ast_jb_impl.get, and ast_speech_engine.get.

read()

read	(		self,
			filename,
			sect = None
	)

Parse configuration information from a file

Reimplemented in SqlConfigParser.

Definition at line 476 of file astconfigparser.py.

    def read(self, filename, sect=None):
        """Parse configuration information from a file"""
        try:
            with open(filename, 'rt') as config_file:
                self._read(config_file, sect)
        except IOError:
            print("Could not open file " + filename + " for reading")
 

References MultiOrderedConfigParser._read().

section()

section	(		self,
			key
	)

Retrieves a list of dictionaries for a section.

Definition at line 371 of file astconfigparser.py.

    def section(self, key):
        """Retrieves a list of dictionaries for a section."""
        return self.get_sections(key)
 

References MultiOrderedConfigParser.get_sections().

Referenced by MultiOrderedConfigParser.get(), and MultiOrderedConfigParser.set().

sections()

sections

(

self

)

Definition at line 368 of file astconfigparser.py.

    def sections(self):
        return self._sections
 

References MultiOrderedConfigParser._sections, and SqlConfigParser._sections.

set()

set	(		self,
			section,
			key,
			val
	)

Sets an option in the given section.

Definition at line 467 of file astconfigparser.py.

    def set(self, section, key, val):
        """Sets an option in the given section."""
        # TODO - set in multiple sections? (for now set in first)
        # TODO - set in both sections and defaults?
        if section in self._sections:
            self.section(section)[0][key] = val
        else:
            self.defaults(section)[0][key] = val
 

References MultiOrderedConfigParser._sections, SqlConfigParser._sections, MultiOrderedConfigParser.defaults(), and MultiOrderedConfigParser.section().

write()

write	(		self,
			config_file
	)

Write configuration information out to a file

Reimplemented in SqlConfigParser.

Definition at line 513 of file astconfigparser.py.

    def write(self, config_file):
        """Write configuration information out to a file"""
        try:
            for key, val in self._includes.iteritems():
                val.write(key)
                config_file.write('#include "%s"\n' % key)
 
            config_file.write('\n')
            write_dicts(config_file, self._defaults)
            write_dicts(config_file, self._sections)
        except:
            try:
                with open(config_file, 'wt') as fp:
                    self.write(fp)
            except IOError:
                print("Could not open file " + config_file + " for writing")

References Section._defaults, MultiOrderedConfigParser._defaults, MultiOrderedConfigParser._includes, MultiOrderedConfigParser._sections, SqlConfigParser._sections, MultiOrderedConfigParser.write(), SqlConfigParser.write(), Registration.write(), aeap_transport_vtable.write, ast_bridge_technology.write, ast_channel_tech.write, ast_format_def.write, ast_custom_function.write, ast_fax_tech.write, ast_rtp_engine.write, ast_speech_engine.write, and astconfigparser.write_dicts().

Referenced by MultiOrderedConfigParser.write().

Field Documentation

_defaults

_defaults

protected

Definition at line 326 of file astconfigparser.py.

Referenced by MultiOrderedConfigParser.add_default(), Section.add_defaults(), MultiOrderedConfigParser.defaults(), Section.get(), Section.get_merged(), Section.keys(), and MultiOrderedConfigParser.write().

_includes

_includes

protected

Definition at line 328 of file astconfigparser.py.

Referenced by MultiOrderedConfigParser.add_include(), MultiOrderedConfigParser.get_sections(), MultiOrderedConfigParser.includes(), and MultiOrderedConfigParser.write().

_parent

_parent

protected

Definition at line 325 of file astconfigparser.py.

Referenced by MultiOrderedConfigParser.get_sections().

_sections

_sections

protected

Definition at line 327 of file astconfigparser.py.

Referenced by MultiOrderedConfigParser.add_section(), MultiOrderedConfigParser.sections(), MultiOrderedConfigParser.set(), and MultiOrderedConfigParser.write().

---

The documentation for this class was generated from the following file:

• astconfigparser.py