PyAthena Namespace Reference

Classes
class	Alg
class	Aud
class	PyComponentMgr
class	Svc
class	Tool

Typedefs
typedef ::AthAlgorithm	AlgBase_t
typedef ::AthService	SvcBase_t
typedef ::AthAlgTool	ToolBase_t

Functions
std::string	repr (PyObject *o)
	returns the string representation of a python object equivalent of calling repr(o) in python
std::string	str (PyObject *o)
	returns the string representation of a python object equivalent of calling str(o) in python
StatusCode callPyMethod	ATLAS_NOT_THREAD_SAFE (PyObject *self, const char *method, PyObject *arg=nullptr)
	call the python method
StatusCode queryInterface	ATLAS_NOT_THREAD_SAFE (PyObject *self, const InterfaceID &riid, void **ppvInterface)
	query interface binding
void pyAudit	ATLAS_NOT_THREAD_SAFE (PyObject *self, const char *method, const char *evt, const char *component)
	helper function for PyAthena::Aud
void pyAudit	ATLAS_NOT_THREAD_SAFE (PyObject *self, const char *method, const char *evt, const char *component, const StatusCode &sc)
	helper function for PyAthena::Aud
void	throw_py_exception (bool display=true)
	helper function to capture the boilerplate code for user friendly stack trace display

Typedef Documentation

AlgBase_t

typedef ::AthAlgorithm PyAthena::AlgBase_t

Definition at line 29 of file PyAthenaAlg.h.

SvcBase_t

typedef ::AthService PyAthena::SvcBase_t

Definition at line 30 of file PyAthenaSvc.h.

ToolBase_t

typedef ::AthAlgTool PyAthena::ToolBase_t

Definition at line 29 of file PyAthenaTool.h.

Function Documentation

ATLAS_NOT_THREAD_SAFE() [1/4]

void pyAudit PyAthena::ATLAS_NOT_THREAD_SAFE	(	PyObject *	self,
		const char *	method,
		const char *	evt,
		const char *	component )

helper function for PyAthena::Aud

ATLAS_NOT_THREAD_SAFE() [2/4]

void pyAudit PyAthena::ATLAS_NOT_THREAD_SAFE	(	PyObject *	self,
		const char *	method,
		const char *	evt,
		const char *	component,
		const StatusCode &	sc )

helper function for PyAthena::Aud

ATLAS_NOT_THREAD_SAFE() [3/4]

StatusCode callPyMethod PyAthena::ATLAS_NOT_THREAD_SAFE	(	PyObject *	self,
		const char *	method,
		PyObject *	arg = nullptr )

call the python method

ATLAS_NOT_THREAD_SAFE() [4/4]

StatusCode queryInterface PyAthena::ATLAS_NOT_THREAD_SAFE	(	PyObject *	self,
		const InterfaceID &	riid,
		void **	ppvInterface )

query interface binding

repr()

std::string PyAthena::repr

(

PyObject *

o

)

returns the string representation of a python object equivalent of calling repr(o) in python

Definition at line 109 of file PyAthenaUtils.cxx.

{
  // PyObject_Repr returns a new ref.
  RootUtils::PyGILStateEnsure ensure;
  PyObject* py_repr = PyObject_Repr( o );
 
  auto [cpp_repr, flag] = RootUtils::PyGetString (py_repr);
  Py_DECREF( py_repr );
  if (!flag) {
    PyAthena::throw_py_exception();
  }
  return cpp_repr;
}

str()

std::string PyAthena::str

(

PyObject *

o

)

returns the string representation of a python object equivalent of calling str(o) in python

Definition at line 124 of file PyAthenaUtils.cxx.

{
  // PyObject_Str returns a new ref.
  RootUtils::PyGILStateEnsure ensure;
  PyObject* py_str = PyObject_Str( o );
  auto [cpp_str, flag] = RootUtils::PyGetString (py_str);
  Py_DECREF( py_str );
  if ( !flag ) {
    PyAthena::throw_py_exception();
  }
  return cpp_str;
}

throw_py_exception()

void PyAthena::throw_py_exception

(

bool

display = true

)

helper function to capture the boilerplate code for user friendly stack trace display

Definition at line 138 of file PyAthenaUtils.cxx.

{
  if (display) {
    RootUtils::PyGILStateEnsure ensure;
    // fetch error
    PyObject* pytype = 0, *pyvalue = 0, *pytrace = 0;
    PyErr_Fetch (&pytype, &pyvalue, &pytrace);
    Py_XINCREF  (pytype);
    Py_XINCREF  (pyvalue);
    Py_XINCREF  (pytrace);
    // restore...
    PyErr_Restore (pytype, pyvalue, pytrace);
    // and print
    PyErr_Print();
    {
      // With py3, need to explicitly flush the python stderr
      // for the error to be visible.
      PyObject* f = PySys_GetObject (const_cast<char*>("stderr"));
      PyObject* fstr = PyUnicode_FromString ("flush");
      PyObject* x = PyObject_CallMethodObjArgs (f, fstr, NULL);
      Py_XDECREF (x);
      Py_XDECREF (fstr);
      Py_XDECREF (f);
    }
  }
#ifdef ATLAS_HAVE_CPYCPPYY
  throw CPyCppyy::PyException();
#else
  throw std::runtime_error ("Python exception");
#endif  // ATLAS_HAVE_CPYCPPYY
}