LAL  7.1.7.1-56c71ae
lal.git_version Namespace Reference

Data Structures

class  VersionMismatchError
 

Functions

def check_match (foreign_id, onmismatch="raise")
 If foreign_id != id, perform an action specified by the onmismatch kwarg. More...
 

Variables

string id = "56c71aeb0381e38938e0474e85a89187384dfb98"
 
string date = "2022-05-27 14:53:21 +0000"
 
string branch = "None"
 
string tag = "None"
 
string author = "Duncan Macleod <duncan.macleod@ligo.org>"
 
string builder = "Unknown User <>"
 
string committer = "Duncan Macleod <duncan.macleod@ligo.org>"
 
string status = "CLEAN: All modifications committed"
 
string version = id
 
string verbose_msg
 

Function Documentation

◆ check_match()

def lal.git_version.check_match (   foreign_id,
  onmismatch = "raise" 
)

If foreign_id != id, perform an action specified by the onmismatch kwarg.

This can be useful for validating input files.

onmismatch actions: "raise": raise a VersionMismatchError, stating both versions involved "warn": emit a warning, stating both versions involved

Definition at line 54 of file git_version.py.

Variable Documentation

◆ id

string lal.git_version.id = "56c71aeb0381e38938e0474e85a89187384dfb98"

Definition at line 23 of file git_version.py.

◆ date

string lal.git_version.date = "2022-05-27 14:53:21 +0000"

Definition at line 24 of file git_version.py.

◆ branch

string lal.git_version.branch = "None"

Definition at line 25 of file git_version.py.

◆ tag

lal.git_version.tag = "None"

Definition at line 26 of file git_version.py.

◆ author

string lal.git_version.author = "Duncan Macleod <duncan.macleod@ligo.org>"

Definition at line 29 of file git_version.py.

◆ builder

string lal.git_version.builder = "Unknown User <>"

Definition at line 30 of file git_version.py.

◆ committer

string lal.git_version.committer = "Duncan Macleod <duncan.macleod@ligo.org>"

Definition at line 31 of file git_version.py.

◆ status

string lal.git_version.status = "CLEAN: All modifications committed"

Definition at line 32 of file git_version.py.

◆ version

string lal.git_version.version = id

Definition at line 33 of file git_version.py.

◆ verbose_msg

string lal.git_version.verbose_msg
Initial value:
1 = """Branch: None
2 Tag: None
3 Id: 56c71aeb0381e38938e0474e85a89187384dfb98
4 
5 Builder: Unknown User <>
6 Repository status: CLEAN: All modifications committed"""

Definition at line 34 of file git_version.py.