CPGridRun.CPGridRun Class Reference

Collaboration diagram for CPGridRun.CPGridRun:

Public Member Functions
	__init__ (self)
	inputList (self)
	outputFilesParsing (self)
	printHelp (self)
	getParser (self)
	configureSubmission (self)
	configureSubmissionSingleSample (self, input)
	printInputDetails (self)
	hasPyami (self)
bool	checkInputInPyami (self)
	outputDSFormatter (self, name)
	execFormatter (self)
	outputsFormatter (self)
bool	hasPrun (self)
	submit (self)
	printDelayedErrorCollection (self)
	checkExternalTools (self)
	askSubmission (self)

Static Public Member Functions
	isAtlasProductionFormat (name)
	rucioCustomNameParser (filename)
	atlasProductionNameParser (filename)

Public Attributes
dict	cmd = {}
	gridParser = self._parseGridArguments()
dict	prunArgsDict = self._createPrunArgsDict()
	args
	unknown_args = parser.parse_known_args()
	output_files = output_files
	inputList

Protected Member Functions
	_initRunscript (self)
	_parseGridArguments (self)
dict	_createPrunArgsDict (self)
dict	_unknownArgsDict (self)
	_checkPrunArgs (self, argDict)
	_prepareAmiQueryFromInputList (self)
bool	_analyzeAmiResults (self, results, datasetPtag)
	_filesChangedOrTarballNotCreated (self)
	_hasCompressedTarball (self)
	_outputDSFormatter (self, name)
	_customOutputDSFormatter (self, name)
	_suffixFormatter (self)
	_filesChanged (self)
	_buildDir (self)
	_sourceDir (self)
	_checkYamlExists (self, runscriptArgs)

Static Protected Member Functions
	_parseInputFileList (path)

Protected Attributes
dict	_errorCollector = {}
	_runscript = None
str	_tarfile = 'cpgrid.tar.gz'
bool	_isFirstRun = True
bool	_tarballRecreated = False
list	_inputList = None
	_yamlPath = None

Detailed Description

Definition at line 11 of file CPGridRun.py.

Constructor & Destructor Documentation

__init__()

CPGridRun.CPGridRun.__init__

(

self

)

Definition at line 12 of file CPGridRun.py.

    def __init__(self):
        self._errorCollector = {} # Delay the error collection until the end of the script for better user experience
        self._runscript = None
        self._tarfile = 'cpgrid.tar.gz'
        self._isFirstRun = True
        self._tarballRecreated = False
        self._inputList = None 
        self._yamlPath = None
        self.cmd = {} # sample name -> command
 
        self.gridParser = self._parseGridArguments()
        self.prunArgsDict = self._createPrunArgsDict()
 
        if self.args.help:
            self._initRunscript()
            self.printHelp()
            sys.exit(0)
 

Member Function Documentation

_analyzeAmiResults()

bool CPGridRun.CPGridRun._analyzeAmiResults ( self, results, datasetPtag )

protected

Definition at line 286 of file CPGridRun.py.

    def _analyzeAmiResults(self, results, datasetPtag) -> bool:
        import re
        regex = re.compile("_p[0-9]+")
        results = [r['ldn'] for r in results]
        notFound = []
        latestPtag = {}
    
        for datasetName in self.cmd:
            if datasetName not in results:
                notFound.append(datasetName)
    
            base = regex.sub("_p%", datasetName)
            matching = [r for r in results if r.startswith(base.replace("_p%", ""))]
            for m in matching:
                mParsed = CPGridRun.atlasProductionNameParser(m)
                try:
                    mPtagInt = int(mParsed.get('ptag', 'p0')[1:])
                    currentPtagInt = int(datasetPtag.get(datasetName, 'p0')[1:])
                    if mPtagInt > currentPtagInt:
                        latestPtag[datasetName] = f"p{mPtagInt}"
                except (ValueError, TypeError):
                    continue
    
        if latestPtag:
            logCPGridRun.info("Newer version of datasets found in AMI:")
            for name, ptag in latestPtag.items():
                logCPGridRun.info(f"{name} -> ptag: {ptag}")
    
        if notFound:
            logCPGridRun.error("Some input datasets are not available in AMI, missing datasets are likely to fail on the grid:")
            logCPGridRun.error(", ".join(notFound))
            return False
    
        return True
    

_buildDir()

CPGridRun.CPGridRun._buildDir ( self )

protected

Definition at line 404 of file CPGridRun.py.

    def _buildDir(self):
        buildDir = os.environ["CMAKE_PREFIX_PATH"]
        buildDir = os.path.dirname(buildDir.split(":")[0])
        return buildDir
 

_checkPrunArgs()

CPGridRun.CPGridRun._checkPrunArgs ( self, argDict )

protected

check the arguments against the prun script to ensure they are valid
See https://github.com/PanDAWMS/panda-client/blob/master/pandaclient/PrunScript.py

Definition at line 208 of file CPGridRun.py.

    def _checkPrunArgs(self,argDict):
        '''
        check the arguments against the prun script to ensure they are valid
        See https://github.com/PanDAWMS/panda-client/blob/master/pandaclient/PrunScript.py
        '''
        import pandaclient.PrunScript
        # We need to temporarily clear the sys.argv to avoid the parser from PrunScript to fail
        original_argv = sys.argv
        sys.argv = ['prun']  # Reset sys.argv to only contain the script name
        prunArgsDict = {}
        prunArgsDict = pandaclient.PrunScript.main(get_options=True)
        sys.argv = original_argv  # Restore the original sys.argv
        nonPrunOrCPGridArgs = []
        for arg in argDict:
            if arg not in prunArgsDict:
                nonPrunOrCPGridArgs.append(arg)
        if nonPrunOrCPGridArgs:
            logCPGridRun.error(f"Unknown arguments detected: {nonPrunOrCPGridArgs}. They do not belong to CPGridRun or Panda.")
            raise ValueError(f"Unknown arguments detected: {nonPrunOrCPGridArgs}. They do not belong to CPGridRun or Panda.")
        

_checkYamlExists()

CPGridRun.CPGridRun._checkYamlExists ( self, runscriptArgs )

protected

Definition at line 465 of file CPGridRun.py.

    def _checkYamlExists(self, runscriptArgs):
        from AnalysisAlgorithmsConfig.CPBaseRunner import CPBaseRunner
        if not hasattr(runscriptArgs, 'text_config'):
            self._errorCollector['no yaml'] = "No YAML configuration file is specified in the exec string. Please provide one using --text-config"
            return
        yamlPath = getattr(runscriptArgs, 'text_config')
        self._yamlPath = yamlPath 
        haveLocalYaml = CPBaseRunner.findLocalPathYamlConfig(yamlPath)
        if haveLocalYaml:
            logCPGridRun.warning("A path to a local YAML configuration file is found, but it may not be grid-usable.")
 
        repoYamls, _ = CPBaseRunner.findRepoPathYamlConfig(yamlPath)
        if repoYamls and len(repoYamls) > 1:
            self._errorCollector['ambiguous yamls'] = f'Multiple files named \"{yamlPath}\" found in the analysis repository. Please provide a more specific path to the config file.\nMatches found:\n' + '\n'.join(repoYamls)
            return
        elif repoYamls and len(repoYamls) == 1:
            logCPGridRun.info(f"Found a grid-usable YAML configuration file in the analysis repository: {repoYamls[0]}")
            return
        
        if haveLocalYaml and self.args.useCentralPackage:
            logCPGridRun.warning("A path to a local YAML configuration file is found, no custom packages are found, proceed with /cvmfs packages only.")
            
        if not repoYamls and not self.args.useCentralPackage:
            self._errorCollector['no usable yaml'] = f"Grid usable YAML configuration file not found: {yamlPath}"
            if haveLocalYaml:
                self._errorCollector['have local yaml'] = f"Only a local YAML configuration file is found: {yamlPath}, not usable in the grid.\n" \
                f"Make sure the YAML file is in build/x86_64-el9-gcc14-opt/data/package_name/config.yaml. You can install the YAML file through CMakeList.txt with `atlas_install_data( data/* )`; use `-t package_name/config.yaml` in the --exec\n"\
                f"Or if you are only using central packages, please use the `--useCentralPackage` flag."
 

_createPrunArgsDict()

dict CPGridRun.CPGridRun._createPrunArgsDict ( self )

protected

converting unknown args to a dictionary

Definition at line 83 of file CPGridRun.py.

    def _createPrunArgsDict(self) -> dict:
        '''
        converting unknown args to a dictionary
        '''
        unknownArgsDict = self._unknownArgsDict()
        if unknownArgsDict and self.hasPrun():
            self._checkPrunArgs(unknownArgsDict)
            logCPGridRun.info(f"Adding prun exclusive arguments: {unknownArgsDict.keys()}")
        elif unknownArgsDict:
            logCPGridRun.warning(f"Unknown arguments detected: {unknownArgsDict}. Cannot check the availablility in Prun because Prun is not available / noSubmit is on.")
        else:
            pass
        return unknownArgsDict
 

_customOutputDSFormatter()

CPGridRun.CPGridRun._customOutputDSFormatter ( self, name )

protected

{group/user}.{username}.{main}.outputDS.{suffix}

Definition at line 350 of file CPGridRun.py.

    def _customOutputDSFormatter(self, name):
        '''
        {group/user}.{username}.{main}.outputDS.{suffix}
        '''
        parts = name.split('.')
        base = 'group' if self.args.groupProduction else 'user'
        username = self.args.gridUsername
        main = parts[2]
        outputDS = 'outputDS'
        suffix = parts[-1]
 
        result  = [base, username,main, outputDS, suffix]
        return ".".join(filter(None, result))
 

_filesChanged()

CPGridRun.CPGridRun._filesChanged ( self )

protected

Definition at line 373 of file CPGridRun.py.

    def _filesChanged(self):
        tarball_mtime = os.path.getmtime(self._tarfile) if os.path.exists(self._tarfile) else 0
        buildDir = self._buildDir()
        sourceDir = self._sourceDir()
 
        # Check for changes in buildDir
        for root, _, files in os.walk(buildDir):
            for file in files:
                file_path = os.path.join(root, file)
                try:
                    if os.path.getmtime(file_path) > tarball_mtime:
                        logCPGridRun.info(f"File {file_path} is newer than the tarball.")
                        return True
                except FileNotFoundError:
                    continue
 
        # Check for changes in sourceDir
        if sourceDir is None:
            logCPGridRun.warning("Source directory is not detected, auto-compression is not performed. Use --recreateTar to update the submission")
            return False
        for root, _, files in os.walk(sourceDir):
            for file in files:
                file_path = os.path.join(root, file)
                try:
                    if os.path.getmtime(file_path) > tarball_mtime:
                        logCPGridRun.info(f"File {file_path} is newer than the tarball.")
                        return True
                except FileNotFoundError:
                    continue
        return False
 

_filesChangedOrTarballNotCreated()

CPGridRun.CPGridRun._filesChangedOrTarballNotCreated ( self )

protected

Definition at line 321 of file CPGridRun.py.

    def _filesChangedOrTarballNotCreated(self):
        return not self._tarballRecreated and (self.args.recreateTar or not os.path.exists(self._tarfile) or self._filesChanged())
    

_hasCompressedTarball()

CPGridRun.CPGridRun._hasCompressedTarball ( self )

protected

Definition at line 324 of file CPGridRun.py.

    def _hasCompressedTarball(self):
        return os.path.exists(self._tarfile) or self._tarballRecreated
    

_initRunscript()

CPGridRun.CPGridRun._initRunscript ( self )

protected

Definition at line 30 of file CPGridRun.py.

    def _initRunscript(self):
        if self._runscript is not None:
            return self._runscript
        elif isAthena:
            from AnalysisAlgorithmsConfig.AthenaCPRunScript import AthenaCPRunScript
            self._runscript = AthenaCPRunScript()
        else:
            from AnalysisAlgorithmsConfig.EventLoopCPRunScript import EventLoopCPRunScript
            self._runscript = EventLoopCPRunScript()
        return self._runscript
 

_outputDSFormatter()

CPGridRun.CPGridRun._outputDSFormatter ( self, name )

protected

{group/user}.{username}.{prefix}.{DSID}.{format}.{tags}.{suffix}

Definition at line 333 of file CPGridRun.py.

    def _outputDSFormatter(self, name):
        '''
        {group/user}.{username}.{prefix}.{DSID}.{format}.{tags}.{suffix}
        '''
        nameParser = CPGridRun.atlasProductionNameParser(name)
        base = 'group' if self.args.groupProduction else 'user'
        username = self.args.gridUsername
        dsid = nameParser['DSID']
        tags = '_'.join(nameParser['tags'])
        fileFormat = nameParser['format']
        base = 'group' if self.args.groupProduction else 'user'
        prefix = self.args.prefix if self.args.prefix else nameParser['main'].split('_')[0] # Dynamically set the prefix, likely to be something like PhPy8Eg
        suffix = self._suffixFormatter()
 
        result = [base, username, prefix, dsid, fileFormat, tags, suffix]
        return ".".join(filter(None, result))
 

_parseGridArguments()

CPGridRun.CPGridRun._parseGridArguments ( self )

protected

Definition at line 41 of file CPGridRun.py.

    def _parseGridArguments(self):
        parser = argparse.ArgumentParser(description='CPGrid runscript to submit CPRun.py jobs to the grid. '
                                         'This script will submit a job to the grid using files in the input text one by one.'
                                         'CPRun.py can handle multiple sources of input and create one output; but not this script',
                                         add_help=False,
                                         formatter_class=argparse.RawTextHelpFormatter)
        parser.add_argument('-h', '--help', dest='help', action='store_true', help='Show this help message and continue')
 
        ioGroup = parser.add_argument_group('Input/Output file configuration')
        ioGroup.add_argument('-i','--input-list', dest='input_list', help='Path to the text file containing list of containers on the panda grid. Each container will be passed to prun as --inDS and is run individually')
        ioGroup.add_argument('--output-files', dest='output_files', nargs='+', default=['output.root'],
                             help='The output files of the grid job. Example: --output-files A.root B.txt B.root results in A/A.root, B/B.txt, B/B.root in the output directory. No need to specify if using CPRun.py')
        ioGroup.add_argument('--destSE', dest='destSE', default='', type=str, help='Destination storage element (PanDA)')
        ioGroup.add_argument('--mergeType', dest='mergeType', default='Default', type=str, help='Output merging type, [None, Default, xAOD]')
 
        pandaGroup = parser.add_argument_group('Input/Output naming configuration')
        pandaGroup.add_argument('--gridUsername', dest='gridUsername', default=os.getenv('USER', ''), type=str, help='Grid username, or the groupname. Default is the current user. Only affect file naming')
        pandaGroup.add_argument('--prefix', dest='prefix', default='', type=str, help='Prefix for the output directory. Dynamically set with input container if not provided')
        pandaGroup.add_argument('--suffix', dest='suffix', default='',type=str, help='Suffix for the output directory')
        pandaGroup.add_argument('--outDS', dest='outDS', default='', type=str,
                                help='Name of an output dataset. outDS will contain all output files (PanDA). If not provided, support dynamic naming if input name is in the Atlas production format or typical user production format')
 
        cpgridGroup = parser.add_argument_group('CPGrid configuration')
        cpgridGroup.add_argument('--groupProduction', dest='groupProduction', action='store_true', help='Only use for official production')
 
        cpgridGroup.add_argument('--exec', dest='exec', type=str,
                                    help='Executable line for the CPRun.py or custom script to run on the grid encapsulated in a double quote (PanDA)\n'
                                    'Run CPRun.py with preset behavior including streamlined file i/o. E.g, "CPRun.py -t config.yaml --no-systematics".\n'
                                    'Run custom script: "customRun.py -i inputs -o output --text-config config.yaml --flagA --flagB"\n'
                                    )
 
        submissionGroup = parser.add_argument_group('Submission configuration')
        submissionGroup.add_argument('-y', '--agreeAll', dest='agreeAll', action='store_true', help='Agree to all the submission details without asking for confirmation. Use with caution!')
        submissionGroup.add_argument('--noSubmit', dest='noSubmit', action='store_true', help='Do not submit the job to the grid (PanDA). Useful to inspect the prun command')
        submissionGroup.add_argument('--testRun', dest='testRun', action='store_true', help='Will submit job to the grid but greatly limit the number of files per job (10) and number of events (300)')
        submissionGroup.add_argument('--checkInputDS', dest='checkInputDS', action='store_true', help='Check if the input datasets are available on the AMI.')
        submissionGroup.add_argument('--recreateTar', dest='recreateTar', action='store_true', help='Re-compress the source code. Source code are compressed by default in submission, this is useful when the source code is updated')
        submissionGroup.add_argument('--useCentralPackage', dest='useCentralPackage', action='store_true', help='Use central package instead of custom packages')
        self.args, self.unknown_args = parser.parse_known_args()
        self.outputFilesParsing()
        return parser
        

_parseInputFileList()

CPGridRun.CPGridRun._parseInputFileList ( path )

staticprotected

Definition at line 640 of file CPGridRun.py.

    def _parseInputFileList(path):
        files = []
        with open(path, 'r') as inputText:
            for line in inputText.readlines():
                # skip comments and empty lines
                if line.startswith('#') or not line.strip():
                    continue
                files += line.split(',')
            # remove leading/trailing whitespaces, and \n
            files = [file.strip() for file in files]
        return files
 

_prepareAmiQueryFromInputList()

CPGridRun.CPGridRun._prepareAmiQueryFromInputList ( self )

protected

Helper function to prepare a list of queries for the AMI based on the input list.
It will replace the _p### with _p% to match the latest ptag.

Definition at line 271 of file CPGridRun.py.

    def _prepareAmiQueryFromInputList(self):
        '''
        Helper function to prepare a list of queries for the AMI based on the input list.
        It will replace the _p### with _p% to match the latest ptag.
        '''
        import re
        regex = re.compile("_p[0-9]+")
        queries = []
        datasetPtag = {}
        for datasetName in self.cmd:
            parsed = CPGridRun.atlasProductionNameParser(datasetName)
            datasetPtag[datasetName] = parsed.get('ptag')
            queries.append(regex.sub("_p%", datasetName))
        return queries, datasetPtag
    

_sourceDir()

CPGridRun.CPGridRun._sourceDir ( self )

protected

Definition at line 409 of file CPGridRun.py.

    def _sourceDir(self):
        cmakeCachePath = os.path.join(self._buildDir(), 'CMakeCache.txt')
        sourceDir = None
        if not os.path.exists(cmakeCachePath):
            return sourceDir
        with open(cmakeCachePath, 'r') as cmakeCache:
            for line in cmakeCache:
                if '_SOURCE_DIR:STATIC=' in line:
                    sourceDir = line.split('=')[1].strip()
                    break
        return sourceDir
 

_suffixFormatter()

CPGridRun.CPGridRun._suffixFormatter ( self )

protected

Definition at line 364 of file CPGridRun.py.

    def _suffixFormatter(self):
        if self.args.suffix:
            return self.args.suffix
        if self.args.testRun:
            import uuid
            return f"test_{uuid.uuid4().hex[:6]}"
        else:
            ''
 

_unknownArgsDict()

dict CPGridRun.CPGridRun._unknownArgsDict ( self )

protected

Cleans the unknown args by removing leading dashes and ensuring they are in key-value pairs

Definition at line 192 of file CPGridRun.py.

    def _unknownArgsDict(self)->dict:
        '''
        Cleans the unknown args by removing leading dashes and ensuring they are in key-value pairs
        '''
        unknown_args_dict = {}
        idx = 0
        while idx < len(self.unknown_args):
            if self.unknown_args[idx].startswith('-'):
                if idx + 1 < len(self.unknown_args) and not self.unknown_args[idx + 1].startswith('-'):
                    unknown_args_dict[self.unknown_args[idx].lstrip('-')] = self.unknown_args[idx + 1]
                    idx += 2
                else:
                    unknown_args_dict[self.unknown_args[idx].lstrip('-')] = True
                    idx += 1
        return unknown_args_dict
    

askSubmission()

CPGridRun.CPGridRun.askSubmission

(

self

)

Definition at line 666 of file CPGridRun.py.

    def askSubmission(self):
        if self.args.agreeAll:
            logCPGridRun.info("You have agreed to all the submission details. Jobs will be submitted without confirmation.")
            self.submit()
            return
        answer = input("Please confirm ALL the submission details are correct before submitting [y/n]: ")
        if answer.lower() == 'y':
            self.submit()
        elif answer.lower() == 'n':
            logCPGridRun.info("Feel free to report any unexpected behavior to the CPAlgorithms team!")
        else:
            logCPGridRun.error("Invalid input. Please enter 'y' or 'n'. Jobs are not submitted.")
 

atlasProductionNameParser()

CPGridRun.CPGridRun.atlasProductionNameParser ( filename )

static

Parsing file name into a dictionary, an example is given here
mc20_13TeV.410470.PhPy8EG_A14_ttbar_hdamp258p75_nonallhad.deriv.DAOD_PHYS.e6337_s3681_r13167_p5855/DAOD_PHYS.34865530._000740.pool.root.1
For the first part
datasetName: mc20_13TeV.410470.PhPy8EG_A14_ttbar_hdamp258p75_nonallhad.deriv.DAOD_PHYS.e6337_s3681_r13167_p5855
projectName: mc20_13TeV
campaign: mc20
energy: 13 #(TeV)
DSID: 410470
main: PhPy8EG_A14_ttbar_hdamp258p75_nonallhad
TODO  generator: PhPy8Eg
TODO  tune: A14 # For Pythia8
TODO  process: ttbar
TODO  hdamp: 258p75 # For Powheg
TODO  decayType: nonallhad
step: deriv
format: DAOD_PHYS
tags: e###_s###_r###_p###_a###_t###_b#
etag: e6337 # EVNT (EVGEN) production and merging
stag: s3681 # Geant4 simulation to produce HITS and merging!
rtag: r13167 # Digitisation and reconstruction, as well as AOD merging
ptag: p5855 # Production of NTUP_PILEUP format and merging
atag: aXXX: atlfast configuration (both simulation and digit/recon)
ttag: tXXX: tag production configuration
btag: bXXX: bytestream production configuration

For the second part
JeditaskID: 34865530
fileNumber: 000740
version: 1

Definition at line 544 of file CPGridRun.py.

    def atlasProductionNameParser(filename):
        '''
        Parsing file name into a dictionary, an example is given here
        mc20_13TeV.410470.PhPy8EG_A14_ttbar_hdamp258p75_nonallhad.deriv.DAOD_PHYS.e6337_s3681_r13167_p5855/DAOD_PHYS.34865530._000740.pool.root.1
        For the first part
        datasetName: mc20_13TeV.410470.PhPy8EG_A14_ttbar_hdamp258p75_nonallhad.deriv.DAOD_PHYS.e6337_s3681_r13167_p5855
        projectName: mc20_13TeV
        campaign: mc20
        energy: 13 #(TeV)
        DSID: 410470
        main: PhPy8EG_A14_ttbar_hdamp258p75_nonallhad
        TODO  generator: PhPy8Eg
        TODO  tune: A14 # For Pythia8
        TODO  process: ttbar
        TODO  hdamp: 258p75 # For Powheg
        TODO  decayType: nonallhad
        step: deriv
        format: DAOD_PHYS
        tags: e###_s###_r###_p###_a###_t###_b#
        etag: e6337 # EVNT (EVGEN) production and merging
        stag: s3681 # Geant4 simulation to produce HITS and merging!
        rtag: r13167 # Digitisation and reconstruction, as well as AOD merging
        ptag: p5855 # Production of NTUP_PILEUP format and merging
        atag: aXXX: atlfast configuration (both simulation and digit/recon)
        ttag: tXXX: tag production configuration
        btag: bXXX: bytestream production configuration
 
        For the second part
        JeditaskID: 34865530
        fileNumber: 000740
        version: 1
 
        '''
        result = {}
        #split the / in case
        # mc20_13TeV.410470.PhPy8EG_A14_ttbar_hdamp258p75_nonallhad.deriv.DAOD_PHYS.e6337_s3681_r13167_p5855
        # /DAOD_PHYS.34865530._000740.pool.root.1
        if '/' in filename:
            datasetPart, filePart = filename.split('/')
        else:
            datasetPart = filename
            filePart = None
 
        # Remove the scope
        if ':' in datasetPart:
            datasetPart = datasetPart.split(':')[1]
 
        # Do not try to parse user datasets
        if datasetPart.startswith('user') or datasetPart.startswith('group'):
            result['datasetName'] = datasetPart
            return result
 
        # Split the dataset part by dots
        datasetParts = datasetPart.split('.')
        result['datasetName'] = datasetPart
        # Extract the first part
        result['projectName'] = datasetParts[0] # is positional
        # Extract the campaign and energy
        campaign_energy = result['projectName'].split('_')
        result['campaign'] = campaign_energy[0]
        result['energy'] = campaign_energy[1]
 
        # Extract the DSID, positional
        result['DSID'] = datasetParts[1]
        result['main'] = datasetParts[2]
        result['step'] = datasetParts[3]
        result['format'] = datasetParts[4]
 
        # Extract the tags (etag, stag, rtag, ptag)
        tags = datasetParts[5].split('_')
        result['tags'] = tags
        for tag in tags:
            if tag.startswith('e'):
                result['etag'] = tag
            elif tag.startswith('s'):
                result['stag'] = tag
            elif tag.startswith('r'):
                result['rtag'] = tag
            elif tag.startswith('p'):
                result['ptag'] = tag
            elif tag.startswith('a'):
                result['atag'] = tag
            elif tag.startswith('t'):
                result['ttag'] = tag
            elif tag.startswith('b'):
                result['btag'] = tag
 
        # Extract the file part if it exists
        if filePart:
            fileParts = filePart.split('.')
            result['jediTaskID'] = fileParts[1]
            result['fileNumber'] = fileParts[2]
            result['version'] = fileParts[-1]
        return result
 

checkExternalTools()

CPGridRun.CPGridRun.checkExternalTools

(

self

)

Definition at line 661 of file CPGridRun.py.

    def checkExternalTools(self):
        self.hasPrun()
        if self.args.checkInputDS:
            self.checkInputInPyami()
        

checkInputInPyami()

bool CPGridRun.CPGridRun.checkInputInPyami

(

self

)

Definition at line 254 of file CPGridRun.py.

    def checkInputInPyami(self) -> bool:
        if not self.hasPyami():
            return False
    
        client = pyAMI.client.Client('atlas')
        pyAMI.atlas.api.init()
    
        queries, datasetPtag = self._prepareAmiQueryFromInputList()
        try:
            results = pyAMI.atlas.api.list_datasets(client, patterns=queries)
        except pyAMI.exception.Error:
            self._errorCollector['no valid certificate'] = (
                "Cannot query AMI, please run 'voms-proxy-init -voms atlas' and ensure your certificate is valid.")
            return False
    
        return self._analyzeAmiResults(results, datasetPtag)
    

configureSubmission()

CPGridRun.CPGridRun.configureSubmission

(

self

)

Definition at line 133 of file CPGridRun.py.

    def configureSubmission(self):
        for input in self.inputList:
            cmd = self.configureSubmissionSingleSample(input)
            self.cmd[input] = cmd
            self._isFirstRun = False
 

configureSubmissionSingleSample()

CPGridRun.CPGridRun.configureSubmissionSingleSample	(		self,
			input )

Definition at line 139 of file CPGridRun.py.

    def configureSubmissionSingleSample(self, input):
        config = {
            'inDS': input,
            'outDS': self.args.outDS if self.args.outDS else self.outputDSFormatter(input) ,
            'cmtConfig': os.environ["CMTCONFIG"],
            'writeInputToTxt': 'IN:in.txt',
            'outputs': self.outputsFormatter(),
            'exec': self.execFormatter(),
            'memory': "2000", # MB
            'addNthFieldOfInDSToLFN': '2,3,6',
        }
        if self.args.noSubmit:
            config['noSubmit'] = True
 
        if self.args.mergeType == 'xAOD':
            config['mergeScript'] = 'xAODMerge %OUT `echo %IN | sed \'s/,/ /g\'`'
 
        if self.args.mergeType != 'None':
            config['mergeOutput'] = True
 
        # Three types of files sending the grid 
        if self.args.useCentralPackage: # 1. Using central package and have a yaml file only
            config['extFile'] = self._yamlPath
            config['noBuild'] = True
            config['noCompile'] = True
            config['athenaTag'] = f"AnalysisBase,{os.environ['AnalysisBase_VERSION']}"
        elif self._filesChangedOrTarballNotCreated(): # 2. Using custom packages and haven't compressed the tarball since the last changes
            config['outTarBall'] = self._tarfile
            config['useAthenaPackages'] = True
            self._tarballRecreated = True
        elif self._hasCompressedTarball(): # 3. Using custom packages and have compressed the tarball
            config['inTarBall'] = self._tarfile
            config['useAthenaPackages'] = True
 
        if self.args.groupProduction:
            config['official'] = True
            config['voms'] = f'atlas:/atlas/{self.args.gridUsername}/Role=production'
 
        if self.args.destSE:
            config['destSE'] = self.args.destSE
 
        if self.args.testRun:
            config['nEventsPerFile'] = 100
            config['nFiles'] = 5
        config.update(self.prunArgsDict)
        cmd = 'prun \\\n'
        for k, v in config.items():
            if isinstance(v, bool) and v:
                cmd += f'--{k} \\\n'
            elif v is not None and v != '':
                cmd += f'--{k} {v} \\\n'
        return cmd.rstrip(' \\\n')
    

execFormatter()

CPGridRun.CPGridRun.execFormatter

(

self

)

Definition at line 421 of file CPGridRun.py.

    def execFormatter(self):
        if not self.args.exec:
            raise ValueError('No exec command provided, use --exec to specify the command to run on the grid')
 
        # Check if the execution command starts with 'CPRun.py' or '-'
        isCPRunDefault = self.args.exec.startswith('-') or self.args.exec.startswith('CPRun.py')
        formatingClause = {
            'input_list': 'in.txt',
            'merge_output_files': len(self.args.output_files) == 1,
        }
        if not isCPRunDefault:
            if self._isFirstRun: logCPGridRun.warning("Non-CPRun.py is detected, please ensure the exec string is formatted correctly. Exec string will not be automatically formatted.")
            return f'"{self.args.exec}"'
        
        # Parse the exec string using the parser to validate and extract known arguments
        self._initRunscript()
        runscriptArgs, unknownArgs = self._runscript.parser.parse_known_args(self.args.exec.split(' '))
        
        # Throw error if unknownArgs contains any --args
        unknown_flags = [arg for arg in unknownArgs if arg.startswith('--')]
        if unknown_flags:
            logCPGridRun.error(f"Unknown flags detected in the exec string: {unknown_flags}. Please check the exec string.")
            raise ValueError(f"Unknown arguments detected: {unknown_flags}")
 
        # Only override if value is None or the parser default
        for key, value in formatingClause.items():
            if hasattr(runscriptArgs, key):
                old_value = getattr(runscriptArgs, key)
                if old_value is None or old_value == self._runscript.parser.get_default(key):
                    setattr(runscriptArgs, key, value)
                    if self._isFirstRun: logCPGridRun.info(f"Setting '{key}' to '{value}' (CPRun.py default is: '{old_value}')")
                else:
                    if self._isFirstRun: logCPGridRun.warning(f"Preserving user-defined '{key}': '{old_value}', default formatting '{value}' will not be applied.")
            else:
                logCPGridRun.error(f"Formatting clause '{key}' is not recognized in the CPRun.py script. Check CPGridRun.py")
                raise ValueError(f"Formatting clause '{key}' is not recognized in the CPRun.py script. Check CPGridRun.py")
        self._checkYamlExists(runscriptArgs)
        # Return the formatted arguments as a string
        arg_string = ' '.join(
            f'--{k.replace("_", "-")}' if isinstance(v, bool) and v else
            f'--{k.replace("_", "-")} {v}' for k, v in vars(runscriptArgs).items() if v not in [None, False]
        )
        return f'"CPRun.py {arg_string}"'
    

getParser()

CPGridRun.CPGridRun.getParser

(

self

)

Definition at line 128 of file CPGridRun.py.

    def getParser(self):
        return self.gridParser
 

hasPrun()

bool CPGridRun.CPGridRun.hasPrun

(

self

)

Definition at line 498 of file CPGridRun.py.

    def hasPrun(self) -> bool:
        import shutil
        prun_path = shutil.which("prun")
        if prun_path is None:
            self._errorCollector['no prun'] = (
                "The 'prun' command is not found. If you are on lxplus, please run the following commands:\n\n"
                "```\n"
                "lsetup panda\n"
                "voms-proxy-init -voms atlas\n"
                "```\n"
                "Make sure you have a valid certificate."
            )
            return False
        return True
        

hasPyami()

CPGridRun.CPGridRun.hasPyami

(

self

)

Definition at line 238 of file CPGridRun.py.

    def hasPyami(self):
        try:
            global pyAMI
            import pyAMI.client
            import pyAMI.atlas.api
        except ModuleNotFoundError:
            self._errorCollector['no AMI'] = (
                "Cannot import pyAMI, please run the following commands:\n\n"
                "```\n"
                "lsetup pyami\n"
                "voms-proxy-init -voms atlas\n"
                "```\n"
                "and make sure you have a valid certificate.")
            return False
        return True
        

inputList()

CPGridRun.CPGridRun.inputList

(

self

)

Definition at line 98 of file CPGridRun.py.

    def inputList(self):
        if not self.args.input_list:
            raise ValueError('No input list provided, use --input-list to specify the input containers')
        if self._inputList is None:
            if self.args.input_list.endswith('.txt'):
                self._inputList = CPGridRun._parseInputFileList(self.args.input_list)
            elif self.args.input_list.endswith('.json'):
                raise NotImplementedError('JSON input list parsing is not implemented')
            elif CPGridRun.isAtlasProductionFormat(self.args.input_list):
                self._inputList = [self.args.input_list]
            else:
                raise ValueError(
                    'use --input-list to specify input containers')
        return self._inputList
 

isAtlasProductionFormat()

CPGridRun.CPGridRun.isAtlasProductionFormat ( name )

static

Definition at line 520 of file CPGridRun.py.

    def isAtlasProductionFormat(name):
        if ":" in name:
            name = name.split(":")[1]
 
        if name.startswith('mc') or name.startswith('data'):
            return True
 
        logCPGridRun.warning("Name is not in the Atlas production format, assuming it is a user production")
        return False
 

outputDSFormatter()

CPGridRun.CPGridRun.outputDSFormatter	(		self,
			name )

Definition at line 327 of file CPGridRun.py.

    def outputDSFormatter(self, name):
        if CPGridRun.isAtlasProductionFormat(name):
            return self._outputDSFormatter(name)
        else:
            return self._customOutputDSFormatter(name)
 

outputFilesParsing()

CPGridRun.CPGridRun.outputFilesParsing

(

self

)

Definition at line 113 of file CPGridRun.py.

    def outputFilesParsing(self):
        output_files = []
        for output in self.args.output_files:
            if ',' in output:
                output_files.extend(output.split(','))
            else:
                output_files.append(output)
        self.output_files = output_files
 

outputsFormatter()

CPGridRun.CPGridRun.outputsFormatter

(

self

)

Definition at line 494 of file CPGridRun.py.

    def outputsFormatter(self):
        outputs = [f'{output.split(".")[0]}:{output}' if ":" not in output else output for output in self.args.output_files]
        return ','.join(outputs)
 

printDelayedErrorCollection()

CPGridRun.CPGridRun.printDelayedErrorCollection

(

self

)

Definition at line 652 of file CPGridRun.py.

    def printDelayedErrorCollection(self):
        if self._errorCollector:
            logCPGridRun.error("Errors were collected during the script execution:")
            
            for key, value in self._errorCollector.items():
                logCPGridRun.error(f"{key}: {value}")
            logCPGridRun.error("Please fix the errors and try again.")
            sys.exit(1)
        

printHelp()

CPGridRun.CPGridRun.printHelp

(

self

)

Definition at line 122 of file CPGridRun.py.

    def printHelp(self):
        self.gridParser.print_help()
        logCPGridRun.info("\033[92m\n If you are using CPRun.py, the following flags are for the CPRun.py in this framework\033[0m")
        self._runscript.parser.usage = argparse.SUPPRESS
        self._runscript.parser.print_help()
 

printInputDetails()

CPGridRun.CPGridRun.printInputDetails

(

self

)

Definition at line 228 of file CPGridRun.py.

    def printInputDetails(self):
        for key, cmd in self.cmd.items():
            parsed_name = CPGridRun.atlasProductionNameParser(key)
            logCPGridRun.info("\n"
                f"Input: {key}\n" +
                "\n".join([f"  {k.replace('_', ' ').title()}: {v}" for k, v in parsed_name.items()]))
            logCPGridRun.info(f"Command: \n{cmd}")
            print("-" * 70)
        # Add your submission logic here
    

rucioCustomNameParser()

CPGridRun.CPGridRun.rucioCustomNameParser ( filename )

static

The custom name has many variations, but most of them follow user/group.username.datasetname.suffix

Definition at line 531 of file CPGridRun.py.

    def rucioCustomNameParser(filename):
        '''
        The custom name has many variations, but most of them follow user/group.username.datasetname.suffix
        '''
        result = {}
        parts = filename.split('.')
        result['userType'] = parts[0]
        result['username'] = parts[1]
        result['main'] = parts[2]
        result['suffix'] = parts[-1]
        return result
 

submit()

CPGridRun.CPGridRun.submit

(

self

)

Definition at line 513 of file CPGridRun.py.

    def submit(self):
        import subprocess
        for key, cmd in self.cmd.items():
            process = subprocess.Popen(cmd, shell=True, stdout=sys.stdout, stderr=sys.stderr)
            process.communicate()
 

Member Data Documentation

_errorCollector

dict CPGridRun.CPGridRun._errorCollector = {}

protected

Definition at line 13 of file CPGridRun.py.

_inputList

list CPGridRun.CPGridRun._inputList = None

protected

Definition at line 18 of file CPGridRun.py.

_isFirstRun

bool CPGridRun.CPGridRun._isFirstRun = True

protected

Definition at line 16 of file CPGridRun.py.

_runscript

CPGridRun.CPGridRun._runscript = None

protected

Definition at line 14 of file CPGridRun.py.

_tarballRecreated

bool CPGridRun.CPGridRun._tarballRecreated = False

protected

Definition at line 17 of file CPGridRun.py.

_tarfile

CPGridRun.CPGridRun._tarfile = 'cpgrid.tar.gz'

protected

Definition at line 15 of file CPGridRun.py.

_yamlPath

CPGridRun.CPGridRun._yamlPath = None

protected

Definition at line 19 of file CPGridRun.py.

args

CPGridRun.CPGridRun.args

Definition at line 79 of file CPGridRun.py.

cmd

dict CPGridRun.CPGridRun.cmd = {}

Definition at line 20 of file CPGridRun.py.

gridParser

CPGridRun.CPGridRun.gridParser = self._parseGridArguments()

Definition at line 22 of file CPGridRun.py.

inputList

CPGridRun.CPGridRun.inputList

Definition at line 134 of file CPGridRun.py.

output_files

CPGridRun.CPGridRun.output_files = output_files

Definition at line 120 of file CPGridRun.py.

prunArgsDict

CPGridRun.CPGridRun.prunArgsDict = self._createPrunArgsDict()

Definition at line 23 of file CPGridRun.py.

unknown_args

CPGridRun.CPGridRun.unknown_args = parser.parse_known_args()

Definition at line 79 of file CPGridRun.py.

---

The documentation for this class was generated from the following file:

• CPGridRun.py