urwid 2.4.6__cp37-cp37m-win32.whl → 2.5.1__cp37-cp37m-win32.whl

urwid/widget/line_box.py

@@ -3,33 +3,38 @@ from __future__ import annotations
 import typing
 
 from .columns import Columns
-from .constants import Align, WHSettings
+from .constants import BOX_SYMBOLS, Align, WHSettings
 from .divider import Divider
 from .pile import Pile
 from .solid_fill import SolidFill
 from .text import Text
-from .widget import Widget, WidgetWrap
-from .widget_decoration import WidgetDecoration
+from .widget_decoration import WidgetDecoration, delegate_to_widget_mixin
 
 if typing.TYPE_CHECKING:
     from typing_extensions import Literal
 
+    from .widget import Widget
+
+WrappedWidget = typing.TypeVar("WrappedWidget")
+
+
+class LineBox(WidgetDecoration[WrappedWidget], delegate_to_widget_mixin("_wrapped_widget")):
+    Symbols = BOX_SYMBOLS
 
-class LineBox(WidgetDecoration, WidgetWrap):
     def __init__(
         self,
-        original_widget: Widget,
+        original_widget: WrappedWidget,
         title: str = "",
         title_align: Literal["left", "center", "right"] | Align = Align.CENTER,
         title_attr=None,
-        tlcorner: str = "┌",
-        tline: str = "─",
-        lline: str = "│",
-        trcorner: str = "┐",
-        blcorner: str = "└",
-        rline: str = "│",
-        bline: str = "─",
-        brcorner: str = "┘",
+        tlcorner: str = BOX_SYMBOLS.LIGHT.TOP_LEFT,
+        tline: str = BOX_SYMBOLS.LIGHT.HORIZONTAL,
+        lline: str = BOX_SYMBOLS.LIGHT.VERTICAL,
+        trcorner: str = BOX_SYMBOLS.LIGHT.TOP_RIGHT,
+        blcorner: str = BOX_SYMBOLS.LIGHT.BOTTOM_LEFT,
+        rline: str = BOX_SYMBOLS.LIGHT.VERTICAL,
+        bline: str = BOX_SYMBOLS.LIGHT.HORIZONTAL,
+        brcorner: str = BOX_SYMBOLS.LIGHT.BOTTOM_RIGHT,
     ) -> None:
         """
         Draw a line around original_widget.
@@ -55,6 +60,44 @@ class LineBox(WidgetDecoration, WidgetWrap):
         If empty string is specified for one of the lines/corners, then no character will be output there.
         If no top/bottom/left/right lines - whole lines will be omitted.
         This allows for seamless use of adjoining LineBoxes.
+
+        Class attribute `Symbols` can be used as source for standard lines:
+
+        >>> print(LineBox(Text("Some text")).render(()))
+        ┌─────────┐
+        │Some text│
+        └─────────┘
+        >>> print(
+        ...   LineBox(
+        ...     Text("Some text"),
+        ...     tlcorner=LineBox.Symbols.LIGHT.TOP_LEFT_ROUNDED,
+        ...     trcorner=LineBox.Symbols.LIGHT.TOP_RIGHT_ROUNDED,
+        ...     blcorner=LineBox.Symbols.LIGHT.BOTTOM_LEFT_ROUNDED,
+        ...     brcorner=LineBox.Symbols.LIGHT.BOTTOM_RIGHT_ROUNDED,
+        ...   ).render(())
+        ... )
+        ╭─────────╮
+        │Some text│
+        ╰─────────╯
+        >>> print(
+        ...   LineBox(
+        ...     Text("Some text"),
+        ...     tline=LineBox.Symbols.HEAVY.HORIZONTAL,
+        ...     bline=LineBox.Symbols.HEAVY.HORIZONTAL,
+        ...     lline=LineBox.Symbols.HEAVY.VERTICAL,
+        ...     rline=LineBox.Symbols.HEAVY.VERTICAL,
+        ...     tlcorner=LineBox.Symbols.HEAVY.TOP_LEFT,
+        ...     trcorner=LineBox.Symbols.HEAVY.TOP_RIGHT,
+        ...     blcorner=LineBox.Symbols.HEAVY.BOTTOM_LEFT,
+        ...     brcorner=LineBox.Symbols.HEAVY.BOTTOM_RIGHT,
+        ...   ).render(())
+        ... )
+        ┏━━━━━━━━━┓
+        ┃Some text┃
+        ┗━━━━━━━━━┛
+
+        To make Table constructions, some lineboxes need to be drawn without sides
+        and T or CROSS symbols used for corners of cells.
         """
 
         w_lline = SolidFill(lline)
@@ -115,15 +158,17 @@ class LineBox(WidgetDecoration, WidgetWrap):
 
         pile_widgets = []
         if top:
-            pile_widgets.append(("flow", top))
+            pile_widgets.append((WHSettings.PACK, top))
         pile_widgets.append(middle)
-        focus_pos = len(pile_widgets) - 1
         if bottom:
-            pile_widgets.append(("flow", bottom))
-        pile = Pile(pile_widgets, focus_item=focus_pos)
+            pile_widgets.append((WHSettings.PACK, bottom))
+
+        self._wrapped_widget = Pile(pile_widgets, focus_item=middle)
+
+        super().__init__(original_widget)
 
-        WidgetDecoration.__init__(self, original_widget)
-        WidgetWrap.__init__(self, pile)
+    def _w(self) -> Pile:
+        return self._wrapped_widget
 
     def format_title(self, text: str) -> str:
         if text:

urwid/widget/overlay.py

@@ -801,7 +801,7 @@ class Overlay(Widget, WidgetContainerMixin, WidgetContainerListContentsMixin):
     def mouse_event(
         self,
         size: tuple[()] | tuple[int] | tuple[int, int],
-        event,
+        event: str,
         button: int,
         col: int,
         row: int,

urwid/widget/padding.py

@@ -22,7 +22,8 @@ from .widget_decoration import WidgetDecoration, WidgetError, WidgetWarning
 if typing.TYPE_CHECKING:
     from typing_extensions import Literal
 
-    from .widget import Widget
+
+WrappedWidget = typing.TypeVar("WrappedWidget")
 
 
 class PaddingError(WidgetError):
@@ -33,10 +34,10 @@ class PaddingWarning(WidgetWarning):
     """Padding related warnings."""
 
 
-class Padding(WidgetDecoration):
+class Padding(WidgetDecoration[WrappedWidget]):
     def __init__(
         self,
-        w: Widget,
+        w: WrappedWidget,
         align: (
             Literal["left", "center", "right"] | Align | tuple[Literal["relative", WHSettings.RELATIVE], int]
         ) = Align.LEFT,
@@ -48,7 +49,7 @@ class Padding(WidgetDecoration):
         min_width: int | None = None,
         left: int = 0,
         right: int = 0,
-    ):
+    ) -> None:
         """
         :param w: a box, flow or fixed widget to pad on the left and/or right
             this widget is stored as self.original_widget
@@ -237,9 +238,11 @@ class Padding(WidgetDecoration):
     @width.setter
     def width(
         self,
-        width: Literal["clip", "pack", WHSettings.CLIP, WHSettings.PACK]
-        | int
-        | tuple[Literal["relative", WHSettings.RELATIVE], int],
+        width: (
+            Literal["clip", "pack", WHSettings.CLIP, WHSettings.PACK]
+            | int
+            | tuple[Literal["relative", WHSettings.RELATIVE], int]
+        ),
     ) -> None:
         """
         Set the padding width.
@@ -471,7 +474,7 @@ class Padding(WidgetDecoration):
     def mouse_event(
         self,
         size: tuple[()] | tuple[int] | tuple[int, int],
-        event,
+        event: str,
         button: int,
         x: int,
         y: int,

urwid/widget/pile.py

@@ -5,6 +5,7 @@ import warnings
 from itertools import chain, repeat
 
 from urwid.canvas import CanvasCombine, CompositeCanvas, SolidCanvas
+from urwid.command_map import Command
 from urwid.monitored_list import MonitoredFocusList, MonitoredList
 from urwid.util import is_mouse_press
 
@@ -852,7 +853,9 @@ class Pile(Widget, WidgetContainerMixin, WidgetContainerListContentsMixin):
 
     def keypress(self, size: tuple[()] | tuple[int] | tuple[int, int], key: str) -> str | None:
         """Pass the keypress to the widget in focus.
-        Unhandled 'up' and 'down' keys may cause a focus change."""
+
+        Unhandled 'up' and 'down' keys may cause a focus change.
+        """
         if not self.contents:
             return key
 
@@ -860,10 +863,10 @@ class Pile(Widget, WidgetContainerMixin, WidgetContainerListContentsMixin):
         _widths, heights, size_args = self.get_rows_sizes(size, focus=self.selectable())
         if self.selectable():
             key = self.focus.keypress(size_args[i], key)
-            if self._command_map[key] not in {"cursor up", "cursor down"}:
+            if self._command_map[key] not in {Command.UP, Command.DOWN}:
                 return key
 
-        if self._command_map[key] == "cursor up":
+        if self._command_map[key] == Command.UP:
             candidates = tuple(range(i - 1, -1, -1))  # count backwards to 0
         else:  # self._command_map[key] == 'cursor down'
             candidates = tuple(range(i + 1, len(self.contents)))
@@ -878,7 +881,7 @@ class Pile(Widget, WidgetContainerMixin, WidgetContainerListContentsMixin):
                 return None
 
             rows = heights[j]
-            if self._command_map[key] == "cursor up":
+            if self._command_map[key] == Command.UP:
                 rowlist = tuple(range(rows - 1, -1, -1))
             else:  # self._command_map[key] == 'cursor down'
                 rowlist = tuple(range(rows))
@@ -934,14 +937,14 @@ class Pile(Widget, WidgetContainerMixin, WidgetContainerListContentsMixin):
     def mouse_event(
         self,
         size: tuple[()] | tuple[int] | tuple[int, int],
-        event,
+        event: str,
         button: int,
         col: int,
         row: int,
         focus: bool,
     ) -> bool | None:
-        """
-        Pass the event to the contained widget.
+        """Pass the event to the contained widget.
+
         May change focus on button 1 press.
         """
         wrow = 0

urwid/widget/popup.py

@@ -34,13 +34,15 @@ if typing.TYPE_CHECKING:
 
     from .widget import Widget
 
+WrappedWidget = typing.TypeVar("WrappedWidget")
 
-class PopUpLauncher(delegate_to_widget_mixin("_original_widget"), WidgetDecoration):
-    def __init__(self, original_widget: Widget) -> None:
+
+class PopUpLauncher(delegate_to_widget_mixin("_original_widget"), WidgetDecoration[WrappedWidget]):
+    def __init__(self, original_widget: [WrappedWidget]) -> None:
         super().__init__(original_widget)
         self._pop_up_widget = None
 
-    def create_pop_up(self):
+    def create_pop_up(self) -> Widget:
         """
         Subclass must override this method and return a widget
         to be used for the pop-up.  This method is called once each time
@@ -74,13 +76,13 @@ class PopUpLauncher(delegate_to_widget_mixin("_original_widget"), WidgetDecorati
         return canv
 
 
-class PopUpTarget(WidgetDecoration):
+class PopUpTarget(WidgetDecoration[WrappedWidget]):
     # FIXME: this whole class is a terrible hack and must be fixed
     # when layout and rendering are separated
     _sizing = frozenset((Sizing.BOX,))
     _selectable = True
 
-    def __init__(self, original_widget: Widget) -> None:
+    def __init__(self, original_widget: WrappedWidget) -> None:
         super().__init__(original_widget)
         self._pop_up = None
         self._current_widget = self._original_widget
@@ -132,7 +134,15 @@ class PopUpTarget(WidgetDecoration):
         self._update_overlay(size, True)
         return self._current_widget.move_cursor_to_coords(size, x, y)
 
-    def mouse_event(self, size: tuple[int, int], event, button: int, x: int, y: int, focus: bool) -> bool | None:
+    def mouse_event(
+        self,
+        size: tuple[int, int],
+        event: str,
+        button: int,
+        x: int,
+        y: int,
+        focus: bool,
+    ) -> bool | None:
         self._update_overlay(size, focus)
         return self._current_widget.mouse_event(size, event, button, x, y, focus)
 

urwid/widget/progress_bar.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import typing
 import warnings
 
-from .constants import Align, Sizing, WrapMode
+from .constants import BAR_SYMBOLS, Align, Sizing, WrapMode
 from .text import Text
 from .widget import Widget
 
@@ -14,7 +14,7 @@ if typing.TYPE_CHECKING:
 class ProgressBar(Widget):
     _sizing = frozenset([Sizing.FLOW])
 
-    eighths = " ▏▎▍▌▋▊▉"
+    eighths = BAR_SYMBOLS.HORISONTAL[:8]  # Full width line is made by style
 
     text_align = Align.CENTER
 
@@ -26,9 +26,10 @@ class ProgressBar(Widget):
         :param done: progress amount at 100%
         :param satt: display attribute for smoothed part of bar where the
                      foreground of satt corresponds to the normal part and the
-                     background corresponds to the complete part.  If satt
-                     is ``None`` then no smoothing will be done.
+                     background corresponds to the complete part.
+                     If satt is ``None`` then no smoothing will be done.
 
+        >>> from urwid import LineBox
         >>> pb = ProgressBar('a', 'b')
         >>> pb
         <ProgressBar flow widget>
@@ -50,6 +51,12 @@ class ProgressBar(Widget):
         >>> for x in range(101):
         ...     cpb2.set_completion(x)
         ...     s = cpb2.render((10, ))
+        >>> pb = ProgressBar('a', 'b', satt='c')
+        >>> pb.set_completion(34.56)
+        >>> print(LineBox(pb).render((20,)))
+        ┌──────────────────┐
+        │      ▏34 %       │
+        └──────────────────┘
         """
         super().__init__()
         self.normal = normal
@@ -58,7 +65,7 @@ class ProgressBar(Widget):
         self._done = done
         self.satt = satt
 
-    def set_completion(self, current):
+    def set_completion(self, current: int) -> None:
         """
         current -- current progress
         """
@@ -88,7 +95,7 @@ class ProgressBar(Widget):
         )
         self.done = done
 
-    def rows(self, size, focus: bool = False) -> int:
+    def rows(self, size: tuple[int], focus: bool = False) -> int:
         return 1
 
     def get_text(self) -> str: