Refactoring: move monitored_list module to the widgets package (#833

)

This is a critical element for the container widgets
All classes are exported via `urwid` namespace without changes

Co-authored-by: Aleksei Stepanov <alekseis@nvidia.com>

tests/test_doctests.py

@@ -34,11 +34,11 @@ def load_tests(loader: unittest.TestLoader, tests: unittest.BaseTestSuite, ignor
         urwid.widget.widget,
         urwid.widget.widget_decoration,
         urwid.widget.wimp,
+        urwid.widget.monitored_list,
         urwid.display.common,
         urwid.display.raw,
         urwid.event_loop.main_loop,
         urwid.numedit,
-        urwid.monitored_list,
         urwid.raw_display,
         urwid.font,
         "urwid.split_repr",  # override function with same name

urwid/__init__.py

@@ -94,7 +94,6 @@
     get_all_fonts,
 )
 from urwid.listbox import ListBox, ListBoxError, ListWalker, ListWalkerError, SimpleFocusListWalker, SimpleListWalker
-from urwid.monitored_list import MonitoredFocusList, MonitoredList
 from urwid.signals import (
     MetaSignals,
     Signals,
@@ -170,6 +169,8 @@
     GridFlowError,
     IntEdit,
     LineBox,
+    MonitoredFocusList,
+    MonitoredList,
     Overlay,
     OverlayError,
     Padding,
@@ -252,6 +253,7 @@
     "lcd_display": "urwid.display.lcd",
     "html_fragment": "urwid.display.html_fragment",
     "web_display": "urwid.display.web",
+    "monitored_list": "urwid.widget.monitored_list",
 }
 # Backward compatible lazy load without any warnings
 # Before DeprecationWarning need to start PendingDeprecationWarning process.

urwid/listbox.py

@@ -30,10 +30,11 @@
 from urwid import signals
 from urwid.canvas import CanvasCombine, SolidCanvas
 from urwid.command_map import Command
-from urwid.monitored_list import MonitoredFocusList, MonitoredList
 from urwid.signals import connect_signal, disconnect_signal
 from urwid.util import is_mouse_press
 from urwid.widget import (
+    MonitoredFocusList,
+    MonitoredList,
     Sizing,
     VAlign,
     WHSettings,

urwid/widget/__init__.py

@@ -29,6 +29,7 @@
 from .frame import Frame, FrameError
 from .grid_flow import GridFlow, GridFlowError
 from .line_box import LineBox
+from .monitored_list import MonitoredFocusList, MonitoredList
 from .overlay import Overlay, OverlayError, OverlayWarning
 from .padding import Padding, PaddingError, PaddingWarning, calculate_left_right_padding
 from .pile import Pile, PileError, PileWarning
@@ -58,6 +59,8 @@
 __all__ = (
     "ANY",
     "BOTTOM",
+    "MonitoredList",
+    "MonitoredFocusList",
     "BOX",
     "CENTER",
     "CLIP",

urwid/widget/columns.py

@@ -7,11 +7,11 @@
 import urwid
 from urwid.canvas import Canvas, CanvasJoin, CompositeCanvas, SolidCanvas
 from urwid.command_map import Command
-from urwid.monitored_list import MonitoredFocusList, MonitoredList
 from urwid.util import is_mouse_press
 
 from .constants import Align, Sizing, WHSettings
 from .container import WidgetContainerListContentsMixin, WidgetContainerMixin, _ContainerElementSizingFlag
+from .monitored_list import MonitoredFocusList, MonitoredList
 from .widget import Widget, WidgetError, WidgetWarning
 
 if typing.TYPE_CHECKING:

urwid/widget/grid_flow.py

@@ -3,12 +3,11 @@
 import typing
 import warnings
 
-from urwid.monitored_list import MonitoredFocusList, MonitoredList
-
 from .columns import Columns
 from .constants import Align, Sizing, WHSettings
 from .container import WidgetContainerListContentsMixin, WidgetContainerMixin
 from .divider import Divider
+from .monitored_list import MonitoredFocusList, MonitoredList
 from .padding import Padding
 from .pile import Pile
 from .widget import Widget, WidgetError, WidgetWrap

urwid/monitored_list.py → urwid/widget/monitored_list.py

@@ -31,6 +31,8 @@
     ArgSpec = ParamSpec("ArgSpec")
     Ret = typing.TypeVar("Ret")
 
+__all__ = ("MonitoredList", "MonitoredFocusList")
+
 _T = typing.TypeVar("_T")
 
 

urwid/widget/pile.py

@@ -6,11 +6,11 @@
 
 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
 
 from .constants import Sizing, WHSettings
 from .container import WidgetContainerListContentsMixin, WidgetContainerMixin, _ContainerElementSizingFlag
+from .monitored_list import MonitoredFocusList, MonitoredList
 from .widget import Widget, WidgetError, WidgetWarning
 
 if typing.TYPE_CHECKING: