In This Package:

FileDescription.py

Go to the documentation of this file.

# FileDescription
#
# Helper class for handling data filenames
#
# Created by: dandwyer@caltech.edu 2010/08/09


class FileDescription:
    """Class to handle filename parsing"""
    def __init__(self, fileName=None):
        """Construct using filename string"""
        self.dirSep = '/'
        self.fileSep = '.'
        self.seqStrip = '_'
        self.clear()
        if fileName!=None:
            self.setByFileName( fileName )
        return

    def clear(self):
        """Clear/initialize file descriptor""" 
        self.path = None
        self.process = None
        self.tag = None
        self.runNumber = None
        self.streamType = None
        self.streamName = None
        self.appName = None
        self.sequence = None
        self.fileType = None
        self.isValid = False
        return

    def setByFileName(self, fileName):
        """Parse filename to initialise file descriptor"""
        self.clear()
        fname = fileName.strip()
        sepLocation = fname.rfind(self.dirSep)
        path = None
        if sepLocation >= 0:
            path = fname[:sepLocation]
            fname = fname[sepLocation+1:]
        fileParts = fname.split(self.fileSep)
        if len(fileParts) != 8:
            print "Error: Incorrect filename structure: '%s'" % fname
            return
        runString = fileParts[2]
        if not runString.isdigit():
            print "Error: Incorrect run number: '%s'" % runString
            return
        seqString = fileParts[6].strip(self.seqStrip)
        if not seqString.isdigit():
            print "Error: Incorrect sequence number: '%s'" % seqString
            return
        self.set(path, fileParts[0], fileParts[1], int(runString),
                 fileParts[3], fileParts[4], fileParts[5], int(seqString),
                 fileParts[7])

    def set(self, path, process, tag, runNumber, streamType, streamName,
            appName, sequence, fileType):
        """Set file descriptor"""
        self.path = path
        self.process = process
        self.tag = tag
        self.runNumber = runNumber
        self.streamType = streamType
        self.streamName = streamName
        self.appName = appName
        self.sequence = sequence
        self.fileType = fileType
        self.isValid = True
        if self.streamType=="AllStreams":
            self.isValid = False
        return

---