/usr/share/pyshared/mvpa2/base/config.py is in python-mvpa2 2.1.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 | # emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
# vi: set ft=python sts=4 ts=4 sw=4 et:
### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
#
# See COPYING file distributed along with the PyMVPA package for the
# copyright and license terms.
#
### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
"""Registry-like monster"""
__docformat__ = 'restructuredtext'
from ConfigParser import SafeConfigParser
import os.path
class ConfigManager(SafeConfigParser):
"""Central configuration registry for PyMVPA.
The purpose of this class is to collect all configurable settings used by
various parts of PyMVPA. It is fairly simple and does only little more
than the standard Python ConfigParser. Like ConfigParser it is blind to the
data that it stores, i.e. not type checking is performed.
Configuration files (INI syntax) in multiple location are passed when the
class is instantiated or whenever `Config.reload()` is called later on.
By default it looks for a config file named `pymvpa2.cfg` in the current
directory and `.pymvpa2.cfg` in the user's home directory. Moreover, the
constructor takes an optional argument with a list of additional file names
to parse.
In addition to configuration files, this class also looks for special
environment variables to read settings from. Names of such variables have to
start with `MVPA_` following by the an optional section name and the
variable name itself ('_' as delimiter). If no section name is provided,
the variables will be associated with section `general`. Some examples::
MVPA_VERBOSE=1
will become::
[general]
verbose = 1
However, `MVPA_VERBOSE_OUTPUT=stdout` becomes::
[verbose]
output = stdout
Any length of variable name as allowed, e.g. MVPA_SEC1_LONG_VARIABLE_NAME=1
becomes::
[sec1]
long variable name = 1
Settings from custom configuration files (specified by the constructor
argument) have the highest priority and override settings found in the
current directory. They in turn override user-specific settings and finally
the content of any `MVPA_*` environment variables overrides all settings
read from any file.
"""
# things we want to count on to be available
_DEFAULTS = {'general':
{
'verbose': '1',
}
}
def __init__(self, filenames=None):
"""Initialization reads settings from config files and env. variables.
Parameters
----------
filenames : list of filenames
"""
SafeConfigParser.__init__(self)
# store additional config file names
if not filenames is None:
self.__cfg_filenames = filenames
else:
self.__cfg_filenames = []
# set critical defaults
for sec, vars in ConfigManager._DEFAULTS.iteritems():
self.add_section(sec)
for key, value in vars.iteritems():
self.set(sec, key, value)
# now get the setting
self.reload()
def reload(self):
"""Re-read settings from all configured locations.
"""
# listof filenames to parse (custom plus some standard ones)
homedir = os.path.expanduser('~')
user_configfile = os.path.join(homedir, '.pymvpa2.cfg')
user_configfile_old = os.path.join(homedir, '.pymvpa.cfg')
filenames = self.__cfg_filenames \
+ ['pymvpa2.cfg', user_configfile]
# Check if config for previous version exists, we need to
# warn users since they might need to copy it over
if not os.path.exists(user_configfile) and \
os.path.exists(user_configfile_old):
# but we can't use our 'warning' since it would not be
# defined yet and import here would be circular
# so use stock Python one
from warnings import warn
warn("You seems to have a configuration file %s for previous "
"version of PyMVPA but lacking configuration for PyMVPA2. "
"Consider copying it into %s"
% (user_configfile_old, user_configfile))
# read local and user-specific config
files = self.read(filenames)
# no look for variables in the environment
for var in [v for v in os.environ.keys() if v.startswith('MVPA_')]:
# strip leading 'MVPA_' and lower case entries
svar = var[5:].lower()
# section is next element in name (or 'general' if simple name)
if not svar.count('_'):
sec = 'general'
else:
cut = svar.find('_')
sec = svar[:cut]
svar = svar[cut + 1:].replace('_', ' ')
# check if section is already known and add it if not
if not self.has_section(sec):
self.add_section(sec)
# set value
self.set(sec, svar, os.environ[var])
def __repr__(self):
"""Generate INI file content with current configuration.
"""
# make adaptor to use str as file-like (needed for ConfigParser.write()
class file2str(object):
def __init__(self):
self.__s = ''
def write(self, val):
self.__s += val
def str(self):
return self.__s
r = file2str()
self.write(r)
return r.str()
def save(self, filename):
"""Write current configuration to a file.
"""
f = open(filename, 'w')
self.write(f)
f.close()
def get(self, section, option, default=None, **kwargs):
"""Wrapper around SafeConfigParser.get() with a custom default value.
This method simply wraps the base class method, but adds a `default`
keyword argument. The value of `default` is returned whenever the
config parser does not have the requested option and/or section.
"""
if not self.has_option(section, option):
return default
try:
return SafeConfigParser.get(self, section, option, **kwargs)
except ValueError, e:
# provide somewhat descriptive error
raise ValueError, \
"Failed to obtain value from configuration for %s.%s. " \
"Original exception was: %s" % (section, option, e)
def getboolean(self, section, option, default=None):
"""Wrapper around SafeConfigParser.getboolean() with a custom default.
This method simply wraps the base class method, but adds a `default`
keyword argument. The value of `default` is returned whenever the
config parser does not have the requested option and/or section.
"""
if not self.has_option(section, option):
if isinstance(default, bool):
return default
else:
if default.lower() not in self._boolean_states:
raise ValueError, 'Not a boolean: %s' % default
return self._boolean_states[default.lower()]
return SafeConfigParser.getboolean(self, section, option)
##REF: Name was automagically refactored
def get_as_dtype(self, section, option, dtype, default=None):
"""Convenience method to query options with a custom default and type
This method simply wraps the base class method, but adds a `default`
keyword argument. The value of `default` is returned whenever the
config parser does not have the requested option and/or section.
In addition, the returned value is converted into the specified `dtype`.
"""
if not self.has_option(section, option):
return default
try:
return SafeConfigParser._get(self, section, dtype, option)
except ValueError, e:
# provide somewhat descriptive error
raise ValueError, \
"Failed to obtain value from configuration for %s.%s. " \
"Original exception was: %s" % (section, option, e)
|