PyFoam.Basics.LineReader module

Read a file line by line

class PyFoam.Basics.LineReader.LineReader(stripAllSpaces=True)

Bases: object

Read a line from a file

The line is stripped of whitespaces at the start and the end of the line and stored in a variable self.line

__dict__ = mappingproxy({'__module__': 'PyFoam.Basics.LineReader', '__doc__': 'Read a line from a file\n\n    The line is stripped of whitespaces at the start and the end of\n    the line and stored in a variable self.line', '__init__': <function LineReader.__init__>, 'bytesRead': <function LineReader.bytesRead>, 'reset': <function LineReader.reset>, 'userSaidStop': <function LineReader.userSaidStop>, 'read_and_interrupt': <function LineReader.read_and_interrupt>, 'read': <function LineReader.read>, '__dict__': <attribute '__dict__' of 'LineReader' objects>, '__weakref__': <attribute '__weakref__' of 'LineReader' objects>, '__annotations__': {}})

__init__(stripAllSpaces=True)

Parameters:

stripAllSpaces – remove all spaces from the line (instead of

only those on the left side)

__module__ = 'PyFoam.Basics.LineReader'

__weakref__

list of weak references to the object (if defined)

bytesRead()

Returns:

number of bytes that were already read

read(fh)

read_and_interrupt(fh)

reads the next line

fh - filehandle to read from

Return value: False if the end of the file was reached. True otherwise

reset()

Reset the reader

userSaidStop()

Returns:

whether the reader caught a Keyboard-interrupt