PrEditor 2.0.0__tar.gz → 2.1.0__tar.gz

{preditor-2.0.0 → preditor-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PrEditor
-Version: 2.0.0
+Version: 2.1.0
 Summary: A python REPL and Editor and console based on Qt.
 Author-email: Blur Studio <opensource@blur.com>
 License: LGPL-3.0

{preditor-2.0.0 → preditor-2.1.0}/PrEditor.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PrEditor
-Version: 2.0.0
+Version: 2.1.0
 Summary: A python REPL and Editor and console based on Qt.
 Author-email: Blur Studio <opensource@blur.com>
 License: LGPL-3.0

{preditor-2.0.0 → preditor-2.1.0}/examples/output_console.py

@@ -6,21 +6,28 @@
 
 import logging
 import sys
+from argparse import ArgumentParser
 
 import Qt
 from Qt.QtCore import QDateTime
 from Qt.QtWidgets import QApplication, QMainWindow
 
 import preditor
+from preditor.contexts import OverrideConsoleStreams
 
 logger_a = logging.getLogger("logger_a")
 logger_a_child = logging.getLogger("logger_a.child")
 logger_b = logging.getLogger("logger_b")
 logger_c = logging.getLogger("logger_c")
 
+# Define a custom logging level name. This should be discouraged but logging
+# supports it so PrEditor should as well.
+SUPER_INFO_LEVEL = logging.INFO - 5
+logging.addLevelName(SUPER_INFO_LEVEL, "SUPER_INFO")
+
 
 class ExampleApp(QMainWindow):
-    def __init__(self, parent=None):
+    def __init__(self, parent=None, init_preditor=True):
         super().__init__(parent=parent)
         # Use a .ui file to simplify the example code setup.
         Qt.QtCompat.loadUi(__file__.replace(".py", ".ui"), self)
@@ -29,6 +36,13 @@ class ExampleApp(QMainWindow):
         self.uiClearBTN.released.connect(self.clear_all)
         self.uiAllLoggingDebugBTN.released.connect(self.all_logging_level_debug)
         self.uiAllLoggingWarningBTN.released.connect(self.all_logging_level_warning)
+        self.uiAllLoggingPrintBTN.released.connect(self.all_logging_print)
+        self.uiAllLoggingRaiseBTN.released.connect(self.all_logging_raise)
+        self.uiAllLoggingChangeHandlersBTN.released.connect(
+            self.all_logging_change_handlers
+        )
+        self.uiUsePrEditorStyleCHK.toggled.connect(self.set_stdout_style)
+        self.uiRemovePrEditorStyleBTN.released.connect(self.clear_stdout_style)
         self.uiLoggingCriticalBTN.released.connect(self.level_critical)
         self.uiLoggingErrorBTN.released.connect(self.level_error)
         self.uiLoggingWarningBTN.released.connect(self.level_warning)
@@ -40,12 +54,15 @@ class ExampleApp(QMainWindow):
         self.uiSendLoggingBTN.released.connect(self.send_logging)
 
         # 1. Create the preditor instance and connect to the console's controllers
-        plog = preditor.instance(parent=self, create=True)
-        preditor.connect_preditor(self)
-        self.uiAllLog.controller = plog
-        self.uiSelectLog.controller = plog
-        self.uiStdout.controller = plog
-        self.uiStderr.controller = plog
+        if init_preditor:
+            plog = preditor.instance(parent=self, create=True)
+            preditor.connect_preditor(self)
+            self.uiAllLog.controller = plog
+            self.uiSelectLog.controller = plog
+            self.uiStdout.controller = plog
+            self.uiStderr.controller = plog
+        else:
+            self.setWindowTitle(f"{self.windowTitle()} - No PrEditor")
 
         # 2. Configure the various OutputConsole widgets.
         # Note: this can be done in the .ui file, but for this example we will
@@ -54,6 +71,10 @@ class ExampleApp(QMainWindow):
         # See this method for how to configure uiAllLog to show all logging
         # messages of all levels
         self.all_logging_level_warning()
+        # Configure the default logging formatter for this widget.
+        self.uiAllLog.logging_formatter_str = (
+            "<<%(levelname)s| %(name)s: Line: %(lineno)d>> %(message)s"
+        )
 
         # Configure uiSelectLog to show logging messages from specific handlers
         self.uiSelectLog.logging_handlers = [
@@ -72,6 +93,24 @@ class ExampleApp(QMainWindow):
         # Configure uiStderr to only show stderr text
         self.uiStderr.stream_echo_stderr = True
 
+    def all_logging_change_handlers(self):
+        """Demonstrate temporarily changing logging_handlers for uiAllLog.
+
+        This changes uiAllLog to only show a subset of loggers not all of them.
+        It sends the same logging messages as the "Send Logging Message" Button,
+        but due to the updated filtering it shows very different results.
+        """
+        handlers = [
+            # Only show logger_a warnings
+            "logger_a_child,level=WARNING",
+            # And enable showing a custom logging level message. This is normally
+            # hidden unless the logging level is set to debug or SUPER_INFO.
+            # Note that we can pass SUPER_INFO because of the `addLevelName` call.
+            "logger_c,level=SUPER_INFO",
+        ]
+        with OverrideConsoleStreams(self.uiAllLog, logging_handlers=handlers):
+            self.send_logging()
+
     def all_logging_level_debug(self):
         """Update this widget to show up to debug messages for all loggers.
         Hide the PyQt loggers as they just clutter the output for this demo.
@@ -80,6 +119,7 @@ class ExampleApp(QMainWindow):
             "root,level=DEBUG",
             "PyQt5,level=CRITICAL",
             "PyQt6,level=CRITICAL",
+            "logger_b,fmt=[%(levelname)s:%(name)s] %(message)s",
         ]
 
     def all_logging_level_warning(self):
@@ -92,8 +132,22 @@ class ExampleApp(QMainWindow):
             # logging messages created when first showing the PrEditor instance.
             "PyQt5,level=CRITICAL",
             "PyQt6,level=CRITICAL",
+            # Replace the default logging_formatter_str formatter only for logger_b
+            "logger_b,fmt=[%(levelname)s:%(name)s] %(message)s",
         ]
 
+    def all_logging_print(self):
+        """Show temporarily enabling showing prints inside multiple consoles."""
+        with OverrideConsoleStreams([self.uiAllLog, self.uiSelectLog], stdout=True):
+            print("This print is also shown in All logging and Select Logging.")
+        print("This print is NOT shown in All logging and Select Logging.")
+
+    def all_logging_raise(self):
+        """Show temporarily enabling showing tracebacks in uiAllLog."""
+        with OverrideConsoleStreams(self.uiAllLog, tracebacks=True):
+            print("This print is NOT shown in All logging.")
+            raise RuntimeError("This Exception is also shown in All logging.")
+
     def clear_all(self):
         """Clear the text from all consoles"""
         self.uiAllLog.clear()
@@ -101,6 +155,11 @@ class ExampleApp(QMainWindow):
         self.uiStdout.clear()
         self.uiStderr.clear()
 
+    def clear_stdout_style(self):
+        """Reset uiStdout's style to not use PrEditor's style."""
+        self.uiUsePrEditorStyleCHK.setChecked(False)
+        self.uiStdout.setStyleSheet(None)
+
     def level_critical(self):
         logging.root.setLevel(logging.CRITICAL)
 
@@ -128,6 +187,14 @@ class ExampleApp(QMainWindow):
     def raise_exception(self):
         raise RuntimeError(self.message_time())
 
+    def set_stdout_style(self, state):
+        """Enable/disable uiStdout using PrEditor's style.
+
+        Note: Disabling it doesn't clear the style, just prevent it from being
+        automatically updated when changed in PrEditor.
+        """
+        self.uiStdout.use_console_stylesheet = state
+
     def send_logging(self):
         logger_a.critical("A critical msg for logger_a")
         logger_a.error("A error msg for logger_a")
@@ -140,23 +207,37 @@ class ExampleApp(QMainWindow):
         logger_b.debug("A debug msg for logger_b")
         logger_c.warning("A warning msg for logger_c")
         logger_c.debug("A debug msg for logger_c")
+        logger_c.log(
+            SUPER_INFO_LEVEL,
+            "A custom logging level msg for logger_c that is normally hidden "
+            "unless using debug or the custom level.",
+        )
         logging.root.warning("A warning msg for logging.root")
         logging.root.debug("A debug msg for logging.root")
 
 
 if __name__ == '__main__':
+    parser = ArgumentParser("Example of using OutputConsole features.")
+    parser.add_argument(
+        "--no-preditor",
+        action="store_true",
+        help="Don't init and install the PrEditor console.",
+    )
+    args = parser.parse_args()
+
     # Configure PrEditor for this application, start capturing all text output
     # from stderr/stdout so once PrEditor is launched, it can show this text.
     # This does not initialize any QtGui/QtWidgets.
-    preditor.configure(
-        # This is the name used to store PrEditor preferences and workboxes
-        # specific to this application.
-        'output_console',
-    )
+    if not args.no_preditor:
+        preditor.configure(
+            # This is the name used to store PrEditor preferences and workboxes
+            # specific to this application.
+            'output_console',
+        )
 
     # Create a Gui Application allowing the user to show PrEditor
     app = QApplication(sys.argv)
-    main_gui = ExampleApp()
+    main_gui = ExampleApp(init_preditor=not args.no_preditor)
 
     main_gui.show()
     app.exec_()

{preditor-2.0.0 → preditor-2.1.0}/examples/output_console.ui

@@ -6,7 +6,7 @@
    <rect>
     <x>0</x>
     <y>0</y>
-    <width>667</width>
+    <width>861</width>
     <height>941</height>
    </rect>
   </property>
@@ -26,25 +26,46 @@
        </property>
        <layout class="QHBoxLayout" name="horizontalLayout_3">
         <item>
-         <widget class="OutputConsole" name="uiAllLog"/>
+         <widget class="OutputConsole" name="uiAllLog">
+          <property name="use_console_stylesheet" stdset="0">
+           <bool>true</bool>
+          </property>
+         </widget>
         </item>
         <item>
-         <layout class="QVBoxLayout" name="verticalLayout">
-          <item>
+         <layout class="QGridLayout" name="gridLayout">
+          <item row="0" column="0">
            <widget class="QPushButton" name="uiAllLoggingWarningBTN">
             <property name="text">
              <string>Warning</string>
             </property>
            </widget>
           </item>
-          <item>
+          <item row="0" column="1">
            <widget class="QPushButton" name="uiAllLoggingDebugBTN">
             <property name="text">
              <string>Debug</string>
             </property>
            </widget>
           </item>
-          <item>
+          <item row="2" column="0" colspan="2">
+           <widget class="Line" name="line">
+            <property name="orientation">
+             <enum>Qt::Horizontal</enum>
+            </property>
+           </widget>
+          </item>
+          <item row="3" column="0" colspan="2">
+           <widget class="QPushButton" name="uiAllLoggingRaiseBTN">
+            <property name="toolTip">
+             <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Uses preditor.contexts.OverrideConsoleStreams to temporarily enable showing tracebacks in all logging and raises an exception. This enables showing errors in that console but errors raised elsewhere won't be shown in that console.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+            </property>
+            <property name="text">
+             <string>Raise and show Exception</string>
+            </property>
+           </widget>
+          </item>
+          <item row="1" column="0" colspan="2">
            <widget class="QLabel" name="label_2">
             <property name="text">
              <string>Set the logging level filter for this widget. This is affected by the global logging levels set at the bottom of this UI, so to see debug output you must set both to debug.</string>
@@ -54,7 +75,27 @@
             </property>
            </widget>
           </item>
-          <item>
+          <item row="4" column="0">
+           <widget class="QPushButton" name="uiAllLoggingPrintBTN">
+            <property name="toolTip">
+             <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Uses preditor.contexts.OverrideConsoleStreams to temporarily enable showing stdout(prints). It also shows the print in Select Logging.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+            </property>
+            <property name="text">
+             <string>Show print</string>
+            </property>
+           </widget>
+          </item>
+          <item row="4" column="1">
+           <widget class="QPushButton" name="uiAllLoggingChangeHandlersBTN">
+            <property name="toolTip">
+             <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Sends the same logging messages as the &amp;quot;Send Logging Messages&amp;quot; button.&lt;/p&gt;&lt;p&gt;However it uses preditor.contexts.OverrideConsoleStreams to temporarily replace logging handlers for uiAllLog. This results in very different output being shown.&lt;/p&gt;&lt;p&gt;If you use the bottom Debug button to set the global logging level to debug you will also see the SUPER_INFO log message.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+            </property>
+            <property name="text">
+             <string>Logging Handlers</string>
+            </property>
+           </widget>
+          </item>
+          <item row="5" column="1">
            <spacer name="verticalSpacer">
             <property name="orientation">
              <enum>Qt::Vertical</enum>
@@ -62,7 +103,7 @@
             <property name="sizeHint" stdset="0">
              <size>
               <width>20</width>
-              <height>40</height>
+              <height>0</height>
              </size>
             </property>
            </spacer>
@@ -77,7 +118,11 @@
        </property>
        <layout class="QVBoxLayout" name="verticalLayout_4">
         <item>
-         <widget class="OutputConsole" name="uiSelectLog"/>
+         <widget class="OutputConsole" name="uiSelectLog">
+          <property name="logging_formatter_str" stdset="0">
+           <string>&lt;&lt;%(levelname)s| %(name)s: Line: %(lineno)d&gt;&gt; %(message)s</string>
+          </property>
+         </widget>
         </item>
        </layout>
       </widget>
@@ -85,9 +130,46 @@
        <property name="title">
         <string>Stdout</string>
        </property>
-       <layout class="QVBoxLayout" name="verticalLayout_2">
-        <item>
-         <widget class="OutputConsole" name="uiStdout"/>
+       <layout class="QGridLayout" name="gridLayout_2">
+        <item row="1" column="1">
+         <widget class="QPushButton" name="uiRemovePrEditorStyleBTN">
+          <property name="toolTip">
+           <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Reset stylesheet to empty and disable Use PrEditor Style Sheet.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+          </property>
+          <property name="text">
+           <string>Remove Style Sheet</string>
+          </property>
+         </widget>
+        </item>
+        <item row="1" column="0">
+         <widget class="QCheckBox" name="uiUsePrEditorStyleCHK">
+          <property name="toolTip">
+           <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Enable using the stylesheet from the PrEditor instances Options -&amp;gt; Style menu. This OutputConsole doesn't have it enabled by default so it doesn't have the stylesheet applied. Checking this will load the style sheet. If you then uncheck it, the style sheet won't be cleared but it will no longer respect the PrEditor Options -&amp;gt; Style changes.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+          </property>
+          <property name="text">
+           <string>Use PrEditor Style Sheet</string>
+          </property>
+         </widget>
+        </item>
+        <item row="1" column="2">
+         <spacer name="horizontalSpacer">
+          <property name="orientation">
+           <enum>Qt::Horizontal</enum>
+          </property>
+          <property name="sizeHint" stdset="0">
+           <size>
+            <width>40</width>
+            <height>20</height>
+           </size>
+          </property>
+         </spacer>
+        </item>
+        <item row="0" column="0" colspan="3">
+         <widget class="OutputConsole" name="uiStdout">
+          <property name="use_console_stylesheet" stdset="0">
+           <bool>false</bool>
+          </property>
+         </widget>
         </item>
        </layout>
       </widget>

{preditor-2.0.0 → preditor-2.1.0}/preditor/contexts.py

@@ -1,6 +1,8 @@
-from __future__ import absolute_import, print_function
+from __future__ import absolute_import
 
 import logging
+from contextlib import contextmanager
+from typing import List, Tuple
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -60,7 +62,7 @@ class ErrorReport(object):
             memory if there isn't a excepthook calling clearReports.
     """
 
-    __reports__ = []
+    __reports__: List[Tuple[str, str]] = []
     enabled = False
 
     def __init__(self, callback, title=''):
@@ -117,3 +119,92 @@ class ErrorReport(object):
             result = callback()
             ret.append((title, fmt.format(result=result)))
         return ret
+
+
+@contextmanager
+def OverrideConsoleStreams(
+    consoles,
+    tracebacks=None,
+    stdout=None,
+    stderr=None,
+    result=None,
+    logging_handlers=None,
+):
+    """Override a Console's stream and logging_handlers settings.
+
+    This is useful if you don't want to show tracebacks or output for un-related code.
+
+    Example:
+
+        console = OutputConsole()
+        with OverrideConsoleStreams(console, tracebacks=True)
+            # A traceback raised here would show in console
+            do_work_you_only_want_to_show_tracebacks_in_console()
+        raise RuntimeError("This traceback will not be shown in console")
+    """
+    # If a single console was passed, convert it into a list
+    try:
+        iter(consoles)
+    except TypeError:
+        consoles = [consoles]
+
+    # Store the current state and apply changes to the consoles
+    current = []
+    for console in consoles:
+        current.append(
+            (
+                console,
+                None if tracebacks is None else console.stream_echo_tracebacks,
+                None if stdout is None else console.stream_echo_stdout,
+                None if stderr is None else console.stream_echo_stderr,
+                None if result is None else console.stream_echo_result,
+                None if logging_handlers is None else console.logging_handlers,
+            )
+        )
+
+        if tracebacks is not None:
+            # Enable/disable traceback display override
+            console.stream_echo_tracebacks = tracebacks
+            if tracebacks:
+                # traceback display is enabled, make it automatically remove
+                # itself if an exception is raised by the sys.excepthook handler.
+                console._write_error_self_destruct = True
+        if stdout is not None:
+            console.stream_echo_stdout = stdout
+        if stderr is not None:
+            console.stream_echo_stderr = stderr
+        if result is not None:
+            console.stream_echo_result = result
+        if logging_handlers is not None:
+            console.logging_handlers = logging_handlers
+
+    # NOTE: This code is a horrible abomination of necessity.
+    try:
+        yield
+    except Exception:
+        # This is syntactically needed, we don't need to capture the exception,
+        # but the else requires it. We need raise any un-handled exceptions
+        # encountered to allow sys.excepthook to process normally.
+        # This prevents the else code from removing the traceback print overriding
+        # because the else/finally are processed before sys.excepthook is.
+        raise
+    else:
+        # Only called when exception was not raised. Restore the original traceback
+        # and disable the self destructing flag its not needed anymore.
+        for item in current:
+            if tracebacks is not None:
+                item[0].stream_echo_tracebacks = item[1]
+                if tracebacks:
+                    item[0]._write_error_self_destruct = False
+    finally:
+        # Always remove non-traceback options. This is handled before excepthook
+        # so we can just use the simplicity of a normal try/finally statement.
+        for item in current:
+            if stdout is not None:
+                item[0].stream_echo_stdout = item[2]
+            if stderr is not None:
+                item[0].stream_echo_stderr = item[3]
+            if result is not None:
+                item[0].stream_echo_result = item[4]
+            if logging_handlers is not None:
+                item[0].logging_handlers = item[5]

{preditor-2.0.0 → preditor-2.1.0}/preditor/excepthooks.py

@@ -5,7 +5,7 @@ import traceback
 
 from Qt import QtCompat
 
-from . import config, plugins
+from . import config, plugins, utils
 from .contexts import ErrorReport
 from .weakref import WeakList
 
@@ -49,9 +49,7 @@ class PreditorExceptHook(object):
             # prevent showing the traceback normally. This last ditch method prints
             # the traceback to the original stderr stream so it can be debugged.
             # Without this you might get little to no output to work with.
-            print(" PrEditor excepthooks failed ".center(79, "-"), file=sys.__stderr__)
-            traceback.print_exc(file=sys.__stderr__)
-            print(" PrEditor excepthooks failed ".center(79, "-"), file=sys.__stderr__)
+            utils.ShellPrint(True).print_exc("PrEditor excepthooks failed")
 
     def default_excepthooks(self):
         """Returns default excepthooks handlers.
@@ -90,15 +88,7 @@ class PreditorExceptHook(object):
             try:
                 callback(*exc_info)
             except Exception:
-                print(
-                    " PrEditor excepthook callback failed ".center(79, "-"),
-                    file=sys.__stderr__,
-                )
-                traceback.print_exc(file=sys.__stderr__)
-                print(
-                    " PrEditor excepthook callback failed ".center(79, "-"),
-                    file=sys.__stderr__,
-                )
+                utils.ShellPrint(True).print_exc("PrEditor excepthook callback failed")
 
     def ask_to_show_logger(self, *exc_info):
         """Show a dialog asking the user how to handle the error."""

{preditor-2.0.0 → preditor-2.1.0}/preditor/gui/app.py

@@ -117,12 +117,15 @@ class App(object):
             if root_window is None:
                 windows = []
                 dialogs = []
-                for w in inst.topLevelWidgets():
-                    if w.parent() is None:
-                        if isinstance(w, QMainWindow):
-                            windows.append(w)
-                        elif isinstance(w, QDialog):
-                            dialogs.append(w)
+
+                hasTopLevelWidgets = hasattr(QApplication.instance(), "topLevelWidgets")
+                if hasTopLevelWidgets:
+                    for w in inst.topLevelWidgets():
+                        if w.parent() is None:
+                            if isinstance(w, QMainWindow):
+                                windows.append(w)
+                            elif isinstance(w, QDialog):
+                                dialogs.append(w)
                 if windows:
                     root_window = windows[0]
                 elif dialogs:

{preditor-2.0.0 → preditor-2.1.0}/preditor/gui/console.py

@@ -136,8 +136,11 @@ class ConsolePrEdit(ConsoleBase):
 
     def clear(self):
         """clears the text in the editor"""
-        super().clear()
+        super(ConsoleBase, self).clear()
         self.startInputLine()
+        # Note: Don't use the regular `super()` call here as it would result
+        # in multiple calls to repaint, just call the base Qt class's clear.
+        self.maybeRepaint(force=True)
 
     def clearToLastPrompt(self):
         # store the current cursor position so we can restore when we are done