About dialog box: code refactoring with guidata

Author: PierreRaybaut

doc/requirements.rst

@@ -9,9 +9,9 @@ The :mod:`plotpy` package requires the following Python modules:
       - Summary
     * - Python
       - >=3.8, <4
-      - 
+      -
     * - guidata
-      - >=3.0.1
+      - >=3.1
       - Automatic GUI generation for easy dataset editing and display
     * - PythonQwt
       - >=0.10
@@ -23,10 +23,10 @@ The :mod:`plotpy` package requires the following Python modules:
       - >=1.3
       - Fundamental algorithms for scientific computing in Python
     * - Pillow
-      - 
+      -
       - Python Imaging Library (Fork)
     * - tifffile
-      - 
+      -
       - Read and write TIFF files
     * - PyQt5
       - >=5.11
@@ -42,19 +42,19 @@ Optional modules for development:
       - Version
       - Summary
     * - black
-      - 
+      -
       - The uncompromising code formatter.
     * - isort
-      - 
+      -
       - A Python utility / library to sort Python imports.
     * - pylint
-      - 
+      -
       - python code static checker
     * - Coverage
-      - 
+      -
       - Code coverage measurement for Python
     * - Cython
-      - 
+      -
       - The Cython compiler for writing C extensions in the Python language.
 
 Optional modules for building the documentation:
@@ -67,19 +67,19 @@ Optional modules for building the documentation:
       - Version
       - Summary
     * - PyQt5
-      - 
+      -
       - Python bindings for the Qt cross platform application toolkit
     * - sphinx
-      - 
+      -
       - Python documentation generator
     * - sphinx-copybutton
-      - 
+      -
       - Add a copy button to each of your code cells.
     * - sphinx_qt_documentation
-      - 
+      -
       - Plugin for proper resolve intersphinx references for Qt elements
     * - python-docs-theme
-      - 
+      -
       - The Sphinx theme for the CPython docs and related projects
 
 Optional modules for running test suite:
@@ -92,14 +92,14 @@ Optional modules for running test suite:
       - Version
       - Summary
     * - pytest
-      - 
+      -
       - pytest: simple powerful testing with Python
     * - pytest-cov
-      - 
+      -
       - Pytest plugin for measuring coverage.
     * - pytest-qt
-      - 
+      -
       - pytest support for PyQt and PySide applications
     * - pytest-xvfb
-      - 
+      -
       - A pytest plugin to run Xvfb (or Xephyr/Xvnc) for tests.

plotpy/tests/gui/test_simple_window.py

@@ -28,10 +28,7 @@
 from plotpy.builder import make
 from plotpy.config import _
 from plotpy.plot import PlotOptions, PlotWidget
-from plotpy.widgets.about import about
-
-APP_NAME = _("Application example")
-VERSION = "1.0.0"
+from plotpy.widgets import about
 
 
 class ImageParam(DataSet):
@@ -168,8 +165,8 @@ def __init__(self):
 
     def setup(self):
         """Setup window parameters"""
-        self.setWindowIcon(get_icon("python.png"))
-        self.setWindowTitle(APP_NAME)
+        self.setWindowIcon(get_icon("plotpy.svg"))
+        self.setWindowTitle(_("Application example"))
         self.resize(QC.QSize(600, 800))
 
         # Welcome message in statusbar:
@@ -210,7 +207,7 @@ def setup(self):
             self,
             _("About..."),
             icon=get_std_icon("MessageBoxInformation"),
-            triggered=self.about,
+            triggered=lambda parent=self: about.show_about_dialog(parent),
         )
         add_actions(help_menu, (about_action,))
 
@@ -222,21 +219,6 @@ def setup(self):
         self.mainwidget = CentralWidget(self, toolbar)
         self.setCentralWidget(self.mainwidget)
 
-    # ------?
-    def about(self):
-        """About box"""
-        QW.QMessageBox.about(
-            self,
-            _("About ") + APP_NAME,
-            "<b>{}</b> v{}"
-            "<p>{} Pierre Raybaut<br><br>{}".format(
-                APP_NAME,
-                VERSION,
-                _("Developped by"),
-                about(html=True, copyright_only=True),
-            ),
-        )
-
     # ------I/O
     def new_image(self):
         """Create a new image"""

plotpy/tools/misc.py

@@ -22,7 +22,7 @@
     get_plot_qrect,
 )
 from plotpy.tools.base import CommandTool, DefaultToolbarID, RectangularActionTool
-from plotpy.widgets.about import about
+from plotpy.widgets import about
 from plotpy.widgets.resizedialog import ResizeDialog
 
 
@@ -260,8 +260,7 @@ def __init__(self, manager, toolbar_id=DefaultToolbarID):
 
     def activate_command(self, plot, checked):
         """Activate tool"""
-
-        QW.QMessageBox.about(plot, _("About") + " plotpy", about(html=True))
+        about.show_about_dialog(plot)
 
 
 class PrintTool(CommandTool):

plotpy/widgets/about.py

@@ -5,31 +5,45 @@
 
 """
 
-import platform
-import sys
+from __future__ import annotations
 
-from qtpy import QtCore as QC
-from qwt import QWT_VERSION_STR
+import guidata
+import qwt
+from guidata.widgets.about import get_general_infos
+from qtpy.QtWidgets import QMessageBox, QWidget
 
 import plotpy
+from plotpy.config import _
 
 
-def about(html=True, copyright_only=False):
-    """Return text about this package"""
-    python_version = "{} {}".format(
-        platform.python_version(), "64 bits" if sys.maxsize > 2**32 else "32 bits"
-    )
+def about(html: bool = True, copyright_only: bool = False) -> str:
+    """Return text about this package
+
+    Args:
+        html: return html text. Defaults to True.
+        copyright_only: if True, return only copyright
+
+    Returns:
+        str: text about this package
+    """
     shortdesc = (
         f"Plotpy {plotpy.__version__}\n\n"
         f"Plotpy is a set of tools for curve and image plotting.\n"
         f"Created by Pierre Raybaut."
     )
-    desc = (
-        f"Copyright © 2023 CEA\n\nPython {python_version}, "
-        f"Qt {QC.__version__}, PythonQwt {QWT_VERSION_STR} on {platform.system()}"
-    )
+    addinfos = f"guidata {guidata.__version__}, PythonQwt {qwt.__version__}"
+    desc = get_general_infos(addinfos)
     if not copyright_only:
         desc = f"{shortdesc}\n\n{desc}"
     if html:
         desc = desc.replace("\n", "<br />")
     return desc
+
+
+def show_about_dialog(parent: QWidget) -> None:
+    """Show ``plotpy`` about dialog
+
+    Args:
+        parent (QWidget): parent widget
+    """
+    QMessageBox.about(parent, _("About") + " plotpy", about(html=True))

pyproject.toml

@@ -29,7 +29,7 @@ classifiers = [
 ]
 requires-python = ">=3.8, <4"
 dependencies = [
-    "guidata>=3.0.1",
+    "guidata>=3.1",
     "PythonQwt>=0.10",
     "NumPy>=1.17",
     "SciPy>=1.3",

requirements.txt

@@ -6,7 +6,7 @@ PyQt5
 PythonQwt>=0.10
 SciPy>=1.3
 black
-guidata>=3.0.1
+guidata>=3.1
 isort
 pylint
 pytest