Changeset 3810 for TI01-discovery/branches/ingestAutomation-upgrade/OAIBatch/FileUtilities.py

Timestamp:

21/04/08 13:10:30 (13 years ago)

Author:

cbyrom

Message:

Create Logger class to standardise output - and allow this to be
switched on/off with a verbose flag.
Implement the logger in several other classes + extend available logging in these.
Also, add a 'usage' method to oai_ingest_new to show proper usage of script.

File:

• TI01-discovery/branches/ingestAutomation-upgrade/OAIBatch/FileUtilities.py (modified) (1 diff)

TI01-discovery/branches/ingestAutomation-upgrade/OAIBatch/FileUtilities.py

@@ -1 @@
-import os
-import sys
+import os, sys
+from Logger import Logger
+
 class FileUtilities:
-        '''
+    '''
         Various helper methods for setting up and cleaning filesystems 
-        C Byrom Apr 08
-        '''
-
-def makepath(path):
-    """ creates missing directories for the given path and
-        returns a normalized absolute version of the path.
-
-    - if the given path already exists in the filesystem
-      the filesystem is not modified.
-
-    - otherwise makepath creates directories along the given path
-      using the dirname() of the path. You may append
-      a '/' to the path if you want it to be a directory path.
-
-    from holger@trillke.net 2002/03/18
-    """
-    from os import makedirs
-    from os.path import normpath,dirname,exists,abspath
-
-    print "INFO: Creating dir: %s" %path 
-    dpath = normpath(dirname(path))
-    if not exists(dpath):
-        makedirs(dpath)
-    return normpath(abspath(path))
-
-def setUpDir(dir):
-        '''
-        Clean out specified directory - or create this, if it doesn't already exist
-        @param dir: directory to set up/clean
-        '''
-        print "Setting up directory, %s" %dir
-        if os.path.isdir(dir):
-                cleanDir(dir)
-        else:
-                try:
-                        makepath(dir)
-                except:
-                        sys.exit("Failed at setting up directory, %s" %dir)
+    C Byrom Apr 08
+    '''
+    logger = None
+    def __init__(self, inLogger):
+        '''
+        Constructor - to set up the utils with a default logger
+        @param logger: logger to use; if none specified, use default logger.  NB, logger must 
+                support a 'printOutput' method
+        '''
+        if inLogger is not None:
+            self.logger = inLogger
+        else:
+            self.logger = Logger(True)
 
 
-def cleanDir(dir):
-        '''
-        Remove all files from the specified directory
-        @param dir: directory to clean 
-        '''
-        print "INFO: Cleaning dir %s" %dir
-        commandline = "ls -1 " + dir + " | xargs -i rm " + dir + "{\}"
-        print "INFO: Executing : " + commandline
-        status = os.system(commandline)
-        if status !=0:
-            sys.exit("Failed at cleaning out directory, %s" %dir)
+    def makepath(self, path):
+        ''' creates missing directories for the given path and
+            returns a normalized absolute version of the path.
+    
+        - if the given path already exists in the filesystem
+          the filesystem is not modified.
+    
+        - otherwise makepath creates directories along the given path
+          using the dirname() of the path. You may append
+          a '/' to the path if you want it to be a directory path.
+    
+        from holger@trillke.net 2002/03/18
+        '''
+        from os import makedirs
+        from os.path import normpath,dirname,exists,abspath
+    
+        self.logger.printOutput("INFO: Creating dir: " + path) 
+        dpath = normpath(dirname(path))
+        if not exists(dpath):
+            makedirs(dpath)
+        return normpath(abspath(path))
 
-        
-def makeBackUp(original_dir, backup_dir):
-        '''
-        Copy contents of original dir into backup dir
-        @param original_dir: dir to backup
-        @param backup_dir: dir to backup to  
-        '''
-        print "Creating backup directory (%s --> %s)" %original_dir %backup_dir
-        commandline = "mkdir " + backup_dir
-        print "INFO: Executing : " + commandline
-        status = os.system(commandline)
-        if status !=0:
-                sys.exit("Failed at creating backup directory %s" %backup_dir)
+    
+    def setUpDir(self, dir):
+        '''
+        Clean out specified directory - or create this, if it doesn't already exist
+        @param dir: directory to set up/clean
+        '''
+        self.logger.printOutput("Setting up directory, " + dir)
+        if os.path.isdir(dir):
+            self.cleanDir(dir)
+        else:
+            try:
+                makepath(dir)
+            except:
+                sys.exit("Failed at setting up directory, %s" %dir)
 
-                commandline = "ls -1 " + original_dir + " | xargs -i cp " + original_dir + "{\} " + backup_dir
-                print "INFO: Executing : " + commandline
-                status = os.system(commandline)
-                if status !=0:
-                        sys.exit("Failed at copying to backup directory %s" %backup_dir)
-        
+
+    def cleanDir(self, dir):
+        '''
+        Remove all files from the specified directory
+        @param dir: directory to clean 
+        '''
+        self.logger.printOutput("INFO: Cleaning dir " + dir)
+        commandline = "ls -1 " + dir + " | xargs -i rm " + dir + "{\}"
+        self.logger.printOutput("INFO: Executing : " + commandline)
+        
+        status = os.system(commandline)
+        if status !=0:
+            sys.exit("Failed at cleaning out directory, %s" %dir)
+
+        
+    def makeBackUp(self, original_dir, backup_dir):
+        '''
+        Copy contents of original dir into backup dir
+        @param original_dir: dir to backup
+        @param backup_dir: dir to backup to  
+        '''
+        self.logger.printOutput("Creating backup directory (" + original_dir + \
+                                " --> " + backup_dir + ")")
+        commandline = "mkdir " + backup_dir
+        self.logger.printOutput("INFO: Executing : " + commandline)
+        status = os.system(commandline)
+        if status !=0:
+            sys.exit("Failed at creating backup directory %s" %backup_dir)
+    
+            commandline = "ls -1 " + original_dir + " | xargs -i cp " + original_dir + "{\} " + backup_dir
+            self.logger.printOutput("INFO: Executing : " + commandline)
+            status = os.system(commandline)
+            if status !=0:
+                sys.exit("Failed at copying to backup directory %s" %backup_dir)
+