1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
|
import sqlalchemy as sa
from sqlalchemy.orm import declarative_base
from sqlalchemy.orm.session import close_all_sessions
from wtforms import Form
from wtforms_alchemy import (
GroupedQuerySelectField,
GroupedQuerySelectMultipleField,
ModelForm,
QuerySelectField,
QuerySelectMultipleField,
)
class DummyPostData(dict):
def getlist(self, key):
v = self[key]
if not isinstance(v, (list, tuple)):
v = [v]
return v
class LazySelect:
def __call__(self, field, **kwargs):
return list(
(val, str(label), selected)
for val, label, selected, _ in field.iter_choices()
)
class Base:
def __init__(self, **kwargs):
for k, v in kwargs.items():
setattr(self, k, v)
class TestBase:
def create_models(self):
class Test(self.base):
__tablename__ = "test"
id = sa.Column(sa.Integer, primary_key=True, nullable=False)
name = sa.Column(sa.String, nullable=False)
self.Test = Test
class PKTest(self.base):
__tablename__ = "pk_test"
foobar = sa.Column(sa.String, primary_key=True, nullable=False)
baz = sa.Column(sa.String, nullable=False)
def __str__(self):
return self.baz
self.PKTest = PKTest
def _fill(self, sess):
for i, n in [(1, "apple"), (2, "banana")]:
s = self.Test(id=i, name=n)
p = self.PKTest(foobar=f"hello{i}", baz=n)
sess.add(s)
sess.add(p)
sess.flush()
sess.commit()
class TestQuerySelectField(TestBase):
def setup_method(self):
self.engine = sa.create_engine("sqlite:///:memory:", echo=False)
self.base = declarative_base()
self.create_models()
self.base.metadata.create_all(self.engine)
Session = sa.orm.session.sessionmaker(bind=self.engine)
self.session = Session()
def teardown_method(self):
close_all_sessions()
self.base.metadata.drop_all(self.engine)
self.engine.dispose()
def test_without_factory(self):
self._fill(self.session)
class F(Form):
a = QuerySelectField(
get_label="name", widget=LazySelect(), get_pk=lambda x: x.id
)
form = F(DummyPostData(a=["1"]))
form.a.query = self.session.query(self.Test)
assert form.a.data is not None
assert form.a.data.id, 1
assert form.a(), [("1", "apple", True), ("2", "banana", False)]
assert form.validate()
form = F(a=self.session.query(self.Test).filter_by(name="banana").first())
form.a.query = self.session.query(self.Test).filter(self.Test.name != "banana")
assert not form.validate()
assert form.a.errors, ["Not a valid choice"]
# Test query with no results
form = F()
form.a.query = (
self.session.query(self.Test)
.filter(self.Test.id == 1, self.Test.id != 1)
.all()
)
assert form.a() == []
def test_with_query_factory(self):
self._fill(self.session)
class F(Form):
a = QuerySelectField(
get_label=(lambda model: model.name),
query_factory=lambda: self.session.query(self.Test),
widget=LazySelect(),
)
b = QuerySelectField(
allow_blank=True,
query_factory=lambda: self.session.query(self.PKTest),
widget=LazySelect(),
)
form = F()
assert form.a.data is None
assert form.a() == [("1", "apple", False), ("2", "banana", False)]
assert form.b.data is None
assert form.b() == [
("__None", "", True),
("hello1", "apple", False),
("hello2", "banana", False),
]
assert not form.validate()
# Test query with no results
form = F()
form.a.query = (
self.session.query(self.Test)
.filter(self.Test.id == 1, self.Test.id != 1)
.all()
)
assert form.a() == []
form = F(DummyPostData(a=["1"], b=["hello2"]))
assert form.a.data.id == 1
assert form.a() == [("1", "apple", True), ("2", "banana", False)]
assert form.b.data.baz == "banana"
assert form.b() == [
("__None", "", False),
("hello1", "apple", False),
("hello2", "banana", True),
]
assert form.validate()
# Make sure the query is cached
self.session.add(self.Test(id=3, name="meh"))
self.session.flush()
self.session.commit()
assert form.a() == [("1", "apple", True), ("2", "banana", False)]
form.a._object_list = None
assert form.a() == [
("1", "apple", True),
("2", "banana", False),
("3", "meh", False),
]
# Test bad data
form = F(DummyPostData(b=["__None"], a=["fail"]))
assert not form.validate()
assert form.a.errors == ["Not a valid choice"]
assert form.b.errors == []
assert form.b.data is None
class TestQuerySelectMultipleField(TestBase):
def setup_method(self):
self.engine = sa.create_engine("sqlite:///:memory:", echo=False)
self.base = declarative_base()
self.create_models()
self.base.metadata.create_all(self.engine)
Session = sa.orm.session.sessionmaker(bind=self.engine)
self.session = Session()
self._fill(self.session)
def teardown_method(self):
close_all_sessions()
self.base.metadata.drop_all(self.engine)
self.engine.dispose()
class F(Form):
a = QuerySelectMultipleField(get_label="name", widget=LazySelect())
def test_unpopulated_default(self):
form = self.F()
assert [] == form.a.data
def test_single_value_without_factory(self):
form = self.F(DummyPostData(a=["1"]))
form.a.query = self.session.query(self.Test)
assert [1] == [v.id for v in form.a.data]
assert form.a() == [("1", "apple", True), ("2", "banana", False)]
assert form.validate()
def test_multiple_values_without_query_factory(self):
form = self.F(DummyPostData(a=["1", "2"]))
form.a.query = self.session.query(self.Test)
assert [1, 2] == [v.id for v in form.a.data]
assert form.a() == [("1", "apple", True), ("2", "banana", True)]
assert form.validate()
form = self.F(DummyPostData(a=["1", "3"]))
form.a.query = self.session.query(self.Test)
assert [x.id for x in form.a.data], [1]
assert not form.validate()
def test_single_default_value(self):
first_test = self.session.get(self.Test, 2)
class F(Form):
a = QuerySelectMultipleField(
get_label="name",
default=[first_test],
widget=LazySelect(),
query_factory=lambda: self.session.query(self.Test),
)
form = F()
assert [v.id for v in form.a.data], [2]
assert form.a(), [("1", "apple", False), ("2", "banana", True)]
assert form.validate()
def test_empty_query(self):
# Test query with no results
form = self.F()
form.a.query = (
self.session.query(self.Test)
.filter(self.Test.id == 1, self.Test.id != 1)
.all()
)
assert form.a() == []
class DatabaseTestCase:
def setup_method(self, method):
self.engine = sa.create_engine("sqlite:///:memory:")
self.base = declarative_base()
self.create_models()
self.base.metadata.create_all(self.engine)
Session = sa.orm.session.sessionmaker(bind=self.engine)
self.session = Session()
def teardown_method(self, method):
close_all_sessions()
self.base.metadata.drop_all(self.engine)
self.engine.dispose()
def create_models(self):
class City(self.base):
__tablename__ = "city"
id = sa.Column(sa.Integer, primary_key=True)
name = sa.Column(sa.String)
country = sa.Column(sa.String)
state_id = sa.Column(sa.Integer, sa.ForeignKey("state.id"))
self.City = City
class State(self.base):
__tablename__ = "state"
id = sa.Column(sa.Integer, primary_key=True)
cities = sa.orm.relationship("City")
self.State = State
def create_cities(self):
self.session.add_all(
[
self.City(name="Helsinki", country="Finland"),
self.City(name="Vantaa", country="Finland"),
self.City(name="New York", country="USA"),
self.City(name="Washington", country="USA"),
self.City(name="Stockholm", country="Sweden"),
]
)
class TestGroupedQuerySelectField(DatabaseTestCase):
def create_form(self, **kwargs):
query = self.session.query(self.City).order_by("name", "country")
class MyForm(Form):
city = GroupedQuerySelectField(
label=kwargs.get("label", "City"),
query_factory=kwargs.get("query_factory", lambda: query),
get_label=kwargs.get("get_label", lambda c: c.name),
get_group=kwargs.get("get_group", lambda c: c.country),
allow_blank=kwargs.get("allow_blank", False),
blank_text=kwargs.get("blank_text", ""),
blank_value=kwargs.get("blank_value", "__None"),
)
return MyForm
def test_custom_none_value(self):
self.create_cities()
MyForm = self.create_form(
allow_blank=True, blank_text="Choose city...", blank_value=""
)
form = MyForm(DummyPostData({"city": ""}))
assert form.validate(), form.errors
assert '<option selected value="">Choose city...</option>' in (str(form.city))
def test_rendering(self):
MyForm = self.create_form()
self.create_cities()
assert str(MyForm().city).replace("\n", "") == (
'<select id="city" name="city">'
'<optgroup label="Finland">'
'<option value="1">Helsinki</option>'
'<option value="2">Vantaa</option>'
'</optgroup><optgroup label="Sweden">'
'<option value="5">Stockholm</option>'
"</optgroup>"
'<optgroup label="USA">'
'<option value="3">New York</option>'
'<option value="4">Washington</option>'
"</optgroup>"
"</select>"
)
class TestGroupedQuerySelectMultipleField(DatabaseTestCase):
def create_form(self, **kwargs):
query = self.session.query(self.City).order_by("name", "country")
class MyForm(ModelForm):
class Meta:
model = self.State
cities = GroupedQuerySelectMultipleField(
label=kwargs.get("label", "City"),
query_factory=kwargs.get("query_factory", lambda: query),
get_label=kwargs.get("get_label", lambda c: c.name),
get_group=kwargs.get("get_group", lambda c: c.country),
blank_text=kwargs.get("blank_text", ""),
)
return MyForm
def test_unpopulated_default(self):
MyForm = self.create_form()
self.create_cities()
assert MyForm().cities.data == []
def test_single_value_without_factory(self):
obj = self.State()
MyForm = self.create_form()
self.create_cities()
form = MyForm(DummyPostData(cities=["1"]), obj=obj)
assert [1] == [v.id for v in form.cities.data]
assert form.validate()
form.populate_obj(obj)
assert [city.id for city in obj.cities] == [1]
def test_multiple_values_without_query_factory(self):
obj = self.State()
MyForm = self.create_form()
self.create_cities()
form = MyForm(DummyPostData(cities=["1", "2"]), obj=obj)
form.cities.query = self.session.query(self.City)
assert [1, 2] == [v.id for v in form.cities.data]
assert form.validate()
form.populate_obj(obj)
assert [city.id for city in obj.cities] == [1, 2]
form = MyForm(DummyPostData(cities=["1", "666"]))
form.cities.query = self.session.query(self.City)
assert not form.validate()
assert [x.id for x in form.cities.data] == [1]
assert not form.validate()
form.populate_obj(obj)
assert [city.id for city in obj.cities] == [1]
form = MyForm(DummyPostData(cities=["666"]))
form.cities.query = self.session.query(self.City)
assert not form.validate()
assert [x.id for x in form.cities.data] == []
assert not form.validate()
form.populate_obj(obj)
assert [city.id for city in obj.cities] == []
def test_rendering(self):
MyForm = self.create_form()
self.create_cities()
assert str(MyForm().cities).replace("\n", "") == (
'<select id="cities" multiple name="cities">'
'<optgroup label="Finland">'
'<option value="1">Helsinki</option>'
'<option value="2">Vantaa</option>'
'</optgroup><optgroup label="Sweden">'
'<option value="5">Stockholm</option>'
"</optgroup>"
'<optgroup label="USA">'
'<option value="3">New York</option>'
'<option value="4">Washington</option>'
"</optgroup>"
"</select>"
)
|
