Merge pull request #34 from kpedro88/pu_list

add script to get list of files on disk

Author: kpedro88

get_files_on_disk.py

@@ -0,0 +1,74 @@
+#!/usr/bin/env python3
+
+"""Returns a list of files from a dataset including only files that are hosted on disk."""
+
+import os,sys,getpass,warnings,glob,shlex,subprocess,argparse # pylint: disable=multiple-imports
+from collections import defaultdict
+
+def getOS():
+    """Gets OS version from shell (other methods return host OS when in container)"""
+    cmd = r"sed -nr 's/[^0-9]*([0-9]+).*/\1/p' /etc/redhat-release"
+    osv = subprocess.check_output(shlex.split(cmd), encoding="utf-8").rstrip()
+    return osv
+
+def getHosted(dataset):
+    """Gets list of files on disk for a dataset, and list of sites along with how many files each site has"""
+    osv = getOS()
+    rucio_path = f'/cvmfs/cms.cern.ch/rucio/x86_64/rhel{osv}/py3/current'
+    os.environ['RUCIO_HOME'] = rucio_path
+    os.environ['RUCIO_ACCOUNT'] = getpass.getuser()
+    full_rucio_path = glob.glob(rucio_path+'/lib/python*.*')[0]
+    sys.path.insert(0,full_rucio_path+'/site-packages/')
+
+    warnings.filterwarnings("ignore", message=".*cryptography.*")
+    from rucio.client.client import Client # pylint: disable=import-error,import-outside-toplevel
+    client = Client()
+
+    # loop over blocks to avoid timeout error from too-large response
+    all_blocks = list(client.list_content(scope='cms',name=dataset))
+    # batch some blocks together for fewer requests
+    # not fully optimized, but n=10 tested to be ~15% faster than n=1
+    nblocks = 10
+    block_groups = [all_blocks[i:i+nblocks] for i in range(0, len(all_blocks), nblocks)]
+
+    from rucio.client.replicaclient import ReplicaClient # pylint: disable=import-error,import-outside-toplevel
+    rep_client = ReplicaClient()
+
+    filelist = set()
+    sitelist = defaultdict(int)
+    def sitecond(site):
+        return "_Tape" not in site
+    for block_group in block_groups:
+        reps = list(rep_client.list_replicas([{'scope': 'cms', 'name': block['name']} for block in block_group]))
+        for rep in reps:
+            for site,state in rep['states'].items():
+                if state=='AVAILABLE' and sitecond(site):
+                    filelist.add(rep['name'])
+                    sitelist[site] += 1
+
+    sys.path.pop(0)
+    return filelist, sitelist
+
+def main(dataset, outfile=None, verbose=False):
+    """Prints file list and site list"""
+    filelist, sitelist = getHosted(dataset)
+
+    if verbose:
+        print("Site list:")
+        print("\n".join(f'{k}: {v}' for k,v in sitelist.items()))
+
+    file = open(outfile,'w') if outfile is not None else sys.stdout # pylint: disable=consider-using-with,unspecified-encoding
+    print("\n".join(filelist), file=file)
+    if outfile is not None: file.close() # pylint: disable=multiple-statements
+
+if __name__=="__main__":
+    parser = argparse.ArgumentParser(
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+        description="Find all available files (those hosted on disk) for a given dataset",
+    )
+    parser.add_argument("-o","--outfile",type=str,default=None,help="write to this file instead of stdout")
+    parser.add_argument("-v","--verbose",default=False,action="store_true",help="print extra information (site list)")
+    parser.add_argument("dataset",type=str,help="dataset to query")
+    args = parser.parse_args()
+
+    main(args.dataset, outfile=args.outfile, verbose=args.verbose)