def __init__(self):
PayloadNode.__init__(self)
self.jobName = None
self.jobType = None
self.parameters = []
self.inputModule = None
self.outputModules = []
def __init__(self):
self.payload = PayloadNode()
self.parameters = {}
self.parameters.setdefault("WorkflowName", "Workflow-%s" % time.time())
self.parameters.setdefault("RequestTimestamp", int(time.time()))
self.parameters.setdefault("RequestCategory", "PreProd")
self.parameters.setdefault("WorkflowType", "Processing")
self.parameters.setdefault("WorkflowRunNumber", 1)
self.parameters.setdefault("StreamerIndexDir", None)
self.pythonLibs = []
self._NodeMap = {}
def addNode(self, nodeInstance):
"""
_addNode_
Add JobSpecNode to this object as a child, propaget jobName
"""
PayloadNode.addNode(self, nodeInstance)
nodeInstance.jobName = self.jobName
nodeInstance.jobType = self.jobType
return
def makeIMProv(self):
"""
_makeIMProv_
Generate IMProvNode based persistency object
"""
baseNode = PayloadNode.makeIMProv(self)
baseNode.attrs['JobName'] = self.jobName
baseNode.attrs['JobType'] = self.jobType
specNode = IMProvNode("JobSpecification")
paramsNode = IMProvNode("Parameters")
for item in self.parameters:
paramsNode.addNode(IMProvNode(item[0], str(item[1])))
outNode = IMProvNode("OutputModules")
for outMod in self.outputModules:
outNode.addNode(IMProvNode("OutputModule", str(outMod)))
specNode.addNode(paramsNode)
specNode.addNode(IMProvNode("InputSource", str(self.inputModule)))
specNode.addNode(outNode)
baseNode.addNode(specNode)
return baseNode
def __init__(self):
self.payload = PayloadNode()
self.parameters = {}
self.parameters.setdefault("WorkflowName", "Workflow-%s" % time.time())
self.parameters.setdefault("RequestTimestamp", int(time.time()))
self.parameters.setdefault("RequestCategory", "PreProd")
self.parameters.setdefault("WorkflowType", "Processing")
self.parameters.setdefault("WorkflowRunNumber", 1)
self.parameters.setdefault("StreamerIndexDir", None)
self.pythonLibs = []
self._NodeMap = {}
def loadFromNode(self, improvNode):
"""
_loadFromNode_
Populate this object based on content of improvNode provided
"""
paramQ = IMProvQuery("/WorkflowSpec/Parameter")
payloadQ = IMProvQuery("/WorkflowSpec/Payload/PayloadNode")
libsQ = IMProvQuery(
"/WorkflowSpec/PythonLibraries/PythonLibrary[attribute(\"Name\")]")
# //
# // Extract Params
#//
paramNodes = paramQ(improvNode)
for item in paramNodes:
paramName = item.attrs.get("Name", None)
if paramName == None:
continue
paramValue = str(item.chardata)
self.parameters[str(paramName)] = paramValue
# //
# // Extract python lib list
#//
libNames = libsQ(improvNode)
for item in libNames:
self.addPythonLibrary(str(item))
# //
# // Extract Payload Nodes
#//
payload = payloadQ(improvNode)[0]
self.payload = PayloadNode()
self.payload.populate(payload)
return
def loadFromNode(self, improvNode):
"""
_loadFromNode_
Populate this object based on content of improvNode provided
"""
paramQ = IMProvQuery("/WorkflowSpec/Parameter")
payloadQ = IMProvQuery("/WorkflowSpec/Payload/PayloadNode")
libsQ = IMProvQuery(
"/WorkflowSpec/PythonLibraries/PythonLibrary[attribute(\"Name\")]")
# //
# // Extract Params
#//
paramNodes = paramQ(improvNode)
for item in paramNodes:
paramName = item.attrs.get("Name", None)
if paramName == None:
continue
paramValue = str(item.chardata)
self.parameters[str(paramName)] = paramValue
# //
# // Extract python lib list
#//
libNames = libsQ(improvNode)
for item in libNames:
self.addPythonLibrary(str(item))
# //
# // Extract Payload Nodes
#//
payload = payloadQ(improvNode)[0]
self.payload = PayloadNode()
self.payload.populate(payload)
return
class WorkflowSpec:
"""
_WorkflowSpec_
Broad definition of a workflow tree using PayloadNodes to
represent the workflow as a tree.
"""
def __init__(self):
self.payload = PayloadNode()
self.parameters = {}
self.parameters.setdefault("WorkflowName", "Workflow-%s" % time.time())
self.parameters.setdefault("RequestTimestamp", int(time.time()))
self.parameters.setdefault("RequestCategory", "PreProd")
self.parameters.setdefault("WorkflowType", "Processing")
self.parameters.setdefault("WorkflowRunNumber", 1)
self.parameters.setdefault("StreamerIndexDir", None)
self.pythonLibs = []
self._NodeMap = {}
def workflowName(self):
"""
_workflowName_
Get the Workflow Name for this instance
"""
return self.parameters["WorkflowName"]
def setWorkflowName(self, name):
"""
_setWorkflowName_
Set the name of this workflow
"""
self.parameters['WorkflowName'] = name
updateWorkflowName(self.payload, name)
return
def requestTimestamp(self):
"""
_requestTimestamp_
Get the request timestamp that will be used in LFN generation
"""
return int(self.parameters['RequestTimestamp'])
def setRequestTimestamp(self, timestamp):
"""
_setRequestTimestamp_
Set the Request Timestamp to be used for LFN creation. Must be
a Unix time integer such as the output of time.time() in python
or `date +%s`
"""
self.parameters['RequestTimestamp'] = timestamp
return
def requestCategory(self):
"""
_requestCategory_
Get the Request Category value. This is the broad classification
of the Request indicating what it is for, eg PreProd, CSA06, DC04,
Personal etc etc
"""
return self.parameters['RequestCategory']
def setRequestCategory(self, category):
"""
_setRequestCategory_
Set the category value for this request
"""
self.parameters['RequestCategory'] = category
return
def setAcquisitionEra(self, era):
"""
_setAcquisitionEra_
set the Acquisition era value for the workflow
"""
self.parameters['AcquisitionEra'] = era
def setActivity(self, activity):
"""
_setWorkflowCategory_
Set the workflow category,
i.e. Simulation, Reconstruction, Reprocessing, Skimming
"""
self.parameters["Activity"] = activity
return
def workflowRunNumber(self):
"""
_workflowRunNumber_
get the workflow run number
"""
return self.parameters['WorkflowRunNumber']
def setWorkflowRunNumber(self, runNumber):
"""
_setWorkflowRunNumber_
Set the workflow run number parameter
"""
self.parameters['WorkflowRunNumber'] = runNumber
return
def pythonLibraries(self):
"""
_pythonLibraries_
Return list of additional py libs needed for this workflow
"""
return self.pythonLibs
def addPythonLibrary(self, libraryName):
"""
_addPythonLibrary_
Add the name of a python lib that needs to be packaged for
runtime. libraryName should be a string of the form
"pkg1.pkg2.module"
"""
self.pythonLibs.append(libraryName)
return
def makeIMProv(self):
"""
_makeIMProv_
Serialise the WorkflowSpec instance into an XML IMProv structure
"""
node = IMProvNode("WorkflowSpec")
for key, val in self.parameters.items():
paramNode = IMProvNode("Parameter", str(val), Name=str(key))
node.addNode(paramNode)
libs = IMProvNode("PythonLibraries")
for lib in self.pythonLibs:
libs.addNode(IMProvNode("PythonLibrary", None, Name=str(lib)))
node.addNode(libs)
payload = IMProvNode("Payload")
payload.addNode(self.payload.makeIMProv())
node.addNode(payload)
return node
def save(self, filename):
"""
_save_
Save this workflow spec into a file using the name provided
"""
handle = open(filename, 'w')
handle.write(self.makeIMProv().makeDOMElement().toprettyxml())
handle.close()
return
def saveString(self):
"""
_saveString_
Save this object to an XML string
"""
improv = self.makeIMProv()
return str(improv.makeDOMElement().toprettyxml())
def loadFromNode(self, improvNode):
"""
_loadFromNode_
Populate this object based on content of improvNode provided
"""
paramQ = IMProvQuery("/WorkflowSpec/Parameter")
payloadQ = IMProvQuery("/WorkflowSpec/Payload/PayloadNode")
libsQ = IMProvQuery(
"/WorkflowSpec/PythonLibraries/PythonLibrary[attribute(\"Name\")]")
# //
# // Extract Params
#//
paramNodes = paramQ(improvNode)
for item in paramNodes:
paramName = item.attrs.get("Name", None)
if paramName == None:
continue
paramValue = str(item.chardata)
self.parameters[str(paramName)] = paramValue
# //
# // Extract python lib list
#//
libNames = libsQ(improvNode)
for item in libNames:
self.addPythonLibrary(str(item))
# //
# // Extract Payload Nodes
#//
payload = payloadQ(improvNode)[0]
self.payload = PayloadNode()
self.payload.populate(payload)
return
def load(self, filename):
"""
_load_
Load a saved WorkflowSpec from a File
"""
node = loadIMProvFile(filename)
self.loadFromNode(node)
return
def loadString(self, xmlString):
"""
_load_
Load a saved WorkflowSpec from a File
"""
node = loadIMProvString(xmlString)
self.loadFromNode(node)
return
def createJobSpec(self):
"""
_createJobSpec_
Create a tree of JobSpecNodes from this WorkflowSpec
instances tree of payload nodes.
Same tree structure will be used, but nodes will be
JobSpecNode instances containing the details from the
corresponding PayloadNode in this instance.
To be used to create JobSpecNode trees from a Workflow
to represent a job created from the general workflow
"""
self._NodeMap = {}
result = JobSpec()
result.payload = self._CloneTreeNode(self.payload)
result.parameters.update(self.parameters)
return result
def _CloneTreeNode(self, node):
"""
_CloneTreeNode_
Internal method for cloning a PayloadNode as a JobSpecNode
and keeping track of the parentage via an id based hashtable
"""
newNode = JobSpecNode()
newNode.loadPayloadNode(node)
if newNode.cfgInterface != None:
newNode.cfgInterface.rawCfg = None
newNode.cfgInterface.originalCfg = None
for key, val in self.parameters.items():
newNode.addParameter(key, val)
self._NodeMap[id(node)] = newNode
if node.parent != None:
parentNode = self._NodeMap[id(node.parent)]
parentNode.addNode(newNode)
for child in node.children:
self._CloneTreeNode(child)
return newNode
# //
# // Accessor methods for retrieving dataset information
#//
def outputDatasets(self):
"""
_outputDatasets_
returns a list of MCPayload.DatasetInfo objects (essentially
just dictionaries) containing all of the output datasets
in all nodes of this WorkflowSpec
"""
result = DatasetTools.getOutputDatasetsFromTree(self.payload)
return result
def outputDatasetsWithPSet(self):
"""
_outputDatasetsWithPSet_
returns a list of MCPayload.DatasetInfo objects (essentially
just dictionaries) containing all of the output datasets
in all nodes of this WorkflowSpec, including a PSetContent key
that contains the PSet {{}} string.
"""
result = DatasetTools.getOutputDatasetsWithPSetFromTree(self.payload)
return result
def pileupDatasets(self):
"""
_pileupDataset_
Get a list of all pileup datasets required by this workflow
"""
return DatasetTools.getPileupDatasetsFromTree(self.payload)
def inputDatasets(self):
"""
_inputDatasets_
return a list of Input datasets from this workflow
"""
return DatasetTools.getInputDatasetsFromTree(self.payload)
class WorkflowSpec:
"""
_WorkflowSpec_
Broad definition of a workflow tree using PayloadNodes to
represent the workflow as a tree.
"""
def __init__(self):
self.payload = PayloadNode()
self.parameters = {}
self.parameters.setdefault("WorkflowName", "Workflow-%s" % time.time())
self.parameters.setdefault("RequestTimestamp", int(time.time()))
self.parameters.setdefault("RequestCategory", "PreProd")
self.parameters.setdefault("WorkflowType", "Processing")
self.parameters.setdefault("WorkflowRunNumber", 1)
self.parameters.setdefault("StreamerIndexDir", None)
self.pythonLibs = []
self._NodeMap = {}
def workflowName(self):
"""
_workflowName_
Get the Workflow Name for this instance
"""
return self.parameters["WorkflowName"]
def setWorkflowName(self, name):
"""
_setWorkflowName_
Set the name of this workflow
"""
self.parameters['WorkflowName'] = name
updateWorkflowName(self.payload, name)
return
def requestTimestamp(self):
"""
_requestTimestamp_
Get the request timestamp that will be used in LFN generation
"""
return int(self.parameters['RequestTimestamp'])
def setRequestTimestamp(self, timestamp):
"""
_setRequestTimestamp_
Set the Request Timestamp to be used for LFN creation. Must be
a Unix time integer such as the output of time.time() in python
or `date +%s`
"""
self.parameters['RequestTimestamp'] = timestamp
return
def requestCategory(self):
"""
_requestCategory_
Get the Request Category value. This is the broad classification
of the Request indicating what it is for, eg PreProd, CSA06, DC04,
Personal etc etc
"""
return self.parameters['RequestCategory']
def setRequestCategory(self, category):
"""
_setRequestCategory_
Set the category value for this request
"""
self.parameters['RequestCategory'] = category
return
def setAcquisitionEra(self, era):
"""
_setAcquisitionEra_
set the Acquisition era value for the workflow
"""
self.parameters['AcquisitionEra'] = era
def setActivity(self, activity):
"""
_setWorkflowCategory_
Set the workflow category,
i.e. Simulation, Reconstruction, Reprocessing, Skimming
"""
self.parameters["Activity"] = activity
return
def workflowRunNumber(self):
"""
_workflowRunNumber_
get the workflow run number
"""
return self.parameters['WorkflowRunNumber']
def setWorkflowRunNumber(self, runNumber):
"""
_setWorkflowRunNumber_
Set the workflow run number parameter
"""
self.parameters['WorkflowRunNumber'] = runNumber
return
def pythonLibraries(self):
"""
_pythonLibraries_
Return list of additional py libs needed for this workflow
"""
return self.pythonLibs
def addPythonLibrary(self, libraryName):
"""
_addPythonLibrary_
Add the name of a python lib that needs to be packaged for
runtime. libraryName should be a string of the form
"pkg1.pkg2.module"
"""
self.pythonLibs.append(libraryName)
return
def makeIMProv(self):
"""
_makeIMProv_
Serialise the WorkflowSpec instance into an XML IMProv structure
"""
node = IMProvNode("WorkflowSpec")
for key, val in self.parameters.items():
paramNode = IMProvNode("Parameter", str(val), Name = str(key))
node.addNode(paramNode)
libs = IMProvNode("PythonLibraries")
for lib in self.pythonLibs:
libs.addNode(IMProvNode("PythonLibrary", None, Name = str(lib)))
node.addNode(libs)
payload = IMProvNode("Payload")
payload.addNode(self.payload.makeIMProv())
node.addNode(payload)
return node
def save(self, filename):
"""
_save_
Save this workflow spec into a file using the name provided
"""
handle = open(filename, 'w')
handle.write(self.makeIMProv().makeDOMElement().toprettyxml())
handle.close()
return
def saveString(self):
"""
_saveString_
Save this object to an XML string
"""
improv = self.makeIMProv()
return str(improv.makeDOMElement().toprettyxml())
def loadFromNode(self, improvNode):
"""
_loadFromNode_
Populate this object based on content of improvNode provided
"""
paramQ = IMProvQuery("/WorkflowSpec/Parameter")
payloadQ = IMProvQuery("/WorkflowSpec/Payload/PayloadNode")
libsQ = IMProvQuery(
"/WorkflowSpec/PythonLibraries/PythonLibrary[attribute(\"Name\")]")
# //
# // Extract Params
#//
paramNodes = paramQ(improvNode)
for item in paramNodes:
paramName = item.attrs.get("Name", None)
if paramName == None:
continue
paramValue = str(item.chardata)
self.parameters[str(paramName)] = paramValue
# //
# // Extract python lib list
#//
libNames = libsQ(improvNode)
for item in libNames:
self.addPythonLibrary(str(item))
# //
# // Extract Payload Nodes
#//
payload = payloadQ(improvNode)[0]
self.payload = PayloadNode()
self.payload.populate(payload)
return
def load(self, filename):
"""
_load_
Load a saved WorkflowSpec from a File
"""
node = loadIMProvFile(filename)
self.loadFromNode(node)
return
def loadString(self, xmlString):
"""
_load_
Load a saved WorkflowSpec from a File
"""
node = loadIMProvString(xmlString)
self.loadFromNode(node)
return
def createJobSpec(self):
"""
_createJobSpec_
Create a tree of JobSpecNodes from this WorkflowSpec
instances tree of payload nodes.
Same tree structure will be used, but nodes will be
JobSpecNode instances containing the details from the
corresponding PayloadNode in this instance.
To be used to create JobSpecNode trees from a Workflow
to represent a job created from the general workflow
"""
self._NodeMap = {}
result = JobSpec()
result.payload = self._CloneTreeNode(self.payload)
result.parameters.update(self.parameters)
return result
def _CloneTreeNode(self, node):
"""
_CloneTreeNode_
Internal method for cloning a PayloadNode as a JobSpecNode
and keeping track of the parentage via an id based hashtable
"""
newNode = JobSpecNode()
newNode.loadPayloadNode(node)
if newNode.cfgInterface != None:
newNode.cfgInterface.rawCfg = None
newNode.cfgInterface.originalCfg = None
for key, val in self.parameters.items():
newNode.addParameter(key, val)
self._NodeMap[id(node)] = newNode
if node.parent != None:
parentNode = self._NodeMap[id(node.parent)]
parentNode.addNode(newNode)
for child in node.children:
self._CloneTreeNode(child)
return newNode
# //
# // Accessor methods for retrieving dataset information
#//
def outputDatasets(self):
"""
_outputDatasets_
returns a list of MCPayload.DatasetInfo objects (essentially
just dictionaries) containing all of the output datasets
in all nodes of this WorkflowSpec
"""
result = DatasetTools.getOutputDatasetsFromTree(self.payload)
return result
def outputDatasetsWithPSet(self):
"""
_outputDatasetsWithPSet_
returns a list of MCPayload.DatasetInfo objects (essentially
just dictionaries) containing all of the output datasets
in all nodes of this WorkflowSpec, including a PSetContent key
that contains the PSet {{}} string.
"""
result = DatasetTools.getOutputDatasetsWithPSetFromTree(
self.payload)
return result
def pileupDatasets(self):
"""
_pileupDataset_
Get a list of all pileup datasets required by this workflow
"""
return DatasetTools.getPileupDatasetsFromTree(self.payload)
def inputDatasets(self):
"""
_inputDatasets_
return a list of Input datasets from this workflow
"""
return DatasetTools.getInputDatasetsFromTree(self.payload)