Rename CursesTextAttrConstant and CursesTextAttrConstants tp CursesTextAttribute and CursesTextAttributes.

Author: Tim-ats-d

visualdialog/__init__.py

@@ -1,7 +1,5 @@
 
-"""
-A library to make easier dialog box in terminal.
-"""
+"""A library to make easier dialog box in terminal."""
 
 __version__ = 0.7
 __author__ = "Timéo Arnouts"

visualdialog/box.py

@@ -9,7 +9,7 @@
 from typing import List, Literal, Sequence, Tuple, Union
 
 from .utils import (CursesKey, CursesKeys,
-                    CursesTextAttrConstant, CursesTextAttrConstants,
+                    CursesTextAttribute, CursesTextAttributes,
                     CursesWindow, TextAttr)
 
 
@@ -82,8 +82,8 @@ def __init__(
             width: int,
             title: str = "",
             title_colors_pair_nb: int = 0,
-            title_text_attr: Union[CursesTextAttrConstant,
-                                   CursesTextAttrConstants] = curses.A_BOLD,
+            title_text_attr: Union[CursesTextAttribute,
+                                   CursesTextAttributes] = curses.A_BOLD,
             downtime_chars: Sequence[str] = (",", ".", ":", ";", "!", "?"),
             downtime_chars_delay: int = 600):
         self.pos_x, self.pos_y = pos_x, pos_y

visualdialog/choices.py

@@ -5,7 +5,7 @@
 from typing import Any, Mapping, Tuple, Union
 
 from .dialog import DialogBox
-from .utils import CursesTextAttrConstants, TextAttr, chunked
+from .utils import CursesTextAttributes, TextAttr, chunked
 
 
 class ChoiceBox(DialogBox):

visualdialog/dialog.py

@@ -9,7 +9,7 @@
 from typing import Any, Callable, List, Mapping, Sequence, Tuple, Union
 
 from .box import BaseTextBox
-from .utils import (CursesTextAttrConstant, CursesTextAttrConstants,
+from .utils import (CursesTextAttribute, CursesTextAttributes,
                     CursesWindow, TextAttr, chunked)
 
 
@@ -43,8 +43,8 @@ def __init__(
             width: int,
             title: str = "",
             title_colors_pair_nb: int = 0,
-            title_text_attr: Union[CursesTextAttrConstant,
-                                   CursesTextAttrConstants] = curses.A_BOLD,
+            title_text_attr: Union[CursesTextAttribute,
+                                   CursesTextAttributes] = curses.A_BOLD,
             downtime_chars: Sequence[str] = (",", ".", ":", ";", "!", "?"),
             downtime_chars_delay: int = 60,
             end_indicator: str = "►"):
@@ -74,8 +74,8 @@ def __exit__(self, type, value, traceback):
     def _display_end_indicator(
             self,
             win: CursesWindow,
-            text_attr: CursesTextAttrConstants = (curses.A_BOLD,
-                                                  curses.A_BLINK)):
+            text_attr: CursesTextAttributes= (curses.A_BOLD,
+                                              curses.A_BLINK)):
         """Displays an end indicator in the lower right corner of
         textbox.
 
@@ -120,7 +120,7 @@ def _write_word_char_by_char(self,
             callback(*cargs)
 
     def _write_word(self,
-                    win,
+                    win: CursesWindow,
                     pos_x: int,
                     pos_y: int,
                     word: str,
@@ -142,14 +142,14 @@ def _write_word(self,
 
     def _one_by_one(self,
                     write_method: Callable,
-                    win,
+                    win: CursesWindow,
                     text: str,
                     colors_pair_nb: int,
-                    text_attr: Union[CursesTextAttrConstant,
-                                     CursesTextAttrConstants],
+                    text_attr: Union[CursesTextAttribute,
+                                     CursesTextAttributes],
                     words_attr: Mapping[Sequence[str],
-                                        Union[CursesTextAttrConstant,
-                                              CursesTextAttrConstants]],
+                                        Union[CursesTextAttribute,
+                                              CursesTextAttributes]],
                     word_delimiter: str,
                     flash_screen: bool,
                     delay: int,
@@ -207,11 +207,11 @@ def char_by_char(
             win: CursesWindow,
             text: str,
             colors_pair_nb: int = 0,
-            text_attr: Union[CursesTextAttrConstant,
-                             CursesTextAttrConstants] = (),
+            text_attr: Union[CursesTextAttribute,
+                             CursesTextAttributes] = (),
             words_attr: Mapping[Sequence[str],
-                                Union[CursesTextAttrConstant,
-                                      CursesTextAttrConstants]] = {},
+                                Union[CursesTextAttribute,
+                                      CursesTextAttributes]] = {},
             word_delimiter: str = " ",
             flash_screen: bool = False,
             delay: int = 40,
@@ -309,11 +309,11 @@ def word_by_word(
             win: CursesWindow,
             text: str,
             colors_pair_nb: int = 0,
-            text_attr: Union[CursesTextAttrConstant,
-                             CursesTextAttrConstants] = (),
+            text_attr: Union[CursesTextAttribute,
+                             CursesTextAttributes] = (),
             words_attr: Mapping[Sequence[str],
-                                Union[CursesTextAttrConstant,
-                                      CursesTextAttrConstants]] = {},
+                                Union[CursesTextAttribute,
+                                      CursesTextAttributes]] = {},
             word_delimiter: str = " ",
             flash_screen: bool = False,
             delay: int = 150,

visualdialog/utils.py

@@ -2,8 +2,8 @@
 # 2020 Timéo Arnouts <[email protected]>
 
 __all__ = ["CursesWindow",
-           "CursesTextAttrConstant",
-           "CursesTextAttrConstants",
+           "CursesTextAttribute",
+           "CursesTextAttributes",
            "CursesKey",
            "CursesKeys",
            "CursesWindow",
@@ -23,8 +23,8 @@
 
 #: curses text attribute constants are integers.
 #: See https://docs.python.org/3/library/curses.html?#constants
-CursesTextAttrConstant = int
-CursesTextAttrConstants = Sequence[CursesTextAttrConstant]
+CursesTextAttribute = int
+CursesTextAttributes = Sequence[CursesTextAttribute]
 
 
 def chunked(seq: Sequence,
@@ -50,7 +50,7 @@ class TextAttr(ContextDecorator):
     """
     def __init__(self,
                  win: CursesWindow,
-                 *attributes: Iterable[CursesTextAttrConstant]):
+                 *attributes: CursesTextAttribute):
         self.win = win
         self.attributes = attributes