CheckPhotonLibraryJobs.FileListIterator Class Reference

Public Member Functions
def	__init__
def	__iter__
def	__next__

Public Attributes
	fileIter
	lineNo
	fileNo

Detailed Description

Iterator: returns one file name at each iteration.

The text file is expected to have one file name per line. Lines are stripped
(`str.strip()`) of spaces.
Empty lines and lines which are a comment are skipped.
A comment line is a line whose first non-blank character is a hash character
('#').

The value returned at each iteration is (lineNo, fileNo, fileName); if
`withLineNo` or `withFileNo` are `False`, the respective element is omitted.
If only the file name is requested (all other option `False`) the return value
is not a tuple but just the file name.

Definition at line 88 of file CheckPhotonLibraryJobs.py.

Constructor & Destructor Documentation

def CheckPhotonLibraryJobs.FileListIterator.__init__	(		self,
			listFile
	)

Definition at line 104 of file CheckPhotonLibraryJobs.py.

    listFile: "text file containing the list" = None,
    listName: "path of the text file containing the list" = None,
    withLineNo: "whether to return also the number of line in file" = False,
    withFileNo: "whether to return also the number of file" = False,
   ):
    assert listFile or listName
    
    if not listFile: listFile = open(listName, 'r')
    self.fileIter = iter(listFile)
    self.lineNo = 0 if withLineNo else None