handlers.procCompareTree.Handler

Package handlers :: Module procCompareTree :: Class Handler

[show private | hide private]

Type Handler

object --+    
         |    
   Handler --+
             |
            Handler

Determines differences between a traversed tree and a reference tree.

The reference tree that traversed trees are compared to is determined by configuration of the handler.

The handler compares individual directories and files and no state is maintained in the traversal of a tree. This allows more than one traversed tree to be compared to the reference tree.

Passes stack data with the key 'status'. Possible values:

'same' - same as the equivalent node in the reference tree
'diff' - different modification time than the equivalent node in the reference tree
'plus' - in the compared tree, not in the reference tree
'minus' - in the reference tree, not in the compared tree

Method Summary
	`__init__(self, configDict)` Initializer that uses a dictionary to configure the handler.
	`beginParentDirHook(self, dirName, subdirNames, fileNames)` Handles the parent directory that the 'walk' has reached.
	`finalizeHook(self)` Save all the results if needed and release resources.
	`handleChildDirHook(self, dirName)` Handles a child directory contained in the parent directory.
	`handleFileHook(self, fileName)` Handles a file 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)`
	`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.
	`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.
	`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)

beginParentDirHook(self, dirName, subdirNames=None, fileNames=None)

Handles the parent directory that the 'walk' has reached. It is invoked BEFORE handling the directories and files that the parent directory contains.

It can modify the subdirNames and fileNames lists, thus affecting the traversal of the tree. It is a feature useful for comparing the traversed tree to other trees.

Overrides:: handlers.baseClass.Handler.beginParentDirHook (inherited documentation)

finalizeHook(self)

Save all the results if needed and release resources.

Overrides:: handlers.baseClass.Handler.finalizeHook (inherited documentation)

handleChildDirHook(self, dirName)

Handles a child directory contained in the parent directory.

Overrides:: handlers.baseClass.Handler.handleChildDirHook (inherited documentation)

handleFileHook(self, fileName)

Handles a file contained in the parent directory.

Overrides:: handlers.baseClass.Handler.handleFileHook (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