Skip to content

Commit 4702329

Browse files
authored
[WTForms] Update stubs for 3.3.0 (#16604)
1 parent 956ce07 commit 4702329

18 files changed

Lines changed: 509 additions & 90 deletions

‎stubs/WTForms/@tests/stubtest_allowlist.txt‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,13 @@ wtforms.meta.DefaultMeta.__getattr__
1010
# Should allow setting and deleting any attribute
1111
wtforms.fields.core.Flags.__delattr__
1212
wtforms.fields.core.Flags.__setattr__
13+
14+
# Error: is inconsistent
15+
# =============================
16+
# __post_init__ ensures label never is None
17+
wtforms.fields.choices.SelectChoice.__init__
18+
19+
# Error: variable differs from runtime type
20+
# =============================
21+
# __post_init__ ensures label never is None
22+
wtforms.fields.choices.SelectChoice.label
Lines changed: 100 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,122 @@
11
from __future__ import annotations
22

3-
from wtforms import SelectField
3+
from enum import Enum, auto
44

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:
560
# any way we can specify the choices inline with a literal should work
661

762
# 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]
1368

1469
# 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]
2075

2176
# 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]
2883

2984
# 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]
3691

3792
# the same should be true for lambdas
3893

3994
# 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]
45100

46101
# 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]
52107

53108
# 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]
60115

61116
# 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]

‎stubs/WTForms/METADATA.toml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
version = "~= 3.2.1"
1+
version = "3.3.*"
22
upstream-repository = "https://github.com/pallets-eco/wtforms"
33
dependencies = ["MarkupSafe"]
4+
requires-python = ">=3.11"

‎stubs/WTForms/wtforms/__init__.pyi‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
from typing import Final
22

33
from wtforms import validators as validators, widgets as widgets
4+
from wtforms.datalist import DataList as DataList, DataListChoice as DataListChoice, enum_datalist as enum_datalist
45
from wtforms.fields.choices import (
6+
Choice as Choice,
57
RadioField as RadioField,
8+
SelectChoice as SelectChoice,
69
SelectField as SelectField,
710
SelectFieldBase as SelectFieldBase,
811
SelectMultipleField as SelectMultipleField,
@@ -27,6 +30,7 @@ from wtforms.fields.numeric import (
2730
)
2831
from wtforms.fields.simple import (
2932
BooleanField as BooleanField,
33+
ButtonField as ButtonField,
3034
ColorField as ColorField,
3135
EmailField as EmailField,
3236
FileField as FileField,
@@ -50,8 +54,8 @@ __all__ = [
5054
"Form",
5155
"ValidationError",
5256
"SelectField",
53-
"SelectFieldBase",
5457
"SelectMultipleField",
58+
"SelectFieldBase",
5559
"RadioField",
5660
"Field",
5761
"Flags",
@@ -69,7 +73,9 @@ __all__ = [
6973
"FloatField",
7074
"IntegerRangeField",
7175
"DecimalRangeField",
76+
"ButtonField",
7277
"BooleanField",
78+
"DataList",
7379
"TextAreaField",
7480
"PasswordField",
7581
"FileField",
@@ -82,4 +88,8 @@ __all__ = [
8288
"URLField",
8389
"EmailField",
8490
"ColorField",
91+
"Choice",
92+
"SelectChoice",
93+
"DataListChoice",
94+
"enum_datalist",
8595
]

‎stubs/WTForms/wtforms/_compat.pyi‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
from collections.abc import Callable
2+
from inspect import Signature
3+
from typing import Any
4+
5+
def get_signature(callable: Callable[..., Any]) -> Signature: ...

‎stubs/WTForms/wtforms/datalist.pyi‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
from collections.abc import Callable, Iterator, Sequence
2+
from dataclasses import dataclass
3+
from enum import EnumMeta
4+
from typing import Any, Protocol, TypeAlias, type_check_only
5+
from typing_extensions import Self
6+
7+
from markupsafe import Markup
8+
from wtforms.fields import Field
9+
10+
_RawDataListChoice: TypeAlias = str | tuple[str] | tuple[str, str | None] | tuple[str, str | None, dict[str, Any]]
11+
_DataListChoices: TypeAlias = Sequence[DataListChoice | _RawDataListChoice] | dict[str, str]
12+
13+
@type_check_only
14+
class _DataListWidget(Protocol):
15+
# see the comment on `wtforms.widgets.core._RenderArg` for a thorough explanation of the kwargs
16+
def __call__(self, datalist: DataList, /, *, field: Field | None = None, **kwargs: Any) -> Markup: ...
17+
18+
__all__ = ("DataList", "DataListChoice", "enum_datalist")
19+
20+
@dataclass
21+
class DataListChoice:
22+
value: str
23+
label: str | None = ...
24+
render_kw: dict[str, Any] = ...
25+
def __post_init__(self) -> None: ...
26+
def __iter__(self) -> Iterator[tuple[str, str, dict[str, Any]]]: ...
27+
@classmethod
28+
def from_input(cls, input: DataListChoice | _RawDataListChoice) -> Self: ...
29+
30+
def enum_datalist(enum_cls: EnumMeta, *, by: str = "value", label: str | None = None) -> DataList: ...
31+
32+
class DataList:
33+
widget: _DataListWidget
34+
render_kw: dict[str, Any]
35+
id: str | None
36+
def __init__(
37+
self,
38+
choices: _DataListChoices | Callable[[Any, Any], _DataListChoices] | Callable[[], _DataListChoices] | None = None,
39+
*,
40+
render_kw: dict[str, Any] | None = None,
41+
widget: _DataListWidget | None = None,
42+
) -> None: ...
43+
def iter_choices(self, field: Field | None = None) -> list[DataListChoice]: ...
44+
# by default this invokes the bound `widget.__call__` with the given kwargs and bound `render_kw`
45+
# see the comment on `wtforms.widgets.core._RenderArg` for a thorough explanation
46+
def __call__(self, field: Field | None = None, **kwargs: Any) -> Markup: ...

‎stubs/WTForms/wtforms/fields/__init__.pyi‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
from wtforms.fields.choices import (
2+
Choice as Choice,
23
RadioField as RadioField,
4+
SelectChoice as SelectChoice,
35
SelectField as SelectField,
46
SelectFieldBase as SelectFieldBase,
57
SelectMultipleField as SelectMultipleField,
8+
enum_choices as enum_choices,
9+
enum_coerce as enum_coerce,
610
)
711
from wtforms.fields.core import Field as Field, Flags as Flags, Label as Label
812
from wtforms.fields.datetime import (
@@ -24,6 +28,7 @@ from wtforms.fields.numeric import (
2428
)
2529
from wtforms.fields.simple import (
2630
BooleanField as BooleanField,
31+
ButtonField as ButtonField,
2732
ColorField as ColorField,
2833
EmailField as EmailField,
2934
FileField as FileField,
@@ -43,10 +48,14 @@ __all__ = [
4348
"Field",
4449
"Flags",
4550
"Label",
51+
"Choice",
52+
"SelectChoice",
4653
"SelectField",
47-
"SelectFieldBase",
4854
"SelectMultipleField",
55+
"SelectFieldBase",
4956
"RadioField",
57+
"enum_choices",
58+
"enum_coerce",
5059
"DateTimeField",
5160
"DateField",
5261
"TimeField",
@@ -59,6 +68,7 @@ __all__ = [
5968
"FloatField",
6069
"IntegerRangeField",
6170
"DecimalRangeField",
71+
"ButtonField",
6272
"BooleanField",
6373
"TextAreaField",
6474
"PasswordField",

0 commit comments

Comments
 (0)