urwid / urwid / 38547055277

90%

Build Type

push

github

Committed by web-flow

Commit Message

Unify deprecation warnings and removal versions (#1421)

Every deprecation warns through urwid._deprecation.warn(): one message format,
the removal release when it is decided, and the warning attributed to the first
frame outside urwid, so it points at the application line that used the API.

- Callables deprecated as a whole carry @deprecated for static type checkers.
- Removed: the escape compatibility constants and plain-tuple CSI_COMMANDS
  entries in vterm.
- Documented as supported: signals user_arg, the ('given', n, widget) container
  tuples, and the urwid.FLOW-style constants.
- Widgets satisfy the Widget protocols under Pyright: the metaclasses set render
  and rows with setattr(); Pile/Columns.options() have per-kind overloads.
- Pile.options() returns the WHSettings member for 'given' and 'weight',
  as Columns.options() already did.
- Docs and examples stop using deprecated APIs; tests assert the warnings.

Removal releases: APIs still used by critical downstream projects (pudb,
mitmproxy, khal, zulip-terminal and others) have their removal postponed to
7.0, so those projects get a release cycle to migrate; deprecations that named
no release get one, and two silent legacy paths start warning.

| what | from | to |
| --- | --- | --- |
| AttrWrap | 6.0 | 7.0 |
| Pile.get_item_size | 6.0 | 7.0 |
| urwid.display_common, raw_display, curses_display, escape module paths | 6.0 | 7.0 |
| ListBox body that is not a ListWalker | not set | 7.0 |
| Non-widget objects in WidgetWrap, WidgetDecoration, Frame, Overlay | not set | 7.0 |
| Columns, Pile, ListBox children without mouse_event | not set | 7.0 |
| NumEdit/FloatEdit camelCase arguments | not set | 7.0 |
| str_util names imported through urwid.util | not set | 6.0 |
| Overriding or assigning BarGraph.get_data | no warning | 7.0 |
| Raw display Screen subclass defining get_input_nonblocking() | no warning | 7.0 |

| what | from | to |
| --- | --- | --- |
| typing_extensions (requirements.txt) | a... (continued)

Coverage Stats

4828 of 5582 branches covered (86.49%)

Branch coverage included in aggregate %.

54 of 69 new or added lines in 19 files covered. (78.26%)

7 existing lines in 3 files now uncovered.

12158 of 13401 relevant lines covered (90.72%)

14.29 hits per line