zettcode-tui 0.4.0__py3-none-any.whl

zettcode/tui/widgets/toast.py

@@ -0,0 +1,137 @@
+"""A transient notice that expires on the application clock."""
+
+from __future__ import annotations
+
+from collections.abc import Callable
+from time import monotonic
+
+from zettcode.tui import RULE
+
+from ..core.focus import walk
+from ..core.geometry import Constraints, Size
+from ..core.widget import Widget
+from ..render import Canvas, Style, truncate
+from ..render.text import display_width
+
+LEVELS = ("info", "success", "warning", "error")
+
+
+class Toast(Widget):
+    """A framed notice that counts down while the application keeps painting.
+
+    Shape::
+
+        +-----------------------+
+        | saved to disk         |  <- frame in the level's colour
+        +-----------------------+
+
+    The frame carries the level's colour; the message stays in the primary
+    foreground so a one-line notice reads as text rather than as a warning.
+
+    Mount registers a scheduler token so the frame loop keeps running for the
+    countdown; ``on_tick`` dismisses it once the deadline passes, either by
+    popping its own screen or by calling ``on_expire``.
+    """
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        level: str = "info",
+        duration: float = 3.0,
+        clock=monotonic,
+        on_expire: Callable[[], None] | None = None,
+    ) -> None:
+        """Configure the message, the level, the countdown, and the expiry hook.
+
+        Args:
+            message: Single line of text; truncated to the toast width.
+            level: Colour key, one of ``LEVELS``.
+            duration: Seconds the toast stays up, floored at zero.
+            clock: Time source for the countdown, injectable for tests.
+            on_expire: Called once the countdown ends, instead of the toast
+                popping its own screen. The toast then stays mounted until the
+                owner removes it.
+        """
+        super().__init__()
+        if level not in LEVELS:
+            raise ValueError(f"Unknown toast level: {level!r}")
+        self.message = message
+        self.level = level
+        self.duration = max(0.0, duration)
+        self.clock = clock
+        self.on_expire = on_expire
+        self._token = f"toast:{id(self)}"
+        self._deadline = 0.0
+
+    @property
+    def remaining(self) -> float:
+        """Return the seconds left before the toast expires."""
+        return max(0.0, self._deadline - self.clock())
+
+    @property
+    def expired(self) -> bool:
+        """Return whether the countdown has run out."""
+        return self.clock() >= self._deadline
+
+    def on_mount(self) -> None:
+        """Start the countdown and keep the frame loop alive while it runs."""
+        self._deadline = self.clock() + self.duration
+        if self.app is not None:
+            self.app.scheduler.animate(self._token)
+
+    def on_unmount(self) -> None:
+        """Release the animation token when the toast is removed."""
+        if self.app is not None:
+            self.app.scheduler.animate(self._token, active=False)
+
+    def on_tick(self) -> None:
+        """Dismiss once the countdown reaches zero."""
+        if not self.expired:
+            return
+        if self.on_expire is not None:
+            self.on_expire()
+            return
+        if self.app is not None and any(widget is self for widget in walk(self.app.screens.top.widget)):
+            self.app.pop_screen()
+
+    def measure(self, constraints: Constraints) -> Size:
+        """Ask for the frame plus one row of message."""
+        return constraints.constrain(Size(display_width(self.message) + 4, 3))
+
+    def render(self, canvas: Canvas) -> None:
+        """Paint the frame and the message in the level's colour."""
+        if self.rect.empty:
+            return
+        theme = self.theme
+        # Clear to the page colour rather than to the terminal's default: the
+        # toast floats over the shell, so "no style" would punch a hole through
+        # whatever palette is active.
+        canvas.fill(
+            self.rect.x,
+            self.rect.y,
+            self.rect.width,
+            self.rect.height,
+            Style(background=theme.background),
+            " ",
+        )
+        color = {
+            "info": theme.text,
+            "success": theme.accent,
+            "warning": theme.warning,
+            "error": theme.error,
+        }[self.level]
+        width = self.rect.width
+        rule = RULE * max(0, width - 2)
+        canvas.draw_text(self.rect.x, self.rect.y, f"\u250c{rule}\u2510", Style(foreground=color))
+        canvas.draw_text(self.rect.x, self.rect.y + 1, "\u2502", Style(foreground=color))
+        canvas.draw_text(
+            self.rect.x + 2,
+            self.rect.y + 1,
+            truncate(self.message, max(0, width - 4)),
+            Style(foreground=theme.text),
+            max_width=max(0, width - 4),
+        )
+        canvas.draw_text(self.rect.x + width - 1, self.rect.y + 1, "\u2502", Style(foreground=color))
+        if self.rect.height > 2:
+            canvas.draw_text(self.rect.x, self.rect.y + 2, f"\u2514{rule}\u2518", Style(foreground=color))

zettcode_tui-0.4.0.dist-info/METADATA

@@ -0,0 +1,20 @@
+Metadata-Version: 2.5
+Name: zettcode-tui
+Version: 0.4.0
+Summary: The widget framework ZettCode's terminal is drawn with, and nothing else
+Project-URL: Repository, https://github.com/Chang-LeHung/zettcode
+Author: Chang-LeHung
+License-Expression: MIT
+Keywords: terminal,tui,widgets,zettcode
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: pyperclip<2,>=1.9
+Requires-Dist: tomli<3,>=2; python_version < '3.11'
+Requires-Dist: wcwidth<1,>=0.2

zettcode_tui-0.4.0.dist-info/RECORD

@@ -0,0 +1,83 @@
+zettcode/tui/__init__.py,sha256=uAVxeBDf5OFEbIT6cowmBGcrdpiFstgkcraqx2hR97k,9530
+zettcode/tui/_compat.py,sha256=tPaYFdlYNeeSxSa_nvis2Yl_ccBmcshKPUIxPiFrhbY,1257
+zettcode/tui/capabilities.py,sha256=Falj59bBouh2hg_kY7Q7FqUHNL9CLTPJe6c6TjzK8RA,4033
+zettcode/tui/clipboard.py,sha256=N6jJhxVRr47ZT6Bsn0DVcjf6jIGACr6nYZyWluzhkJ0,4237
+zettcode/tui/console.py,sha256=gLfKqPLTIUUH9UzJD8137g80-SpZKsHaoyTIU3XsdFc,8822
+zettcode/tui/gallery.py,sha256=4lstm2IB33tVn6ZgUYAkUbjmwHpCHlJybQKydJAUGao,20951
+zettcode/tui/glyphs.py,sha256=f7Kbm6wH8mTmALKNptji5v2CaHjctSRs3-z_MReKrEs,2495
+zettcode/tui/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+zettcode/tui/runner.py,sha256=9EMqUMm7vIEixadyVKG2dW_XFVs4Cf7O5Nj5u1ezHvE,15221
+zettcode/tui/terminal.py,sha256=d6-ZyQ4BPtwMArZ6ZX3V4u3bPOsyfw2U0k2RBF9sjvs,9827
+zettcode/tui/theme_file.py,sha256=FaJaXKtd5fCVZPGOiWIKxIspYlScUIcgJZ7cYrY76DU,12186
+zettcode/tui/core/__init__.py,sha256=-a-ksfiJ71Dos8MYjHIsxoD9daupeAUKnvqGLiz-zLw,1304
+zettcode/tui/core/app.py,sha256=3pjYwszlLGeXq4IrmtF8TWNdsBh7b7wFXUc23Yi9THc,26912
+zettcode/tui/core/events.py,sha256=f9xgXD7JjbTAXQtHtuDnlaZ52P_gUnbt3VNqySLZoUw,3554
+zettcode/tui/core/focus.py,sha256=6V6pAgRdzXcjoRGeutOuMFBhuIVekifR3y-JMCsNrpE,2871
+zettcode/tui/core/geometry.py,sha256=S5Abmk0eenuf-SXJRrjBOQwwRlSms2gMfuS4GeoUZbY,6626
+zettcode/tui/core/host.py,sha256=ETzblei1B4P7U5558XQAva6Qtrwj_xmsIswix_V5xQM,2164
+zettcode/tui/core/keymap.py,sha256=JoJ4jlXX1Uco6WlBLF3GCag4eCgA28PoA7nD6EhR02M,7822
+zettcode/tui/core/scheduler.py,sha256=5f_DGU9rnCcIK7rSfrA-mA77j6gNdIp9Iq-nUmrsWXQ,3821
+zettcode/tui/core/screen.py,sha256=fYAbb1ya2JXcR45cbTDknxFxY-Jy42jbZ3qN52xZlDE,2585
+zettcode/tui/core/theme.py,sha256=DiN4gH3LfH5zMk1tX8Cvc7_dd7fDJnldPPSKVHqJa7Y,11514
+zettcode/tui/core/widget.py,sha256=3NmBhMw1hMQpdoP7_VvrHh3_-K3-2KBqxVlZgLmgOhw,7269
+zettcode/tui/input/__init__.py,sha256=95b0q0Sg7NdzYnwLKnYwYk_4xMuWN8DWZPk96bW7s-E,412
+zettcode/tui/input/bridge.py,sha256=H22LilSVW8RQzXYro1I-F-PrZToBN893fuJhAHhZVlE,1484
+zettcode/tui/input/decoder.py,sha256=OKwjSDI1RszW-Zn-IpAUAfYwKLfJUGhlb9EZwRAIUFQ,10208
+zettcode/tui/input/events.py,sha256=B_BeFCHSAjKOCPrBIHxAXNZjZEeUf_P7_4fS7qBUN1M,2093
+zettcode/tui/input/keys.py,sha256=7oGhl_VktNdsXOzwBqL6JxPqYN_i-04FVFg7uPdyI-g,11167
+zettcode/tui/input/reader.py,sha256=Z_3XQkrzm1NAB68C2lir0HYZLdomkSFggO5x7_LvhPw,6128
+zettcode/tui/layout/__init__.py,sha256=ryqAsk1Qpw3ndcTaqbLTfCypihHx2BG9hEKwf1WX5b8,539
+zettcode/tui/layout/box.py,sha256=ZUcr1Vw3lKcmIFD8K9h1DOqD5awFdRFsZVOxF5HMOTc,5576
+zettcode/tui/layout/overlay.py,sha256=i6VOFN-l7sfx1J_L4NtubYUlrw3ziMa7J-E5gftGwwc,6362
+zettcode/tui/layout/scroll.py,sha256=yEZJJ9--AAiZL8KYdTPoaptpEJOCPwYRZtaI6pyVAhY,20526
+zettcode/tui/layout/solver.py,sha256=D_VSpgRjuRUs421YcHmG118BDo3lZXZ8EqP-5fXV8Wg,3588
+zettcode/tui/layout/spacing.py,sha256=4Ifz6MS8Q8ZKwlPXF6cYJkF7P23H9vEz1EJcIEPWUFI,5623
+zettcode/tui/render/__init__.py,sha256=b_i8mh9j-TG8pMemNlWU5W4VOV_WIc9FR_n6dO-pxgM,1643
+zettcode/tui/render/ansi.py,sha256=1RrPxfuB0604rfx8CySYNmHN_gUhFRoSm_GWEwICOUU,14748
+zettcode/tui/render/canvas.py,sha256=odK3Fa3b7DZQq_ECzLdZ5Of-ONDRUPJcp8iN2oe8ElM,6163
+zettcode/tui/render/code.py,sha256=ft1zR-814I_RGfRInqPI7ThUO3gweB511Qg-DNIXWI4,19435
+zettcode/tui/render/color.py,sha256=b58WkKeLFWaxYYrvfaD8y2svwFlJLpuA8WHon0bPzWg,6425
+zettcode/tui/render/renderer.py,sha256=v88QJEohEu8CIEez8lRple68MP7yainkoAg5Kh-uMmY,7081
+zettcode/tui/render/rich_text.py,sha256=WNJCrK6yrk6AJzdrE_nxrpHTsJmH859sk5gO9UjQwBY,3305
+zettcode/tui/render/style.py,sha256=O57Czv8V0bHjIqGprCEBmtooH76qyTqrm_-KRyPMJBE,3835
+zettcode/tui/render/sweep.py,sha256=b4Fth9njPaSmp_jcxam3IRfLffHh_j9H5Kzqkw6dhtw,3307
+zettcode/tui/render/text.py,sha256=D6EqTmVm2-IO0f2OjED2q9_nsuKpsg1Ap6jifllmdbM,11529
+zettcode/tui/testing/__init__.py,sha256=k2AzxYGGLKFOklY6qtV1NcyRhkC0VVcvaTeKXHELC9A,259
+zettcode/tui/testing/harness.py,sha256=nLjcG-6Ykd-ZvZiz3-p2aJdGTtorQq8h-xP-MokadrM,8363
+zettcode/tui/testing/snapshot.py,sha256=8ugKcy2LJLnlAMaZHlfgw_ob2yxNAu8fuIBb7ztdj4w,2279
+zettcode/tui/themes/ayu-mirage.toml,sha256=lr5hKwMnUWKwtYbDWKk9C2H5uxiY8Rf9fHLEGLBUGck,805
+zettcode/tui/themes/catppuccin-latte.toml,sha256=1KEBekwaS77p1vjBVf6otR32IjT1Ink1gux9kep1T88,821
+zettcode/tui/themes/catppuccin-mocha.toml,sha256=ey6M09D6CyECLDHQXeL_7LVgh6hqoG_ieCXBQ0kF4h8,813
+zettcode/tui/themes/dracula.toml,sha256=ZfzUhg6P0LO-9LYMpCytjvq8cgClIJgwTWgE-HPKW9c,809
+zettcode/tui/themes/github-dimmed.toml,sha256=O_DRAaYlZJwFIKQA7mQcrlP9ULSz32kKK15s_ylwIVc,813
+zettcode/tui/themes/github-light.toml,sha256=dvMCtyGiMZtR5PgWlHQFbTqxbLeBOVGgVErsdvtOU5M,818
+zettcode/tui/themes/gruvbox-dark.toml,sha256=tFPaEJCo4L78TYCXQ8w6r-WRrIce3atJrFg0dmQCLps,811
+zettcode/tui/themes/gruvbox-light.toml,sha256=PhNkmgWoupNqk6aq1p2TXT8GgEeQ-GALZLfN-kne_js,805
+zettcode/tui/themes/kanagawa.toml,sha256=JPrNzSGDSb3Usnu7akB3_udjLq7bB7_s6g-liPP0kIQ,804
+zettcode/tui/themes/nord.toml,sha256=4WD2qcS6JG1OcTNDIF9fHVHxwaSJa68LfmKmEscYXB4,818
+zettcode/tui/themes/one-dark.toml,sha256=1AtHACprq8hg4U7zb_qV6b7hSJXJkelgkpfOplvAcLE,813
+zettcode/tui/themes/rose-pine-dawn.toml,sha256=ROXtFqGp34Qe84pbyOGdcShzxbehlNj7cDKNjuDlG6E,813
+zettcode/tui/themes/rose-pine.toml,sha256=w747JzGFDn-UZtQopK9obo3OLHdKTyno3HNyfoqgcgQ,807
+zettcode/tui/themes/solarized-dark.toml,sha256=vVUdHEUTaDv9NqQgIhCucjm_qIrNA9mokSHOxD23NoE,804
+zettcode/tui/themes/solarized-light.toml,sha256=zaPeXgUgDRf19AbX2sax2z-DUphXL2smmzxn1oUBOZM,810
+zettcode/tui/themes/tokyo-night.toml,sha256=UpeOL8GJ_wfw2OJMEvPE9bUpMUeMD2BIX0bNu6wJlqM,809
+zettcode/tui/widgets/__init__.py,sha256=_8AEo33GKSpdeJ30_GiPKbAJ_qpFC69TQFux57hrmC4,3447
+zettcode/tui/widgets/collapsible.py,sha256=rYZ-qfvd5MPhenlXxM9w78eFsg8kUXQgQ61vr_2FeZA,4311
+zettcode/tui/widgets/completion.py,sha256=DqlnNOfG6A4NSFOInpOlYEOKVB_cJZxqXk200pPSoeE,8622
+zettcode/tui/widgets/console.py,sha256=osYYmfpJk2pXdz4sGDA0GjouHAz_zoqMy_xhFB39bz8,18544
+zettcode/tui/widgets/dialog.py,sha256=3Ip4JEmuGmQsc8Y_358hgjGlJHS_lJvbCVVArX3ZPfQ,5846
+zettcode/tui/widgets/diff.py,sha256=XmkswgYEhlxDx0KSPQJUhdYjB2uFXO8qu84yjY2hHUQ,9288
+zettcode/tui/widgets/list.py,sha256=DTDQo-kcj93YfmiqGA9GTFQ_taoLfIfMIUs6uYiObQw,12119
+zettcode/tui/widgets/list_page.py,sha256=jyvSggXpv_OGV1T86zHLVBT0j92-Z_q1UAx3ZPKMSpQ,5627
+zettcode/tui/widgets/markdown.py,sha256=GJ3K-riOujSjureFvViNajF01By13vjyaoj1Aofc3eg,26643
+zettcode/tui/widgets/progress.py,sha256=mTn5ToMkLSr6-KPCm4WCPNqZ0CUuX3RTRV_TQP8CXO0,6223
+zettcode/tui/widgets/rich_text.py,sha256=J4Fhn4je5uFL7lcVQsoIqx9DkNdXWT0HyxoN1LgtI18,3762
+zettcode/tui/widgets/status.py,sha256=e7jopfHt9JMGoODZtqGtsU79ZyFAfDlJc6hbmT05qC4,4386
+zettcode/tui/widgets/table.py,sha256=DMgKz-dGeE-Qt2QZD-OuD3j-gN_i7IQ79-ClhsJMC5E,3724
+zettcode/tui/widgets/tasks.py,sha256=v6QazBKnS8CE8rzzRtBarDQSvvVRmxSAw-VVXVtKjcY,6021
+zettcode/tui/widgets/text.py,sha256=xXeOGMv6vAFKsIXBnNsCcm_-LR9RZTpogwgZYfF03gw,3824
+zettcode/tui/widgets/textarea.py,sha256=af90H5f4P8BbEtp2Hu_R_4PvI45ZOzh-Sz2-jtqJHxA,28067
+zettcode/tui/widgets/toast.py,sha256=3Ubqwk6yT6-Rgdn3L4iEl6DG8bjyXGZ9TIlbBw4OJoU,5027
+zettcode_tui-0.4.0.dist-info/METADATA,sha256=VBmapr04A1CIMNlAzlQ_nnPDR0p47vJAPiAfbtkf8RU,819
+zettcode_tui-0.4.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+zettcode_tui-0.4.0.dist-info/RECORD,,

zettcode_tui-0.4.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any