hspylib-clitt 0.9.117__py3-none-any.whl → 0.9.119__py3-none-any.whl

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.117
+0.9.119

clitt/__init__.py

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

clitt/addons/__init__.py

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

clitt/addons/appman/__init__.py

@@ -1,8 +1,8 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.117
+# hspylib-clitt v0.9.119
 #
-# 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.117'
+__version__ = '0.9.119'

clitt/addons/appman/templates/__init__.py

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

clitt/addons/widman/__init__.py

@@ -1,8 +1,8 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.117
+# hspylib-clitt v0.9.119
 #
-# 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.117'
+__version__ = '0.9.119'

clitt/addons/widman/widgets/__init__.py

@@ -1,8 +1,8 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.117
+# hspylib-clitt v0.9.119
 #
-# 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.117'
+__version__ = '0.9.119'

clitt/core/__init__.py

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

clitt/core/exception/__init__.py

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

clitt/core/exception/exceptions.py

@@ -16,3 +16,4 @@
 
 class NotATerminalError(NotImplementedError):
     """Raised when a TTY terminal is required"""
+

clitt/core/icons/__init__.py

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

clitt/core/icons/emojis/__init__.py

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

clitt/core/icons/font_awesome/__init__.py

@@ -1,8 +1,8 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.117
+# hspylib-clitt v0.9.119
 #
-# 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.117'
+__version__ = '0.9.119'

clitt/core/term/__init__.py

@@ -1,8 +1,8 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.117
+# hspylib-clitt v0.9.119
 #
-# 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.117'
+__version__ = '0.9.119'

clitt/core/term/commons.py

@@ -1,15 +1,28 @@
-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
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+   @project: hspylib-clitt
+   @package: hspylib-clitt.main.clitt.core.term
+      @file: commons.py
+   @created: Wed, 20 Mar 2024
+    @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 2024, HSPyLib team
+"""
 
-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]
@@ -20,6 +33,14 @@ EraseDirection  : TypeAlias = Union["Direction", "Portion"]
 # fmt: on
 
 
+def is_a_tty() -> bool:
+    """Checks whether we are under a tty environment."""
+    try:
+        return sys.stdout.isatty() and sys.stdin.isatty()
+    except ValueError:
+        return sys.stdout.isatty()
+
+
 class Direction(Enumeration):
     """Provide a base class for the cursor direction."""
 
@@ -44,8 +65,7 @@ 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.warning(NotATerminalError("get_dimensions:: Requires a terminal (TTY)"))
+    if not is_a_tty():
         return fallback
     dim = get_terminal_size((fallback[1], fallback[0]))
     return dim.lines, dim.columns
@@ -55,19 +75,20 @@ def get_cursor_position(fallback: Tuple[int, int] = (0, 0)) -> Tuple[int, int]:
     """Get the terminal cursor position.
     :return line, column
     """
-    pos, buf, re_query_resp = fallback, "", r"^\x1b\[(\d*);(\d*)R"
+    pos = fallback
 
-    if not sys.stdout.isatty():
-        log.warning(NotATerminalError("get_cursor_position:: Requires a terminal (TTY)"))
+    if is_debugging():
         return pos
 
-    if is_debugging():
+    if not is_a_tty():
         return pos
 
-    stdin = sys.stdin.fileno()  # Get the stdin file descriptor.
-    attrs = termios.tcgetattr(stdin)  # Save terminal attributes.
+    buf, re_query_resp = "", r"^\x1b\[(\d*);(\d*)R"
+    stdin, attrs = None, None
 
     try:
+        stdin = sys.stdin.fileno()  # Get the stdin file descriptor.
+        attrs = termios.tcgetattr(stdin)  # Save terminal attributes.
         tty.setcbreak(stdin, termios.TCSANOW)
         sys.stdout.write(Vt100.get_cursor_pos())
         sys.stdout.flush()
@@ -76,7 +97,10 @@ def get_cursor_position(fallback: Tuple[int, int] = (0, 0)) -> Tuple[int, int]:
         if matches := re.match(re_query_resp, buf):  # If the response is 'Esc[r;cR'
             groups = matches.groups()
             pos = int(groups[0]), int(groups[1])
+    except termios.error:
+        pass
     finally:
-        termios.tcsetattr(stdin, termios.TCSANOW, attrs)  # Reset terminal attributes
+        if stdin and attrs:
+            termios.tcsetattr(stdin, termios.TCSANOW, attrs)  # Reset terminal attributes
 
     return pos

clitt/core/term/cursor.py

@@ -1,4 +1,19 @@
-import os
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+   @project: hspylib-clitt
+   @package: hspylib-clitt.main.clitt.core.term
+      @file: cursor.py
+   @created: Wed, 20 Mar 2024
+    @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 2024, HSPyLib team
+"""
+
+from clitt.core.term.commons import Direction, EraseDirection, get_cursor_position, MoveDirection, Portion, Position
 from hspylib.core.metaclass.singleton import Singleton
 from hspylib.core.tools.commons import sysout
 from hspylib.core.tools.text_tools import last_index_of
@@ -7,7 +22,7 @@ from hspylib.modules.cli.vt100.vt_code import VtCode
 from hspylib.modules.cli.vt100.vt_color import VtColor
 from typing import Any
 
-from clitt.core.term.commons import Direction, EraseDirection, get_cursor_position, MoveDirection, Position, Portion
+import os
 
 
 class Cursor(metaclass=Singleton):
@@ -120,7 +135,7 @@ class Cursor(metaclass=Singleton):
         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)):])
+        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
         )

clitt/core/term/screen.py

@@ -1,3 +1,18 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+   @project: hspylib-clitt
+   @package: hspylib-clitt.main.clitt.core.term
+      @file: screen.py
+   @created: Wed, 20 Mar 2024
+    @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 2024, HSPyLib team
+"""
+
 from clitt.core.term.commons import Dimension, get_dimensions, Portion, Resize_Cb
 from clitt.core.term.cursor import Cursor
 from clitt.core.tui.tui_preferences import TUIPreferences

clitt/core/term/terminal.py

@@ -12,27 +12,26 @@
 
    Copyright·(c)·2024,·HSPyLib
 """
-import atexit
-import logging as log
-import os
-import platform
-import select
-import shlex
-import signal
-import sys
-from subprocess import CalledProcessError, Popen, PIPE
-from typing import Any, Optional, Tuple, List, Iterable
-
+from clitt.core.exception.exceptions import NotATerminalError
+from clitt.core.term.commons import is_a_tty
+from clitt.core.term.cursor import Cursor
+from clitt.core.term.screen import Screen
 from hspylib.core.enums.charset import Charset
 from hspylib.core.metaclass.singleton import Singleton
 from hspylib.core.tools.commons import sysout
 from hspylib.modules.application.exit_status import ExitStatus
 from hspylib.modules.cli.keyboard import Keyboard
 from hspylib.modules.cli.vt100.vt_100 import Vt100
+from subprocess import CalledProcessError, PIPE, Popen
+from typing import Any, Iterable, List, Optional, Tuple
 
-from clitt.core.exception.exceptions import NotATerminalError
-from clitt.core.term.cursor import Cursor
-from clitt.core.term.screen import Screen
+import atexit
+import logging as log
+import os
+import platform
+import select
+import shlex
+import signal
 
 
 class Terminal(metaclass=Singleton):
@@ -42,7 +41,7 @@ class Terminal(metaclass=Singleton):
 
     @staticmethod
     def is_a_tty() -> bool:
-        return sys.stdout.isatty()
+        return is_a_tty()
 
     @staticmethod
     def _chain_pipes(cmd_list: Iterable, **kwargs) -> Popen:
@@ -55,7 +54,7 @@ class Terminal(metaclass=Singleton):
             del kwargs["stderr"]
         if "stdin" in kwargs:
             del kwargs["stdin"]
-        commands = map(shlex.split, cmd_list) if 'shell' not in kwargs else cmd_list
+        commands = map(shlex.split, cmd_list) if "shell" not in kwargs else cmd_list
         first_cmd, *rest_cmds = commands
         if len(rest_cmds) > 0:
             procs: List[Popen] = [Popen(first_cmd, stdout=PIPE, stderr=PIPE, **kwargs)]

clitt/core/tui/__init__.py

@@ -1,8 +1,8 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.117
+# hspylib-clitt v0.9.119
 #
-# 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.117'
+__version__ = '0.9.119'

clitt/core/tui/line_input/__init__.py

@@ -1,12 +1,12 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.117
+# hspylib-clitt v0.9.119
 #
-# 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.117'
+__version__ = '0.9.119'

clitt/core/tui/line_input/keyboard_input.py

@@ -13,15 +13,14 @@
    Copyright·(c)·2024,·HSPyLib
 """
 
-from typing import Optional, List, Dict
-
-import pyperclip
-from hspylib.modules.cli.keyboard import Keyboard
-from hspylib.modules.cli.vt100.vt_color import VtColor
-
 from clitt.core.term.commons import Direction
 from clitt.core.term.terminal import Terminal
 from clitt.core.tui.tui_component import TUIComponent
+from hspylib.modules.cli.keyboard import Keyboard
+from hspylib.modules.cli.vt100.vt_color import VtColor
+from typing import Dict, List, Optional
+
+import pyperclip
 
 
 class KeyboardInput(TUIComponent):
@@ -42,7 +41,8 @@ class KeyboardInput(TUIComponent):
     @staticmethod
     def preload_history(history: List[str]) -> None:
         """Preload the input with the provided dictionary."""
-        for entry in history:
+        rev_history = reversed(history)
+        for entry in rev_history:
             KeyboardInput._add_history(entry)
         KeyboardInput._HIST_INDEX = 0
 
@@ -97,10 +97,11 @@ class KeyboardInput(TUIComponent):
         return text
 
     def __init__(
-        self, prompt: str = "",
+        self,
+        prompt: str = "",
         prompt_color: VtColor = VtColor.NC,
         text_color: VtColor = VtColor.NC,
-        navbar_enable: bool = False
+        navbar_enable: bool = False,
     ):
         super().__init__(prompt)
         self._prompt_color = prompt_color
@@ -168,18 +169,18 @@ class KeyboardInput(TUIComponent):
                     if self._input_index > 0:
                         self._input_index = max(0, self._input_index - 1)
                         self._update_input(
-                            self._input_text[: self._input_index] + self._input_text[1 + self._input_index:]
+                            self._input_text[: self._input_index] + self._input_text[1 + self._input_index :]
                         )
                 case Keyboard.VK_DELETE:
                     self._update_input(
-                        self._input_text[: self._input_index] + self._input_text[1 + self._input_index:]
+                        self._input_text[: self._input_index] + self._input_text[1 + self._input_index :]
                     )
                 case Keyboard.VK_CTRL_F:  # Forget history
                     self.forget_history()
                 case Keyboard.VK_CTRL_P:  # Paste from clipboard
-                    text = (pyperclip.paste() or '').replace("\n", "↵")
+                    text = (pyperclip.paste() or "").replace("\n", "↵")
                     self._update_input(
-                        self._input_text[: self._input_index] + text + self._input_text[self._input_index:]
+                        self._input_text[: self._input_index] + text + self._input_text[self._input_index :]
                     )
                     self._input_index += len(text)
                 case Keyboard.VK_CTRL_R:  # Reset contents
@@ -201,7 +202,7 @@ class KeyboardInput(TUIComponent):
                     self._input_index = self.length
                 case _ as key if key.val.isprintable():
                     self._update_input(
-                        self._input_text[: self._input_index] + key.val + self._input_text[self._input_index:]
+                        self._input_text[: self._input_index] + key.val + self._input_text[self._input_index :]
                     )
                     self._input_index += 1
                 case _ as key if key in Keyboard.break_keys():

clitt/core/tui/line_input/line_input.py

@@ -12,18 +12,14 @@
 
    Copyright·(c)·2024,·HSPyLib
 """
+from clitt.core.tui.line_input.keyboard_input import KeyboardInput
 from hspylib.modules.cli.keyboard import Keyboard
 from hspylib.modules.cli.vt100.vt_color import VtColor
 from typing import Optional
 
-from clitt.core.tui.line_input.keyboard_input import KeyboardInput
-
 
 def line_input(
-    prompt: str = "",
-    prompt_color: VtColor = VtColor.NC,
-    text_color: VtColor = VtColor.NC,
-    navbar_enable: bool = False
+    prompt: str = "", prompt_color: VtColor = VtColor.NC, text_color: VtColor = VtColor.NC, navbar_enable: bool = False
 ) -> Optional[str | Keyboard]:
     """Read a string from standard input.
     :param prompt: The message to be displayed to the user.

clitt/core/tui/mchoose/__init__.py

@@ -1,12 +1,12 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.117
+# hspylib-clitt v0.9.119
 #
-# Package: main.clitt.core.tui.mchoose
+# Package: main.build.lib.clitt.core.tui.mchoose
 """Package initialization."""
 
 __all__ = [
     'mchoose', 
     'menu_choose'
 ]
-__version__ = '0.9.117'
+__version__ = '0.9.119'

clitt/core/tui/mchoose/mchoose.py

@@ -12,11 +12,10 @@
 
    Copyright·(c)·2024,·HSPyLib
 """
+from clitt.core.tui.mchoose.menu_choose import MenuChoose
 from hspylib.core.enums.charset import Charset
 from typing import List, Optional, TypeVar
 
-from clitt.core.tui.mchoose.menu_choose import MenuChoose
-
 T = TypeVar("T")
 
 
@@ -24,7 +23,7 @@ def mchoose(
     items: List[T],
     checked: bool | List[bool] = False,
     title: str = "Please choose among the options",
-    output: str = None
+    output: str = None,
 ) -> Optional[List[T]]:
     """
     Terminal UI menu choose input method.