hspylib-clitt 0.9.116__tar.gz → 0.9.118__tar.gz

{hspylib-clitt-0.9.116/hspylib_clitt.egg-info → hspylib-clitt-0.9.118}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hspylib-clitt
-Version: 0.9.116
+Version: 0.9.118
 Summary: HsPyLib - CLI Terminal Tools
 Home-page: https://github.com/yorevs/hspylib
 Author: Hugo Saporetti Junior
@@ -35,7 +35,7 @@ Requires-Dist: urllib3<2.0.0
 ## Create professional CLI applications
 
 [![License](https://badgen.net/badge/license/MIT/gray)](LICENSE.md)
-[![Release](https://badgen.net/badge/release/v0.9.116/gray)](CHANGELOG.md#unreleased)
+[![Release](https://badgen.net/badge/release/v0.9.118/gray)](CHANGELOG.md#unreleased)
 [![PyPi](https://badgen.net/badge/icon/python?icon=pypi&label)](https://pypi.org/project/hspylib-clitt)
 [![GitHub](https://badgen.net/badge/icon/github?icon=github&label)](https://github.com/yorevs/hspylib)
 [![Gitter](https://badgen.net/badge/icon/gitter?icon=gitter&label)](https://gitter.im/hspylib/community)

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/README.md

@@ -3,7 +3,7 @@
 ## Create professional CLI applications
 
 [![License](https://badgen.net/badge/license/MIT/gray)](LICENSE.md)
-[![Release](https://badgen.net/badge/release/v0.9.116/gray)](CHANGELOG.md#unreleased)
+[![Release](https://badgen.net/badge/release/v0.9.118/gray)](CHANGELOG.md#unreleased)
 [![PyPi](https://badgen.net/badge/icon/python?icon=pypi&label)](https://pypi.org/project/hspylib-clitt)
 [![GitHub](https://badgen.net/badge/icon/github?icon=github&label)](https://github.com/yorevs/hspylib)
 [![Gitter](https://badgen.net/badge/icon/gitter?icon=gitter&label)](https://gitter.im/hspylib/community)

hspylib-clitt-0.9.118/clitt/.version

@@ -0,0 +1 @@
+0.9.118

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/__classpath__.py

@@ -18,11 +18,11 @@ from hspylib.core.tools.commons import get_path, run_dir
 
 
 class _Classpath(Classpath):
-    """TODO"""
+    """Provide a class to help locating user-defined classes, packages, sources and resources."""
 
     def __init__(self):
         super().__init__(get_path(__file__), get_path(run_dir()), (get_path(__file__) / "resources"))
 
 
 # Instantiate the classpath singleton
-assert _Classpath().INSTANCE is not None, "Failed to create Classpath instance"
+assert (classpath := _Classpath().INSTANCE) is not None, "Failed to create Classpath instance"

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/__init__.py

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

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/__main__.py

@@ -12,7 +12,7 @@
 
    Copyright·(c)·2024,·HSPyLib
 """
-from clitt.__classpath__ import _Classpath
+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
@@ -31,10 +31,10 @@ class Main(TUIApplication):
     """HsPyLib CLI Terminal Tools - Create professional CLI applications."""
 
     # The welcome message
-    DESCRIPTION = _Classpath.get_source_path("welcome.txt").read_text(encoding=Charset.UTF_8.val)
+    DESCRIPTION = classpath.get_source("welcome.txt").read_text(encoding=Charset.UTF_8.val)
 
     # Location of the .version file
-    VERSION_DIR = _Classpath.source_path()
+    VERSION_DIR = classpath.source_path()
 
     class Addon(Enumeration):
         """HsPyLib addon types."""

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/addons/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.116
+# hspylib-clitt v0.9.118
 #
 # Package: main.clitt.addons
 """Package initialization."""
@@ -9,4 +9,4 @@ __all__ = [
     'appman', 
     'widman'
 ]
-__version__ = '0.9.116'
+__version__ = '0.9.118'

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/addons/appman/__init__.py

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

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/addons/appman/templates/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.116
+# hspylib-clitt v0.9.118
 #
 # Package: main.clitt.addons.appman.templates
 """Package initialization."""
@@ -8,4 +8,4 @@
 __all__ = [
     
 ]
-__version__ = '0.9.116'
+__version__ = '0.9.118'

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/addons/appman/templates/main_qt_view.py.tpl

@@ -6,7 +6,7 @@ from %APP_NAME%.__classpath__ import _Classpath
 
 class MainQtView(QtView):
     """Main application view"""
-    VERSION = _Classpath.get_source_path(".version").read_text(encoding=Charset.UTF_8.val)
+    VERSION = classpath.get_source(".version").read_text(encoding=Charset.UTF_8.val)
 
     FORMS_DIR = str(_Classpath.resource_path() / "forms")
 

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/addons/widman/__init__.py

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

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/addons/widman/widgets/__init__.py

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

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/core/__init__.py

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

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/core/exception/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.116
+# hspylib-clitt v0.9.118
 #
 # Package: main.clitt.core.exception
 """Package initialization."""
@@ -8,4 +8,4 @@
 __all__ = [
     'exceptions'
 ]
-__version__ = '0.9.116'
+__version__ = '0.9.118'

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/core/exception/exceptions.py

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

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/core/icons/__init__.py

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

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/core/icons/emojis/__init__.py

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

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/core/icons/font_awesome/__init__.py

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

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/core/term/__init__.py

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

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/core/term/commons.py

@@ -1,3 +1,18 @@
+#!/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
+"""
+
 from clitt.core.exception.exceptions import NotATerminalError
 from hspylib.core.enums.enumeration import Enumeration
 from hspylib.core.tools.commons import is_debugging
@@ -20,6 +35,11 @@ EraseDirection  : TypeAlias = Union["Direction", "Portion"]
 # fmt: on
 
 
+def is_a_tty() -> bool:
+    """Checks whether we are under a tty environment."""
+    return sys.stdout.isatty() and sys.stdin.isatty()
+
+
 class Direction(Enumeration):
     """Provide a base class for the cursor direction."""
 
@@ -44,7 +64,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():
+    if not is_a_tty():
         log.warning(NotATerminalError("get_dimensions:: Requires a terminal (TTY)"))
         return fallback
     dim = get_terminal_size((fallback[1], fallback[0]))
@@ -55,19 +75,21 @@ 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():
+        log.warning(NotATerminalError("get_cursor_position:: Requires a terminal (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 +98,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:
+        log.warning(NotATerminalError("get_cursor_position:: Requires a terminal (TTY)"))
     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

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/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
         )
@@ -156,4 +171,4 @@ class Cursor(metaclass=Singleton):
         return self.position
 
 
-assert Cursor().INSTANCE is not None, "Failed to create Cursor instance"
+assert (cursor := Cursor().INSTANCE) is not None, "Failed to create Cursor instance"

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/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
@@ -88,4 +103,4 @@ class Screen(metaclass=Singleton):
             self._resize_timer.start()
 
 
-assert Screen().INSTANCE is not None, "Failed to create Screen instance"
+assert (screen := Screen().INSTANCE) is not None, "Failed to create Screen instance"

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/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)]
@@ -200,4 +199,4 @@ class Terminal(metaclass=Singleton):
         return self.screen.cursor
 
 
-assert Terminal().INSTANCE is not None, "Failed to create Terminal instance"
+assert (terminal := Terminal().INSTANCE) is not None, "Failed to create Terminal instance"

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/core/tui/__init__.py

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

{hspylib-clitt-0.9.116 → hspylib-clitt-0.9.118}/clitt/core/tui/line_input/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.116
+# hspylib-clitt v0.9.118
 #
 # Package: main.clitt.core.tui.line_input
 """Package initialization."""
@@ -9,4 +9,4 @@ __all__ = [
     'keyboard_input', 
     'line_input'
 ]
-__version__ = '0.9.116'
+__version__ = '0.9.118'