Use string/enum as the ctor parameter

Author: Flamefire

scorep/_instrumenters/scorep_cProfile.py

@@ -4,7 +4,7 @@
 
 class ScorepCProfile(scorep._bindings.CInstrumenter, ScorepInstrumenter):
     def __init__(self, enable_instrumenter):
-        scorep._bindings.CInstrumenter.__init__(self, tracing_or_profiling=False)
+        scorep._bindings.CInstrumenter.__init__(self, interface='Profile')
         ScorepInstrumenter.__init__(self, enable_instrumenter)
 
     def _enable_instrumenter(self):

scorep/_instrumenters/scorep_cTrace.py

@@ -4,7 +4,7 @@
 
 class ScorepCTrace(scorep._bindings.CInstrumenter, ScorepInstrumenter):
     def __init__(self, enable_instrumenter):
-        scorep._bindings.CInstrumenter.__init__(self, tracing_or_profiling=True)
+        scorep._bindings.CInstrumenter.__init__(self, interface='Trace')
         ScorepInstrumenter.__init__(self, enable_instrumenter)
 
     def _enable_instrumenter(self):

src/classes.cpp

@@ -26,22 +26,35 @@ extern "C"
 
     static int CInstrumenter_init(scorepy::CInstrumenter* self, PyObject* args, PyObject* kwds)
     {
-        static const char* kwlist[] = { "tracing_or_profiling", nullptr };
-        int tracing_or_profiling;
+        static const char* kwlist[] = { "interface", nullptr };
+        const char* interface_cstring;
 
-        if (!PyArg_ParseTupleAndKeywords(args, kwds, "p", const_cast<char**>(kwlist),
-                                         &tracing_or_profiling))
+        if (!PyArg_ParseTupleAndKeywords(args, kwds, "s", const_cast<char**>(kwlist),
+                                         &interface_cstring))
             return -1;
 
-        self->init(tracing_or_profiling != 0);
+        const std::string interface_string = interface_cstring;
+        scorepy::InstrumenterInterface interface;
+        if (interface_string == "Trace")
+            interface = scorepy::InstrumenterInterface::Trace;
+        else if (interface_string == "Profile")
+            interface = scorepy::InstrumenterInterface::Profile;
+        else
+        {
+            PyErr_Format(PyExc_TypeError, "Expected 'Trace' or 'Profile', got '%s'",
+                         interface_cstring);
+            return -1;
+        }
+
+        self->init(interface);
         return 0;
     }
 
-    static PyObject* CInstrumenter_get_tracingOrProfiling(scorepy::CInstrumenter* self, void*)
+    static PyObject* CInstrumenter_get_interface(scorepy::CInstrumenter* self, void*)
     {
-        scorepy::PyRefObject result(self->tracing_or_profiling ? Py_True : Py_False,
-                                    scorepy::retain_object);
-        return result;
+        const char* result =
+            self->interface == scorepy::InstrumenterInterface::Trace ? "Trace" : "Profile";
+        return PyUnicode_FromString(result);
     }
 
     static PyObject* CInstrumenter_enable_instrumenter(scorepy::CInstrumenter* self, PyObject*)
@@ -85,9 +98,8 @@ PyTypeObject& getCInstrumenterType()
         { nullptr } /* Sentinel */
     };
     static PyGetSetDef getseters[] = {
-        { "tracing_or_profiling", scorepy::cast_to_PyFunc(CInstrumenter_get_tracingOrProfiling),
-          nullptr, "Return whether the trace (True) or profile (False) instrumentation is used",
-          nullptr },
+        { "interface", scorepy::cast_to_PyFunc(CInstrumenter_get_interface), nullptr,
+          "Return the used interface for instrumentation", nullptr },
         { nullptr } /* Sentinel */
     };
     // Sets the first few fields explicitely and remaining ones to zero

src/scorepy/cInstrumenter.cpp

@@ -21,19 +21,15 @@ void CInstrumenter::enable_instrumenter()
     const auto callback = [](PyObject* obj, PyFrameObject* frame, int what, PyObject* arg) -> int {
         return from_PyObject(obj)->on_event(*frame, what, arg) ? 0 : -1;
     };
-    if (tracing_or_profiling)
-    {
+    if (interface == InstrumenterInterface::Trace)
         PyEval_SetTrace(callback, to_PyObject());
-    }
     else
-    {
         PyEval_SetProfile(callback, to_PyObject());
-    }
 }
 
 void CInstrumenter::disable_instrumenter()
 {
-    if (tracing_or_profiling)
+    if (interface == InstrumenterInterface::Trace)
         PyEval_SetTrace(nullptr, nullptr);
     else
         PyEval_SetProfile(nullptr, nullptr);

src/scorepy/cInstrumenter.hpp

@@ -5,14 +5,22 @@
 
 namespace scorepy
 {
+/// Interface to Python used to implement an instrumenter
+/// See sys.settrace/setprofile
+enum class InstrumenterInterface
+{
+    Profile,
+    Trace
+};
+
 struct CInstrumenter
 {
     PyObject_HEAD;
-    bool tracing_or_profiling;
+    InstrumenterInterface interface;
 
-    void init(bool tracing_or_profiling)
+    void init(InstrumenterInterface interface)
     {
-        this->tracing_or_profiling = tracing_or_profiling;
+        this->interface = interface;
     }
     void enable_instrumenter();
     void disable_instrumenter();