Configurable Namespace Reference

Classes
class	Error
class	PropertyReference
	Allow references to options as in old style. More...
class	Configurable
class	DummyDescriptor
	if isinstance(v,Configurable) and not v.isPublic(): rep += v.__str__( indent + 1 ) + os.linesep elif isinstance(v,GaudiHandleArray): for vi in v: if isinstance(vi,Configurable) and not vi.isPublic(): rep += vi.__str__( indent + 1 ) + os.linesep More...
class	ConfigurableGeneric
class	ConfigurableAlgorithm
class	ConfigurableService
class	ConfigurableAlgTool
class	ConfigurableAuditor
class	ConfigurableUser
Functions
def	expandvars
def	appendPostConfigAction
def	removePostConfigAction
def	applyConfigurableUsers
def	getNeededConfigurables
def	purge
Variables
list	__all__
	data ---------------------------------------------------------------------
tuple	log = logging.getLogger( 'Configurable' )
list	postConfigActions = []
	_appliedConfigurableUsers_ = False

---

Function Documentation

def Configurable::appendPostConfigAction

(

function )

Add a new callable ('function') to the list of post-configuration actions.
If the callable is already in the list, it is moved to the end of the list.
The list is directly accessible as 'GaudiKernel.Configurable.postConfigActions'.

Definition at line 1309 of file Configurable.py.

01310                                     :
01311     """
01312     Add a new callable ('function') to the list of post-configuration actions.
01313     If the callable is already in the list, it is moved to the end of the list.
01314     The list is directly accessible as 'GaudiKernel.Configurable.postConfigActions'.
01315     """
01316     try:
01317         postConfigActions.remove(function)
01318     except:
01319         pass
    postConfigActions.append(function)

def Configurable::applyConfigurableUsers

(

)

Call the apply method of all the ConfigurableUser instances respecting the
dependencies. First the C.U.s that are not used by anybody, then the used
ones, when they are not used anymore.

Definition at line 1328 of file Configurable.py.

                            :
    """
    Call the apply method of all the ConfigurableUser instances respecting the
    dependencies. First the C.U.s that are not used by anybody, then the used
    ones, when they are not used anymore.
    """
    # Avoid double calls
    global _appliedConfigurableUsers_, postConfigActions
    if _appliedConfigurableUsers_:
        return
    _appliedConfigurableUsers_ = True

    confUsers = [ c
                  for c in Configurable.allConfigurables.values()
                  if hasattr(c,"__apply_configuration__") ]
    applied = True # needed to detect dependency loops
    while applied and confUsers:
        newConfUsers = [] # list of conf users that cannot be applied yet
        applied = False
        for c in confUsers:
            if hasattr(c,"__users__") and c.__users__:
                newConfUsers.append(c) # cannot use this one yet
            else: # it does not have users or the list is empty
                applied = True
                # the ConfigurableUser is enabled if it doesn't have an _enabled
                # property or its value is True
                enabled = (not hasattr(c, "_enabled")) or c._enabled
                if enabled:
                    log.info("applying configuration of %s", c.name())
                    c.__apply_configuration__()
                    log.info(c)
                else:
                    log.info("skipping configuration of %s", c.name())
                if hasattr(c, "__detach_used__"):
                    # tells the used configurables that they are not needed anymore
                    c.__detach_used__()
        confUsers = newConfUsers # list of C.U.s still to go
    if confUsers:
        # this means that some C.U.s could not be applied because of a dependency loop
        raise Error("Detected loop in the ConfigurableUser "
                    " dependencies: %r" % [ c.name()
                                            for c in confUsers ])
    # Call post-config actions
    for action in postConfigActions:
        action()

def Configurable::expandvars

(

data )

Expand environment variables "data".
Data can be string, list, tuple and dictionary. For collection, all the
contained strings will be manipulated (recursively).

Definition at line 27 of file Configurable.py.

                    :
    """
    Expand environment variables "data".
    Data can be string, list, tuple and dictionary. For collection, all the
    contained strings will be manipulated (recursively).
    """
    import os.path
    typ = type(data)
    if typ is str:
        return os.path.expandvars(data)
    elif typ in [list, tuple]:
        collect = []
        for i in data:
            collect.append(expandvars(i))
        return typ(collect)
    elif typ is dict:
        collect = {}
        for k in data:
            collect[expandvars(k)] = expandvars(data[k])
        return collect
    return data

def Configurable::getNeededConfigurables

(

)

Function to select all and only the configurables that have to be used in
GaudiPython.AppMgr constructor.
This is needed because in Athena the implementation have to be different (the
configuration is used in a different moment).

Definition at line 1374 of file Configurable.py.

                            :
    """
    Function to select all and only the configurables that have to be used in
    GaudiPython.AppMgr constructor.
    This is needed because in Athena the implementation have to be different (the
    configuration is used in a different moment).
    """
    return [ k
             for k, v in Configurable.allConfigurables.items()
             if v.getGaudiType() != "User" ] # Exclude ConfigurableUser instances

def Configurable::purge

(

)

Clean up all configurations and configurables.

Definition at line 1385 of file Configurable.py.

           :
    """
    Clean up all configurations and configurables.
    """
    for c in Configurable.allConfigurables.values():
        c.__class__.configurables.clear()
    Configurable.allConfigurables.clear()
    # FIXME: (MCl) this is needed because instances of ConfigurableGeneric are not
    #        migrated to the correct class when this is known.
    ConfigurableGeneric.configurables.clear()
    from ProcessJobOptions import _included_files
    import os.path, sys
    for file in _included_files:
        dirname, basname = os.path.split(file)
        basname, ext = os.path.splitext(basname)
        if basname in sys.modules:
            del sys.modules[basname]
    _included_files.clear()

def Configurable::removePostConfigAction

(

function )

Remove a collable from the list of post-config actions.
The list is directly accessible as 'GaudiKernel.Configurable.postConfigActions'.

Definition at line 1320 of file Configurable.py.

                                    :
    """
    Remove a collable from the list of post-config actions.
    The list is directly accessible as 'GaudiKernel.Configurable.postConfigActions'.
    """
    postConfigActions.remove(function)

---

Variable Documentation

list Configurable::__all__

Initial value:

[ 'Configurable',
            'ConfigurableAlgorithm',
            'ConfigurableAlgTool',
            'ConfigurableAuditor',
            'ConfigurableService',
            'ConfigurableUser',
            'VERBOSE','DEBUG','INFO', 'WARNING', 'ERROR', 'FATAL',
            'appendPostConfigAction', 'removePostConfigAction' ]

data ---------------------------------------------------------------------

Definition at line 14 of file Configurable.py.

Configurable::_appliedConfigurableUsers_ = False

Definition at line 1327 of file Configurable.py.

tuple Configurable::log = logging.getLogger( 'Configurable' )

Definition at line 25 of file Configurable.py.

list Configurable::postConfigActions = []

Definition at line 1308 of file Configurable.py.