PyFoam.Applications.CommonVCSCommit module

Class that implements the common functionality commiting cases to the VCS

class PyFoam.Applications.CommonVCSCommit.CommonVCSCommit[source]

Bases: object

The class that defines options for commiting cases

__dict__ = mappingproxy({'__module__': 'PyFoam.Applications.CommonVCSCommit', '__doc__': ' The class that defines options for commiting cases\n    ', 'addOptions': <function CommonVCSCommit.addOptions>, 'checkAndCommit': <function CommonVCSCommit.checkAndCommit>, '__dict__': <attribute '__dict__' of 'CommonVCSCommit' objects>, '__weakref__': <attribute '__weakref__' of 'CommonVCSCommit' objects>, '__annotations__': {}})
__module__ = 'PyFoam.Applications.CommonVCSCommit'
__weakref__

list of weak references to the object (if defined)

addOptions()[source]
checkAndCommit(sol, msg=None)[source]
Parameters:

  • sol – SolutionDirectory that should be commited

  • msg – The commit message that should be used if none is specified by the user