Module Hierarchy

• handlers
  • baseClass: Module with the base class for all the handlers.
  • filterDirsBasename: Handler that filters directories based on their base names.
  • filterDirsPath: Handler that filters directories specified by full path.
  • filterFilesBasename: Handler that filters files based on their base names.
  • filterFilesBasenameRe: Handler that filters files by their base names using regular expressions.
  • filterFilesPath: Handler that filters files specified by full path.
  • filterInFilenamesFromSeq: Deprecated, replaced by filterFilesBasename.
  • filterOutDirnamesFromSeq: Deprecated, replaced by filterDirsBasename.
  • filterOutDirsFromSeq: Deprecated, replaced by filterDirsPath.
  • filterOutFilenamesFromSeq: Deprecated, replaced by filterFilesBasename.
  • filterOutFilesFromSeq: Deprecated, replaced by filterFilesPath.
  • handlerTemplate: Template file for handlers.
  • logAll: Handler that logs files and directories to a plain text file.
  • logFilesOnly: Handler that logs only files to a plain text file.
  • procBuildDict: Handler that builds a persistent data structure from the tree.
  • procCompareTree: Handler compares a tree to what is saved in a persistent structure.
  • procFromDict: Handler compares the tree to what is saved in a persistent structure.
  • procRemoveFiles: Handler that removes files.
  • procTarFiles: Handler that creates a '.tar.gz' file.
  • resultsViewer: Module with the mixin class for all the results viewers.
  • viewDirsPlain: Handler that creates a plain list view of the directories.
  • viewFilesPlain: Handler that creates a plain list view of the files.
• test
  • genericTc: Base class for all the test cases.
  • test_all: Test suite that runs all the test cases.
  • test_ctrlr_zigo: Sanity test case for the controller class
  • test_handlers_filterDirsBasename: Test case for the 'filterDirsBasename' handler
  • test_handlers_filterDirsPath: Test case for the 'filterDirsPath' handler
  • test_handlers_filterFilesBasename: Test case for the 'filterFilesBasename' handler
  • test_handlers_filterFilesBasenameRe: Test case for the 'filterFilesBasenameRe' handler
  • test_handlers_filterFilesPath: Test case for the 'filterFilesPath' handler
  • test_handlers_logAll: Test case for the 'writeToFile' handler
  • test_handlers_procBuildDict: Test case for the 'buildDict' handler
  • test_handlers_procCompareTree: Test case for the 'procCompareTree' handler
  • test_handlers_procFromDict: Test case for the 'procFromDict' handler
  • testsConfig: Configuration used by all the test cases.
• zigo: Top-level module of the framework, contains the Controller class.

Class Hierarchy

• __builtin__.object: The most base type
  • handlers.baseClass.Handler: The base class for all the handlers.
    • handlers.filterDirsBasename.Handler: Filters directories with base names that match any of the patterns in a sequence.
    • handlers.filterDirsPath.Handler: Filters directories specified by their full path.
    • handlers.filterFilesBasename.Handler: Filters files with base names that match any of the patterns in a sequence.
    • handlers.filterFilesBasenameRe.Handler: Filters files by their base names using re search.
    • handlers.filterFilesPath.Handler: Filters files specified by full path.
    • handlers.filterInFilenamesFromSeq.Handler: Deprecated, replaced by filterFilesBasename.
    • handlers.filterOutDirnamesFromSeq.Handler: Deprecated, replaced by filterDirsBasename.
    • handlers.filterOutDirsFromSeq.Handler: Deprecated, replaced by filterDirsPath.
    • handlers.filterOutFilenamesFromSeq.Handler: Deprecated, replaced by filterFilesBasename.
    • handlers.filterOutFilesFromSeq.Handler: Deprecated, replaced by filterFilesPath.
    • handlers.handlerTemplate.Handler: Un-comment and implement methods as needed.
    • handlers.logAll.Handler: Logs files and directories to a plain text file.
    • handlers.logFilesOnly.Handler: Logs files to a plain text file.
    • handlers.procBuildDict.Handler: Builds a persistent structure containing the tree.
    • handlers.procCompareTree.Handler: Determines differences between a traversed tree and a reference tree.
    • handlers.procFromDict.Handler: Determines file and directory changes from a previously saved structure.
    • handlers.procRemoveFiles.Handler: Removes all the files that are passed in.
    • handlers.procTarFiles.Handler: Creates a 'tar.gz' file with all the files that are passed in.
    • handlers.viewDirsPlain.Handler: Creates a plain list view of the directories.
    • handlers.viewFilesPlain.Handler: Creates a plain list view of the files.
  • handlers.baseClass.metaCfgCls: Metadata for configuration.
  • test.genericTc.origModifMixin: Helper class for test cases that use the 'orig' and 'modified' trees
    • test.test_handlers_procBuildDict.buildDictTestCase: Testing of the 'buildDict' handler.
    • test.test_ctrlr_zigo.ctrlrTestCase: Sanity test case for the controller class.
    • test.test_handlers_filterDirsBasename.filterInTestCase: Testing of the 'filterInTestCase' handler for filtering directories in.
    • test.test_handlers_filterDirsPath.filterInTestCase: Testing of the 'filterDirsPath' handler for filtering directories in.
    • test.test_handlers_filterFilesBasename.filterInTestCase: Testing of the 'filterFilesBasename' handler for filtering files in.
    • test.test_handlers_filterFilesBasenameRe.filterInTestCase: Testing of the 'filterFilesBasenameRe' handler for filtering files in.
    • test.test_handlers_filterFilesPath.filterInTestCase: Testing of the 'filterFilesPath' handler for filtering files in.
    • test.test_handlers_filterDirsBasename.filterOutTestCase: Testing of the 'filterInTestCase' handler for filtering directories out.
    • test.test_handlers_filterDirsPath.filterOutTestCase: Testing of the 'filterDirsPath' handler for filtering directories out.
    • test.test_handlers_filterFilesBasename.filterOutTestCase: Testing of the 'filterFilesBasename' handler for filtering files out.
    • test.test_handlers_filterFilesBasenameRe.filterOutTestCase: Testing of the 'filterFilesBasenameRe' handler for filtering files out.
    • test.test_handlers_filterFilesPath.filterOutTestCase: Testing of the 'filterFilesPath' handler for filtering files out.
    • test.test_handlers_procCompareTree.logFileTestCase: Testing of the 'procCompareTree' handler.
    • test.test_handlers_procFromDict.logFileTestCase: Testing of the 'procFromDict' handler.
    • test.test_handlers_procCompareTree.stackOutputTestCase: Testing of the 'procCompareTree' handler.
    • test.test_handlers_procFromDict.stackOutputTestCase: Testing of the 'procFromDict' handler.
    • test.test_handlers_logAll.writeToFileTestCase: Testing of the 'writeToFile' handler.
  • unittest.TestCase: A class whose instances are single test cases.
    • test.genericTc.baseClassForHandlerTestCase: Generic code for testing any of the handler combinations
      • test.test_handlers_procBuildDict.buildDictTestCase: Testing of the 'buildDict' handler.
      • test.test_handlers_filterDirsBasename.filterInTestCase: Testing of the 'filterInTestCase' handler for filtering directories in.
      • test.test_handlers_filterDirsPath.filterInTestCase: Testing of the 'filterDirsPath' handler for filtering directories in.
      • test.test_handlers_filterFilesBasename.filterInTestCase: Testing of the 'filterFilesBasename' handler for filtering files in.
      • test.test_handlers_filterFilesBasenameRe.filterInTestCase: Testing of the 'filterFilesBasenameRe' handler for filtering files in.
      • test.test_handlers_filterFilesPath.filterInTestCase: Testing of the 'filterFilesPath' handler for filtering files in.
      • test.test_handlers_filterDirsBasename.filterOutTestCase: Testing of the 'filterInTestCase' handler for filtering directories out.
      • test.test_handlers_filterDirsPath.filterOutTestCase: Testing of the 'filterDirsPath' handler for filtering directories out.
      • test.test_handlers_filterFilesBasename.filterOutTestCase: Testing of the 'filterFilesBasename' handler for filtering files out.
      • test.test_handlers_filterFilesBasenameRe.filterOutTestCase: Testing of the 'filterFilesBasenameRe' handler for filtering files out.
      • test.test_handlers_filterFilesPath.filterOutTestCase: Testing of the 'filterFilesPath' handler for filtering files out.
      • test.test_handlers_procCompareTree.logFileTestCase: Testing of the 'procCompareTree' handler.
      • test.test_handlers_procFromDict.logFileTestCase: Testing of the 'procFromDict' handler.
      • test.test_handlers_procCompareTree.stackOutputTestCase: Testing of the 'procCompareTree' handler.
      • test.test_handlers_procFromDict.stackOutputTestCase: Testing of the 'procFromDict' handler.
      • test.test_handlers_logAll.writeToFileTestCase: Testing of the 'writeToFile' handler.
    • test.test_ctrlr_zigo.ctrlrTestCase: Sanity test case for the controller class.
  • __builtin__.type: type(object) -> the object's type type(name, bases, dict) -> a new type
  • handlers.resultsViewer.ViewerMixin: Mixin class for all the results viewer handlers.
    • handlers.viewDirsPlain.Handler: Creates a plain list view of the directories.
    • handlers.viewFilesPlain.Handler: Creates a plain list view of the files.
• exceptions.Exception: Common base class for all exceptions.
  • exceptions.StandardError: Base class for all standard Python exceptions.
    • exceptions.AssertionError: Assertion failed.
• zigo.Controller: Uses a Handler stack and walks through trees of directories.