Functions
def	loadListFromFile (filename)

def	save_history (historyPath=historyPath)

def	sectionNofTotal (inputList, currentSection, numSections)

Variables
	historyPath

Function Documentation

◆ loadListFromFile()

def FileUtils.loadListFromFile ( filename )

Loads a list of strings from file.  Will append to given list
if asked.

Definition at line 6 of file FileUtils.py.

References print().

 def loadListFromFile (filename):
     """Loads a list of strings from file.  Will append to given list
     if asked."""
     retval = []
     filename = os.path.expanduser (filename)
     if not os.path.exists (filename):
         print("Error: file '%s' does not exist."%(filename))
         raise RuntimeError("Bad filename")
     source = open (filename, 'r')            for line in source.readlines():
         line = re.sub (r'#.+$', '', line) # remove comment characters
         line = line.strip()
         if len (line):
             retval.append (line)
     source.close()
     return retval
 
 

◆ save_history()

def FileUtils.save_history ( historyPath = historyPath )

Definition at line 60 of file FileUtils.py.

     def save_history(historyPath=historyPath):
         import readline
         readline.write_history_file(historyPath)
         if os.path.exists(historyPath):
             readline.read_history_file(historyPath)
 
 

◆ sectionNofTotal()

def FileUtils.sectionNofTotal	(	inputList,
		currentSection,
		numSections
	)

Returns the appropriate sublist given the current section
(1..numSections)

Definition at line 24 of file FileUtils.py.

 def sectionNofTotal (inputList, currentSection, numSections):
     """Returns the appropriate sublist given the current section
     (1..numSections)"""
     currentSection -= 1 # internally, we want 0..N-1, not 1..N
     size       = len (inputList)
     perSection = size // numSections
     extra      = size %  numSections
     start      = perSection * currentSection
     num        = perSection
     if currentSection < extra:
         # the early sections get an extra item
         start += currentSection
         num   += 1
     else:
         start += extra
     stop = start + num
     return inputList[ start:stop ]
 
 

Variable Documentation

◆ historyPath

FileUtils.historyPath

Definition at line 57 of file FileUtils.py.