Rename TextBox to BaseTextBox, add Numeric type hinting.

Author: Tim-ats-d

doc/source/visualdialog.rst

@@ -10,7 +10,7 @@ Text boxes
 TextBox
 -------
 
-.. autoclass:: visualdialog.box.TextBox
+.. autoclass:: visualdialog.box.BaseTextBox
     :members:
     :undoc-members:
     :private-members:

visualdialog/box.py

@@ -19,7 +19,7 @@
 #
 #
 
-__all__ = ["TextBox"]
+__all__ = ["BaseTextBox"]
 
 import curses
 import curses.textpad
@@ -29,6 +29,7 @@
                     CursesKeyConstants,
                     CursesTextAttributesConstant,
                     CursesTextAttributesConstants,
+                    Numeric,
                     TextAttributes)
 
 
@@ -47,7 +48,7 @@ def __str__(self):
         return f"text box was aborted by pressing the {self.key} key"
 
 
-class TextBox:
+class BaseTextBox:
     """This class provides attributs and methods to manage a text box.
 
     .. NOTE::
@@ -98,7 +99,7 @@ class TextBox:
         Waiting time in seconds after writing a character contained in
         ``downtime_chars``.
         This defaults to ``0.6``.
-    :type downtime_chars_delay: Union[int,float]
+    :type downtime_chars_delay: Numeric
     """
 
     def __init__(
@@ -113,7 +114,7 @@ def __init__(
                                CursesTextAttributesConstants] = curses.A_BOLD,
         downtime_chars: Union[Tuple[str],
                               List[str]] = (",", ".", ":", ";", "!", "?"),
-        downtime_chars_delay: Union[int, float] = .6):
+        downtime_chars_delay: Numeric = .6):
         self.pos_x, self.pos_y = pos_x, pos_y
         self.length, self.width = length, width
 

visualdialog/dialog.py

@@ -27,14 +27,15 @@
 import time
 from typing import Callable, Dict, List, Optional, Tuple, Union
 
-from .box import TextBox
+from .box import BaseTextBox
 from .utils import (CursesTextAttributesConstant,
                     CursesTextAttributesConstants,
+                    Numeric,
                     TextAttributes,
                     _make_chunk)
 
 
-class DialogBox(TextBox):
+class DialogBox(BaseTextBox):
     """This class provides methods and attributs to manage a dialog box.
 
     :param end_dialog_indicator: Character that will be displayed in the
@@ -49,7 +50,7 @@ class DialogBox(TextBox):
 
     .. NOTE::
         This class inherits all the methods and attributes of
-        ``TextBox``.
+        ``BaseTextBox``.
 
     .. WARNING::
         Parameters ``downtime_chars`` and ``downtime_chars_delay`` do
@@ -109,8 +110,8 @@ def char_by_char(
         words_attr: Union[Dict[Tuple[str], CursesTextAttributesConstant],
                           Dict[Tuple[str], CursesTextAttributesConstants]] = {},
         flash_screen: bool = False,
-        delay: Union[int, float] = .04,
-        random_delay: Union[Tuple[int, float], List[int, float]] = (0, 0),
+        delay: Numeric = .04,
+        random_delay: Union[Tuple[Numeric], List[Numeric]] = (0, 0),
         callback: Callable = lambda: None,
         cargs: Union[Tuple, List] = ()):
         """Writes the given text character by character in the current
@@ -147,13 +148,13 @@ def char_by_char(
 
         :param delay: Waiting time between the writing of each character
             of text in second. This defaults to ``0.04``.
-        :type delay: Union[int, float]
+        :type delay: Numeric
 
         :param random_delay: Waiting time between the writing of each
             character in seconds where time waited is a random number
             generated in ``random_delay`` interval. This defaults to
             ``(0, 0)``.
-        :type random_delay: Union[tuple[int, float],list[int, float]]
+        :type random_delay: Union[tuple[Numeric],list[Numeric]]
 
         :param callback: Callable called after writing a character and
             the delay time has elapsed. This defaults to a lambda which
@@ -254,8 +255,8 @@ def word_by_word(
         words_attr: Union[Dict[Tuple[str], CursesTextAttributesConstant],
                           Dict[Tuple[str], CursesTextAttributesConstants]] = {},
         flash_screen: bool = False,
-        delay: Union[int, float] = .15,
-        random_delay: Union[Tuple[int, float], List[int, float]] = (0, 0),
+        delay: Numeric = .15,
+        random_delay: Union[Tuple[Numeric], List[Numeric]] = (0, 0),
         callback: Callable = lambda: None,
         cargs: Union[Tuple, List] = ()):
         """Writes the given text word by word at position in the current
@@ -296,13 +297,13 @@ def word_by_word(
 
         :param delay: Waiting time between the writing of each word of
             ``text`` in second. This defaults to ``0.15``.
-        :type delay: Union[int, float]
+        :type delay: Numeric
 
         :param random_delay: Waiting time between the writing of each
             word in seconds where time waited is a random number
             generated in ``random_delay`` interval. This defaults to
             ``(0, 0)``.
-        :type random_delay: Union[tuple[int, float],list[int, float]]
+        :type random_delay: Union[Tuple[Numeric], List[Numeric]]
 
         :param callback: Callable called after writing a word and the
             delay time has elapsed. This defaults to a lambda which do

visualdialog/utils.py

@@ -19,9 +19,11 @@
 #
 #
 
-from typing import Generator, List, Tuple, Union
+from typing import Generator, List, Tuple, TypeVar, Union
 
 
+Numeric = TypeVar("Numeric", int, float)
+
 # curses text attribute constants are integers.
 # See https://docs.python.org/3/library/curses.html?#constants
 CursesTextAttributesConstant = int