python.PythonConfig.PrivateToolConfig Class Reference

Collaboration diagram for python.PythonConfig.PrivateToolConfig:

Public Member Functions
	__init__ (self, algorithm, prefix, type)
	__getattr__ (self, name)
	__setattr__ (self, key, value)
	__str__ (self)

Protected Attributes
	_algorithm = algorithm
	_prefix = prefix
	_type = type
dict	_props = {}

Detailed Description

Standalone Private Tool Configuration

This class is used to mimic the behaviour of Athena tool configurable
classes. To be able to set the properties of private tools used by
dual-use algorithms in a way that's valid for both Athena and EventLoop.

Definition at line 284 of file PythonConfig.py.

Constructor & Destructor Documentation

__init__()

python.PythonConfig.PrivateToolConfig.__init__	(		self,
			algorithm,
			prefix,
			type )

Constructor for an private tool configuration object

Definition at line 292 of file PythonConfig.py.

    def __init__( self, algorithm, prefix, type ):
        """Constructor for an private tool configuration object
        """
 
        self._algorithm = algorithm
        self._prefix = prefix
        self._type = type
        self._props = {}
 

Member Function Documentation

__getattr__()

python.PythonConfig.PrivateToolConfig.__getattr__	(		self,
			name )

Get a previously set property value from the configuration

This function allows us to retrieve the value of a tool property that
was already set for an algorithm's private tool, to possibly use it in
some configuration decisions in the Python code itself.

Keyword arguments:
  name -- The name of the property

Definition at line 301 of file PythonConfig.py.

    def __getattr__( self, name ):
        """Get a previously set property value from the configuration
 
        This function allows us to retrieve the value of a tool property that
        was already set for an algorithm's private tool, to possibly use it in
        some configuration decisions in the Python code itself.
 
        Keyword arguments:
          name -- The name of the property
        """
 
        # Short-circuit internal/dunder attribute lookups, which are never
        # properties (and would otherwise recurse if '_props' is missing):
        if name.startswith( '_' ):
            raise AttributeError( name )
 
        # Fail if the property was not (yet) set:
        if name not in self._props:
            raise AttributeError(
                f'Property "{name}" was not set on '
                f'"{self._algorithm.type()}/{self._algorithm.name()}.{self._prefix}"' )
 
        # Return the property value:
        return self._props[ name ]
 

__setattr__()

python.PythonConfig.PrivateToolConfig.__setattr__	(		self,
			key,
			value )

Set a tool property on an existing configuration object

This function allows us to set/override properties on a private tool
of an algorithm configuration object. Allowing for the following syntax:

   alg = ...
   alg.Tool.IntProperty = 66
   alg.Tool.FloatProperty = 3.141592
   alg.Tool.StringProperty = "Foo"

Keyword arguments:
  key   -- The key/name of the property
  value -- The value to set for the property

Definition at line 326 of file PythonConfig.py.

    def __setattr__( self, key, value ):
        """Set a tool property on an existing configuration object
 
        This function allows us to set/override properties on a private tool
        of an algorithm configuration object. Allowing for the following syntax:
 
           alg = ...
           alg.Tool.IntProperty = 66
           alg.Tool.FloatProperty = 3.141592
           alg.Tool.StringProperty = "Foo"
 
        Keyword arguments:
          key   -- The key/name of the property
          value -- The value to set for the property
        """
 
        # Private variables should be set directly:
        if key[ 0 ] == '_':
            return super().__setattr__( key, value )
 
        # Construct the full name, used in the C++ code:
        fullName = self._prefix + "." + key
 
        # Set the property, and remember its value:
        self._algorithm.setPropertyFromString( fullName,
                                               stringPropValue( value ) )
        self._props[ key ] = copy.deepcopy( value )
 

__str__()

python.PythonConfig.PrivateToolConfig.__str__

(

self

)

Print the private tool configuration in a user friendly way

This is just to help with debugging configurations, allowing
the user to get a nice printout of their job configuration.

Definition at line 354 of file PythonConfig.py.

    def __str__( self ):
        """Print the private tool configuration in a user friendly way
 
        This is just to help with debugging configurations, allowing
        the user to get a nice printout of their job configuration.
        """
 
        name = f'Private Tool {self._type}/{self._prefix}'
        result = ' \n'
        result += PythonConfig._printHeader( name )
        result += '\n'
        for key, value in sorted( self._props.items() ):
            if isinstance( value, str ):
                printedValue = f"'{value}'"
            else:
                printedValue = value
            result += f"|- {key}: {indentBy( printedValue, '| ' )}\n"
        result += PythonConfig._printFooter( name )
        return result
 
 

Member Data Documentation

_algorithm

python.PythonConfig.PrivateToolConfig._algorithm = algorithm

protected

Definition at line 296 of file PythonConfig.py.

_prefix

python.PythonConfig.PrivateToolConfig._prefix = prefix

protected

Definition at line 297 of file PythonConfig.py.

_props

dict python.PythonConfig.PrivateToolConfig._props = {}

protected

Definition at line 299 of file PythonConfig.py.

_type

python.PythonConfig.PrivateToolConfig._type = type

protected

Definition at line 298 of file PythonConfig.py.

---

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

• PythonConfig.py