Extend move_widget tests, add preserve_geometry kwarg

The 'preserve_geometry' kwarg to 'move_widget' is passed to 'copy_widget' and allows a user to force the function to automatically reconfigure the widget in the new parent using the old geometry manager information (as it does for the children, by setting the level to 1 at the start of the copy_widget recursive function)

Author: RedFantom

tests/test_utilities.py

@@ -11,6 +11,11 @@
 
 
 class TestUtilities(BaseWidgetTest):
+    def assertGeometryInfoEquals(self, info1, info2):
+        info1.pop("in", None)
+        info2.pop("in", None)
+        self.assertEquals(info1, info2)
+
     def setUp(self):
         BaseWidgetTest.setUp(self)
         self._dummy_flag = False
@@ -37,30 +42,36 @@ def test_move_widget(self):
 
     def test_move_widget_pack(self):
         label = ttk.Label(self.window)
-        label.pack()
+        label.pack(side=tk.LEFT)
+        info = label.pack_info()
         tl = tk.Toplevel(self.window)
-        label = move_widget(label, tl)
-        label.pack()
+        label = move_widget(label, tl, preserve_geometry=True)
         self.assertIsChild(label, tl)
         self.assertIn(label, tl.pack_slaves())
+        self.assertNotIn(label, self.window.pack_slaves())
+        self.assertGeometryInfoEquals(info, label.pack_info())
 
     def test_move_widget_grid(self):
         label = ttk.Label(self.window)
-        label.grid()
+        label.grid(row=1, column=1)
+        info = label.grid_info()
         tl = tk.Toplevel(self.window)
-        label = move_widget(label, tl)
-        label.grid()
+        label = move_widget(label, tl, preserve_geometry=True)
         self.assertIsChild(label, tl)
-        self.assertIn(label, tl.grid_slaves())
+        self.assertIn(label, tl.grid_slaves(row=1, column=1))
+        self.assertNotIn(label, self.window.grid_slaves(row=1, column=1))
+        self.assertGeometryInfoEquals(info, label.grid_info())
 
     def test_move_widget_place(self):
         label = ttk.Label(self.window)
-        label.place()
+        label.place(x=0, y=10)
+        info = label.place_info()
         tl = tk.Toplevel(self.window)
-        label = move_widget(label, tl)
-        label.place()
+        label = move_widget(label, tl, preserve_geometry=True)
         self.assertIsChild(label, tl)
         self.assertIn(label, tl.place_slaves())
+        self.assertNotIn(label, self.window.place_slaves())
+        self.assertGeometryInfoEquals(info, label.place_info())
 
     def test_move_widget_with_binding(self):
         label = ttk.Label(self.window)
@@ -123,6 +134,60 @@ def test_move_widget_with_binding_on_parent(self):
         self.window.event_generate("<Enter>")
         self.assertHasBeenInvoked()
 
+    def test_move_widget_with_children_pack(self):
+        frame = ttk.Frame(self.window)
+        label = ttk.Label(frame)
+        parent = tk.Toplevel()
+        label.pack(side=tk.BOTTOM)
+        info = label.pack_info()
+        frame.pack(expand=True)
+
+        frame = move_widget(frame, parent)
+        self.assertTrue(len(frame.pack_slaves()) == 1)
+        label2 = frame.nametowidget(frame.pack_slaves()[0])
+        self.assertTrue(label is not label2)
+
+        self.assertGeometryInfoEquals(info, label2.pack_info())
+        self.assertRaises(tk.TclError, label.pack_info)
+        self.assertRaises(tk.TclError, frame.pack_info)  # Frame is not packed
+        self.assertIn(label2, frame.pack_slaves())
+
+    def test_move_widget_with_children_grid(self):
+        frame = ttk.Frame(self.window)
+        label = ttk.Label(frame)
+        parent = tk.Toplevel()
+        label.grid(row=1, column=1)
+        info = label.grid_info()
+        frame.grid(row=1, column=1)
+
+        frame = move_widget(frame, parent)
+        self.assertTrue(len(frame.grid_slaves()) == 1)
+        label2 = frame.nametowidget(frame.grid_slaves()[0])
+        self.assertTrue(label is not label2)
+
+        self.assertGeometryInfoEquals(info, label2.grid_info())
+        self.assertRaises(tk.TclError, label.grid_info)
+        self.assertTrue(len(frame.grid_info()) == 0)  # Frame is not in grid
+        self.assertIn(label2, frame.grid_slaves())
+
+    def test_move_widget_with_children_place(self):
+        frame = ttk.Frame(self.window)
+        label = ttk.Label(frame)
+        parent = tk.Toplevel()
+        label.place(x=53, y=13)
+        info = label.place_info()
+        frame.place(x=100, y=10)
+
+        frame = move_widget(frame, parent)
+        self.assertTrue(len(frame.place_slaves()) == 1)
+        label2 = frame.nametowidget(frame.place_slaves()[0])
+        self.assertTrue(label is not label2)
+
+        self.assertGeometryInfoEquals(info, label2.place_info())
+        self.assertRaises(tk.TclError, label.place_info)
+        self.assertTrue(len(frame.place_info()) == 0)
+        self.assertIn(label2, frame.place_slaves())
+
     def test_parse_geometry(self):
         g = parse_geometry('1x1+1+1')
         self.assertEqual(g, (1, 1, 1, 1))

ttkwidgets/utilities.py

@@ -51,7 +51,6 @@ def copy_widget(widget, new_parent, level=0):
         widget._tclCommands = None  # Preserve bound functions
         script = widget.bind(b)
         rv.bind(b, script)
-
     if level > 0:
         if widget.grid_info():  # if geometry manager is grid
             temp = widget.grid_info()
@@ -66,6 +65,7 @@ def copy_widget(widget, new_parent, level=0):
             del temp['in']
             rv.pack(**temp)
     level += 1
+
     if widget.pack_slaves():  # subwidgets are using the pack() geometry manager
         for child in widget.pack_slaves():
             copy_widget(child, rv, level)
@@ -75,16 +75,21 @@ def copy_widget(widget, new_parent, level=0):
     return rv
 
 
-def move_widget(widget, new_parent):
+def move_widget(widget, new_parent, preserve_geometry=False):
     """
     Moves widget to new_parent
 
     :param widget: widget to move
+    :type widget: tk.Widget
     :param new_parent: new parent for the widget
+    :type new_parent: tk.Widget
+    :param preserve_geometry: Whether to preserve the geometry of the
+        widget in the old parent into the new parent
+    :type preserve_geometry: bool
 
     :return: moved widget reference
     """
-    rv = copy_widget(widget, new_parent)
+    rv = copy_widget(widget, new_parent, level=preserve_geometry)
     widget.destroy()
     return rv