GaudiConfig2._configurables Namespace Reference

Classes
class	Configurable
class	ConfigurableMeta
class	Property

Functions
def	useGlobalInstances (enable)
def	opt_repr (value)
def	makeConfigurableClass (name, **namespace)
def	all_options (explicit_defaults=False)

Variables
	_GLOBAL_INSTANCES
	(c) Copyright 1998-2023 CERN for the benefit of the LHCb and ATLAS collaborations # # This software is distributed under the terms of the Apache version 2 licence, # copied verbatim in the file "LICENSE". More...

Function Documentation

all_options()

def GaudiConfig2._configurables.all_options

(

explicit_defaults = False

)

Return a dictionary with all explicitly set options, or with also the
defaults if explicit_defaults is set to True.

Definition at line 311 of file _configurables.py.

def all_options(explicit_defaults=False):
    """
    Return a dictionary with all explicitly set options, or with also the
    defaults if explicit_defaults is set to True.
    """
    opts = {}
    for c in Configurable.instances.values():
        opts.update(c.__opt_properties__(explicit_defaults))
    return opts

makeConfigurableClass()

def GaudiConfig2._configurables.makeConfigurableClass	(		name,
		**	namespace
	)

Create a Configurable specialization.

Definition at line 301 of file _configurables.py.

def makeConfigurableClass(name, **namespace):
    """
    Create a Configurable specialization.
    """
    properties = namespace.pop("properties", {})
    namespace.update({pname: Property(*pargs) for pname, pargs in properties.items()})
 
    return type(name, (Configurable,), namespace)
 
 

opt_repr()

def GaudiConfig2._configurables.opt_repr

(

value

)

String representation of the value, such that it can be consumed be the
Gaudi option parsers.

Definition at line 116 of file _configurables.py.

def opt_repr(value):
    """
    String representation of the value, such that it can be consumed be the
    Gaudi option parsers.
    """
    if hasattr(value, "__opt_repr__"):
        return value.__opt_repr__()
    elif isinstance(value, str):
        return '"{}"'.format(value.replace('"', '\\"'))
    return repr(value)
 
 

useGlobalInstances()

def GaudiConfig2._configurables.useGlobalInstances

(

enable

)

Enable or disable the global instances database.

By default global instances are enabled.

Definition at line 15 of file _configurables.py.

def useGlobalInstances(enable):
    """
    Enable or disable the global instances database.
 
    By default global instances are enabled.
    """
    global _GLOBAL_INSTANCES
    if enable == _GLOBAL_INSTANCES:
        return
    if not enable:
        assert (
            not Configurable.instances
        ), "Configurable instances DB not empty, cannot be disabled"
    _GLOBAL_INSTANCES = enable
 
 

Variable Documentation

_GLOBAL_INSTANCES

GaudiConfig2._configurables._GLOBAL_INSTANCES

private

(c) Copyright 1998-2023 CERN for the benefit of the LHCb and ATLAS collaborations # # This software is distributed under the terms of the Apache version 2 licence, # copied verbatim in the file "LICENSE".

# # In applying this licence, CERN does not waive the privileges and immunities # granted to it by virtue of its status as an Intergovernmental Organization # or submit itself to any jurisdiction. #

Classes and functions for handling Configurables

Definition at line 12 of file _configurables.py.