python.AsgServiceConfig.PrivateToolConfig Class Reference

Inheritance diagram for python.AsgServiceConfig.PrivateToolConfig:

Collaboration diagram for python.AsgServiceConfig.PrivateToolConfig:

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

Private Attributes
	_service
	_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 services in a way that's valid for both Athena and EventLoop.

Definition at line 261 of file AsgServiceConfig.py.

Constructor & Destructor Documentation

__init__()

def python.AsgServiceConfig.PrivateToolConfig.__init__	(		self,
			service,
			prefix,
			type
	)

Constructor for an private tool configuration object

Definition at line 269 of file AsgServiceConfig.py.

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

Member Function Documentation

__getattr__()

def python.AsgServiceConfig.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 service'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 280 of file AsgServiceConfig.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 service'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._service.type(),
                                    self._service.name(), self._prefix ) )
 
        # Return the property value:
        return self._props[ name ]
 

__setattr__()

def python.AsgServiceConfig.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 service configuration object. Allowing for the following syntax:

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

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

Definition at line 300 of file AsgServiceConfig.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 service configuration object. Allowing for the following syntax:
 
           service = ...
           service.Tool.IntProperty = 66
           service.Tool.FloatProperty = 3.141592
           service.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._service.setPropertyFromString( fullName,
                                               stringPropValue( value ) )
        self._props[ key ] = copy.deepcopy( value )
        pass
 

__str__()

def python.AsgServiceConfig.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 329 of file AsgServiceConfig.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 += AsgServiceConfig._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 += AsgServiceConfig._printFooter( name )
        return result
 

Member Data Documentation

_prefix

python.AsgServiceConfig.PrivateToolConfig._prefix

private

Definition at line 274 of file AsgServiceConfig.py.

_props

python.AsgServiceConfig.PrivateToolConfig._props

private

Definition at line 276 of file AsgServiceConfig.py.

_service

python.AsgServiceConfig.PrivateToolConfig._service

private

Definition at line 273 of file AsgServiceConfig.py.

_type

python.AsgServiceConfig.PrivateToolConfig._type

private

Definition at line 275 of file AsgServiceConfig.py.

---

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

• AsgServiceConfig.py