python.Auditor.HephaestusAuditor Class Reference

Inheritance diagram for python.Auditor.HephaestusAuditor:

Collaboration diagram for python.Auditor.HephaestusAuditor:

Public Member Functions
def	__init__ (self, name="HephaestusAuditor", mode='leak-check', **kw)
def	initialize (self)
def	finalize (self)
def	before (self, evt_name, comp_name)
def	after (self, evt_name, comp_name, sc)
def	__getstate__ (self)
def	__setstate__ (self, dct)
virtual StatusCode	initialize () override
	Gaudi Aud Implementation. More...
virtual StatusCode	sysInitialize () override
virtual StatusCode	finalize () override
virtual const char *	typeName () const override
	return the std::type_info name of the underlying py-component This is used by concrete implementations to connect a python component to its C++ counter-part More...
virtual void	before (const std::string &evt, const std::string &name, const EventContext &ctx) override
	Auditor interface More...
virtual void	after (const std::string &evt, const std::string &name, const EventContext &ctx, const StatusCode &sc) override
virtual PyObject *	self () override
	return associated python object. More...
	DeclareInterfaceID (IPyComponent, 1, 0)

Public Attributes
	auditOn
	topSequenceName

Protected Member Functions
virtual bool	setPyAttr (PyObject *pyobj) override
	attach the C++ component to its python cousin More...

Protected Attributes
PyObject *	m_self
	Pointer to self (from the python world) More...

Private Member Functions
def	__setupMemoryTracker (self, mode, startup=True)

Private Attributes
	_evt
	_memtrack
	_start
	_stop

Detailed Description

Definition at line 13 of file Auditor.py.

Constructor & Destructor Documentation

__init__()

def python.Auditor.HephaestusAuditor.__init__	(		self,
			name = "HephaestusAuditor",
			mode = 'leak-check',
		**	kw
	)

Definition at line 14 of file Auditor.py.

    def __init__( self, name = "HephaestusAuditor", mode = 'leak-check', **kw ):
        kw[ 'name' ] = name
        super( HephaestusAuditor, self ).__init__( **kw )
 
      # event counter
        self._evt = 0
 
      # settable parameter: subselection to audit on
        try:
           self.auditOn = kw[ 'auditOn' ]
        except KeyError:
           self.auditOn = [ 'execute' ]
 
      # settable parameter: determine event boundaries on the master sequence
        try:
           self.topSequenceName = kw[ 'topSequenceName' ]
        except KeyError:
           self.topSequenceName = 'AthMasterSeq'
 
        self.__setupMemoryTracker( mode, True )
 

Member Function Documentation

__getstate__()

def python.Auditor.HephaestusAuditor.__getstate__

(

self

)

Definition at line 92 of file Auditor.py.

    def __getstate__( self ):
      # determine mode used
        mode = 'leak-check'
        if self._memtrack.start != self._start:
           mode = 'delete-check'
 
      # the base class will try to pickle all parts of the dict indiscriminately ...
        mtmod = self._memtrack
        del self._memtrack
        dct = super( HephaestusAuditor, self ).__getstate__()
 
      # but need to be kept alive if the job does not end on the pickle (resetting
      # in __setupMemoryTracker is fine, since it is cached in sys.modules)
        self._memtrack = mtmod
 
      # store mode used
        dct[ 'mode' ] = mode
 
      # store the module-level variables, as they may have been modified
        dct[ 'GlobalSettings' ] = GlobalSettings
 
      # store the pid of the current process: if we get re-loaded into the same
      # process, then no restart should be done (this isn't foolproof, but there
      # is no current way of checking otherwise)
        import os
        dct[ 'pid' ] = os.getpid()
 
        return dct
 

__setstate__()

def python.Auditor.HephaestusAuditor.__setstate__	(		self,
			dct
	)

Definition at line 121 of file Auditor.py.

    def __setstate__( self, dct ):
        super( HephaestusAuditor, self ).__setstate__( dct )
 
      # copy the values instead of resetting the reference, in case it has
      # been imported somewhere
        global GlobalSettings
        for k,v in dct[ 'GlobalSettings' ].items():
            GlobalSettings[ k ] = v
 
        import os
        self.__setupMemoryTracker( dct[ 'mode' ], dct[ 'pid' ] != os.getpid() )
 
      # the following is a guess; similar problem really as start(), really
        if dct[ 'pid' ] == os.getpid():
            self._evt = dct[ '_evt' ]
        else:
            self._evt = 0

__setupMemoryTracker()

def python.Auditor.HephaestusAuditor.__setupMemoryTracker (   self,   mode,   startup = True  )

private

Definition at line 35 of file Auditor.py.

    def __setupMemoryTracker( self, mode, startup = True ):
      # get going immediately, so that this is the first memory hook
        import MemoryTracker
        self._memtrack = MemoryTracker
 
        if mode == 'leak-check':
            self._start = self._memtrack.start
            self._stop  = self._memtrack.stop
 
            if startup or 'full' in self.auditOn:
                self._memtrack.save()
                self._memtrack.install()
 
        elif mode == 'delete-check':
            import DeleteChecker
            self._start = DeleteChecker.start
            self._stop  = DeleteChecker.stop
 
        else:
            raise RuntimeError( 'unknown mode: %s (expected leak-check or delete-check)' % mode )
 
      # for full, just get going and never look back
        if 'full' in self.auditOn:
            self._start()
 

after() [1/2]

void PyAthena::Aud::after ( const std::string &  evt, const std::string &  name, const EventContext &  ctx, const StatusCode &  sc  )

overridevirtualinherited

Definition at line 117 of file PyAthenaAud.cxx.

{
  std::string evtname = evt;
  std::transform(evt.begin(), evt.end(), evtname.begin(), ::tolower);
  PyAthena::pyAudit (m_self, "after", evtname.c_str(), name.c_str(), sc);
}

after() [2/2]

def python.Auditor.HephaestusAuditor.after	(		self,
			evt_name,
			comp_name,
			sc
	)

Definition at line 86 of file Auditor.py.

    def after( self, evt_name, comp_name, sc ):
        if not self.auditOn or evt_name.lower() in self.auditOn:
            self._stop()
        return
 

before() [1/2]

void PyAthena::Aud::before ( const std::string &  evt, const std::string &  name, const EventContext &  ctx  )

overridevirtualinherited

Auditor interface

Definition at line 108 of file PyAthenaAud.cxx.

{
  std::string evtname = evt;
  std::transform(evt.begin(), evt.end(), evtname.begin(), ::tolower);
  PyAthena::pyAudit (m_self, "before", evtname.c_str(), name.c_str());
}

before() [2/2]

def python.Auditor.HephaestusAuditor.before	(		self,
			evt_name,
			comp_name
	)

Definition at line 76 of file Auditor.py.

    def before( self, evt_name, comp_name ):
        if not self.auditOn or evt_name.lower() in self.auditOn:
            if (self._memtrack.configure() & self._memtrack.PROFILE):
                if GlobalSettings[ 'event-based' ] and evt_name.lower() == 'execute'\
                       and comp_name == self.topSequenceName:
                    self._evt += 1
                    self._memtrack._profname( GlobalSettings[ 'label' ] + '_execute.%d' % self._evt )
            self._start()
        return
 

DeclareInterfaceID()

IPyComponent::DeclareInterfaceID ( IPyComponent  , 1  , 0    )

inherited

finalize() [1/2]

StatusCode PyAthena::Aud::finalize ( )

overridevirtualinherited

Definition at line 87 of file PyAthenaAud.cxx.

{
  return PyAthena::callPyMethod( m_self, "sysFinalize" );
}

finalize() [2/2]

def python.Auditor.HephaestusAuditor.finalize

(

self

)

Definition at line 70 of file Auditor.py.

    def finalize( self ):
        if 'full-athena' in self.auditOn:
            self._stop()
 
        return PyAthena.StatusCode.Success
 

initialize() [1/2]

StatusCode PyAthena::Aud::initialize ( )

overridevirtualinherited

Gaudi Aud Implementation.

Definition at line 61 of file PyAthenaAud.cxx.

{
  return PyAthena::callPyMethod( m_self, "sysInitialize" );
}

initialize() [2/2]

def python.Auditor.HephaestusAuditor.initialize

(

self

)

Definition at line 60 of file Auditor.py.

    def initialize( self ):
        if 'full-athena' in self.auditOn:
            self._start()
 
        if (self._memtrack.configure() & self._memtrack.PROFILE):
            if not GlobalSettings[ 'event-based' ]:
                self._memtrack._profname( GlobalSettings[ 'label' ] )
 
        return PyAthena.StatusCode.Success
 

self()

virtual PyObject* PyAthena::Aud::self ( )

inlineoverridevirtualinherited

return associated python object.

BORROWED reference.

Implements IPyComponent.

Definition at line 68 of file PyAthenaAud.h.

{ return m_self; }

setPyAttr()

bool PyAthena::Aud::setPyAttr ( PyObject *  pyobj )

overrideprotectedvirtualinherited

attach the C++ component to its python cousin

Implements IPyComponent.

Definition at line 130 of file PyAthenaAud.cxx.

{
  // now we tell the PyObject which C++ object it is the cousin of.
  RootUtils::PyGILStateEnsure ensure;
  PyObject* pyobj = TPython::CPPInstance_FromVoidPtr
    ( (void*)this, this->typeName() );
  if ( !pyobj ) {
    PyErr_Clear();
    // try PyAthena::Aud
    pyobj = TPython::CPPInstance_FromVoidPtr ((void*)this, "PyAthena::Aud");
    MsgStream msg( msgSvc(), name() );
    msg << MSG::INFO
        << "could not dyncast component [" << name() << "] to a python "
        << "object of type [" << this->typeName() << "] (probably a missing "
        << "dictionary)" << endmsg
        << "fallback to [PyAthena::Aud]..."
        << endmsg;
  }
  if ( !pyobj ) {
    PyErr_Clear();
    MsgStream msg( msgSvc(), name() );
    msg << MSG::WARNING << "Could not dyncast component ["
        << name() << "] to a pyobject of type [" 
        << this->typeName() << "]"
        << endmsg;
  } else {
    if ( -1 == PyObject_SetAttrString(o, "_cppHandle", pyobj) ) {
      PyErr_Clear();
      MsgStream msg( msgSvc(), name() );
      msg << MSG::WARNING 
          << "Could not attach C++ handle [" << name() << "] to its python "
          << "cousin !"
          << endmsg;
      if ( -1 == PyObject_SetAttrString(o, "_cppHandle", Py_None) ) {
        PyErr_Clear();
        msg << MSG::WARNING
            << "could not attach a dummy C++ handle [" << name() << "] to its "
            << "python cousin !"
            << endmsg;
      }
    } else {
      return true;
    }
  }
  return false;
}

sysInitialize()

StatusCode PyAthena::Aud::sysInitialize ( )

overridevirtualinherited

Definition at line 67 of file PyAthenaAud.cxx.

{
  ServiceHandle<IPyComponentMgr> pyMgr
    ( "PyAthena::PyComponentMgr/PyComponentMgr", name() );
  if ( !pyMgr.retrieve().isSuccess() ) {
    return StatusCode::FAILURE;
  }
 
  // first retrieve our python object cousin...
  m_self = pyMgr->pyObject( this );
 
  if ( m_self == Py_None ) {
    return StatusCode::FAILURE;
  }
 
  // re-route to usual sysInit...
  return Gaudi::Auditor::sysInitialize();
}

typeName()

const char * PyAthena::Aud::typeName ( ) const

overridevirtualinherited

return the std::type_info name of the underlying py-component This is used by concrete implementations to connect a python component to its C++ counter-part

Implements IPyComponent.

Definition at line 97 of file PyAthenaAud.cxx.

{ 
  static const std::string tname = System::typeinfoName(typeid(*this));
  return tname.c_str();
}

Member Data Documentation

_evt

python.Auditor.HephaestusAuditor._evt

private

Definition at line 19 of file Auditor.py.

_memtrack

python.Auditor.HephaestusAuditor._memtrack

private

Definition at line 38 of file Auditor.py.

_start

python.Auditor.HephaestusAuditor._start

private

Definition at line 41 of file Auditor.py.

_stop

python.Auditor.HephaestusAuditor._stop

private

Definition at line 42 of file Auditor.py.

auditOn

python.Auditor.HephaestusAuditor.auditOn

Definition at line 23 of file Auditor.py.

m_self

PyObject* PyAthena::Aud::m_self

protectedinherited

Pointer to self (from the python world)

Definition at line 90 of file PyAthenaAud.h.

topSequenceName

python.Auditor.HephaestusAuditor.topSequenceName

Definition at line 29 of file Auditor.py.

---

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

• Auditor.py