logging docstrings should use bool instead of int for exc_info

[CharString]

The documentation passes an integer as the exc_info parameter:

cpython/Lib/logging/__init__.py

Line 1496 in 8edc802

logger.debug("Houston, we have a %s", "thorny problem", exc_info=1)

But the annotation doesn't allow that.

https://github.com/python/typeshed/blob/2168ab5ff4e40c37505b3e5048944603b71a857d/stdlib/logging/__init__.pyi#L66-L67

Linked PRs

• gh-114494: Change logging docstring to bool for exec_info #114558
• [3.12] gh-114494: Change logging docstring to bool for exec_info (GH=114558) #114624
• [3.11] gh-114494: Change logging docstring to bool for exec_info (GH-114558) #116242

[srittau]

Thank you for the report. The line in question has last been changed 22 years ago, before the introduction of the bool type. The intent is clearly to pass a boolean value, which we annotate using the bool type in typeshed, even if other "truthy"/"falsy" values are also accepted.

The docstrings should probably be updated, though. Cc @gvanrossum

[CharString]

I know. And at first True and False were just names bound to 1 and 0, iirc. :)

[JelleZijlstra]

I agree this should be fixed in CPython. I'll transfer the issue.

[soufrabi]

Assign me

[soufrabi]

There are 6 lines in the file that needs to be changed. Each for different level of logging.