meta-diff.py

Go to the documentation of this file.

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
"""This script reads metadata from a given file"""
 
import argparse
import os
import sys
 
from PyUtils.MetaDiff import meta_diff
 
# escape sequence [?1034h which appear on several runs due to smm capability
# (Meta Mode On) for xterm.
if "TERM" in os.environ:
    del os.environ["TERM"]
 
 
def main():
    """Handle command line arguments and call meta_diff"""
 
    parser = argparse.ArgumentParser(
        description="Compare the metadata content of two files"
    )
 
    parser.add_argument(
        "files",
        nargs=2,
        metavar="FILE",
        help="The names of two files to compare",
    )
 
    parser.add_argument(
        "-v",
        "--verbose",
        action="store_true",
        help="print detailed output on screen",
    )
 
    parser.add_argument(
        "-s",
        "--ordered",
        action="store_true",
        help="When comparing lists, check the element order too.",
    )
    
    parser.add_argument(
        "-r",
        "--regex",
        action="store_true",
        help="Allows filtering by regex instead of by plain string",
    )
    
    parser.add_argument(
        "-k",
        "--key-only",
        action="store_true",
        help="Show only the keys and not the difference",
    )
 
    parser.add_argument(
        "-d",
        "--drop",
        nargs="+",
        default=None,
        metavar="KEY",
        help="Keys to drop from metadata retrieved from file. Separe nested dictionary keys using '.'. An '*' matches any key.",
    )
 
    parser.add_argument(
        "-m",
        "--mode",
        default="full",
        metavar="MODE",
        type=str,
        choices=["tiny", "lite", "full", "peeker"],
        help="""\
             This flag provides the user capability to select the amount of
             metadata retrieved. There are four options:
                         tiny (only those values used in PyJobTransforms),
                         lite
                         peeker
                         and full ( all  available data found)
             """,
    )
 
    parser.add_argument(
        "-t",
        "--type",
        default=None,
        metavar="TYPE",
        type=str,
        choices=["POOL", "BS"],
        help="""\
             The file type of the input filename. By default, it tries to
             determine itself the file type of the input.
             """,
    )
 
    parser.add_argument(
        "-f",
        "--filter",
        default=[],
        metavar="FILTER",
        nargs="+",
        type=str,
        help="Expression to select specific metadata fields to retrieve.",
    )
 
    parser.add_argument(
        "-x",
        "--diff-format",
        default="simple",
        type=str,
        choices=["simple", "diff"],
        help="Switch between 'simple' or 'diff' style differences ",
    )
 
    parser.add_argument(
        "--promote",
        default=None,
        type=bool,
        help="Force promotion or not of the metadata keys ",
    )
 
    parser.add_argument(
        "--ignoreTrigger",
        action='store_true',
        help="Ignore trigger metadata",
    )
 
    args = parser.parse_args()
 
    if len(args.files) != 2:
        print("you must supply two files to compare")
        sys.exit(1)
      
    for file_name in args.files:
        if not os.path.exists(file_name):
            print("File does not exists: {}".format(file_name))
            sys.exit(1)
 
    
    diff = meta_diff(
        args.files,
        verbose=args.verbose,
        ordered=args.ordered,
        drop=args.drop,
        mode=args.mode,
        meta_key_filter=args.filter,
        file_type=args.type,
        promote=args.promote,
        diff_format=args.diff_format,
        regex=args.regex,
        key_only=args.key_only,
        ignore_trigger=args.ignoreTrigger,
    )
 
 
    if diff:
        print("\n".join(diff))
        sys.exit(1)
 
    sys.exit(0)
 
 
if __name__ == "__main__":
    main()