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

`ImportManager
Manages imported modules and protects against concurrent imports.
Keeps lists of all imported Python modules and templates as well as other
config files used by Webware for Python. For modules which are not directly
imported, ImportManager can use ImportSpy to keep track of them. This can
be used to detect changes in source files, templates or config files in order
to reload them automatically by the AutoReloadingAppServer. The use of
ImportSpy can be suppressed with the``UseImportSpy`` setting.`

Modules

``

WebUtils imp | os sys | time |

Classes

``

ImportLock
WebKit.Object.Object(__builtin__.object, MiscUtils.NamedValueAccess.NamedValueAccess)
  ImportManager

class ImportLock

``

`Lock for multi-threaded imports.
Provides a lock for protecting against concurrent imports. This is
necessary because WebKit is multithreaded and uses its own import hook.
This class abstracts the difference between using the Python interpreter's
global import lock, and using our own RLock. The global lock is the correct
solution, but is only available in Python since version 2.2.3. If it's not
available, we fall back to using an RLock (which is not as good, but better
than nothing).
`

Methods defined here:

__init__(self)
  `Create the lock.
  Aliases the `acquire` and `release` methods to
  `imp.acquire_lock` and `imp.release_lock` (if available),
  or to acquire and release our own RLock.`

class ImportManager(WebKit.Object.Object)
`` | `The import manager. Keeps track of the Python modules and other system files that have been imported and are used by Webware.`

Method resolution order:
  ImportManager
  WebKit.Object.Object
  __builtin__.object
  MiscUtils.NamedValueAccess.NamedValueAccess

Methods defined here:

__init__(self)
  `Create import hook.`

activateImportSpy(self)
  `Activate ImportSpy to keep track of modules loaded elsewhere.`

delModules(self, includePythonModules=False, excludePrefixes=None)
  `Delete imported modules.
  Deletes all the modules that the ImportSpy has ever imported unless
  they are part of WebKit. This in support of DebugAppServer's useful
  (yet imperfect) support for AutoReload.`

fileList(self, update=True)
  `Return the list of tracked files.`

fileUpdated(self, filename, update=True, getmtime=<function getmtime at 0x81754c4>)
  `Check whether file has been updated.`

find_module(self, name, path=None)
  `Replaces imp.find_module.`

load_module(self, name, file, filename, info)
  `Replaces imp.load_module.`

notifyOfNewFiles(self, hook)
  `Register notification hook.
  Called by someone else to register that they'd like to be know
  when a new file is imported.`

recordFile(self, filename, isfile=<function isfile at 0x817564c>)
  `Record a file.`

recordModule(self, mod, isfile=<function isfile at 0x817564c>)
  `Record a module.`

recordModules(self, moduleNames=None)
  `Record a list of modules (or all modules).`

updatedFile(self, update=True, getmtime=<function getmtime at 0x81754c4>)
  `Check whether one of the files has been updated.`

watchFile(self, path, modname=None, getmtime=<function getmtime at 0x81754c4>)
  `Add more files to watch without importing them.`

Methods inherited from WebKit.Object.Object:

deprecated(self, method)
  `Output a deprecation warning.
  The implementation of WebKit sometimes invokes this method which prints
  a warning that the method you are using has been deprecated.
  This method expects that deprecated methods say so at the beginning of
  their doc string and terminate that msg with @. For example:
  DEPRECATED: Class.foo() on 01/24/01 in ver 0.5. Use Class.bar() instead. @
  Putting this information in the doc string is important for accuracy
  in the generated docs.
  Example call:
  deprecated(self.foo)`

Data descriptors inherited from WebKit.Object.Object:

__dict__
  `dictionary for instance variables (if defined)`

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

Methods inherited from MiscUtils.NamedValueAccess.NamedValueAccess:

handleUnknownSetKey(self, key)

hasValueForKey(self, key)
  `Check whether key is available.
  Returns true if the key is available, although that does not guarantee
  that there will not be errors caused by retrieving the 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().`

valueForKey(self, key, default=<class MiscUtils.NoDefault at 0x81cfa1c>)
  `Get value for given key.
  Suppose key is 'foo'.
  This method returns the value with the following precedence:
  1. Methods before non-methods
  2. Public attributes before private attributes
  More specifically, this method then returns one of the following:
  * foo()
  * _foo()
  * self.foo
  * self._foo
  ... or default, if it was specified,
  otherwise invokes and returns result of valueForUnknownKey().
  Note that valueForUnknownKey() normally returns an exception.
  See valueForName() which is a more advanced version of this method
  that allows multiple, qualified keys.`

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.`

Functions

``

StringIO(...)
  `StringIO([s]) -- Return a StringIO-like stream for reading or writing`