python.AthConfigFlags.CfgFlag Class Reference

Inheritance diagram for python.AthConfigFlags.CfgFlag:

Collaboration diagram for python.AthConfigFlags.CfgFlag:

Public Member Functions
	__init__ (self, default, type=None, help=None)
	set (self, value)
	get (self, flagdict=None)
	__repr__ (self)

Protected Member Functions
	_validateType (self, value)

Protected Attributes
	_type = type
	_help = help
	_value = None
	_setDef = value

Static Protected Attributes
dict	_compatibleTypes

Static Private Attributes
list	__slots__ = ['_value', '_setDef', '_type', '_help']

Detailed Description

The base flag object.

A flag can be set to either a fixed value or a callable, which computes
the value based on other flags.

Definition at line 22 of file AthConfigFlags.py.

Constructor & Destructor Documentation

__init__()

python.AthConfigFlags.CfgFlag.__init__	(		self,
			default,
			type = None,
			help = None )

Initialise the flag with the default value.

Optionally set the type of the flag value and the help string.

Definition at line 35 of file AthConfigFlags.py.

    def __init__(self, default, type=None, help=None):
        """Initialise the flag with the default value.
 
        Optionally set the type of the flag value and the help string.
        """
        if default is None:
            raise ValueError("Default value of a flag must not be None")
        self._type = type
        self._help = help
        self.set(default)
        return
 

Member Function Documentation

__repr__()

python.AthConfigFlags.CfgFlag.__repr__

(

self

)

Definition at line 92 of file AthConfigFlags.py.

    def __repr__(self):
        if self._value is not None:
            return repr(self._value)
        else:
            return "[function]"
 

_validateType()

python.AthConfigFlags.CfgFlag._validateType ( self, value )

protected

Definition at line 98 of file AthConfigFlags.py.

    def _validateType(self, value):
        if (self._type is None or value is None or
            isinstance(value, self._type) or
            (type(value), self._type) in self._compatibleTypes):
            return
        # Type mismatch
        raise TypeError(f"Flag is of type '{self._type.__name__}', "
                        f"but value '{value}' of type '{type(value).__name__}' set.")
 
 

get()

python.AthConfigFlags.CfgFlag.get	(		self,
			flagdict = None )

Get the value of the flag.

If the currently set value is a callable, a dictionary of all available
flags needs to be provided.

Definition at line 61 of file AthConfigFlags.py.

    def get(self, flagdict=None):
        """Get the value of the flag.
 
        If the currently set value is a callable, a dictionary of all available
        flags needs to be provided.
        """
 
        if self._value is not None:
            return deepcopy(self._value)
 
        # For cases where the value is intended to be None
        # i.e. _setDef applied this value, we should not progress
        if self._setDef is None:
            return None
 
        if not flagdict:
            raise RuntimeError("Flag is using a callable but all flags are not available.")
 
        # Have to call the method to obtain the default value, and then reuse it in all next accesses
        if flagdict.locked():
            # optimise future reads, drop possibility to update this flag ever
            self._value = self._setDef(flagdict)
            self._setDef = None
            value = self._value
        else:
            # use function for as long as the flags are not locked
            value = self._setDef(flagdict)
 
        self._validateType(value)
        return deepcopy(value)
 

set()

python.AthConfigFlags.CfgFlag.set	(		self,
			value )

Set the value of the flag.

Can be a constant value or a callable.

Definition at line 47 of file AthConfigFlags.py.

    def set(self, value):
        """Set the value of the flag.
 
        Can be a constant value or a callable.
        """
        if callable(value):
            self._value=None
            self._setDef=value
        else:
            self._value=value
            self._setDef=None
            self._validateType(self._value)
        return
 

Member Data Documentation

__slots__

list python.AthConfigFlags.CfgFlag.__slots__ = ['_value', '_setDef', '_type', '_help']

staticprivate

Definition at line 29 of file AthConfigFlags.py.

_compatibleTypes

python.AthConfigFlags.CfgFlag._compatibleTypes

staticprotected

Initial value:

=  {
        (int, float),   # int can be assigned to float flag
    }

Definition at line 31 of file AthConfigFlags.py.

_help

python.AthConfigFlags.CfgFlag._help = help

protected

Definition at line 43 of file AthConfigFlags.py.

_setDef

python.AthConfigFlags.CfgFlag._setDef = value

protected

Definition at line 54 of file AthConfigFlags.py.

_type

python.AthConfigFlags.CfgFlag._type = type

protected

Definition at line 42 of file AthConfigFlags.py.

_value

python.AthConfigFlags.CfgFlag._value = None

protected

Definition at line 53 of file AthConfigFlags.py.

---

The documentation for this class was generated from the following file:

• AthConfigFlags.py