compareFiles Namespace Reference

Classes
class	Report

Functions
def	compare_corrections (c1, c2)
def	compare_files (old, new)
def	json_load (path)

Variables
	parser = argparse.ArgumentParser(description="Compares the content of two correction JSON files. Assumes their content are valid schemav2.")
	nargs
	help
	args = parser.parse_args()
	files = map(json_load, args.files)
def	report = compare_files(*files)

Function Documentation

compare_corrections()

def compareFiles.compare_corrections	(		c1,
			c2
	)

Return False if the two corrections differ in their content
Differences in name, version or description are not considered

def compare_corrections(c1, c2):
    """Return False if the two corrections differ in their content
    Differences in name, version or description are not considered"""
 
    for key in ["inputs", "output", "data", "generic_formulas"]:
        if c1.get(key) != c2.get(key):
            return False
    return True
 
 

compare_files()

def compareFiles.compare_files	(		old,
			new
	)

def compare_files(old, new):
    corrs_old = old["corrections"]
    names_vers_old = { (c["name"], c["version"]) for c in corrs_old }
    names_old = { nv[0] for nv in names_vers_old }
    corrs_new = new["corrections"]
    names_vers_new = { (c["name"], c["version"]) for c in corrs_new }
 
    report = Report()
    report.corrs_removed = names_vers_old - names_vers_new
 
    for corr in corrs_new:
        name = corr["name"]
        vers = corr["version"]
 
        # new correction name, not present in old file
        if name not in names_old:
            report.corr_added.append(correctionlib.schemav2.Correction.parse_obj(corr))
            continue
 
        # we know there is a correction with the same name in the old file
        corrs_old_same_name = [ c for c in corrs_old if c["name"] == name ]
 
        # -> check if there is one with the same version
        old_same_version = next((c for c in corrs_old_same_name if c["version"] == vers), None)
 
        if old_same_version:
            # same version but different content -> problem!
            if not compare_corrections(old_same_version, corr):
                report.corr_version_error.add((name, vers))
            continue
 
        # different version -> check the version increased
        old_max_version = max(corrs_old_same_name, key=lambda c: c["version"])
        if old_max_version["version"] > vers:
            report.corr_version_error.add((name, vers))
        else:
            report.corr_updated.append(
                (correctionlib.schemav2.Correction.parse_obj(old_max_version),
                correctionlib.schemav2.Correction.parse_obj(corr)))
 
    return report
 
 

json_load()

def compareFiles.json_load

(

path

)

    def json_load(path):
        data = correctionlib.highlevel.open_auto(path)
        return json.loads(data)

Variable Documentation

args

args = parser.parse_args()

files

files = map(json_load, args.files)

help

help

nargs

nargs

parser

parser = argparse.ArgumentParser(description="Compares the content of two correction JSON files. Assumes their content are valid schemav2.")

report

def report = compare_files(*files)