MetaReader.py

Go to the documentation of this file.

# Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
 
import os
import re
from fnmatch import fnmatchcase
from AthenaCommon.Logging import logging
from AthenaConfiguration.AthConfigFlags import isGaudiEnv
from PyUtils.PoolFile import isRNTuple
from ROOT import gSystem
 
msg = logging.getLogger('MetaReader')
 
# compile the regex needed in _convert_value() outside it to optimize the code.
regexEventStreamInfo = re.compile(r'^EventStreamInfo(_p\d+)?$')
regexIOVMetaDataContainer = re.compile(r'^IOVMetaDataContainer(_p\d+)?$')
regexByteStreamMetadataContainer = re.compile(r'^ByteStreamMetadataContainer(_p\d+)?$')
regexXAODCutBookkeeperContainer = re.compile(r'^xAOD::CutBookkeeperContainer(_v\d+)?$')
regexXAODCutBookkeeperContainerAux = re.compile(r'^xAOD::CutBookkeeperAuxContainer(_v\d+)?$')
regexXAODEventFormat = re.compile(r'^xAOD::EventFormat(_v\d+)?$')
regexXAODFileMetaData = re.compile(r'^xAOD::FileMetaData(_v\d+)?$')
regexXAODFileMetaDataAux = re.compile(r'^xAOD::FileMetaDataAuxInfo(_v\d+)?$')
regexXAODFileMetaDataAuxDyn = re.compile(r'^(xAOD::)?FileMetaData.*AuxDyn(\.[a-zA-Z0-9]+)?$')
regexXAODTriggerMenu = re.compile(r'^DataVector<xAOD::TriggerMenu(_v\d+)?>$') # Run 2
regexXAODTriggerMenuAux = re.compile(r'^xAOD::TriggerMenuAuxContainer(_v\d+)?$') # Run 2
regexXAODTriggerMenuJson = re.compile(r'^DataVector<xAOD::TriggerMenuJson(_v\d+)?>$') # Run 3
regexXAODTriggerMenuJsonAux = re.compile(r'^xAOD::TriggerMenuJsonAuxContainer(_v\d+)?$') # Run 3
regexXAODTruthMetaData = re.compile(r'^DataVector<xAOD::TruthMetaData(_v\d+)?>$')
regexXAODTruthMetaDataAux = re.compile(r'^xAOD::TruthMetaDataAuxContainer(_v\d+)?$')
regex_cppname = re.compile(r'^([\w:]+)(<.*>)?$')
# regex_persistent_class = re.compile(r'^([a-zA-Z]+_p\d+::)*[a-zA-Z]+_p\d+$')
regex_persistent_class = re.compile(r'^([a-zA-Z]+(_[pv]\d+)?::)*[a-zA-Z]+_[pv]\d+$')
regex_BS_files = re.compile(r'^(\w+):.*((\.D?RAW\..*)|(\.data$))')
regex_URI_scheme = re.compile(r'^([A-Za-z0-9\+\.\-]+)\:')
 
lite_primary_keys_to_keep = [
    'lumiBlockNumbers', 'runNumbers', 'mc_event_number', 'mc_channel_number',
    'eventTypes', 'processingTags', 'itemList']
lite_TagInfo_keys_to_keep = [
    'beam_energy', 'beam_type', 'GeoAtlas', 'IOVDbGlobalTag',
    'AODFixVersion', 'project_name', 'mc_campaign']
 
trigger_keys = [
    'TriggerConfigInfo',
    'TriggerMenu', 'TriggerMenuJson_BG', 'TriggerMenuJson_HLT', 'TriggerMenuJson_HLTMonitoring', 'TriggerMenuJson_HLTPS', 'TriggerMenuJson_L1', 'TriggerMenuJson_L1PS',
    '/TRIGGER/HLT/Groups', '/TRIGGER/HLT/HltConfigKeys', '/TRIGGER/HLT/Menu', '/TRIGGER/HLT/PrescaleKey', '/TRIGGER/HLT/Prescales',
    '/TRIGGER/LVL1/ItemDef', '/TRIGGER/LVL1/Lvl1ConfigKey', '/TRIGGER/LVL1/Menu', '/TRIGGER/LVL1/Prescales', '/TRIGGER/LVL1/Thresholds',
    'DataVector<xAOD::TriggerMenuJson_v1>_TriggerMenu', 'DataVector<xAOD::TriggerMenuJson_v1>_TriggerMenuJson_BG', 'DataVector<xAOD::TriggerMenuJson_v1>_TriggerMenuJson_HLT',
    'DataVector<xAOD::TriggerMenuJson_v1>_TriggerMenuJson_HLTMonitoring', 'DataVector<xAOD::TriggerMenuJson_v1>_TriggerMenuJson_HLTPS',
    'DataVector<xAOD::TriggerMenuJson_v1>_TriggerMenuJson_L1', 'DataVector<xAOD::TriggerMenuJson_v1>_TriggerMenuJson_L1PS',
]
 
 
def read_metadata(filenames, file_type = None, mode = 'lite', promote = None, meta_key_filter = None,
                  unique_tag_info_values = True, ignoreNonExistingLocalFiles=False):
    """
    This tool is independent of Athena framework and returns the metadata from a given file.
    :param filenames: the input file from which metadata needs to be extracted.
    :param file_type: the type of file. POOL or BS (bytestream: RAW, DRAW) files.
    :param mode: if true, will return all metadata associated with the filename. By default, is false and this will
    return a "tiny" version which have only the following keys: 'file_guid', 'file_size', 'file_type', 'nentries'.
    :return: a dictionary of metadata for the given input file.
    """
 
    # make the mode available in the _convert methods
    global _gbl_mode
    _gbl_mode = mode
 
    from RootUtils import PyROOTFixes  # noqa F401
 
    # Check if the input is a file or a list of files.
    if isinstance(filenames, str):
        filenames = [filenames]
 
    # Check if file_type is an allowed value
    if file_type is not None:
        if file_type not in ('POOL', 'BS'):
            raise NameError('Allowed values for \'file_type\' parameter are: "POOL" or "BS": you provided "' + file_type + '"')
        else:
            msg.info('Forced file_type: {0}'.format(file_type))
 
    # Check the value of mode parameter
    if mode not in ('tiny', 'lite', 'full', 'peeker', 'iov'):
        raise NameError('Allowed values for "mode" parameter are: "tiny", "lite", "peeker", "iov" or "full"')
 
    if meta_key_filter is None:
        meta_key_filter = []
 
    # Disable 'full' and 'iov' in non-Gaudi environments
    if not isGaudiEnv():
        if mode in ('full', 'iov'):
            raise NameError('The following modes are not available in AnalysisBase: "iov" and "full"')
 
    msg.info('Current mode used: {0}'.format(mode))
    msg.info('Current filenames: {0}'.format(filenames))
 
    if mode != 'full' and mode !='iov' and len(meta_key_filter) > 0:
        raise NameError('It is possible to use the meta_key_filter option only for full mode')
    if meta_key_filter:
        msg.info('Filter used: {0}'.format(meta_key_filter))
 
    # create the storage object for metadata.
    meta_dict = {}
 
    # ----- retrieve metadata from all filename or filenames --------------------------------------------------------#
    for filename in filenames:
        meta_dict[filename] = {}
        current_file_type = None
        # Determine the file_type of the input and store this information into meta_dict
        if not file_type:
            if os.path.isfile(filename):
                
                if ignoreNonExistingLocalFiles and not regex_URI_scheme.match(filename) and gSystem.AccessPathName(filename): # Attention, bizarre convention of return value!! 
                    msg.warn('Ignoring not accessible file: {}'.format(filename))
                    continue
                    
                with open(filename, 'rb') as binary_file:
                    magic_file = binary_file.read(4)
 
                    if magic_file == 'root' or magic_file == b'root':
                        current_file_type = 'POOL'
                        meta_dict[filename]['file_type'] = 'POOL'
 
                    else:
                        current_file_type = 'BS'
                        meta_dict[filename]['file_type'] = 'BS'
 
                    # add information about the file_size of the input filename
                    meta_dict[filename]['file_size'] = os.path.getsize(filename)
 
            # determine the file type for the remote input files
            else:
                if regex_BS_files.match(filename):
                    current_file_type = 'BS'
                    meta_dict[filename]['file_type'] = 'BS'
                else:
                    current_file_type = 'POOL'
                    meta_dict[filename]['file_type'] = 'POOL'
 
                # add information about the file_size of the input filename
                meta_dict[filename]['file_size'] = None  # None -> we can't read the file size for a remote file
 
        else:
            current_file_type = file_type
 
        # ----- retrieves metadata from POOL files ------------------------------------------------------------------#
        if current_file_type == 'POOL':
            
            if ignoreNonExistingLocalFiles and not regex_URI_scheme.match(filename) and gSystem.AccessPathName(filename): # Attention, bizarre convention of return value!! 
                msg.warn('Ignoring not accessible file: {}'.format(filename))
                continue
                    
            import ROOT
            # open the file using ROOT.TFile
            current_file = ROOT.TFile.Open( _get_pfn(filename) )
 
            # get auto flush setting from the main EventData TTree
            from PyUtils.PoolFile import PoolOpts
            collectionTree = current_file.Get(PoolOpts.TTreeNames.EventData)
            if isinstance(collectionTree, ROOT.TTree):
                meta_dict[filename]['auto_flush'] = collectionTree.GetAutoFlush()
 
            # read and add the 'GUID' value
            meta_dict[filename]['file_guid'] = _read_guid(filename)
 
            # read and add compression level and algorithm
            meta_dict[filename]['file_comp_alg'] = current_file.GetCompressionAlgorithm()
            meta_dict[filename]['file_comp_level'] = current_file.GetCompressionLevel()
 
            if isRNTuple( current_file.Get(PoolOpts.RNTupleNames.MetaData) ):
                msg.warning(
                    "Reading in-file metadata from RNTuple is currently of limited support"
                )
                meta_dict[filename]["nentries"] = dataheader_nentries(current_file)
 
                def get_raw_md(filename):
                    """Helper function to read the raw metadata from RNTuple.
                    We use subprocess because output from RNTupleReader uses
                    std::ostream for output, which is not captured by PyROOT.
 
                    Returns the raw metadata as a json-like string, but one cannot
                    assume it is valid json.
 
                    Known issues of invalid json constructs:
                    - double quotes are not escaped in string values
                    - single-quoted strings
                    - nested json objects and lists inside single-quoted strings
                    """
                    import subprocess
                    import sys
 
                    raw_md = f"""
from ROOT.Experimental import RNTupleReader
from ROOT import TFile
 
 
def read_md(infile):
    file_handle = TFile.Open(infile)
    md = file_handle.Get("MetaData")
    reader = RNTupleReader.Open(md)
    reader.Show(0)
 
read_md("{filename}")
                    """
                    result = subprocess.run(
                        [sys.executable, "-c", raw_md],
                        capture_output=True,
                        text=True,
                    )
                    raw_data = "".join(result.stdout.split())
                    return raw_data.replace("\x00", '""')
 
                def extract_keys(json_like_string, keys):
                    """Helper for extracting key-value pairs from json-like string"""
                    import json
 
                    result = {}
                    for key in keys:
                        if key == "m_eventTypes":
                            pattern = rf'"{key}":(\[\{{.*?\}}\])'
                        elif "beamEnergy" in key:
                            pattern = rf'"{key}":(\b[+]?([0-9]*\.[0-9]+|[0-9]+\.?[0-9]*)[eE][+]?([0-9]+)\b)'
                        else:
                            pattern = rf'"{key}"\s*:\s*(\[[^\]]*\]|"[^"]*"|\d+)'
                        match = re.search(pattern, json_like_string)
                        if match:
                            try:
                                result[key] = json.loads(match.group(1))
                            except json.JSONDecodeError:
                                pass
                    return result
 
                # metadata keys which can be relatively reliably extracted from RNTuple
                keys_to_extract = [
                    "m_numberOfEvents",
                    "m_runNumbers",
                    "m_lumiBlockNumbers",
                    "m_processingTags",
                    "m_itemList",
                    "m_eventTypes",
                    "m_branchNames",
                    "m_classNames",
                    "FileMetaDataAuxDyn:amiTag",
                    "FileMetaDataAuxDyn:AODFixVersion",
                    "FileMetaDataAuxDyn:AODCalibVersion",
                    "FileMetaDataAuxDyn:beamEnergy",
                    "FileMetaDataAuxDyn:beamType",
                    "FileMetaDataAuxDyn:conditionsTag",
                    "FileMetaDataAuxDyn:dataYear",
                    "FileMetaDataAuxDyn:generatorsInfo",
                    "FileMetaDataAuxDyn:geometryVersion",
                    "FileMetaDataAuxDyn:isDataOverlay",
                    "FileMetaDataAuxDyn:mcCampaign",
                    "FileMetaDataAuxDyn:mcProcID",
                    "FileMetaDataAuxDyn:simFlavour",
                    "productionRelease",
                    "dataType",
                ]
 
                result = extract_keys(get_raw_md(filename), keys_to_extract)
 
                item_list = []
                from CLIDComps.clidGenerator import clidGenerator
 
                cgen = clidGenerator("")
                for item in result["m_itemList"]:
                    item_list.append((cgen.getNameFromClid(item["_0"]), item["_1"].encode("utf-8")))
                meta_dict[filename]["itemList"] = item_list
                event_types = []
                for event_type in result["m_eventTypes"]:
                    fields = {
                        key.removeprefix("m_"): value
                        for key, value in event_type.items()
                    }
                    fields = _convert_event_type_bitmask(fields)
                    fields = _convert_event_type_user_type(fields)
                    event_types.extend(fields["type"])
                meta_dict[filename]["eventTypes"] = event_types
                meta_dict[filename]["numberOfEvents"] = result["m_numberOfEvents"]
                meta_dict[filename]["runNumbers"] = result["m_runNumbers"]
                meta_dict[filename]["lumiBlockNumbers"] = result["m_lumiBlockNumbers"]
                meta_dict[filename]["processingTags"] = result["m_processingTags"]
 
                meta_dict[filename]["EventFormat"] = {}
                ef_items = {}
                for branch_name, class_name in dict(
                    zip(
                        result["m_branchNames"],
                        result["m_classNames"],
                    )
                ).items():
                    ef_items[branch_name] = class_name
                meta_dict[filename]["EventFormat"] = ef_items
 
                meta_dict[filename]["FileMetaData"] = {}
                for key in keys_to_extract:
                    try:
                        meta_dict[filename]["FileMetaData"][key.split(":")[1]] = (
                            result[key]
                        )
                    except (IndexError, KeyError):
                        continue
                msg.debug(f"Read metadata from RNTuple: {meta_dict[filename]}")
                return meta_dict
 
            # ----- read extra metadata required for 'lite' and 'full' modes ----------------------------------------#
            if mode != 'tiny':
                # selecting from all tree the only one which contains metadata, respectively "MetaData"
                metadata_tree = current_file.Get('MetaData')
                # read all list of branches stored in "MetaData" tree
                metadata_branches = metadata_tree.GetListOfBranches()
                nr_of_branches = metadata_branches.GetEntriesFast()
 
                # object to store the names of metadata containers and their corresponding class name.
                meta_dict[filename]['metadata_items'] = {}
 
                # create a container for the list of filters used for the lite version
                meta_filter = {}
 
                # set the filters for name
                if mode == 'lite':
                    if isGaudiEnv():
                        meta_filter = {
                            '/TagInfo': 'IOVMetaDataContainer_p1',
                            'IOVMetaDataContainer_p1__TagInfo': 'IOVMetaDataContainer_p1',
                            '*': 'EventStreamInfo_p*'
                        }
                    else:
                        meta_filter = {
                            'FileMetaData': '*',
                            'FileMetaDataAux.': 'xAOD::FileMetaDataAuxInfo_v1',
                        }
 
                # set the filters for name
                if mode == 'peeker':
                    meta_filter.update({
                        'TriggerMenu': 'DataVector<xAOD::TriggerMenu_v1>', # R2 trigger metadata format AOD (deprecated)
                        'TriggerMenuAux.': 'xAOD::TriggerMenuAuxContainer_v1',
                        'DataVector<xAOD::TriggerMenu_v1>_TriggerMenu': 'DataVector<xAOD::TriggerMenu_v1>', # R2 trigger metadata format ESD (deprecated)
                        'xAOD::TriggerMenuAuxContainer_v1_TriggerMenuAux.': 'xAOD::TriggerMenuAuxContainer_v1',
                        'TriggerMenuJson_HLT': 'DataVector<xAOD::TriggerMenuJson_v1>', # R3 trigger metadata format AOD
                        'TriggerMenuJson_HLTAux.': 'xAOD::TriggerMenuJsonAuxContainer_v1',
                        'TriggerMenuJson_HLTMonitoring': 'DataVector<xAOD::TriggerMenuJson_v1>', # R3 trigger metadata format AOD
                        'TriggerMenuJson_HLTMonitoringAux.': 'xAOD::TriggerMenuJsonAuxContainer_v1',
                        'TriggerMenuJson_HLTPS': 'DataVector<xAOD::TriggerMenuJson_v1>', # R3 trigger metadata format AOD
                        'TriggerMenuJson_HLTPSAux.': 'xAOD::TriggerMenuJsonAuxContainer_v1',
                        'TriggerMenuJson_L1': 'DataVector<xAOD::TriggerMenuJson_v1>', # R3 trigger metadata format AOD
                        'TriggerMenuJson_L1Aux.': 'xAOD::TriggerMenuJsonAuxContainer_v1',
                        'TriggerMenuJson_L1PS': 'DataVector<xAOD::TriggerMenuJson_v1>', # R3 trigger metadata format AOD
                        'TriggerMenuJson_L1PSAux.': 'xAOD::TriggerMenuJsonAuxContainer_v1',
                        'CutBookkeepers': 'xAOD::CutBookkeeperContainer_v1',
                        'CutBookkeepersAux.': 'xAOD::CutBookkeeperAuxContainer_v1',
                        'FileMetaData': '*',
                        'FileMetaDataAux.': 'xAOD::FileMetaDataAuxInfo_v1',
                        'TruthMetaData': '*',
                        'TruthMetaDataAux.': 'xAOD::TruthMetaDataAuxContainer_v1',
                        'DataVector<xAOD::TriggerMenuJson_v1>_TriggerMenuJson_HLT': 'DataVector<xAOD::TriggerMenuJson_v1>', # R3 trigger metadata format ESD
                        'xAOD::TriggerMenuJsonAuxContainer_v1_TriggerMenuJson_HLTAux.': 'xAOD::TriggerMenuJsonAuxContainer_v1',
                        'DataVector<xAOD::TriggerMenuJson_v1>_TriggerMenuJson_HLTMonitoring': 'DataVector<xAOD::TriggerMenuJson_v1>', # R3 trigger metadata format ESD
                        'xAOD::TriggerMenuJsonAuxContainer_v1_TriggerMenuJson_HLTMonitoringAux.': 'xAOD::TriggerMenuJsonAuxContainer_v1',
                        'DataVector<xAOD::TriggerMenuJson_v1>_TriggerMenuJson_HLTPS': 'DataVector<xAOD::TriggerMenuJson_v1>', # R3 trigger metadata format ESD
                        'xAOD::TriggerMenuJsonAuxContainer_v1_TriggerMenuJson_HLTPSAux.': 'xAOD::TriggerMenuJsonAuxContainer_v1',
                        'DataVector<xAOD::TriggerMenuJson_v1>_TriggerMenuJson_L1': 'DataVector<xAOD::TriggerMenuJson_v1>', # R3 trigger metadata format ESD
                        'xAOD::TriggerMenuJsonAuxContainer_v1_TriggerMenuJson_L1Aux.': 'xAOD::TriggerMenuJsonAuxContainer_v1',
                        'DataVector<xAOD::TriggerMenuJson_v1>_TriggerMenuJson_L1PS': 'DataVector<xAOD::TriggerMenuJson_v1>', # R3 trigger metadata format ESD
                        'xAOD::TriggerMenuJsonAuxContainer_v1_TriggerMenuJson_L1PSAux.': 'xAOD::TriggerMenuJsonAuxContainer_v1'
                    })
 
                    if isGaudiEnv():
                        meta_filter.update({
                            '/TagInfo': 'IOVMetaDataContainer_p1',
                            'IOVMetaDataContainer_p1__TagInfo': 'IOVMetaDataContainer_p1',
                            '/Simulation/Parameters': 'IOVMetaDataContainer_p1',
                            '/Digitization/Parameters': 'IOVMetaDataContainer_p1',
                            '/EXT/DCS/MAGNETS/SENSORDATA': 'IOVMetaDataContainer_p1',
                            '*': 'EventStreamInfo_p*'
                        })
 
                if (mode == 'full' or mode == 'iov') and meta_key_filter:
                    meta_filter = {f: '*' for f in meta_key_filter}
                # store all persistent classes for metadata container existing in a POOL/ROOT file.
                persistent_instances = {}
                dynamic_fmd_items = {}
 
                # Protect non-Gaudi environments from meta-data classes it doesn't know about
                if not isGaudiEnv():
                    metadata_tree.SetBranchStatus("*", False)
 
                for i in range(0, nr_of_branches):
                    branch = metadata_branches.At(i)
                    name = branch.GetName()
                    if name == 'index_ref':
                        # skip the index branch
                        continue
 
                    class_name = branch.GetClassName()
 
                    if regexIOVMetaDataContainer.match(class_name):
                        name = name.replace('IOVMetaDataContainer_p1_', '').replace('_', '/')
 
                    if regexIOVMetaDataContainer.match(class_name):
                        meta_dict[filename]['metadata_items'][name] = 'IOVMetaDataContainer'
                    elif regexByteStreamMetadataContainer.match(class_name):
                        meta_dict[filename]['metadata_items'][name] = 'ByteStreamMetadataContainer'
                    elif regexEventStreamInfo.match(class_name):
                        meta_dict[filename]['metadata_items'][name] = 'EventStreamInfo'
                    elif regexXAODFileMetaData.match(class_name):
                        meta_dict[filename]['metadata_items'][name] = 'FileMetaData'
                    elif regexXAODTruthMetaData.match(class_name):
                        meta_dict[filename]['metadata_items'][name] = 'TruthMetaData'
                    else:
                        type_name = class_name
                        if not type_name:
                            try:
                                type_name = branch.GetListOfLeaves()[0].GetTypeName()
                            except IndexError:
                                pass
                        meta_dict[filename]['metadata_items'][name] = type_name
 
                    if len(meta_filter) > 0:
                        keep = False
                        for filter_key, filter_class in meta_filter.items():
                            if (filter_key.replace('/', '_') in name.replace('/', '_') or filter_key == '*') and fnmatchcase(class_name, filter_class):
                                if 'CutBookkeepers' in filter_key:
                                    keep = filter_key == name
                                    if keep:
                                        break
                                else:
                                    keep = True
                                    break
 
                        if not keep:
                            continue
                    else:
                        # CutBookkeepers should always be filtered:
                        if 'CutBookkeepers' in name and name not in ['CutBookkeepers', 'CutBookkeepersAux.']:
                            continue
 
                    if not isGaudiEnv():
                        metadata_tree.SetBranchStatus(f"{name}*", True)
 
                    # assign the corresponding persistent class based of the name of the metadata container
                    if regexEventStreamInfo.match(class_name):
                        if class_name.endswith('_p1'):
                            persistent_instances[name] = ROOT.EventStreamInfo_p1()
                        elif class_name.endswith('_p2'):
                            persistent_instances[name] = ROOT.EventStreamInfo_p2()
                        else:
                            persistent_instances[name] = ROOT.EventStreamInfo_p3()
                    elif regexIOVMetaDataContainer.match(class_name):
                        persistent_instances[name] = ROOT.IOVMetaDataContainer_p1()
                    elif regexXAODEventFormat.match(class_name):
                        persistent_instances[name] = ROOT.xAOD.EventFormat_v1()
                    elif regexXAODTriggerMenu.match(class_name) and _check_project() not in ['AthGeneration']:
                        persistent_instances[name] = ROOT.xAOD.TriggerMenuContainer_v1()
                    elif regexXAODTriggerMenuAux.match(class_name) and _check_project() not in ['AthGeneration']:
                        persistent_instances[name] = ROOT.xAOD.TriggerMenuAuxContainer_v1()
                    elif regexXAODTriggerMenuJson.match(class_name) and _check_project() not in ['AthGeneration']:
                        persistent_instances[name] = ROOT.xAOD.TriggerMenuJsonContainer_v1()
                    elif regexXAODTriggerMenuJsonAux.match(class_name) and _check_project() not in ['AthGeneration']:
                        persistent_instances[name] = ROOT.xAOD.TriggerMenuJsonAuxContainer_v1()
                    elif regexXAODCutBookkeeperContainer.match(class_name):
                        persistent_instances[name] = ROOT.xAOD.CutBookkeeperContainer_v1()
                    elif regexXAODCutBookkeeperContainerAux.match(class_name):
                        persistent_instances[name] = ROOT.xAOD.CutBookkeeperAuxContainer_v1()
                    elif regexXAODFileMetaData.match(class_name):
                        persistent_instances[name] = ROOT.xAOD.FileMetaData_v1()
                    elif regexXAODFileMetaDataAux.match(class_name):
                        persistent_instances[name] = ROOT.xAOD.FileMetaDataAuxInfo_v1()
                    elif regexXAODTruthMetaData.match(class_name):
                        persistent_instances[name] = ROOT.xAOD.TruthMetaDataContainer_v1()
                    elif regexXAODTruthMetaDataAux.match(class_name):
                        persistent_instances[name] = ROOT.xAOD.TruthMetaDataAuxContainer_v1()
 
                    if name in persistent_instances:
                        branch.SetAddress(ROOT.AddressOf(persistent_instances[name]))
 
                    # This creates a dict to store the dynamic attributes of the xAOD::FileMetaData
                    dynamicFMD = regexXAODFileMetaDataAuxDyn.match(name)
                    if dynamicFMD:
                        dynamicName = dynamicFMD.group().split('.')[-1]
                        dynamicType = regex_cppname.match(class_name)
                        if dynamicType:
                            # this should be a string
                            dynamic_fmd_items[dynamicName] = ROOT.std.string()
                            branch.SetAddress(ROOT.AddressOf(dynamic_fmd_items[dynamicName]))
                        else:
                            dynamic_fmd_items[dynamicName] = None
 
 
                metadata_tree.GetEntry(0)
 
                # This loads the dynamic attributes of the xAOD::FileMetaData from the TTree
                for key in dynamic_fmd_items:
                    if dynamic_fmd_items[key] is None:
                        try:
                            if key.startswith("is"):
                                # this is probably a boolean
                                dynamic_fmd_items[key] = getattr(metadata_tree, key) != '\x00'
                            else:
                                # this should be a float
                                dynamic_fmd_items[key] = getattr(metadata_tree, key)
                        except AttributeError:
                            # should not happen, but just ignore missing attributes
                            pass
                    else:
                        # convert ROOT.std.string objects to python equivalent
                        dynamic_fmd_items[key] = str(dynamic_fmd_items[key])
 
                # clean the meta-dict if the meta_key_filter flag is used, to return only the key of interest
                if meta_key_filter:
                    meta_dict[filename] = {}
 
                # read the metadata
                for name, content in persistent_instances.items():
                    key = name
                    if hasattr(content, 'm_folderName'):
                        key = content.m_folderName
 
                    # Some transition AODs contain both the Run2 and Run3 metadata formats. We only wish to read the Run3 format if such a file is encountered.
                    has_r3_trig_meta = ('TriggerMenuJson_HLT' in persistent_instances or 'DataVector<xAOD::TriggerMenuJson_v1>_TriggerMenuJson_HLT' in persistent_instances)
                    aux = None
                    if key.startswith('TriggerMenuJson_') and not key.endswith('Aux.'): # interface container for the menu (AOD)
                        aux = persistent_instances[key+'Aux.']
                    elif key.startswith('DataVector<xAOD::TriggerMenuJson_v1>_TriggerMenuJson_') and not key.endswith('Aux.'): # interface container for the menu (ESD)
                        menuPart = key.split('_')[-1]
                        aux = persistent_instances['xAOD::TriggerMenuJsonAuxContainer_v1_TriggerMenuJson_'+menuPart+'Aux.']    
                    elif key == 'TriggerMenu' and 'TriggerMenuAux.' in persistent_instances and not has_r3_trig_meta: # AOD case (legacy support, HLT and L1 menus)
                        aux = persistent_instances['TriggerMenuAux.']
                    elif key == 'DataVector<xAOD::TriggerMenu_v1>_TriggerMenu' and 'xAOD::TriggerMenuAuxContainer_v1_TriggerMenuAux.' in persistent_instances and not has_r3_trig_meta: # ESD case (legacy support, HLT and L1 menus)
                        aux = persistent_instances['xAOD::TriggerMenuAuxContainer_v1_TriggerMenuAux.']
                    elif (key == 'CutBookkeepers'
                          and 'CutBookkeepersAux.' in persistent_instances):
                        aux = persistent_instances['CutBookkeepersAux.']
                    elif key == 'CutBookkeepersAux.':
                        continue   # Extracted using the interface object
                    elif (key == 'FileMetaData'
                          and 'FileMetaDataAux.' in persistent_instances):
                        aux = persistent_instances['FileMetaDataAux.']
                    elif (key == 'xAOD::FileMetaData_v1_FileMetaData'
                          and 'xAOD::FileMetaDataAuxInfo_v1_FileMetaDataAux.' in persistent_instances):
                        aux = persistent_instances['xAOD::FileMetaDataAuxInfo_v1_FileMetaDataAux.']
                    elif (key == 'TruthMetaData'
                          and 'TruthMetaDataAux.' in persistent_instances):
                        aux = persistent_instances['TruthMetaDataAux.']
                    elif key == 'TruthMetaDataAux.':
                        continue   # Extracted using the interface object
                    elif 'Menu' in key and key.endswith('Aux.'):
                        continue   # Extracted using the interface object
 
                    return_obj = _convert_value(content, aux)
 
                    if 'TriggerMenuJson' in key  or ('TriggerMenu' in key and not has_r3_trig_meta):
                        if 'RAWTriggerMenuJson' in return_obj:
                            meta_dict[filename][key] = return_obj['RAWTriggerMenuJson']
                            del return_obj['RAWTriggerMenuJson']
                        if 'TriggerConfigInfo' not in meta_dict[filename]:
                            meta_dict[filename]['TriggerConfigInfo'] = {}
                        if 'dbkey' in return_obj:
                            meta_dict[filename]['TriggerConfigInfo'][key.split('_')[-1]] = {
                                'key' : return_obj['dbkey'],
                                'name': return_obj['name']
                                }
                            del return_obj['dbkey']
                            del return_obj['name']
                        if 'TriggerMenu' not in meta_dict[filename]:
                            meta_dict[filename]['TriggerMenu'] = {}
                        meta_dict[filename]['TriggerMenu'].update(return_obj)
                    elif "FileMetaData" in key:
                        if "FileMetaData" not in meta_dict[filename]:
                            meta_dict[filename]["FileMetaData"] = dynamic_fmd_items
                        meta_dict[filename]["FileMetaData"].update(return_obj)
                    else:
                        meta_dict[filename][key] = return_obj
 
            try:
                # get the number of events from EventStreamInfo
                esi_dict = next(key for key, value in meta_dict[filename].items()
                                if isinstance(value, dict) and "numberOfEvents" in value and
                                meta_dict[filename]["metadata_items"][key] == "EventStreamInfo")
                msg.debug(f"{esi_dict=}")
                meta_dict[filename]["nentries"] = meta_dict[filename][esi_dict]["numberOfEvents"]
            except StopIteration as err:
                msg.debug(f"Caught {err=}, {type(err)=}, falling back on opening the DataHeader"
                          " Container to read the number of entries")
                meta_dict[filename]['nentries'] = dataheader_nentries(current_file)
                msg.debug(f"{meta_dict[filename]['nentries']=}")
 
            if unique_tag_info_values and mode=='iov':
                unique_tag_info_values = False
                msg.info('disabling "unique_tag_info_values" option for "iov" mode')
 
            # This is a required workaround which will temporarily be fixing ATEAM-560 originated from  ATEAM-531
            # ATEAM-560: https://its.cern.ch/jira/browse/ATEAM-560
            # ATEAM-531: https://its.cern.ch/jira/browse/ATEAM-531
            # This changes will remove all duplicates values presented in some files due
            # to the improper merging of two IOVMetaDataContainers.
            if unique_tag_info_values:
                msg.info('MetaReader is called with the parameter "unique_tag_info_values" set to True. '
                         'This is a workaround to remove all duplicate values from "/TagInfo" key')
                if '/TagInfo' in meta_dict[filename]:
                    for key, value in meta_dict[filename]['/TagInfo'].items():
                        if isinstance(value, list) and value:
                            if len(unique_values := set(value)) > 1:
                                msg.warn(
                                    f"Found multiple values for {key}: {value}. "
                                    "Looking for possible duplicates."
                                )
                                maybe_ok = False
                                if key == "AMITag":
                                    # curate duplicates like: ['s3681_q453', 's3681_q453_'] or ["s3681_q453", "q453_s3681"]
                                    unique_amitags = set()
                                    for amitags in unique_values:
                                        unique_amitags.add(
                                            "_".join({tag for tag in amitags.split("_") if tag})
                                        )
                                    if len(unique_amitags) == 1:
                                        maybe_ok = True
                                elif key == "beam_energy":
                                    # handle duplicates like: ['6500000', '6500000.0'] or [3, "3"]
                                    unique_energies = set()
                                    for energy in unique_values:
                                        try:
                                            energy = int(energy)
                                        except ValueError:
                                            try:
                                                energy = float(energy)
                                            except ValueError:
                                                pass
                                        unique_energies.add(energy)
                                    if len(unique_energies) == 1:
                                        maybe_ok = True
                                elif key in ["AtlasRelease", "IOVDbGlobalTag", "AODFixVersion"]:
                                    maybe_ok = True
                                if maybe_ok:
                                    msg.warn(
                                        f"Multiple values for {key} may mean the same, or "
                                        "the input file was produced in multi-step job. "
                                        f"Ignoring all but the first entry: {key} = {value[0]}"
                                    )
                                else:
                                    raise ValueError(
                                        f"{key} from /TagInfo contains more than 1 unique value: {value}"
                                    )
 
                            meta_dict[filename]['/TagInfo'][key] = value[0]
 
            if promote is None:
                promote = mode == 'lite' or mode == 'peeker'
 
            # Filter the data and create a prettier output for the 'lite' mode
            if mode == 'lite':
                meta_dict = make_lite(meta_dict)
 
            if mode == 'peeker':
                meta_dict = make_peeker(meta_dict)
 
            if promote:
                meta_dict = promote_keys(meta_dict, mode)
 
            # If AnalysisBase the itemList must be grabbed another way
            if not isGaudiEnv():
                if isinstance(collectionTree, ROOT.TTree):
                    meta_dict[filename]['itemList'] = [ (b.GetClassName(), b.GetName()) for b in collectionTree.GetListOfBranches() ]
 
        # ----- retrieves metadata from bytestream (BS) files (RAW, DRAW) ------------------------------------------#
        elif current_file_type == 'BS':
            
            if ignoreNonExistingLocalFiles and not regex_URI_scheme.match(filename) and not os.path.isfile(filename): 
                msg.warn('Ignoring not accessible file: {}'.format(filename))
                continue
            
            import eformat
 
            # store the number of entries
            bs = eformat.istream(filename)
            meta_dict[filename]['nentries'] = bs.total_events
 
            # store the 'guid' value
            data_reader = eformat.EventStorage.pickDataReader(filename)
            assert data_reader, 'problem picking a data reader for file [%s]' % filename
 
            # set auto flush equivalent, which for BS is always 1
            meta_dict[filename]['auto_flush'] = 1
 
            if hasattr(data_reader, 'GUID'):
                meta_dict[filename]['file_guid'] = data_reader.GUID()
 
            # compression level and algorithm, for BS always ZLIB
            meta_dict[filename]['file_comp_alg'] = 1
            meta_dict[filename]['file_comp_level'] = 1
 
 
            # if the flag full is set to true then grab all metadata
            # ------------------------------------------------------------------------------------------------------#
            if mode != "tiny":
                bs_metadata = {}
 
                for md in data_reader.freeMetaDataStrings():
                    if md.startswith('Event type:'):
                        k = 'eventTypes'
                        v = []
                        if 'is sim' in md:
                            v.append('IS_SIMULATION')
                        else:
                            v.append('IS_DATA')
 
                        if 'is atlas' in md:
                            v.append('IS_ATLAS')
                        else:
                            v.append('IS_TESTBEAM')
 
                        if 'is physics' in md:
                            v.append('IS_PHYSICS')
                        else:
                            v.append('IS_CALIBRATION')
 
                        bs_metadata[k] = tuple(v)
 
                    elif md.startswith('GeoAtlas:'):
                        k = 'geometry'
                        v = md.split('GeoAtlas:')[1].strip()
                        bs_metadata[k] = v
 
                    elif md.startswith('IOVDbGlobalTag:'):
                        k = 'conditions_tag'
                        v = md.split('IOVDbGlobalTag:')[1].strip()
                        bs_metadata[k] = v
 
                    elif '=' in md:
                        k, v = md.split('=')
                        bs_metadata[k] = v
 
                bs_metadata['detectorMask'] = data_reader.detectorMask()
                bs_metadata['runNumbers'] = data_reader.runNumber()
                bs_metadata['lumiBlockNumbers'] = data_reader.lumiblockNumber()
                bs_metadata['projectTag'] = data_reader.projectTag()
                bs_metadata['stream'] = data_reader.stream()
                #bs_metadata['beamType'] = getattr(data_reader, 'beamType')()
                beamTypeNbr= data_reader.beamType()
                #According to info from Rainer and Guiseppe the beam type is
                #O: no beam
                #1: protons
                #2: ions
                if (beamTypeNbr==0): bs_metadata['beamType'] = 'cosmics'
                elif (beamTypeNbr==1 or beamTypeNbr==2):  bs_metadata['beamType'] = 'collisions'
                else: bs_metadata['beamType'] = 'unknown'
 
                bs_metadata['beamEnergy'] = data_reader.beamEnergy()
 
                meta_dict[filename]['eventTypes'] = bs_metadata.get('eventTypes', [])
                meta_dict[filename]['GeoAtlas'] = bs_metadata.get('geometry', None)
                meta_dict[filename]['conditions_tag'] = bs_metadata.get('conditions_tag', None)
                meta_dict[filename]['project_name'] = bs_metadata.get('projectTag', None)
 
                # Promote up one level
                meta_dict[filename]['detectorMask'] = [bs_metadata.get('detectorMask', None)]
                meta_dict[filename]['runNumbers'] = [bs_metadata.get('runNumbers', None)]
                meta_dict[filename]['lumiBlockNumbers'] = [bs_metadata.get('lumiBlockNumbers', None)]
                meta_dict[filename]['beam_type'] = bs_metadata.get('beamType', None)
                meta_dict[filename]['beam_energy'] = bs_metadata.get('beamEnergy', None)
                meta_dict[filename]['stream'] = bs_metadata.get('stream', None)
 
                if not data_reader.good():
                    # event-less file...
                    meta_dict[filename]['runNumbers'].append(bs_metadata.get('run_number', 0))
                    meta_dict[filename]['lumiBlockNumbers'].append(bs_metadata.get('LumiBlock', 0))
 
                msg.debug(f"{meta_dict[filename]=}")
                msg.debug(f"{len(bs)=}")
                if len(bs):
                    evt = bs[0]
                    try:
                        evt.check()
                        meta_dict[filename]['processingTags'] = [tag.name for tag in evt.stream_tag()]
                        meta_dict[filename]['evt_number'] = [evt.global_id()]
                        meta_dict[filename]['run_type'] = [eformat.helper.run_type2string(evt.run_type())]
                        # ATLASRECTS-7126: If there is no valid lumiblock information
                        # in the ByteStream header, get the info from the first event.
                        if meta_dict[filename]['lumiBlockNumbers'] == [0]:
                            msg.debug('Taking the luminosity block info from the first event (%i)', evt.lumi_block())
                            meta_dict[filename]['lumiBlockNumbers'] = [evt.lumi_block()]
                        # ATLASRECTS-7126: If there is no valid run number information
                        # in the ByteStream header, get the info from the first event.
                        if meta_dict[filename]['runNumbers'] == [0]:
                            msg.debug('Taking the run number info from the first event (%i)', evt.run_no())
                            meta_dict[filename]['runNumbers'] = [evt.run_no()]
                    except RuntimeError as err:
                        msg.error("Issue while reading the first event of BS file %r: %r", filename, err)
                    else:
                        msg.debug(f"{meta_dict[filename]=}")
                else:
                    msg.warn(f"Event-less BS {filename=}, will not read metadata information from the first event")
 
                # fix for ATEAM-122
                if len(bs_metadata.get('eventTypes', '')) == 0:  # see: ATMETADATA-6
                    evt_type = ['IS_DATA', 'IS_ATLAS']
                    if bs_metadata.get('stream', '').startswith('physics_'):
                        evt_type.append('IS_PHYSICS')
                    elif bs_metadata.get('stream', '').startswith('calibration_'):
                        evt_type.append('IS_CALIBRATION')
                    elif bs_metadata.get('projectTag', '').endswith('_calib'):
                        evt_type.append('IS_CALIBRATION')
                    else:
                        evt_type.append('Unknown')
 
                    meta_dict[filename]['eventTypes'] = evt_type
 
                if mode == 'full':
                    meta_dict[filename]['bs_metadata'] = bs_metadata
 
        # ------ Throw an error if the user provide other file types -------------------------------------------------#
        else:
            msg.error('Unknown filetype for {0} - there is no metadata interface for type {1}'.format(filename, current_file_type))
            return None
 
    return meta_dict
 
 
def _check_project():
    import os
    if 'AthSimulation_DIR' in os.environ:
        return 'AthSimulation'
    if 'AthGeneration_DIR' in os.environ:
        return 'AthGeneration'
    return 'Athena'
 
 
def _get_pfn(filename):
    """
    Extract the actual filename if LFN or PFN notation is used
    """
    pfx = filename[0:4]
    if pfx == 'PFN:':
        return filename[4:]
    if pfx == 'LFN:':
        import subprocess, os
        os.environ['POOL_OUTMSG_LEVEL'] = 'Error'
        output = subprocess.check_output(['FClistPFN','-l',filename[4:]],text=True).split('\n')
        if len(output) == 2:
            return output[0]
        msg.error( 'FClistPFN({0}) returned unexpected number of lines:'.format(filename) )
        msg.error( '\n'.join(output) )
    return filename
 
 
def _read_guid(filename):
    """
    Extracts the "guid" (Globally Unique Identifier) in POOL files and Grid catalogs) value from a POOL file.
    :param filename: the input file
    :return: the guid value, None if unavailable
    """
    import ROOT
    root_file = ROOT.TFile.Open( _get_pfn(filename) )
    params = root_file.Get('##Params')
    if not params:
        return
    if not isinstance(params, ROOT.TTree):
        raise NotImplementedError(f"Cannot extract GUID from object {params!r} of type {type(params)!r}")
 
    regex = re.compile(r'\[NAME=(\w+)\]\[VALUE=(.*)\]', re.ASCII)
    fid = None
 
    for entry in params:
        param = entry.GetLeaf('db_string').GetValueString()
 
        result = regex.match(param)
        if result and result.group(1) == 'FID' :
            # don't exit yet, it's the last FID entry that counts
            fid = result.group(2)
 
    return fid
 
 
def _extract_fields(obj):
    result = {}
 
    for meth in dir(obj):
        if not meth.startswith('_'):
            if meth.startswith('m_'):
 
                field_name = str(meth)[2:]
                field_value = getattr(obj, meth)
 
                result[field_name] = _convert_value(field_value)
 
    return result
 
 
def _convert_value(value, aux = None):
    cl=value.__class__
 
    if hasattr(cl, '__cpp_name__'):
        result = regex_cppname.match(cl.__cpp_name__)
        if result:
            cpp_type = result.group(1)
            if cpp_type == 'vector' or cpp_type == 'std::vector':
                return [_convert_value(val) for val in value]
            elif cpp_type == 'set' or cpp_type == 'std::set':
                return {_convert_value(val) for val in value}
            elif cpp_type == 'pair' or cpp_type == 'std::pair':
                return _convert_value(value.first), _convert_value(value.second)
            
            # elif cpp_type == 'long':
            #   return int(value)
            
            elif cpp_type == 'string' or cpp_type == 'std::string':
                return str(value)
            
            elif cl.__cpp_name__ == "_Bit_reference":
                return bool(value)
 
            # special case which extracts data in a better format from IOVPayloadContainer_p1 class
            elif cl.__cpp_name__ == 'IOVMetaDataContainer_p1':
                return _extract_fields_iovmdc(value)
 
            elif cl.__cpp_name__ == 'IOVPayloadContainer_p1':
                global _gbl_mode
                if _gbl_mode == 'iov':
                    return _extract_iov_detailed(value)
                else:
                    return _extract_fields_iov( value, range(value.m_attrIndexes.size()) )
 
            elif cl.__cpp_name__ == 'xAOD::EventFormat_v1':
                return _extract_fields_ef(value)
            elif cl.__cpp_name__ == 'xAOD::CutBookkeeperContainer_v1':
                return _extract_fields_cbk(interface=value, aux=aux)
            elif cl.__cpp_name__ == 'xAOD::FileMetaData_v1':
                return _extract_fields_fmd(interface=value, aux=aux)
            elif cl.__cpp_name__ == 'DataVector<xAOD::TruthMetaData_v1>':
                return _extract_fields_tmd(interface=value, aux=aux)
 
            elif cl.__cpp_name__ == 'DataVector<xAOD::TriggerMenu_v1>' :
                return _extract_fields_triggermenu(interface=value, aux=aux)
 
            elif cl.__cpp_name__ == 'DataVector<xAOD::TriggerMenuJson_v1>' :
                return _extract_fields_triggermenujson(interface=value, aux=aux)
 
            elif (cl.__cpp_name__ == 'EventStreamInfo_p1' or
                  cl.__cpp_name__ == 'EventStreamInfo_p2' or
                  cl.__cpp_name__ == 'EventStreamInfo_p3'):
                return _extract_fields_esi(value)
 
            elif (cl.__cpp_name__ == 'EventType_p1' or
                  cl.__cpp_name__ == 'EventType_p3'):
                fields = _extract_fields(value)
                fields = _convert_event_type_bitmask(fields)
                fields = _convert_event_type_user_type(fields)
                return fields
 
            elif regex_persistent_class.match(cl.__cpp_name__):
                return _extract_fields(value)
 
    return value
 
 
def _get_attribute_val(iov_container, attr_name, attr_idx):
    type_idx = attr_idx.typeIndex()
    obj_idx = attr_idx.objIndex()
 
    attr_value = None
 
    if type_idx == 0:
        attr_value = bool(iov_container.m_bool[obj_idx])
    elif type_idx == 1:
        attr_value = int(iov_container.m_char[obj_idx])
    elif type_idx == 2:
        attr_value = int(iov_container.m_unsignedChar[obj_idx])
    elif type_idx == 3:
        attr_value = int(iov_container.m_short[obj_idx])
    elif type_idx == 4:
        attr_value = int(iov_container.m_unsignedShort[obj_idx])
    elif type_idx == 5:
        attr_value = int(iov_container.m_int[obj_idx])
    elif type_idx == 6:
        attr_value = int(iov_container.m_unsignedInt[obj_idx])
    elif type_idx == 7:
        attr_value = int(iov_container.m_long[obj_idx])
    elif type_idx == 8:
        attr_value = int(iov_container.m_unsignedLong[obj_idx])
    elif type_idx == 9:
        attr_value = int(iov_container.m_longLong[obj_idx])
    elif type_idx == 10:
        attr_value = int(iov_container.m_unsignedLongLong[obj_idx])
    elif type_idx == 11:
        attr_value = float(iov_container.m_float[obj_idx])
    elif type_idx == 12:
        attr_value = float(iov_container.m_double[obj_idx])
    elif type_idx == 13:
        # skipping this type because is file IOVPayloadContainer_p1.h (line 120) is commented and not considered
        pass
    elif type_idx == 14:
        attr_value = str(iov_container.m_string[obj_idx])
        # Cleaning class name from value
        if attr_value.startswith('IOVMetaDataContainer_p1_'):
            attr_value = attr_value.replace('IOVMetaDataContainer_p1_', '')
        if attr_value.startswith('_'):
            attr_value = attr_value.replace('_', '/')
        # Now it is clean
    elif type_idx == 15:
        attr_value = int(iov_container.m_date[obj_idx])
    elif type_idx == 16:
        attr_value = int(iov_container.m_timeStamp[obj_idx])
    else:
        raise ValueError('Unknown type id {0} for attribute {1}'.format(type_idx, attr_name))
 
    return attr_value
 
 
def _extract_fields_iov( iov_container, idx_range ):
     result = {}
 
     for idx in idx_range:
         attr_idx = iov_container.m_attrIndexes[idx]
         name_idx = attr_idx.nameIndex()
         attr_name = iov_container.m_attrName[name_idx]
         attr_value = _get_attribute_val(iov_container, attr_name, attr_idx)
 
         if attr_name not in result:
             result[attr_name] = [attr_value]
         else:
             result[attr_name].append(attr_value)
 
     max_element_count = 0
     for content in result.values():
         if len(content) > max_element_count:
             max_element_count = len(content)
 
     if max_element_count <= 1:
         for name, content in result.items():
             if len(content) > 0:
                 result[name] = content[0]
             else:
                 result[name] = None
 
     return result
 
 
def _extract_iov_detailed(iov_container):
    def iovtostr(t):
        # break iov time into high and low halves (run number usually in the higher half)
        return "({h}:{l})".format(h=t>>32, l=t&(2^32-1))
 
    def extract_list_collection(iov_container, listCollection ):
        result = {}
        ln = 0
        for list in listCollection.m_attrLists:
            ln = ln + 1
            lname = 'List {ln}: iov=[{s} ,{e}];  Channel#={ch}'.format(
                ln=ln, s=iovtostr(list.m_range.m_start),
                e=iovtostr(list.m_range.m_stop),
                ch=list.m_channelNumber )
            result[ lname ] = _extract_fields_iov( iov_container, range(list.m_firstIndex, list.m_lastIndex) )
        return result
 
    result = {}
    pn = 0
    for listCollection in iov_container.m_payloadVec:
        pn = pn + 1
        pname = 'IOV range {n}: [{s}, {e}]'.format(n=pn, s=iovtostr(listCollection.m_start),
                                                   e=iovtostr(listCollection.m_stop))
        result[ pname ] = extract_list_collection(iov_container, listCollection )
    return result
 
 
def _extract_fields_iovmdc(value):
    return _convert_value(value.m_payload)
 
 
def _extract_fields_esi(value):
    result = {}
 
    result['eventTypes'] = []
    for eventType in value.m_eventTypes:
        result['eventTypes'].append(_convert_value(eventType))
 
    result['numberOfEvents'] = value.m_numberOfEvents
    result['runNumbers'] = list(value.m_runNumbers)
    result['lumiBlockNumbers'] = list(value.m_lumiBlockNumbers)
    result['processingTags'] = [str(v) for v in value.m_processingTags]
    result['itemList'] = []
 
    # Get the class name in the repository with CLID <clid>
    from CLIDComps.clidGenerator import clidGenerator
    cgen = clidGenerator("")
    for clid, sgkey in value.m_itemList:
        result['itemList'].append((cgen.getNameFromClid(clid), sgkey))
 
    return result
 
 
def _extract_fields_ef(value):
    result = {}
 
    for ef_element in value:
        result[ef_element.first] = ef_element.second.className()
 
    return result
 
 
def _extract_fields_cbk(interface=None, aux=None):
    """Extract CutBookkeeper content into dictionary
 
    This function takes the CutBookkeeperContainer_v1 and CutBookkeeperAuxContainer_v1 objects.
    It makes sure the the interface object uses the auxiliary object as store.
        Args:
            interface (CutBookkeeperContainer_v1):     the interface class
            aux       (CutBookkeeperAuxContainer_v1):  auxiliary container object
        Returns
            dict: with the cycle number and last stream
    """
    if not interface or not aux:
        return {}
    interface.setStore(aux)
 
    max_cycle = -1
    input_stream = ''
 
    for cbk in interface:
        current_cycle = int(cbk.cycle())
        if current_cycle > max_cycle:
            max_cycle = current_cycle
            input_stream = str(cbk.inputStream())
 
    result = {
        'currentCutCycle': max_cycle,
        'currentCutInputStream': input_stream,
    }
    return result
 
 
def _extract_fields_fmd(interface=None, aux=None):
    """Turn static FileMetaData content into dictionary
 
    This function takes the FileMetaData_v1 and FileMetaDataAuxInfo_v1 objects.
    It makes sure the the interface object uses the auxiliary object as store.
    Next the two static variables of FileMetaDataAuxInfo_v1 are retrieved and
    added to the dictionary that is returned.
        Args:
            interface (FileMetaData_v1):        the interface class
            aux       (FileMetaDataAuxInfo_v1): auxiliary container object
        Returns
            dict: with the production release and dataType
    """
    import ROOT
    if not interface or not aux:
        return {}
    interface.setStore(aux)
    metaContent = {
        "productionRelease": ROOT.std.string(),
        "dataType": ROOT.std.string(),
        "runNumbers": ROOT.std.vector('unsigned int')(),
        "lumiBlocks": ROOT.std.vector('unsigned int')(),
    }
    # Note: using this for dynamic attributes returns empty content
    for k, v in metaContent.items():
        try:
            interface.value(getattr(interface, k), v)
        except AttributeError:
            interface.value(k, v)
    # Now return python objects
    result = {k: str(v) for k, v in metaContent.items() if type(v) is ROOT.std.string}
    result.update({k: list(v) for k, v in metaContent.items() if type(v) is ROOT.std.vector('unsigned int')})
    return result
 
 
def _extract_fields_tmd(interface=None, aux=None):
    import ROOT
    BadAuxVarException = ROOT.SG.ExcBadAuxVar
    """Extract TruthMetaData content into dictionary
 
    This function takes the TruthMetaDataContainer_v1 and TruthMetaDataAuxContainer_v1 objects.
    It makes sure the the interface object uses the auxiliary object as store.
        Args:
            interface (TruthMetaDataContainer_v1):     the interface class
            aux       (TruthMetaDataAuxContainer_v1):  auxiliary container object
        Returns
            dict
    """
    if not interface or not aux:
        return {}
    interface.setStore(aux)
 
    # return the first as we do not really expect more than one
    result = {}
    for tmd in interface:
        result['mcChannelNumber'] = tmd.mcChannelNumber()
 
        try:
            result['weightNames'] = list(tmd.weightNames())
        except BadAuxVarException:
            result['weightNames'] = []
 
        try:
            result['lhefGenerator'] = str(tmd.lhefGenerator())
        except BadAuxVarException:
            result['lhefGenerator'] = ''
    
        try:
            result['generators'] = str(tmd.generators())
        except BadAuxVarException:
            result['generators'] = ''
    
        try:
            result['evgenProcess'] = str(tmd.evgenProcess())
        except BadAuxVarException:
            result['evgenProcess'] = ''
    
        try:
            result['evgenTune'] = str(tmd.evgenTune())
        except BadAuxVarException:
            result['evgenTune'] = ''
    
        try:
            result['hardPDF'] = str(tmd.hardPDF())
        except BadAuxVarException:
            result['hardPDF'] = ''
    
        try:
            result['softPDF'] = str(tmd.softPDF())
        except BadAuxVarException:
            result['softPDF'] = ''
 
    return result
 
 
""" Note: Deprecated. Legacy support for Run 2 AODs produced in release 21 or in release 22 prior to April 2021
"""
def _extract_fields_triggermenu(interface, aux):
    if aux is None:
        return {}
 
    L1Items = []
    HLTChains = []
 
    try:
        interface.setStore( aux )
        if interface.size() > 0:
            # We make the assumption that the first stored SMK is
            # representative of all events in the input collection.
            firstMenu = interface.at(0)
            L1Items   = [ _convert_value(item) for item in firstMenu.itemNames() ]
            HLTChains = [ _convert_value(chain) for chain in firstMenu.chainNames() ]
    except Exception as err: # noqa: F841
        msg.warn('Problem reading xAOD::TriggerMenu:')
 
    result = {}
    result['L1Items'] = L1Items
    result['HLTChains'] = HLTChains
 
    return result
 
def _extract_fields_triggermenujson(interface, aux):
    result = {}
 
    try:
        interface.setStore( aux )
        if interface.size() > 0:
            # We make the assumption that the first stored SMK is
            # representative of all events in the input collection.
            firstMenu = interface.at(0)
            import json
            decoded = json.loads(firstMenu.payload())
            result['RAWTriggerMenuJson'] = firstMenu.payload()
            result['name'] = firstMenu.name()
            result['dbkey'] = firstMenu.key()
            if decoded['filetype'] == 'hltmenu':
                result['HLTChains'] = [ _convert_value(chain) for chain in decoded['chains'] ] 
            elif decoded['filetype'] == 'l1menu':
                result['L1Items'] = [ _convert_value(item) for item in decoded['items'] ] 
            elif decoded['filetype'] in ['bunchgroupset', 'hltprescale', 'l1prescale', 'hltmonitoringsummary']:
                return result
 
            else:
                msg.warn('Got an xAOD::TriggerMenuJson called {0} but only expecting hltmenu or l1menu'.format(decoded['filetype']))
                return {}
                
    except Exception as err: # noqa: F841
        msg.warn('Problem reading xAOD::TriggerMenuJson')
 
    return result
 
def _convert_event_type_user_type(value):
    if 'user_type' in value:
        items = value['user_type'].split('#')[3:]
        for i in range(0, len(items), 2):
            value[items[i]] = _convert_value(items[i+1])
    return value
 
def _convert_event_type_bitmask(value):
 
    types = None
    for key in value:
        if key == 'bit_mask':
            val = value[key]
 
            bitmask_length = len(val)
 
            is_simulation = False
            is_testbeam = False
            is_calibration = False
 
            if bitmask_length > 0:  # ROOT.EventType.IS_SIMULATION
                is_simulation = val[0]
 
            if bitmask_length > 1:  # ROOT.EventType.IS_TESTBEAM
                is_testbeam = val[1]
 
            if bitmask_length > 2:  # ROOT.EventType.IS_CALIBRATION:
                is_calibration = val[2]
 
            types = [
                'IS_SIMULATION' if is_simulation else 'IS_DATA',
                'IS_TESTBEAM' if is_testbeam else 'IS_ATLAS',
                'IS_CALIBRATION' if is_calibration else 'IS_PHYSICS'
            ]
 
    value['type'] = types
    return value
 
 
def make_lite(meta_dict):
    for filename, file_content in meta_dict.items():
        for key in file_content:
            if key in meta_dict[filename]['metadata_items'] and regexEventStreamInfo.match(meta_dict[filename]['metadata_items'][key]):
                for item in list(meta_dict[filename][key]):
                    if item not in lite_primary_keys_to_keep:
                        meta_dict[filename][key].pop(item)
 
        if '/TagInfo' in file_content:
            
 
            for item in list(meta_dict[filename]['/TagInfo']):
                if item not in lite_TagInfo_keys_to_keep:
                    meta_dict[filename]['/TagInfo'].pop(item)
    return meta_dict
 
 
def make_peeker(meta_dict):
    for filename, file_content in meta_dict.items():
        for key in file_content:
            if key in meta_dict[filename]['metadata_items'] and regexEventStreamInfo.match(meta_dict[filename]['metadata_items'][key]):
                keys_to_keep = [
                    'lumiBlockNumbers',
                    'runNumbers',
                    'mc_event_number',
                    'mc_channel_number',
                    'eventTypes',
                    'processingTags',
                    'itemList'
                ]
                for item in list(meta_dict[filename][key]):
                    if item not in keys_to_keep:
                        meta_dict[filename][key].pop(item)
 
        if '/TagInfo' in file_content:
            keys_to_keep = [
                'beam_energy',
                'beam_type',
                'GeoAtlas',
                'IOVDbGlobalTag',
                'AODFixVersion',
                'AMITag',
                'project_name',
                'triggerStreamOfFile',
                'AtlasRelease',
                'specialConfiguration',
                'mc_campaign',
                'hepmc_version',
                'generators',
                'data_year',
            ]
            for item in list(meta_dict[filename]['/TagInfo']):
                if item not in keys_to_keep:
                    meta_dict[filename]['/TagInfo'].pop(item)
 
        if '/Simulation/Parameters' in file_content:
            keys_to_keep = [
                'G4Version',
                'TruthStrategy',
                'SimBarcodeOffset',
                'RegenerationIncrement',
                'TRTRangeCut',
                'SimulationFlavour',
                'Simulator',
                'PhysicsList',
                'SimulatedDetectors',
            ]
            for item in list(meta_dict[filename]['/Simulation/Parameters']):
                if item not in keys_to_keep:
                    meta_dict[filename]['/Simulation/Parameters'].pop(item)
 
        if '/Digitization/Parameters' in file_content:
            keys_to_keep = [
                'numberOfCollisions',
                'intraTrainBunchSpacing',
                'BeamIntensityPattern'
                'physicsList',
                'digiSteeringConf',
                'pileUp',
                'DigitizedDetectors',
            ]
            for item in list(meta_dict[filename]['/Digitization/Parameters']):
                if item not in keys_to_keep:
                    meta_dict[filename]['/Digitization/Parameters'].pop(item)
 
        if 'CutBookkeepers' in file_content:
            keys_to_keep = [
                'currentCutCycle',
                'currentCutInputStream',
            ]
            for item in list(meta_dict[filename]['CutBookkeepers']):
                if item not in keys_to_keep:
                    meta_dict[filename]['CutBookkeepers'].pop(item)
 
        if 'TruthMetaData' in file_content:
            keys_to_keep = [
                'mcChannelNumber',
                'weightNames',
            ]
            for item in list(meta_dict[filename]['TruthMetaData']):
                if item not in keys_to_keep:
                    meta_dict[filename]['TruthMetaData'].pop(item)
 
    return meta_dict
 
 
def promote_keys(meta_dict, mode):
    for filename, file_content in meta_dict.items():
        md = meta_dict[filename]
        for key in file_content:
            if key in md['metadata_items'] and regexEventStreamInfo.match(md['metadata_items'][key]):
                md.update(md[key])
 
                if 'eventTypes' in md and len(md['eventTypes']):
                    et = md['eventTypes'][0]
                    md['mc_event_number'] = et.get('mc_event_number', md['runNumbers'][0])
                    if 'mc_channel_number' in et:
                        md['mc_channel_number'] = et.get('mc_channel_number', None)
                    md['eventTypes'] = et['type']
 
                    # For very old files
                    if 'GeoAtlas' in et:
                        md['GeoAtlas']       = et.get('GeoAtlas', None)
                    if 'IOVDbGlobalTag' in et:
                        md['IOVDbGlobalTag'] = et.get('IOVDbGlobalTag', None)
 
                if 'lumiBlockNumbers' in md[key]:
                    md['lumiBlockNumbers'] = md[key]['lumiBlockNumbers']
                
                if 'processingTags' in md[key]:
                    md['processingTags'] = md[key]['processingTags']
 
                meta_dict[filename].pop(key)
                break
 
            if not isGaudiEnv() and key in md['metadata_items'] and 'FileMetaData' in key:
                if 'beamType' in md[key]:
                    md['beam_type'] = md[key]['beamType']
 
                if 'runNumbers' in md[key]:
                    md['runNumbers'] = md[key]['runNumbers']
 
                if 'mcProcID' in md[key]:
                    md['mc_channel_number'] = int(md[key]['mcProcID'])
 
                if 'mcCampaign' in md[key]:
                    md['mc_campaign'] = md[key]['mcCampaign']
 
                if 'dataYear' in md[key]:
                    md['data_year'] = int(md[key]['dataYear'])
 
                if 'lumiBlocks' in md[key]:
                    md['lumiBlockNumbers'] = md[key]['lumiBlocks']
                
                if mode == 'peeker' and 'amiTag' in md[key]:
                    md['AMITag'] = md[key]['amiTag']
 
                if 'beamEnergy' in md[key]:
                    md['beam_energy'] = int(md[key]['beamEnergy'])
 
                if 'geometryVersion' in md[key]:
                    md['GeoAtlas'] = md[key]['geometryVersion']
 
                # EventType checks
                md['eventTypes'] = []
                if mode == 'peeker' and 'simFlavour' in md[key]:
                    md['SimulationFlavour'] = md[key]['simFlavour']
 
                if 'simFlavour' in md[key] and ('FullG4' in md[key]['simFlavour'] or 'ATLFAST' in md[key]['simFlavour']):
                    md['eventTypes'].append('IS_SIMULATION')
                else:
                    md['eventTypes'].append('IS_DATA')
 
                if 'GeoAtlas' in md and 'ATLAS' in md['GeoAtlas']:
                    md['eventTypes'].append('IS_ATLAS')
                    # this is probably safe to assume for all files used in AnalysisBase
                    md['eventTypes'].append('IS_PHYSICS')
                else:
                    md['eventTypes'].append('IS_TESTBEAM')
 
                if 'dataType' in md[key]:
                    md['processingTags'] = [md[key]['dataType']]
 
                if mode == 'peeker':
                    if 'productionRelease' in md[key]:
                        md['AtlasRelease'] = md[key]['productionRelease']
                    
                    if 'generatorsInfo' in md[key]:
                        md['generators']  = md[key]['generatorsInfo']
 
                if mode == 'lite':
                    meta_dict[filename].pop(key)
                break
 
        if '/TagInfo' in file_content:
            md.update(md['/TagInfo'])
            md.pop('/TagInfo')
 
        if '/Generation/Parameters' in file_content:
            md.update(md['/Generation/Parameters'])
            md.pop('/Generation/Parameters')
 
        if '/Simulation/Parameters' in file_content:
            md.update(md['/Simulation/Parameters'])
            md.pop('/Simulation/Parameters')
 
        if '/Digitization/Parameters' in file_content:
            md.update(md['/Digitization/Parameters'])
            md.pop('/Digitization/Parameters')
 
        if 'CutBookkeepers' in file_content:
            md.update(md['CutBookkeepers'])
            md.pop('CutBookkeepers')
 
    return meta_dict
 
 
def convert_itemList(metadata, layout):
    """
    This function will rearrange the itemList values to match the format of 'eventdata_items', 'eventdata_itemsList'
    or 'eventdata_itemsDic' generated with the legacy file peeker tool
    :param metadata: a dictionary obtained using read_metadata method.
                     The mode for read_metadata must be 'peeker of 'full'
    :param layout: the mode in which the data will be converted:
                * for 'eventdata_items' use: layout= None
                * for 'eventdata_itemsList' use: layout= '#join'
                * for 'eventdata_itemsDic' use: layout= 'dict'
    """
 
    # Find the itemsList:
    item_list = None
 
    if 'itemList' in metadata:
        item_list = metadata['itemList']
    else:
 
        current_key = None
 
        for key in metadata:
            if 'metadata_items' in metadata and key in metadata['metadata_items'] and metadata['metadata_items'][key] == 'EventStreamInfo_p3':
                current_key = key
                break
        if current_key is not None:
            item_list = metadata[current_key]['itemList']
 
    if item_list is not None:
 
        if layout is None:
            return item_list
 
        elif layout == '#join':
            return [k + '#' + v for k, v in item_list if k]
 
 
        elif layout == 'dict':
            from collections import defaultdict
            dic = defaultdict(list)
 
            for k, v in item_list:
                dic[k].append(v)
 
            return dict(dic)
 
 
def dataheader_nentries(infile):
    """Extract number of entries from DataHeader.
 
    infile  ROOT TFile object or filename string
    return  Number of entries as returned by DataHeader object in infile,
            None in absence of DataHeader object
    """
    import ROOT
    from PyUtils.PoolFile import PoolOpts
    if not isinstance(infile, ROOT.TFile):
        infile = ROOT.TFile.Open(infile)
 
    for name in {PoolOpts.TTreeNames.DataHeader, PoolOpts.RNTupleNames.DataHeader}:
        obj = infile.Get(name)
        msg.debug(f"dataheader_nentries: {name=}, {obj=}, {type(obj)=}")
        if not obj:
            continue
        if isinstance(obj, ROOT.TTree):
            return obj.GetEntriesFast()
        else:
            # check early to avoid scary ROOT read errors
            if ROOT.gROOT.GetVersionInt() < 63100:
                raise RuntimeError("ROOT ver. 6.31/01 or greater needed to read RNTuple files")
            if isRNTuple(obj):
                return ROOT.Experimental.RNTupleReader.Open(obj).GetNEntries()
            else:
                raise NotImplementedError(f"Keys of type {type(obj)!r} not supported")