Skip to content

Commit 84371e8

Browse files
JelleZijlstragvanrossum
JelleZijlstra
authored and
gvanrossum
committed
add Optional to exc_info and extra in logging (#1117)
None is the default value for these two arguments to logging.Logger._log (which most other stuff in logging delegates to). I was getting errors in my codebase because mypy now distinguishes between Any and Optional[Any].
1 parent 6a06dd4 commit 84371e8

File tree

1 file changed

+48
-48
lines changed

1 file changed

+48
-48
lines changed

‎stdlib/2and3/logging/__init__.pyi

+48-48
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ import threading
1313
_SysExcInfoType = Union[Tuple[type, BaseException, TracebackType],
1414
Tuple[None, None, None]]
1515
if sys.version_info >= (3, 5):
16-
_ExcInfoType = Union[bool, _SysExcInfoType, Exception]
16+
_ExcInfoType = Union[None, bool, _SysExcInfoType, Exception]
1717
else:
18-
_ExcInfoType = Union[bool, _SysExcInfoType]
18+
_ExcInfoType = Union[None, bool, _SysExcInfoType]
1919
_ArgsType = Union[Tuple[Any, ...], Dict[str, Any]]
2020
_FilterType = Union['Filter', Callable[['LogRecord'], int]]
2121

@@ -33,54 +33,54 @@ class Logger:
3333
def getChild(self, suffix: str) -> 'Logger': ...
3434
if sys.version_info >= (3,):
3535
def debug(self, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
36-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
36+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
3737
**kwargs: Any) -> None: ...
3838
def info(self, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
39-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
39+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
4040
**kwargs: Any) -> None: ...
4141
def warning(self, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
42-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
42+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
4343
**kwargs: Any) -> None: ...
4444
def warn(self, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
45-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
45+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
4646
**kwargs: Any) -> None: ...
4747
def error(self, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
48-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
48+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
4949
**kwargs: Any) -> None: ...
5050
def critical(self, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
51-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
51+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
5252
**kwargs: Any) -> None: ...
5353
def log(self, lvl: int, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
54-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
54+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
5555
**kwargs: Any) -> None: ...
5656
def exception(self, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
57-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
57+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
5858
**kwargs: Any) -> None: ...
5959
else:
6060
def debug(self,
6161
msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
62-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
62+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
6363
def info(self,
6464
msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
65-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
65+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
6666
def warning(self,
6767
msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
68-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
68+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
6969
def warn(self,
7070
msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
71-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
71+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
7272
def error(self,
7373
msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
74-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
74+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
7575
def critical(self,
7676
msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
77-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
77+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
7878
def log(self,
7979
lvl: int, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
80-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
80+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
8181
def exception(self,
8282
msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
83-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
83+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
8484
def addFilter(self, filt: _FilterType) -> None: ...
8585
def removeFilter(self, filt: _FilterType) -> None: ...
8686
def filter(self, record: 'LogRecord') -> bool: ...
@@ -220,48 +220,48 @@ class LoggerAdapter:
220220
def process(self, msg: Text, kwargs: MutableMapping[str, Any]) -> Tuple[str, MutableMapping[str, Any]]: ...
221221
if sys.version_info >= (3,):
222222
def debug(self, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
223-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
223+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
224224
**kwargs: Any) -> None: ...
225225
def info(self, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
226-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
226+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
227227
**kwargs: Any) -> None: ...
228228
def warning(self, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
229-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
229+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
230230
**kwargs: Any) -> None: ...
231231
def error(self, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
232-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
232+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
233233
**kwargs: Any) -> None: ...
234234
def exception(self, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
235-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
235+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
236236
**kwargs: Any) -> None: ...
237237
def critical(self, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
238-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
238+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
239239
**kwargs: Any) -> None: ...
240240
def log(self, lvl: int, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
241-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
241+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
242242
**kwargs: Any) -> None: ...
243243
else:
244244
def debug(self,
245245
msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
246-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
246+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
247247
def info(self,
248248
msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
249-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
249+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
250250
def warning(self,
251251
msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
252-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
252+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
253253
def error(self,
254254
msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
255-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
255+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
256256
def exception(self,
257257
msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
258-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
258+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
259259
def critical(self,
260260
msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
261-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
261+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
262262
def log(self,
263263
lvl: int, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
264-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
264+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
265265
def isEnabledFor(self, lvl: int) -> bool: ...
266266
if sys.version_info >= (3,):
267267
def getEffectiveLevel(self) -> int: ...
@@ -282,46 +282,46 @@ if sys.version_info >= (3,):
282282

283283
if sys.version_info >= (3,):
284284
def debug(msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
285-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
285+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
286286
**kwargs: Any) -> None: ...
287287
def info(msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
288-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
288+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
289289
**kwargs: Any) -> None: ...
290290
def warning(msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
291-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
291+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
292292
**kwargs: Any) -> None: ...
293293
def warn(msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
294-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
294+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
295295
**kwargs: Any) -> None: ...
296296
def error(msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
297-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
297+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
298298
**kwargs: Any) -> None: ...
299299
def critical(msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
300-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
300+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
301301
**kwargs: Any) -> None: ...
302302
def exception(msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
303-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
303+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
304304
**kwargs: Any) -> None: ...
305305
def log(lvl: int, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
306-
stack_info: bool = ..., extra: Dict[str, Any] = ...,
306+
stack_info: bool = ..., extra: Optional[Dict[str, Any]] = ...,
307307
**kwargs: Any) -> None: ...
308308
else:
309309
def debug(msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
310-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
310+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
311311
def info(msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
312-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
312+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
313313
def warning(msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
314-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
314+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
315315
def warn(msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
316-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
316+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
317317
def error(msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
318-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
318+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
319319
def critical(msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
320-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
320+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
321321
def exception(msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
322-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
322+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
323323
def log(lvl: int, msg: Text, *args: Any, exc_info: _ExcInfoType = ...,
324-
extra: Dict[str, Any] = ..., **kwargs: Any) -> None: ...
324+
extra: Optional[Dict[str, Any]] = ..., **kwargs: Any) -> None: ...
325325

326326
def disable(lvl: int) -> None: ...
327327
def addLevelName(lvl: int, levelName: str) -> None: ...

0 commit comments

Comments
 (0)