lalpulsar.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 = "b72065aa91ee35dd80e1b6021dcd79873bfb48c8"
string	date = "2024-04-26 08:36:20 +0000"
string	branch = "None"
string	tag = "None"
string	author = "Karl Wette <karl.wette@ligo.org>"
string	builder = "Unknown User <>"
string	committer = "Karl Wette <karl.wette@ligo.org>"
string	status = "CLEAN: All modifications committed"
string	version = id
string	verbose_msg

Function Documentation

check_match()

def lalpulsar.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 lalpulsar.git_version.id = "b72065aa91ee35dd80e1b6021dcd79873bfb48c8"

Definition at line 23 of file git_version.py.

date

string lalpulsar.git_version.date = "2024-04-26 08:36:20 +0000"

Definition at line 24 of file git_version.py.

branch

string lalpulsar.git_version.branch = "None"

Definition at line 25 of file git_version.py.

tag

lalpulsar.git_version.tag = "None"

Definition at line 26 of file git_version.py.

author

string lalpulsar.git_version.author = "Karl Wette <karl.wette@ligo.org>"

Definition at line 29 of file git_version.py.

builder

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

Definition at line 30 of file git_version.py.

committer

string lalpulsar.git_version.committer = "Karl Wette <karl.wette@ligo.org>"

Definition at line 31 of file git_version.py.

status

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

Definition at line 32 of file git_version.py.

version

string lalpulsar.git_version.version = id

Definition at line 33 of file git_version.py.

verbose_msg

string lalpulsar.git_version.verbose_msg

Initial value:

=  """Branch: None
Tag: None
Id: b72065aa91ee35dd80e1b6021dcd79873bfb48c8
 
Builder: Unknown User <>
Repository status: CLEAN: All modifications committed"""

Definition at line 34 of file git_version.py.