WebKit.ConfigurableForServerSidePath | index /usr/local/share/webware/WebKit/ConfigurableForServerSidePath.py

Classes

``

MiscUtils.Configurable.Configurable(__builtin__.object)
  ConfigurableForServerSidePath

class ConfigurableForServerSidePath(MiscUtils.Configurable.Configurable)

``

`Configuration file functionality incorporating a server side path.
This is a version of `MiscUtils.Configurable.Configurable`
that provides a customized `setting` method for classes which
have a `serverSidePath` method. If a setting's name ends with
``Filename`` or ``Dir``, its value is passed through
`serverSidePath` before being returned.
In other words, relative filenames and directory names are expanded
with the location of the object, NOT the current directory.
Application and AppServer are two well known users of this
mix-in. Any class that has a `serverSidePath` method and a
`Configurable` base class, should inherit this class instead.
This is used with for MakeAppWorkDir, which changes the serverSidePath.
`

Method resolution order:
  ConfigurableForServerSidePath
  MiscUtils.Configurable.Configurable
  __builtin__.object

Methods defined here:

setting(self, name, default=<class 'MiscUtils.NoDefault'>)
  `Return setting, using the server side path when indicated.
  Returns the setting, filtered by serverSidePath(),
  if the name ends with ``Filename`` or ``Dir``.`

Methods inherited from MiscUtils.Configurable.Configurable:

__init__(self)

commandLineConfig(self)
  `Return the settings that came from the command-line.
  These settings come via addCommandLineSetting().`

config(self)
  `Return the configuration of the object as a dictionary.
  This is a combination of defaultConfig() and userConfig().
  This method caches the config.`

configFilename(self)
  `Return the full name of the user config file.
  Users can override the configuration by this config file.
  Subclasses must override to specify a name.
  Returning None is valid, in which case no user config file
  will be loaded.`

configName(self)
  `Return the name of the configuration file without the extension.
  This is the portion of the config file name before the '.config'.
  This is used on the command-line.`

configReplacementValues(self)
  `Return a dictionary for substitutions in the config file.
  This must be a dictionary suitable for use with "string % dict"
  that should be used on the text in the config file.
  If an empty dictionary (or None) is returned, then no substitution
  will be attempted.`

defaultConfig(self)
  `Return a dictionary with all the default values for the settings.
  This implementation returns {}. Subclasses should override.`

hasSetting(self, name)
  `Check whether a configuration setting has been changed.`

printConfig(self, dest=None)
  `Print the configuration to the given destination.
  The default destination is stdout. A fixed with font is assumed
  for aligning the values to start at the same column.`

setSetting(self, name, value)
  `Set a particular configuration setting.`

userConfig(self)
  `Return the user config overrides.
  These settings can be found in the optional config file.
  Returns {} if there is no such file.
  The config filename is taken from configFilename().`

Data descriptors inherited from MiscUtils.Configurable.Configurable:

__dict__
  `dictionary for instance variables (if defined)`

__weakref__
  `list of weak references to the object (if defined)`