PyAthena::PyComponentMgr Class Reference

#include <PyComponentMgr.h>

Inheritance diagram for PyAthena::PyComponentMgr:

Collaboration diagram for PyAthena::PyComponentMgr:

Public Member Functions
	PyComponentMgr (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor with parameters: More...
virtual	~PyComponentMgr ()
	Destructor: More...
virtual StatusCode	initialize () override
	Gaudi Service Implementation. More...
virtual StatusCode	finalize () override
virtual PyObject *	pyObject (IPyComponent *component) override
	Retrieve a python object from the python world. More...

Private Types
typedef std::unordered_map< std::string, PyObject * >	PyComponents_t

Private Member Functions
	PyComponentMgr ()=delete

Private Attributes
PyObject *	m_dict
	The dictionary of python components' description It should be of the form: { 'name' : { 'package' : "MyAnaPkg", 'class' : "MyAlg", 'pyprops' : { 'OutputLevel' : 1, ..., } }, }. More...
PyComponents_t	m_components
	A fast look-up hash-map for python components { 'name' : PyObject* } PyObject* is NULL if not yet instantiated Note that we own the PyObjects. More...

Friends
class	SvcFactory< PyAthena::PyComponentMgr >

Detailed Description

Definition at line 35 of file PyComponentMgr.h.

Member Typedef Documentation

PyComponents_t

typedef std::unordered_map<std::string, PyObject*> PyAthena::PyComponentMgr::PyComponents_t

private

Definition at line 84 of file PyComponentMgr.h.

Constructor & Destructor Documentation

PyComponentMgr() [1/2]

PyComponentMgr::PyComponentMgr	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Constructor with parameters:

Definition at line 72 of file PyComponentMgr.cxx.

                                           : 
  base_class  ( name,     pSvcLocator ),
  m_dict      ( nullptr ),
  m_components(   )
{
  //
  // Property declaration
  // 
  //declareProperty( "Property", m_nProperty, "descr" );
 
}

~PyComponentMgr()

PyComponentMgr::~PyComponentMgr ( )

virtual

Destructor:

Definition at line 87 of file PyComponentMgr.cxx.

{ 
  ATH_MSG_DEBUG("Calling destructor");
 
  // we own the repository of instances' description
  if ( m_dict ) {
    RootUtils::PyGILStateEnsure ensure;
    Py_DECREF( m_dict );
    m_dict = nullptr;
  }
 
  // as well as the one of corresponding instances
  if ( m_components.size() ) {
    RootUtils::PyGILStateEnsure ensure;
    for ( PyComponents_t::iterator
            i    = m_components.begin(),
            iEnd = m_components.end();
          i != iEnd;
          ++i ) {
      ATH_MSG_VERBOSE("__del__(" << i->first << ")...");
      Py_XDECREF( i->second );
    }
  }
 
}

PyComponentMgr() [2/2]

PyAthena::PyComponentMgr::PyComponentMgr ( )

privatedelete

Member Function Documentation

finalize()

StatusCode PyComponentMgr::finalize ( )

overridevirtual

Definition at line 198 of file PyComponentMgr.cxx.

{
  ATH_MSG_INFO("Finalizing " << name() << "...");
  return StatusCode::SUCCESS;
}

initialize()

StatusCode PyComponentMgr::initialize ( )

overridevirtual

Gaudi Service Implementation.

Definition at line 116 of file PyComponentMgr.cxx.

{
  ATH_MSG_INFO("Initializing " << name() << "...");
 
  const std::string pyModuleName = "AthenaPython.Configurables";
 
  // import the module holding the dictionary of component instances
  RootUtils::PyGILStateEnsure ensure;
  ATH_MSG_DEBUG("Importing module [" << pyModuleName << "]...");
  PyObject* module = PyImport_ImportModule( const_cast<char*>(pyModuleName.c_str()) );
  if ( !module || !PyModule_Check( module ) ) {
    ATH_MSG_ERROR("Could not import [" << pyModuleName << "] !!");
    Py_XDECREF (module);
    throw CPyCppyy::PyException();
  }
 
  const std::string pyClassName = "PyComponents";
  PyObject* pyClass = 0;
  pyClass = PyDict_GetItemString( PyModule_GetDict( module ),
                  const_cast<char*>( pyClassName.c_str() ) );
  
  // borrowed ref. so ->increment
  Py_XINCREF( pyClass );
 
  if ( !pyClass ) {
    ATH_MSG_ERROR("Could not retrieve class [" << pyClassName
                  << "] from module [" << pyModuleName << "] !!");
    Py_XDECREF(pyClass);
    Py_DECREF (module);
    return StatusCode::FAILURE;
  }
 
  m_dict = PyObject_GetAttrString( pyClass,
                   const_cast<char*>( "instances" ) );
  if ( !m_dict || !PyDict_Check( m_dict ) ) {
    ATH_MSG_ERROR("Could not retrieve attribute [instances] from class ["
                  << pyClassName << "] !!");
    Py_DECREF (pyClass);
    Py_DECREF (module);
    return StatusCode::FAILURE;
  }
  Py_DECREF(pyClass);
 
  // install the fancy attribute getter for PyComponents to automatically
  // retrieve an initialized component.
  // see bug #46668
  {
    PyObject* fancy_attr = 0;
    fancy_attr = PyDict_GetItemString(PyModule_GetDict(module),
                      (char*)"_install_fancy_attrs");
    // borrowed ref => increment
    Py_XINCREF(fancy_attr);
    if (!fancy_attr) {
      PyErr_Clear();
      ATH_MSG_INFO
        ("could not retrieve function [_install_fancy_attrs] from module ["
         << pyModuleName << "]");
    } else {
      PyObject* ret = PyObject_CallFunction(fancy_attr, NULL);
      Py_XDECREF(ret);
    }
    Py_XDECREF(fancy_attr);
  }
  Py_DECREF (module);
 
  // make sure the PyROOT fixes are installed
  const std::string pyRootFixes = "RootUtils.PyROOTFixes";
  ATH_MSG_DEBUG("Importing module [" << pyRootFixes << "]...");
  PyObject *rootFixes = 0;
  rootFixes = PyImport_ImportModule(const_cast<char*>(pyRootFixes.c_str()));
  if ( !rootFixes || !PyModule_Check( rootFixes ) ) {
    PyErr_Print();
    PyErr_Clear();
    ATH_MSG_WARNING("Could not import [" << pyRootFixes << "] !!"
                    << endmsg
                    << "Some problem may appear with some C++->python binded classes (YMMV)");
  }
  Py_XDECREF(rootFixes);
  return StatusCode::SUCCESS;
}

pyObject()

PyObject * PyComponentMgr::pyObject ( IPyComponent *  component )

overridevirtual

Retrieve a python object from the python world.

this returns a NEW reference to that python object.

Hum... remove ? or not ? leaving the objects on the python side may allow easier retrieval from py-components...

Definition at line 206 of file PyComponentMgr.cxx.

{
  const std::string& name = cppComp->name();
 
  // Check if we already have instantiated that component
  RootUtils::PyGILStateEnsure ensure;
  PyComponents_t::iterator comp = m_components.find( name );
  if ( comp != m_components.end() && comp->second ) {
    Py_INCREF (comp->second);
    return comp->second;
  }
  m_components[name] = static_cast<PyObject*>( NULL );
 
  // Check we have a valid dict.
  if ( !m_dict || !PyDict_Check(m_dict) ) {
    ATH_MSG_ERROR("Invalid repository of Python components !!");
    Py_INCREF( Py_None );
    return Py_None;
  }
  
  PyObject* o = PyDict_GetItemString( m_dict, 
                      const_cast<char*>(name.c_str()) );
  // borrowed ref -> incr
  Py_XINCREF( o );
 
  // Check we have a valid dict.
  if ( !o ) {
    ATH_MSG_ERROR("No such python component [" << name
                  << "] or invalid item !!");
    Py_XDECREF( o );
    throw CPyCppyy::PyException();
  }
  m_components[name] = o;
 
//   // remove the object from the python dict
//   if ( PyDict_DelItemString( m_dict, const_cast<char*>(name.c_str()) ) ) {
//     ATH_MSG_ERROR("Could not remove [" << name << "] from PyComponents.instances !!");
//     throw PyROOT::TPyException();
//   }
 
  // now we tell the PyObject which C++ object it is the cousin of.
  if ( !cppComp->setPyAttr(o) ) {
    ATH_MSG_WARNING("Could not connect the C++ object ["
                    << cppComp->typeName() << "/" << cppComp->name()
                    << "] with its python cousin !");
  }
 
  removePyGen();
 
  Py_INCREF(o);
  return o;
}

Friends And Related Function Documentation

SvcFactory< PyAthena::PyComponentMgr >

friend class SvcFactory< PyAthena::PyComponentMgr >

friend

Definition at line 30 of file PyComponentMgr.h.

Member Data Documentation

m_components

PyComponents_t PyAthena::PyComponentMgr::m_components

private

A fast look-up hash-map for python components { 'name' : PyObject* } PyObject* is NULL if not yet instantiated Note that we own the PyObjects.

Definition at line 90 of file PyComponentMgr.h.

m_dict

PyObject* PyAthena::PyComponentMgr::m_dict

private

The dictionary of python components' description It should be of the form: { 'name' : { 'package' : "MyAnaPkg", 'class' : "MyAlg", 'pyprops' : { 'OutputLevel' : 1, ..., } }, }.

Definition at line 82 of file PyComponentMgr.h.

---

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

• PyComponentMgr.h
• PyComponentMgr.cxx