hspylib-clitt 0.9.41__py3-none-any.whl → 0.9.51__py3-none-any.whl

clitt/.version

@@ -1 +1 @@
-0.9.41
+0.9.51

clitt/__classpath__.py

@@ -25,4 +25,4 @@ class _Classpath(Classpath):
 
 
 # Instantiate the classpath singleton
-_Classpath()
+assert _Classpath().INSTANCE is not None, "Failed to create Classpath instance"

clitt/__init__.py

@@ -1,12 +1,13 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.41
+# hspylib-clitt v0.9.51
 #
 # Package: main.clitt
 """Package initialization."""
 
 __all__ = [
   'addons', 
-  'core'
+  'core', 
+  'utils'
 ]
-__version__ = '0.9.41'
+__version__ = '0.9.51'

clitt/__main__.py

@@ -12,22 +12,20 @@
 
    Copyright 2023, HsPyLib team
 """
-from clitt.__classpath__ import _Classpath
-from clitt.addons.appman.appman import AppManager
-from clitt.addons.appman.appman_enums import AppExtension, AppType
-from clitt.addons.setman.setman import SetMan
-from clitt.addons.setman.setman_enums import SetmanOps, SettingsType
-from clitt.addons.widman.widman import WidgetManager
-from clitt.core.tui.tui_application import TUIApplication
+import sys
+
 from hspylib.core.enums.charset import Charset
 from hspylib.core.enums.enumeration import Enumeration
 from hspylib.core.tools.commons import run_dir, syserr
 from hspylib.core.tools.text_tools import strip_linebreaks
-from hspylib.modules.application.argparse.parser_action import ParserAction
 from hspylib.modules.application.exit_status import ExitStatus
 from hspylib.modules.application.version import Version
 
-import sys
+from clitt.__classpath__ import _Classpath
+from clitt.addons.appman.appman import AppManager
+from clitt.addons.appman.appman_enums import AppExtension, AppType
+from clitt.addons.widman.widman import WidgetManager
+from clitt.core.tui.tui_application import TUIApplication
 
 
 class Main(TUIApplication):
@@ -45,7 +43,6 @@ class Main(TUIApplication):
         # fmt: off
         APPMAN      = 'appman'
         WIDGETS     = 'widgets'
-        SETMAN      = 'setman'
         # fmt: on
 
         @property
@@ -85,25 +82,7 @@ class Main(TUIApplication):
                     'presented in a dashboard',
                     nargs='?') \
                 .add_parameter(
-                    'widget-args', "the widget's arguments (if applicable)", nargs='*') \
-            .argument(self.Addon.SETMAN.val, 'app Settings Manager: Manage your terminal settings') \
-                .add_parameter(
-                    'operation',
-                    'the operation to be performed against your settings. ',
-                    choices=SetmanOps.choices()) \
-                .add_option(
-                    'name', 'n', 'name',
-                    'the settings name. ', nargs='?') \
-                .add_option(
-                    'value', 'v', 'value',
-                    'the settings value. ', nargs='?') \
-                .add_option(
-                    'stype', 't', 'type',
-                    'the settings type. ',
-                    choices=SettingsType.choices()) \
-                .add_option(
-                    'simple', 's', 'simple',
-                    'display without formatting. ', action=ParserAction.STORE_TRUE)  # fmt: on
+                    'widget-args', "the widget's arguments (if applicable)", nargs='*')
 
     def _main(self, *params, **kwargs) -> ExitStatus:
         """Main entry point handler."""
@@ -117,8 +96,6 @@ class Main(TUIApplication):
             self.start_appman()
         elif app == self.Addon.WIDGETS.val:
             self.start_widman()
-        elif app == self.Addon.SETMAN.val:
-            self.start_setman()
         else:
             syserr(f"### Invalid Addon application: {app}")
             self.usage(ExitStatus.FAILED)
@@ -157,16 +134,6 @@ class Main(TUIApplication):
                     app_ext.append(AppExtension.GIT)
                 addon.create(args.app_name, AppType.of_value(args.app_type), list(app_ext), args.dest_dir or run_dir())
 
-    def start_setman(self) -> None:
-        """Start the Setman application."""
-        addon = SetMan(self)
-        op = SetmanOps.of_value(self.get_arg("operation"), ignore_case=True)
-        name = self.get_arg("name")
-        value = self.get_arg("value")
-        stype = self.get_arg("stype")
-        simple_fmt: bool = bool(self.get_arg("simple"))
-        addon.execute(op, name, value, SettingsType.of_value(stype) if stype else None, simple_fmt)
-
 
 # Application entry point
 if __name__ == "__main__":

clitt/addons/__init__.py

@@ -1,13 +1,12 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.41
+# hspylib-clitt v0.9.51
 #
 # Package: main.clitt.addons
 """Package initialization."""
 
 __all__ = [
   'appman', 
-  'setman', 
   'widman'
 ]
-__version__ = '0.9.41'
+__version__ = '0.9.51'

clitt/addons/appman/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.41
+# hspylib-clitt v0.9.51
 #
 # Package: main.clitt.addons.appman
 """Package initialization."""
@@ -10,4 +10,4 @@ __all__ = [
   'appman_enums', 
   'templates'
 ]
-__version__ = '0.9.41'
+__version__ = '0.9.51'

clitt/addons/appman/appman.py

@@ -13,6 +13,7 @@
    Copyright 2023, HsPyLib team
 """
 from clitt.addons.appman.appman_enums import AppExtension, AppType
+from clitt.core.term.terminal import Terminal
 from clitt.core.tui.minput.input_validator import InputValidator
 from clitt.core.tui.minput.minput import MenuInput, minput
 from hspylib.core.enums.charset import Charset
@@ -25,7 +26,6 @@ from hspylib.core.tools.text_tools import camelcase, ensure_endswith
 from hspylib.modules.application.application import Application
 from hspylib.modules.application.exit_status import ExitStatus
 from hspylib.modules.application.version import Version
-from hspylib.modules.cli.terminal import Terminal
 from hspylib.modules.fetch.fetch import get
 from textwrap import dedent
 from typing import List

clitt/addons/appman/templates/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.41
+# hspylib-clitt v0.9.51
 #
 # Package: main.clitt.addons.appman.templates
 """Package initialization."""
@@ -8,4 +8,4 @@
 __all__ = [
   
 ]
-__version__ = '0.9.41'
+__version__ = '0.9.51'

clitt/addons/widman/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.41
+# hspylib-clitt v0.9.51
 #
 # Package: main.clitt.addons.widman
 """Package initialization."""
@@ -11,4 +11,4 @@ __all__ = [
   'widgets', 
   'widman'
 ]
-__version__ = '0.9.41'
+__version__ = '0.9.51'

clitt/addons/widman/widgets/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.41
+# hspylib-clitt v0.9.51
 #
 # Package: main.clitt.addons.widman.widgets
 """Package initialization."""
@@ -11,4 +11,4 @@ __all__ = [
   'widget_send_msg', 
   'widget_time_calc'
 ]
-__version__ = '0.9.41'
+__version__ = '0.9.51'

clitt/addons/widman/widgets/widget_free.py

@@ -19,12 +19,13 @@ from hspylib.core.tools.commons import human_readable_bytes, sysout
 from hspylib.modules.application.exit_status import ExitStatus
 from hspylib.modules.application.version import Version
 from hspylib.modules.cli.keyboard import Keyboard
-from hspylib.modules.cli.terminal import Terminal
 from textwrap import dedent
 from time import sleep
 
 import re
 
+from clitt.core.terminal import Terminal
+
 
 class WidgetFree(Widget):
     """HsPyLib Widget to Report current system memory usage"""

clitt/addons/widman/widgets/widget_punch.py

@@ -21,7 +21,6 @@ from hspylib.core.zoned_datetime import now
 from hspylib.modules.application.argparse.argument_parser import HSArgumentParser
 from hspylib.modules.application.exit_status import ExitStatus
 from hspylib.modules.application.version import Version
-from hspylib.modules.cli.terminal import Terminal
 from textwrap import dedent
 from typing import List
 
@@ -30,6 +29,8 @@ import os
 import re
 import sys
 
+from clitt.core.terminal import Terminal
+
 
 class WidgetPunch(Widget):
     """HsPyLib Widget to Report current system memory usage"""
@@ -232,7 +233,7 @@ class WidgetPunch(Widget):
 
     def _edit_punches(self) -> None:
         """Open the default system editor to edit punches."""
-        Terminal.open_file(self.HHS_PUNCH_FILE)
+        Terminal.open(self.HHS_PUNCH_FILE)
 
     def _reset_punches(self) -> None:
         """Rename the punch file as a weekly punch file and reset current punch file."""

clitt/core/__init__.py

@@ -1,13 +1,13 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.41
+# hspylib-clitt v0.9.51
 #
 # Package: main.clitt.core
 """Package initialization."""
 
 __all__ = [
   'icons', 
-  'settings', 
+  'term', 
   'tui'
 ]
-__version__ = '0.9.41'
+__version__ = '0.9.51'

clitt/core/icons/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.41
+# hspylib-clitt v0.9.51
 #
 # Package: main.clitt.core.icons
 """Package initialization."""
@@ -9,4 +9,4 @@ __all__ = [
   'emojis', 
   'font_awesome'
 ]
-__version__ = '0.9.41'
+__version__ = '0.9.51'

clitt/core/icons/emojis/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.41
+# hspylib-clitt v0.9.51
 #
 # Package: main.clitt.core.icons.emojis
 """Package initialization."""
@@ -9,4 +9,4 @@ __all__ = [
   'emojis', 
   'face_smiling'
 ]
-__version__ = '0.9.41'
+__version__ = '0.9.51'

clitt/core/icons/font_awesome/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.41
+# hspylib-clitt v0.9.51
 #
 # Package: main.clitt.core.icons.font_awesome
 """Package initialization."""
@@ -14,4 +14,4 @@ __all__ = [
   'nav_icons', 
   'widget_icons'
 ]
-__version__ = '0.9.41'
+__version__ = '0.9.51'

clitt/core/term/__init__.py

@@ -0,0 +1,14 @@
+# _*_ coding: utf-8 _*_
+#
+# hspylib-clitt v0.9.51
+#
+# Package: main.clitt.core.term
+"""Package initialization."""
+
+__all__ = [
+  'commons', 
+  'cursor', 
+  'screen', 
+  'terminal'
+]
+__version__ = '0.9.51'

clitt/core/term/commons.py

@@ -0,0 +1,63 @@
+import logging as log
+import re
+import sys
+import termios
+import tty
+from shutil import get_terminal_size
+from typing import TypeVar, Tuple, Callable, Union
+
+from hspylib.core.exception.exceptions import NotATerminalError
+from hspylib.core.tools.commons import is_debugging
+from hspylib.modules.cli.vt100.vt_100 import Vt100
+
+DIMENSION = TypeVar("DIMENSION", bound=Tuple[int, int])
+
+POSITION = TypeVar("POSITION", bound=Tuple[int, int])
+
+CB_RESIZE = TypeVar("CB_RESIZE", bound=Callable[[None], None])
+
+MOVE_DIRECTION = TypeVar("MOVE_DIRECTION", bound="Cursor.Direction")
+
+ERASE_DIRECTION = TypeVar("ERASE_DIRECTION", bound=Union["Cursor.Direction", "Screen.Portion"])
+
+
+def get_dimensions(fallback: Tuple[int, int] = (24, 80)) -> Tuple[int, int]:
+    """Retrieve the size of the terminal.
+    :return lines, columns
+    """
+    if not sys.stdout.isatty():
+        log.error(NotATerminalError("screen_size:: Requires a terminal (TTY)"))
+        return fallback
+    dim = get_terminal_size((fallback[1], fallback[0]))
+    return dim.lines, dim.columns
+
+
+def get_cursor_position(fallback: Tuple[int, int] = (0, 0)) -> Tuple[int, int]:
+    """Get the terminal cursor position.
+    :return line, column
+    """
+    pos, buf = fallback, ""
+
+    if not sys.stdout.isatty():
+        log.error(NotATerminalError("get_cursor_position:: Requires a terminal (TTY)"))
+        return pos
+
+    if is_debugging():
+        return pos
+
+    stdin = sys.stdin.fileno()  # Get the stdin file descriptor.
+    attrs = termios.tcgetattr(stdin)  # Save terminal attributes.
+
+    try:
+        tty.setcbreak(stdin, termios.TCSANOW)
+        sys.stdout.write(Vt100.get_cursor_pos())
+        sys.stdout.flush()
+        while not buf or buf[-1] != "R":
+            buf += sys.stdin.read(1)
+        if matches := re.match(r"^\x1b\[(\d*);(\d*)R", buf):  # If the response is 'Esc[r;cR'
+            groups = matches.groups()
+            pos = int(groups[0]), int(groups[1])
+    finally:
+        termios.tcsetattr(stdin, termios.TCSANOW, attrs)  # Reset terminal attributes
+
+    return pos

clitt/core/term/cursor.py

@@ -0,0 +1,124 @@
+import os
+from typing import Any
+
+from hspylib.core.enums.enumeration import Enumeration
+from hspylib.core.metaclass.singleton import Singleton
+from hspylib.core.tools.commons import sysout
+from hspylib.core.tools.text_tools import last_index_of
+from hspylib.modules.cli.vt100.vt_100 import Vt100
+from hspylib.modules.cli.vt100.vt_code import VtCode
+from hspylib.modules.cli.vt100.vt_color import VtColor
+
+from clitt.core.term.commons import POSITION, MOVE_DIRECTION, ERASE_DIRECTION, get_cursor_position
+
+
+class Cursor(metaclass=Singleton):
+    """Provide a base class for the screen cursor."""
+
+    INSTANCE = None
+
+    CURSOR_HOME = 1, 1
+
+    class Direction(Enumeration):
+        """Provide a base class for the cursor direction."""
+        # fmt: off
+        UP          = '%ED1%', '%CUU({n})%'   # Cursor up (line)
+        RIGHT       = '%EL0%', '%CUF({n})%'   # Cursor right (forward)
+        DOWN        = '%ED0%', '%CUD({n})%'   # Cursor down (line)
+        LEFT        = '%EL1%', '%CUB({n})%'   # Cursor left (backward)
+        # fmt: on
+
+    def __init__(self):
+        self._position: POSITION = get_cursor_position() or self.CURSOR_HOME
+        self._bottom: POSITION = self.CURSOR_HOME
+        self._saved_attrs = self._position, self._bottom
+
+    def __str__(self):
+        return f"({', '.join(list(map(str, self._position)))})"
+
+    def __repr__(self):
+        return str(self)
+
+    @property
+    def position(self) -> POSITION:
+        return self._position
+
+    @position.setter
+    def position(self, new_position: POSITION) -> None:
+        self._bottom = (new_position[0], new_position[1]) if new_position >= self._bottom else self._bottom
+        self._position = new_position
+
+    @property
+    def bottom(self) -> POSITION:
+        return self._bottom
+
+    def home(self) -> None:
+        """Move the cursor to home position."""
+        self.move_to(self.CURSOR_HOME[0], self.CURSOR_HOME[1])
+
+    def end(self) -> None:
+        """Move the cursor to the bottom most position on the screen."""
+        self.move_to(self.bottom[0], self.bottom[1])
+
+    def move_to(self, row: int = None, column: int = None) -> POSITION:
+        """Move the cursor to the specified position."""
+        row_pos = max(self.CURSOR_HOME[0], row if row is not None else self.position[0])
+        col_pos = max(self.CURSOR_HOME[1], column if column is not None else self.position[1])
+        sysout(f"%CUP({row_pos};{col_pos})%", end="")
+        self.position = row_pos, col_pos
+        return self.position
+
+    def move(self, amount: int, direction: MOVE_DIRECTION) -> POSITION:
+        """Move the cursor towards the specified direction."""
+        sysout(direction.value[1].format(n=amount), end="")
+        row_pos, col_pos = self.position
+        match direction:
+            case Cursor.Direction.UP:
+                row_pos -= max(0, amount)
+            case Cursor.Direction.DOWN:
+                row_pos += max(0, amount)
+            case Cursor.Direction.LEFT:
+                col_pos -= max(0, amount)
+            case Cursor.Direction.RIGHT:
+                col_pos += max(0, amount)
+        self.position = row_pos, col_pos
+        return self.position
+
+    def erase(self, direction: ERASE_DIRECTION) -> POSITION:
+        """Erase the screen following the specified direction.
+        Note: It does not move the cursor along the way."""
+        sysout(direction.value[0], end="")
+        return self.position
+
+    def track(self) -> POSITION:
+        """Track the cursor position."""
+        self.position = get_cursor_position() or self.position
+        return self.position
+
+    def write(self, obj: Any, end: str = "") -> POSITION:
+        """Write the string representation of the object to the screen."""
+        sysout(obj, end=end)
+        text = (str(obj) + end).replace("%EOL%", os.linesep)
+        text = VtColor.strip_colors(VtCode.strip_codes(text))
+        text_offset = len(text[max(0, last_index_of(text, os.linesep)):])
+        self.position = self.position[0] + text.count(os.linesep), text_offset + (
+            self.position[1] if text.count(os.linesep) == 0 else 0
+        )
+        return self.position
+
+    def writeln(self, obj: Any) -> POSITION:
+        """Write the string representation of the object to the screen, appending a new line."""
+        return self.write(obj, end=os.linesep)
+
+    def save(self) -> POSITION:
+        """Save the current cursor position and attributes."""
+        sysout(Vt100.save_cursor(), end="")
+        self._saved_attrs = self._position, self._bottom
+        return self.position
+
+    def restore(self) -> POSITION:
+        """Save the current cursor position and attributes."""
+        sysout(Vt100.restore_cursor(), end="")
+        self._position = self._saved_attrs[0]
+        self._bottom = self._saved_attrs[1]
+        return self.position

clitt/core/term/screen.py

@@ -0,0 +1,96 @@
+import threading
+from threading import Timer
+from typing import Optional, List
+
+from hspylib.core.enums.enumeration import Enumeration
+from hspylib.core.metaclass.singleton import Singleton
+from hspylib.core.tools.commons import sysout
+
+from clitt.core.term.commons import DIMENSION, CB_RESIZE, get_dimensions
+from clitt.core.term.cursor import Cursor
+from clitt.core.tui.tui_preferences import TUIPreferences
+
+
+class Screen(metaclass=Singleton):
+    """Provide a base class for terminal UI components."""
+
+    INSTANCE = None
+
+    RESIZE_WATCH_INTERVAL = 0.5
+
+    class Portion(Enumeration):
+        """Provide a base class for the portions of the screen."""
+        # fmt: off
+        SCREEN      = '%ED2%', ''   # Entire screen (screen)
+        LINE        = '%EL2%', ''   # Entire line (line)
+        # fmt: on
+
+    def __init__(self):
+        self._preferences: TUIPreferences = TUIPreferences.INSTANCE
+        self._dimension: DIMENSION = get_dimensions()
+        self._cursor: Cursor = Cursor.INSTANCE or Cursor()
+        self._resize_timer: Optional[Timer] = None
+        self._cb_watchers: List[CB_RESIZE] = []
+        self._alternate: bool = False
+        self._resize_watcher()
+
+    def __str__(self):
+        return f"Terminal.Screen(rows={self.lines}, columns={self.columns}, cursor={self.cursor})"
+
+    def __repr__(self):
+        return str(self)
+
+    @property
+    def preferences(self) -> TUIPreferences:
+        return self._preferences
+
+    @property
+    def dimension(self) -> DIMENSION:
+        return self._dimension
+
+    @property
+    def lines(self) -> int:
+        return self._dimension[0]
+
+    @property
+    def columns(self) -> int:
+        return self._dimension[1]
+
+    @property
+    def cursor(self) -> Cursor:
+        return self._cursor
+
+    @property
+    def alternate(self) -> bool:
+        return self._alternate
+
+    @alternate.setter
+    def alternate(self, enable: bool) -> None:
+        """Switch to the alternate screen buffer.
+        :param enable: alternate enable on/off.
+        """
+        self._alternate = enable
+        sysout(f"%SC{'A' if enable else 'M'}%", end="")
+        self.cursor.track()
+
+    def clear(self) -> None:
+        """Clear terminal and move the cursor to HOME position (0, 0)."""
+        sysout("%ED2%%HOM%", end="")
+        self.cursor.home()
+
+    def add_watcher(self, watcher: CB_RESIZE) -> None:
+        """Add a resize watcher."""
+        self._cb_watchers.append(watcher)
+        if not self._resize_timer:
+            self._resize_watcher()
+
+    def _resize_watcher(self) -> None:
+        """Add a watcher for screen resizes. If a resize is detected, the callback is called with the
+        new dimension."""
+        if self._cb_watchers and threading.main_thread().is_alive():
+            dimension: DIMENSION = get_dimensions()
+            self._resize_timer = Timer(self.RESIZE_WATCH_INTERVAL, self._resize_watcher)
+            if dimension != self._dimension:
+                list(map(lambda cb_w: cb_w(), self._cb_watchers))
+                self._dimension = dimension
+            self._resize_timer.start()