urwid 4.0.0__tar.gz → 4.0.2__tar.gz

{urwid-4.0.0 → urwid-4.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: urwid
-Version: 4.0.0
+Version: 4.0.2
 Summary: A full-featured console (xterm et al.) user interface library
 Author-email: Ian Ward <ian@excess.org>
 License-Expression: LGPL-2.1-only

urwid-4.0.2/SECURITY.md

@@ -0,0 +1,3 @@
+# Security
+
+Report vulnerabilities at https://github.com/urwid/urwid/security/advisories

{urwid-4.0.0 → urwid-4.0.2}/docs/changelog.rst

@@ -2,6 +2,81 @@
 Changelog
 ---------
 
+Urwid 4.0.2
+===========
+
+2026-06-02
+
+New features 🗹
++++++++++++++++
+* Initial typing support for urwid package by @penguinolog in https://github.com/urwid/urwid/pull/1144
+Bug fixes 🕷
+++++++++++++
+* Fix ListBoxError in _keypress_page_down when snapping to a widget above the top by @neutralinsomniac in https://github.com/urwid/urwid/pull/1133
+* Fix lazy_import of display modules if __package__ is not defined by @penguinolog in https://github.com/urwid/urwid/pull/1136
+Documentation 🕮
+++++++++++++++++
+* Adjust typing for `urwid.display` and `urwid.event_loop` by @penguinolog in https://github.com/urwid/urwid/pull/1138
+* Typing: extend typing information for `urwid.display` by @penguinolog in https://github.com/urwid/urwid/pull/1139
+* Typing: adjust event loop types by @penguinolog in https://github.com/urwid/urwid/pull/1140
+* Typing: adjust types for vterm, numedit and graphics by @penguinolog in https://github.com/urwid/urwid/pull/1141
+* Typing: adjust types for `urwid.widget` by @penguinolog in https://github.com/urwid/urwid/pull/1142
+Refactoring 🛠
+++++++++++++++
+* Feat: refactor `urwid.widget.scrollable` by @penguinolog in https://github.com/urwid/urwid/pull/1143
+Other Changes
++++++++++++++
+* Web display: tighten security by using more complex identifiers by @penguinolog in https://github.com/urwid/urwid/pull/1137
+
+New Contributors
+++++++++++++++++
+* @neutralinsomniac made their first contribution in https://github.com/urwid/urwid/pull/1133
+
+**Full Changelog**: https://github.com/urwid/urwid/compare/4.0.1...4.0.2
+
+Urwid 4.0.1
+===========
+
+2026-05-26
+
+Bug fixes 🕷
+++++++++++++
+* fix three return type annotations by @evgunter in https://github.com/urwid/urwid/pull/1121
+* Web display: use secure random session identifiers by @penguinolog in https://github.com/urwid/urwid/pull/1128
+Other Changes
++++++++++++++
+* Add SECURITY.md by @jrwe in https://github.com/urwid/urwid/pull/1123
+
+New Contributors
+++++++++++++++++
+* @evgunter made their first contribution in https://github.com/urwid/urwid/pull/1121
+* @jrwe made their first contribution in https://github.com/urwid/urwid/pull/1123
+
+**Full Changelog**: https://github.com/urwid/urwid/compare/4.0.0...4.0.1
+
+Urwid 4.0.0
+===========
+
+2026-03-30
+
+Breaking Changes ⚠
+++++++++++++++++++
+* Deprecation: Remove deprecated protected  methods for version 4 by @penguinolog in https://github.com/urwid/urwid/pull/1078
+* Deprecation: Remove deprecated public methods announced to be removed in v4 by @penguinolog in https://github.com/urwid/urwid/pull/1085
+* Deprecation: Remove deprecated `Filler.get_body` and `Filler.set_body` by @penguinolog in https://github.com/urwid/urwid/pull/1117
+Deprecations ⚡
+++++++++++++++
+* Deprecation: announce deadline for deprecated APIs by @penguinolog in https://github.com/urwid/urwid/pull/1118
+Bug fixes 🕷
+++++++++++++
+* stdin handling for closed state by @wilkpio in https://github.com/urwid/urwid/pull/1112
+
+New Contributors
+++++++++++++++++
+* @wilkpio made their first contribution in https://github.com/urwid/urwid/pull/1112
+
+**Full Changelog**: https://github.com/urwid/urwid/compare/3.0.5...4.0.0
+
 Urwid 3.0.5
 ===========
 

{urwid-4.0.0 → urwid-4.0.2}/docs/examples/bigtext.py

@@ -28,7 +28,6 @@ from __future__ import annotations
 import typing
 
 import urwid
-import urwid.display.raw
 
 if typing.TYPE_CHECKING:
     from collections.abc import Callable

{urwid-4.0.0 → urwid-4.0.2}/examples/bigtext.py

@@ -28,7 +28,6 @@ from __future__ import annotations
 import typing
 
 import urwid
-import urwid.display.raw
 
 if typing.TYPE_CHECKING:
     from collections.abc import Callable

{urwid-4.0.0 → urwid-4.0.2}/pyproject.toml

@@ -54,6 +54,9 @@ lcd = ["pyserial"]
 [tool.distutils.bdist_wheel]
 universal = 0
 
+[tool.setuptools.package-data]
+urwid = [ "py.typed" ]
+
 [tool.setuptools_scm]
 write_to = "urwid/version.py"
 

urwid-4.0.2/ruff-requirements.txt

@@ -0,0 +1 @@
+ruff==0.15.15

{urwid-4.0.0 → urwid-4.0.2}/tests/test_listbox.py

@@ -1960,6 +1960,31 @@ class ZeroHeightContentsTest(unittest.TestCase):
         self.assertEqual([b"below  ", b"       ", b"       ", b"       ", b"       "], canvas.text)
 
 
+class PageDownAboveTopTest(unittest.TestCase):
+    def test_page_down_does_not_raise(self):
+        # Two-row rows so the four-item list does not fit the viewport at once.
+        lb = urwid.ListBox(
+            urwid.SimpleListWalker(
+                            [
+                    urwid.Text("a0\nb0"),
+                    SelectableText("a1\nb1"),
+                    urwid.Text("a2\nb2"),
+                    urwid.Text("a3\nb3"),
+                ]
+            )
+        )
+        size = (7, 4)
+        lb.set_focus(0)
+        lb.render(size, focus=True)
+        lb.keypress(size, "page down")  # used to raise ListBoxError
+        self.assertEqual(lb.focus_position, 3)
+        canvas = lb.render(size, focus=True)
+        self.assertEqual([b"a2     ", b"b2     ", b"a3     ", b"b3     "], canvas.text)
+        # a second page down at the bottom is a no-op, not a crash
+        lb.keypress(size, "page down")
+        self.assertEqual(lb.focus_position, 3)
+
+
 class ListBoxSetBodyTest(unittest.TestCase):
     def test_signal_connected(self):
         lb = urwid.ListBox([])

{urwid-4.0.0 → urwid-4.0.2}/urwid/__init__.py

@@ -215,37 +215,239 @@ from .widget import (
     scale_bar_values,
 )
 
+__all__ = (
+    "ACTIVATE",
+    "ANY",
+    "BLACK",
+    "BOTTOM",
+    "BOX",
+    "BROWN",
+    "CENTER",
+    "CLIP",
+    "CURSOR_DOWN",
+    "CURSOR_LEFT",
+    "CURSOR_MAX_LEFT",
+    "CURSOR_MAX_RIGHT",
+    "CURSOR_PAGE_DOWN",
+    "CURSOR_PAGE_UP",
+    "CURSOR_RIGHT",
+    "CURSOR_UP",
+    "DARK_BLUE",
+    "DARK_CYAN",
+    "DARK_GRAY",
+    "DARK_GREEN",
+    "DARK_MAGENTA",
+    "DARK_RED",
+    "DEFAULT",
+    "ELLIPSIS",
+    "FIXED",
+    "FLOW",
+    "GIVEN",
+    "LEFT",
+    "LIGHT_BLUE",
+    "LIGHT_CYAN",
+    "LIGHT_GRAY",
+    "LIGHT_GREEN",
+    "LIGHT_MAGENTA",
+    "LIGHT_RED",
+    "MIDDLE",
+    "PACK",
+    "REDRAW_SCREEN",
+    "RELATIVE",
+    "RELATIVE_100",
+    "RIGHT",
+    "SPACE",
+    "TOP",
+    "UPDATE_PALETTE_ENTRY",
+    "WEIGHT",
+    "WHITE",
+    "YELLOW",
+    "Align",
+    "AsyncioEventLoop",
+    "AttrMap",
+    "AttrMapError",
+    "AttrSpec",
+    "AttrSpecError",
+    "AttrWrap",
+    "BarGraph",
+    "BarGraphError",
+    "BarGraphMeta",
+    "BaseScreen",
+    "BigText",
+    "BlankCanvas",
+    "BoxAdapter",
+    "BoxAdapterError",
+    "Button",
+    "Canvas",
+    "CanvasCache",
+    "CanvasCombine",
+    "CanvasError",
+    "CanvasJoin",
+    "CanvasOverlay",
+    "CheckBox",
+    "CheckBoxError",
+    "Columns",
+    "ColumnsError",
+    "CommandMap",
+    "CompositeCanvas",
+    "Divider",
+    "Edit",
+    "EditError",
+    "EventLoop",
+    "ExitMainLoop",
+    "Filler",
+    "FillerError",
+    "Font",
+    "FontRegistry",
+    "Frame",
+    "FrameError",
+    "GraphVScale",
+    "GridFlow",
+    "GridFlowError",
+    "HalfBlock5x4Font",
+    "HalfBlock6x5Font",
+    "HalfBlock7x7Font",
+    "HalfBlockHeavy6x5Font",
+    "IntEdit",
+    "LayoutSegment",
+    "LineBox",
+    "ListBox",
+    "ListBoxError",
+    "ListWalker",
+    "ListWalkerError",
+    "MainLoop",
+    "MetaSignals",
+    "MetaSuper",
+    "MonitoredFocusList",
+    "MonitoredList",
+    "Overlay",
+    "OverlayError",
+    "Padding",
+    "PaddingError",
+    "ParentNode",
+    "Pile",
+    "PileError",
+    "PopUpLauncher",
+    "PopUpTarget",
+    "ProgressBar",
+    "RadioButton",
+    "RealTerminal",
+    "ScreenError",
+    "ScrollBar",
+    "Scrollable",
+    "SelectEventLoop",
+    "SelectableIcon",
+    "Sextant2x2Font",
+    "Sextant3x3Font",
+    "Signals",
+    "SimpleFocusListWalker",
+    "SimpleListWalker",
+    "Sizing",
+    "SolidCanvas",
+    "SolidFill",
+    "StandardTextLayout",
+    "TagMarkupException",
+    "Text",
+    "TextCanvas",
+    "TextError",
+    "TextLayout",
+    "Thin3x3Font",
+    "Thin4x3Font",
+    "Thin6x6Font",
+    "TreeListBox",
+    "TreeNode",
+    "TreeWalker",
+    "TreeWidget",
+    "TreeWidgetError",
+    "VAlign",
+    "WHSettings",
+    "Widget",
+    "WidgetContainerMixin",
+    "WidgetDecoration",
+    "WidgetDisable",
+    "WidgetError",
+    "WidgetMeta",
+    "WidgetPlaceholder",
+    "WidgetWrap",
+    "WidgetWrapError",
+    "WrapMode",
+    "__version__",
+    "__version_tuple__",
+    "apply_target_encoding",
+    "calc_text_pos",
+    "calc_trim_text",
+    "calc_width",
+    "command_map",
+    "connect_signal",
+    "decompose_tagmarkup",
+    "default_layout",
+    "delegate_to_widget_mixin",
+    "detected_encoding",
+    "disconnect_signal",
+    "disconnect_signal_by_key",
+    "display",
+    "emit_signal",
+    "event_loop",
+    "fixed_size",
+    "get_all_fonts",
+    "get_encoding_mode",
+    "int_scale",
+    "is_mouse_event",
+    "is_wide_char",
+    "move_next_char",
+    "move_prev_char",
+    "register_signal",
+    "scale_bar_values",
+    "set_encoding",
+    "supports_unicode",
+    "widget",
+    "within_double_byte",
+)
+
+
 # Optional event loops with external dependencies
 
 try:
     from .event_loop import TornadoEventLoop
 except ImportError:
     pass
+else:
+    __all__ += ("TornadoEventLoop",)
 
 try:
     from .event_loop import GLibEventLoop
 except ImportError:
     pass
+else:
+    __all__ += ("GLibEventLoop",)
 
 try:
     from .event_loop import TwistedEventLoop
 except ImportError:
     pass
+else:
+    __all__ += ("TwistedEventLoop",)
 
 try:
     from .event_loop import TrioEventLoop
 except ImportError:
     pass
+else:
+    __all__ += ("TrioEventLoop",)
 
 # OS Specific
 if sys.platform != "win32":
     from .vterm import TermCanvas, TermCharset, Terminal, TermModes
 
-    # ZMQEventLoop cause interpreter crash on windows
+    __all__ += ("TermCanvas", "TermCharset", "TermModes", "Terminal")
+
+    # ZMQEventLoop cause interpreter crash on Windows
     try:
         from .event_loop import ZMQEventLoop
     except ImportError:
         pass
+    else:
+        __all__ += ("ZMQEventLoop",)
 
 # Backward compatibility
 VERSION = __version_tuple__

{urwid-4.0.0 → urwid-4.0.2}/urwid/canvas.py

@@ -39,10 +39,11 @@ from urwid.util import (
 )
 
 if typing.TYPE_CHECKING:
-    from collections.abc import Hashable, Iterable, Iterator, Sequence
+    from collections.abc import Hashable, Iterable, Iterator, Mapping, Sequence
 
     from typing_extensions import Literal
 
+    from .display.common import AttrSpec
     from .widget import Widget
 
 
@@ -214,7 +215,7 @@ class Canvas:
 
     def __init__(self) -> None:
         """Base Canvas class"""
-        self._widget_info: tuple[Widget, tuple[[]] | tuple[int] | tuple[int, int], bool] | None = None
+        self._widget_info: tuple[Widget, tuple[()] | tuple[int] | tuple[int, int], bool] | None = None
         self.coords: dict[str, tuple[int, int, tuple[Widget, int, int]] | tuple[int, int, None]] = {}
         self.shortcuts: dict[str, str] = {}
 
@@ -240,7 +241,7 @@ class Canvas:
         self._widget_info = widget, size, focus
 
     @property
-    def widget_info(self) -> tuple[Widget, tuple[[]] | tuple[int] | tuple[int, int], bool] | None:
+    def widget_info(self) -> tuple[Widget, tuple[()] | tuple[int] | tuple[int, int], bool] | None:
         return self._widget_info
 
     @property
@@ -260,10 +261,10 @@ class Canvas:
         self,
         trim_left: int = 0,
         trim_top: int = 0,
-        cols: int | None = None,
-        rows: int | None = None,
-        attr=None,
-    ) -> Iterator[list[tuple[object, Literal["0", "U"] | None, bytes]]]:
+        cols: int = 0,
+        rows: int = 0,
+        attr: Mapping[object, AttrSpec | str | None] | None = None,
+    ) -> Iterator[list[tuple[AttrSpec | str | None, Literal["0", "U"] | None, bytes]]]:
         raise NotImplementedError()
 
     def cols(self) -> int:
@@ -321,7 +322,7 @@ class Canvas:
 
         self.coords["pop up"] = (left, top, (w, overlay_width, overlay_height))
 
-    def translate_coords(self, dx: int, dy: int) -> dict[str, tuple[int, int, tuple[Widget, int, int]]]:
+    def translate_coords(self, dx: int, dy: int) -> dict[str, tuple[int, int, tuple[Widget, int, int] | None]]:
         """
         Return coords shifted by (dx, dy).
         """
@@ -455,10 +456,10 @@ class TextCanvas(Canvas):
         self,
         trim_left: int = 0,
         trim_top: int = 0,
-        cols: int | None = 0,
-        rows: int | None = 0,
-        attr=None,
-    ) -> Iterator[tuple[object, Literal["0", "U"] | None, bytes]]:
+        cols: int = 0,
+        rows: int = 0,
+        attr: Mapping[object, AttrSpec | str | None] | None = None,
+    ) -> Iterator[list[tuple[AttrSpec | str | None, Literal["0", "U"] | None, bytes]]]:
         """
         Return the canvas content as a list of rows where each row
         is a list of (attr, cs, text) tuples.
@@ -529,10 +530,10 @@ class BlankCanvas(Canvas):
         self,
         trim_left: int = 0,
         trim_top: int = 0,
-        cols: int | None = 0,
-        rows: int | None = 0,
-        attr=None,
-    ) -> Iterator[list[tuple[object, Literal["0", "U"] | None, bytes]]]:
+        cols: int = 0,
+        rows: int = 0,
+        attr: Mapping[object, AttrSpec | str | None] | None = None,
+    ) -> Iterator[list[tuple[AttrSpec | str | None, Literal["0", "U"] | None, bytes]]]:
         """
         return (cols, rows) of spaces with default attributes.
         """
@@ -583,8 +584,8 @@ class SolidCanvas(Canvas):
         trim_top: int = 0,
         cols: int | None = None,
         rows: int | None = None,
-        attr=None,
-    ) -> Iterator[list[tuple[object, Literal["0", "U"] | None, bytes]]]:
+        attr: Mapping[object, AttrSpec | str | None] | None = None,
+    ) -> Iterator[list[tuple[AttrSpec | str | None, Literal["0", "U"] | None, bytes]]]:
         if cols is None:
             cols = self.size[0]
         if rows is None:
@@ -611,7 +612,7 @@ class CompositeCanvas(Canvas):
     class for storing a combination of canvases
     """
 
-    def __init__(self, canv: Canvas = None) -> None:
+    def __init__(self, canv: Canvas | None = None) -> None:
         """
         canv -- a Canvas object to wrap this CompositeCanvas around.
 
@@ -682,13 +683,14 @@ class CompositeCanvas(Canvas):
         self,
         trim_left: int = 0,
         trim_top: int = 0,
-        cols: int | None = None,
-        rows: int | None = None,
-        attr=None,
-    ) -> Iterator[list[tuple[object, Literal["0", "U"] | None, bytes]]]:
+        cols: int = 0,
+        rows: int = 0,
+        attr: Mapping[object, AttrSpec | str | None] | None = None,
+    ) -> Iterator[list[tuple[AttrSpec | str | None, Literal["0", "U"] | None, bytes]]]:
         """
-        Return the canvas content as a list of rows where each row
-        is a list of (attr, cs, text) tuples.
+        Return the canvas content as a list of rows where each row is a list of (attr, cs, text) tuples.
+
+        All parameters are ignored.
         """
         shard_tail = []
         for num_rows, cviews in self.shards:
@@ -1217,7 +1219,7 @@ def CanvasCombine(canvas_info: Iterable[tuple[Canvas, typing.Any, bool]]) -> Com
     return combined_canvas
 
 
-def CanvasOverlay(top_c: Canvas, bottom_c: Canvas, left: int, top: int) -> CompositeCanvas:
+def CanvasOverlay(top_c: CompositeCanvas, bottom_c: Canvas, left: int, top: int) -> CompositeCanvas:
     """
     Overlay canvas top_c onto bottom_c at position (left, top).
     """

{urwid-4.0.0 → urwid-4.0.2}/urwid/display/__init__.py

@@ -97,6 +97,6 @@ def lazy_import(name: str, package: str | None = None) -> types.ModuleType:
     return module
 
 
-html_fragment = lazy_import(".html_fragment", __package__)
-lcd = lazy_import(".lcd", __package__)
-web = lazy_import(".web", __package__)
+html_fragment = lazy_import(".html_fragment", "urwid.display")
+lcd = lazy_import(".lcd", "urwid.display")
+web = lazy_import(".web", "urwid.display")

{urwid-4.0.0 → urwid-4.0.2}/urwid/display/_posix_raw_display.py

@@ -43,18 +43,19 @@ from . import _raw_display_base, escape
 from .common import INPUT_DESCRIPTORS_CHANGED
 
 if typing.TYPE_CHECKING:
-    import socket
     from collections.abc import Callable
     from types import FrameType
 
     from urwid.event_loop import EventLoop
 
+    SignalHandler = Callable[[int, FrameType | None], typing.Any] | int | None  # pylint: disable=unsupported-binary-operation
+
 
 class Screen(_raw_display_base.Screen):
     def __init__(
         self,
-        input: typing.TextIO = sys.stdin,  # noqa: A002  # pylint: disable=redefined-builtin
-        output: typing.TextIO = sys.stdout,
+        input: _raw_display_base.SupportsFileno = sys.stdin,  # noqa: A002  # pylint: disable=redefined-builtin
+        output: _raw_display_base.TextWriter = sys.stdout,
         bracketed_paste_mode=False,
         focus_reporting=False,
     ) -> None:
@@ -75,9 +76,9 @@ class Screen(_raw_display_base.Screen):
         self.focus_reporting = focus_reporting
 
         # These store the previous signal handlers after setting ours
-        self._prev_sigcont_handler = None
-        self._prev_sigtstp_handler = None
-        self._prev_sigwinch_handler = None
+        self._prev_sigcont_handler: SignalHandler = None
+        self._prev_sigtstp_handler: SignalHandler = None
+        self._prev_sigwinch_handler: SignalHandler = None
 
     def __repr__(self) -> str:
         return (
@@ -161,6 +162,8 @@ class Screen(_raw_display_base.Screen):
             close_fds=True,
             encoding="ascii",
         )
+        if m.stdout is None:
+            raise RuntimeError("gpm mouse tracking stdout was not created")
         fcntl.fcntl(m.stdout.fileno(), fcntl.F_SETFL, os.O_NONBLOCK)
         self.gpm_mev = m
 
@@ -205,7 +208,7 @@ class Screen(_raw_display_base.Screen):
         # restore mouse tracking to previous state
         self._mouse_tracking(self._mouse_tracking_enabled)
 
-        return super()._start()
+        super()._start()
 
     def _stop(self) -> None:
         """
@@ -234,7 +237,7 @@ class Screen(_raw_display_base.Screen):
 
         super()._stop()
 
-    def get_input_descriptors(self) -> list[socket.socket | typing.IO | int]:
+    def get_input_descriptors(self) -> list[_raw_display_base.SupportsFileno | int]:
         """
         Return a list of integer file descriptors that should be
         polled in external event loops to check for user input.
@@ -292,9 +295,11 @@ class Screen(_raw_display_base.Screen):
         return super()._get_input_codes() + self._get_gpm_codes()
 
     def _get_gpm_codes(self) -> list[int]:
-        codes = []
+        codes: list[int] = []
         try:
             while self.gpm_mev is not None and self.gpm_event_pending:
+                if self.gpm_mev.stdout is None:
+                    return codes
                 codes.extend(self._encode_gpm_event())
         except OSError as e:
             if e.args[0] != 11:
@@ -303,7 +308,8 @@ class Screen(_raw_display_base.Screen):
 
     def _read_raw_input(self, timeout: int) -> bytearray:
         ready = self._wait_for_input_ready(timeout)
-        if self.gpm_mev is not None and self.gpm_mev.stdout.fileno() in ready:
+        gpm_stdout = self.gpm_mev.stdout if self.gpm_mev is not None else None
+        if gpm_stdout is not None and gpm_stdout.fileno() in ready:
             self.gpm_event_pending = True
         fd = self._input_fileno()
         chars = bytearray()
@@ -325,6 +331,9 @@ class Screen(_raw_display_base.Screen):
 
     def _encode_gpm_event(self) -> list[int]:
         self.gpm_event_pending = False
+        if self.gpm_mev is None or self.gpm_mev.stdout is None:
+            return []
+
         s = self.gpm_mev.stdout.readline()
         result = s.split(", ")
         if len(result) != 6:
@@ -405,7 +414,7 @@ class Screen(_raw_display_base.Screen):
         """Return the terminal dimensions (num columns, num rows)."""
         y, x = super().get_cols_rows()
         with contextlib.suppress(OSError):  # Term size could not be determined
-            if hasattr(self._term_output_file, "fileno"):
+            if isinstance(self._term_output_file, _raw_display_base.SupportsFileno):
                 buf = fcntl.ioctl(self._term_output_file.fileno(), termios.TIOCGWINSZ, b" " * 8)
                 y, x, _, _ = struct.unpack("hhhh", buf)