Replace value_checker decorator by a descriptor for BaseTextBox class. Start to implement skin for textboxes.

Author: Tim-ats-d

tests/test.py

@@ -22,7 +22,7 @@ def main(win):
     curses.init_pair(3, curses.COLOR_GREEN, 0)
 
     textbox = DialogBox(1, 4,
-                        14, 4,
+                        15, 5,
                         title="Tim-ats-d",
                         # title_colors_pair_nb=3,
                         end_indicator="o")
@@ -36,20 +36,22 @@ def main(win):
     }
 
     def display_position(self: DialogBox,
+                         win,
                          char: str,
                          char_index: int):
         win.addstr(0, 0, str(self.dimensions))
         win.refresh()
 
     def display_char_info(self: DialogBox,
+                          win,
                           char: str,
                           char_index: str):
         win.addstr(5, 0, char + str(char_index))
         win.refresh()
 
     for reply in text:
-        textbox.char_by_char(win,
-                             reply,
+        textbox.char_by_char(reply,
+                             win,
                              callbacks=(display_position, display_char_info),
                              text_attr=(curses.A_ITALIC, curses.A_BOLD),
                              words_attr=special_words)

visualdialog/box.py

@@ -6,39 +6,46 @@
 import curses
 import curses.textpad
 import functools
-from typing import Callable, List, Literal, Sequence, Tuple, Union
+from typing import (Any, Callable, List, Literal, NoReturn, Sequence, Tuple,
+                    Union)
 
 from .error import PanicError, ValueNotInBound
-from .type import CursesKey, CursesTextAttribute, CursesTextAttributes, CursesWindow
+from .type import (CursesKey, CursesTextAttribute, CursesTextAttributes,
+                   CursesWindow)
 from .utils import TextAttr, to_tuple
 
 
-def value_checker(initializer: Callable) -> Callable:
-    """A decorator which ensures that correct values are passed to
-    :class:`BaseTextBox` initializer to avoid unexpected behavior.
+class BoundHeight:
+    """A descriptor which ensures that correct value is setted to
+    ``BaseTextBox.height`` to avoid unexpected behavior.
     """
-    def __init__(self,
-                 pos_x, pos_y,
-                 height, width,
-                 title,
-                 *args, **kwargs):
-        minimum_box_width = 4
+    def __get__(self, obj: "BaseTextBox", objtype=None):
+        return obj._height
 
+    def __set__(self, obj: "BaseTextBox", value: int) -> NoReturn:
         title_box_borders_total_height = 5
-        minimum_box_height = len(title) + title_box_borders_total_height
+        minimum_box_height = len(obj.title) + title_box_borders_total_height
+
+        if value < minimum_box_height:
+            raise ValueNotInBound("height must be more than title length + 5")
+        else:
+            obj._height = value
+
 
-        if width < minimum_box_width:
-            raise ValueNotInBound(f"width must be less than {minimum_box_width}")
-        elif height < minimum_box_height:
-            raise ValueNotInBound("height must be less than len(title) + 5")
+class BoundWidth:
+    """A descriptor which ensures that correct value is setted to
+    ``BaseTextBox.width`` to avoid unexpected behavior.
+    """
+    def __get__(self, obj: "BaseTextBox", objtype=None):
+        return obj._width
 
-        initializer(self,
-                    pos_x, pos_y,
-                    height, width,
-                    title,
-                    *args, **kwargs)
+    def __set__(self, obj: "BaseTextBox", value: int) -> NoReturn:
+        minimum_box_width = 4
 
-    return __init__
+        if value < minimum_box_width:
+            raise ValueNotInBound(f"width must be more than {minimum_box_width}")
+        else:
+            obj._width = value
 
 
 class BaseTextBox:
@@ -95,7 +102,8 @@ class BaseTextBox:
     :ivar panic_keys: initial value: []:
         List of accepted key to raise :exc:`PanicError`.
     """
-    @value_checker
+    height, width = BoundHeight(), BoundWidth()
+
     def __init__(
             self,
             pos_x: int,
@@ -109,9 +117,6 @@ def __init__(
             downtime_chars: Sequence[str] = (",", ".", ":", ";", "!", "?"),
             downtime_chars_delay: int = 600):
         """Initializes instance of :class:`BaseTextBox`."""
-        self.pos_x, self.pos_y = pos_x, pos_y
-        self.height, self.width = height - 1, width - 1
-
         self.title_offsetting_y = 2 if title else 0
 
         # Compensation for left and upper borders of text box.
@@ -127,6 +132,9 @@ def __init__(
             self.title_colors = curses.color_pair(title_colors_pair_nb)
             self.title_text_attr = to_tuple(title_text_attr)
 
+        self.pos_x, self.pos_y = pos_x, pos_y
+        self.height, self.width = height - 1, width - 1
+
         self.downtime_chars = downtime_chars
         self.downtime_chars_delay = downtime_chars_delay
 

visualdialog/dialog.py

@@ -338,8 +338,7 @@ def _one_by_one(self,
         text_attr = to_tuple(text_attr)
         colors_pair = curses.color_pair(colors_pair_nb)
 
-        wrapped_text = self.text_wrapper.wrap(text)
-        wrapped_text = chunked(wrapped_text, self.nb_lines_max)
+        wrapped_text = chunked(self.text_wrapper.wrap(text), self.nb_lines_max)
 
         if flash_screen:
             curses.flash()
@@ -429,4 +428,4 @@ def _write_word(self,
                      + rand_delay)
 
         for callback in callbacks:
-            callback(self, win, word)
+            callback(self, win, word)

visualdialog/skin.py

@@ -0,0 +1,20 @@
+
+from typing import Dict, Literal, NamedTuple
+
+
+TextBoxSkin = Dict[Literal[str], str]
+
+
+classic: TextBoxSkin = {
+    "upper_corner": "+",
+    "side": "|"
+}
+
+class Skin(NamedTuple):
+    upper_corner: str
+    lower_corner: str = "%"
+
+
+p = Skin("t")._asdict()
+classic.update(p)
+print(classic)