urwid 2.6.15__py3-none-any.whl → 3.0.5__py3-none-any.whl

urwid/widget/edit.py

@@ -99,11 +99,11 @@ class Edit(Text):
 
         >>> Edit()
         <Edit selectable flow widget '' edit_pos=0>
-        >>> Edit(u"Y/n? ", u"yes")
+        >>> Edit("Y/n? ", "yes")
         <Edit selectable flow widget 'yes' caption='Y/n? ' edit_pos=3>
-        >>> Edit(u"Name ", u"Smith", edit_pos=1)
+        >>> Edit("Name ", "Smith", edit_pos=1)
         <Edit selectable flow widget 'Smith' caption='Name ' edit_pos=1>
-        >>> Edit(u"", u"3.14", align='right')
+        >>> Edit("", "3.14", align="right")
         <Edit selectable flow widget '3.14' align='right' edit_pos=4>
         """
 
@@ -140,11 +140,11 @@ class Edit(Text):
 
         Text returned includes the caption and edit_text, possibly masked.
 
-        >>> Edit(u"What? ","oh, nothing.").get_text()
+        >>> Edit("What? ", "oh, nothing.").get_text()
         ('What? oh, nothing.', [])
-        >>> Edit(('bright',u"user@host:~$ "),"ls").get_text()
+        >>> Edit(("bright", "user@host:~$ "), "ls").get_text()
         ('user@host:~$ ls', [('bright', 13)])
-        >>> Edit(u"password:", u"seekrit", mask=u"*").get_text()
+        >>> Edit("password:", "seekrit", mask="*").get_text()
         ('password:*******', [])
         """
 
@@ -184,21 +184,21 @@ class Edit(Text):
         >>> size = (10,)
         >>> Edit().get_pref_col(size)
         0
-        >>> e = Edit(u"", u"word")
+        >>> e = Edit("", "word")
         >>> e.get_pref_col(size)
         4
-        >>> e.keypress(size, 'left')
+        >>> e.keypress(size, "left")
         >>> e.get_pref_col(size)
         3
-        >>> e.keypress(size, 'end')
+        >>> e.keypress(size, "end")
         >>> e.get_pref_col(size)
         <Align.RIGHT: 'right'>
-        >>> e = Edit(u"", u"2\\nwords")
-        >>> e.keypress(size, 'left')
-        >>> e.keypress(size, 'up')
+        >>> e = Edit("", "2\\nwords")
+        >>> e.keypress(size, "left")
+        >>> e.keypress(size, "up")
         >>> e.get_pref_col(size)
         4
-        >>> e.keypress(size, 'left')
+        >>> e.keypress(size, "left")
         >>> e.get_pref_col(size)
         0
         """
@@ -220,7 +220,7 @@ class Edit(Text):
         >>> e.set_caption("cap1")
         >>> print(e.caption)
         cap1
-        >>> e.set_caption(('bold', "cap2"))
+        >>> e.set_caption(("bold", "cap2"))
         >>> print(e.caption)
         cap2
         >>> e.attrib
@@ -247,7 +247,7 @@ class Edit(Text):
         :param pos: cursor position
         :type pos: int
 
-        >>> e = Edit(u"", u"word")
+        >>> e = Edit("", "word")
         >>> e.edit_pos
         4
         >>> e.set_edit_pos(2)
@@ -294,12 +294,12 @@ class Edit(Text):
         :type text: bytes or unicode
 
         >>> e = Edit()
-        >>> e.set_edit_text(u"yes")
+        >>> e.set_edit_text("yes")
         >>> print(e.edit_text)
         yes
         >>> e
         <Edit selectable flow widget 'yes' edit_pos=0>
-        >>> e.edit_text = u"no"  # Urwid 0.9.9 or later
+        >>> e.edit_text = "no"  # Urwid 0.9.9 or later
         >>> print(e.edit_text)
         no
         """
@@ -317,7 +317,7 @@ class Edit(Text):
         """
         Return the edit text for this widget.
 
-        >>> e = Edit(u"What? ", u"oh, nothing.")
+        >>> e = Edit("What? ", "oh, nothing.")
         >>> print(e.get_edit_text())
         oh, nothing.
         >>> print(e.edit_text)
@@ -343,12 +343,12 @@ class Edit(Text):
                      must match the text in the caption
         :type text: bytes or unicode
 
-        >>> e = Edit(u"", u"42")
-        >>> e.insert_text(u".5")
+        >>> e = Edit("", "42")
+        >>> e.insert_text(".5")
         >>> e
         <Edit selectable flow widget '42.5' edit_pos=4>
         >>> e.set_edit_pos(2)
-        >>> e.insert_text(u"a")
+        >>> e.insert_text("a")
         >>> print(e.edit_text)
         42a.5
         """
@@ -381,7 +381,7 @@ class Edit(Text):
         # if there's highlighted text, it'll get replaced by the new text
         text = self._normalize_to_caption(text)
         if self.highlight:
-            start, stop = self.highlight  # pylint: disable=unpacking-non-sequence  # already checked
+            start, stop = self.highlight
             btext, etext = self.edit_text[:start], self.edit_text[stop:]
             result_text = btext + etext
             result_pos = start
@@ -406,17 +406,17 @@ class Edit(Text):
         Handle editing keystrokes, return others.
 
         >>> e, size = Edit(), (20,)
-        >>> e.keypress(size, 'x')
-        >>> e.keypress(size, 'left')
-        >>> e.keypress(size, '1')
+        >>> e.keypress(size, "x")
+        >>> e.keypress(size, "left")
+        >>> e.keypress(size, "1")
         >>> print(e.edit_text)
         1x
-        >>> e.keypress(size, 'backspace')
-        >>> e.keypress(size, 'end')
-        >>> e.keypress(size, '2')
+        >>> e.keypress(size, "backspace")
+        >>> e.keypress(size, "end")
+        >>> e.keypress(size, "2")
         >>> print(e.edit_text)
         x2
-        >>> e.keypress(size, 'shift f1')
+        >>> e.keypress(size, "shift f1")
         'shift f1'
         """
         pos = self.edit_pos
@@ -517,7 +517,7 @@ class Edit(Text):
         Returns True if move succeeded, False otherwise.
 
         >>> size = (10,)
-        >>> e = Edit("","edit\\ntext")
+        >>> e = Edit("", "edit\\ntext")
         >>> e.move_cursor_to_coords(size, 5, 0)
         True
         >>> e.edit_pos
@@ -555,8 +555,8 @@ class Edit(Text):
         Move the cursor to the location clicked for button 1.
 
         >>> size = (20,)
-        >>> e = Edit("","words here")
-        >>> e.mouse_event(size, 'mouse press', 1, 2, 0, True)
+        >>> e = Edit("", "words here")
+        >>> e.mouse_event(size, "mouse press", 1, 2, 0, True)
         True
         >>> e.edit_pos
         2
@@ -572,7 +572,7 @@ class Edit(Text):
         """
         if not self.highlight:
             return False
-        start, stop = self.highlight  # pylint: disable=unpacking-non-sequence  # already checked
+        start, stop = self.highlight
         btext, etext = self.edit_text[:start], self.edit_text[stop:]
         self.set_edit_text(btext + etext)
         self.edit_pos = start
@@ -588,14 +588,14 @@ class Edit(Text):
         Render edit widget and return canvas.  Include cursor when in
         focus.
 
-        >>> edit = Edit("? ","yes")
+        >>> edit = Edit("? ", "yes")
         >>> c = edit.render((10,), focus=True)
         >>> c.text
         [b'? yes     ']
         >>> c.cursor
         (5, 0)
         """
-        self._shift_view_to_cursor = bool(focus)  # noqa: FURB123,RUF100
+        self._shift_view_to_cursor = bool(focus)
 
         canv: TextCanvas | CompositeCanvas = super().render(size, focus)
         if focus:
@@ -639,7 +639,7 @@ class Edit(Text):
         """
         Return the (*x*, *y*) coordinates of cursor within widget.
 
-        >>> Edit("? ","yes").get_cursor_coords((10,))
+        >>> Edit("? ", "yes").get_cursor_coords((10,))
         (5, 0)
         """
         (maxcol,) = size
@@ -672,7 +672,7 @@ class IntEdit(Edit):
         caption -- caption markup
         default -- default edit value
 
-        >>> IntEdit(u"", 42)
+        >>> IntEdit("", 42)
         <IntEdit selectable flow widget '42' edit_pos=2>
         """
         if default is not None:
@@ -689,32 +689,32 @@ class IntEdit(Edit):
         """
         Handle editing keystrokes.  Remove leading zeros.
 
-        >>> e, size = IntEdit(u"", 5002), (10,)
-        >>> e.keypress(size, 'home')
-        >>> e.keypress(size, 'delete')
+        >>> e, size = IntEdit("", 5002), (10,)
+        >>> e.keypress(size, "home")
+        >>> e.keypress(size, "delete")
         >>> print(e.edit_text)
         002
-        >>> e.keypress(size, 'end')
+        >>> e.keypress(size, "end")
         >>> print(e.edit_text)
         2
         """
-        unhandled = super().keypress(size, key)
+        if unhandled := super().keypress(size, key):
+            return unhandled
 
-        if not unhandled:
-            # trim leading zeros
-            while self.edit_pos > 0 and self.edit_text[:1] == "0":
-                self.set_edit_pos(self.edit_pos - 1)
-                self.set_edit_text(self.edit_text[1:])
+        # trim leading zeros
+        while self.edit_pos > 0 and self.edit_text[:1] == "0":
+            self.set_edit_pos(self.edit_pos - 1)
+            self.set_edit_text(self.edit_text[1:])
 
-        return unhandled
+        return None
 
     def value(self) -> int:
         """
         Return the numeric value of self.edit_text.
 
         >>> e, size = IntEdit(), (10,)
-        >>> e.keypress(size, '5')
-        >>> e.keypress(size, '1')
+        >>> e.keypress(size, "5")
+        >>> e.keypress(size, "1")
         >>> e.value() == 51
         True
         """

urwid/widget/filler.py

@@ -162,8 +162,8 @@ class Filler(WidgetDecoration[WrappedWidget]):
     def body(self) -> WrappedWidget:
         """backwards compatibility, widget used to be stored as body"""
         warnings.warn(
-            "backwards compatibility, widget used to be stored as body",
-            PendingDeprecationWarning,
+            "backwards compatibility, widget used to be stored as body. API will be removed in version 5.0.",
+            DeprecationWarning,
             stacklevel=2,
         )
         return self.original_widget
@@ -171,8 +171,8 @@ class Filler(WidgetDecoration[WrappedWidget]):
     @body.setter
     def body(self, new_body: WrappedWidget) -> None:
         warnings.warn(
-            "backwards compatibility, widget used to be stored as body",
-            PendingDeprecationWarning,
+            "backwards compatibility, widget used to be stored as body. API will be removed in version 5.0.",
+            DeprecationWarning,
             stacklevel=2,
         )
         self.original_widget = new_body
@@ -180,7 +180,7 @@ class Filler(WidgetDecoration[WrappedWidget]):
     def get_body(self) -> WrappedWidget:
         """backwards compatibility, widget used to be stored as body"""
         warnings.warn(
-            "backwards compatibility, widget used to be stored as body",
+            "backwards compatibility, widget used to be stored as body. API will be removed in version 4.0.",
             DeprecationWarning,
             stacklevel=2,
         )
@@ -188,7 +188,7 @@ class Filler(WidgetDecoration[WrappedWidget]):
 
     def set_body(self, new_body: WrappedWidget) -> None:
         warnings.warn(
-            "backwards compatibility, widget used to be stored as body",
+            "backwards compatibility, widget used to be stored as body. API will be removed in version 4.0.",
             DeprecationWarning,
             stacklevel=2,
         )
@@ -361,21 +361,21 @@ def calculate_top_bottom_filler(
     bottom -- a fixed number of rows to fill on the bottom
 
     >>> ctbf = calculate_top_bottom_filler
-    >>> ctbf(15, 'top', 0, 'given', 10, None, 2, 0)
+    >>> ctbf(15, "top", 0, "given", 10, None, 2, 0)
     (2, 3)
-    >>> ctbf(15, 'relative', 0, 'given', 10, None, 2, 0)
+    >>> ctbf(15, "relative", 0, "given", 10, None, 2, 0)
     (2, 3)
-    >>> ctbf(15, 'relative', 100, 'given', 10, None, 2, 0)
+    >>> ctbf(15, "relative", 100, "given", 10, None, 2, 0)
     (5, 0)
-    >>> ctbf(15, 'middle', 0, 'given', 4, None, 2, 0)
+    >>> ctbf(15, "middle", 0, "given", 4, None, 2, 0)
     (6, 5)
-    >>> ctbf(15, 'middle', 0, 'given', 18, None, 2, 0)
+    >>> ctbf(15, "middle", 0, "given", 18, None, 2, 0)
     (0, 0)
-    >>> ctbf(20, 'top', 0, 'relative', 60, None, 0, 0)
+    >>> ctbf(20, "top", 0, "relative", 60, None, 0, 0)
     (0, 8)
-    >>> ctbf(20, 'relative', 30, 'relative', 60, None, 0, 0)
+    >>> ctbf(20, "relative", 30, "relative", 60, None, 0, 0)
     (2, 6)
-    >>> ctbf(20, 'relative', 30, 'relative', 60, 14, 0, 0)
+    >>> ctbf(20, "relative", 30, "relative", 60, 14, 0, 0)
     (2, 4)
     """
     if height_type == WHSettings.RELATIVE:

urwid/widget/frame.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import typing
 import warnings
+from collections.abc import MutableMapping
 
 from urwid.canvas import CanvasCombine, CompositeCanvas
 from urwid.split_repr import remove_defaults
@@ -13,7 +14,7 @@ from .filler import Filler
 from .widget import Widget, WidgetError
 
 if typing.TYPE_CHECKING:
-    from collections.abc import Iterator, MutableMapping
+    from collections.abc import Iterator
 
     from typing_extensions import Literal
 
@@ -121,8 +122,9 @@ class Frame(Widget, WidgetContainerMixin, typing.Generic[BodyWidget, HeaderWidge
     def get_header(self) -> HeaderWidget:
         warnings.warn(
             f"method `{self.__class__.__name__}.get_header` is deprecated, "
-            f"standard property `{self.__class__.__name__}.header` should be used instead",
-            PendingDeprecationWarning,
+            f"standard property `{self.__class__.__name__}.header` should be used instead."
+            "API will be removed in version 5.0.",
+            DeprecationWarning,
             stacklevel=2,
         )
         return self.header
@@ -130,8 +132,9 @@ class Frame(Widget, WidgetContainerMixin, typing.Generic[BodyWidget, HeaderWidge
     def set_header(self, header: HeaderWidget) -> None:
         warnings.warn(
             f"method `{self.__class__.__name__}.set_header` is deprecated, "
-            f"standard property `{self.__class__.__name__}.header` should be used instead",
-            PendingDeprecationWarning,
+            f"standard property `{self.__class__.__name__}.header` should be used instead."
+            "API will be removed in version 5.0.",
+            DeprecationWarning,
             stacklevel=2,
         )
         self.header = header
@@ -149,8 +152,9 @@ class Frame(Widget, WidgetContainerMixin, typing.Generic[BodyWidget, HeaderWidge
     def get_body(self) -> BodyWidget:
         warnings.warn(
             f"method `{self.__class__.__name__}.get_body` is deprecated, "
-            f"standard property {self.__class__.__name__}.body should be used instead",
-            PendingDeprecationWarning,
+            f"standard property {self.__class__.__name__}.body should be used instead."
+            "API will be removed in version 5.0.",
+            DeprecationWarning,
             stacklevel=2,
         )
         return self.body
@@ -158,8 +162,9 @@ class Frame(Widget, WidgetContainerMixin, typing.Generic[BodyWidget, HeaderWidge
     def set_body(self, body: BodyWidget) -> None:
         warnings.warn(
             f"method `{self.__class__.__name__}.set_body` is deprecated, "
-            f"standard property `{self.__class__.__name__}.body` should be used instead",
-            PendingDeprecationWarning,
+            f"standard property `{self.__class__.__name__}.body` should be used instead."
+            "API will be removed in version 5.0.",
+            DeprecationWarning,
             stacklevel=2,
         )
         self.body = body
@@ -179,8 +184,9 @@ class Frame(Widget, WidgetContainerMixin, typing.Generic[BodyWidget, HeaderWidge
     def get_footer(self) -> FooterWidget:
         warnings.warn(
             f"method `{self.__class__.__name__}.get_footer` is deprecated, "
-            f"standard property `{self.__class__.__name__}.footer` should be used instead",
-            PendingDeprecationWarning,
+            f"standard property `{self.__class__.__name__}.footer` should be used instead."
+            "API will be removed in version 5.0.",
+            DeprecationWarning,
             stacklevel=2,
         )
         return self.footer
@@ -188,8 +194,9 @@ class Frame(Widget, WidgetContainerMixin, typing.Generic[BodyWidget, HeaderWidge
     def set_footer(self, footer: FooterWidget) -> None:
         warnings.warn(
             f"method `{self.__class__.__name__}.set_footer` is deprecated, "
-            f"standard property `{self.__class__.__name__}.footer` should be used instead",
-            PendingDeprecationWarning,
+            f"standard property `{self.__class__.__name__}.footer` should be used instead."
+            "API will be removed in version 5.0.",
+            DeprecationWarning,
             stacklevel=2,
         )
         self.footer = footer
@@ -233,8 +240,9 @@ class Frame(Widget, WidgetContainerMixin, typing.Generic[BodyWidget, HeaderWidge
         """
         warnings.warn(
             "included for backwards compatibility."
-            "You should rather use the container property `.focus_position` to get this value.",
-            PendingDeprecationWarning,
+            "You should rather use the container property `.focus_position` to get this value."
+            "API will be removed in version 5.0.",
+            DeprecationWarning,
             stacklevel=2,
         )
         return self.focus_position
@@ -242,8 +250,9 @@ class Frame(Widget, WidgetContainerMixin, typing.Generic[BodyWidget, HeaderWidge
     def set_focus(self, part: Literal["header", "footer", "body"]) -> None:
         warnings.warn(
             "included for backwards compatibility."
-            "You should rather use the container property `.focus_position` to set this value.",
-            PendingDeprecationWarning,
+            "You should rather use the container property `.focus_position` to set this value."
+            "API will be removed in version 5.0.",
+            DeprecationWarning,
             stacklevel=2,
         )
         self.focus_position = part
@@ -255,15 +264,6 @@ class Frame(Widget, WidgetContainerMixin, typing.Generic[BodyWidget, HeaderWidge
         This is a read-only property."""
         return {"header": self._header, "footer": self._footer, "body": self._body}[self.focus_part]
 
-    def _get_focus(self) -> BodyWidget | HeaderWidget | FooterWidget:
-        warnings.warn(
-            f"method `{self.__class__.__name__}._get_focus` is deprecated, "
-            f"please use `{self.__class__.__name__}.focus` property",
-            DeprecationWarning,
-            stacklevel=3,
-        )
-        return {"header": self._header, "footer": self._footer, "body": self._body}[self.focus_part]
-
     @property
     def contents(
         self,
@@ -275,9 +275,9 @@ class Frame(Widget, WidgetContainerMixin, typing.Generic[BodyWidget, HeaderWidge
         a dict-like object similar to::
 
             {
-                'body': (body_widget, None),
-                'header': (header_widget, None),  # if frame has a header
-                'footer': (footer_widget, None) # if frame has a footer
+                "body": (body_widget, None),
+                "header": (header_widget, None),  # if frame has a header
+                "footer": (footer_widget, None),  # if frame has a footer
             }
 
         This object may be used to read or update the contents of the Frame.
@@ -294,9 +294,9 @@ class Frame(Widget, WidgetContainerMixin, typing.Generic[BodyWidget, HeaderWidge
 
         # noinspection PyMethodParameters
         class FrameContents(
-            typing.MutableMapping[
+            MutableMapping[
                 str,
-                typing.Tuple[typing.Union[BodyWidget, HeaderWidget, FooterWidget], None],
+                tuple[typing.Union[BodyWidget, HeaderWidget, FooterWidget], None],
             ]
         ):
             # pylint: disable=no-self-argument
@@ -388,15 +388,6 @@ class Frame(Widget, WidgetContainerMixin, typing.Generic[BodyWidget, HeaderWidge
         else:
             self.footer = None
 
-    def _contents(self):
-        warnings.warn(
-            f"method `{self.__class__.__name__}._contents` is deprecated, "
-            f"please use property `{self.__class__.__name__}.contents`",
-            DeprecationWarning,
-            stacklevel=3,
-        )
-        return self.contents
-
     def options(self) -> None:
         """
         There are currently no options for Frame contents.