Improve docstring of utils._make_chunk and utils.TextAttributes, fix type hinting.

Author: Tim-ats-d

visualdialog/utils.py

@@ -18,8 +18,11 @@
 #  MA 02110-1301, USA.
 #
 #
+
+from contextlib import ContextDecorator
 import _curses
-from typing import Generator, List, Tuple, TypeVar, Union
+from typing import (Generator, Iterable, List, NoReturn, Tuple, TypeVar,
+					Union)
 
 
 Numeric = TypeVar("Numeric", int, float)
@@ -39,39 +42,40 @@
 
 def _make_chunk(iterable: Union[Tuple, List],
                 chunk_length: int) -> Generator:
-    """Returns a tuple that contains the given iterator separated
-    into chunk_length bundles.
+    """Returns a tuple that contains given iterable separated into
+    ``chunk_length`` bundles.
 
-    :returns: Iterator separated into chunk_length bundles.
+    :returns: Generator separated into ``chunk_length`` bundles.
     """
     return (iterable[chunk:chunk + chunk_length]
-            for chunk in range(0, len(iterable), chunk_length))
+				for chunk in range(0, len(iterable), chunk_length))
 
 
-class TextAttributes:
-    """A context manager to manage curses text attributs.
+class TextAttributes(ContextDecorator):
+    """A context manager to manage ``curses`` text attributes.
 
-    :param win: `curses` window object for which the attributes will be
-        managed.
+    :param win: ``curses`` window object for which the attributes will
+		be managed.
 
-    :param attributes: List of attributes to activate and desactivate.
+    :param attributes: Iterable of ``curses`` text attributes to activate
+		and desactivate.
     """
     def __init__(self,
                  win: CursesWindow,
-                 *attributes: CursesTextAttributesConstants):
+                 *attributes: Iterable[CursesTextAttributesConstant]):
         self.win = win
         self.attributes = attributes
 
-    def __enter__(self):
-        """Activates one by one the attributes contained in
-        self.attributes.
+    def __enter__(self) -> NoReturn:
+        """Activate one by one attributes contained in self.attributes
+        on ``self.win``.
         """
         for attr in self.attributes:
             self.win.attron(attr)
 
-    def __exit__(self, type, value, traceback):
-        """Disable one by one the attributes contained in
-        self.attributes.
+    def __exit__(self, type, value, traceback) -> NoReturn:
+        """Disable one by one attributes contained in
+        ``self.attributes`` on ``self.win``.
         """
         for attr in self.attributes:
             self.win.attroff(attr)