MPCDAnalysis.ProgramVersionDatabase.ProgramVersionDatabase Class Reference

Public Member Functions
def	__init__ (self)
def	returnCurrentRepositoryDescription (self)
def	commitContainsNoKnownBugs (self, commit)
def	currentCommitContainsNoKnownBugs (self)

Public Attributes
	repository
	knownBugs

Detailed Description

Provides information on the versions of the OpenMPCD program.

Definition at line 9 of file ProgramVersionDatabase.py.

Constructor & Destructor Documentation

__init__()

def MPCDAnalysis.ProgramVersionDatabase.ProgramVersionDatabase.__init__

(

self

)

    The constructor.

    This will require a file `.OpenMPCD/config/ProgramVersionDatabase.yaml`
    to be readable, and contain in `repositoryPath` the path to the git
    repository of the `OpenMPCD` project. The path may contain an initial '~'
    character, which will be expanded to the user's home directory.

Definition at line 20 of file ProgramVersionDatabase.py.

Member Function Documentation

commitContainsNoKnownBugs()

def MPCDAnalysis.ProgramVersionDatabase.ProgramVersionDatabase.commitContainsNoKnownBugs	(		self,
			commit
	)

    Returns whether the specified `commit` contains no known bugs.

Definition at line 84 of file ProgramVersionDatabase.py.

currentCommitContainsNoKnownBugs()

def MPCDAnalysis.ProgramVersionDatabase.ProgramVersionDatabase.currentCommitContainsNoKnownBugs

(

self

)

    Returns whether the current commit contains no known bugs.

    Untracked and unstaged changes are ignored for this function.

Definition at line 102 of file ProgramVersionDatabase.py.

returnCurrentRepositoryDescription()

def MPCDAnalysis.ProgramVersionDatabase.ProgramVersionDatabase.returnCurrentRepositoryDescription

(

self

)

    Returns the current commit SHA1 id, with the string "+MODIFICATIONS"
    appended if any of the currently tracked files have been modified, and
    with the string "+UNTRACKED" appended if there are files which are not
    tracked.

Definition at line 47 of file ProgramVersionDatabase.py.

---

The documentation for this class was generated from the following file:

• ProgramVersionDatabase.py