openprocess 0.12.1__tar.gz → 0.12.2__tar.gz

{openprocess-0.12.1/openprocess.egg-info → openprocess-0.12.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openprocess
-Version: 0.12.1
+Version: 0.12.2
 Summary: Process mining, Petri nets and workflows in one open app: every algorithm visible, every result reproducible, every step teachable
 Author: Sam Struthers
 License: MIT

{openprocess-0.12.1 → openprocess-0.12.2}/openprocess/__init__.py

@@ -48,7 +48,7 @@ from .sim.simulator import Simulator
 #: The one place the version number is written (pyproject.toml, the update
 #: check and packaging/build.py read it from here).  A release is tagged
 #: "v" + this, e.g. v0.2.0.
-__version__ = "0.12.1"
+__version__ = "0.12.2"
 
 __all__ = [
     "Arc", "BindingElement", "CPNet", "Marking", "Multiset", "Page", "Place",

{openprocess-0.12.1 → openprocess-0.12.2}/openprocess/flow/boxes/measure.py

@@ -20,7 +20,7 @@ from typing import Literal
 
 from ... import flow
 from ...mining.cases import case_value, cases
-from ...mining.dotted import SORT_MODES, X_MODES, DotSettings, Dots, svg
+from ...mining.dotted import SORT_MODES, X_MODES, DotSettings, Dots, how_to_read, svg
 from ...mining.log import EventLog
 from ...mining.petrinet import PetriNet
 from ..box import box
@@ -229,8 +229,7 @@ def dotted_chart(log: EventLog,
                   f"{dots.origin + timedelta(seconds=dots.x_max - dots.x_min):%d %b %Y %H:%M}")
     title = f"{log.name}: {rows.lower()} by {X_MODES[dots.mode].lower()}, colour by {colour.lower()}"
     return Figure("Dotted chart", svg=svg(dots, title, unit),
-                  caption=f"Dotted chart: rows {rows}, x {X_MODES[dots.mode]}, colour {colour}, "
-                          f"sorted by {sort.lower()}.")
+                  caption=f"{how_to_read(settings, dots.mode)} Colour: {colour}.")
 
 
 @box(name="Who does what", group="Measure")

{openprocess-0.12.1 → openprocess-0.12.2}/openprocess/gui/flow/viewers.py

@@ -398,17 +398,10 @@ def result_widget(value, page=None, node=None) -> QWidget:
         if value.note:
             add(label(value.note, "muted", wrap=True))
     elif isinstance(value, Figure):
-        shown = False
+        shown, svg = False, None
         if value.svg:
             try:
-                from PySide6.QtSvgWidgets import QSvgWidget
-                svg = QSvgWidget()
-                svg.load(value.svg.encode("utf-8"))
-                svg.setMinimumHeight(260)
-                svg.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
-                size = svg.renderer().defaultSize()
-                if size.width() > 0:
-                    svg.setMaximumHeight(int(min(600, max(260, size.height() * 1.4))))
+                svg = SvgFigure(value.svg)
                 add(svg)
                 shown = True
             except ImportError:
@@ -425,8 +418,11 @@ def result_widget(value, page=None, node=None) -> QWidget:
             add(label("The figure has no SVG or PNG form.", "muted"))
         if value.caption:
             add(label(value.caption, "muted", wrap=True))
+        buttons = [button("Open larger", lambda: open_figure(value, svg))] if value.svg and shown else []
         if page is not None:
-            add(hbox(button("Save as SVG…", lambda: page.save_figure(value)), None))
+            buttons.append(button("Save as SVG…", lambda: page.save_figure(value)))
+        if buttons:
+            add(hbox(*buttons, None))
     elif isinstance(value, Text):
         text = QPlainTextEdit(value.text)
         text.setReadOnly(True)
@@ -1047,3 +1043,75 @@ def status_text(result: Result | None) -> tuple[str, str]:
     if result.status == "blocked":
         return result.message or "Not allowed to run yet", "warning"
     return result.message or "Waiting", "muted"
+
+
+class SvgFigure(QWidget):
+    """An SVG figure drawn at the width it is given and in its own
+    proportions, never stretched: text stays readable and nothing is cut
+    off. Click it to see it at full size."""
+
+    def __init__(self, svg: str, parent=None) -> None:
+        from PySide6.QtSvg import QSvgRenderer
+        super().__init__(parent)
+        self.renderer = QSvgRenderer(svg.encode("utf-8"), self)
+        size = self.renderer.defaultSize()
+        self.ratio = size.height() / size.width() if size.width() > 0 else 0.6
+        self.svg = svg
+        policy = QSizePolicy(QSizePolicy.Expanding, QSizePolicy.Preferred)
+        policy.setHeightForWidth(True)
+        self.setSizePolicy(policy)
+        self.setMinimumWidth(200)
+        self.setCursor(Qt.PointingHandCursor)
+        self.setToolTip("Click to see the figure at full size")
+
+    def hasHeightForWidth(self) -> bool:
+        return True
+
+    def heightForWidth(self, width: int) -> int:
+        return max(1, round(width * self.ratio))
+
+    def sizeHint(self):
+        from PySide6.QtCore import QSize
+        size = self.renderer.defaultSize()
+        return QSize(size.width(), size.height()) if size.width() > 0 else QSize(560, 336)
+
+    def paintEvent(self, event) -> None:
+        from PySide6.QtCore import QRectF
+        from PySide6.QtGui import QPainter
+        painter = QPainter(self)
+        painter.setRenderHint(QPainter.Antialiasing)
+        width = min(self.width(), round(self.height() / self.ratio)) if self.ratio else self.width()
+        height = round(width * self.ratio)
+        self.renderer.render(painter, QRectF((self.width() - width) / 2, 0, width, height))
+        painter.end()
+
+    def mouseReleaseEvent(self, event) -> None:
+        if event.button() == Qt.LeftButton:
+            open_figure(None, self)
+        super().mouseReleaseEvent(event)
+
+
+def open_figure(figure, widget: "SvgFigure | None") -> None:
+    """The figure in a window of its own, as large as the screen allows;
+    resizing the window resizes the figure, in proportion."""
+    if widget is None:
+        return
+    window = QDialog(widget.window())
+    window.setWindowTitle(getattr(figure, "name", None) or "Figure")
+    full = SvgFigure(widget.svg)
+    full.setCursor(Qt.ArrowCursor)
+    full.setToolTip("")
+    full.mouseReleaseEvent = lambda event: None
+    full.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
+    layout = QVBoxLayout(window)
+    layout.setContentsMargins(12, 12, 12, 12)
+    layout.addWidget(full)
+    size = full.sizeHint()
+    width, height = size.width() + 24, size.height() + 24
+    screen = widget.screen().availableGeometry() if widget.screen() else None
+    if screen is not None:
+        scale = min(1.0, (screen.width() - 80) / width, (screen.height() - 80) / height)
+        width, height = round(width * scale), round(height * scale)
+    window.resize(width, height)
+    window.setAttribute(Qt.WA_DeleteOnClose)
+    window.show()

{openprocess-0.12.1 → openprocess-0.12.2}/openprocess/mining/dotted.py

@@ -365,7 +365,7 @@ def svg(dots: Dots, title: str = "", unit: str = "Auto", width: int = 900) -> st
     legend_rows = (min(len(dots.colour_values), 9) + 2) // 3
     top = 34 + 18 * legend_rows
     bottom, right = 44, 16
-    plot_h = min(max(n_rows * (16 if labelled else 0.5), 220), 620)
+    plot_h = min(max(n_rows * (16 if labelled else 0.5), 220), 440)     # landscape: it fits a side panel
     plot_w = width - left - right
     height = top + plot_h + bottom
     x0, x1 = dots.x_min, dots.x_max
@@ -442,14 +442,40 @@ def svg(dots: Dots, title: str = "", unit: str = "Auto", width: int = 900) -> st
     # Legend: what each colour means, with how many events.
     items = [(CATEGORICAL_LIGHT[i], v, dots.colour_counts[v]) for i, v in enumerate(dots.colour_values[:8])]
     rest = dots.colour_values[8:]
-    if rest:
-        items.append((OTHER_LIGHT, f"Other ({len(rest)})", sum(dots.colour_counts[v] for v in rest)))
+    if rest:     # name the grey values when there are few, so none is hidden
+        name = "Other: " + ", ".join(rest) if len(rest) <= 3 else f"Other ({len(rest)} values)"
+        items.append((OTHER_LIGHT, name, sum(dots.colour_counts[v] for v in rest)))
     column = (width - left - right) / 3
     for i, (fill, value, count) in enumerate(items):
         lx, ly = left + (i % 3) * column, 32 + (i // 3) * 18
-        name = (value or "–") if len(value) <= 34 else value[:33] + "…"
+        name = (value or "–") if len(value) <= 48 else value[:47] + "…"
         out.append(f'<circle cx="{lx + 5:.1f}" cy="{ly - 4}" r="4.5" fill="{fill}"/>')
         out.append(f'<text x="{lx + 14:.1f}" y="{ly}" fill="#333">{_escape(name)} '
                    f'<tspan fill="#888">{count:,}</tspan></text>')
     out.append("</svg>")
     return "\n".join(out)
+
+
+def how_to_read(settings: DotSettings, mode: int) -> str:
+    """What the chart's axes mean and which patterns to look for, for the
+    x mode it was drawn in and its rows."""
+    by_case = settings.rows == "Case"
+    rows = ("Each row is a case and each dot one of its events" if by_case else
+            f"Each row is one value of {settings.rows} and each dot an event of it")
+    order = f"; rows are sorted by {SORT_MODES[settings.sort].lower()}" if by_case else ""
+    x = {
+        0: ", at the time it happened. "
+           + ("The slope of the first dots is the arrival rate, vertical lines are events handled "
+              "together (batches), and horizontal gaps are cases waiting."
+              if by_case else
+              "Gaps are times it was not active (nights, weekends, days off), and vertical lines "
+              "are batches."),
+        1: ", at the time since its case began, so every case starts at 0. Compare how long each "
+           "step takes after the start; long horizontal gaps are waiting.",
+        2: ", at its share of the case's duration (0 % the first event, 100 % the last), so cases "
+           "of different lengths line up: a column shows where in a case something usually happens.",
+        3: ", at its place among all events of the log ordered by time: actual time without the gaps.",
+        4: ", at its position in the case (0 is the first event): which step comes where, whatever "
+           "the time.",
+    }[mode]
+    return f"{rows}{order}{x}"

{openprocess-0.12.1 → openprocess-0.12.2/openprocess.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openprocess
-Version: 0.12.1
+Version: 0.12.2
 Summary: Process mining, Petri nets and workflows in one open app: every algorithm visible, every result reproducible, every step teachable
 Author: Sam Struthers
 License: MIT

{openprocess-0.12.1 → openprocess-0.12.2}/tests/test_flow_gui.py

@@ -1442,3 +1442,12 @@ def test_alignments_show_as_chevrons_and_on_the_model(app):
     assert len(lists) == 1 and lists[0].model().rowCount() == 3
     widget.resize(900, 900)
     widget.grab()
+
+
+def test_a_figure_keeps_its_proportions_at_any_width(app):
+    """A figure in the Result panel is never stretched: its height follows its width."""
+    from openprocess.gui.flow.viewers import SvgFigure
+    figure = SvgFigure('<svg xmlns="http://www.w3.org/2000/svg" width="900" height="450" viewBox="0 0 900 450">'
+                       '<rect width="900" height="450" fill="white"/></svg>')
+    assert figure.hasHeightForWidth()
+    assert figure.heightForWidth(380) == 190 and figure.heightForWidth(900) == 450

{openprocess-0.12.1 → openprocess-0.12.2}/tests/test_measure.py

@@ -86,6 +86,8 @@ def test_dotted_chart_draws_one_dot_per_event():
     # Dots on the same spot in the same colour are drawn once: u1 creates all four orders on day 0.
     by_user = dotted_chart(purchase_log(), rows="User", colour="Activity")
     assert by_user.svg.count('r="3.0"') == 13 and ">u2</text>" in by_user.svg
+    # Five activities fit the palette; the caption says how to read the chart.
+    assert "Other" not in figure.svg and "arrival rate" in figure.caption
     # Without timestamps the chart falls back to the position in the case.
     untimed = dotted_chart(EventLog.from_simple_log(parse_simple_log("[<a,b,c>^2, <a,c>]")), x="Actual time")
     assert "Event position in the case" in untimed.svg and untimed.svg.count('r="3.0"') == 8