PyFoam.RunDictionary.FileBasis module

Basis for the handling of OpenFOAM-files

Transparently accepts gnuzipped files

class PyFoam.RunDictionary.FileBasis.CleanCharactersFile(name, charsToRemove)

Bases: FileBasis

Read file and remove characters from the content

__annotations__ = {}

__init__(name, charsToRemove)

@param charsToRemove: string with characters that should be removed

__module__ = 'PyFoam.RunDictionary.FileBasis'

parse(cnt)

Parse a string that is to be the content, to be overriden by the sub-classes

class PyFoam.RunDictionary.FileBasis.FileBasis(name, createZipped=True, useBinary=False)

Bases: Utilities

Base class for the other OpenFOAM–file-classes

__annotations__ = {}

__enter__()

Making the ‘with’-statement happy

__exit__(typ, value, traceback)

Making the ‘with’-statement happy

__init__(name, createZipped=True, useBinary=False)

Parameters:

name – Name of the file. If the field is zipped the .gz is

appended. Alternatively it can be a filehandle :param createZipped: if the file doesnot exist: should it be created as a zipped file?

__module__ = 'PyFoam.RunDictionary.FileBasis'

__str__()

Build a string from self.content, to be overriden by sub-classes

addedString = '//PyFoamAdded'

Comment for lines that were added by PyFoam-routines

baseName()

Returns the basic file name (without .gz)

closeFile()

closes the file

copyRest(l, out)

Copy the rest of the file

Parameters:

• l – a LineReader object

• out – filehandle to echo the lines to

encode(txt)

Encode a string to byte if necessary (for Python3)

getCaseDir()

Return the path to the case of this file (if any valid case is found). Else return None

goMatch(l, exp, out=None, stop=None)

Read lines until a regular expression is matched

Parameters:

• l – a LineReader object

• exp – the expression to look for

• out – filehandle to echo the lines to

• stop – pattern that indicates that exp will never be found

Returns:

match-object if exp is found, the line if stop is found and None if the end of the file is reached

goTo(l, s, out=None, echoLast=False, stop=None)

Read lines until a token is found

Parameters:

• l – a LineReader object

• s – the string to look for

• out – filehandle to echo the lines to

• stop – pattern that indicates that exp will never be found (only passed through to goMatch)

• echoLast – echo the line with the string

makeTemp()

creates a temporary file

openFile(keepContent=False, mode='r')

opens the file. To be overloaded by derived classes

parse(cnt)

Parse a string that is to be the content, to be overriden by the sub-classes

purgeFile()

Undo all the manipulations done by PyFOAM

Goes through the file and removes all lines that were added

readFile()

read the whole File into memory

realName()

The full filename with appended .gz (if zipped)

removedString = '//PyFoamRemoved: '

Comment for lines that were overwritten by PyFoam-routines

writeEncoded(out, txt)

Convert the text to ‘bytes’ is we encounter a zipped file

writeFile(content=None)

write the whole File from memory :param content: content that should replace the old content

writeFileAs(name)

Writes a copy of the file. Extends with .gz if the original is zipped :param name: Name under which the file is written

class PyFoam.RunDictionary.FileBasis.FileBasisBackup(name, backup=False, createZipped=True, useBinary=False)

Bases: FileBasis

A file with a backup-copy

__annotations__ = {}

__init__(name, backup=False, createZipped=True, useBinary=False)

Parameters:

• name (str) – The name of the parameter file

• backup (boolean) – create a backup-copy of the file

__module__ = 'PyFoam.RunDictionary.FileBasis'

counter = {}

restore()

if a backup-copy was made the file is restored from this

PyFoam.RunDictionary.FileBasis.exists(name)