-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
__init__.py
208 lines (181 loc) · 6.2 KB
/
__init__.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
import functools
import string
import typing as t
from mypy.errorcodes import ErrorCode
from mypy.nodes import (
Expression,
FuncDef,
LambdaExpr,
NameExpr,
RefExpr,
StrExpr,
)
from mypy.options import Options
from mypy.plugin import (
MethodContext,
Plugin,
)
from mypy.types import (
get_proper_type,
ProperType,
Type,
)
import typing_extensions as te
ERROR_BAD_ARG: te.Final[ErrorCode] = ErrorCode(
'logger-arg',
'Positional argument of loguru handler is not valid for given message',
'loguru',
)
ERROR_BAD_KWARG: te.Final[ErrorCode] = ErrorCode(
'logger-kwarg',
'Named argument of loguru handler is not valid for given message',
'loguru',
)
class Opts(t.NamedTuple):
lazy: bool
DEFAULT_LAZY = False # type: te.Final
DEFAULT_OPTS = Opts(lazy=DEFAULT_LAZY) # type: te.Final
NAME_TO_BOOL = {
'False': False,
'True': True,
} # type: te.Final
def _loguru_logger_call_handler(
loggers: t.Dict[ProperType, Opts],
ctx: MethodContext,
) -> Type:
log_msg_expr = ctx.args[0][0]
logger_opts = loggers.get(ctx.type) or DEFAULT_OPTS
assert isinstance(log_msg_expr, StrExpr), type(log_msg_expr)
# collect call args/kwargs
# due to funky structure mypy offers here, it's easier
# to beg for forgiveness here
try:
call_args = ctx.args[1]
call_args_count = len(call_args)
except IndexError:
call_args = []
call_args_count = 0
try:
call_kwargs = {
kwarg_name: ctx.args[2][idx]
for idx, kwarg_name in enumerate(ctx.arg_names[2])
}
except IndexError:
call_kwargs = {}
# collect args/kwargs from string interpolation
log_msg_value: str = log_msg_expr.value
log_msg_expected_args_count = 0
log_msg_expected_kwargs = []
for res in string.Formatter().parse(log_msg_value):
if res[1] is None:
continue
elif not res[1].strip():
log_msg_expected_args_count += 1
else:
log_msg_expected_kwargs.append(res[1].strip())
if log_msg_expected_args_count > call_args_count:
ctx.api.msg.fail(
f'Missing {log_msg_expected_args_count - call_args_count} '
'positional arguments for log message',
context=log_msg_expr,
code=ERROR_BAD_ARG,
)
return ctx.default_return_type
elif log_msg_expected_args_count < call_args_count:
ctx.api.msg.note(
f'Expected {log_msg_expected_args_count} but found {call_args_count} '
'positional arguments for log message',
context=log_msg_expr,
code=ERROR_BAD_ARG,
)
return ctx.default_return_type
elif logger_opts.lazy:
for call_pos, call_arg in enumerate(call_args):
if isinstance(call_arg, LambdaExpr) and call_arg.arguments:
ctx.api.msg.fail(
f'Expected 0 arguments for <lambda>: {call_pos} arg',
context=call_arg,
code=ERROR_BAD_ARG,
)
elif isinstance(call_arg, RefExpr) and isinstance(
call_arg.node, FuncDef) and call_arg.node.arguments:
ctx.api.msg.fail(
f'Expected 0 arguments for {call_arg.fullname}: {call_pos} arg',
context=call_arg,
code=ERROR_BAD_ARG,
)
for log_msg_kwarg in log_msg_expected_kwargs:
maybe_kwarg_expr = call_kwargs.pop(log_msg_kwarg, None)
if maybe_kwarg_expr is None:
ctx.api.msg.fail(
f'{log_msg_kwarg} keyword argument is missing',
context=log_msg_expr,
code=ERROR_BAD_KWARG,
)
return ctx.default_return_type
elif logger_opts.lazy:
if isinstance(maybe_kwarg_expr, LambdaExpr) and maybe_kwarg_expr.arguments:
ctx.api.msg.fail(
f'Expected 0 arguments for <lambda>: {log_msg_kwarg} kwarg',
context=maybe_kwarg_expr,
code=ERROR_BAD_KWARG,
)
elif isinstance(maybe_kwarg_expr, RefExpr) and isinstance(
maybe_kwarg_expr.node, FuncDef) and maybe_kwarg_expr.node.arguments:
ctx.api.msg.fail(
'Expected 0 arguments for '
f'{maybe_kwarg_expr.node.fullname}: {log_msg_kwarg}',
context=maybe_kwarg_expr,
code=ERROR_BAD_KWARG,
)
for extra_kwarg_name in call_kwargs:
ctx.api.msg.fail(
f'{extra_kwarg_name} keyword argument not found in log message',
context=log_msg_expr,
code=ERROR_BAD_KWARG,
)
return ctx.default_return_type
def _loguru_opt_call_handler(
loggers: t.Dict[ProperType, Opts],
ctx: MethodContext,
) -> Type:
return_type = get_proper_type(ctx.default_return_type)
lazy_expr = _get_opt_arg('lazy', ctx=ctx)
if isinstance(lazy_expr, NameExpr):
loggers[return_type] = Opts(lazy=NAME_TO_BOOL[lazy_expr.name])
return return_type
def _get_opt_arg(
arg_name: str,
*,
ctx: MethodContext,
) -> t.Optional[Expression]:
try:
return ctx.args[ctx.callee_arg_names.index(arg_name)][0]
except IndexError:
return None
class LoguruPlugin(Plugin):
builtin_severities = (
'info',
'debug',
'warning',
'error',
'exception',
'success',
'trace',
)
def __init__(self, options: Options) -> None:
super().__init__(options)
self._known_loggers: t.Dict[ProperType, Opts] = {}
def get_method_hook(
self,
fullname: str,
) -> t.Optional[t.Callable[[MethodContext], Type]]:
if fullname.startswith('loguru'):
_, method = fullname.rsplit('.', 1)
if method in self.builtin_severities:
return functools.partial(_loguru_logger_call_handler, self._known_loggers)
elif method == 'opt':
return functools.partial(_loguru_opt_call_handler, self._known_loggers)
return super().get_method_hook(fullname)
def plugin(version: str) -> t.Type[LoguruPlugin]:
return LoguruPlugin