python.PerfMonFlags Namespace Reference

Classes
class	doFastMonMT
class	doFullMonMT
class	doMonitoringMT
class	OutputJSON
class	PerfMonFlags

Functions
def	_decode_pmon_opts (opts, dry_run=False)
	module clean-up More...

Variables
string	__author__ = 'Sebastien Binet'
string	__version__ = "$Revision: 1.17 $"
string	__doc__ = "A container of flags for Performance Monitoring"
list	list_jobproperties

Function Documentation

_decode_pmon_opts()

def python.PerfMonFlags._decode_pmon_opts (   opts,   dry_run = False  )

private

module clean-up

– helper function to decode athena-command-line options

helper function to decode athena-command-line options.

@param opts is a list of options which can enable or disable a few
       jobproperties.PerfMonFlags fields

@param dry_run to only decode but not set the options

one activates a perfmon flag by prepending '+' in front of the option name
(or nothing prepended, '+' being the implied default)
and de-activates it by prepending '-'.

Definition at line 101 of file PerfMonFlags.py.

def _decode_pmon_opts(opts, dry_run=False):
    """helper function to decode athena-command-line options.
 
    @param opts is a list of options which can enable or disable a few
           jobproperties.PerfMonFlags fields
 
    @param dry_run to only decode but not set the options
 
    one activates a perfmon flag by prepending '+' in front of the option name
    (or nothing prepended, '+' being the implied default)
    and de-activates it by prepending '-'.
    """
    pmf = jobproperties.PerfMonFlags
    dispatch = {
        'perfmonmt':  pmf.doMonitoringMT,
        'fastmonmt':  pmf.doFastMonMT,
        'fullmonmt':  pmf.doFullMonMT,
        }
 
    for opt in opts:
        flag_name = opt[:]
        val = True
        if opt.startswith('-'):
            val = False
            flag_name = flag_name[1:]
        elif opt.startswith('+'):
            val = True
            flag_name = flag_name[1:]
        if flag_name not in dispatch:
            raise ValueError(
                '[%s] is not a valid PerfMonFlag (allowed: %r)' %
                (flag_name, list(dispatch.keys()))
                )
                
        if not dry_run:
            dispatch[flag_name].set_Value(val)

Variable Documentation

__author__

string python.PerfMonFlags.__author__ = 'Sebastien Binet'

private

Definition at line 12 of file PerfMonFlags.py.

__doc__

string python.PerfMonFlags.__doc__ = "A container of flags for Performance Monitoring"

private

Definition at line 14 of file PerfMonFlags.py.

__version__

string python.PerfMonFlags.__version__ = "$Revision: 1.17 $"

private

Definition at line 13 of file PerfMonFlags.py.

list_jobproperties

list python.PerfMonFlags.list_jobproperties

Initial value:

=  [
    doMonitoringMT,
    doFastMonMT,
    doFullMonMT,
    OutputJSON,
    ]

Definition at line 87 of file PerfMonFlags.py.