MultiOrderedConfigParser Class Reference

Inheritance diagram for MultiOrderedConfigParser:

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

Detailed Description

Definition at line 323 of file astconfigparser.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			parent = None
	)

Definition at line 324 of file astconfigparser.py.

References Section._defaults, MultiOrderedConfigParser._defaults, MultiOrderedConfigParser._includes, MultiOrderedConfigParser._parent, and MultiOrderedConfigParser._sections.

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

Member Function Documentation

add_default()

def 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.

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

Referenced by MultiOrderedConfigParser.read().

 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)

add_include()

def add_include	(		self,
			filename,
			parser = None
	)

Add a new #include file to the configuration.

Definition at line 422 of file astconfigparser.py.

References MultiOrderedConfigParser._includes.

Referenced by MultiOrderedConfigParser.read().

 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

add_section()

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.

Definition at line 403 of file astconfigparser.py.

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

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

 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

default()

def default	(		self,
			key
	)

Retrieves a list of dictionaries for a default section.

Definition at line 355 of file astconfigparser.py.

References MultiOrderedConfigParser.get_defaults().

Referenced by MultiOrderedConfigParser.get().

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

defaults()

def defaults

(

self

)

Definition at line 352 of file astconfigparser.py.

References Section._defaults, and MultiOrderedConfigParser._defaults.

Referenced by MultiOrderedConfigParser.set().

 def defaults(self):
 return self._defaults

find_value()

def 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.

Referenced by MultiOrderedConfigParser.get().

 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)

get()

def get	(		self,
			section,
			key
	)

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

Definition at line 433 of file astconfigparser.py.

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

Referenced by MultiOrderedConfigParser.multi_get().

 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))

get_defaults()

def get_defaults	(		self,
			key
	)

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

Definition at line 397 of file astconfigparser.py.

References MultiOrderedConfigParser.get_sections().

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

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

get_sections()

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.

Definition at line 375 of file astconfigparser.py.

References MultiOrderedConfigParser._includes, and MultiOrderedConfigParser._parent.

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

 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

includes()

def includes

(

self

)

Definition at line 419 of file astconfigparser.py.

References MultiOrderedConfigParser._includes.

 def includes(self):
 return self._includes

multi_get()

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.

Definition at line 449 of file astconfigparser.py.

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

 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))

read()

def read	(		self,
			filename,
			sect = None
	)

Parse configuration information from a file

Definition at line 476 of file astconfigparser.py.

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

 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")

section()

def section	(		self,
			key
	)

Retrieves a list of dictionaries for a section.

Definition at line 371 of file astconfigparser.py.

References MultiOrderedConfigParser.get_sections().

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

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

sections()

def sections

(

self

)

Definition at line 368 of file astconfigparser.py.

References MultiOrderedConfigParser._sections.

 def sections(self):
 return self._sections

set()

def set	(		self,
			section,
			key,
			val
	)

Sets an option in the given section.

Definition at line 467 of file astconfigparser.py.

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

 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

write()

def write	(		self,
			config_file
	)

Write configuration information out to a file

Definition at line 513 of file astconfigparser.py.

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

Referenced by MultiOrderedConfigParser.write().

 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")

---

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

• astconfigparser.py

---

Generated on Sun Aug 8 2021 19:47:31 for Asterisk - The Open Source Telephony Project by   1.8.13