Merge branch 'devel' into feature-ire

Author: pkazanzides

cisstInteractive/code/ireFramework.cpp

@@ -88,6 +88,9 @@ class PyTextCtrlHook {
     static PyObject* PythonEventClass;   // the event object to pass to PostEvent
     static PyObject* PythonWindow;       // the window that will handle the event
     static PyMethodDef Methods[];
+#if (PY_MAJOR_VERSION >= 3)
+    static PyModuleDef ModuleDef;
+#endif
     static cmnCallbackStreambuf<char> *Streambuf;
     static cmnLogMask Mask;
 
@@ -108,7 +111,7 @@ class PyTextCtrlHook {
     static void PrintLog(const char * str, int len);
 
     // Initialize the Python module
-    static void InitModule(const char * name);
+    static PyObject *InitModule();
 
     // Cleanup
     static void Cleanup();
@@ -201,7 +204,6 @@ void PyTextCtrlHook::SetupStreambuf(void)
 //     len:  the length of the string
 void PyTextCtrlHook::PrintLog(const char * str, int len)
 {
-#if (PY_MAJOR_VERSION == 2)
     PyObject* result;
 
     // If PythonFunc is set, we know that PythonEventClass is also set
@@ -211,32 +213,38 @@ void PyTextCtrlHook::PrintLog(const char * str, int len)
         // This function is defined in Python 2.3 or greater.
         PyGILState_STATE gstate = PyGILState_Ensure();
 
-        PyObject* event = PyObject_CallObject(PythonEventClass, NULL);
+        // Create an instance of the event class and set the msg attribute
+        PyObject *empty = Py_BuildValue("()");
+        PyObject *kwargs = Py_BuildValue("{s:s}", "msg", str);
+        PyObject* event = PyObject_Call(PythonEventClass, empty, kwargs);
         CMN_ASSERT(event);
+        Py_DECREF(empty);
+        Py_DECREF(kwargs);
 
-        // Convert the C string to a Python string
-        PyObject* pystr = Py_BuildValue("s", str);
-        // Store the string as the "msg" attribute in the event object
-        CMN_ASSERT(PyObject_SetAttrString(event, "msg", pystr) == 0);
-        // Decrement "pystr" reference count (PyObject_SetAttrString incremented it).
-        Py_DECREF(pystr);
         // Build the args for the Python function
         PyObject* args = Py_BuildValue("OO", PythonWindow, event);
         // Decrement "event" reference count (Py_BuildValue incremented it)
         Py_DECREF(event);
         // Call the callback function
+#if (PY_MAJOR_VERSION == 2)
         if (PyCFunction_Check(PythonFunc)) {
             // If it is a (wrapped) C function, call it directly.
             try {
                 result = PyCFunction_Call(PythonFunc, args, 0);
+                result = PyObject_CallObject(PythonFunc, args);
             }
             catch(...) {
                 std::cout << "PyCFunction_Call exception" << std::endl;
             }
         }
-        else
+        else {
             // Call the Python function (via the interpreter)
-            result = PyEval_CallObject(PythonFunc, args);
+            result = PyObject_CallObject(PythonFunc, args);
+        }
+#else
+        // Call the Python function (via the interpreter)
+        result = PyObject_CallObject(PythonFunc, args);
+#endif
         // Decrement reference count
         Py_DECREF(args);
 
@@ -251,7 +259,6 @@ void PyTextCtrlHook::PrintLog(const char * str, int len)
         // Release Python global interpreter lock
         PyGILState_Release(gstate);
     }
-#endif
 }
 
 // Cleanup:  remove logger channel, delete Streambuf object,
@@ -295,11 +302,31 @@ PyMethodDef PyTextCtrlHook::Methods[] = {
     { NULL, NULL, 0, NULL }
 };
 
-void PyTextCtrlHook::InitModule(const char * name)
+#if (PY_MAJOR_VERSION >= 3)
+PyModuleDef PyTextCtrlHook::ModuleDef = {
+    PyModuleDef_HEAD_INIT,
+    "ireLogger",
+    "ireLogger documentation",
+    -1,
+    PyTextCtrlHook::Methods,
+    NULL,
+    NULL,
+    NULL,
+    NULL
+};
+#endif
+
+PyObject *PyTextCtrlHook::InitModule()
 {
+    PyObject *pModule;
 #if (PY_MAJOR_VERSION == 2)
-    Py_InitModule(name, Methods);
+    pModule = Py_InitModule("ireLogger", Methods);
+#else
+    pModule = PyModule_Create(&ModuleDef);
 #endif
+    if (pModule == NULL)
+        CMN_LOG_INIT_ERROR << "PyTextCtrlHook::InitModule failed" << std::endl;
+    return pModule;
 }
 
 // ****************************************************************************
@@ -333,8 +360,8 @@ ireFramework* ireFramework::Instance(void) {
 //
 void ireFramework::InitShellInstance(void)
 {
-    if (IsInitialized()) {
-        CMN_LOG_INIT_WARNING << "ireFramework already initialized" << std::endl;
+    if (IRE_State != IRE_NOT_CONSTRUCTED) {
+        CMN_LOG_INIT_WARNING << "ireFramework already constructed" << std::endl;
         return;
     }
 #if (CISST_OS == CISST_LINUX)
@@ -353,22 +380,7 @@ void ireFramework::InitShellInstance(void)
                            << ": " << msg << std::endl;
     }
 #endif
-    Py_Initialize();
-#if (PY_MAJOR_VERSION < 3) || (PY_MINOR_VERSION < 7)
-    // PyEval_InitThreads was deprecated in Python 3.7 (it is no longer needed)
-    PyEval_InitThreads();
-#endif
-#if (CISST_OS == CISST_LINUX)
-#if (PY_MAJOR_VERSION == 2)
-    // TODO: check if this is needed for Python3
-    // For Linux, change dlopenflags to avoid swig::stop_iterator exceptions
-    PyGILState_STATE gstate = PyGILState_Ensure();
-    PyThreadState *threadState = PyThreadState_Get();
-    threadState->interp->dlopenflags |= RTLD_GLOBAL;
-    PyGILState_Release(gstate);
-#endif
-#endif
-    IRE_State = IRE_INITIALIZED;
+    IRE_State = IRE_CONSTRUCTED;
 }
 
 // ****************************************************************************
@@ -400,27 +412,66 @@ void ireFramework::FinalizeShellInstance(void)
 // of any PyObject s that use hard references.
 //
 void ireFramework::LaunchIREShellInstance(const char * startup, bool newPythonThread, bool useIPython,
-                                          bool useStreambuf) {
-    //start python
-    const char * python_args[] = { "", startup };
-
-    if (IRE_State != IRE_INITIALIZED) {
+                                          bool useStreambuf)
+{
+    if (IRE_State != IRE_CONSTRUCTED) {
         CMN_LOG_INIT_ERROR << "LaunchIREShellInstance:  IRE state is " << IRE_State << "." << std::endl;
         cmnThrow(std::runtime_error("LaunchIREShellInstance: invalid IRE state."));
     }
-    IRE_State = IRE_LAUNCHED;
+
     NewPythonThread = newPythonThread;
 
     if (pInstance)
         Py_DECREF(pInstance);
     pInstance = 0;
 
 #if (PY_MAJOR_VERSION == 2)
-    // Initialize ireLogger module, which is used for the cmnLogger output window
-    PyTextCtrlHook::InitModule("ireLogger");
+    Py_Initialize();
+    // Set python_args as argv.
+    // Note that currently, startup script run separately for IPython.
+    const char * python_args[] = { "", startup };
     PySys_SetArgv(2, const_cast<char **>(python_args));
+    // Initialize ireLogger module, which is used for the cmnLogger output window
+    PyTextCtrlHook::InitModule();
+#else
+    // Following setting of python_args appears to be necessary when using Python 3
+    // with wxPython. Note that currently, startup script run separately for IPython.
+    const char * python_args[] = { "", "IRE", startup };
+    PyConfig config;
+    PyConfig_InitPythonConfig(&config);
+    PyConfig_SetBytesArgv(&config, 3, const_cast<char **>(python_args));
+    // Initialize ireLogger module, which is used for the cmnLogger output window
+    if (PyImport_AppendInittab("ireLogger", PyTextCtrlHook::InitModule) == -1)
+        CMN_LOG_INIT_WARNING << "LaunchIREShellInstance: failed to import ireLogger" << std::endl;
+    PyStatus status;
+    status = Py_InitializeFromConfig(&config);
+    PyConfig_Clear(&config);
+    if (PyStatus_IsError(status)) {
+        CMN_LOG_INIT_ERROR << "LaunchIREShellInstance: init error: " << status.err_msg << std::endl;
+        cmnThrow(std::runtime_error("LaunchIREShellInstance: init error"));
+    }
+    else if (PyStatus_IsExit(status)) {
+        CMN_LOG_INIT_ERROR << "LaunchIREShellInstance: init exit: " << status.err_msg << std::endl;
+        cmnThrow(std::runtime_error("LaunchIREShellInstance: init exit"));
+    }
+#endif
+#if (PY_MAJOR_VERSION < 3) || (PY_MINOR_VERSION < 7)
+    // PyEval_InitThreads was deprecated in Python 3.7 (it is no longer needed)
+    PyEval_InitThreads();
+#endif
+#if (CISST_OS == CISST_LINUX)
+#if (PY_MAJOR_VERSION == 2)
+    // TODO: check if this is needed for Python3
+    // For Linux, change dlopenflags to avoid swig::stop_iterator exceptions
+    PyGILState_STATE gstate = PyGILState_Ensure();
+    PyThreadState *threadState = PyThreadState_Get();
+    threadState->interp->dlopenflags |= RTLD_GLOBAL;
+    PyGILState_Release(gstate);
+#endif
 #endif
 
+    IRE_State = IRE_LAUNCHED;
+
     // Get global dictionary (pModule and pDict are borrowed references)
     PyObject *pModule = PyImport_AddModule("__main__");
     PyObject *pDict = PyModule_GetDict(pModule);
@@ -432,6 +483,7 @@ void ireFramework::LaunchIREShellInstance(const char * startup, bool newPythonTh
 
     char launchString[128];
     if (useIPython) {
+        // Could instead add "argv=[%s]" to launchString, where %s is startup string
         PyRun_SimpleString(startup);
         // Following code is for very old versions of IPython (possibly prior to 1.0)
         // PyRun_SimpleString("from IPython.Shell import IPShellEmbed\n");
@@ -526,12 +578,8 @@ bool ireFramework::IsInitialized()
 
 void ireFramework::Reset()
 {
-    if (IRE_State == IRE_FINISHED) {
-        if (!IsInitialized())
-            InitShell();
-        else
-            IRE_State = IRE_INITIALIZED;
-    }
+    if (IRE_State == IRE_FINISHED)
+        IRE_State = IRE_CONSTRUCTED;
 }
 
 void ireFramework::UnblockThreads()

cisstInteractive/code/ireTask.cpp

@@ -6,7 +6,7 @@
   Author(s):  Peter Kazanzides
   Created on: 2010-12-10
 
-  (C) Copyright 2010 Johns Hopkins University (JHU), All Rights Reserved.
+  (C) Copyright 2010-2025 Johns Hopkins University (JHU), All Rights Reserved.
 
 --- begin cisst license - do not edit ---
 
@@ -52,7 +52,7 @@ void ireTask::Initialize(void)
         required->AddEventHandlerWrite(&ireTask::Log, this, 
                                        mtsManagerComponentBase::EventNames::PrintLog);
     }
-    SetInitializationDelay(30.0);  // Allow up to 30 seconds for it to start
+    SetInitializationDelay(10.0);  // Allow up to 10 seconds for it to start
 }
 
 ireTask::~ireTask()
@@ -74,8 +74,9 @@ void ireTask::Startup(void)
             << GetName() << " = cisstCommon.cmnObjectRegister.FindObject('" << GetName() << "'); "
             << StartupCommands;
     try {
-        // Don't use cmnCallbackStreambuf because we will use system-wide log
-        ireFramework::LaunchIREShell(startup.str().c_str(), true, (Shell == IRE_IPYTHON), false);
+        // Set last parameter true to use cmnCallbackStreambuf (standard CMN_LOG)
+        // Set last parameter false if using system-wide log (threaded logging)
+        ireFramework::LaunchIREShell(startup.str().c_str(), true, (Shell == IRE_IPYTHON), true);
     }
     catch (...) {
         if (Shell == IRE_IPYTHON)

cisstInteractive/code/irepy/ireMain.py

@@ -599,17 +599,15 @@ def GetTypeString(self, obj):
     #-------------------------------------------------
 
     def SaveHistoryToFile(self):
-        # PK TODO: pickle not yet working in Python3
-        if sys.version_info.major == 2:
-            cmdlist = self.CommandHistoryListCtrl.GetAllItems()
-            f = open(self.HISTORY_FILENAME, 'w')
-            pickle.dump(cmdlist, f)
+        cmdlist = self.CommandHistoryListCtrl.GetAllItems()
+        f = open(self.HISTORY_FILENAME, 'wb')
+        pickle.dump(cmdlist, f)
 
     def LoadHistoryFromFile(self, fn=HISTORY_FILENAME):
         Data = []
         if os.path.isfile(fn):
             try:
-                Data = pickle.load(open(fn))
+                Data = pickle.load(open(fn, 'rb'))
             except Exception as error:
                 msgdlg = wx.MessageDialog(self, str(error), "Load History", wx.OK | wx.ICON_ERROR)
                 msgdlg.ShowModal()
@@ -693,13 +691,13 @@ def TruncateHistoryFile(self):
             # write the command file up to the selected line into the named file
             # fetch any existing list first and append to it
             try:
-                archlist = pickle.load(open(fn))
+                archlist = pickle.load(open(fn), 'rb')
             except IOError:
                 archlist = []
             n=0
             for n in range(choice):
                 archlist.append( cmdlist[n] )
-            pickle.dump( archlist, open(fn, 'w'))
+            pickle.dump( archlist, open(fn, 'wb'))
             text = "Your command history was archived to " + fn
             msgdlg = wx.MessageDialog(self, text, title, wx.OK | wx.ICON_INFORMATION)
             msgdlg.ShowModal()
@@ -836,7 +834,7 @@ def OnViewLogger(self, event):
     def OnLoadWorkspace(self, event):
         Filepath = py.editor.openSingle(directory='',wildcard='IRE Workspace (*.ws)|*.ws|All Files (*.*)|*.*').path
         if Filepath:
-            File = open(Filepath)
+            File = open(Filepath, 'rb')
             LoadWorkspaceFile(self.Shell.interp.locals, File)
             File.close()
             self.CheckScopeVariables()
@@ -848,7 +846,7 @@ def OnSaveWorkspace(self, event):
             (name, ext) = os.path.splitext(Filepath)
             if not ext:
                Filepath += '.ws'
-            File = open(Filepath,'w')
+            File = open(Filepath,'wb')
             SaveWorkspaceToFile(self.Shell.interp.locals, File)
             File.close()
 

cisstInteractive/code/irepy/ireWorkspace.py

@@ -76,7 +76,7 @@ def main():
     v1 = v2 = None
     print('v1 = ', v1, '\nv2 = ', v2)
     LoadFile(open('workspace'))
-    Workspace = pickle.load(open('workspace'))
+    Workspace = pickle.load(open('workspace', 'rb'))
     for Variable in Workspace:
         exec(Variable + " = Workspace['" + Variable + "']")
     print('v1 = ', v1, '\nv2 = ', v2)

cisstInteractive/code/makeIrepy.py

@@ -62,14 +62,13 @@ def main():
            sys.exit(1)
 
     # compile the source files
-    for f in glob.glob1(src,'*.py'):
-        py_compile.compile(os.path.join(src,f), os.path.join(dest,f+'c'))
+    for fpath in glob.glob(os.path.join(src,'*.py')):
+        fname = os.path.basename(fpath)
+        py_compile.compile(fpath, os.path.join(dest,fname+'c'))
 
     #Now copy the images over.
     #This can be directly handled by CMake
     #shutil.copytree(os.path.join(src,'images', os.path.join(dest, 'images')))
 
 if __name__ == "__main__":
     main()
-    
-