getPayloadData Namespace Reference

Functions
def	deserialize_iovs (db, plugin_name, plot_name, tag, time_type, iovs)
def	discover ()
def	discover_plugins ()
def	output (description, param)
def	supress_output (f)

Function Documentation

def getPayloadData.deserialize_iovs	(		db,
			plugin_name,
			plot_name,
			tag,
			time_type,
			iovs
	)

Deserializes given iovs data and returns plot coordinates 

Definition at line 63 of file getPayloadData.py.

References createfilelist.int, and output().

Referenced by output().

def deserialize_iovs(db, plugin_name, plot_name, tag, time_type, iovs):
    ''' Deserializes given iovs data and returns plot coordinates '''
    
    output('Starting to deserialize iovs: ', '')
    output('db: ', db)
    output('plugin name: ', plugin_name)
    output('plot name: ', plot_name)
    output('tag name: ', tag)
    output('tag time type: ', time_type)
    output('iovs: ', iovs)
  
    plugin_base = import_module('pluginModule_PayloadInspector')
    output('PI plugin base: ', plugin_base)

    plugin_obj = import_module(plugin_name)
    output('PI plugin object: ', plugin_obj)

    # get plot method and execute it with given iovs
    plot = getattr(plugin_obj, plot_name)()
    output('plot object: ', plot)

    if db == "Prod":
        db_name = 'frontier://FrontierProd/CMS_CONDITIONS'
    elif db == 'Prep' :
        db_name = 'frontier://FrontierPrep/CMS_CONDITIONS'
    else:
        db_name = db
    output('full DB name: ', db_name)
    

    success = plot.process(db_name, tag, time_type, int(iovs['start_iov']), int(iovs['end_iov']))
    output('plot processed data successfully: ', success)
    if not success:
        return False


    result = plot.data()
    output('deserialized data: ', result)
    return result

def getPayloadData.discover

(

)

Discovers object types and plots for a given cmssw release
    Example:
    {
        "BasicPayload": [
            {"plot": "plot_BeamSpot_x", "plot_type": "History", 
             "single_iov": false, "plugin_name": "pluginBeamSpot_PayloadInspector",
             "title": "x vs run number"},
            ...
        ],
       ...
    }

Definition at line 139 of file getPayloadData.py.

References mps_setup.append, dir, discover_plugins(), and output().

Referenced by output().

def discover():
    ''' Discovers object types and plots for a given cmssw release
        Example:
        {
            "BasicPayload": [
                {"plot": "plot_BeamSpot_x", "plot_type": "History", 
                 "single_iov": false, "plugin_name": "pluginBeamSpot_PayloadInspector",
                 "title": "x vs run number"},
                ...
            ],
           ...
        }
    '''
    plugin_base = import_module('pluginModule_PayloadInspector') 
    result = {}
    for plugin_name in discover_plugins():
        output(' - plugin name: ', plugin_name)
        plugin_obj = import_module(plugin_name)
        output('*** PI plugin object: ', plugin_obj)
        for plot in dir(plugin_obj):
            if 'plot_' not in plot: continue # skip if method doesn't start with 'plot_' prefix
            output(' - plot name: ', plot)
            plot_method= getattr(plugin_obj, plot)()
            output(' - plot object: ', plot_method)
            payload_type = plot_method.payloadType()
            output(' - payload type: ', payload_type)
            plot_title = plot_method.title()
            output(' - plot title: ', plot_title)
            plot_type = plot_method.type()
            output(' - plot type: ', plot_type)
            single_iov = plot_method.isSingleIov()
            output(' - is single iov: ', single_iov)
            result.setdefault(payload_type, []).append({'plot': plot, 'plugin_name': plugin_name, 'title': plot_title, 'plot_type': plot_type, 'single_iov': single_iov})
            output('currently discovered info: ', result)
    output('*** final output:', '')
    return json.dumps(result)

def getPayloadData.discover_plugins

(

)

Returns a list of Payload Inspector plugin names
    Example:
    ['pluginBasicPayload_PayloadInspector', 'pluginBeamSpot_PayloadInspector', 'pluginSiStrip_PayloadInspector']

Definition at line 103 of file getPayloadData.py.

References output(), and python.rootplot.root2matplotlib.replace().

Referenced by discover().

def discover_plugins():
    ''' Returns a list of Payload Inspector plugin names
        Example:
        ['pluginBasicPayload_PayloadInspector', 'pluginBeamSpot_PayloadInspector', 'pluginSiStrip_PayloadInspector']
    '''
    architecture = os.environ.get('SCRAM_ARCH', None)
    output('architecture: ', architecture)

    plugins = []
    releases = [
        os.environ.get('CMSSW_BASE', None),
        os.environ.get('CMSSW_RELEASE_BASE', None)
    ]

    for r in releases:
        if not r: continue # skip if release base is not specified
        output('* release: ', r)

        path = os.path.join(r, 'lib', architecture)
        output('* full release path: ', path)

        plugins += glob.glob(path + '/plugin*_PayloadInspector.so' )
        output('found plugins: ', plugins) 
        
        if r: break # break loop if CMSSW_BASE is specified        
  
    # extracts the object name from plugin path:
    # /afs/cern.ch/cms/slc6_amd64_gcc493/cms/cmssw/CMSSW_8_0_6/lib/slc6_amd64_gcc493/pluginBasicPayload_PayloadInspector.so
    # becomes pluginBasicPayload_PayloadInspector
    result = []
    for p in plugins:
         result.append(p.split('/')[-1].replace('.so', ''))

    output('discovered plugins: ', result)
    return result

def getPayloadData.output	(		description,
			param
	)

Definition at line 176 of file getPayloadData.py.

References deserialize_iovs(), discover(), and harvestTrackValidationPlots.str.

Referenced by deserialize_iovs(), discover(), and discover_plugins().

def output(description, param):
    if args.verbose:
        print ''
        print description, param

def getPayloadData.supress_output

(

f

)

Temporarily disables stdout and stderr so that printouts from the plot
plugin does not compromise the purity of our ssh stream if 
args.suppress_output is true

Definition at line 20 of file getPayloadData.py.

References f.

def supress_output( f ):
    '''
    Temporarily disables stdout and stderr so that printouts from the plot
    plugin does not compromise the purity of our ssh stream if 
    args.suppress_output is true
    '''
    def decorated( *fargs, **fkwargs ):

        suppress = args.suppress_output
        if suppress:
            
            # Get rid of what is already there ( should be nothing for this script )
            sys.stdout.flush()

            # Save file descriptors so it can be reactivated later 
            saved_stdout = os.dup( 1 )
            saved_stderr = os.dup( 2 )

            # /dev/null is used just to discard what is being printed
            devnull = os.open( '/dev/null', os.O_WRONLY )

            # Duplicate the file descriptor for /dev/null
            # and overwrite the value for stdout (file descriptor 1)
            os.dup2( devnull, 1 )
            os.dup2( devnull, 2 )

        result = f( *fargs, **fkwargs )

        if suppress:

            # Close devnull after duplication (no longer needed)
            os.close( devnull )

            # Reenable stdout and stderr
            os.dup2( saved_stdout, 1 )
            os.dup2( saved_stderr, 2 )

        return result

    return decorated


@supress_output