-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.py
285 lines (230 loc) · 7.07 KB
/
types.py
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
import dataclasses
import enum
from typing import (
Any,
List,
Optional,
TypedDict,
TypeVar,
Union,
)
import strawberry
from strawberry.scalars import JSON
from typing_extensions import Annotated, TypeAlias, Unpack
_R = TypeVar("_R")
@strawberry.type
class Resource:
name: str
fields: List["ResourceField"] = strawberry.field(default_factory=list)
def __hash__(self):
return hash(self.name)
@strawberry.enum
class FieldKind(enum.Enum):
"""The proper field kind.
This is useful to differentiate the kind of the field from its
scalar value. E.g. A "String" scalar might be a `POSTAL_CODE`, a
`PASSWORD`, etc.
"""
BOOLEAN = "boolean"
CURRENCY = "currency"
DATE = "date"
DATETIME = "datetime"
TIMEDELTA = "timedelta"
DECIMAL = "decimal"
EMAIL = "email"
FILE = "file"
IMAGE = "image"
FLOAT = "float"
ID = "id"
IP = "IP"
INT = "int"
JSON = "json"
LEGAL_PERSON_DOC = "legal-person-doc"
NATURAL_PERSON_DOC = "natural-person-doc"
PASSWORD = "password"
PERCENT = "percent"
PHONE = "phone"
POSTAL_CODE = "postal-code"
STRING = "string"
STRING_LIST = "string-list"
MULTILINE = "multiline"
TIME = "time"
URL = "url"
UUID = "uuid"
POINT = "point"
GEOPOINT = "geopoint"
POLYGON = "polygon"
DISTANCE = "distance"
MARKDOWN = "markdown"
@strawberry.enum
class FieldObjectKind(enum.Enum):
"""The kind of the nested object.
The options here are:
OBJECT:
A nested type containing the given fields (e.g. `{"foo": "bar", "baz", 123}`)
OBJECT_LIST:
A nested list of types containing the given fields
(e.g. `[{"foo": "bar", "baz", 123}, ...]`)
INPUT:
A nested input expecting the given fields (e.g. `{"foo": "bar", "baz", 123}`)
INPUT_LIST:
A nested list of inputs expecting the given fields
(e.g. `[{"foo": "bar", "baz", 123}, ...]`)
LIST_INPUT:
A nested `ListInput` type, containing its usual `set`/`add`/`remove` options,
each expecting a list of the given inputs
(e.g. `{"set": [{{"foo": "bar", "baz", 123}, ...}]}`).
"""
OBJECT = "object"
OBJECT_LIST = "object-list"
INPUT = "input"
INPUT_LIST = "input-list"
LIST_INPUT = "list-input"
@strawberry.type
class BaseFieldValidation:
"""Field validation values."""
required: bool = strawberry.field(
description="If this field is required.",
default=True,
)
@strawberry.type
class StringFieldValidation(BaseFieldValidation):
"""Field validation for string values."""
min_length: Optional[int] = strawberry.field(
description="Min length for the string.",
default=None,
)
max_length: Optional[int] = strawberry.field(
description="Max length for the string.",
default=None,
)
@strawberry.type
class IntFieldValidation(BaseFieldValidation):
"""Field validation for integer values."""
min_value: Optional[int] = strawberry.field(
description="Min value for the number.",
default=None,
)
max_value: Optional[int] = strawberry.field(
description="Max value for the number.",
default=None,
)
@strawberry.type
class DecimalFieldValidation(IntFieldValidation):
"""Field validation for decimal values."""
max_digits: Optional[int] = strawberry.field(
description="Max digits allowed. Note: This include the decimal places.",
default=None,
)
decimal_places: Optional[int] = strawberry.field(
description="Decimal places allowed",
default=None,
)
FieldValidation: TypeAlias = strawberry.union( # type: ignore
"FieldValidation",
(
BaseFieldValidation,
StringFieldValidation,
IntFieldValidation,
DecimalFieldValidation,
),
)
@strawberry.type
class FieldChoice:
"""A valid choice for the field."""
label: str
value: JSON
group: Optional[str] = None
@strawberry.type
class Field:
"""Base field schema."""
name: str = strawberry.field(
description="The name of the field.",
)
kind: FieldKind = strawberry.field(
description="The kind of the field.",
)
label: str = strawberry.field(
description="The field's humanized name",
)
multiple: bool = strawberry.field(
description="If this field expects an array of values.",
default=False,
)
orderable: bool = strawberry.field(
description="If this field is orderable.",
default=False,
)
filterable: bool = strawberry.field(
description="If this field is filterable.",
default=False,
)
help_text: Optional[str] = strawberry.field(
description="A help text for the field.",
default=None,
)
choices: Optional[List[FieldChoice]] = strawberry.field(
description="Valid choices for this field, if any is defined.",
default=None,
)
default_value: Optional[JSON] = strawberry.field(
description="Default value for the field. Parse the json to get its value.",
default=None,
)
validation: FieldValidation = strawberry.field(
description="Validation options for this field",
default_factory=BaseFieldValidation,
)
resource: Optional[str] = strawberry.field(
description="The resource that this field is linked to",
default=None,
)
@strawberry.type
class FieldObject:
"""Base field list schema."""
name: str = strawberry.field(
description="The name of the field.",
)
label: str = strawberry.field(
description="The field's humanized name",
)
obj_kind: FieldObjectKind = strawberry.field(
description="The kind of the field.",
)
obj_type: str = strawberry.field(
description="The obj type name.",
)
fields: List["ResourceField"] = strawberry.field(
description="All subfields of this field.",
)
resource: Optional[str] = strawberry.field(
description="The resource that this field is linked to",
default=None,
)
ResourceField: TypeAlias = strawberry.union("ResourceField", (Field, FieldObject)) # type: ignore
class FieldOptions(TypedDict, total=False):
kind: FieldKind
multiple: bool
orderable: bool
filterable: bool
label: str
resource: Optional[str]
help_text: Optional[str]
choices: Optional[List[FieldChoice]]
default_value: Any
validation: FieldValidation
class FieldObjectOptions(TypedDict, total=False):
label: str
obj_kind: FieldObjectKind
FieldOrFieldObjectOptions: TypeAlias = Union[FieldOptions, FieldObjectOptions]
@dataclasses.dataclass
class FieldOptionsConfig:
options: FieldOptions
def __hash__(self):
return hash((self.__class__, frozenset(self.options.items())))
class HiddenFieldError(Exception): ...
class HiddenField: ...
Hidden = Annotated[_R, HiddenField()]
def config(**options: Unpack[FieldOptions]):
"""Override options for a field."""
return FieldOptionsConfig(options=options)