ENH: Control the amount of console output of the python web proxy

When using ScriptEditor, long messages are often logged in the terminal. These are helpful during development and troubleshooting, but not when using the application. These messages are disabled by default now and can be enabled when needed. SlicerMorph/SlicerScriptEditor#43 Co-authored-by: Andras Lasso <[email protected]>
chir-set · Sep 29, 2024 · 7f1e01f · 7f1e01f
1 parent 84e5d4b
commit 7f1e01f
Show file tree

Hide file tree

Showing 3 changed files with 80 additions and 21 deletions.
diff --git a/Base/QTGUI/qSlicerWebPythonProxy.cxx b/Base/QTGUI/qSlicerWebPythonProxy.cxx
@@ -31,36 +31,36 @@
 # include "qSlicerPythonManager.h"
 #endif
 #include "qSlicerWebPythonProxy.h"
+#include "qSlicerWebPythonProxy_p.h"
 
-// --------------------------------------------------------------------------
-qSlicerWebPythonProxy::qSlicerWebPythonProxy(QObject *parent)
-  : QObject(parent)
-{
-  this->pythonEvaluationAllowed = false;
-}
+//------------------------------------------------------------------------------
+qSlicerWebPythonProxyPrivate::~qSlicerWebPythonProxyPrivate() = default;
+
+CTK_GET_CPP(qSlicerWebPythonProxy, bool, verbose, Verbose);
+CTK_SET_CPP(qSlicerWebPythonProxy, bool, setVerbose, Verbose);
 
 // --------------------------------------------------------------------------
-bool qSlicerWebPythonProxy::isPythonEvaluationAllowed()
+bool qSlicerWebPythonProxyPrivate::isPythonEvaluationAllowed()
 {
 #ifdef Slicer_USE_PYTHONQT
-  if (this->pythonEvaluationAllowed)
+  if (this->PythonEvaluationAllowed)
   {
     return true;
   }
 
-  qSlicerCoreApplication * app = qSlicerCoreApplication::application();
+  qSlicerCoreApplication* app = qSlicerCoreApplication::application();
   if (!app || qSlicerCoreApplication::testAttribute(qSlicerCoreApplication::AA_DisablePython))
   {
     return false;
   }
 
   ctkMessageBox* confirmationBox = new ctkMessageBox(qSlicerApplication::application()->mainWindow());
   confirmationBox->setAttribute(Qt::WA_DeleteOnClose);
-  confirmationBox->setWindowTitle(tr("Allow Python execution?"));
-  confirmationBox->setText(tr("Allow the web page to execute code using Slicer's python?"));
+  confirmationBox->setWindowTitle(qSlicerWebPythonProxy::tr("Allow Python execution?"));
+  confirmationBox->setText(qSlicerWebPythonProxy::tr("Allow the web page to execute code using Slicer's python?"));
 
-  confirmationBox->addButton(tr("Allow"), QMessageBox::AcceptRole);
-  confirmationBox->addButton(tr("Reject"), QMessageBox::RejectRole);
+  confirmationBox->addButton(qSlicerWebPythonProxy::tr("Allow"), QMessageBox::AcceptRole);
+  confirmationBox->addButton(qSlicerWebPythonProxy::tr("Reject"), QMessageBox::RejectRole);
 
   confirmationBox->setDontShowAgainVisible(true);
   confirmationBox->setDontShowAgainSettingsKey("WebEngine/AllowPythonExecution");
@@ -69,15 +69,33 @@ bool qSlicerWebPythonProxy::isPythonEvaluationAllowed()
 
   if (resultCode == QMessageBox::AcceptRole)
   {
-    this->pythonEvaluationAllowed = true;
+    this->PythonEvaluationAllowed = true;
   }
 #endif
-  return this->pythonEvaluationAllowed;
+  return this->PythonEvaluationAllowed;
+}
+
+//------------------------------------------------------------------------------
+qSlicerWebPythonProxy::qSlicerWebPythonProxy(QObject* parent)
+  : Superclass(parent)
+  , d_ptr(new qSlicerWebPythonProxyPrivate)
+{
+}
+
+//------------------------------------------------------------------------------
+qSlicerWebPythonProxy::qSlicerWebPythonProxy(qSlicerWebPythonProxyPrivate* pimpl)
+  : d_ptr(pimpl)
+{
 }
 
+//------------------------------------------------------------------------------
+qSlicerWebPythonProxy::~qSlicerWebPythonProxy() = default;
+
 // --------------------------------------------------------------------------
 QString qSlicerWebPythonProxy::evalPython(const QString &python, int mode)
 {
+  Q_D(qSlicerWebPythonProxy);
+
   ctkAbstractPythonManager::ExecuteStringMode executeStringMode{ctkAbstractPythonManager::FileInput};
   switch (mode)
   {
@@ -97,11 +115,14 @@ QString qSlicerWebPythonProxy::evalPython(const QString &python, int mode)
 
   QString result;
 #ifdef Slicer_USE_PYTHONQT
-  if (this->isPythonEvaluationAllowed())
+  if (d->isPythonEvaluationAllowed())
   {
     qSlicerPythonManager *pythonManager = qSlicerApplication::application()->pythonManager();
     result = pythonManager->executeString(python, executeStringMode).toString();
-    qDebug() << "Running " << python << " result is " << result;
+    if (this->verbose())
+    {
+      qDebug() << "Running " << python << " result is " << result;
+    }
   }
 #else
   Q_UNUSED(python);

diff --git a/Base/QTGUI/qSlicerWebPythonProxy.h b/Base/QTGUI/qSlicerWebPythonProxy.h
@@ -27,16 +27,20 @@
 // QtGUI includes
 #include "qSlicerBaseQTGUIExport.h"
 
+class qSlicerWebPythonProxyPrivate;
 
 class Q_SLICER_BASE_QTGUI_EXPORT qSlicerWebPythonProxy
   : public QObject
 {
   Q_OBJECT
+  Q_PROPERTY(bool verbose READ verbose WRITE setVerbose)
 
 public:
+  typedef QObject Superclass;
 
   /// Constructor
   explicit qSlicerWebPythonProxy(QObject *parent = nullptr);
+  virtual ~qSlicerWebPythonProxy();
 
   /// This enum maps to ctkAbstractPythonManager execution modes Py_eval_input,
   /// Py_file_input and Py_single_input.
@@ -54,6 +58,10 @@ class Q_SLICER_BASE_QTGUI_EXPORT qSlicerWebPythonProxy
     };
   Q_ENUMS(EvalPythonMode);
 
+  /// Enabled detailed logging during Python evaluation.
+  bool verbose() const;
+  void setVerbose(bool value);
+
 public slots:
 
   /// Convenient function to execute python code from
@@ -70,11 +78,13 @@ public slots:
   /// \sa qSlicerWebWidget::initializeWebEngineProfile
   QString evalPython(const QString &python, int mode = FileInput);
 
-private:
-  /// Keep track of user response to avoid going through ctk dialog to check
-  bool isPythonEvaluationAllowed();
-  bool pythonEvaluationAllowed;
+protected:
+  qSlicerWebPythonProxy(qSlicerWebPythonProxyPrivate* pimpl);
+  QScopedPointer<qSlicerWebPythonProxyPrivate> d_ptr;
 
+private:
+  Q_DECLARE_PRIVATE(qSlicerWebPythonProxy);
+  Q_DISABLE_COPY(qSlicerWebPythonProxy);
 };
 
 #endif
diff --git a/Base/QTGUI/qSlicerWebPythonProxy_p.h b/Base/QTGUI/qSlicerWebPythonProxy_p.h
@@ -0,0 +1,28 @@
+/*=auto=========================================================================
+
+  Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH) All Rights Reserved.
+
+  See COPYRIGHT.txt
+  or http://www.slicer.org/copyright/copyright.txt for details.
+
+=========================================================================auto=*/
+
+#ifndef __qSlicerWebPythonProxy_p_h
+#define __qSlicerWebPythonProxy_p_h
+
+#include "qSlicerBaseQTGUIExport.h"
+
+//------------------------------------------------------------------------------
+class Q_SLICER_BASE_QTGUI_EXPORT qSlicerWebPythonProxyPrivate
+{
+public:
+  virtual ~qSlicerWebPythonProxyPrivate();
+
+  /// Keep track of user response to avoid going through ctk dialog to check
+  bool isPythonEvaluationAllowed();
+
+  bool PythonEvaluationAllowed{ false };
+  bool Verbose{ false };
+};
+
+#endif