-
-
Notifications
You must be signed in to change notification settings - Fork 35
/
type_util.py
212 lines (172 loc) · 4.68 KB
/
type_util.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
import dataclasses
import datetime
import decimal
import enum
import typing
import uuid
from typing import (
Any,
Callable,
ClassVar,
Dict,
Optional,
Protocol,
Type,
Union,
get_origin,
get_type_hints,
)
import msgspec
builtin_types: typing.List = [
None,
bool,
int,
float,
str,
bytes,
bytearray,
tuple,
list,
dict,
set,
frozenset,
]
std_lib_types: typing.List = [
datetime.datetime,
datetime.date,
datetime.time,
uuid.UUID,
decimal.Decimal,
enum.Enum,
enum.IntEnum,
dataclasses.dataclass,
]
typing_types: typing.List = [
typing.Tuple,
typing.List,
typing.Dict,
typing.Set,
typing.FrozenSet,
typing.Union,
typing.Optional,
]
msgspec_types: typing.List = [
msgspec.Struct,
]
allowed_types = builtin_types + std_lib_types + typing_types
class IsDataclass(Protocol):
# as already noted in comments, checking for this attribute is currently
# the most reliable way to ascertain that something is a dataclass
__dataclass_fields__: ClassVar[Dict[str, Any]]
AllowedType = Union[
None,
bool,
int,
float,
str,
bytes,
bytearray,
tuple,
list,
dict,
set,
frozenset,
datetime.datetime,
datetime.date,
datetime.time,
uuid.UUID,
decimal.Decimal,
enum.Enum,
enum.IntEnum,
IsDataclass,
typing.Tuple,
typing.List,
typing.Dict,
typing.Set,
typing.FrozenSet,
msgspec.Struct,
Type[enum.Enum], # For enum classes
Type[enum.IntEnum], # For int enum classes
]
def verify_function_args(func: Callable) -> None:
arg_count = func.__code__.co_argcount
if arg_count < 1:
return
if arg_count > 1:
raise ValueError(
f"`{func.__name__}` has more than 1 args; "
"RPC functions can have only one arg - msg, or no arg"
)
arg_name = func.__code__.co_varnames[0]
func_arg_type = get_type_hints(func)
if arg_name not in func_arg_type:
raise TypeError(
f"`{func.__name__}` has no type hinting; RPC functions must have type hints"
)
def verify_function_return(func: Callable) -> None:
types = get_type_hints(func)
if not types.get("return"):
raise TypeError(
f"`{func.__name__}` has no return type hinting; RPC functions must have type hints"
)
def get_function_input_class(func: Callable) -> Optional[type]:
arg_count = func.__code__.co_argcount
if arg_count == 0:
return None
if arg_count == 1:
arg_name = func.__code__.co_varnames[0]
func_arg_type = get_type_hints(func)
return func_arg_type[arg_name]
return None
def get_function_return_class(func: Callable):
types = get_type_hints(func)
return types.get("return")
def verify_function_input_type(func: Callable):
input_type = get_function_input_class(func)
if input_type is None:
return
if is_allowed_type(input_type):
return
raise TypeError(
f"{func.__name__} has type {input_type} which is not allowed; "
"allowed types are: \n" + "\n".join([str(t) for t in allowed_types])
)
def verify_function_return_type(func: Callable):
return_type = get_function_return_class(func)
# None is not allowed as return type
if return_type is None:
raise TypeError(
f"{func.__name__} returns None; RPC functions must return a value"
)
# Optional is not allowed as return type
if get_origin(return_type) == typing.Union and type(None) in return_type.__args__:
raise TypeError(
f"{func.__name__} returns Optional; RPC functions must return a value"
)
if is_allowed_type(return_type):
return
raise TypeError(
f"{func.__name__} has return type {return_type} which is not allowed; "
"allowed types are: \n" + "\n".join([str(t) for t in allowed_types])
)
def verify_allowed_type(msg, rpc_method: Optional[str] = None):
if not isinstance(msg, tuple(allowed_types)):
method_name = f"for method `{rpc_method}`" if rpc_method else ""
raise TypeError(
f"{msg} is not allowed {method_name}; allowed types are: \n"
+ "\n".join([str(t) for t in allowed_types])
)
def is_allowed_type(typ: Type):
if typ in allowed_types:
return True
if str(typ).startswith("<enum"):
return True
if dataclasses.is_dataclass(typ):
return True
origin_type = get_origin(typ)
if origin_type is not None and origin_type in allowed_types:
return True
for mtype in msgspec_types:
if issubclass(typ, mtype):
return True
return False