Home | Trees | Index | Help |
|
---|
Package Cheetah :: Module SettingsManager :: Class SettingsManager |
|
_SettingsCollector
--+
|
SettingsManager
Template
A mixin class that provides facilities for managing application settings. SettingsManager is designed to work well with nested settings dictionaries of any depth.
Method Summary | |
---|---|
MUST BE CALLED BY SUBCLASSES... | |
Returns a shallow copy of the settings dictionary... | |
Returns a deep copy of the settings dictionary... | |
Return a string with the settings in .ini file format. | |
True/False... | |
Set a setting in self._settings. | |
Get a setting from self._settings, with or without a default value. | |
Return a reference to the settings dictionary... | |
Update the settings with a selective merge or a complete overwrite. | |
Update the settings from a text file using the syntax accepted by Python's standard ConfigParser module (like Windows .ini files). | |
See the docstring for .updateSettingsFromConfigFile() The caller of this method is responsible for closing the inFile file object. | |
See the docstring for .updateSettingsFromConfigFile()... | |
Update the settings from variables in a Python source file. | |
Update the settings from a code in a Python src string. | |
Write all the settings that can be represented as strings to an .ini style config file. |
Method Details |
---|
__init__(self)
|
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=<class Cheetah.SettingsManager.NoDefault at 0xb7c4de3c>)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=True)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=True, merge=True)See the docstring for .updateSettingsFromConfigFile() The caller of this method is responsible for closing the inFile file object. |
updateSettingsFromConfigStr(self, configStr, convert=True, merge=True)See the docstring for .updateSettingsFromConfigFile() |
updateSettingsFromPySrcFile(self, path, merge=True)Update the settings from variables in a Python source file. This method will temporarily add the directory of src file to sys.path so that import statements relative to that dir will work properly. |
updateSettingsFromPySrcStr(self, theString, merge=True)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. |
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.1 on Mon Jan 1 16:34:19 2007 | http://epydoc.sf.net |