v1.5.8

Author: Paebbels

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+"files.trimTrailingWhitespace": false,
+}

doc/Dependencies.rst

@@ -69,7 +69,7 @@ the mandatory dependencies too.
 +-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
 | **Package**                                               | **Version** | **License**                                                                            | **Dependencies**     |
 +===========================================================+=============+========================================================================================+======================+
-| `pytest <https://GitHub.com/pytest-dev/pytest>`__         | ≥7.0.1      | `MIT <https://GitHub.com/pytest-dev/pytest/blob/master/LICENSE>`__                     | *Not yet evaluated.* |
+| `pytest <https://GitHub.com/pytest-dev/pytest>`__         | ≥7.1.1      | `MIT <https://GitHub.com/pytest-dev/pytest/blob/master/LICENSE>`__                     | *Not yet evaluated.* |
 +-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
 | `pytest-cov <https://GitHub.com/pytest-dev/pytest-cov>`__ | ≥3.0.0      | `MIT <https://GitHub.com/pytest-dev/pytest-cov/blob/master/LICENSE>`__                 | *Not yet evaluated.* |
 +-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
@@ -105,13 +105,13 @@ the mandatory dependencies too.
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
 | **Package**                                                                                     | **Version**  | **License**                                                                                              | **Dependencies**     |
 +=================================================================================================+==============+==========================================================================================================+======================+
-| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__                                               | ≥4.4.0       | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__                              | *Not yet evaluated.* |
+| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__                                               | ≥4.5.0       | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__                              | *Not yet evaluated.* |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
 | `sphinx_btd_theme <https://GitHub.com/buildthedocs/sphinx.theme>`__                             | ≥0.5.2       | `MIT <https://GitHub.com/buildthedocs/sphinx.theme/blob/master/LICENSE>`__                               | *Not yet evaluated.* |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
 | !! `sphinx_fontawesome <https://GitHub.com/fraoustin/sphinx_fontawesome>`__                     | ≥0.0.6       | `GPL 2.0 <https://GitHub.com/fraoustin/sphinx_fontawesome/blob/master/LICENSE>`__                        | *Not yet evaluated.* |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
-| `sphinx_autodoc_typehints <https://GitHub.com/agronholm/sphinx-autodoc-typehints>`__            | ≥1.17.0      | `MIT <https://GitHub.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__                      | *Not yet evaluated.* |
+| `sphinx_autodoc_typehints <https://GitHub.com/agronholm/sphinx-autodoc-typehints>`__            | ≥1.18.1      | `MIT <https://GitHub.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__                      | *Not yet evaluated.* |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
 
 

doc/_templates/autoapi/module.rst

@@ -6,6 +6,8 @@
 ``{{ node.name }}``
 =={{ '=' * node.name|length }}==
 
+.. py:module:: {{ node.name }}
+
 {##}
 {%- block modules -%}
 {%- if subnodes %}

doc/conf.py

@@ -216,6 +216,7 @@
 # Sphinx.Ext.ExtLinks
 # ==============================================================================
 extlinks = {
+	"gh":      ("https://GitHub.com/%s", "gh:"),
 	"ghissue": ('https://GitHub.com/pyTooling/pyTooling.TerminalUI/issues/%s', 'issue #'),
 	"ghpull":  ('https://GitHub.com/pyTooling/pyTooling.TerminalUI/pull/%s', 'pull request #'),
 	"ghsrc":   ('https://GitHub.com/pyTooling/pyTooling.TerminalUI/blob/main/pyTooling/%s?ts=2', None),

doc/index.rst

@@ -126,7 +126,7 @@ Example
 Contributors
 ************
 
-* `Patrick Lehmann <https://GitHub.com/Paebbels>`_ (Maintainer)
+* `Patrick Lehmann <https://GitHub.com/Paebbels>`__ (Maintainer)
 * `and more... <https://GitHub.com/pyTooling/pyTooling.TerminalUI/graphs/contributors>`__
 
 

doc/requirements.txt

@@ -3,7 +3,7 @@
 pyTooling>=1.9.5
 
 # Enforce latest version on ReadTheDocs
-sphinx>=4.4.0
+sphinx>=4.5.0
 
 # Sphinx Extenstions
 #sphinx.ext.coverage
@@ -14,7 +14,7 @@ sphinxcontrib-mermaid>=0.7.1
 #sphinxcontrib-spelling>=2.2.0
 autoapi
 sphinx_fontawesome>=0.0.6
-sphinx_autodoc_typehints>=1.17.0
+sphinx_autodoc_typehints>=1.18.1
 # changelog>=0.3.5
 
 # BuildTheDocs Extensions (mostly patched Sphinx extensions)

pyTooling/TerminalUI/__init__.py

@@ -33,15 +33,15 @@
 __email__ =     "[email protected]"
 __copyright__ = "2007-2022, Patrick Lehmann"
 __license__ =   "Apache License, Version 2.0"
-__version__ =   "1.5.7"
+__version__ =   "1.5.8"
 __keywords__ =  ["terminal", "shell", "text user interface", "TUI", "console", "message logging"]
 
 from enum                   import Enum, unique
 from platform               import system as platform_system
 from typing                 import NoReturn, Tuple, Any
 
 from pyTooling.Decorators   import export
-from pyTooling.MetaClasses  import Singleton
+from pyTooling.MetaClasses  import ExtendedType
 
 
 @export
@@ -97,7 +97,7 @@ class Terminal:
 	_width  : int = None      #: Terminal width in characters
 	_height : int = None      #: Terminal height in characters
 
-	def __init__(self) -> None:
+	def __init__(self):
 		"""
 		Initialize a terminal.
 
@@ -390,7 +390,7 @@ class Line:
 		Severity.DryRun:    "DRYRUN: {message}"
 	}                     #: Terminal messages formatting rules
 
-	def __init__(self, message, severity=Severity.Normal, indent=0, appendLinebreak=True) -> None:
+	def __init__(self, message, severity=Severity.Normal, indent=0, appendLinebreak=True):
 		"""Constructor for a new ``Line`` object."""
 		self._severity =        severity
 		self._message =         message
@@ -428,7 +428,7 @@ class ILineTerminal:
 
 	_terminal = None
 
-	def __init__(self, terminal=None) -> None:
+	def __init__(self, terminal=None):
 		"""MixIn initializer."""
 		self._terminal = terminal
 
@@ -506,8 +506,8 @@ def WriteDryRun(self, *args, condition=True, **kwargs):
 
 
 @export
-class LineTerminal(Terminal, ILineTerminal, metaclass=Singleton):
-	def __init__(self, verbose=False, debug=False, quiet=False, writeToStdOut=True) -> None:
+class LineTerminal(Terminal, ILineTerminal, metaclass=ExtendedType, singleton=True):
+	def __init__(self, verbose=False, debug=False, quiet=False, writeToStdOut=True):
 		"""Initializer of a line based terminal interface."""
 		Terminal.__init__(self)
 		ILineTerminal.__init__(self, self)

pyTooling/TerminalUI/py.typed

@@ -42,4 +42,7 @@
 	description="A set of helpers to implement a text user interface (TUI) in a terminal.",
 	gitHubNamespace=gitHubNamespace,
 	sourceFileWithVersion=packageInformationFile,
+	dataFiles={
+		packageName: ["py.typed"]
+	}
 )

setup.py

@@ -4,7 +4,7 @@
 Coverage>=6.3
 
 # Test Runner
-pytest>=7.0.1
+pytest>=7.1.1
 pytest-cov>=3.0.0
 
 # Static Type Checking