Inheritance diagram for python.PyComps.PySgDumper:

Collaboration diagram for python.PyComps.PySgDumper:

Public Member Functions
	__init__ (self, name='PySgDumper', **kw)
	initialize (self)
	execute (self)
	finalize (self)
virtual StatusCode	reinitialize () override
virtual StatusCode	start () override
virtual StatusCode	stop () override
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
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
virtual PyObject *	self () override
	return associated python object.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Public Attributes
	items = kw.get('items', '*')
	properties and data members
	exclude = kw.get('exclude', '')
str	ofile = kw.get('ofile', '')
	sg = None
	handle to event store
	failed_dumps = set()
	list of objects and/or classes for which the dump failed ( (key, clid-or-class, 'reason'), ... )
	clidsvc = PyAthena.py_svc ('ClassIDSvc')

Protected Member Functions
virtual bool	setPyAttr (PyObject *pyobj) override
	attach the C++ component to its python cousin
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
	_dumper_fct = get_dumper_fct
int	_evt_nbr = 0
PyObject *	m_self
	Pointer to self (from the python world)

Static Protected Attributes
tuple	_ignore_clids

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 224 of file Event/PyDumper/python/PyComps.py.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ init()

python.PyComps.PySgDumper.__init__	(		self,
			name = 'PySgDumper',
		**	kw )

Definition at line 231 of file Event/PyDumper/python/PyComps.py.

    def __init__(self, name='PySgDumper', **kw):
        
        kw['name'] = name
        super(PySgDumper, self).__init__(**kw)
 
        self.items = kw.get('items', '*')
        self.exclude = kw.get('exclude', '')
        self.ofile = kw.get('ofile', '')
 
        self.sg = None
 
        self.failed_dumps = set()
        return

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

python.PyComps.PySgDumper.execute ( self )

Definition at line 295 of file Event/PyDumper/python/PyComps.py.

    def execute(self):
        _debug= self.msg.debug
        _info = self.msg.info
        _warn = self.msg.warning
        _add_fail = self.failed_dumps.add
        _info('==> processing event [%s]...', self._evt_nbr)
        self.ofile.writelines (['%s\n'%('='*40),
                                '==> evt nbr [%s]\n' % self._evt_nbr])
        self._evt_nbr += 1
 
        if self.items is None:
            elist = self.exclude.split(',')
            proxies = self.sg.proxies()
            sg = dict()
            _typename = self.clidsvc.typename
            for p in proxies:
                clid = p.clID()
                if clid in self._ignore_clids:
                    continue
                n  = str(p.name())
                tp = _typename(clid)
                if n == 'Input': continue
                if n.endswith('Aux.'): continue
                if n.endswith('_DELETED'): continue
                if not p.isValid(): continue
                excluded = False
                for exc in elist:
                    if fnmatch (n, exc) or (tp and fnmatch(tp, exc)):
                        excluded = True
                        break
                if excluded:
                    continue
                if tp:
                    sg[n] = tp
                else:
                    self.msg.warning ('no typename for key=[%s], clid=[%i]',
                                      n, clid)
                    _add_fail ((n,clid,'no typename from clid'))
                    
            items = [(i[1], i[0]) for i in sg.items() if i[1] != "EventInfo"]
            items.sort()
            evt_info = [(clid, key) for key,clid in sg.items() if clid=="EventInfo"]
            if len(evt_info)==1:
                items.insert (0, evt_info[0])
        else:
            items = self.items
            
        _retrieve = self.sg.retrieve
        _get = self.sg.__getitem__
        for cont_type, cont_key in items:
            _debug ('dumping object [%s#%s]', cont_type, cont_key)
            try:
                if cont_type is None:
                    o = _get (cont_key)
                else:
                    o = _retrieve (cont_type, cont_key)
                if o is None:
                    _add_fail ((cont_key, cont_type, 'retrieve failed'))
                    if self._evt_nbr==1:
                        _warn ('could not retrieve object [%s#%s]',
                               cont_type, cont_key)
                    continue
                try:
                    dumper = self._dumper_fct (klass=o.__class__,
                                               ofile=self.ofile)
                except RuntimeError as err:
                    _add_fail ((cont_key, cont_type, 'dump failed ' + str(err)))
                    if self._evt_nbr==1:
                        _warn (err)
                    continue
                self.ofile.writelines (
                    ['%s%s[%s/%s]%s\n'%(
                        os.linesep,
                        '-'*10,
                        o.__class__.__name__,
                        cont_key,
                        '-'*10)
                     ]
                    )
                self.ofile.flush()
                dumper (o)
                self.ofile.flush()
            except Exception as err:
                traceback.print_exc()
                _add_fail ((cont_key, cont_type, 'sg-retrieve failed'))
                if self._evt_nbr==1:
                    _warn ('caught exception:\n%s', err)
                    _warn ('could not retrieve object [%s#%s]',
                           cont_type, cont_key)
                continue
        return StatusCode.Success
            
 

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ finalize()

python.PyComps.PySgDumper.finalize ( self )

Definition at line 388 of file Event/PyDumper/python/PyComps.py.

    def finalize(self):
        self.msg.info ('==> finalize...')
        self.msg.info ('processed [%s] events', self._evt_nbr)
        
        self.ofile.flush()
        if hasattr(self.ofile,'name'):
            o_name = self.ofile.name
        else:
            o_name = '<unnamed file>'
        import sys
        if not (self.ofile is sys.stdout) and \
           not (self.ofile is sys.stderr) and \
           not (o_name in ['/dev/stdout', '/dev/stderr',]):
            self.ofile.close()
 
        _info = self.msg.info
        if len(self.failed_dumps)>0:
            _info ("the following objects could not be dumped:")
            from collections import defaultdict
            reasons = defaultdict(list)
            for name,klass,reason in self.failed_dumps:
                reasons[reason].append ((name,klass))
            for reason in reasons.keys():
                _info (' ==> [%s]', reason)
                for name,klass in reasons[reason]:
                    _info ("     [%s#%s]", klass, name)
        return StatusCode.Success
 

◆ initialize()

python.PyComps.PySgDumper.initialize ( self )

Definition at line 249 of file Event/PyDumper/python/PyComps.py.

    def initialize(self):
        self.msg.info('==> initialize...')
        self.sg = PyAthena.py_svc('StoreGateSvc')
        if not self.sg:
            self.msg.error('could not retrieve StoreGateSvc')
            return StatusCode.Failure
 
        self.clidsvc = PyAthena.py_svc ('ClassIDSvc')
        if not self.clidsvc:
            self.msg.error ('could not retrieve ClassIDSvc')
            return StatusCode.Failure
 
        try:
            self.items = _decode_item_list(self.items, self.msg)
        except Exception as err:
            self.msg.error(err)
            return StatusCode.Failure
            
        if self.ofile is None or self.ofile == '':
            from time import time
            self.ofile = open('pysgdump_%s.log'%int(time()*100), 'w')
            pass
        elif isinstance(self.ofile, str):
            self.ofile = open(self.ofile, 'w')
        elif isinstance(self.ofile, IOBase):
            pass
        else:
            self.msg.error("don't know how to handle ofile value/type [%s/%s]!",
                           str(self.ofile), type(self.ofile))
            return StatusCode.Failure
        
        from PyDumper.Dumpers import get_dumper_fct
        self._dumper_fct = get_dumper_fct
 
        if hasattr(self.ofile, 'name'):
            ofile_name = self.ofile.name
        else:
            ofile_name = '<temporary unnamed file>'
            
        self.msg.info ('dumping containers %s',
                       '<ALL>' if self.items is None else self.items)
        self.msg.info ('into [%s]', ofile_name)
 
        self._evt_nbr = 0
        return StatusCode.Success
 

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg()

MsgStream & AthCommonMsg< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ reinitialize()

StatusCode Alg::reinitialize ( )

overridevirtualinherited

Definition at line 67 of file PyAthenaAlg.cxx.

{
  ATH_MSG_INFO("Re-Initializing " << name() << "...");
  return PyAthena::callPyMethod( m_self, "sysReinitialize" );
}

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ self()

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

inlineoverridevirtualinherited

return associated python object.

BORROWED reference.

Implements IPyComponent.

Definition at line 71 of file PyAthenaAlg.h.

71{ return m_self; }

◆ setPyAttr()

bool Alg::setPyAttr ( PyObject * pyobj )

overrideprotectedvirtualinherited

attach the C++ component to its python cousin

Implements IPyComponent.

Definition at line 143 of file PyAthenaAlg.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::Alg
    pyobj = TPython::CPPInstance_FromVoidPtr ((void*)this, "PyAthena::Alg");
    ATH_MSG_INFO
      ("could not dyncast component [" << name() << "] to a python "
       << "object of type [" << this->typeName() << "] (probably a missing "
       << "dictionary)" << endmsg
       << "fallback to [PyAthena::Alg]...");
  }
  if ( !pyobj ) {
    PyErr_Clear();
    ATH_MSG_WARNING("Could not dyncast component ["
                    << name() << "] to a pyobject of type [" 
                    << this->typeName() << "]");
  } else {
    if ( -1 == PyObject_SetAttrString(o, "_cppHandle", pyobj) ) {
      PyErr_Clear();
      ATH_MSG_WARNING
        ("Could not attach C++ handle [" << name() << "] to its python "
         << "cousin !");
      if ( -1 == PyObject_SetAttrString(o, "_cppHandle", Py_None) ) {
        PyErr_Clear();
        ATH_MSG_WARNING
          ("could not attach a dummy C++ handle [" << name() << "] to its "
           "python cousin !");
      }
    } else {
      return true;
    }
  }
  return false;
}

◆ start()

StatusCode Alg::start ( )

overridevirtualinherited

Definition at line 74 of file PyAthenaAlg.cxx.

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

◆ stop()

StatusCode Alg::stop ( )

overridevirtualinherited

Definition at line 80 of file PyAthenaAlg.cxx.

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

◆ sysInitialize()

StatusCode Alg::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthAlgorithm.

Definition at line 105 of file PyAthenaAlg.cxx.

{
  ServiceHandle<IPyComponentMgr> pyMgr
    ( "PyAthena::PyComponentMgr/PyComponentMgr", name() );
  if ( !pyMgr.retrieve().isSuccess() ) {
    ATH_MSG_ERROR("Could not retrieve service [" << pyMgr.typeAndName()
                  << "] !!");
    return StatusCode::FAILURE;
  }
 
  // first retrieve our python object cousin...
  m_self = pyMgr->pyObject( this );
 
  if ( m_self == Py_None ) {
    ATH_MSG_ERROR("Wrapped PyObject is NONE !");
    return StatusCode::FAILURE;
  }
 
  // re-route to usual sysInit...
  return AlgBase_t::sysInitialize();
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ typeName()

const char * Alg::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 132 of file PyAthenaAlg.cxx.

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

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ _dumper_fct

python.PyComps.PySgDumper._dumper_fct = get_dumper_fct

protected

Definition at line 281 of file Event/PyDumper/python/PyComps.py.

◆ _evt_nbr

python.PyComps.PySgDumper._evt_nbr = 0

protected

Definition at line 292 of file Event/PyDumper/python/PyComps.py.

◆ _ignore_clids

tuple python.PyComps.PySgDumper._ignore_clids

staticprotected

Initial value:

=  (
        1118613496, # old ParticleJetContainer class
        222376821,  # DataHeader
        55596997,   # EventContext
        )

Definition at line 226 of file Event/PyDumper/python/PyComps.py.

◆ clidsvc

python.PyComps.PySgDumper.clidsvc = PyAthena.py_svc ('ClassIDSvc')

Definition at line 256 of file Event/PyDumper/python/PyComps.py.

◆ exclude

python.PyComps.PySgDumper.exclude = kw.get('exclude', '')

Definition at line 238 of file Event/PyDumper/python/PyComps.py.

◆ failed_dumps

python.PyComps.PySgDumper.failed_dumps = set()

list of objects and/or classes for which the dump failed ( (key, clid-or-class, 'reason'), ... )

Definition at line 246 of file Event/PyDumper/python/PyComps.py.

◆ items

python.PyComps.PySgDumper.items = kw.get('items', '*')

properties and data members

Definition at line 237 of file Event/PyDumper/python/PyComps.py.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_self

PyObject* PyAthena::Alg::m_self

protectedinherited

Pointer to self (from the python world)

Definition at line 96 of file PyAthenaAlg.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ ofile

python.PyComps.PySgDumper.ofile = kw.get('ofile', '')

Definition at line 239 of file Event/PyDumper/python/PyComps.py.

◆ sg

python.PyComps.PySgDumper.sg = None

handle to event store

Definition at line 242 of file Event/PyDumper/python/PyComps.py.

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

Event/PyDumper/python/PyComps.py

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ reinitialize()

◆ renounce()

◆ renounceArray()

◆ self()

◆ setPyAttr()

◆ start()

◆ stop()

◆ sysInitialize()

◆ sysStart()

◆ typeName()

◆ updateVHKA()

Member Data Documentation

◆ _dumper_fct

◆ _evt_nbr

◆ _ignore_clids

◆ clidsvc

◆ exclude

◆ failed_dumps

◆ items

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_self

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ ofile

◆ sg

◆ init()