python.KeyStore Namespace Reference

Classes
class	CfgItemList
class	CfgKeyStore

Functions
def	__setattr__ (self, k, v)
	raise AttributeError( "CfgItemList' object has no attribute '%s'" % ( attr ) ) More...
def	__delattr__ (self, attr)
def	__bool__ (self)
def	removeItem (self, item)
def	removeAllItems (self, item)
def	remove (self, items)
def	removeAll (self)
def	clear (self)
def	setup (self)
def	getProperties (self)
def	_addItem (self, i)
def	add (self, arg)
def	has_item (self, item)
def	allowWildCard (self, allow)
def	__call__ (self, key=None)
def	list (self, key=None)
def	dict (self)
def	__repr__ (self)
def	__str__ (self, indent=0, headerLastIndentUnit=Configurable.indentUnit)
def	name (self)
def	children (self)
def	allChildren (self)
def	items (self)
	for l in self.keys(): yield self[l] More...
def	clear (self, label=None)
def	write (self, fileName, label)
def	read (self, fileName, label)
def	loadKeyStoreFromPoolFile (keyStore, pool_file, label='transient', items_type='eventdata')
def	keystore_diff (ref, chk, labels=None, ofile=None)

Variables
string	__version__ = '$Revision: 1.11 $'
	data More...
string	__author__ = 'Sebastien Binet <binet@cern.ch>'
list	__all__
	_allowedTriggerKeys = re.compile( r"(?P<KlassName>.*?)#HLTAutoKey.*\*$" )
	msg = logging.getLogger( 'CfgItemList' )
	_children
	_items
	_allowWildCard

Function Documentation

__bool__()

def python.KeyStore.__bool__

(

self

)

Definition at line 206 of file KeyStore.py.

    def __bool__(self):
        return True
 

__call__()

def python.KeyStore.__call__	(		self,
			key = None
	)

Definition at line 302 of file KeyStore.py.

    def __call__( self, key = None ):
        if key is not None:
            items = set( [ i for i in self._items if i.startswith(key+"#") ] )
        else:
            items = set( self._items )
        for c in self._children:
            try:
                for i in c.list( key ):
                    items.add( i )
            except AttributeError as err:
                msg.warning( err )
                pass
        items = [ i for i in items ]
        items.sort()
        return items
 

__delattr__()

def python.KeyStore.__delattr__	(		self,
			attr
	)

Definition at line 201 of file KeyStore.py.

    def __delattr__( self, attr ):
        for c in self._children:
            if c._name == attr:
                self._children.remove( c )
 

__repr__()

def python.KeyStore.__repr__

(

self

)

Definition at line 329 of file KeyStore.py.

    def __repr__( self ):
        return '<%s/%s at %s>' % (self.__class__.__name__,self._name,
                                hex(id(self)))
 

__setattr__()

def python.KeyStore.__setattr__	(		self,
			k,
			v
	)

raise AttributeError( "CfgItemList' object has no attribute '%s'" % ( attr ) )

Definition at line 190 of file KeyStore.py.

    def __setattr__( self, k, v ):
        if k in CfgItemList.__slots__:
            return super(CfgItemList, self).__setattr__(k, v)
        for c in self.children():
            if c.name() == k:
                return setattr(c, k, v)
        try:
            return super(CfgItemList, self).__setattr__(k, v)
        except AttributeError:
            pass
        

__str__()

def python.KeyStore.__str__	(		self,
			indent = 0,
			headerLastIndentUnit = Configurable.indentUnit
	)

Definition at line 333 of file KeyStore.py.

    def __str__( self, indent = 0,
                 headerLastIndentUnit=Configurable.indentUnit ):
        global msg  # to print some info depending on output level
        indentStr = indent * Configurable.indentUnit
        # print header
        title = "%s/%s" % ( self.__class__.__name__, self._name )
 
        # print line to easily see start-of-configurable
        if indent > 0:
            headerIndent = (indent-1)*Configurable.indentUnit \
                           + headerLastIndentUnit
        else:
            headerIndent = ''
 
        rep = Configurable._printHeader( headerIndent, title )
        rep += os.linesep
 
        # print own properties
        props = self.getProperties()
        if not props:
            #rep += indentStr + '|-<no output-item-list>' + os.linesep
            rep += indentStr + '| ' + os.linesep
        else:
            # get property name with
            nameWidth = 0
            for p in props.keys():
                nameWidth=max(nameWidth,len(p))
            for p, v in props.items():
                # start with indent and property name
                prefix = indentStr + '|-%-*s' % (nameWidth,p)
                # add memory address for debugging (not for defaults)
                if msg.isEnabledFor( logging.DEBUG ):
                    address = ' @%11s' % hex(id(v))
                    prefix += address
                # add value and default
                strVal = repr(v)
                # add the value
                line = prefix + ' = ' + strVal
                # add the line to the total string
                rep += line + os.linesep
        # print configurables + their properties, or loop over sequence
        for cfg in self.allChildren():
            rep += cfg.__str__( indent + 1, '|=' ) + os.linesep
 
        # print line to easily see end-of-configurable. Note: No linesep!
        rep += Configurable._printFooter( indentStr, title )
        return rep
 

_addItem()

def python.KeyStore._addItem (   self,   i  )

private

Definition at line 259 of file KeyStore.py.

    def _addItem( self, i ):
        if i.count( "*" ) <= 0:
            if i not in self._items:
                self._items.append( i )
        elif (self._allowWildCard or _allowedTriggerKeys.match(i)):
            if i not in self._items:
                self._items.append( i )
        else:
            msg.warning( "Attempt to add an invalid element: '%s'", i )
            msg.warning( "     ==> Ignoring invalid element: '%s'", i )
        return
                    

add()

def python.KeyStore.add	(		self,
			arg
	)

Definition at line 271 of file KeyStore.py.

    def add( self, arg ):
        if isinstance(arg, (list, tuple) ):
            for a in set(arg):
                self._addItem( a )
        elif isinstance(arg, str):
            self._addItem( arg )
        elif isinstance(arg, dict):
            new = arg.copy()
            for k in new.keys():
                if not isinstance(new[k], (list,tuple)):
                    new[k] = ( new[k], )
                self.add( [ '%s#%s' % (k,e) for e in new[k] ] )
        else:
            msg.error( "Could not add '%r' of type '%s'", arg, type(arg) )
        return
 

allChildren()

def python.KeyStore.allChildren

(

self

)

Definition at line 387 of file KeyStore.py.

    def allChildren( self ):
        children = []
        for c in self._children:
            children.append( c )
            children += c.allChildren()
           
        return children
   

allowWildCard()

def python.KeyStore.allowWildCard	(		self,
			allow
	)

Definition at line 299 of file KeyStore.py.

    def allowWildCard( self, allow ):
        self._allowWildCard = allow
        

children()

def python.KeyStore.children

(

self

)

Definition at line 384 of file KeyStore.py.

    def children( self ):
        return self._children
    

clear() [1/2]

def python.KeyStore.clear

(

self

)

Definition at line 235 of file KeyStore.py.

    def clear( self ):
        self.removeAll()
        self._items = []
        

clear() [2/2]

def python.KeyStore.clear	(		self,
			label = None
	)

Definition at line 527 of file KeyStore.py.

    def clear(self, label = None):
        if label is not None:
            self[label].clear()
        else:
            for c in self._items.children():
                c.clear()
        return
 

dict()

def python.KeyStore.dict

(

self

)

Definition at line 321 of file KeyStore.py.

    def dict( self ):
        props = self.getProperties()
        for c in self._children:
            props.update( c.dict() )
        for k in props.keys():
            props[k] = sorted(props[k])
        return props
    

getProperties()

def python.KeyStore.getProperties

(

self

)

Definition at line 247 of file KeyStore.py.

    def getProperties( self ):
        props = {}
        for item in self._items:
            cppType = item.split("#")[0]
            sgKey   = item.replace( cppType+"#", '' )
            if cppType in props:
                if sgKey not in props[cppType]:
                    props[cppType].append( sgKey )
            else:
                props[cppType] = [ sgKey ]
        return props
 

has_item()

def python.KeyStore.has_item	(		self,
			item
	)

Definition at line 287 of file KeyStore.py.

    def has_item( self, item ):
        from fnmatch import fnmatchcase as match
        for i in self._items:
            if match(i, item):
                return True
 
        
        for c in self._children:
            if c.has_item( item ):
                return True
        return False
    

items()

def python.KeyStore.items

(

self

)

for l in self.keys(): yield self[l]

Definition at line 524 of file KeyStore.py.

    def items(self):
        return zip( self.keys(), self.values() )
    

keystore_diff()

def python.KeyStore.keystore_diff	(		ref,
			chk,
			labels = None,
			ofile = None
	)

Helper function to print the 'diff' of two KeyStores `ref` and `chk` into
the file-like object `ofile` (default value: sys.stdout)
 `ref` and `chk` can either be :
   - @c KeyStore.CfgKeyStore instances or,
   - strings being the names of the _already created_
     @c KeyStore.CfgKeyStore instances
 @param `labels` the list of labels (default: CfgKeyStore.Labels) to compare
        between the two CfgKeyStores

Definition at line 637 of file KeyStore.py.

def keystore_diff (ref, chk, labels=None, ofile=None):
    """
    Helper function to print the 'diff' of two KeyStores `ref` and `chk` into
    the file-like object `ofile` (default value: sys.stdout)
     `ref` and `chk` can either be :
       - @c KeyStore.CfgKeyStore instances or,
       - strings being the names of the _already created_
         @c KeyStore.CfgKeyStore instances
     @param `labels` the list of labels (default: CfgKeyStore.Labels) to compare
            between the two CfgKeyStores
    """
    if isinstance (ref, str):
        if ref not in CfgKeyStore.instances:
            raise ValueError \
                  ('invalid `ref` argument (non existing instance name [%s])'%\
                   ref)
        ref = CfgKeyStore.instances [ref]
 
    if isinstance (chk, str):
        if chk not in CfgKeyStore.instances:
            raise ValueError \
                  ('invalid `chk` argument (non existing instance name [%s])'%\
                   chk)
        chk = CfgKeyStore.instances [chk]
 
    if labels is None:
        labels = CfgKeyStore.__slots__['Labels']
    elif isinstance (labels, str):
        labels = [l.strip() for l in labels.split() if l.strip() != '']
        
    if ofile is None:
        import sys
        ofile = sys.stdout
    
    diff = []
    if ref is chk or ref == chk:
        return ""
    
    for label in labels:
        ref_content = sorted (ref[label].list())
        chk_content = sorted (chk[label].list())
        if len(ref_content) != len(chk_content):
            diff.append ("- len(ref[%s]) == %i" % (label,len(ref_content)))
            diff.append ("+ len(chk[%s]) == %i" % (label,len(chk_content)))
        for r in ref_content:
            if r not in chk_content:
                diff.append ("- ref[%s] : %s" % (label, r))
        for c in chk_content:
            if c not in ref_content:
                diff.append ("+ chk[%s] : %s" % (label, c))
    if len(diff) == 0:
        return ""
 
    diff.append ("")
    map (ofile.writelines, (d for d in os.linesep.join(diff)))
    ofile.flush()
    diff = "".join(diff)
    return diff

list()

def python.KeyStore.list	(		self,
			key = None
	)

Definition at line 318 of file KeyStore.py.

    def list( self, key = None ):
        return self( key )
 

loadKeyStoreFromPoolFile()

def python.KeyStore.loadKeyStoreFromPoolFile	(		keyStore,
			pool_file,
			label = 'transient',
			items_type = 'eventdata'
	)

Helper function to create a CfgKeyStore of name `keyStore` from the
content of the POOL file `pool_file` (a python string).
The content of the POOL file will be stored into the label `label`

Definition at line 609 of file KeyStore.py.

def loadKeyStoreFromPoolFile(keyStore, pool_file,
                             label='transient',
                             items_type='eventdata'):
    """
    Helper function to create a CfgKeyStore of name `keyStore` from the
    content of the POOL file `pool_file` (a python string).
    The content of the POOL file will be stored into the label `label`
    """
    if not isinstance(keyStore, str):
        raise ValueError("argument 0 (`keyStore`) should be string")
    if not isinstance(pool_file, str):
        raise ValueError("argument 1 (`pool_file`) should be string")
    if not isinstance(label, str):
        raise ValueError("argument 2 (`label`) should be string")
    
    from PyUtils.PoolFile import extract_items
    item_list = ['%s#%s'%(name,key)
                 for name,key in extract_items(pool_file,
                                               verbose=False,
                                               items_type=items_type)
                 ]
    ks = CfgKeyStore(keyStore)
    ks_label = getattr(ks, label)
    
    ks_label.add (item_list)
 
    return ks
    

name()

def python.KeyStore.name

(

self

)

Definition at line 381 of file KeyStore.py.

    def name( self ):
        return self._name
    

read()

def python.KeyStore.read	(		self,
			fileName,
			label
	)

Definition at line 588 of file KeyStore.py.

    def read( self, fileName, label ):
        item = self[label]
        import imp, inspect
        from AthenaCommon.Include import FindFile,optionsPath
        osp = os.path
        name = osp.expanduser( osp.expandvars( fileName ) )
        name = FindFile( name, optionsPath, os.R_OK )
        if not name:
            name = FindFile( osp.basename(fileName), optionsPath, os.R_OK )
        uri = open( name, 'r' )
        mod = imp.load_source( uri.name[:-3], uri.name, uri )
        uri.close()
 
        fill = inspect.getmembers(
            mod, lambda o: inspect.isfunction(o) and (o.__name__ == '_fill')
            )[0][1]
        fill( item )
        return
    

remove()

def python.KeyStore.remove	(		self,
			items
	)

Definition at line 226 of file KeyStore.py.

    def remove( self, items ):
        if not type(items) in ( type([]), type(()) ):
            items = [ items ]
 
        self._children = [ e for e in self._children if e not in items ]
 

removeAll()

def python.KeyStore.removeAll

(

self

)

Definition at line 232 of file KeyStore.py.

    def removeAll( self ):
        self.remove( self._children )
 

removeAllItems()

def python.KeyStore.removeAllItems	(		self,
			item
	)

Definition at line 220 of file KeyStore.py.

    def removeAllItems( self, item ):
        self.removeItem( item )
        for c in self._children:
            c.removeAllItems( item )
        return
    

removeItem()

def python.KeyStore.removeItem	(		self,
			item
	)

Definition at line 209 of file KeyStore.py.

    def removeItem( self, item ):
        if not type(item) in ( type([]), type(()) ):
            items = ( item, )
        else:
            items = item
        for item in items:
            for i in self._items:
                if i == item:
                    self._items.remove( i )
        return
    

setup()

def python.KeyStore.setup

(

self

)

Definition at line 239 of file KeyStore.py.

    def setup( self ):
        msg.debug( 'setup of Output ItemList: %s', self._name )
        if msg.isEnabledFor( logging.VERBOSE ):
            msg.verbose( 'layout of sequence: %s\n%s', self._name, str(self) )
 
        for child in self.children():
            child.setup()
 

write()

def python.KeyStore.write	(		self,
			fileName,
			label
	)

Definition at line 562 of file KeyStore.py.

    def write( self, fileName, label ):
        item = self[label]
        try:
            from pprint import pprint
            from datetime import datetime
            from io import StringIO
            buf = StringIO()
            pprint( item.dict(), stream = buf )
            
            out = open( os.path.expanduser(os.path.expandvars(fileName)), 'w' )
            out.writelines( os.linesep.join( [
                "## autogenerated at [%s]" % str(datetime.now()),
                "",
                "## method filling an item-list with some data",
                "def _fill( item ):",
                "    item.add(","%s    )" % buf.getvalue(),
                "    return",
                "",
                "## EOF ##",
                ] ) )
            out.close()
        except Exception as e:
            print ("Py:Error :",e)
            raise e
        return
 

Variable Documentation

__all__

list python.KeyStore.__all__

private

Initial value:

=  [ "CfgItemList", "CfgKeyStore",
            "loadKeyStoreFromPoolFile",
            "keystore_diff" ]

Definition at line 10 of file KeyStore.py.

__author__

string python.KeyStore.__author__ = 'Sebastien Binet <binet@cern.ch>'

private

Definition at line 8 of file KeyStore.py.

__version__

string python.KeyStore.__version__ = '$Revision: 1.11 $'

private

data

Definition at line 7 of file KeyStore.py.

_allowedTriggerKeys

python.KeyStore._allowedTriggerKeys = re.compile( r"(?P<KlassName>.*?)#HLTAutoKey.*\*$" )

private

Definition at line 19 of file KeyStore.py.

_allowWildCard

python.KeyStore._allowWildCard

private

Definition at line 300 of file KeyStore.py.

_children

python.KeyStore._children

private

Definition at line 230 of file KeyStore.py.

_items

python.KeyStore._items

private

Definition at line 237 of file KeyStore.py.

msg

python.KeyStore.msg = logging.getLogger( 'CfgItemList' )

Definition at line 26 of file KeyStore.py.