PyTermGUI 7.7.1__tar.gz → 7.7.3__tar.gz

{pytermgui-7.7.1 → pytermgui-7.7.3}/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [7.7.2] - 2024-08-31
+
+### Additions
+
+- Stop allowing selection of closed Collapsible's items
+- Clarify some documentation
+
+<!-- HATCH README END -->
+
 ## [7.7.1] - 2024-02-24
 
 ### Additions
@@ -8,8 +17,6 @@
 
 - Fix `inline` widget referring to `hover` mouse mode
 
-<!-- HATCH README END -->
-
 ## [7.7.0] - 2023-09-06
 
 ### Additions
@@ -403,6 +410,7 @@
 
 <!-- HATCH URI DEFINITIONS START -->
 
+[7.7.2]: https://github.com/bczsalba/pytermgui/compare/v7.7.1...v7.7.2
 [7.7.1]: https://github.com/bczsalba/pytermgui/compare/v7.7.0...v7.7.1
 [7.7.0]: https://github.com/bczsalba/pytermgui/compare/v7.6.0...v7.7.0
 [7.6.0]: https://github.com/bczsalba/pytermgui/compare/v7.5.0...v7.6.0

{pytermgui-7.7.1 → pytermgui-7.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: PyTermGUI
-Version: 7.7.1
+Version: 7.7.3
 Summary: Python TUI framework with mouse support, modular widget system, customizable and rapid terminal markup language and more!
 Project-URL: homepage, https://github.com/bczsalba/PyTermGUI
 Project-URL: repository, https://github.com/bczsalba/PyTermGUI
@@ -99,21 +99,19 @@ Additionally, there are a couple of neat tools to make your general Python devel
 
 ## Latest release
 
-### [7.7.1] - 2024-02-24
+### [7.7.2] - 2024-08-31
 
 ### Additions
 
-- Add support for wide characters
-
-### Bugfixes
-
-- Fix `inline` widget referring to `hover` mouse mode
+- Stop allowing selection of closed Collapsible's items
+- Clarify some documentation
 
 
 Read the full changelog [here](https://github.com/bczsalba/pytermgui/blob/master/CHANGELOG.md).
 
 
 
+[7.7.2]: https://github.com/bczsalba/pytermgui/compare/v7.7.1...v7.7.2
 [7.7.1]: https://github.com/bczsalba/pytermgui/compare/v7.7.0...v7.7.1
 [7.7.0]: https://github.com/bczsalba/pytermgui/compare/v7.6.0...v7.7.0
 [7.6.0]: https://github.com/bczsalba/pytermgui/compare/v7.5.0...v7.6.0

{pytermgui-7.7.1 → pytermgui-7.7.3}/pyproject.toml

@@ -1,7 +1,5 @@
 [build-system]
-# requires = ["setuptools", "setuptools-scm"]
-# build-backend = "setuptools.build_meta"
-requires = ["hatchling", "hatch-fancy-pypi-readme"]
+requires = ["hatchling >= 1.26.1", "hatch-fancy-pypi-readme"]
 build-backend = "hatchling.build"
 
 [project]

{pytermgui-7.7.1 → pytermgui-7.7.3}/pytermgui/__init__.py

@@ -40,7 +40,7 @@ if "-m" in sys.argv:  # pragma: no cover
 
     warnings.filterwarnings("ignore")
 
-__version__ = "7.7.1"
+__version__ = "7.7.3"
 
 
 def auto(data: Any, **widget_args: Any) -> Optional[Widget | list[Splitter]]:

{pytermgui-7.7.1 → pytermgui-7.7.3}/pytermgui/input.py

@@ -331,25 +331,25 @@ try:
     # TODO: Add shift+arrow keys
     _platform_keys = {
         "ESC": "\x1b",
-        "LEFT": "\x1bK",
-        "RIGHT": "\x1bM",
-        "UP": "\x1bH",
-        "DOWN": "\x1bP",
+        "LEFT": "\x1b[D",
+        "RIGHT": "\x1b[C",
+        "UP": "\x1b[A",
+        "DOWN": "\x1b[B",
         "ENTER": "\r",
         "RETURN": "\r",
-        "BACKSPACE": "\x08",
-        "F1": "\x00;",
-        "F2": "\x00<",
-        "F3": "\x00=",
-        "F4": "\x00>",
-        "F5": "\x00?",
-        "F6": "\x00@",
-        "F7": "\x00A",
-        "F8": "\x00B",
-        "F9": "\x00C",
-        "F10": "\x00D",
-        "F11": "\xe0\x85",
-        "F12": "\xe0\x86",
+        "BACKSPACE": "\x7f",
+        "F1": "\x1bOP",
+        "F2": "\x1bOQ",
+        "F3": "\x1bOR",
+        "F4": "\x1bOS",
+        "F5": "\x1b[15~",
+        "F6": "\x1b[17~",
+        "F7": "\x1b[18~",
+        "F8": "\x1b[19~",
+        "F9": "\x1b[20~",
+        "F10": "\x1b[21~",
+        "F11": "\x1b[23~",
+        "F12": "\x1b[24~",
     }
 
     _getch = _GetchWindows()

{pytermgui-7.7.1 → pytermgui-7.7.3}/pytermgui/regex.py

@@ -71,7 +71,7 @@ def real_length(text: str) -> int:
         The display-length of text.
     """
 
-    return wcswidth(strip_ansi(text))
+    return max(wcswidth(strip_ansi(text)), 0)
 
 
 def escape_markup(text: str) -> str:

{pytermgui-7.7.1 → pytermgui-7.7.3}/pytermgui/widgets/collapsible.py

@@ -7,6 +7,7 @@ from typing import Any
 from ..enums import Overflow
 from ..input import keys
 from .containers import Container
+from .base import Widget
 from .toggle import Toggle
 
 __all__ = ["Collapsible"]
@@ -53,6 +54,13 @@ class Collapsible(Container):
 
         self._is_expanded = False
 
+    @property
+    def selectables(self) -> list[tuple[Widget, int]]:
+        if self._is_expanded:
+            return super().selectables
+
+        return [(self.trigger, 0)]
+
     def toggle(self) -> Collapsible:
         """Toggles expanded state.
 

{pytermgui-7.7.1 → pytermgui-7.7.3}/pytermgui/window_manager/layouts.py

@@ -285,7 +285,8 @@ class Layout:
         """Adds a new slot to the layout.
 
         Args:
-            name: The name of the slot. Used for display purposes.
+            name: The **snakeified** name of the slot. A non-snake case name
+                will cause issues when trying to retrieve the slot (see GH#147).
             slot: An already instantiated `Slot` instance. If this is given,
                 the additional width & height arguments will be ignored.
             width: The width for the new slot. See below for special types.

pytermgui-7.7.1/pytermgui/cell.py

@@ -1,320 +0,0 @@
-from __future__ import annotations
-
-from dataclasses import dataclass
-
-STYLE_START_CHAR = "\x1b"
-STYLE_END_CHAR = "m"
-
-UNSETTER_LOOKUP = {
-    **{"38": {"39"}, "48": {"49"}, "54": {"53"}},
-    **{str(index + 20): {str(index)} for index in range(1, 10)},
-    **{"22": {"1", "2"}},
-}
-
-
-def _is_color(style: str) -> bool:
-    """Determines whether the given style string is a color."""
-
-    if style.startswith(("38", "48")):
-        return True
-
-    if style.isdigit():
-        index = int(style)
-
-        if 30 <= index <= 38 or 40 <= index <= 48:
-            return True
-
-    return False
-
-
-def _process_styles(styles: list[str]) -> tuple[list[str], str, str]:
-    """Processes the given styles, cleaning them up along the way.
-
-    This does 2 major tasks:
-
-    - Remove styles that are unset by later ones
-    - Extract the fore and background colors, returning them
-
-    Args:
-        style: The list of styles to process.
-
-    Returns:
-        A tuple containing:
-
-        - The processed list of styles
-        - The foreground color
-        - The background color
-    """
-
-    # TODO: Split up compound styles before handling them.
-
-    applied = []
-    foreground = ""
-    background = ""
-
-    for style in styles:
-        unset_styles = UNSETTER_LOOKUP.get(style)
-
-        if _is_color(style):
-            if style.startswith("3"):
-                foreground = style
-            else:
-                background = style
-
-            continue
-
-        if style == "39":
-            foreground = ""
-
-        elif style == "49":
-            background = ""
-
-        elif style == "0":
-            applied = []
-            foreground = ""
-            background = ""
-
-        elif unset_styles is not None:
-            for unset_style in unset_styles:
-                if unset_style in applied:
-                    applied.remove(unset_style)
-
-        if style not in applied:
-            applied.append(style)
-
-    if foreground:
-        applied.append(foreground)
-
-    if background:
-        applied.append(background)
-
-    return applied, foreground, background
-
-
-def _split(styles: str) -> list[str]:
-    """Splits styles into a list of their content.
-
-    For example, `\x1b[38;5;141;1m` would become `38;5;141` and `1`.
-    """
-
-    return [style.rstrip("m") for style in styles.split("\x1b[")[1:]]
-
-
-def _combine(styles: list[str]) -> str:
-    """Combines a list of style content into a compound style setter.
-
-    Instead of doing individual tags, it puts all of the styles into
-    a single unit, i.e. instead of `\x1b[38;5;141m\x1b[1m` it returns
-    `\x1b[38;5;141;1m`.
-    """
-
-    if len(styles) == 0:
-        return ""
-
-    return f"\x1b[{';'.join(styles)}{STYLE_END_CHAR}"
-
-
-@dataclass
-class Cell:
-    """A unit that represents a single, possibly ANSI-styled character."""
-
-    char: str = ""
-    styles: str = ""
-
-    _foreground: str | None = None
-    _background: str | None = None
-
-    def __str__(self) -> str:
-        """Gets the content of this cell."""
-
-        return self.styles + self.char
-
-    @property
-    def foreground(self) -> str | None:
-        """Returns the currently set foreground color in this cell."""
-
-        return self._foreground
-
-    @foreground.setter
-    def foreground(self, new: str | None) -> None:
-        """Allows setting the foreground color, while unsetting the current one."""
-
-        current = self.foreground
-
-        if current is not None:
-            self.styles = self.styles.replace(current, "")
-
-        self.styles += new
-
-        if new is not None:
-            self._foreground = f"\x1b[{new}m"
-
-        else:
-            self._foreground = None
-
-    @property
-    def background(self) -> str | None:
-        """Returns the currently set background color in this cell."""
-
-        return self._background
-
-    @background.setter
-    def background(self, new: str | None) -> None:
-        """Allows setting the background color, while unsetting the current one."""
-
-        current = self.background
-
-        if current is not None:
-            self.styles = self.styles.replace(current, "")
-
-        self.styles += new
-
-        if new is not None:
-            self._background = f"\x1b[{new}m"
-
-        else:
-            self._background = None
-
-    @classmethod
-    def from_line(cls, line: str, styles: str = "") -> Generator[None, None, Cell]:
-        """Yields Cells generated from a line of text.
-
-        Args:
-            line: The input line. May or may not contain ANSI styles.
-            styles: Styles that are applied to the line from before the line started.
-
-        Returns:
-            A Cell generator.
-        """
-
-        in_style = False
-        current_style = styles
-        current_styles = []
-
-        for char in line:
-            if char == STYLE_START_CHAR:
-                in_style = True
-                current_style = ""
-                continue
-
-            if in_style:
-                if char == "[":
-                    continue
-
-                if char == STYLE_END_CHAR:
-                    current_styles.append(current_style)
-                    in_style = False
-                    continue
-
-                current_style += char
-                continue
-
-            current_styles, fore, back = _process_styles(current_styles)
-
-            yield Cell(char or " ", _combine(current_styles), fore, back)
-
-        if current_style != "":
-            current_styles, fore, back = _process_styles(
-                current_styles + [current_style]
-            )
-
-            yield Cell("", _combine(current_styles), fore, back)
-
-    @classmethod
-    def first_of(cls, line: str) -> Cell:
-        """Returns the first cell yielded by `from_line`."""
-
-        for cell in cls.from_line(line):
-            return cell
-
-
-class CellMatrix:
-    def __init__(self, width: int, height: int, default: str = " ") -> None:
-        self._cells = []
-        self._changes: list[tuple[int, int, Cell]] = []
-
-        for _ in range(height):
-            row = []
-
-            for _ in range(width):
-                row.append(Cell(default))
-
-            self._cells.append(row)
-
-        self.width = width
-        self.height = height
-
-    def resize(self, width: int, height: int, default: str = " ") -> None:
-        diff_cols = width - self.width
-        diff_rows = height - self.height
-
-        default_cell = list(Cell.from_line(default))[0]
-
-        for row in range(self.height):
-            self._cells[row].extend([default_cell] * diff_cols)
-
-        for _ in range(diff_rows):
-            self._cells.append([default_cell] * (width))
-
-        self.width, self.height = width, height
-
-    def add_text(
-        self, text: str, offset: tuple[int, int] = (0, 0), register_change: bool = True
-    ) -> None:
-        x, y = offset
-
-        if y >= self.height:
-            return
-
-        for i, cell in enumerate(Cell.from_line(text)):
-            # Sometimes some styles (usually the global unsetter 0) are left over at
-            # the end of a line of text. These are dealt with here; overflowing either
-            # into the next cell in the same row, or the first cell of the next one.
-            if cell.char == "":
-                if x + i < self.width:
-                    self._cells[y][x + i].styles += cell.styles
-
-                else:
-                    if y + 1 >= self.height:
-                        continue
-
-                    self._cells[y + 1][0].styles += cell.styles
-
-                continue
-
-            if self.width <= x + i:
-                break
-
-            if self._cells[y][x + i] != cell:
-                self._cells[y][x + i] = cell
-
-                if register_change:
-                    self._changes.append((x + i, y, cell))
-
-    def fill(self, content: str) -> None:
-        for row in range(self.height):
-            for col in range(self.width):
-                self.add_text(content, (col, row), register_change=False)
-
-    def build_lines(self) -> list[str]:
-        lines = []
-        for row in self._cells:
-            buff = ""
-
-            for cell in row:
-                buff += str(cell)
-
-            lines.append(buff + "")
-
-        return lines
-
-    def get_diff(self, origin: tuple[int, int] = (1, 1)) -> tuple[str, int]:
-        buff = ""
-
-        for x, y, cell in self._changes:
-            buff += f"\x1b[{y + origin[1]};{x + origin[0]}H{cell}"
-
-        change_count = len(self._changes)
-        self._changes.clear()
-
-        return buff, change_count

pytermgui-7.7.1/tests/not_test_cell.py

@@ -1,125 +0,0 @@
-from pytermgui.cell import (
-    Cell,
-    CellMatrix,
-    _is_color,
-    _combine,
-    _split,
-    _process_styles,
-)
-
-
-def test_is_color():
-    assert _is_color("31")
-    assert _is_color("45")
-    assert _is_color("38;5;141")
-    assert _is_color("48;5;61")
-    assert _is_color("38;2;22;33;44")
-    assert _is_color("48;2;22;33;44")
-
-    assert not _is_color("1")
-    assert not _is_color("9")
-    assert not _is_color("22")
-    assert not _is_color("1")
-
-
-def test_combine():
-    assert _combine(["41", "38;5;141", "1"]) == "\x1b[41;38;5;141;1m"
-
-
-def test_split():
-    assert _split("\x1b[38;2;53;12;123m\x1b[1m\x1b[9m\x1b[48;2;21;21;21m") == [
-        "38;2;53;12;123",
-        "1",
-        "9",
-        "48;2;21;21;21",
-    ]
-
-
-def test_process_styles():
-    tests = [
-        # Bold & Dim both get unset by the same unsetter
-        (["38;5;141", "1", "9", "2", "22"], {"38;5;141", "9", "22"}),
-        # 0 unsets everything
-        (["38;2;66;66;66", "1", "0"], {"0"}),
-        # Duplicates are ignored
-        (["1", "1", "9"], {"1", "9"}),
-        # Foreground colors work; background ones unset
-        (["38;5;131", "1", "41", "49"], {"38;5;131", "1", "49"}),
-        # Background colors work; foreground ones unset
-        (["48;2;33;44;55", "7", "35", "39"], {"48;2;33;44;55", "7", "39"}),
-    ]
-
-    for target, expected in tests:
-        output = _process_styles(target)[0]
-
-        if len(set(output)) != len(output):
-            raise ValueError(f"Output {output} contains duplicates.")
-
-        assert set(output) == expected
-
-
-def test_cell_from_line():
-    tests = [
-        # General example
-        (
-            "\x1b[38;5;141\x1b[1mHello\x1b[7mThere",
-            [
-                Cell("H", "\x1b[38;5;141;1m", "38;5;141"),
-                Cell("e", "\x1b[38;5;141;1m", "38;5;141"),
-                Cell("l", "\x1b[38;5;141;1m", "38;5;141"),
-                Cell("l", "\x1b[38;5;141;1m", "38;5;141"),
-                Cell("o", "\x1b[38;5;141;1m", "38;5;141"),
-                Cell("T", "\x1b[7;38;5;141;1m", "38;5;141"),
-                Cell("h", "\x1b[7;38;5;141;1m", "38;5;141"),
-                Cell("e", "\x1b[7;38;5;141;1m", "38;5;141"),
-                Cell("r", "\x1b[7;38;5;141;1m", "38;5;141"),
-                Cell("e", "\x1b[7;38;5;141;1m", "38;5;141"),
-                # Trailing style
-                Cell("", "\x1b[7;38;5;141;1m", "38;5;141"),
-            ],
-        ),
-        # Achy breaky code (chode)
-        # Unsetters & trailing
-        (
-            "\x1b[1m\x1b[33m1\x1b[22m2\x1b[0m",
-            [
-                Cell(char="1", styles="\x1b[1;33m"),
-                Cell(char="2", styles="\x1b[22;33m"),
-                Cell(char="", styles="\x1b[0m"),
-            ],
-        ),
-        # (Future) Compound styles
-        # (
-        #     "\x1b[1;33m1\x1b[22m2\x1b[0m",
-        #     [
-        #         Cell(char="1", styles="\x1b[1;33m"),
-        #         Cell(char="2", styles="\x1b[22;33m"),
-        #         Cell(char="", styles="\x1b[0m"),
-        #     ],
-        # ),
-    ]
-
-    for target, expected in tests:
-        assert list(Cell.from_line(target)) == expected
-
-
-def test_cell_foreground():
-    assert Cell.first_of("\x1b[38;5;141mHello there").foreground == "\x1b[38;5;141m"
-
-
-def test_cell_matrix_resize():
-    mat = CellMatrix(5, 5, default="x")
-    mat.resize(10, 10, default="O")
-
-    assert mat.build_lines() == [
-        "xxxxxOOOOO",
-        "xxxxxOOOOO",
-        "xxxxxOOOOO",
-        "xxxxxOOOOO",
-        "xxxxxOOOOO",
-        "OOOOOOOOOO",
-        "OOOOOOOOOO",
-        "OOOOOOOOOO",
-        "OOOOOOOOOO",
-        "OOOOOOOOOO",
-    ]