python.PythonConfig.PrivateToolConfig Class Reference

Inheritance diagram for python.PythonConfig.PrivateToolConfig:

Collaboration diagram for python.PythonConfig.PrivateToolConfig:

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

Private Attributes
	_algorithm
	_prefix
	_type
	_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 303 of file PythonConfig.py.

Constructor & Destructor Documentation

__init__()

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

Constructor for an private tool configuration object

Definition at line 311 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 = {}
 
        pass
 

Member Function Documentation

__getattr__()

def 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 322 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
        """
 
        # Fail if the property was not (yet) set:
        if not name in self._props:
            raise AttributeError( 'Property "%s" was not set on "%s/%s.%s"' %
                                  ( name, self._algorithm.type(),
                                    self._algorithm.name(), self._prefix ) )
 
        # Return the property value:
        return self._props[ name ]
 

__setattr__()

def 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 342 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( PrivateToolConfig, self ).__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 )
        pass
 

__str__()

def 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 371 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 = 'Private Tool %s/%s' % ( 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 = "'%s'" % value
            else:
                printedValue = value
                pass
            result += "|- %s: %s\n" % ( key, indentBy( printedValue, "| " ) )
            pass
        result += PythonConfig._printFooter( name )
        return result
 

Member Data Documentation

_algorithm

python.PythonConfig.PrivateToolConfig._algorithm

private

Definition at line 315 of file PythonConfig.py.

_prefix

python.PythonConfig.PrivateToolConfig._prefix

private

Definition at line 316 of file PythonConfig.py.

_props

python.PythonConfig.PrivateToolConfig._props

private

Definition at line 318 of file PythonConfig.py.

_type

python.PythonConfig.PrivateToolConfig._type

private

Definition at line 317 of file PythonConfig.py.

---

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

• PythonConfig.py