MiscUtils.PropertiesObject | index /usr/local/share/webware/MiscUtils/PropertiesObject.py

Modules

``

os | sys | types |

Classes

``

UserDict.UserDict(MiscUtils.NamedValueAccess.NamedValueAccess)
  PropertiesObject
exceptions.Exception(exceptions.BaseException)
  WillNotRunError

class PropertiesObject(UserDict.UserDict)

``

`A PropertiesObject represents, in a dictionary-like fashion, the values found in a Properties.py file. That file is always included with a Webware component to advertise its name, version, status, etc. Note that a Webware component is a Python package that follows additional conventions. Also, the top level Webware directory contains a Properties.py.
Component properties are often used for:
* generation of documentation
* runtime examination of components, especially prior to loading
PropertiesObject provides additional keys:
* filename - the filename from which the properties were read
* versionString - a nicely printable string of the version
* requiredPyVersionString - like versionString but for requiredPyVersion instead
* willRun - 1 if the component will run. So far that means having the right Python version.
* willNotRunReason - defined only if willRun is 0. contains a readable error message
Using a PropertiesObject is better than investigating the Properties.py file directly, because the rules for determining derived keys and any future convenience methods will all be provided here.
Usage example:
from MiscUtils.PropertiesObject import PropertiesObject
props = PropertiesObject(filename)
for item in props.items():
print '%s: %s' % item
Note: We don't normally suffix a class name with "Object" as we have with this class, however, the name Properties.py is already used in our containing package and all other packages.
`

Method resolution order:
  PropertiesObject
  UserDict.UserDict
  MiscUtils.NamedValueAccess.NamedValueAccess

Methods defined here:

__init__(self, filename=None)

checkDeniedOpSys(self)

checkRequiredOpSys(self)

checkRequiredPyVersion(self)

checkRequiredSoftware(self)
  `Not implemented. No op right now.`

checkWillRunFunc(self)

cleanPrivateItems(self)
  `Removes items whose keys start with a double underscore, such as __builtins__.`

createDerivedItems(self)

createRequiredPyVersionString(self)

createVersionString(self)

createWillRun(self)

loadValues(self, dict)

readFileNamed(self, filename)

willRunKeys(self)
  `Returns a list of keys whose values should be examined in order to determine if the component will run. Used by createWillRun().`

Methods inherited from UserDict.UserDict:

__cmp__(self, dict)

__contains__(self, key)

__delitem__(self, key)

__getitem__(self, key)

__len__(self)

__repr__(self)

__setitem__(self, key, item)

clear(self)

copy(self)

get(self, key, failobj=None)

hasValueForKey = _UserDict_hasValueForKey(self, key)

has_key(self, key)

items(self)

iteritems(self)

iterkeys(self)

itervalues(self)

keys(self)

pop(self, key, *args)

popitem(self)

setdefault(self, key, failobj=None)

update(self, dict=None, **kwargs)

valueForKey = _UserDict_valueForKey(self, key, default=<class MiscUtils.NoDefault at 0x832da1c>)

values(self)

Class methods inherited from UserDict.UserDict:

fromkeys(cls, iterable, value=None) from __builtin__.classobj

Methods inherited from MiscUtils.NamedValueAccess.NamedValueAccess:

handleUnknownSetKey(self, key)

hasValueForName(self, keysString)
  `Check whether name is available.`

resetKeyBindings(self)
  `Rest all key bindings, releasing alreaedy referenced values.`

setValueForKey(self, key, value)
  `Set value for a given key.
  Suppose key is 'foo'.
  This method sets the value with the following precedence:
  1. Public attributes before private attributes
  2. Methods before non-methods
  More specifically, this method then uses one of the following:
  @@ 2000-03-04 ce: fill in
  ... or invokes handleUnknownSetKey().`

valueForKeySequence(self, listOfKeys, default=None)
  `Get the value for the given list of keys.`

valueForName(self, keysString, default=None)
  `Get the value for the given keysString.
  This is the more advanced version of valueForKey(), which can only
  handle single names. This method can handle
  'foo', 'foo1.foo2', 'a.b.c.d', etc.
  It will traverse dictionaries if needed.`

valueForUnknownKey(self, key, default)

valuesForNames(self, keys, default=None, defaults=None, forgive=0, includeNames=0)
  `Get all values for given names.
  Returns a list of values that match the given keys, each of which is
  passed through valueForName() and so could be of the form 'a.b.c'.
  keys and defaults are sequences.
  default is any kind of object.
  forgive and includeNames are flags.
  If default is not None, then it is substituted when a key is not found.
  Otherwise, if defaults is not None, then it's corresponding/parallel
  value for the current key is substituted when a key is not found.
  Otherwise, if forgive is true, then unknown keys simply don't produce
  any values.
  Otherwise, if default and defaults are None, and forgive is false,
  then the unknown keys will probably raise an exception through
  valueForUnknownKey() although that method can always return
  a final, default value.
  if keys is None, then None is returned.
  If keys is an empty list, then None is returned.
  Often these last four arguments are specified by key.
  Examples:
  names = ['origin.x', 'origin.y', 'size.width', 'size.height']
  obj.valuesForNames(names)
  obj.valuesForNames(names, default=0.0)
  obj.valuesForNames(names, defaults=[0.0, 0.0, 100.0, 100.0])
  obj.valuesForNames(names, forgive=0)
  @@ 2000-03-04 ce: includeNames is only supported when forgive=1.
  It should be supported for the other cases.
  It should be documented.
  It should be included in the test cases.`

class WillNotRunError(exceptions.Exception)

``

Method resolution order:
  WillNotRunError
  exceptions.Exception
  exceptions.BaseException
  __builtin__.object

Data descriptors defined here:

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

Methods inherited from exceptions.Exception:

__init__(...)
  `x.__init__(...) initializes x; see x.__class__.__doc__ for signature`

Data and other attributes inherited from exceptions.Exception:

__new__ = <built-in method __new__ of type object at 0x8118b60>
  `T.__new__(S, ...) -> a new object with type S, a subtype of T`

Methods inherited from exceptions.BaseException:

__delattr__(...)
  `x.__delattr__('name') <==> del x.name`

__getattribute__(...)
  `x.__getattribute__('name') <==> x.name`

__getitem__(...)
  `x.__getitem__(y) <==> x[y]`

__getslice__(...)
  `x.__getslice__(i, j) <==> x[i:j]
  Use of negative indices is not supported.`

__reduce__(...)

__repr__(...)
  `x.__repr__() <==> repr(x)`

__setattr__(...)
  `x.__setattr__('name', value) <==> x.name = value`

__setstate__(...)

__str__(...)
  `x.__str__() <==> str(x)`

Data descriptors inherited from exceptions.BaseException:

__dict__

args

message
  `exception message`