Accept lists and tuples in listboxes, comboboxes, and spinboxes

UnsignedArduino · UnsignedArduino · commit c53c9fc1bb37 · 2021-05-12T17:19:26.000-04:00
diff --git a/Tests/test_Combobox.py b/Tests/test_Combobox.py
@@ -18,7 +18,7 @@ def test_bad_params(self):
         with self.assertRaises(TypeError):
             Combobox(1)
         with self.assertRaises(TypeError):
-            Combobox(self.root, values=[])
+            Combobox(self.root, values={})
         with self.assertRaises(TypeError):
             Combobox(self.root, width=5.5)
         with self.assertRaises(TypeError):
@@ -48,9 +48,10 @@ def test_values(self):
             self.assertEqual(c.values, ())
             c.values = ("Foo", )
             self.assertEqual(c.values, ("Foo", ))
+            c.values = ["Bar"]
+            self.assertEqual(c.values, ("Bar", ))
             with self.assertRaises(TypeError):
-                c.values = ["lol", "this", "doesn't", "work", "it", "must", "be",
-                            "a", "tuple"]
+                c.values = {}
         except tk.TclError:
             pass
 
diff --git a/Tests/test_Listbox.py b/Tests/test_Listbox.py
@@ -52,8 +52,10 @@ def test_values(self):
         self.assertEqual(l.values, [])
         l.values = ["Foo"]
         self.assertEqual(l.values, ["Foo"])
+        l.values = ("Bar", )
+        self.assertEqual(l.values, ["Bar"])
         with self.assertRaises(TypeError):
-            l.values = ()
+            l.values = {}
 
     def test_enabled(self):
         l = Listbox(self.root)
diff --git a/Tests/test_Spinbox.py b/Tests/test_Spinbox.py
@@ -18,7 +18,7 @@ def test_bad_params(self):
         with self.assertRaises(TypeError):
             Spinbox(parent=1)
         with self.assertRaises(TypeError):
-            Spinbox(self.root, values=["this", "doesn't", "work"])
+            Spinbox(self.root, values={"this", "doesn't", "work"})
         with self.assertRaises(TypeError):
             Spinbox(self.root, width=5.5)
         with self.assertRaises(TypeError):
@@ -46,8 +46,10 @@ def test_values(self):
         self.assertEqual(s.values, ())
         s.values = ("Foo", )
         self.assertEqual(s.values, ("Foo", ))
+        s.values = ["Foo"]
+        self.assertEqual(s.values, ("Foo",))
         with self.assertRaises(TypeError):
-            s.values = []
+            s.values = {}
 
     def test_enabled(self):
         s = Spinbox(self.root)
diff --git a/TkZero/Combobox.py b/TkZero/Combobox.py
@@ -13,7 +13,7 @@ class Combobox(ttk.Combobox):
     def __init__(
         self,
         parent: Union[tk.Widget, Union[tk.Tk, tk.Toplevel]],
-        values: tuple[str, ...] = (),
+        values: Union[list[str, ...], tuple[str, ...]] = (),
         width: int = None,
         show: str = None,
         validate: Callable = None,
@@ -23,8 +23,8 @@ def __init__(
         Initiate a ttk.Combobox.
 
         :param parent: The parent of the combobox.
-        :param values: The default values you can choose, should be a tuple of
-         str. Defaults to ()
+        :param values: The default values you can choose, should be a tuple or
+         list of str. Defaults to ()
         :param width: The width of the combobox. Defaults to None.
         :param show: The character to show instead of the actual text.
          Defaults to None.
@@ -41,9 +41,10 @@ def __init__(
                 f"Union[tk.Widget, Union[tk.Tk, tk.Toplevel]]! "
                 f"(type passed in: {repr(type(parent))})"
             )
-        if not isinstance(values, tuple):
+        if not isinstance(values, (tuple, list)):
             raise TypeError(
-                f"values is not a tuple! " f"(type passed in: {repr(type(values))})"
+                f"values is not a tuple or a list! "
+                f"(type passed in: {repr(type(values))})"
             )
         if not isinstance(width, int) and width is not None:
             raise TypeError(
@@ -102,7 +103,7 @@ def value(self, new_text: str) -> None:
         self.insert(0, new_text)
 
     @property
-    def values(self) -> tuple[str]:
+    def values(self) -> tuple[str, ...]:
         """
         Get the default options you can select.
 
@@ -111,19 +112,19 @@ def values(self) -> tuple[str]:
         return self["values"] if self["values"] else ()
 
     @values.setter
-    def values(self, new_values: tuple[str]) -> None:
+    def values(self, new_values: Union[tuple[str, ...], list[str, ...]]) -> None:
         """
         Set the default options text on this combobox.
 
-        :param new_values: The new options, as a tuple of str.
+        :param new_values: The new options, as a tuple or list of str.
         :return: None.
         """
-        if not isinstance(new_values, tuple):
+        if not isinstance(new_values, (tuple, list)):
             raise TypeError(
-                f"new_values is not a tuple! "
+                f"new_values is not a tuple or a list! "
                 f"(type passed in: {repr(type(new_values))})"
             )
-        self["values"] = new_values
+        self["values"] = tuple([str(thing) for thing in new_values])
 
     @property
     def enabled(self) -> bool:
diff --git a/TkZero/Listbox.py b/TkZero/Listbox.py
@@ -21,7 +21,7 @@ class Listbox(tk.Listbox):
     def __init__(
         self,
         parent: Union[tk.Widget, Union[tk.Tk, tk.Toplevel]],
-        values: list[str, ...] = None,
+        values: Union[list[str, ...], tuple[str, ...]] = None,
         select_mode: str = SelectModes.Single,
         height: int = None,
         width: int = None,
@@ -32,8 +32,8 @@ def __init__(
         Initiate a tk.Listbox.
 
         :param parent: The parent of the listbox.
-        :param values: The default values you can choose, should be a list of
-         str. Defaults to []
+        :param values: The default values you can choose, should be a list or
+         tuple of str. Defaults to []
         :param select_mode: The select mode to use. (allows you to select one
          or more items or not) Should be a str and defaults to
          SelectModes.Single
@@ -47,9 +47,10 @@ def __init__(
                 f"Union[tk.Widget, Union[tk.Tk, tk.Toplevel]]! "
                 f"(type passed in: {repr(type(parent))})"
             )
-        if not isinstance(values, list) and values is not None:
+        if not isinstance(values, (list, tuple)) and values is not None:
             raise TypeError(
-                f"values is not a list! " f"(type passed in: {repr(type(values))})"
+                f"values is not a list or a tuple! "
+                f"(type passed in: {repr(type(values))})"
             )
         if not isinstance(select_mode, str):
             raise TypeError(
@@ -118,16 +119,16 @@ def values(self) -> list[str]:
         return self._values
 
     @values.setter
-    def values(self, new_values: list[str]) -> None:
+    def values(self, new_values: Union[list[str, ...], tuple[str, ...]]) -> None:
         """
         Set the items on this combobox.
 
-        :param new_values: The new items, as a list of str.
+        :param new_values: The new items, as a list or tuple of str.
         :return: None.
         """
-        if not isinstance(new_values, list):
+        if not isinstance(new_values, (list, tuple)):
             raise TypeError(
-                f"new_values is not a list! "
+                f"new_values is not a list or a tuple! "
                 f"(type passed in: {repr(type(new_values))})"
             )
         self._values = [str(item) for item in new_values]
diff --git a/TkZero/Spinbox.py b/TkZero/Spinbox.py
@@ -13,7 +13,7 @@ class Spinbox(ttk.Spinbox):
     def __init__(
         self,
         parent: Union[tk.Widget, Union[tk.Tk, tk.Toplevel]],
-        values: tuple[str, ...] = (),
+        values: Union[tuple[str, ...], list[str, ...]] = (),
         width: int = None,
         show: str = None,
         validate: Callable = None,
@@ -23,8 +23,8 @@ def __init__(
         Initiate a ttk.Spinbox.
 
         :param parent: The parent of the combobox.
-        :param values: The values you can choose, should be a tuple of str.
-         Defaults to ()
+        :param values: The values you can choose, should be a tuple or list of
+         str. Defaults to ()
         :param width: The width of the combobox. Defaults to None.
         :param show: The character to show instead of the actual text.
          Defaults to None.
@@ -41,9 +41,10 @@ def __init__(
                 f"Union[tk.Widget, Union[tk.Tk, tk.Toplevel]]! "
                 f"(type passed in: {repr(type(parent))})"
             )
-        if not isinstance(values, tuple) and values is not None:
+        if not isinstance(values, (tuple, list)) and values is not None:
             raise TypeError(
-                f"values is not a tuple! " f"(type passed in: {repr(type(values))})"
+                f"values is not a tuple or list! "
+                f"(type passed in: {repr(type(values))})"
             )
         if not isinstance(width, int) and width is not None:
             raise TypeError(
@@ -72,7 +73,7 @@ def __init__(
         else:
             self.bind("<3>", lambda event: self._popup(event=event))
         if values is not None:
-            self["values"] = values
+            self["values"] = tuple([str(thing) for thing in values])
         self._make_context_menu()
 
     @property
@@ -100,28 +101,28 @@ def value(self, new_text: str) -> None:
         self.insert(0, new_text)
 
     @property
-    def values(self) -> tuple[str]:
+    def values(self) -> tuple[str, ...]:
         """
         Get the options you can select.
 
-        :return: A str of the text in this entry.
+        :return: A tuple of str of the options you can select.
         """
         return self["values"] if self["values"] else ()
 
     @values.setter
-    def values(self, new_values: tuple[str]) -> None:
+    def values(self, new_values: Union[tuple[str, ...], list[str, ...]]) -> None:
         """
         Set the options text on this spinbox.
 
-        :param new_values: The new options, as a tuple of str.
+        :param new_values: The new options, as a tuple or list of str.
         :return: None.
         """
-        if not isinstance(new_values, tuple):
+        if not isinstance(new_values, (tuple, list)):
             raise TypeError(
-                f"new_values is not a tuple! "
+                f"new_values is not a tuple or list! "
                 f"(type passed in: {repr(type(new_values))})"
             )
-        self["values"] = new_values
+        self["values"] = tuple([str(thing) for thing in new_values])
 
     @property
     def enabled(self) -> bool:
diff --git a/docs/Combobox.html b/docs/Combobox.html
diff --git a/docs/Listbox.html b/docs/Listbox.html
diff --git a/docs/Spinbox.html b/docs/Spinbox.html
