PrEditor 0.10.0__tar.gz → 1.1.0__tar.gz

{preditor-0.10.0 → preditor-1.1.0}/.github/workflows/static-analysis-and-test.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install tox
+          python -m pip install tox coverage[toml]
 
       - name: Lint with flake8
         run: tox -e flake8
@@ -35,9 +35,6 @@ jobs:
       - name: Format with black
         run: tox -e black
 
-      - name: Py 2 and 3 compatibility
-        run: tox -e modernize
-
 
   test:
     # We want to run on external PRs, but not on our own internal PRs as they'll
@@ -49,9 +46,9 @@ jobs:
 
     strategy:
       matrix:
-        os: ['ubuntu-latest']
+        os: ['ubuntu-latest', 'windows-latest']
         python: ['3.8', '3.9', '3.10', '3.11']
-        # Works around the depreciation of python 3.6, 3.7 for ubuntu
+        # Works around the depreciation of python 3.7 for ubuntu
         # https://github.com/actions/setup-python/issues/544
         include:
           - os: 'ubuntu-22.04'
@@ -85,7 +82,6 @@ jobs:
           include-hidden-files: true
           retention-days: 1
 
-
   coverage:
     # We want to run on external PRs, but not on our own internal PRs as they'll
     # be run by the push to the branch. Without this if check, checks are

{preditor-0.10.0 → preditor-1.1.0}/.pre-commit-config.yaml

@@ -1,4 +1,8 @@
 ---
+ci:
+  autoupdate_schedule: quarterly
+  skip: [black, flake8]
+
 repos:
 
 -   repo: https://github.com/psf/black
@@ -12,14 +16,9 @@ repos:
     -   id: flake8
         additional_dependencies:
             - flake8-bugbear==22.12.6
+            - Flake8-pyproject
             - pep8-naming==0.13.3
 
--   repo: https://github.com/asottile/setup-cfg-fmt
-    rev: v2.2.0
-    hooks:
-    -   id: setup-cfg-fmt
-        args: [--min-py3-version=3.6]
-
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
     hooks:

{preditor-0.10.0 → preditor-1.1.0}/CONTRIBUTING.md

@@ -56,7 +56,7 @@ A set of GitHub Action workflows are in place to perform the following style and
 
 **Styling**
 
-Styling or linting is performed via [flake8] along with the plugins [flake8-bugbear] & [pep8-naming]. A minor amount of configuration has been added to _[setup.cfg]_ in order to provide better compatibility with our formatter black (see next section).
+Styling or linting is performed via [flake8] along with the plugins [flake8-bugbear], [Flake8-pyproject] & [pep8-naming]. A minor amount of configuration has been added to _[pyproject.toml]_ in order to provide better compatibility with our formatter black (see next section).
 
 **Formatting**
 
@@ -69,8 +69,9 @@ Releases are made manually by project managers and will automatically be uploade
 
 [flake8]: https://github.com/PyCQA/flake8
 [flake8-bugbear]: https://github.com/PyCQA/flake8-bugbear
+[Flake8-pyproject]: https://github.com/john-hen/Flake8-pyproject
 [pep8-naming]: https://github.com/PyCQA/pep8-naming
-[setup.cfg]: https://github.com/blurstudio/preditor/blob/master/setup.cfg
+[pyproject.toml]: https://github.com/blurstudio/hab/blob/master/pyproject.toml
 [black]: https://github.com/psf/black
 [Issues]: https://github.com/blurstudio/preditor/issues
 [create a new issue]: https://github.com/blurstudio/preditor/issues/new

{preditor-0.10.0 → preditor-1.1.0}/PKG-INFO

@@ -1,39 +1,40 @@
 Metadata-Version: 2.4
 Name: PrEditor
-Version: 0.10.0
+Version: 1.1.0
 Summary: A python REPL and Editor and console based on Qt.
-Home-page: https://github.com/blurstudio/PrEditor.git
-Author: Blur Studio
-Author-email: opensource@blur.com
+Author-email: Blur Studio <opensource@blur.com>
 License: LGPL-3.0
+Project-URL: Homepage, https://github.com/blurstudio/PrEditor
+Project-URL: Source, https://github.com/blurstudio/PrEditor
+Project-URL: Tracker, https://github.com/blurstudio/PrEditor/issues
 Platform: any
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: !=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,>=2.7
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: Qt.py
 Requires-Dist: configparser>=4.0.2
 Requires-Dist: future>=0.18.2
-Requires-Dist: python-redmine>=2.1.1
 Requires-Dist: signalslot>=0.1.2
-Requires-Dist: importlib-metadata>=4.8.3; python_version >= "3.6"
+Requires-Dist: importlib-metadata>=4.8.3
 Provides-Extra: cli
 Requires-Dist: click>=7.1.2; extra == "cli"
 Requires-Dist: click-default-group; extra == "cli"
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
+Requires-Dist: build; extra == "dev"
 Requires-Dist: covdefaults; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
 Requires-Dist: flake8; extra == "dev"
 Requires-Dist: flake8-bugbear; extra == "dev"
+Requires-Dist: Flake8-pyproject; extra == "dev"
 Requires-Dist: pep8-naming; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: tox; extra == "dev"
@@ -127,6 +128,12 @@ preditor.launch()
 preditor.shutdown()
 ```
 
+Up to the point where the PrEditor instance is created you can update the config
+data set by `preditor.configure`. For example you can change the name(used to load
+a set of user prefs) by calling `preditor.config.name = 'NewName'`. This is useful
+for configuring PrEditor before you import your specific setup code that implements
+a better `parent_callback`.
+
 # Installing
 
 `pip install preditor`
@@ -165,8 +172,7 @@ The more mature QScintilla workbox requires a few extra dependencies that must
 be passed manually. It hasn't been added to `extras_require` because we plan to
 split it into its own pip module due to it requiring PyQt5 which is a little hard
 to get working inside of DCC's that ship with PySide2 by default. Here is the
-python 3 pip install command(For python 2 you will need to compile QScintilla
-yourself.)
+python 3 pip install command.
 
 - `pip install preditor PyQt5, QScintilla>=2.11.4 aspell-python-py3`
 

{preditor-0.10.0 → preditor-1.1.0}/PrEditor.egg-info/PKG-INFO

@@ -1,39 +1,40 @@
 Metadata-Version: 2.4
 Name: PrEditor
-Version: 0.10.0
+Version: 1.1.0
 Summary: A python REPL and Editor and console based on Qt.
-Home-page: https://github.com/blurstudio/PrEditor.git
-Author: Blur Studio
-Author-email: opensource@blur.com
+Author-email: Blur Studio <opensource@blur.com>
 License: LGPL-3.0
+Project-URL: Homepage, https://github.com/blurstudio/PrEditor
+Project-URL: Source, https://github.com/blurstudio/PrEditor
+Project-URL: Tracker, https://github.com/blurstudio/PrEditor/issues
 Platform: any
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: !=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,>=2.7
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: Qt.py
 Requires-Dist: configparser>=4.0.2
 Requires-Dist: future>=0.18.2
-Requires-Dist: python-redmine>=2.1.1
 Requires-Dist: signalslot>=0.1.2
-Requires-Dist: importlib-metadata>=4.8.3; python_version >= "3.6"
+Requires-Dist: importlib-metadata>=4.8.3
 Provides-Extra: cli
 Requires-Dist: click>=7.1.2; extra == "cli"
 Requires-Dist: click-default-group; extra == "cli"
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
+Requires-Dist: build; extra == "dev"
 Requires-Dist: covdefaults; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
 Requires-Dist: flake8; extra == "dev"
 Requires-Dist: flake8-bugbear; extra == "dev"
+Requires-Dist: Flake8-pyproject; extra == "dev"
 Requires-Dist: pep8-naming; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: tox; extra == "dev"
@@ -127,6 +128,12 @@ preditor.launch()
 preditor.shutdown()
 ```
 
+Up to the point where the PrEditor instance is created you can update the config
+data set by `preditor.configure`. For example you can change the name(used to load
+a set of user prefs) by calling `preditor.config.name = 'NewName'`. This is useful
+for configuring PrEditor before you import your specific setup code that implements
+a better `parent_callback`.
+
 # Installing
 
 `pip install preditor`
@@ -165,8 +172,7 @@ The more mature QScintilla workbox requires a few extra dependencies that must
 be passed manually. It hasn't been added to `extras_require` because we plan to
 split it into its own pip module due to it requiring PyQt5 which is a little hard
 to get working inside of DCC's that ship with PySide2 by default. Here is the
-python 3 pip install command(For python 2 you will need to compile QScintilla
-yourself.)
+python 3 pip install command.
 
 - `pip install preditor PyQt5, QScintilla>=2.11.4 aspell-python-py3`
 

{preditor-0.10.0 → preditor-1.1.0}/PrEditor.egg-info/SOURCES.txt

@@ -8,8 +8,6 @@ MANIFEST.in
 README.md
 pyproject.toml
 requirements.txt
-setup.cfg
-setup.py
 tox.ini
 .github/PULL_REQUEST_TEMPLATE.md
 .github/ISSUE_TEMPLATE/BUG_REPORT.md
@@ -28,9 +26,11 @@ preditor/__init__.py
 preditor/__main__.py
 preditor/about_module.py
 preditor/cli.py
+preditor/config.py
 preditor/contexts.py
 preditor/debug.py
 preditor/enum.py
+preditor/excepthooks.py
 preditor/logging_config.py
 preditor/osystem.py
 preditor/plugins.py
@@ -60,7 +60,6 @@ preditor/gui/logger_window_handler.py
 preditor/gui/logger_window_plugin.py
 preditor/gui/loggerwindow.py
 preditor/gui/newtabwidget.py
-preditor/gui/redmine_login_dialog.py
 preditor/gui/set_text_editor_path_dialog.py
 preditor/gui/status_label.py
 preditor/gui/suggest_path_quotes_dialog.py
@@ -79,7 +78,6 @@ preditor/gui/ui/editor_chooser.ui
 preditor/gui/ui/errordialog.ui
 preditor/gui/ui/find_files.ui
 preditor/gui/ui/loggerwindow.ui
-preditor/gui/ui/redmine_login_dialog.ui
 preditor/gui/ui/set_text_editor_path_dialog.ui
 preditor/gui/ui/suggest_path_quotes_dialog.ui
 preditor/resource/environment_variables.html
@@ -176,6 +174,9 @@ preditor/utils/__init__.py
 preditor/utils/cute.py
 preditor/utils/stylesheets.py
 preditor/utils/text_search.py
+tests/conftest.py
+tests/test_config.py
+tests/test_prefs.py
 tests/test_stream.py
 tests/find_files/re_greedy_False_0_True.md
 tests/find_files/re_greedy_False_2_True.md

{preditor-0.10.0 → preditor-1.1.0}/PrEditor.egg-info/requires.txt

@@ -1,10 +1,7 @@
 Qt.py
 configparser>=4.0.2
 future>=0.18.2
-python-redmine>=2.1.1
 signalslot>=0.1.2
-
-[:python_version >= "3.6"]
 importlib-metadata>=4.8.3
 
 [cli]
@@ -13,10 +10,12 @@ click-default-group
 
 [dev]
 black
+build
 covdefaults
 coverage
 flake8
 flake8-bugbear
+Flake8-pyproject
 pep8-naming
 pytest
 tox

{preditor-0.10.0 → preditor-1.1.0}/README.md

@@ -84,6 +84,12 @@ preditor.launch()
 preditor.shutdown()
 ```
 
+Up to the point where the PrEditor instance is created you can update the config
+data set by `preditor.configure`. For example you can change the name(used to load
+a set of user prefs) by calling `preditor.config.name = 'NewName'`. This is useful
+for configuring PrEditor before you import your specific setup code that implements
+a better `parent_callback`.
+
 # Installing
 
 `pip install preditor`
@@ -122,8 +128,7 @@ The more mature QScintilla workbox requires a few extra dependencies that must
 be passed manually. It hasn't been added to `extras_require` because we plan to
 split it into its own pip module due to it requiring PyQt5 which is a little hard
 to get working inside of DCC's that ship with PySide2 by default. Here is the
-python 3 pip install command(For python 2 you will need to compile QScintilla
-yourself.)
+python 3 pip install command.
 
 - `pip install preditor PyQt5, QScintilla>=2.11.4 aspell-python-py3`
 

{preditor-0.10.0 → preditor-1.1.0}/examples/add_to_app.py

@@ -41,9 +41,9 @@ if __name__ == '__main__':
         # specific to this application.
         'add_to_app',
     )
-    import preditor.debug
+    import preditor.excepthooks
 
-    preditor.debug.BlurExcepthook.install()
+    preditor.excepthooks.PreditorExceptHook.install()
 
     # Create a Gui Application allowing the user to show PrEditor
     app = QApplication(sys.argv)

{preditor-0.10.0 → preditor-1.1.0}/preditor/__init__.py

@@ -1,20 +1,19 @@
 from __future__ import absolute_import, print_function
 
-import logging  # noqa: E402
-import os  # noqa: E402
-import sys  # noqa: E402
+import logging
+import os
+import sys
 
-from Qt.QtCore import Qt  # noqa: E402
+from Qt.QtCore import Qt
 
-from . import osystem  # noqa: E402
-from .plugins import Plugins  # noqa: E402
-from .version import version as __version__  # noqa: E402,F401
+from . import osystem
+from .config import PreditorConfig
+from .plugins import Plugins
+from .version import version as __version__
 
 DEFAULT_CORE_NAME = "PrEditor"
 """The default name to use for the core name."""
 
-_global_config = {}
-
 core = None  # create a managed Core instance
 """
 The blurdev managed :class:`Core` object from the :mod:`blurdev.cores` module.
@@ -31,6 +30,11 @@ _logger.addHandler(logging.NullHandler())
 
 plugins = Plugins()
 
+config = PreditorConfig()
+"""This config is used to setup the instance of PrEditor. It can be edited up
+to the point the instance is created. After that changes will be ignored.
+"""
+
 
 def about_preditor(instance=None):
     """Useful info about installed packages generated by plugins.
@@ -65,7 +69,14 @@ def init():
         plugin()
 
 
-def configure(name, parent_callback=None, excepthook=True, logging=True, streams=True):
+def configure(
+    name,
+    parent_callback=None,
+    excepthook=True,
+    logging=True,
+    streams=True,
+    headless_callback=None,
+):
     """Global configuration of PrEditor. Safe to re-call until the instance is created.
 
     Configures the instance of PrEditor without creating the GUI. It should be run
@@ -73,6 +84,10 @@ def configure(name, parent_callback=None, excepthook=True, logging=True, streams
     show as much stdout/err text as possible even the text printed before the
     application's GUI is created.
 
+    This is a convenience method that sets useful defaults on `preditor.config`.
+    You can directly set the values on there instead of calling this function.
+    If you use that make sure to enable each feature as it doesn't by default.
+
     Once `preditor.instance(create=True)` is called this will return without
     making any changes. Otherwise unless noted with "First call only." each time
     this function is called it will update any previously set values. This allows
@@ -101,44 +116,25 @@ def configure(name, parent_callback=None, excepthook=True, logging=True, streams
             LoggerWindow will show all of the captured text. This lets you only
             create the LoggerWindow IF you need to show it, but when you do it
             will have all of the std stream text written after this call.
+        headless_callback (callable, optional): Callback that returns a bool
+            indicating if PrEditor should attempt to create GUI elements.
     """
-    # Once the UI instance has been created, configure should not do anything.
-    if instance(create=False):
-        return
-
-    # Store the core_name.
-    changed = _global_config.get('core_name') != name
-    _global_config['core_name'] = name
-    if parent_callback:
-        _global_config['parent_callback'] = parent_callback
-
-    if streams and not _global_config.get('streams_installed'):
-        # Install the stream manager to capture output
-        from preditor.stream import install_to_std
-
-        install_to_std()
-        _global_config['streams_installed'] = True
-
-    if logging and changed:
-        # Only update the logging config if the core name has changed.
-        # Note: When called repeatedly, this won't remove old logger's added by
-        # the previous calls so you may see some loggers added that were never
-        # actually added by code other than the LoggingConfig.
-        from .logging_config import LoggingConfig
-
-        cfg = LoggingConfig(core_name=name)
-        cfg.load()
-
-    if excepthook and not _global_config.get('excepthook_installed'):
-        import preditor.debug
-
-        preditor.debug.BlurExcepthook.install()
-        _global_config['excepthook_installed'] = True
+    # The name should always be set first. The logging setting depends on it,
+    # and the others may depend on it in the future.
+    config.name = name
+    config.logging = logging
+    # Capture stdout/err streams and install the excepthook so we start capturing
+    # output as early as possible if enabled.
+    config.streams = streams
+    config.excepthook = excepthook
+    # These will be used to create the GUI instance if PrEditor needs shown.
+    config.parent_callback = parent_callback
+    config.headless_callback = headless_callback
 
 
 def get_core_name():
     """Returns the configured core_name or DEFAULT_CORE_NAME."""
-    return _global_config.get('core_name', DEFAULT_CORE_NAME)
+    return config.name
 
 
 def launch(run_workbox=False, app_id=None, name=None, standalone=False):
@@ -164,11 +160,11 @@ def launch(run_workbox=False, app_id=None, name=None, standalone=False):
     if name is None:
         # If the name wasn't passed we will get it from the name stored when
         # configure was called.
-        if 'core_name' not in _global_config:
+        if config.name is None:
             raise RuntimeError(
                 "You call configure before calling launch if not passing name"
             )
-        name = _global_config['core_name']
+        name = config.name
     else:
         # A name was provided, call configure to ensure it has been called
         configure(name=name)
@@ -241,17 +237,6 @@ def resourcePath(relpath=''):
     return os.path.join(relativePath(__file__), 'resource', relpath)
 
 
-def root_window():
-    # If a parent widget callback was configured, use it
-    if 'parent_callback' in _global_config:
-        return _global_config['parent_callback']()
-
-    # Otherwise, attempt to find the top level widget from Qt
-    from .gui.app import App
-
-    return App.root_window()
-
-
 def parent_callback():
     """Returns the parent_callback or None.
 
@@ -259,7 +244,7 @@ def parent_callback():
     LoggerWindow when its first created. This can be used by DCC's to set the
     parent to their main window.
     """
-    return _global_config.get("parent_callback")
+    return config.parent_callback
 
 
 def connect_preditor(
@@ -311,9 +296,7 @@ def instance(parent=None, run_workbox=False, create=True):
         than once, the same instance will be returned. If create is False, it may
         return None.
     """
-    from .gui.loggerwindow import LoggerWindow
-
-    return LoggerWindow.instance(parent=parent, run_workbox=run_workbox, create=create)
+    return config.instance(parent=parent, run_workbox=run_workbox, create=create)
 
 
 def shutdown():

{preditor-0.10.0 → preditor-1.1.0}/preditor/about_module.py

@@ -5,7 +5,6 @@ import os
 import sys
 import textwrap
 
-import six
 from future.utils import with_metaclass
 
 import preditor
@@ -52,11 +51,7 @@ class AboutModule(with_metaclass(abc.ABCMeta, object)):
                     text = plug.text()
                 except Exception as error:
                     text = "Error processing: {}".format(error)
-            if six.PY3:
-                text = textwrap.indent(text, cls.indent)
-            else:
-                text = ['{}{}'.format(cls.indent, line) for line in text.split('\n')]
-                text = "\n".join(text)
+            text = textwrap.indent(text, cls.indent)
 
             # Build the output string including the version information if provided.
             if version is not None: