urwid 2.6.8__py3-none-any.whl → 2.6.10__py3-none-any.whl

urwid/display/escape.py

@@ -310,17 +310,15 @@ class KeyqueueTrie:
 
         (b, x, y) = (int(val) for val in value[:-1].split(";"))
         action = value[-1]
-
-        # shift, etc. is not communicated on my machine, so I
-        # can't and won't be able to add support for it.
-        # Double and triple clicks are not supported as well. They can be
-        # implemented by using a timer. This timer can check if the last
-        # registered click is below a certain threshold. This threshold
-        # is normally set in the operating system itself, so setting one
-        # here will cause an inconsistent behaviour. I do not plan to use
-        # that feature, so I won't implement it.
+        # Double and triple clicks are not supported.
+        # They can be implemented by using a timer.
+        # This timer can check if the last registered click is below a certain threshold.
+        # This threshold is normally set in the operating system itself,
+        # so setting one here will cause an inconsistent behaviour.
 
         prefixes = []
+        if b & 4:
+            prefixes.append("shift ")
         if b & 8:
             prefixes.append("meta ")
         if b & 16:

urwid/event_loop/asyncio_loop.py

@@ -222,9 +222,10 @@ class AsyncioEventLoop(EventLoop):
             loop.default_exception_handler(context)
 
     def run(self) -> None:
-        """
-        Start the event loop.  Exit the loop when any callback raises
-        an exception.  If ExitMainLoop is raised, exit cleanly.
+        """Start the event loop.
+
+        Exit the loop when any callback raises an exception.
+        If ExitMainLoop is raised, exit cleanly.
         """
         self._loop.set_exception_handler(self._exception_handler)
         self._loop.run_forever()

urwid/event_loop/trio_loop.py

@@ -160,9 +160,10 @@ class TrioEventLoop(EventLoop):
             trio.run(self._main_task, instruments=[emulate_idle_callbacks])
 
     async def run_async(self) -> None:
-        """Starts the main loop and blocks asynchronously until the main loop
-        exits. This allows one to embed an urwid app in a Trio app even if the
-        Trio event loop is already running. Example::
+        """Starts the main loop and blocks asynchronously until the main loop exits.
+
+        This allows one to embed an urwid app in a Trio app even if the Trio event loop is already running.
+        Example::
 
             with trio.open_nursery() as nursery:
                 event_loop = urwid.TrioEventLoop()

urwid/version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.6.8'
-__version_tuple__ = version_tuple = (2, 6, 8)
+__version__ = version = '2.6.10'
+__version_tuple__ = version_tuple = (2, 6, 10)

urwid/widget/__init__.py

@@ -61,8 +61,6 @@ from .wimp import Button, CheckBox, CheckBoxError, RadioButton, SelectableIcon
 __all__ = (
     "ANY",
     "BOTTOM",
-    "MonitoredList",
-    "MonitoredFocusList",
     "BOX",
     "CENTER",
     "CLIP",
@@ -72,7 +70,6 @@ __all__ = (
     "GIVEN",
     "LEFT",
     "MIDDLE",
-    "GridFlowWarning",
     "PACK",
     "RELATIVE",
     "RELATIVE_100",
@@ -91,20 +88,8 @@ __all__ = (
     "BoxAdapter",
     "BoxAdapterError",
     "BoxWidget",
-    "ListWalkerError",
-    "ListWalker",
-    "SimpleListWalker",
-    "SimpleFocusListWalker",
-    "ListBoxError",
-    "ListBox",
     "Button",
     "CheckBox",
-    "TreeWidgetError",
-    "TreeWidget",
-    "TreeNode",
-    "ParentNode",
-    "TreeWalker",
-    "TreeListBox",
     "CheckBoxError",
     "Columns",
     "ColumnsError",
@@ -121,14 +106,22 @@ __all__ = (
     "GraphVScale",
     "GridFlow",
     "GridFlowError",
+    "GridFlowWarning",
     "IntEdit",
     "LineBox",
+    "ListBox",
+    "ListBoxError",
+    "ListWalker",
+    "ListWalkerError",
+    "MonitoredFocusList",
+    "MonitoredList",
     "Overlay",
     "OverlayError",
     "OverlayWarning",
     "Padding",
     "PaddingError",
     "PaddingWarning",
+    "ParentNode",
     "Pile",
     "PileError",
     "PileWarning",
@@ -140,10 +133,17 @@ __all__ = (
     "Scrollable",
     "ScrollableError",
     "SelectableIcon",
+    "SimpleFocusListWalker",
+    "SimpleListWalker",
     "Sizing",
     "SolidFill",
     "Text",
     "TextError",
+    "TreeListBox",
+    "TreeNode",
+    "TreeWalker",
+    "TreeWidget",
+    "TreeWidgetError",
     "VAlign",
     "WHSettings",
     "Widget",

urwid/widget/listbox.py

@@ -20,6 +20,7 @@
 
 from __future__ import annotations
 
+import operator
 import typing
 import warnings
 from collections.abc import Iterable, Sized
@@ -43,7 +44,18 @@ if typing.TYPE_CHECKING:
 
     from urwid.canvas import Canvas, CompositeCanvas
 
-__all__ = ("ListWalkerError", "ListWalker", "SimpleListWalker", "SimpleFocusListWalker", "ListBoxError", "ListBox")
+__all__ = (
+    "ListBox",
+    "ListBoxError",
+    "ListWalker",
+    "ListWalkerError",
+    "SimpleFocusListWalker",
+    "SimpleListWalker",
+    "VisibleInfo",
+    "VisibleInfoFillItem",
+    "VisibleInfoMiddle",
+    "VisibleInfoTopBottom",
+)
 
 _T = typing.TypeVar("_T")
 _K = typing.TypeVar("_K")
@@ -54,22 +66,30 @@ class ListWalkerError(Exception):
 
 
 @runtime_checkable
-class ScrollSupportingBody(Sized, Protocol):
-    """Protocol for ListWalkers that support Scrolling."""
+class ScrollSupportingBody(Protocol):
+    """Protocol for ListWalkers."""
 
     def get_focus(self) -> tuple[Widget, _K]: ...
 
     def set_focus(self, position: _K) -> None: ...
 
-    def __getitem__(self, index: _K) -> _T: ...
-
-    def positions(self, reverse: bool = False) -> Iterable[_K]: ...
-
     def get_next(self, position: _K) -> tuple[Widget, _K] | tuple[None, None]: ...
 
     def get_prev(self, position: _K) -> tuple[Widget, _K] | tuple[None, None]: ...
 
 
+@runtime_checkable
+class EstimatedSized(Protocol):
+    """Widget can estimate it's size.
+
+    PEP 424 defines API for memory-efficiency.
+    For the ListBox it's a sign of the limited body length.
+    The main use-case is lazy-load, where real length calculation is expensive.
+    """
+
+    def __length_hint__(self) -> int: ...
+
+
 class ListWalker(metaclass=signals.MetaSignals):  # pylint: disable=no-member, unsubscriptable-object
     # mixin not named as mixin
     signals: typing.ClassVar[list[str]] = ["modified"]
@@ -276,7 +296,7 @@ class ListBoxError(Exception):
     pass
 
 
-class _Middle(typing.NamedTuple):
+class VisibleInfoMiddle(typing.NamedTuple):
     """Named tuple for ListBox internals."""
 
     offset: int
@@ -286,7 +306,7 @@ class _Middle(typing.NamedTuple):
     cursor: tuple[int, int] | tuple[int] | None
 
 
-class _FillItem(typing.NamedTuple):
+class VisibleInfoFillItem(typing.NamedTuple):
     """Named tuple for ListBox internals."""
 
     widget: Widget
@@ -294,11 +314,45 @@ class _FillItem(typing.NamedTuple):
     rows: int
 
 
-class _TopBottom(typing.NamedTuple):
+class VisibleInfoTopBottom(typing.NamedTuple):
     """Named tuple for ListBox internals."""
 
     trim: int
-    fill: list[_FillItem]
+    fill: list[VisibleInfoFillItem]
+
+    @classmethod
+    def from_raw_data(
+        cls,
+        trim: int,
+        fill: Iterable[tuple[Widget, Hashable, int]],
+    ) -> Self:
+        """Construct from not typed data.
+
+        Useful for overridden cases."""
+        return cls(trim=trim, fill=[VisibleInfoFillItem(*item) for item in fill])  # pragma: no cover
+
+
+class VisibleInfo(typing.NamedTuple):
+    middle: VisibleInfoMiddle
+    top: VisibleInfoTopBottom
+    bottom: VisibleInfoTopBottom
+
+    @classmethod
+    def from_raw_data(
+        cls,
+        middle: tuple[int, Widget, Hashable, int, tuple[int, int] | tuple[int] | None],
+        top: tuple[int, Iterable[tuple[Widget, Hashable, int]]],
+        bottom: tuple[int, Iterable[tuple[Widget, Hashable, int]]],
+    ) -> Self:
+        """Construct from not typed data.
+
+        Useful for overridden cases.
+        """
+        return cls(  # pragma: no cover
+            middle=VisibleInfoMiddle(*middle),
+            top=VisibleInfoTopBottom.from_raw_data(*top),
+            bottom=VisibleInfoTopBottom.from_raw_data(*bottom),
+        )
 
 
 class ListBox(Widget, WidgetContainerMixin):
@@ -390,16 +444,23 @@ class ListBox(Widget, WidgetContainerMixin):
         )
         self.body = body
 
-    def __len__(self) -> int:
+    @property
+    def __len__(self) -> Callable[[], int]:
         if isinstance(self._body, Sized):
-            return len(self._body)
+            return self._body.__len__
         raise AttributeError(f"{self._body.__class__.__name__} is not Sized")
 
+    @property
+    def __length_hint__(self) -> Callable[[], int]:  # pylint: disable=invalid-length-hint-returned
+        if isinstance(self._body, (Sized, EstimatedSized)):
+            return lambda: operator.length_hint(self._body)
+        raise AttributeError(f'{self._body.__class__.__name__} is not Sized and do not implement "__length_hint__"')
+
     def calculate_visible(
         self,
         size: tuple[int, int],
         focus: bool = False,
-    ) -> tuple[_Middle, _TopBottom, _TopBottom] | tuple[None, None, None]:
+    ) -> VisibleInfo | tuple[None, None, None]:
         """
         Returns the widgets that would be displayed in
         the ListBox given the current *size* and *focus*.
@@ -470,7 +531,7 @@ class ListBox(Widget, WidgetContainerMixin):
 
             p_rows = prev.rows((maxcol,))
             if p_rows:  # filter out 0-height widgets
-                fill_above.append(_FillItem(prev, pos, p_rows))
+                fill_above.append(VisibleInfoFillItem(prev, pos, p_rows))
             if p_rows > fill_lines:  # crosses top edge?
                 trim_top = p_rows - fill_lines
                 break
@@ -489,7 +550,7 @@ class ListBox(Widget, WidgetContainerMixin):
 
             n_rows = next_pos.rows((maxcol,))
             if n_rows:  # filter out 0-height widgets
-                fill_below.append(_FillItem(next_pos, pos, n_rows))
+                fill_below.append(VisibleInfoFillItem(next_pos, pos, n_rows))
             if n_rows > fill_lines:  # crosses bottom edge?
                 trim_bottom = n_rows - fill_lines
                 fill_lines -= n_rows
@@ -515,7 +576,7 @@ class ListBox(Widget, WidgetContainerMixin):
                 break
 
             p_rows = prev.rows((maxcol,))
-            fill_above.append(_FillItem(prev, pos, p_rows))
+            fill_above.append(VisibleInfoFillItem(prev, pos, p_rows))
             if p_rows > fill_lines:  # more than required
                 trim_top = p_rows - fill_lines
                 offset_rows += fill_lines
@@ -524,17 +585,31 @@ class ListBox(Widget, WidgetContainerMixin):
             offset_rows += p_rows
 
         # 5. return the interesting bits
-        return (
-            _Middle(offset_rows - inset_rows, focus_widget, focus_pos, focus_rows, cursor),
-            _TopBottom(trim_top, fill_above),
-            _TopBottom(trim_bottom, fill_below),
+        return VisibleInfo(
+            VisibleInfoMiddle(offset_rows - inset_rows, focus_widget, focus_pos, focus_rows, cursor),
+            VisibleInfoTopBottom(trim_top, fill_above),
+            VisibleInfoTopBottom(trim_bottom, fill_below),
         )
 
-    def get_scrollpos(self, size: tuple[int, int] | None = None, focus: bool = False) -> int:
-        """Current scrolling position."""
+    def _check_support_scrolling(self) -> None:
+        from .treetools import TreeWalker
+
         if not isinstance(self._body, ScrollSupportingBody):
             raise ListBoxError(f"{self} body do not implement methods required for scrolling protocol")
 
+        if not isinstance(self._body, (Sized, EstimatedSized, TreeWalker)):
+            raise ListBoxError(
+                f"{self} body is not a Sized, can not estimate it's size and not a TreeWalker."
+                f"Scroll is not allowed due to risk of infinite cycle of widgets load."
+            )
+
+        if getattr(self._body, "wrap_around", False):
+            raise ListBoxError("Body is wrapped around. Scroll position calculation is undefined.")
+
+    def get_scrollpos(self, size: tuple[int, int] | None = None, focus: bool = False) -> int:
+        """Current scrolling position."""
+        self._check_support_scrolling()
+
         if not self._body:
             return 0
 
@@ -560,22 +635,65 @@ class ListBox(Widget, WidgetContainerMixin):
 
     def rows_max(self, size: tuple[int, int] | None = None, focus: bool = False) -> int:
         """Scrollable protocol for sized iterable and not wrapped around contents."""
-        if not isinstance(self._body, ScrollSupportingBody):
-            raise ListBoxError(f"{self} body do not implement methods required for scrolling protocol")
-
-        if getattr(self._body, "wrap_around", False):
-            raise ListBoxError("Body is wrapped around")
+        self._check_support_scrolling()
 
         if size is not None:
             self._rendered_size = size
 
         if size or not self._rows_max_cached:
-            self._rows_max_cached = sum(
-                self._body[position].rows((self._rendered_size[0],), focus) for position in self._body.positions()
-            )
+            cols = self._rendered_size[0]
+            rows = 0
+
+            focused_w, idx = self.body.get_focus()
+            rows += focused_w.rows((cols,), focus)
+
+            prev, pos = self._body.get_prev(idx)
+            while prev is not None:
+                rows += prev.rows((cols,), False)
+                prev, pos = self._body.get_prev(pos)
+
+            next_, pos = self.body.get_next(idx)
+            while next_ is not None:
+                rows += next_.rows((cols,), True)
+                next_, pos = self._body.get_next(pos)
+
+            self._rows_max_cached = rows
 
         return self._rows_max_cached
 
+    def require_relative_scroll(self, size: tuple[int, int], focus: bool = False) -> bool:
+        """Widget require relative scroll due to performance limitations of real lines count calculation."""
+        return isinstance(self._body, (Sized, EstimatedSized)) and (size[1] * 3 < operator.length_hint(self.body))
+
+    def get_first_visible_pos(self, size: tuple[int, int], focus: bool = False) -> int:
+        self._check_support_scrolling()
+
+        if not self._body:
+            return 0
+
+        _mid, top, _bottom = self.calculate_visible(size, focus)
+        if top.fill:
+            first_pos = top.fill[-1].position
+        else:
+            first_pos = self.focus_position
+
+        over = 0
+        _widget, first_pos = self.body.get_prev(first_pos)
+        while first_pos is not None:
+            over += 1
+            _widget, first_pos = self.body.get_prev(first_pos)
+
+        return over
+
+    def get_visible_amount(self, size: tuple[int, int], focus: bool = False) -> int:
+        self._check_support_scrolling()
+
+        if not self._body:
+            return 1
+
+        _mid, top, bottom = self.calculate_visible(size, focus)
+        return 1 + len(top.fill) + len(bottom.fill)
+
     def render(
         self,
         size: tuple[int, int],  # type: ignore[override]
@@ -594,9 +712,9 @@ class ListBox(Widget, WidgetContainerMixin):
         if middle is None:
             return SolidCanvas(" ", maxcol, maxrow)
 
-        _ignore, focus_widget, focus_pos, focus_rows, cursor = middle
-        trim_top, fill_above = top
-        trim_bottom, fill_below = bottom
+        _ignore, focus_widget, focus_pos, focus_rows, cursor = middle  # pylint: disable=unpacking-non-sequence
+        trim_top, fill_above = top  # pylint: disable=unpacking-non-sequence
+        trim_bottom, fill_below = bottom  # pylint: disable=unpacking-non-sequence
 
         combinelist: list[tuple[Canvas, int, bool]] = []
         rows = 0
@@ -706,7 +824,7 @@ class ListBox(Widget, WidgetContainerMixin):
         if middle is None:
             return None
 
-        offset_inset, _ignore1, _ignore2, _ignore3, cursor = middle
+        offset_inset, _ignore1, _ignore2, _ignore3, cursor = middle  # pylint: disable=unpacking-non-sequence
         if not cursor:
             return None
 
@@ -897,9 +1015,9 @@ class ListBox(Widget, WidgetContainerMixin):
         if middle is None:
             return
 
-        row_offset, focus_widget, _focus_pos, focus_rows, _cursor = middle
-        _trim_top, _fill_above = top
-        trim_bottom, fill_below = bottom
+        row_offset, focus_widget, _focus_pos, focus_rows, _cursor = middle  # pylint: disable=unpacking-non-sequence
+        _trim_top, _fill_above = top  # pylint: disable=unpacking-non-sequence
+        trim_bottom, fill_below = bottom  # pylint: disable=unpacking-non-sequence
 
         if focus_widget.selectable():
             return
@@ -935,9 +1053,9 @@ class ListBox(Widget, WidgetContainerMixin):
         self._body.set_focus(focus_pos)
 
         middle, top, bottom = self.calculate_visible((maxcol, maxrow), focus)
-        focus_offset, _focus_widget, focus_pos, focus_rows, _cursor = middle
-        _trim_top, fill_above = top
-        _trim_bottom, fill_below = bottom
+        focus_offset, _focus_widget, focus_pos, focus_rows, _cursor = middle  # pylint: disable=unpacking-non-sequence
+        _trim_top, fill_above = top  # pylint: disable=unpacking-non-sequence
+        _trim_bottom, fill_below = bottom  # pylint: disable=unpacking-non-sequence
 
         offset = focus_offset
         for _widget, pos, rows in fill_above:
@@ -1251,8 +1369,8 @@ class ListBox(Widget, WidgetContainerMixin):
         if middle is None:
             return True
 
-        focus_row_offset, focus_widget, focus_pos, _ignore, cursor = middle
-        _trim_top, fill_above = top
+        focus_row_offset, focus_widget, focus_pos, _ignore, cursor = middle  # pylint: disable=unpacking-non-sequence
+        _trim_top, fill_above = top  # pylint: disable=unpacking-non-sequence
 
         row_offset = focus_row_offset
 
@@ -1324,8 +1442,8 @@ class ListBox(Widget, WidgetContainerMixin):
         if middle is None:
             return True
 
-        focus_row_offset, focus_widget, focus_pos, focus_rows, cursor = middle
-        _trim_bottom, fill_below = bottom
+        focus_row_offset, focus_widget, focus_pos, focus_rows, cursor = middle  # pylint: disable=unpacking-non-sequence
+        _trim_bottom, fill_below = bottom  # pylint: disable=unpacking-non-sequence
 
         row_offset = focus_row_offset + focus_rows
         rows = focus_rows
@@ -1363,9 +1481,6 @@ class ListBox(Widget, WidgetContainerMixin):
             if widget is None:
                 self.shift_focus((maxcol, maxrow), row_offset - rows)
                 return None
-            # FIXME: catch this bug in testcase
-            # self.change_focus((maxcol,maxrow), pos,
-            #    row_offset+rows, 'above')
             self.change_focus((maxcol, maxrow), pos, row_offset - rows, "above")
             return None
 
@@ -1406,8 +1521,8 @@ class ListBox(Widget, WidgetContainerMixin):
         if middle is None:
             return True
 
-        row_offset, focus_widget, focus_pos, focus_rows, cursor = middle
-        _trim_top, fill_above = top
+        row_offset, focus_widget, focus_pos, focus_rows, cursor = middle  # pylint: disable=unpacking-non-sequence
+        _trim_top, fill_above = top  # pylint: disable=unpacking-non-sequence
 
         # topmost_visible is row_offset rows above top row of
         # focus (+ve) or -row_offset rows below top row of focus (-ve)
@@ -1516,7 +1631,7 @@ class ListBox(Widget, WidgetContainerMixin):
 
             # find out where that actually puts us
             middle, top, _bottom = self.calculate_visible((maxcol, maxrow), True)
-            act_row_offset, _ign1, _ign2, _ign3, _ign4 = middle
+            act_row_offset, _ign1, _ign2, _ign3, _ign4 = middle  # pylint: disable=unpacking-non-sequence
 
             # discard chosen widget if it will reduce scroll amount
             # because of a fixed cursor (absolute last resort)
@@ -1566,7 +1681,7 @@ class ListBox(Widget, WidgetContainerMixin):
 
         # final check for pathological case where we may fall short
         middle, top, _bottom = self.calculate_visible((maxcol, maxrow), True)
-        act_row_offset, _ign1, pos, _ign2, _ign3 = middle
+        act_row_offset, _ign1, pos, _ign2, _ign3 = middle  # pylint: disable=unpacking-non-sequence
         if act_row_offset >= row_offset:
             # no problem
             return None
@@ -1598,8 +1713,8 @@ class ListBox(Widget, WidgetContainerMixin):
         if middle is None:
             return True
 
-        row_offset, focus_widget, focus_pos, focus_rows, cursor = middle
-        _trim_bottom, fill_below = bottom
+        row_offset, focus_widget, focus_pos, focus_rows, cursor = middle  # pylint: disable=unpacking-non-sequence
+        _trim_bottom, fill_below = bottom  # pylint: disable=unpacking-non-sequence
 
         # bottom_edge is maxrow-focus_pos rows below top row of focus
         bottom_edge = maxrow - row_offset
@@ -1704,7 +1819,7 @@ class ListBox(Widget, WidgetContainerMixin):
 
             # find out where that actually puts us
             middle, _top, bottom = self.calculate_visible((maxcol, maxrow), True)
-            act_row_offset, _ign1, _ign2, _ign3, _ign4 = middle
+            act_row_offset, _ign1, _ign2, _ign3, _ign4 = middle  # pylint: disable=unpacking-non-sequence
 
             # discard chosen widget if it will reduce scroll amount
             # because of a fixed cursor (absolute last resort)
@@ -1750,7 +1865,7 @@ class ListBox(Widget, WidgetContainerMixin):
 
         # final check for pathological case where we may fall short
         middle, _top, bottom = self.calculate_visible((maxcol, maxrow), True)
-        act_row_offset, _ign1, pos, _ign2, _ign3 = middle
+        act_row_offset, _ign1, pos, _ign2, _ign3 = middle  # pylint: disable=unpacking-non-sequence
         if act_row_offset <= row_offset:
             # no problem
             return None
@@ -1795,9 +1910,9 @@ class ListBox(Widget, WidgetContainerMixin):
         if middle is None:
             return False
 
-        _ignore, focus_widget, focus_pos, focus_rows, _cursor = middle
-        trim_top, fill_above = top
-        _ignore, fill_below = bottom
+        _ignore, focus_widget, focus_pos, focus_rows, _cursor = middle  # pylint: disable=unpacking-non-sequence
+        trim_top, fill_above = top  # pylint: disable=unpacking-non-sequence
+        _ignore, fill_below = bottom  # pylint: disable=unpacking-non-sequence
 
         fill_above.reverse()  # fill_above is in bottom-up order
         w_list = [*fill_above, (focus_widget, focus_pos, focus_rows), *fill_below]
@@ -1850,11 +1965,11 @@ class ListBox(Widget, WidgetContainerMixin):
         middle, top, bottom = self.calculate_visible((maxcol, maxrow), focus=focus)
         if middle is None:  # empty listbox
             return ["top", "bottom"]
-        trim_top, above = top
-        trim_bottom, below = bottom
+        trim_top, above = top  # pylint: disable=unpacking-non-sequence
+        trim_bottom, below = bottom  # pylint: disable=unpacking-non-sequence
 
         if trim_bottom == 0:
-            row_offset, _w, pos, rows, _c = middle
+            row_offset, _w, pos, rows, _c = middle  # pylint: disable=unpacking-non-sequence
             row_offset += rows
             for _w, pos, rows in below:  # noqa: B007  # magic with scope
                 row_offset += rows
@@ -1862,7 +1977,7 @@ class ListBox(Widget, WidgetContainerMixin):
                 result.append("bottom")
 
         if trim_top == 0:
-            row_offset, _w, pos, _rows, _c = middle
+            row_offset, _w, pos, _rows, _c = middle  # pylint: disable=unpacking-non-sequence
             for _w, pos, rows in above:  # noqa: B007  # magic with scope
                 row_offset -= rows
             if self._body.get_prev(pos) == (None, None):

urwid/widget/monitored_list.py

@@ -31,7 +31,7 @@ if typing.TYPE_CHECKING:
     ArgSpec = ParamSpec("ArgSpec")
     Ret = typing.TypeVar("Ret")
 
-__all__ = ("MonitoredList", "MonitoredFocusList")
+__all__ = ("MonitoredFocusList", "MonitoredList")
 
 _T = typing.TypeVar("_T")
 

urwid/widget/scrollable.py

@@ -85,10 +85,10 @@ class ScrollbarSymbols(str, enum.Enum):
 
 
 @runtime_checkable
-class SupportsScroll(Protocol):
-    """Protocol for scroll supporting widget.
+class WidgetProto(Protocol):
+    """Protocol for widget.
 
-    Due to protocol can not inherit non-protocol bases, require also several obligatory Widget methods.
+    Due to protocol cannot inherit non-protocol bases, define several obligatory Widget methods.
     """
 
     # Base widget methods (from Widget)
@@ -116,12 +116,27 @@ class SupportsScroll(Protocol):
 
     def render(self, size: tuple[int, int], focus: bool = False) -> Canvas: ...
 
-    # Scroll specific methods
+
+@runtime_checkable
+class SupportsScroll(WidgetProto, Protocol):
+    """Scroll specific methods."""
+
     def get_scrollpos(self, size: tuple[int, int], focus: bool = False) -> int: ...
 
     def rows_max(self, size: tuple[int, int] | None = None, focus: bool = False) -> int: ...
 
 
+@runtime_checkable
+class SupportsRelativeScroll(WidgetProto, Protocol):
+    """Relative scroll-specific methods."""
+
+    def require_relative_scroll(self, size: tuple[int, int], focus: bool = False) -> bool: ...
+
+    def get_first_visible_pos(self, size: tuple[int, int], focus: bool = False) -> int: ...
+
+    def get_visible_amount(self, size: tuple[int, int], focus: bool = False) -> int: ...
+
+
 class Scrollable(WidgetDecoration[WrappedWidget]):
     def sizing(self) -> frozenset[Sizing]:
         return frozenset((Sizing.BOX,))
@@ -286,7 +301,7 @@ class Scrollable(WidgetDecoration[WrappedWidget]):
             ow = self._original_widget
             ow_size = self._get_original_widget_size(size)
 
-            # Remember previous cursor position if possible
+            # Remember the previous cursor position if possible
             if hasattr(ow, "get_cursor_coords"):
                 self._old_cursor_coords = ow.get_cursor_coords(ow_size)
 
@@ -294,7 +309,7 @@ class Scrollable(WidgetDecoration[WrappedWidget]):
             if key is None:
                 return None
 
-        # Handle up/down, page up/down, etc
+        # Handle up/down, page up/down, etc.
         command_map = self._command_map
         if command_map[key] == Command.UP:
             self._scroll_action = SCROLL_LINE_UP
@@ -438,10 +453,10 @@ class Scrollable(WidgetDecoration[WrappedWidget]):
 class ScrollBar(WidgetDecoration[WrappedWidget]):
     Symbols = ScrollbarSymbols
 
-    def sizing(self):
+    def sizing(self) -> frozenset[Sizing]:
         return frozenset((Sizing.BOX,))
 
-    def selectable(self):
+    def selectable(self) -> bool:
         return True
 
     def __init__(
@@ -483,30 +498,60 @@ class ScrollBar(WidgetDecoration[WrappedWidget]):
     ) -> Canvas:
         from urwid import canvas
 
+        def render_no_scrollbar() -> Canvas:
+            self._original_widget_size = size
+            return ow.render(size, focus)
+
+        def render_for_scrollbar() -> Canvas:
+            self._original_widget_size = ow_size
+            return ow.render(ow_size, focus)
+
         maxcol, maxrow = size
 
-        sb_width = self._scrollbar_width
-        ow_size = (max(0, maxcol - sb_width), maxrow)
+        ow_size = (max(0, maxcol - self._scrollbar_width), maxrow)
         sb_width = maxcol - ow_size[0]
 
         ow = self._original_widget
         ow_base = self.scrolling_base_widget
-        ow_rows_max = ow_base.rows_max(size, focus)
-        if ow_rows_max <= maxrow:
-            # Canvas fits without scrolling - no scrollbar needed
-            self._original_widget_size = size
-            return ow.render(size, focus)
-        ow_rows_max = ow_base.rows_max(ow_size, focus)
 
-        ow_canv = ow.render(ow_size, focus)
-        self._original_widget_size = ow_size
-
-        pos = ow_base.get_scrollpos(ow_size, focus)
-        posmax = ow_rows_max - maxrow
+        # Use hasattr instead of protocol: hasattr will return False in case of getattr raise AttributeError
+        # Use __length_hint__ first since it's less resource intensive
+        use_relative = (
+            isinstance(ow_base, SupportsRelativeScroll)
+            and any(hasattr(ow_base, attrib) for attrib in ("__length_hint__", "__len__"))
+            and ow_base.require_relative_scroll(size, focus)
+        )
 
-        # Thumb shrinks/grows according to the ratio of
-        # <number of visible lines> / <number of total lines>
-        thumb_weight = min(1.0, maxrow / max(1, ow_rows_max))
+        if use_relative:
+            # `operator.length_hint` is Protocol (Spec) over class based and can end false-negative on the instance
+            # use length_hint-like approach with safe `AttributeError` handling
+            ow_len = getattr(ow_base, "__len__", getattr(ow_base, "__length_hint__", lambda: 0))()
+            ow_canv = render_for_scrollbar()
+            visible_amount = ow_base.get_visible_amount(ow_size, focus)
+            pos = ow_base.get_first_visible_pos(ow_size, focus)
+
+            # in the case of estimated length, it can be smaller than real widget length
+            ow_len = max(ow_len, visible_amount, pos)
+            posmax = ow_len - visible_amount
+            thumb_weight = min(1.0, visible_amount / max(1, ow_len))
+
+            if ow_len == visible_amount:
+                # Corner case: formally all contents indexes should be visible, but this does not mean all rows
+                use_relative = False
+
+        if not use_relative:
+            ow_rows_max = ow_base.rows_max(size, focus)
+            if ow_rows_max <= maxrow:
+                # Canvas fits without scrolling - no scrollbar needed
+                return render_no_scrollbar()
+
+            ow_canv = render_for_scrollbar()
+            ow_rows_max = ow_base.rows_max(ow_size, focus)
+            pos = ow_base.get_scrollpos(ow_size, focus)
+            posmax = ow_rows_max - maxrow
+            thumb_weight = min(1.0, maxrow / max(1, ow_rows_max))
+
+        # Thumb shrinks/grows according to the ratio of <number of visible lines> / <number of total lines>
         thumb_height = max(1, round(thumb_weight * maxrow))
 
         # Thumb may only touch top/bottom if the first/last row is visible
@@ -564,7 +609,7 @@ class ScrollBar(WidgetDecoration[WrappedWidget]):
         self._invalidate()
 
     @property
-    def scrolling_base_widget(self) -> SupportsScroll:
+    def scrolling_base_widget(self) -> SupportsScroll | SupportsRelativeScroll:
         """Nearest `original_widget` that is compatible with the scrolling API"""
 
         def orig_iter(w: Widget) -> Iterator[Widget]:

urwid/widget/treetools.py

@@ -43,7 +43,7 @@ from .wimp import SelectableIcon
 if typing.TYPE_CHECKING:
     from collections.abc import Hashable, Sequence
 
-__all__ = ("TreeWidgetError", "TreeWidget", "TreeNode", "ParentNode", "TreeWalker", "TreeListBox")
+__all__ = ("ParentNode", "TreeListBox", "TreeNode", "TreeWalker", "TreeWidget", "TreeWidgetError")
 
 
 class TreeWidgetError(RuntimeError):
@@ -85,7 +85,7 @@ class TreeWidget(WidgetWrap[Padding[typing.Union[Text, Columns]]]):
         """Update display widget text for parent widgets"""
         # icon is first element in columns indented widget
         icon = [self.unexpanded_icon, self.expanded_icon][self.expanded]
-        self._w.original_widget.contents[0] = (icon, (WHSettings.GIVEN, 1, False))
+        self._w.base_widget.contents[0] = (icon, (WHSettings.GIVEN, 1, False))
 
     def get_indent_cols(self) -> int:
         return self.indent_cols * self.get_node().get_depth()
@@ -496,8 +496,8 @@ class TreeListBox(ListBox):
 
         middle, top, _bottom = self.calculate_visible(size)
 
-        row_offset, _focus_widget, _focus_pos, _focus_rows, _cursor = middle
-        _trim_top, fill_above = top
+        row_offset, _focus_widget, _focus_pos, _focus_rows, _cursor = middle  # pylint: disable=unpacking-non-sequence
+        _trim_top, fill_above = top  # pylint: disable=unpacking-non-sequence
 
         for _widget, pos, rows in fill_above:
             row_offset -= rows

{urwid-2.6.8.dist-info → urwid-2.6.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: urwid
-Version: 2.6.8
+Version: 2.6.10
 Summary: A full-featured console (xterm et al.) user interface library
 Home-page: https://urwid.org/
 Author-email: Ian Ward <ian@excess.org>

{urwid-2.6.8.dist-info → urwid-2.6.10.dist-info}/RECORD

@@ -11,7 +11,7 @@ urwid/split_repr.py,sha256=pXzuddzQ4RnfIl537Gvoe8PVaBRHCPnxgdYvKK0qm8k,3899
 urwid/str_util.py,sha256=1ss-LHAhjXTynTVBcoSgYWIpBeN_RirqHYhP7fq7MrA,10844
 urwid/text_layout.py,sha256=lHiGfo7clmwHt5dMl_AaQSs2ov9IbY9JySTATZBm7h0,22821
 urwid/util.py,sha256=pGXnma03_IBx3v6_qN9cDWPXPj_YjkhQ9IxLjm_0TpU,15747
-urwid/version.py,sha256=jdg0k_UZTwIu69t9K_2liDiTcorgM7X8Mp2eI1v4r40,411
+urwid/version.py,sha256=Q6B6SJpzx7ArqUrw_2w87t72hs-NzqHnm-ERmJDUGVM,413
 urwid/vterm.py,sha256=q9-8dxJpVr_7a0Bj_z_FYDiRgzos3IS17BjhYcy1RDw,58410
 urwid/wimp.py,sha256=o1YsjL_tBLXba8ZRr1MTHH0poLSlXT_atY3-uD_Ualg,567
 urwid/display/__init__.py,sha256=y90WbHPNRHlimPrXhzsSfFsBbBHy8QErmB1y4Xza-xo,1732
@@ -23,22 +23,22 @@ urwid/display/_win32.py,sha256=hD4hytElpfIv5qxGNTMSa2QeBNByqJDNVpmiiQSj6CM,5401
 urwid/display/_win32_raw_display.py,sha256=0PuHEhqJRl8uQmaWSOWceM1aEuolPZ-1MbHYN7s9yRY,9248
 urwid/display/common.py,sha256=_WiwXtt6KULEVLGeZvRIwmNcSfL92BPFv-uhb0_w2d0,39528
 urwid/display/curses.py,sha256=poYvs4iGPzl1jXpi8UUNyrTX2Ap9qxXPVhSu_zE4IuY,22800
-urwid/display/escape.py,sha256=rUIaEpyTMmZYFdn2tXn_wmecEW-D0tO59FUk0t5neZo,17968
+urwid/display/escape.py,sha256=rG7x82_S91SRdfKXOEzkawDFtmVk5_KiKIY4Bh2mf7s,17826
 urwid/display/html_fragment.py,sha256=lQRqr-hTrknQyZTtzPDp9zr-TWOT4NcuSsusS-LXIOU,8547
 urwid/display/lcd.py,sha256=qXfuyZcicarrZM-O-ccPFBPjflD3_bLMv3IQzmYI43E,17607
 urwid/display/raw.py,sha256=TSkIEM6KnQHPmmpBkWKdirZOwVXhSV67k7hWmuuR2OY,1125
 urwid/display/web.py,sha256=39o12Cl79Ft669-mIbq_ZGGVzzkSfHb3Ny54mASegec,19250
 urwid/event_loop/__init__.py,sha256=6di4AYD6HbCf6v5p0rZOoteKnM9U5tfk4NKcWMH4FV4,1199
 urwid/event_loop/abstract_loop.py,sha256=6Kkw3KCJ4ndiI2I1P8fPdtHzjuekRxUuvzFOiR0Myok,5494
-urwid/event_loop/asyncio_loop.py,sha256=QoK1zO6YHg5dn2DPlCXSf9uXPHEe6k6P9pPJMWISB-Q,8473
+urwid/event_loop/asyncio_loop.py,sha256=9B3redIwvfYzqKSbnxiocb6wx9VXLi5XB08cUJkserE,8471
 urwid/event_loop/glib_loop.py,sha256=GFoLAenoWKm-13rTBKzCF2JdCEryJKpMo25aidZ7BWs,9351
 urwid/event_loop/main_loop.py,sha256=gR2jGmqg1-CXFdNDlt-NizdS5AA7EZfmp6sW-nXwa18,26000
 urwid/event_loop/select_loop.py,sha256=5ZkIPqyIVJdWRTC89Ca5h8ub_-jpqXjFZaKqiWhdkDg,7534
 urwid/event_loop/tornado_loop.py,sha256=VNgXW2gO4edcYDjyEGb86yOHrE0NNXQUPXIOfJyZnAk,7100
-urwid/event_loop/trio_loop.py,sha256=2SBX1pbiJddAsXbe1itPPXYdoX5_U00m56A4h0x9dWI,10467
+urwid/event_loop/trio_loop.py,sha256=46uFQ1O-AM8EaJETCsXzECDNviYMyzOsDKQoJgMHQSk,10468
 urwid/event_loop/twisted_loop.py,sha256=CtpWBzxNp_y7LHejnXIS67B-iboM3irb_MuI_FtXzc0,9219
 urwid/event_loop/zmq_loop.py,sha256=wt4lE0hnDODTVaAMuB5wCSAD5yQ6D9pj8_G_7iNGBUI,9074
-urwid/widget/__init__.py,sha256=Mbfr6N4sfUFoknlkMDvTbfyR65rUFkRAeNKzjz4sENY,4683
+urwid/widget/__init__.py,sha256=lEFAuQKYnGKS9-dhUggItnnm9Bvbbuk7RAKvzrs8xkI,4683
 urwid/widget/attr_map.py,sha256=L6svBcabtXeSaU2cNrgDv4Nne6QYk-nvVbr88sA4WnY,6205
 urwid/widget/attr_wrap.py,sha256=pJQHVNlwcX5IgpdSmTqYOt63EX-p5hA0mJfXtWXJ6wg,4830
 urwid/widget/bar_graph.py,sha256=Ui2Z-DJ7Try9rkAQ14rK__-oSGfsWncpJH-AxSF00bk,21615
@@ -53,22 +53,22 @@ urwid/widget/filler.py,sha256=EEnyAawdKXuwf79pErfNuvqsU1SVTutcMUrwWkU4wfo,14665
 urwid/widget/frame.py,sha256=AOe4FwjvwcIwrpXqyZkCwSZWwAALNl1XRMAKx6ZXYWs,21834
 urwid/widget/grid_flow.py,sha256=otujeOTWYDr4gwuDikBm9zZd8SUgma9yvQ1hDWI-dGk,21514
 urwid/widget/line_box.py,sha256=V750xiZtkw6_uRXLhNY91ER3pXwwrZstVv_IJUZd_YY,6884
-urwid/widget/listbox.py,sha256=s3hg3VoiDY3pfqEmkURIE_Fa8WcLLzuaJn-_LVfG0EM,69495
-urwid/widget/monitored_list.py,sha256=M0PjNc_Vtuk6fnWdDelx-nbs3jLtXAo4JKB_OTk8McI,18773
+urwid/widget/listbox.py,sha256=EaGo13fpt4Oy9V00n27U-2PhOWa7-nmsTgnddKv9GII,74392
+urwid/widget/monitored_list.py,sha256=8lBb8kowLAqKMKByiBZp4jt9PSnXjYAoAjXFXm-7xcg,18773
 urwid/widget/overlay.py,sha256=7EtTHOomIF4xzwYiY7SiMCQZF2IHrmO88YeosFOMFo0,34505
 urwid/widget/padding.py,sha256=tdBJybrKJqR8OLo5DHixn6KZA3tefYlfo9kkqvxYLEc,21252
 urwid/widget/pile.py,sha256=aIzKYNrSQtbHVk_bn2PElHUiSdsO_NKnL4mTu-sXm4I,38628
 urwid/widget/popup.py,sha256=UQ1MTzt8RNcfIvmwIqDM4mypxxXUOMsGoiozom8HfTg,5814
 urwid/widget/progress_bar.py,sha256=HRnIu2V2_4wgsnAdrhK-GVVToyLaXRH0gtlkWllA4Mo,4767
-urwid/widget/scrollable.py,sha256=PZjcelZlyfl0MnxY7DHuaae_XbjuJQ1bVNPlSlmaWJI,22198
+urwid/widget/scrollable.py,sha256=yB3S3k5dOdZ-wrQMlgxQH-1AZONSf5X6Y2accIa9tpk,24279
 urwid/widget/solid_fill.py,sha256=NZRDSRK0lP4r7gXcKDgVaKEoeOcWvtrY5k2aueQEEL4,1260
 urwid/widget/text.py,sha256=jy15hL6rCBoJdZviq2jJ-i9eO6vEcxvzCIVAZs12AUw,12187
-urwid/widget/treetools.py,sha256=7b2US3Dj_akQ2JCf5gPo1SKGfvIhnQjbkpcLfYl0Kk4,17307
+urwid/widget/treetools.py,sha256=5s3Dnp2PCz4wQccutmdvsTTbAROJMLehXe4moB5POY0,17387
 urwid/widget/widget.py,sha256=dMGNVewj2NGFdGKAtDJYgOzhuJAtrr_BALOMwNzUyj0,29550
 urwid/widget/widget_decoration.py,sha256=aHP9Y7JKVCI2dw2OdRrzMj9p--C1pMIbxSJskWBLIgc,5633
 urwid/widget/wimp.py,sha256=4wfzTQBLMbhicSlL64hBPb-1W5FAFrIKfb43i10MKSY,27305
-urwid-2.6.8.dist-info/COPYING,sha256=NrbT-keRaUP9X-wxPFhHhJRgR-wTN6eLRA5ZkstZX4k,26434
-urwid-2.6.8.dist-info/METADATA,sha256=MYAhcUjx0jFXDZeMC8x8xCVYSJhAAwnLgbnQSixNIrw,11042
-urwid-2.6.8.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-urwid-2.6.8.dist-info/top_level.txt,sha256=AwxQA43kNkjHbhYELXHBKrQ01X5CR2KnDzU07cVqilY,6
-urwid-2.6.8.dist-info/RECORD,,
+urwid-2.6.10.dist-info/COPYING,sha256=NrbT-keRaUP9X-wxPFhHhJRgR-wTN6eLRA5ZkstZX4k,26434
+urwid-2.6.10.dist-info/METADATA,sha256=o9GKYe-Nt5Hkz7EF_S6E3DXp8CblUs66umXNmAj5-jI,11043
+urwid-2.6.10.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+urwid-2.6.10.dist-info/top_level.txt,sha256=AwxQA43kNkjHbhYELXHBKrQ01X5CR2KnDzU07cVqilY,6
+urwid-2.6.10.dist-info/RECORD,,

{urwid-2.6.8.dist-info → urwid-2.6.10.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any