|
1 | 1 | from __future__ import annotations |
2 | 2 |
|
3 | | -from wtforms import SelectField |
| 3 | +from enum import Enum, auto |
4 | 4 |
|
| 5 | +from wtforms import Field, Form, SelectChoice, SelectField, StringField |
| 6 | +from wtforms.fields import enum_choices, enum_coerce |
| 7 | + |
| 8 | +# construct SelectChoice from old inputs |
| 9 | +SelectChoice.from_input("") |
| 10 | +SelectChoice.from_input(("", "")) |
| 11 | +SelectChoice.from_input(("", "", {})) |
| 12 | +# non-str values are no longer allowed/encouraged |
| 13 | +# technically they never were, it just never was enforced |
| 14 | +# coerce(value) is supposed to yield the object that gets stored in data |
| 15 | +# so values in choices are intended to be pre-serialized to str in the |
| 16 | +# format coerce expects |
| 17 | +SelectChoice.from_input((1, "1")) # type: ignore[arg-type] |
| 18 | +SelectChoice.from_input((True, "t", {})) # type: ignore[arg-type] |
| 19 | +SelectChoice.from_input((False, "f", {})) # type: ignore[arg-type] |
| 20 | + |
| 21 | +# provide choices as any iterable of SelectChoice |
| 22 | +SelectField(choices=[SelectChoice("")]) |
| 23 | + |
| 24 | +# new style of grouped choices |
| 25 | +SelectField(choices=[SelectChoice("A", optgroup="a"), SelectChoice("B", optgroup="b")]) |
| 26 | + |
| 27 | +# provide a callback without arguments that generates a sequence of SelectChoice |
| 28 | +SelectField(choices=lambda: [SelectChoice("")]) |
| 29 | + |
| 30 | + |
| 31 | +# or a callback that receives the form as its first and the field as its second argument |
| 32 | +def generate_choices(form: Form, field: SelectField) -> list[SelectChoice]: |
| 33 | + return [] |
| 34 | + |
| 35 | + |
| 36 | +def generate_choices_generous_field_type(form: Form, field: Field) -> list[SelectChoice]: |
| 37 | + return [] |
| 38 | + |
| 39 | + |
| 40 | +def generate_choices_wrong_field_type(form: Form, field: StringField) -> list[SelectChoice]: |
| 41 | + return [] |
| 42 | + |
| 43 | + |
| 44 | +SelectField(choices=lambda form, field: [SelectChoice("")]) |
| 45 | +SelectField(choices=generate_choices) |
| 46 | +SelectField(choices=generate_choices_generous_field_type) |
| 47 | +SelectField(choices=generate_choices_wrong_field_type) # type: ignore |
| 48 | + |
| 49 | + |
| 50 | +# provide choices based on enum |
| 51 | +class TestEnum(Enum): |
| 52 | + foo = auto() |
| 53 | + bar = auto() |
| 54 | + baz = auto() |
| 55 | + |
| 56 | + |
| 57 | +SelectField(choices=enum_choices(TestEnum), coerce=enum_coerce(TestEnum)) |
| 58 | + |
| 59 | +# deprecated ways of providing choices: |
5 | 60 | # any way we can specify the choices inline with a literal should work |
6 | 61 |
|
7 | 62 | # tuple of tuples |
8 | | -SelectField(choices=(("", ""),)) |
9 | | -SelectField(choices=((1, "1"),)) |
10 | | -SelectField(choices=(("", "", {}),)) |
11 | | -SelectField(choices=((True, "t", {}),)) |
12 | | -SelectField(choices=((True, "t"), (False, "f", {}))) |
| 63 | +SelectField(choices=(("", ""),)) # pyright: ignore[reportDeprecated] |
| 64 | +SelectField(choices=((1, "1"),)) # pyright: ignore[reportDeprecated] |
| 65 | +SelectField(choices=(("", "", {}),)) # pyright: ignore[reportDeprecated] |
| 66 | +SelectField(choices=((True, "t", {}),)) # pyright: ignore[reportDeprecated] |
| 67 | +SelectField(choices=((True, "t"), (False, "f", {}))) # pyright: ignore[reportDeprecated] |
13 | 68 |
|
14 | 69 | # list of tuples |
15 | | -SelectField(choices=[("", "")]) |
16 | | -SelectField(choices=[(1, "1")]) |
17 | | -SelectField(choices=[("", "", {})]) |
18 | | -SelectField(choices=[(True, "t", {})]) |
19 | | -SelectField(choices=[(True, "t"), (False, "f", {})]) |
| 70 | +SelectField(choices=[("", "")]) # pyright: ignore[reportDeprecated] |
| 71 | +SelectField(choices=[(1, "1")]) # pyright: ignore[reportDeprecated] |
| 72 | +SelectField(choices=[("", "", {})]) # pyright: ignore[reportDeprecated] |
| 73 | +SelectField(choices=[(True, "t", {})]) # pyright: ignore[reportDeprecated] |
| 74 | +SelectField(choices=[(True, "t"), (False, "f", {})]) # pyright: ignore[reportDeprecated] |
20 | 75 |
|
21 | 76 | # dict of tuple of tuples |
22 | | -SelectField(choices={"a": (("", ""),)}) |
23 | | -SelectField(choices={"a": ((1, "1"),)}) |
24 | | -SelectField(choices={"a": (("", "", {}),)}) |
25 | | -SelectField(choices={"a": ((True, "t", {}),)}) |
26 | | -SelectField(choices={"a": ((True, "t"), (False, "f", {}))}) |
27 | | -SelectField(choices={"a": ((True, "", {}),), "b": ((False, "f"),)}) |
| 77 | +SelectField(choices={"a": (("", ""),)}) # pyright: ignore[reportDeprecated] |
| 78 | +SelectField(choices={"a": ((1, "1"),)}) # pyright: ignore[reportDeprecated] |
| 79 | +SelectField(choices={"a": (("", "", {}),)}) # pyright: ignore[reportDeprecated] |
| 80 | +SelectField(choices={"a": ((True, "t", {}),)}) # pyright: ignore[reportDeprecated] |
| 81 | +SelectField(choices={"a": ((True, "t"), (False, "f", {}))}) # pyright: ignore[reportDeprecated] |
| 82 | +SelectField(choices={"a": ((True, "", {}),), "b": ((False, "f"),)}) # pyright: ignore[reportDeprecated] |
28 | 83 |
|
29 | 84 | # dict of list of tuples |
30 | | -SelectField(choices={"a": [("", "")]}) |
31 | | -SelectField(choices={"a": [(1, "1")]}) |
32 | | -SelectField(choices={"a": [("", "", {})]}) |
33 | | -SelectField(choices={"a": [(True, "t", {})]}) |
34 | | -SelectField(choices={"a": [(True, "t"), (False, "f", {})]}) |
35 | | -SelectField(choices={"a": [(True, "", {})], "b": [(False, "f")]}) |
| 85 | +SelectField(choices={"a": [("", "")]}) # pyright: ignore[reportDeprecated] |
| 86 | +SelectField(choices={"a": [(1, "1")]}) # pyright: ignore[reportDeprecated] |
| 87 | +SelectField(choices={"a": [("", "", {})]}) # pyright: ignore[reportDeprecated] |
| 88 | +SelectField(choices={"a": [(True, "t", {})]}) # pyright: ignore[reportDeprecated] |
| 89 | +SelectField(choices={"a": [(True, "t"), (False, "f", {})]}) # pyright: ignore[reportDeprecated] |
| 90 | +SelectField(choices={"a": [(True, "", {})], "b": [(False, "f")]}) # pyright: ignore[reportDeprecated] |
36 | 91 |
|
37 | 92 | # the same should be true for lambdas |
38 | 93 |
|
39 | 94 | # tuple of tuples |
40 | | -SelectField(choices=lambda: (("", ""),)) |
41 | | -SelectField(choices=lambda: ((1, "1"),)) |
42 | | -SelectField(choices=lambda: (("", "", {}),)) |
43 | | -SelectField(choices=lambda: ((True, "t", {}),)) |
44 | | -SelectField(choices=lambda: ((True, "t"), (False, "f", {}))) |
| 95 | +SelectField(choices=lambda: (("", ""),)) # pyright: ignore[reportDeprecated] |
| 96 | +SelectField(choices=lambda: ((1, "1"),)) # pyright: ignore[reportDeprecated] |
| 97 | +SelectField(choices=lambda: (("", "", {}),)) # pyright: ignore[reportDeprecated] |
| 98 | +SelectField(choices=lambda: ((True, "t", {}),)) # pyright: ignore[reportDeprecated] |
| 99 | +SelectField(choices=lambda: ((True, "t"), (False, "f", {}))) # pyright: ignore[reportDeprecated] |
45 | 100 |
|
46 | 101 | # list of tuples |
47 | | -SelectField(choices=lambda: [("", "")]) |
48 | | -SelectField(choices=lambda: [(1, "1")]) |
49 | | -SelectField(choices=lambda: [("", "", {})]) |
50 | | -SelectField(choices=lambda: [(True, "t", {})]) |
51 | | -SelectField(choices=lambda: [(True, "t"), (False, "f", {})]) |
| 102 | +SelectField(choices=lambda: [("", "")]) # pyright: ignore[reportDeprecated] |
| 103 | +SelectField(choices=lambda: [(1, "1")]) # pyright: ignore[reportDeprecated] |
| 104 | +SelectField(choices=lambda: [("", "", {})]) # pyright: ignore[reportDeprecated] |
| 105 | +SelectField(choices=lambda: [(True, "t", {})]) # pyright: ignore[reportDeprecated] |
| 106 | +SelectField(choices=lambda: [(True, "t"), (False, "f", {})]) # pyright: ignore[reportDeprecated] |
52 | 107 |
|
53 | 108 | # dict of tuple of tuples |
54 | | -SelectField(choices=lambda: {"a": (("", ""),)}) |
55 | | -SelectField(choices=lambda: {"a": ((1, "1"),)}) |
56 | | -SelectField(choices=lambda: {"a": (("", "", {}),)}) |
57 | | -SelectField(choices=lambda: {"a": ((True, "t", {}),)}) |
58 | | -SelectField(choices=lambda: {"a": ((True, "t"), (False, "f", {}))}) |
59 | | -SelectField(choices=lambda: {"a": ((True, "", {}),), "b": ((False, "f"),)}) |
| 109 | +SelectField(choices=lambda: {"a": (("", ""),)}) # pyright: ignore[reportDeprecated] |
| 110 | +SelectField(choices=lambda: {"a": ((1, "1"),)}) # pyright: ignore[reportDeprecated] |
| 111 | +SelectField(choices=lambda: {"a": (("", "", {}),)}) # pyright: ignore[reportDeprecated] |
| 112 | +SelectField(choices=lambda: {"a": ((True, "t", {}),)}) # pyright: ignore[reportDeprecated] |
| 113 | +SelectField(choices=lambda: {"a": ((True, "t"), (False, "f", {}))}) # pyright: ignore[reportDeprecated] |
| 114 | +SelectField(choices=lambda: {"a": ((True, "", {}),), "b": ((False, "f"),)}) # pyright: ignore[reportDeprecated] |
60 | 115 |
|
61 | 116 | # dict of list of tuples |
62 | | -SelectField(choices=lambda: {"a": [("", "")]}) |
63 | | -SelectField(choices=lambda: {"a": [(1, "1")]}) |
64 | | -SelectField(choices=lambda: {"a": [("", "", {})]}) |
65 | | -SelectField(choices=lambda: {"a": [(True, "t", {})]}) |
66 | | -SelectField(choices=lambda: {"a": [(True, "t"), (False, "f", {})]}) |
67 | | -SelectField(choices=lambda: {"a": [(True, "", {})], "b": [(False, "f")]}) |
| 117 | +SelectField(choices=lambda: {"a": [("", "")]}) # pyright: ignore[reportDeprecated] |
| 118 | +SelectField(choices=lambda: {"a": [(1, "1")]}) # pyright: ignore[reportDeprecated] |
| 119 | +SelectField(choices=lambda: {"a": [("", "", {})]}) # pyright: ignore[reportDeprecated] |
| 120 | +SelectField(choices=lambda: {"a": [(True, "t", {})]}) # pyright: ignore[reportDeprecated] |
| 121 | +SelectField(choices=lambda: {"a": [(True, "t"), (False, "f", {})]}) # pyright: ignore[reportDeprecated] |
| 122 | +SelectField(choices=lambda: {"a": [(True, "", {})], "b": [(False, "f")]}) # pyright: ignore[reportDeprecated] |
0 commit comments