git_version.py

Go to the documentation of this file.

# -*- coding: utf-8 -*-
# git_version.py - vcs information module
#
# Copyright (C) 2010 Nickolas Fotopoulos
# Copyright (C) 2012-2013 Adam Mercer
# Copyright (C) 2016 Leo Singer
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or (at
# your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with with program; see the file COPYING. If not, write to the
# Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
# MA 02110-1301 USA
 
id = "5e288d307a57761220ddec659d57ae1ab1f4a1d3"
date = "2025-06-17 11:54:06 +0000"
branch = "None"
tag = "None"
if tag == "None":
    tag = None
author = "Geraint Pratten <geraint.pratten@ligo.org>"
builder = "Unknown User <>"
committer = "Geraint Pratten <geraint.pratten@ligo.org>"
status = "CLEAN: All modifications committed"
version = id
verbose_msg = """Branch: None
Tag: None
Id: 5e288d307a57761220ddec659d57ae1ab1f4a1d3
 
Builder: Unknown User <>
Repository status: CLEAN: All modifications committed"""
 
import warnings
 
class VersionMismatchError(ValueError):
    pass
 
def 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
    """
    if onmismatch not in ("raise", "warn"):
        raise ValueError(onmismatch + " is an unrecognized value of onmismatch")
    if foreign_id == "5e288d307a57761220ddec659d57ae1ab1f4a1d3":
        return
    msg = "Program id (5e288d307a57761220ddec659d57ae1ab1f4a1d3) does not match given id (%s)." % foreign_id
    if onmismatch == "raise":
        raise VersionMismatchError(msg)
 
    # in the backtrace, show calling code
    warnings.warn(msg, UserWarning)