Method Summary |
|
__init__ (self)
MUST BE CALLED BY SUBCLASSES... |
|
copySettings (self)
Returns a shallow copy of the settings dictionary... |
|
deepcopySettings (self)
Returns a deep copy of the settings dictionary... |
|
getConfigString (self)
Return a string with the settings in .ini file format. |
|
hasSetting (self,
key)
True/False... |
|
setSetting (self,
name,
value)
Set a setting in self._settings. |
|
setting (self,
name,
default)
Get a setting from self._settings, with or without a default value. |
|
settings (self)
Return a reference to the settings dictionary... |
|
updateSettings (self,
newSettings,
merge)
Update the settings with a selective merge or a complete overwrite. |
|
updateSettingsFromConfigFile (self,
path,
**kw)
Update the settings from a text file using the syntax accepted by
Python's standard ConfigParser module (like Windows .ini files). |
|
updateSettingsFromConfigFileObj (self,
inFile,
convert,
merge)
See the docstring for .updateSettingsFromConfigFile()
The caller of this method is responsible for closing the inFile file
object. |
|
updateSettingsFromConfigStr (self,
configStr,
convert,
merge)
See the docstring for .updateSettingsFromConfigFile()... |
|
updateSettingsFromPySrcFile (self,
path,
merge)
Update the settings from variables in a Python source file. |
|
updateSettingsFromPySrcStr (self,
theString,
merge)
Update the settings from a code in a Python src string. |
|
writeConfigFile (self,
path)
Write all the settings that can be represented as strings to an .ini
style config file. |
|
_createConfigFile (self,
outFile)
Write all the settings that can be represented as strings to an .ini
style config string. |
|
_defaultSettings(self)
|
|
_initializeSettings (self)
A hook that allows for complex setting initialization sequences that
involve references to 'self' or other settings. |
Inherited from _SettingsCollector |
|
_getAllAttrsFromContainer (self,
container)
Extract all the attributes of a SettingsContainer subclass. |
|
_isContainer (self,
thing)
Check if 'thing' is a Python module or a subclass of
SettingsContainer. |
|
normalizePath (self,
path)
A hook for any neccessary path manipulations. |
|
readSettingsFromConfigFile (self,
path,
convert)
|
|
readSettingsFromConfigFileObj (self,
inFile,
convert)
Return the settings from a config file that uses the syntax accepted by
Python's standard ConfigParser module (like Windows .ini files). |
|
readSettingsFromContainer (self,
container,
ignoreUnderscored)
Returns all settings from a SettingsContainer or Python
module. |
|
readSettingsFromModule (self,
container,
ignoreUnderscored)
Returns all settings from a SettingsContainer or Python
module. |
|
readSettingsFromPySrcFile (self,
path)
Return new settings dict from variables in a Python source file. |
|
readSettingsFromPySrcStr (self,
theString)
Return a dictionary of the settings in a Python src string. |