hspylib-clitt 0.9.118__py3-none-any.whl → 0.9.120__py3-none-any.whl

build/lib/clitt/core/tui/tui_component.py

@@ -0,0 +1,154 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+   @project: HsPyLib-Clitt
+   @package: clitt.core.tui
+      @file: tui_component.py
+   @created: Tue, 4 May 2021
+    @author: <B>H</B>ugo <B>S</B>aporetti <B>J</B>unior"
+      @site: https://github.com/yorevs/hspylib
+   @license: MIT - Please refer to <https://opensource.org/licenses/MIT>
+
+   Copyright·(c)·2024,·HSPyLib
+"""
+from abc import ABC, abstractmethod
+from clitt.core.icons.font_awesome.awesome import Awesome
+from clitt.core.term.commons import Direction
+from clitt.core.term.cursor import Cursor
+from clitt.core.term.screen import Screen
+from clitt.core.term.terminal import Terminal
+from clitt.core.tui.tui_preferences import TUIPreferences
+from hspylib.core.tools.text_tools import elide_text
+from hspylib.modules.cli.keyboard import Keyboard
+from typing import Any, List, Optional, TypeVar
+
+T = TypeVar("T", bound=Any)
+
+
+class TUIComponent(ABC):
+    """Provide a base class for terminal UI components."""
+
+    def __init__(self, title: str):
+        self._re_render = True
+        self._done = False
+        self._title = title
+        self._terminal = Terminal.INSTANCE
+
+    @property
+    def terminal(self) -> Terminal:
+        return self._terminal
+
+    @property
+    def screen(self) -> Screen:
+        return self.terminal.screen
+
+    @property
+    def cursor(self) -> Cursor:
+        return self.terminal.screen.cursor
+
+    @property
+    def prefs(self) -> TUIPreferences:
+        return self.screen.preferences
+
+    @property
+    def title(self) -> str:
+        return self._title
+
+    @property
+    def rows(self) -> int:
+        return self.screen.lines
+
+    @property
+    def columns(self) -> int:
+        return self.screen.columns
+
+    def _prepare_render(self, auto_wrap: bool = False, show_cursor: bool = False) -> None:
+        """Prepare the screen for renderization."""
+        self.screen.add_watcher(self.invalidate)
+        Terminal.set_auto_wrap(auto_wrap)
+        Terminal.set_show_cursor(show_cursor)
+        self.screen.clear()
+        self.cursor.save()
+
+    def _loop(self, break_keys: List[Keyboard] = None) -> Keyboard:
+        """Loop and wait for a keypress. Render the component if required."""
+
+        break_keys = break_keys or Keyboard.break_keys()
+        keypress = Keyboard.VK_NONE
+
+        # Wait for user interaction
+        while not self._done and keypress not in break_keys:
+
+            # Menu Renderization
+            if self._re_render:
+                self.render()
+            # Navigation input
+            keypress = self.handle_keypress()
+
+        self.cursor.end()
+        self.cursor.erase(Direction.DOWN)
+        self.cursor.reset_mode()
+        self.cursor.writeln("\n")
+
+        return keypress
+
+    def draw_line(self, line_fmt: str, *args: Any) -> None:
+        """Draws a formatted component line respecting the specified max_columns.
+        :param line_fmt: the line format.
+        :param args: the format arguments.
+        """
+        self.writeln(elide_text(line_fmt.format(*args), self.columns) + "%NC%")
+
+    def draw_navbar(self, navbar: str) -> None:
+        """Draws the component navigation bar respecting the specified max_columns.
+        :param navbar: the component's navigation bar.
+        """
+        self.write(navbar)
+
+    def draw_selector(self, is_selected: bool = False, has_bg_color: bool = True) -> Awesome:
+        """Draws and highlight the selected component line.
+        :param is_selected: whether to set a selected foreground color or not.
+        :param has_bg_color: whether to set a background or not.
+        """
+        prefs = TUIPreferences.INSTANCE
+        if is_selected:
+            selector = prefs.selected_icon
+            if has_bg_color:
+                self.write(prefs.sel_bg_color.code)
+            self.write(prefs.highlight_color.code)
+        else:
+            selector = prefs.unselected_icon
+            self.write(prefs.text_color.code)
+
+        return selector
+
+    def write(self, obj: Any) -> None:
+        """Write the string representation of the object to the screen."""
+        self.terminal.echo(obj, end="")
+
+    def writeln(self, obj: Any) -> None:
+        """Write the string representation of the object to the screen, appending a new line."""
+        self.terminal.echo(obj)
+
+    def invalidate(self) -> None:
+        """Invalidate current TUI renderization."""
+        self.screen.clear()
+        self.cursor.save()
+        self.render()
+
+    @abstractmethod
+    def execute(self) -> Optional[T | List[T]]:
+        """Execute the main TUI component flow."""
+
+    @abstractmethod
+    def render(self) -> None:
+        """Renders the TUI component."""
+
+    @abstractmethod
+    def navbar(self, **kwargs) -> str:
+        """Get the TUI component's navigation bar (optional)."""
+
+    @abstractmethod
+    def handle_keypress(self) -> Keyboard:
+        """Handle a keyboard press."""

build/lib/clitt/core/tui/tui_preferences.py

@@ -0,0 +1,103 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+   @project: HsPyLib-Clitt
+   @package: clitt.core.tui
+      @file: tui_preferences.py
+   @created: Tue, 4 May 2021
+    @author: <B>H</B>ugo <B>S</B>aporetti <B>J</B>unior"
+      @site: https://github.com/yorevs/hspylib
+   @license: MIT - Please refer to <https://opensource.org/licenses/MIT>
+
+   Copyright·(c)·2024,·HSPyLib
+"""
+
+from clitt.core.icons.font_awesome.form_icons import FormIcons
+from clitt.core.icons.font_awesome.nav_icons import Awesome, NavIcons
+from clitt.core.preferences import Preferences
+from hspylib.modules.cli.vt100.vt_color import VtColor
+
+
+class TUIPreferences(Preferences):
+    """Terminal UI Preferences class."""
+
+    INSTANCE = None
+
+    def __init__(self):
+        super().__init__("hhs.clitt")
+
+    @property
+    def max_rows(self) -> int:
+        return max(3, self.get_preference("max.rows", 10))
+
+    @property
+    def items_per_line(self) -> int:
+        return max(2, self.get_preference("items.per.line", 6))
+
+    @property
+    def title_line_length(self) -> int:
+        return max(15, self.get_preference("title.line.len", 30))
+
+    @property
+    def title_color(self) -> VtColor:
+        return self.get_preference("title.color", VtColor.ORANGE)
+
+    @property
+    def caption_color(self) -> VtColor:
+        return self.get_preference("caption.color", VtColor.WHITE)
+
+    @property
+    def text_color(self) -> VtColor:
+        return self.get_preference("text.color", VtColor.WHITE)
+
+    @property
+    def success_color(self) -> VtColor:
+        return self.get_preference("success.color", VtColor.GREEN)
+
+    @property
+    def warning_color(self) -> VtColor:
+        return self.get_preference("warning.color", VtColor.YELLOW)
+
+    @property
+    def error_color(self) -> VtColor:
+        return self.get_preference("error.color", VtColor.RED)
+
+    @property
+    def highlight_color(self) -> VtColor:
+        return self.get_preference("highlight.color", VtColor.CYAN)
+
+    @property
+    def navbar_color(self) -> VtColor:
+        return self.get_preference("navbar.color", VtColor.YELLOW)
+
+    @property
+    def tooltip_color(self) -> VtColor:
+        return self.get_preference("tooltip.color", VtColor.GREEN)
+
+    @property
+    def breadcrumb_color(self) -> VtColor:
+        return self.get_preference("breadcrumb.color", VtColor.compose(VtColor.BG_BLUE, VtColor.WHITE))
+
+    @property
+    def sel_bg_color(self) -> VtColor:
+        return self.get_preference("sel.bg.color", VtColor.BLUE)
+
+    @property
+    def selected_icon(self) -> Awesome:
+        return self.get_preference("selected.icon", NavIcons.POINTER)
+
+    @property
+    def unselected_icon(self) -> Awesome:
+        return self.get_preference("unselected.icon", Awesome.no_icon())
+
+    @property
+    def checked_icon(self) -> Awesome:
+        return self.get_preference("checked.icon", FormIcons.MARKED)
+
+    @property
+    def unchecked_icon(self) -> Awesome:
+        return self.get_preference("unchecked.icon", FormIcons.UNMARKED)
+
+
+assert (tui_preferences := TUIPreferences().INSTANCE) is not None, "Failed to create TUIPreferences instance"

build/lib/clitt/utils/__init__.py

@@ -0,0 +1,11 @@
+# _*_ coding: utf-8 _*_
+#
+# hspylib-clitt v0.9.120
+#
+# Package: main.build.lib.build.lib.clitt.utils
+"""Package initialization."""
+
+__all__ = [
+    'git_utils'
+]
+__version__ = '0.9.120'

build/lib/clitt/utils/git_utils.py

@@ -0,0 +1,66 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+   @project: HsPyLib
+   @package: clitt.utils
+      @file: git_utils.py
+   @created: Nov 14, 2019
+    @author: <B>H</B>ugo <B>S</B>aporetti <B>J</B>unior
+      @site: https://github.com/yorevs/hspylib
+   @license: MIT - Please refer to <https://opensource.org/licenses/MIT>
+
+   Copyright·(c)·2024,·HSPyLib
+"""
+from clitt.core.term.terminal import Terminal
+from hspylib.modules.application.exit_status import ExitStatus
+from typing import Tuple
+
+
+class GitTools:
+    """TODO"""
+
+    @staticmethod
+    def top_level_dir() -> Tuple[str, ExitStatus]:
+        """TODO"""
+        return Terminal.shell_exec("git rev-parse --show-toplevel")
+
+    @staticmethod
+    def current_branch() -> Tuple[str, ExitStatus]:
+        """TODO"""
+        return Terminal.shell_exec("git symbolic-ref --short HEAD")
+
+    @staticmethod
+    def changelog(from_tag: str, to_tag: str) -> Tuple[str, ExitStatus]:
+        """TODO"""
+        return Terminal.shell_exec(f"git log --oneline --pretty='format:%h %ad %s' --date=short {from_tag}^..{to_tag}^")
+
+    @staticmethod
+    def unreleased() -> Tuple[str, ExitStatus]:
+        """TODO"""
+        latest_tag = Terminal.shell_exec("git describe --tags --abbrev=0 HEAD^")
+        return Terminal.shell_exec(f"git log --oneline --pretty='format:%h %ad %s' --date=short '{latest_tag}'..HEAD")
+
+    @staticmethod
+    def release_date(tag_name: str) -> Tuple[str, ExitStatus]:
+        """TODO"""
+        return Terminal.shell_exec(f"git log -1 --pretty='format:%ad' --date=short {tag_name}")
+
+    @staticmethod
+    def tag_list() -> Tuple[str, ExitStatus]:
+        """TODO"""
+        return Terminal.shell_exec("git log --tags --simplify-by-decoration --pretty='format:%ci %d'")
+
+    @staticmethod
+    def create_tag(version: str, commit_id: str = "HEAD", description: str = None) -> Tuple[str, ExitStatus]:
+        """TODO"""
+        return Terminal.shell_exec(f"git tag -a v{version} {commit_id} -m '{description or version}'")
+
+    @staticmethod
+    def search_logs(filter_by: str = ".*") -> Tuple[str, ExitStatus]:
+        """TODO"""
+        return Terminal.shell_exec(f"git log --grep='{filter_by}' --pretty=format:'%h %ad %s' --date=short")
+
+    @staticmethod
+    def show_file(filename: str, commit_id: str = "HEAD") -> Tuple[str, ExitStatus]:
+        return Terminal.shell_exec(f"git show {commit_id}:{filename}")

clitt/.version

@@ -1 +1 @@
-0.9.118
+0.9.120

clitt/__init__.py

@@ -1,8 +1,8 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.118
+# hspylib-clitt v0.9.120
 #
-# Package: main.clitt
+# Package: main.build.lib.clitt
 """Package initialization."""
 
 __all__ = [
@@ -10,4 +10,4 @@ __all__ = [
     'core', 
     'utils'
 ]
-__version__ = '0.9.118'
+__version__ = '0.9.120'

clitt/addons/__init__.py

@@ -1,12 +1,12 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.118
+# hspylib-clitt v0.9.120
 #
-# Package: main.clitt.addons
+# Package: main.build.lib.clitt.addons
 """Package initialization."""
 
 __all__ = [
     'appman', 
     'widman'
 ]
-__version__ = '0.9.118'
+__version__ = '0.9.120'

clitt/addons/appman/__init__.py

@@ -1,8 +1,8 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.118
+# hspylib-clitt v0.9.120
 #
-# Package: main.clitt.addons.appman
+# Package: main.build.lib.clitt.addons.appman
 """Package initialization."""
 
 __all__ = [
@@ -10,4 +10,4 @@ __all__ = [
     'appman_enums', 
     'templates'
 ]
-__version__ = '0.9.118'
+__version__ = '0.9.120'

clitt/addons/appman/templates/__init__.py

@@ -1,11 +1,11 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.118
+# hspylib-clitt v0.9.120
 #
-# Package: main.clitt.addons.appman.templates
+# Package: main.build.lib.clitt.addons.appman.templates
 """Package initialization."""
 
 __all__ = [
     
 ]
-__version__ = '0.9.118'
+__version__ = '0.9.120'

clitt/addons/widman/__init__.py

@@ -1,8 +1,8 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.118
+# hspylib-clitt v0.9.120
 #
-# Package: main.clitt.addons.widman
+# Package: main.build.lib.clitt.addons.widman
 """Package initialization."""
 
 __all__ = [
@@ -11,4 +11,4 @@ __all__ = [
     'widgets', 
     'widman'
 ]
-__version__ = '0.9.118'
+__version__ = '0.9.120'

clitt/addons/widman/widgets/__init__.py

@@ -1,8 +1,8 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.118
+# hspylib-clitt v0.9.120
 #
-# Package: main.clitt.addons.widman.widgets
+# Package: main.build.lib.clitt.addons.widman.widgets
 """Package initialization."""
 
 __all__ = [
@@ -11,4 +11,4 @@ __all__ = [
     'widget_send_msg', 
     'widget_time_calc'
 ]
-__version__ = '0.9.118'
+__version__ = '0.9.120'

clitt/core/__init__.py

@@ -1,8 +1,8 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.118
+# hspylib-clitt v0.9.120
 #
-# Package: main.clitt.core
+# Package: main.build.lib.clitt.core
 """Package initialization."""
 
 __all__ = [
@@ -12,4 +12,4 @@ __all__ = [
     'term', 
     'tui'
 ]
-__version__ = '0.9.118'
+__version__ = '0.9.120'

clitt/core/exception/__init__.py

@@ -1,11 +1,11 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.118
+# hspylib-clitt v0.9.120
 #
-# Package: main.clitt.core.exception
+# Package: main.build.lib.clitt.core.exception
 """Package initialization."""
 
 __all__ = [
     'exceptions'
 ]
-__version__ = '0.9.118'
+__version__ = '0.9.120'

clitt/core/icons/__init__.py

@@ -1,12 +1,12 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.118
+# hspylib-clitt v0.9.120
 #
-# Package: main.clitt.core.icons
+# Package: main.build.lib.clitt.core.icons
 """Package initialization."""
 
 __all__ = [
     'emojis', 
     'font_awesome'
 ]
-__version__ = '0.9.118'
+__version__ = '0.9.120'

clitt/core/icons/emojis/__init__.py

@@ -1,12 +1,12 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.118
+# hspylib-clitt v0.9.120
 #
-# Package: main.clitt.core.icons.emojis
+# Package: main.build.lib.clitt.core.icons.emojis
 """Package initialization."""
 
 __all__ = [
     'emojis', 
     'face_smiling'
 ]
-__version__ = '0.9.118'
+__version__ = '0.9.120'

clitt/core/icons/font_awesome/__init__.py

@@ -1,8 +1,8 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.118
+# hspylib-clitt v0.9.120
 #
-# Package: main.clitt.core.icons.font_awesome
+# Package: main.build.lib.clitt.core.icons.font_awesome
 """Package initialization."""
 
 __all__ = [
@@ -15,4 +15,4 @@ __all__ = [
     'trickplay_icons', 
     'widget_icons'
 ]
-__version__ = '0.9.118'
+__version__ = '0.9.120'

clitt/core/term/__init__.py

@@ -1,8 +1,8 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.118
+# hspylib-clitt v0.9.120
 #
-# Package: main.clitt.core.term
+# Package: main.build.lib.clitt.core.term
 """Package initialization."""
 
 __all__ = [
@@ -11,4 +11,4 @@ __all__ = [
     'screen', 
     'terminal'
 ]
-__version__ = '0.9.118'
+__version__ = '0.9.120'

clitt/core/term/commons.py

@@ -13,18 +13,16 @@
    Copyright 2024, HSPyLib team
 """
 
-from clitt.core.exception.exceptions import NotATerminalError
-from hspylib.core.enums.enumeration import Enumeration
-from hspylib.core.tools.commons import is_debugging
-from hspylib.modules.cli.vt100.vt_100 import Vt100
-from shutil import get_terminal_size
-from typing import Callable, Tuple, TypeAlias, Union
-
-import logging as log
 import re
 import sys
 import termios
 import tty
+from shutil import get_terminal_size
+from typing import Callable, Tuple, TypeAlias, Union
+
+from hspylib.core.enums.enumeration import Enumeration
+from hspylib.core.tools.commons import is_debugging
+from hspylib.modules.cli.vt100.vt_100 import Vt100
 
 # fmt: off
 Dimension       : TypeAlias = Tuple[int, int]
@@ -37,7 +35,10 @@ EraseDirection  : TypeAlias = Union["Direction", "Portion"]
 
 def is_a_tty() -> bool:
     """Checks whether we are under a tty environment."""
-    return sys.stdout.isatty() and sys.stdin.isatty()
+    try:
+        return sys.stdout.isatty() and sys.stdin.isatty()
+    except ValueError:
+        return sys.stdout.isatty()
 
 
 class Direction(Enumeration):
@@ -65,7 +66,6 @@ def get_dimensions(fallback: Tuple[int, int] = (24, 80)) -> Tuple[int, int]:
     :return lines, columns
     """
     if not is_a_tty():
-        log.warning(NotATerminalError("get_dimensions:: Requires a terminal (TTY)"))
         return fallback
     dim = get_terminal_size((fallback[1], fallback[0]))
     return dim.lines, dim.columns
@@ -81,7 +81,6 @@ def get_cursor_position(fallback: Tuple[int, int] = (0, 0)) -> Tuple[int, int]:
         return pos
 
     if not is_a_tty():
-        log.warning(NotATerminalError("get_cursor_position:: Requires a terminal (TTY)"))
         return pos
 
     buf, re_query_resp = "", r"^\x1b\[(\d*);(\d*)R"
@@ -99,7 +98,7 @@ def get_cursor_position(fallback: Tuple[int, int] = (0, 0)) -> Tuple[int, int]:
             groups = matches.groups()
             pos = int(groups[0]), int(groups[1])
     except termios.error:
-        log.warning(NotATerminalError("get_cursor_position:: Requires a terminal (TTY)"))
+        pass
     finally:
         if stdin and attrs:
             termios.tcsetattr(stdin, termios.TCSANOW, attrs)  # Reset terminal attributes

clitt/core/tui/__init__.py

@@ -1,8 +1,8 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.118
+# hspylib-clitt v0.9.120
 #
-# Package: main.clitt.core.tui
+# Package: main.build.lib.clitt.core.tui
 """Package initialization."""
 
 __all__ = [
@@ -17,4 +17,4 @@ __all__ = [
     'tui_component', 
     'tui_preferences'
 ]
-__version__ = '0.9.118'
+__version__ = '0.9.120'

clitt/core/tui/line_input/__init__.py

@@ -1,12 +1,12 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.118
+# hspylib-clitt v0.9.120
 #
-# Package: main.clitt.core.tui.line_input
+# Package: main.build.lib.clitt.core.tui.line_input
 """Package initialization."""
 
 __all__ = [
     'keyboard_input', 
     'line_input'
 ]
-__version__ = '0.9.118'
+__version__ = '0.9.120'