PrEditor 1.0.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

preditor/__init__.py

@@ -184,7 +184,10 @@ def launch(run_workbox=False, app_id=None, name=None, standalone=False):
     # it regain focus.
     widget.activateWindow()
     widget.raise_()
-    widget.setWindowState(widget.windowState() & ~Qt.WindowMinimized | Qt.WindowActive)
+    widget.setWindowState(
+        widget.windowState() & ~Qt.WindowState.WindowMinimized
+        | Qt.WindowState.WindowActive
+    )
     widget.console().setFocus()
     app.start()
 

preditor/about_module.py

@@ -111,10 +111,14 @@ class AboutQt(AboutModule):
             pass
 
         # Add info for all Qt5 bindings that have been imported
-        if 'PyQt5.QtCore' in sys.modules:
-            ret.append('PyQt5: {}'.format(sys.modules['PyQt5.QtCore'].PYQT_VERSION_STR))
+        if 'PySide6.QtCore' in sys.modules:
+            ret.append('PySide6: {}'.format(sys.modules['PySide6.QtCore'].qVersion()))
+        if 'PyQt6.QtCore' in sys.modules:
+            ret.append('PyQt6: {}'.format(sys.modules['PyQt6.QtCore'].PYQT_VERSION_STR))
         if 'PySide2.QtCore' in sys.modules:
             ret.append('PySide2: {}'.format(sys.modules['PySide2.QtCore'].qVersion()))
+        if 'PyQt5.QtCore' in sys.modules:
+            ret.append('PyQt5: {}'.format(sys.modules['PyQt5.QtCore'].PYQT_VERSION_STR))
 
         # Add qt library paths for plugin debugging
         for i, path in enumerate(QtCore.QCoreApplication.libraryPaths()):

preditor/config.py

@@ -48,6 +48,7 @@ class PreditorConfig:
         self._name = None
         self._logging = False
         self._headless_callback = None
+        self._on_create_callback = None
         self._parent_callback = None
         self._error_dialog_class = True
         self._excepthooks = []
@@ -63,6 +64,7 @@ class PreditorConfig:
             f"{' ' * indent}logging: {self.logging}",
             f"{' ' * indent}headless_callback: {self.headless_callback!r}",
             f"{' ' * indent}parent_callback: {self.parent_callback!r}",
+            f"{' ' * indent}on_create_callback: {self.on_create_callback!r}",
         ]
         return '\n'.join(ret)
 
@@ -233,6 +235,20 @@ class PreditorConfig:
             # If the core name was changed attempt to update the logging config.
             self.update_logging()
 
+    @property
+    def on_create_callback(self):
+        """A pointer to a method that is called on LoggerWindow instance create.
+
+        This callback accepts the instance and can be used to customize the
+        LoggerWindow instance when it is first created.
+        """
+        return self._on_create_callback
+
+    @on_create_callback.setter
+    @set_if_unlocked()
+    def on_create_callback(self, cb):
+        self._on_create_callback = cb
+
     @property
     def parent_callback(self):
         """A pointer to a method that is called by `self.root_window`.

preditor/dccs/.hab.json

@@ -0,0 +1,10 @@
+{
+    "name": "preditor",
+    "version": "0.0.dev0",
+    "environment": {
+        "append": {
+            "MAYA_MODULE_PATH": "{relative_root}/maya",
+            "ADSK_APPLICATION_PLUGINS": "{relative_root}/studiomax"
+        }
+    }
+}

preditor/dccs/maya/PrEditor_maya.mod

@@ -1,2 +1 @@
 + PrEditor DEVELOPMENT .
-PYTHONPATH +:= ../..

preditor/dccs/maya/README.md

@@ -0,0 +1,22 @@
+# Maya Integration
+
+This is an example of using an Maya module to add PrEditor into Maya. This adds
+a PrEditor menu with a PrEditor action in Maya's menu bar letting you open PrEditor. It
+adds the excepthook so if a python exception is raised it will prompt the user
+to show PrEditor. PrEditor will show all python stdout/stderr output generated
+after the plugin is loaded.
+
+# Setup
+
+Make sure to follow these [setup instructions](/preditor/README.md#Setup) first to create the virtualenv.
+
+Alternatively you can use [myapy's](https://help.autodesk.com/view/MAYAUL/2026/ENU/?guid=GUID-72A245EC-CDB4-46AB-BEE0-4BBBF9791627) pip to install the requirements, but a
+separate virtualenv is recommended. This method should not require setting the
+`PREDITOR_SITE` environment variable even if you use an editable install.
+
+# Use
+
+The [preditor/dccs/maya](/preditor/dccs/maya) directory is setup as a Maya Module. To load it in
+maya add the full path to that directory to the `MAYA_MODULE_PATH` environment
+variable. You can use `;` on windows and `:` on linux to join multiple paths together.
+You will need to enable auto load for the `PrEditor_maya.py` plugin.

preditor/dccs/maya/plug-ins/PrEditor_maya.py

@@ -1,5 +1,9 @@
 from __future__ import absolute_import
 
+import os
+import site
+from pathlib import Path
+
 import maya.mel
 from maya import OpenMayaUI, cmds
 
@@ -35,12 +39,39 @@ def launch(ignored):
     return widget
 
 
+def update_site():
+    """Adds a site dir to python. This makes its contents importable to python.
+
+    This includes making any editable installs located in that site-packages folder
+    accessible to this python instance. This does not activate the virtualenv.
+
+    If the env var `PREDITOR_SITE` is set, this path is used. Otherwise the
+    parent directory of preditor is used.
+
+    - `PREDITOR_SITE` is useful if you want to use an editable install of preditor
+    for development. This should point to a virtualenv's site-packages folder.
+    - Otherwise if the virtualenv has a regular pip install of preditor you can
+    skip setting the env var.
+    """
+    venv_path = os.getenv("PREDITOR_SITE")
+    # If the env var is not defined then use the parent dir of this preditor package.
+    if venv_path is None:
+        venv_path = cmds.moduleInfo(moduleName="PrEditor", path=True)
+        venv_path = Path(venv_path).parent.parent.parent
+        venv_path = str(venv_path)
+
+    print(f"Preditor is adding python site: {venv_path}")
+    site.addsitedir(venv_path)
+
+
 def initializePlugin(mobject):  # noqa: N802
     """Initialize the script plug-in"""
     global preditor_menu
 
     # If running headless, there is no need to build a gui and create the python logger
     if not headless():
+        update_site()
+
         from Qt.QtWidgets import QApplication
 
         import preditor
@@ -67,7 +98,7 @@ def initializePlugin(mobject):  # noqa: N802
         gmainwindow = maya.mel.eval("$temp1=$gMainWindow")
         preditor_menu = cmds.menu(label="PrEditor", parent=gmainwindow, tearOff=True)
         cmds.menuItem(
-            label="Show",
+            label="PrEditor",
             command=launch,
             sourceType="python",
             image=preditor.resourcePath('img/preditor.png'),

preditor/dccs/studiomax/PackageContents.xml

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="utf-8"?>
+<ApplicationPackage
+    SchemaVersion="1.0"
+    AutodeskProduct="3ds Max"
+    ProductType="Application"
+    Name="PrEditor"
+    Description="Initialize PrEditor inside 3ds Max."
+    AppVersion="0.0.1"
+    ProductCode="{7b1e4ece-9a30-4afb-99ed-b9fb7c23e2f9}"
+    UpgradeCode="{2d245bb4-19cf-4f90-ae19-3ff006ed0f48}">
+    <CompanyDetails Name="Blur Studio" Email="opensource@blur.com"/>
+    <Components Description="pre-start-up scripts parts">
+        <RuntimeRequirements OS="Win64" Platform="3ds Max" SeriesMin="2025" SeriesMax="2026" />
+        <ComponentEntry ModuleName="./preditor.ms" />
+    </Components>
+    <Components Description="macroscripts parts">
+        <RuntimeRequirements OS="Win64" Platform="3ds Max" SeriesMin="2025" SeriesMax="2026" />
+        <ComponentEntry ModuleName="./PrEditor-PrEditor_Show.mcr" />
+    </Components>
+    <Components Description="menu parts">
+        <RuntimeRequirements OS="Win64" Platform="3ds Max" SeriesMin="2025" SeriesMax="2026" />
+        <ComponentEntry ModuleName="./preditor_menu.mnx" />
+    </Components>
+    <Components Description="light icon paths parts">
+        <RuntimeRequirements OS="Win64" Platform="3ds Max" SeriesMin="2025" SeriesMax="2026" />
+        <ComponentEntry AppName="lighticons" Version="1.0.0" ModuleName="../../resource/img" />
+    </Components>
+    <Components Description="dark icon paths parts">
+        <RuntimeRequirements OS="Win64" Platform="3ds Max" SeriesMin="2025" SeriesMax="2026" />
+        <ComponentEntry AppName="darkicons" Version="1.0.0" ModuleName="../../resource/img" />
+    </Components>
+</ApplicationPackage>

preditor/dccs/studiomax/PrEditor-PrEditor_Show.mcr

@@ -0,0 +1,8 @@
+macroScript PrEditor_Show
+category:"PrEditor"
+tooltip:"PrEditor..."
+IconName:"preditor.ico"
+(
+    local preditor = python.import "preditor"
+    preditor.launch()
+)

preditor/dccs/studiomax/README.md

@@ -0,0 +1,17 @@
+# 3ds Max Integration
+
+This is an example of using an Autodesk Application Package to load PrEditor into
+3ds Max. This adds a PrEditor item to the Scripting menu in 3ds Max's menu bar
+to show PrEditor. It adds the excepthook so if a python exception is raised
+it will prompt the user to show PrEditor. PrEditor will show all python stdout/stderr
+output generated after the plugin is loaded.
+
+# Setup
+
+Make sure to follow these [setup instructions](/preditor/README.md#Setup) first to create the virtualenv.
+
+# Use
+
+The [preditor/dccs/studiomax](/preditor/dccs/studiomax) directory is setup as a 3ds Max Application Plugin.
+To load it in 3ds Max add the full path to that directory to the `ADSK_APPLICATION_PLUGINS` environment
+variable. You can use `;` on windows and `:` on linux to join multiple paths together.

preditor/dccs/studiomax/preditor.ms

@@ -0,0 +1,16 @@
+
+function configure_preditor = (
+    local pysite = python.import "site"
+    local WinEnv = dotNetClass "System.Environment"
+    -- If the env var PREDITOR_SITE is set, add its packages to python
+    local venv_path = WinEnv.GetEnvironmentVariable "PREDITOR_SITE"
+    if venv_path != undefined do (
+        print("Preditor is adding python site: " + venv_path)
+        pysite.addsitedir venv_path
+    )
+    -- Configure preditor, adding excepthook etc.
+    local preditor = python.import "preditor"
+    preditor.configure "studiomax"
+)
+
+configure_preditor()

preditor/dccs/studiomax/preditor_menu.mnx

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<MaxMenuTransformations>
+    <CreateMenuSeparator MenuId="658724ec-de09-47dd-b723-918c59a28ad1" Id="9cdc28de-9e70-471c-ae5c-d86e3b7fefba" BeforeId="4e206a37-f502-4fa8-ba0e-70dd427d507f"/>
+    <MoveItem DestinationId="658724ec-de09-47dd-b723-918c59a28ad1" ItemId="4e206a37-f502-4fa8-ba0e-70dd427d507f"/>
+    <CreateMenuAction MenuId="658724ec-de09-47dd-b723-918c59a28ad1" Id="f243229b-f0f6-42b4-a94d-bebe9ef9777f" ActionId="647394-PrEditor_Show`PrEditor"/>
+    <MoveItem DestinationId="658724ec-de09-47dd-b723-918c59a28ad1" ItemId="9cdc28de-9e70-471c-ae5c-d86e3b7fefba" BeforeId="f243229b-f0f6-42b4-a94d-bebe9ef9777f"/>
+</MaxMenuTransformations>

preditor/debug.py

@@ -21,11 +21,15 @@ class FileLogger:
         """Removes the contents of the log file."""
         open(self._logfile, 'w').close()
         if stamp:
-            msg = '--------- Date: {today} Version: {version} ---------'
-            print(msg.format(today=datetime.datetime.today(), version=sys.version))
+            print(self.stamp())
 
     def flush(self):
-        self._stdhandle.flush()
+        if self._stdhandle:
+            self._stdhandle.flush()
+
+    def stamp(self):
+        msg = '--------- Date: {today} Version: {version} ---------'
+        return msg.format(today=datetime.datetime.today(), version=sys.version)
 
     def write(self, msg):
         f = open(self._logfile, 'a')

preditor/excepthooks.py

@@ -15,10 +15,8 @@ class PreditorExceptHook(object):
     This calls each callable in the `preditor.config.excepthooks` list any time
     `sys.excepthook` is called due to an raised exception.
 
-    If `config.excepthook` is empty when installing this class, it will
-    automatically add the `call_base_excepthook` and `ask_to_show_logger` methods.
-    This enables showing the excepthook in parent streams and prompting the user
-    to show PrEditor when an error happens. You can disable this by adding `None`
+    If `config.excepthooks` is empty when installing this class, it will
+    automatically add `default_excepthooks`. You can disable this by adding `None`
     to the list before this class is initialized.
     """
 
@@ -27,8 +25,7 @@ class PreditorExceptHook(object):
 
         # Add the default excepthooks
         if not config.excepthooks and config.excepthooks != [None]:
-            config.excepthooks.append(self.call_base_excepthook)
-            config.excepthooks.append(self.ask_to_show_logger)
+            config.excepthooks.extend(self.default_excepthooks())
 
     def __call__(self, *exc_info):
         """Run when an exception is raised and calls all `config.excepthooks`."""
@@ -40,6 +37,18 @@ class PreditorExceptHook(object):
         # Clear any ErrorReports that were generated by this exception handling
         ErrorReport.clearReports()
 
+    def default_excepthooks(self):
+        """Returns default excepthooks handlers.
+
+        This includes the `call_base_excepthook` and `ask_to_show_logger` methods.
+        They enables showing the excepthook in parent streams and prompting the user
+        to show PrEditor when an error happens.
+        """
+        return [
+            self.call_base_excepthook,
+            self.ask_to_show_logger,
+        ]
+
     def call_base_excepthook(self, *exc_info):
         """Process `base_excepthook` supplied during object instantiation.
 

preditor/gui/app.py

@@ -93,7 +93,7 @@ class App(object):
         Returns:
             args: Extend the arguments used to intialize the QApplication.
         """
-        if settings.OS_TYPE == "Windows" and Qt.IsPyQt5:
+        if settings.OS_TYPE == "Windows" and (Qt.IsPyQt6 or Qt.IsPyQt5):
             # Make Qt automatically scale based on the monitor the window is
             # currently located.
             return ["--platform", "windows:dpiawareness=0"]
@@ -157,4 +157,4 @@ class App(object):
         """Exec's the QApplication if it hasn't already been started."""
         if self.app_created and self.app and not self.app_has_exec:
             self.app_has_exec = True
-            self.app.exec_()
+            Qt.QtCompat.QApplication.exec_()

preditor/gui/codehighlighter.py

@@ -4,7 +4,6 @@ import json
 import os
 import re
 
-from Qt.QtCore import QRegExp
 from Qt.QtGui import QColor, QSyntaxHighlighter, QTextCharFormat
 
 from .. import resourcePath
@@ -68,59 +67,46 @@ class CodeHighlighter(QSyntaxHighlighter):
             if parent and hasattr(parent, 'outputPrompt'):
                 self.highlightText(
                     text,
-                    QRegExp('%s[^\\n]*' % re.escape(parent.outputPrompt())),
+                    re.compile('%s[^\\n]*' % re.escape(parent.outputPrompt())),
                     format,
                 )
 
             # format the keywords
             format = self.keywordFormat()
             for kwd in self._keywords:
-                self.highlightText(text, QRegExp(r'\b%s\b' % kwd), format)
+                self.highlightText(text, re.compile(r'\b%s\b' % kwd), format)
 
             # format the strings
             format = self.stringFormat()
+
             for string in self._strings:
                 self.highlightText(
                     text,
-                    QRegExp('%s[^%s]*' % (string, string)),
+                    re.compile('{s}[^{s}]*{s}'.format(s=string)),
                     format,
-                    includeLast=True,
                 )
 
             # format the comments
             format = self.commentFormat()
             for comment in self._comments:
-                self.highlightText(text, QRegExp(comment), format)
+                self.highlightText(text, re.compile(comment), format)
 
     def highlightText(self, text, expr, format, offset=0, includeLast=False):
         """Highlights a text group with an expression and format
 
         Args:
             text (str): text to highlight
-            expr (QRegExp): search parameter
+            expr (QRegularExpression): search parameter
             format (QTextCharFormat): formatting rule
-            offset (int): number of characters to offset by when highlighting
             includeLast (bool): whether or not the last character should be highlighted
         """
-        pos = expr.indexIn(text, 0)
-
         # highlight all the given matches to the expression in the text
-        while pos != -1:
-            pos = expr.pos(offset)
-            length = len(expr.cap(offset))
-
-            # use the last character if desired
+        for match in expr.finditer(text):
+            start, end = match.span()
+            length = end - start
             if includeLast:
                 length += 1
-
-            # set the formatting
-            self.setFormat(pos, length, format)
-
-            matched = expr.matchedLength()
-            if includeLast:
-                matched += 1
-
-            pos = expr.indexIn(text, pos + matched)
+            self.setFormat(start, length, format)
 
     def keywordColor(self):
         # pull the color from the parent if possible because this doesn't support

preditor/gui/completer.py

@@ -5,6 +5,7 @@ import re
 import sys
 from enum import Enum
 
+import Qt as Qt_py
 from Qt.QtCore import QRegExp, QSortFilterProxyModel, QStringListModel, Qt
 from Qt.QtGui import QCursor, QTextCursor
 from Qt.QtWidgets import QCompleter, QToolTip
@@ -63,12 +64,16 @@ class PythonCompleter(QCompleter):
 
     def setCaseSensitive(self, caseSensitive=True):
         """Set case sensitivity for completions"""
-        self._sensitivity = Qt.CaseSensitive if caseSensitive else Qt.CaseInsensitive
+        self._sensitivity = (
+            Qt.CaseSensitivity.CaseSensitive
+            if caseSensitive
+            else Qt.CaseSensitivity.CaseInsensitive
+        )
         self.buildCompleter()
 
     def caseSensitive(self):
         """Return current case sensitivity state for completions"""
-        caseSensitive = self._sensitivity == Qt.CaseSensitive
+        caseSensitive = self._sensitivity == Qt.CaseSensitivity.CaseSensitive
         return caseSensitive
 
     def setCompleterMode(self, completerMode=CompleterMode.STARTS_WITH):
@@ -89,7 +94,7 @@ class PythonCompleter(QCompleter):
         self.filterModel.setSourceModel(model)
         self.filterModel.setFilterCaseSensitivity(self._sensitivity)
         self.setModel(self.filterModel)
-        self.setCompletionMode(QCompleter.UnfilteredPopupCompletion)
+        self.setCompletionMode(QCompleter.CompletionMode.UnfilteredPopupCompletion)
 
     def currentObject(self, scope=None, docMode=False):
         if self._enabled:
@@ -155,8 +160,14 @@ class PythonCompleter(QCompleter):
         if self._completerMode == CompleterMode.FULL_FUZZY:
             regExStr = ".*".join(prefix)
 
-        regexp = QRegExp(regExStr, self._sensitivity)
-        self.filterModel.setFilterRegExp(regexp)
+        if Qt_py.IsPyQt6 or Qt_py.IsPySide6:
+            regexp = QRegExp(regExStr)
+            if self._sensitivity:
+                regexp.setPatternOptions(QRegExp.PatternOption.CaseInsensitiveOption)
+            self.filterModel.setFilterRegularExpression(regexp)
+        else:
+            regexp = QRegExp(regExStr, self._sensitivity)
+            self.filterModel.setFilterRegExp(regexp)
 
     def clear(self):
         self.popup().hide()
@@ -193,7 +204,7 @@ class PythonCompleter(QCompleter):
         """pulls out the text underneath the cursor of this items widget"""
 
         cursor = self.widget().textCursor()
-        cursor.select(QTextCursor.WordUnderCursor)
+        cursor.select(QTextCursor.SelectionType.WordUnderCursor)
 
         # grab the selected word
         word = cursor.selectedText()