Repository navigation
logging module LogRecord __init__ mismatch #9913
Description
According to the Python docs for the LogRecord in logging module the msg argument and property is a string:
https://docs.python.org/3/library/logging.html#logging.LogRecord
In the typeshed, the attribute is set to a str:
typeshed/stdlib/logging/__init__.pyi
Line 392 in dd2818a
But the msg input argument is set to object:
typeshed/stdlib/logging/__init__.pyi
Line 407 in dd2818a
And looking at the source the argument is not changed at all:
https://github.com/python/cpython/blob/7f760c2fca3dc5f46a518f5b7622783039bc8b7b/Lib/logging/__init__.py#L305
Unless this is for a backwards-compatible version, I guess this is a mismatch.
Activity
[-]logging module LogRecord `__init__`[/-][+]logging module LogRecord `__init__` mismatch[/+]Akuli commentedon Mar 22, 2023
I think we should just use
streverywhere. If you are passing a non-string, and it isn't converted to a string anywhere inlogging, it may fail when some completely unrelated code handles the log records elsewhere. IMO this is exactly what type checking is supposed to avoid.aminalaee commentedon Mar 23, 2023
But in that case type checking is actually stricter than the implementation, and causes mismatch between typeshed and python docs and implementation.