Source code for fudge.legacy.endl.fudgeDocumentationFile
# <<BEGIN-copyright>>
# <<END-copyright>>
[docs]class fudgeDocumentationFile :
def __init__( self, fileName ) :
"""The __init__ for fudgeDocumentationFile. This method does not read in any data, it only initializes some variables."""
self.fileName = fileName
self.text = None
self.XML_ParserFriendlyText = None
[docs] def read( self ) :
"""Read in the documentation for self. Note, this is not done by the __init__ method."""
if( self.text is None ) :
try :
f = open( self.fileName )
self.text = f.read( )
f.close( )
except :
raise Exception( "\nError in fudgeDocumentationFile.read: could not open documentation file %s" % self.fileName )
[docs] def getText( self ) :
"""Returns the documentation for self. Calls read if file has not been read."""
if( self.text is None ) : self.read( )
return( self.text )
[docs] def getXML_ParserFriendlyText( self ) :
"""Converts &, < and > in the self.text to '&', '<' and '>', respectively and stores it in self.XML_ParserFriendlyText"""
if( self.XML_ParserFriendlyText is None ) :
lines = self.getText( )
if( lines is not None ) :
lines = lines.replace( '&', '&' )
lines = lines.replace( '<', '<' )
self.XML_ParserFriendlyText = lines.replace( '>', '>' )
return( self.XML_ParserFriendlyText )
[docs] def setText( self, text ) :
self.text = text
self.XML_ParserFriendlyText = None
[docs] def write( self, fileName = None ) :
"""If self.text is not equal to None, then its contents are written to file fileName. Self.text must be a python string.
If fileName is None then self.fileName is used."""
if( self.text is None ) : return
if( fileName is None ) : fileName = self.fileName
try :
f = open( fileName, 'w' )
f.write( self.text )
f.close( )
except :
raise Exception( "\nError in fudgeDocumentationFile.write: could not open documentation file %s" % self.fileName )