Refactor examples/confrontation.py, add operator < support for DialogBox.

Author: Tim-ats-d

README.md

@@ -69,7 +69,7 @@ pip install sphinx sphinx_rtd_theme
 
 ### Hello world with **Visual-dialog**
 
-```python3
+```py3
 import curses
 
 from visualdialog import DialogBox
@@ -84,8 +84,8 @@ def main(win):
     textbox = DialogBox(x, y,
                         height, width,
                         title="Demo")
-    textbox.char_by_char(win,
-                         "Hello world")
+    textbox.char_by_char("Hello world",
+                         win)
 
 
 curses.wrapper(main)

doc/source/visualdialog.rst

@@ -36,6 +36,8 @@ DialogBox
 
   .. automethod:: __exit__
 
+  .. automethod:: __lt__
+
   .. automethod:: char_by_char
 
   .. automethod:: word_by_word

examples/confrontation.py

@@ -2,42 +2,40 @@
 # A concrete example exploiting the possibilities of Visual-dialog.
 
 import curses
+from functools import partial
 
 from visualdialog import DialogBox
 
 
-PASS_KEYS = (" ", "\n")
-HEIGHT, WIDTH = 35, 5
+pass_keys = (" ", "\n")
+height, width = 35, 5
 
 
 # It is preferable to create its own class derived from DialogBox for
-# complex applications.
-class CustomDialogBox(DialogBox):
-
-    def __init__(self,
-                 win,
-                 pos_x: int,
-                 pos_y: int,
-                 title: str,
-                 title_colors_pair_nb: int,
-                 **kwargs):
-        DialogBox.__init__(self,
-                           pos_x,
-                           pos_y,
-                           HEIGHT,
-                           WIDTH,
-                           title,
-                           title_colors_pair_nb,
-                           global_win=win,
-                           # Use a default window to display text.
-                           # Setting this parameter allows to avoid passing
-                           # `win` parameter to `char_by_char` and
-                           # `word_by_word` methods. Useful when dealing with
-                           # many `DialogBox` methods calls.
-                           **kwargs)
-
-        # Definition of accepted key codes to pass a dialog.
-        self.confirm_keys = PASS_KEYS
+# complex applications (or an instance factory like here).
+def box_factory(win,
+                x: int,
+                y: int,
+                title: int,
+                title_colors_pair_nb: int,
+                **kwargs) -> DialogBox:
+    box = DialogBox(x, y,
+                    height, width,
+                    title, title_colors_pair_nb,
+                    global_win=win,
+                    # Use a default window to display text.
+                    # Setting this parameter allows to avoid passing `win`
+                    # parameter to `char_by_char` and `word_by_word` methods.
+                    # Useful when dealing with many `DialogBox` methods calls.
+                    **kwargs)
+
+    # Definition of accepted key codes to pass a dialog.
+    box.confirm_keys = pass_keys
+    # Definition of a partial objet to reduce verbosity and accelerate
+    # the time it takes to write the text on the screen.
+    box.char_by_char = partial(box.char_by_char, delay=30)
+
+    return box
 
 
 def main(win):
@@ -52,24 +50,24 @@ def main(win):
     max_y, max_x = win.getmaxyx()  # Get height and width of the window.
 
     left_x = 2  # Left alignment.
-    right_x = max_x - HEIGHT - 4  # Calculation of right alignment.
-    center_x = max_x//2 - HEIGHT//2  # Calculation of center alignment.
-    bottom_y = max_y - WIDTH - 4  # Calculation of bottom alignment.
-
-    phoenix_wright = CustomDialogBox(win,
-                                     left_x, bottom_y,
-                                     "Phoenix",  # Title of dialog box.
-                                     1)  # Color pair used to colored title.
-
-    april_may = CustomDialogBox(win,
-                                center_x, bottom_y,
-                                "April",
-                                2)
-
-    miles_edgeworth = CustomDialogBox(win,
-                                      right_x, bottom_y,
-                                      "Edgeworth",
-                                      3)
+    right_x = max_x - height - 4  # Calculation of right alignment.
+    center_x = max_x//2 - height//2  # Calculation of center alignment.
+    bottom_y = max_y - width - 4  # Calculation of bottom alignment.
+
+    phoenix_wright = box_factory(win,
+                                 left_x, bottom_y,
+                                 "Phoenix",  # Title of dialog box.
+                                 1)  # Color pair used to colored title.
+
+    april_may = box_factory(win,
+                            center_x, bottom_y,
+                            "April",
+                            2)
+
+    miles_edgeworth = box_factory(win,
+                                  right_x, bottom_y,
+                                  "Edgeworth",
+                                  3)
 
     phoenix_wright.char_by_char("This testimony is a pure invention !",
                                 delay=30)

examples/panic.py

@@ -10,27 +10,25 @@ def main(win):
     curses.curs_set(False)
 
     box = DialogBox(1, 1,
-                    40, 6)
+                    40, 6
+                    global_win=win)
 
     # Definition of keys to pass and exit a dialog.
     box.confirm_keys.append("\n")
     box.panic_keys = ("q", )
 
     try:
         box.char_by_char("When a key contained in EXIT_KEY is pressed "
-                         "at end of dialog PanicError exception is raised.",
-                         win)
+                         "at end of dialog PanicError exception is raised.")
     except PanicError:  # Catch PanicError.
         box.char_by_char("PanicError exception has been caught. "
                          "One of the keys contained in EXIT_CHAR has "
-                         "been pressed.",
-                         win)
+                         "been pressed.")
     else:
         box.char_by_char("None of the keys contained in EXIT_CHAR have "
-                         "been pressed.",
-                         win)
+                         "been pressed.")
     finally:  # Code executed in all cases.
-        box.char_by_char("End of dialog.", win)
+        box.char_by_char("End of dialog.")
 
 
 # Execution of main function.

visualdialog/dialog.py

@@ -83,6 +83,22 @@ def __exit__(self, type, value, traceback):
         """Return None."""
         return None
 
+    def __lt__(self, text: str) -> str:
+        """A shortcut to call :meth:`char_by_char` by passing only
+        `text` argument.
+
+            >>> DialogBox(x, y,
+            ...           height, width,
+            ...           global_win=win) < "Foo bar"
+
+        This code roughly equivalent to:
+
+            >>> DialogBox(x, y,
+            ...           height, width).char_by_char("Foo bar", win)
+
+        """
+        return self.char_by_char(text)
+
     def char_by_char(self,
                      text: str,
                      win: CursesWindow = None,