Merge branch 'master' into feature/optgroup

Author: nagytech

setup.cfg

@@ -34,7 +34,7 @@ packages = wtforms_sqlalchemy
 include_package_data = true
 python_requires = >= 3.8
 install_requires =
-  WTForms>=1.0.5,<3.1
+  WTForms>=3.1
   SQLAlchemy>=0.7.10,<2
 
 [flake8]

tests/test_main.py

@@ -34,7 +34,8 @@
 class LazySelect:
     def __call__(self, field, **kwargs):
         return list(
-            (val, str(label), selected) for val, label, selected in field.iter_choices()
+            (val, str(label), selected, render_kw)
+            for val, label, selected, render_kw in field.iter_choices()
         )
 
 
@@ -111,7 +112,9 @@ class F(Form):
         form.a.query = sess.query(self.Test)
         self.assertTrue(form.a.data is not None)
         self.assertEqual(form.a.data.id, 1)
-        self.assertEqual(form.a(), [("1", "apple", True), ("2", "banana", False)])
+        self.assertEqual(
+            form.a(), [("1", "apple", True, {}), ("2", "banana", False, {})]
+        )
         self.assertTrue(form.validate())
 
         form = F(a=sess.query(self.Test).filter_by(name="banana").first())
@@ -144,28 +147,32 @@ class F(Form):
 
         form = F()
         self.assertEqual(form.a.data, None)
-        self.assertEqual(form.a(), [("1", "apple", False), ("2", "banana", False)])
+        self.assertEqual(
+            form.a(), [("1", "apple", False, {}), ("2", "banana", False, {})]
+        )
         self.assertEqual(form.b.data, None)
         self.assertEqual(
             form.b(),
             [
-                ("__None", "", True),
-                ("hello1", "apple", False),
-                ("hello2", "banana", False),
+                ("__None", "", True, {}),
+                ("hello1", "apple", False, {}),
+                ("hello2", "banana", False, {}),
             ],
         )
         self.assertFalse(form.validate())
 
         form = F(DummyPostData(a=["1"], b=["hello2"]))
         self.assertEqual(form.a.data.id, 1)
-        self.assertEqual(form.a(), [("1", "apple", True), ("2", "banana", False)])
+        self.assertEqual(
+            form.a(), [("1", "apple", True, {}), ("2", "banana", False, {})]
+        )
         self.assertEqual(form.b.data.baz, "banana")
         self.assertEqual(
             form.b(),
             [
-                ("__None", "", False),
-                ("hello1", "apple", False),
-                ("hello2", "banana", True),
+                ("__None", "", False, {}),
+                ("hello1", "apple", False, {}),
+                ("hello2", "banana", True, {}),
             ],
         )
         self.assertTrue(form.validate())
@@ -174,11 +181,17 @@ class F(Form):
         sess.add(self.Test(id=3, name="meh"))
         sess.flush()
         sess.commit()
-        self.assertEqual(form.a(), [("1", "apple", True), ("2", "banana", False)])
+        self.assertEqual(
+            form.a(), [("1", "apple", True, {}), ("2", "banana", False, {})]
+        )
         form.a._object_list = None
         self.assertEqual(
             form.a(),
-            [("1", "apple", True), ("2", "banana", False), ("3", "meh", False)],
+            [
+                ("1", "apple", True, {}),
+                ("2", "banana", False, {}),
+                ("3", "meh", False, {}),
+            ],
         )
 
         # Test bad data
@@ -217,14 +230,18 @@ def test_single_value_without_factory(self):
         form = self.F(DummyPostData(a=["1"]))
         form.a.query = self.sess.query(self.Test)
         self.assertEqual([1], [v.id for v in form.a.data])
-        self.assertEqual(form.a(), [("1", "apple", True), ("2", "banana", False)])
+        self.assertEqual(
+            form.a(), [("1", "apple", True, {}), ("2", "banana", False, {})]
+        )
         self.assertTrue(form.validate())
 
     def test_multiple_values_without_query_factory(self):
         form = self.F(DummyPostData(a=["1", "2"]))
         form.a.query = self.sess.query(self.Test)
         self.assertEqual([1, 2], [v.id for v in form.a.data])
-        self.assertEqual(form.a(), [("1", "apple", True), ("2", "banana", True)])
+        self.assertEqual(
+            form.a(), [("1", "apple", True, {}), ("2", "banana", True, {})]
+        )
         self.assertTrue(form.validate())
 
         form = self.F(DummyPostData(a=["1", "3"]))
@@ -245,7 +262,9 @@ class F(Form):
 
         form = F()
         self.assertEqual([v.id for v in form.a.data], [2])
-        self.assertEqual(form.a(), [("1", "apple", False), ("2", "banana", True)])
+        self.assertEqual(
+            form.a(), [("1", "apple", False, {}), ("2", "banana", True, {})]
+        )
         self.assertTrue(form.validate())
 
 

wtforms_sqlalchemy/fields.py

@@ -49,6 +49,7 @@ class QuerySelectField(SelectFieldBase):
     model instance and expected to return the label text. Otherwise, the model
     object's `__str__` will be used.
 
+
     Specify `get_group` to allow `option` elements to be grouped into `optgroup`
     sections.  If a string, this is the name of an attribute on the model
     containing the group name.  If a one-argument callable, this callable will
@@ -57,6 +58,12 @@ class QuerySelectField(SelectFieldBase):
     will be used as both the grouping key and the display label in the `select`
     options.
 
+    Specify `get_render_kw` to apply HTML attributes to each option. If a
+    string, this is the name of an attribute on the model containing a
+    dictionary.  If a one-argument callable, this callable will be passed the
+    model instance and expected to return a dictionary.  Otherwise, an empty
+    dictionary will be used.
+
     If `allow_blank` is set to `True`, then a blank choice will be added to the
     top of the list. Selecting this choice will result in the `data` property
     being `None`. The label for this blank choice can be set by specifying the
@@ -73,6 +80,7 @@ def __init__(
         get_pk=None,
         get_label=None,
         get_group=None,
+        get_render_kw=None,
         allow_blank=False,
         blank_text="",
         **kwargs
@@ -105,6 +113,13 @@ def __init__(
             else:
                 self.get_group = get_group
 
+        if get_render_kw is None:
+            self.get_render_kw = lambda _: {}
+        elif isinstance(get_render_kw, str):
+            self.get_render_kw = operator.attrgetter(get_render_kw)
+        else:
+            self.get_render_kw = get_render_kw
+
         self.allow_blank = allow_blank
         self.blank_text = blank_text
         self.query = None
@@ -133,10 +148,10 @@ def _get_object_list(self):
 
     def iter_choices(self):
         if self.allow_blank:
-            yield ("__None", self.blank_text, self.data is None)
+            yield ("__None", self.blank_text, self.data is None, {})
 
         for pk, obj in self._get_object_list():
-            yield (pk, self.get_label(obj), obj == self.data)
+            yield (pk, self.get_label(obj), obj == self.data, self.get_render_kw(obj))
 
     def has_groups(self):
         return self._has_groups
@@ -225,7 +240,7 @@ def _set_data(self, data):
 
     def iter_choices(self):
         for pk, obj in self._get_object_list():
-            yield (pk, self.get_label(obj), obj in self.data)
+            yield (pk, self.get_label(obj), obj in self.data, self.get_render_kw(obj))
 
     def process_formdata(self, valuelist):
         self._formdata = set(valuelist)