Merge branch 'dev' of https://github.com/Tim-ats-d/Visual-dialog into dev

Author: Tim-ats-d

examples/confrontation.py

@@ -7,7 +7,7 @@
 
 
 PASS_KEYS = (" ", "\n")
-HEIGHT, WIDTH = 35, 6
+HEIGHT, WIDTH = 37, 7
 
 
 # It is preferable to create its own class derived from DialogBox for

examples/monologue.py

@@ -23,7 +23,7 @@ def main(win):
     curses.init_pair(2, curses.COLOR_CYAN, 0)
 
     textbox = DialogBox(1, 1,  # Position 1;1 in win.
-                        30, 5,  # Height and width of textbox.
+                        30, 6,  # Height and width of textbox.
                         "Tim-ats",  # Title of textbox.
                         1)  # Curses color_pair used to colored title.
 

visualdialog/__init__.py

@@ -1,4 +1,3 @@
-
 """A library to make easier dialog box in terminal."""
 
 __version__ = 0.8

visualdialog/box.py

@@ -5,31 +5,31 @@
 
 import curses
 import curses.textpad
-from typing import List, Literal, Sequence, Tuple, Union
+from typing import Callable, List, Literal, Sequence, Tuple, Union
 
 from .error import PanicError, ValueNotInBound
 from .type import CursesKey, CursesTextAttribute, CursesTextAttributes, CursesWindow
 from .utils import TextAttr, to_tuple
 
 
-MINIMUM_BOX_WIDTH = 4
-
-
 def value_checker(initializer: Callable) -> Callable:
-    """A decorator which checks if the arguments passed to
-    ``BaseTextBox`` initializer are consistent.
+    """A decorator which ensures that correct values are passed to
+    ``BaseTextBox`` initializer to avoid unexpected behavior.
     """
     def __init__(self,
                  pos_x, pos_y,
                  height, width,
                  title,
                  *args, **kwargs):
-        minimum_box_height = len(title) + 5
+        minimum_box_width = 4
+
+        title_box_borders_total_height = 5
+        minimum_box_height = len(title) + title_box_borders_total_height
 
-        if width < MINIMUM_BOX_WIDTH:
-            raise ValueNotInBound("ne peut pas faire moins de 4 de hauteur")
-        elif minimum_box_height > height:
-            raise ValueNotInBound("ne peut pas faire plus de len(title) + 5")
+        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")
 
         initializer(self,
                     pos_x, pos_y,
@@ -102,18 +102,17 @@ def __init__(
 
         self.title_offsetting_y = 2 if title else 0
 
-        # Compensation for the left border of the dialog box.
+        # Compensation for left and upper borders of text box.
         self.text_pos_x = pos_x + 2
-        # Compensation for the upper border of the dialog box.
         self.text_pos_y = pos_y + self.title_offsetting_y + 1
 
+        # Text margins.
         self.nb_char_max_line = height - 5
         self.nb_lines_max = width - 3
 
         self.title = title
         if title:
             self.title_colors = curses.color_pair(title_colors_pair_nb)
-            # Test if only one argument is passed instead of a sequence.
             self.title_text_attr = to_tuple(title_text_attr)
 
         self.downtime_chars = downtime_chars
@@ -154,30 +153,31 @@ def dimensions(self) -> Tuple[int]:
     def framing_box(self, win: CursesWindow):
         """Display dialog box borders and his title.
 
-        If attribute ``self.title`` is empty doesn't display the title.
+        If attribute ``self.title`` is empty doesn't display the title
+        box.
 
         :param win: ``curses`` window object on which the method will
             have effect.
         """
-        title_length = len(self.title) + 4
+        title_height = len(self.title) + 4
         title_width = 2
 
-        # Displays the title and the title box.
+        # Display title and title box.
         if self.title:
             attr = (self.title_colors, *self.title_text_attr)
 
             curses.textpad.rectangle(win,
                                      self.pos_y,
                                      self.pos_x + 1,
                                      self.pos_y + title_width,
-                                     self.pos_x + title_length)
+                                     self.pos_x + title_height)
 
             with TextAttr(win, *attr):
                 win.addstr(self.pos_y + 1,
                            self.pos_x + 3,
                            self.title)
 
-        # Displays the borders of the dialog box.
+        # Display borders of text box.
         curses.textpad.rectangle(win,
                                  self.pos_y + self.title_offsetting_y,
                                  self.pos_x,

visualdialog/dialog.py

@@ -27,7 +27,7 @@ class DialogBox(BaseTextBox):
         of ``TextBox``.
 
     .. NOTE::
-        This class inherits from ``BaseTextBox``.
+        This class inherits of ``BaseTextBox``.
 
     .. NOTE::
         This class is a context manager.
@@ -360,7 +360,10 @@ def _one_by_one(self,
                     delay: int,
                     random_delay: Sequence[int],
                     callbacks: Iterable[Callable]):
-        # Test if only one argument is passed instead of a tuple.
+        """This method offers a general purpose API to display text
+        regardless of whether it is written word by word or character by
+        character.
+        """
         text_attr = to_tuple(text_attr)
 
         colors_pair = curses.color_pair(colors_pair_nb)
@@ -400,5 +403,3 @@ def _one_by_one(self,
 
             self._display_end_indicator(win)
             self.get_input(win)
-
-

visualdialog/error.py

@@ -1,18 +1,18 @@
 # error.py
 # 2020 Timéo Arnouts <[email protected]>
 
-__all__ = ["PanicError"]
+__all__ = ["PanicError", "ValueNotInBound"]
 
 from typing import Callable
 
 from .type import CursesKey
 
 
 class ValueNotInBound(ValueError):
-    """Exception thrown when when incorrect values are passed as
-    parameters to the ``BaseTextBox`` constructor.
+    """Exception thrown when incorrect values are passed as parameters
+    to the ``BaseTextBox`` constructor.
     """
-    ...
+    pass
 
 
 class PanicError(KeyboardInterrupt):

visualdialog/utils.py

@@ -24,6 +24,9 @@ def chunked(seq: Sequence,
 def to_tuple(obj: Union[object, Sequence]) -> Union[Tuple, Sequence]:
     """Check if the given object is a sequence, if so returns it,
     otherwise returns it as a tuple.
+
+    This function is mainly used to work with sequences even if only one
+    argument is passed.
     """
     if isinstance(obj, Sequence):
         return obj