Package handlers :: Module filterDirsBasename :: Class Handler
[show private | hide private]
[frames | no frames]

Type Handler

object --+    
         |    
   Handler --+
             |
            Handler


Filters directories with base names that match any of the patterns in a sequence.

Uses fnmatch to compare directory names to patterns in the configuration. Filtering out affects also subfolders (a directory that is filtered out is not traversed).
Method Summary
  __init__(self, configDict)
Initializer that uses a dictionary to configure the handler.
  handleChildDirHook(self, dirName)
Handles a child directory contained in the parent directory.
  setConfig(self, configDict)
Updates itself with configDict.
    Inherited from Handler
  __add__(self, otherHandler)
Operator for layering the handlers in a stack.
  __repr__(self)
  beginParentDirHook(self, dirName, subdirNames, fileNames)
Handles the parent directory that the 'walk' has reached.
  beginParentDirWrapper(self, dirName, subdirNames, fileNames)
Invokes beginParentDirHook for this handler and, recursively, for each handler below this one in the stack.
  calcModifValue(fileNamePath)
Helper method that calculates the value used to determine if a file has been changed or is different from another file. (Static method)
  endParentDirHook(self)
Handles the parent directory that the 'walk' has reached.
  endParentDirWrapper(self)
Invokes endParentDirHook for this handler and, recursively, for each handler below this one in the stack.
  finalizeHook(self)
Save all the results if needed and release resources.
  finalizeWrapper(self)
Invokes finalizeHook for this handler and, recursively, for each handler below this one in the stack.
  getMetaCfg(cls)
(Static method)
  handleChildDirWrapper(self, dirName)
Invokes handleChildDirHook for this handler and, recursively, for each handler below this one in the stack.
  handleFileHook(self, fileName)
Handles a file contained in the parent directory.
  handleFileWrapper(self, fileName)
Invokes handleFileHook for this handler and, recursively, for each handler below this one in the stack.
  modifValue(self, fileName)
Helper method to get the value used to determine if a file has been changed or is different from another file.
  setTopDir(self, topDir)
Sets the top directory in the handler.
  treeTopHook(self, topDir)
Takes care of initialization that is needed for every tree.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Instance Method Details

__init__(self, configDict=None)
(Constructor)

Initializer that uses a dictionary to configure the handler.
Overrides:
handlers.baseClass.Handler.__init__ (inherited documentation)

handleChildDirHook(self, dirName)

Handles a child directory contained in the parent directory.
Overrides:
handlers.baseClass.Handler.handleChildDirHook (inherited documentation)

setConfig(self, configDict)

Updates itself with configDict.
Overrides:
handlers.baseClass.Handler.setConfig (inherited documentation)

Generated by Epydoc 2.1 on Wed Dec 22 15:47:44 2004 http://epydoc.sf.net