wrong/ambiguous type descriptions for `LogRecord.exc_info`

オープン
  • 何か問題がありますか？
#161,918 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
52/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
python
領域
documentation

調査の方向性

Start with the LogRecord.exc_info and Formatter.formatException() entries in the logging documentation, then compare their descriptions with the behavior and typeshed references linked in the issue. Clarify which values these APIs allow and how the documented exception tuple handles missing exception or traceback values. Done means the documentation accurately describes the relevant cases; the issue leaves open whether code or typeshed changes are also needed.

索引モデルが issue の本文から書いたものです。

説明

docs
Documentation

Hey.

The documentation of LogRecord describes the exc_info attribute as:

exc_info (tuple[type[BaseException], BaseException, types.TracebackType] | None) – An exception tuple with the current exception information, as returned by sys.exc_info(), or None if no exception information is available.

However, records created through the normal logger methods can contain values that don’t match this type:

import logging

class H(logging.Handler):
    def emit(self, record):
        print(repr(record.exc_info))

logger = logging.getLogger()
logger.addHandler(H())
logger.propagate = False

logger.error("b", exc_info=True)           # outside of an except-block
logger.error("c", exc_info=ValueError())   # exception that was never raised

which gives as of CPython 3.14.10:

(None, None, None)
(<class 'ValueError'>, ValueError(), None)

A very recent commit (938144efad4659f7aa66bf9ef362fd3c602c4bbc) already fixed the case of a false truth value, which as per “If exc_info does not evaluate as false, …” is IMO allowed.

Now:

  1. Outside an except-block it would be (None, None, None).
  2. If an exception instance is passed, the tuple is built from its traceback, which is None for exceptions that were never raised, while the documented type requires types.TracebackType.

I think typeshed already documents it properly:
https://github.com/python/typeshed/blob/80f7beabfbb71a634cc3dbca8e418a5da790142c/stdlib/logging/__init__.pyi#L63

https://github.com/python/typeshed/blob/80f7beabfbb71a634cc3dbca8e418a5da790142c/stdlib/logging/__init__.pyi#L318

So far I'd say this is a documentation issue.

Now I can create valid LogRecord-objects that don’t go through _log() and its normalisation:

>>> import logging
>>> l = logging.getLogger()
>>> r = logging.makeLogRecord({"exc_info": True})
>>> r.exc_info
True
>>> r = l.makeRecord("z", 40, "f", 1, "m", None, exc_info=False)
>>> r.exc_info
False
>>>

For makeLogRecord and makeRecord… it’s IMO not really clear what values these allow (de jure) for exc_info.
If they’d follow the spirit of “If exc_info does not evaluate as false, …” then the the above type description would be even more wrong, as then exc_info could be any object.

This would then IMO also make the types on typeshed wrong, cause while logging.Formatter.format() itself would call formatException() only if exc_info has a true truth value:
https://github.com/python/cpython/blob/ecefd40671f340d543c214b80744d4301d249f37/Lib/logging/__init__.py#L716-L720

that may be still any object, there's nothing for the false case and both format() and formatException() are public, so any subclass may call formatException() without the if record.exc_info:.

Last but not least:
formatException() is more or less documented to an even more restrictive type:

Formats the specified exception information (a standard exception tuple as returned by sys.exc_info()) as a string.

So not sure,... at least some documentation seems to be not exact... but maybe there also needs to be code changes if the normalisation of exc_info should happen not only via LogRecord objects created through _log()... and if not, typeshed might need some updates to account for values that may be given.

Cheers,
Chris

主要言語
Python
スター
78.2k
フォーク
36.6k
平均マージ
19時間 57分
マージ済み PR（30日）
630

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

python/cpython のほかの issue

python/cpython の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。