PyFoam.Basics.Utilities module

Utility functions

Can be used via a class or as functions

class PyFoam.Basics.Utilities.Utilities

Bases: object

Class with utility methods

Can be inherited without side effects by classes that need these methods

__dict__ = mappingproxy({'__module__': 'PyFoam.Basics.Utilities', '__doc__': 'Class with utility methods\n\n    Can be inherited without side effects by classes that need these\n    methods', '__init__': <function Utilities.__init__>, 'execute': <function Utilities.execute>, 'remove': <function Utilities.remove>, 'rmtree': <function Utilities.rmtree>, 'copytree': <function Utilities.copytree>, 'copyfile': <function Utilities.copyfile>, 'writeDictionaryHeader': <function Utilities.writeDictionaryHeader>, 'excludeNames': ['^.svn$', '~$'], 'findFileInDir': <function Utilities.findFileInDir>, 'listDirectory': <function Utilities.listDirectory>, 'which': <function Utilities.which>, 'find': <function Utilities.find>, 'humanReadableSize': <function Utilities.humanReadableSize>, 'humanReadableDuration': <function Utilities.humanReadableDuration>, 'diskUsage': <function Utilities.diskUsage>, '__dict__': <attribute '__dict__' of 'Utilities' objects>, '__weakref__': <attribute '__weakref__' of 'Utilities' objects>, '__annotations__': {}})

__init__()

__module__ = 'PyFoam.Basics.Utilities'

__weakref__

list of weak references to the object (if defined)

copyfile(src, dst)

Encapsulates the shutil copyfile and provides an alternative for old Python-version

copytree(src, dst, symlinks=False, force=False)

Encapsulates the shutil copytree and provides an alternative for old Python-version

diskUsage(fpath)

Calculate the disk space used at the specified path in bytes

excludeNames = ['^.svn$', '~$']

execute(cmd, debug=False, workdir=None, echo=None, outfile=None, getReturnCode=False)

Execute the command cmd. If specified change the working directory

Currently no error-handling is done :return: A list with all the output-lines of the execution

find(pattern, path, directoriesToo=True)

Find all files whose names match :param pattern: glob-style pattern :param path: path under which this files are to be searched :param directoriesToo: also match directories?

findFileInDir(dName, fName)

Find file in a directory (search recursively) :param dName: name of the directory :param fName: name of the file to look force :return: the complete path. Directory and path joined if nothing is found

humanReadableDuration(num)

Creates a string that prints a duration in an easily readable form. Easily readable means that the two highest non-zero values will be printed

humanReadableSize(num)

Lifted from http://stackoverflow.com/questions/1094841/reusable-library-to-get-human-readable-version-of-file-size Gets a number in bytes and returns a human readable string

listDirectory(d)

Lists the files in a directory, but excludes certain names and files with certain endings :param d: The directory to list :return: List of the found files and directories

remove(f)

Remove a file if it exists.

rmtree(dst, ignore_errors=False)

Encapsulates the shutil rmtree and provides an alternative for old Python-version

which(progname)

Get the full path. Return None if not found

writeDictionaryHeader(f)

Writes a dummy header so OpenFOAM accepts the file as a dictionary :param f: The file to write to :type f: file

PyFoam.Basics.Utilities.copyfile(src, dest)

Calls the method of the same name from the Utilites class

PyFoam.Basics.Utilities.copytree(src, dest, symlinks=False, force=False)

Calls the method of the same name from the Utilites class

PyFoam.Basics.Utilities.diskUsage(fpath)

Calls the method of the same name from the Utilites class

PyFoam.Basics.Utilities.execute(cmd, debug=False, workdir=None, echo=None, outfile=None, getReturnCode=False)

Calls the method of the same name from the Utilites class

PyFoam.Basics.Utilities.find(pattern, path, directoriesToo=True)

Calls the method of the same name from the Utilites class

PyFoam.Basics.Utilities.findFileInDir(d, f)

Calls the method of the same name from the Utilites class

PyFoam.Basics.Utilities.humanReadableDuration(num)

Calls the method of the same name from the Utilites class

PyFoam.Basics.Utilities.humanReadableSize(num)

Calls the method of the same name from the Utilites class

PyFoam.Basics.Utilities.listDirectory(d)

Calls the method of the same name from the Utilites class

PyFoam.Basics.Utilities.remove(f)

Calls the method of the same name from the Utilites class

PyFoam.Basics.Utilities.rmtree(path, ignore_errors=False)

Calls the method of the same name from the Utilites class

PyFoam.Basics.Utilities.which(prog)

Calls the method of the same name from the Utilites class

PyFoam.Basics.Utilities.writeDictionaryHeader(f)

Calls the method of the same name from the Utilites class