`"import"` audit hook documentation is misleading
還沒有人認領這個 Issue。
- 主要語言
- Python
- 星號
- 77.2k
- 分支
- 36k
- PR 合併指標
- PR 指標待擷取
描述
Documentation
The documentation for the import statement states that it:
Raises an auditing event import with arguments module, filename, sys.path, sys.meta_path, sys.path_hooks.
However, this is not the case if the target of the import is already in sys.modules, as the audit event is raised only on first import. For imports of Python source, the event fires from import_find_and_load(), which is called from PyImport_ImportModuleLevelObject() only if the module is not already loaded.
The docs seem to suggest that the audit event is associated with the statement, but the docs are wrong.
Promote to bug?
I'm filing this as a documentation issue because the docs are not describing this behavior, but it seems that it may represent a bug in CPython. I'm willing to write a patch either way and would like a core developer to decide if this is a docs problem or a runtime problem.
It seems to me that there are a lot of use cases where a user really does want an audit event for every import statement, regardless of whether or not the module has already been imported. In fact, I found this quirk specifically because of one of these use cases. I had an application running import torch in a place where that (memory-hungry) import needed to be deferred, but the output of my debugging audit hook showed me only the first import (which luckily was still enough information to fix the problem).
If a core developer agrees that it makes sense to raise this event even if the target module is already present in sys.modules, this could be promoted to a CPython bug.
Sample program
# target_program.py
import sys
import hook
sys.addaudithook(hook.audit_numpy_import)
# BEGIN unmodified target program
import numpy
from helper import somefunc # also runs `import numpy`
def random_array():
arr = np.random.randint(0, 255, size=(30, 50))
return arr, somefunc()
helper.py
import numpy
def somefunc():
return numpy.array([42])
hook.py
import inspect
import sys
def audit_numpy_import(event, args):
if event != "import":
return
TARGET_MODULE = "numpy"
module, filename, syspath, sysmeta_path, syspath_hooks = args
if module == TARGET_MODULE:
stack = inspect.stack()
target_frame = stack[1] # index 0 is *this* frame, index 1 is where the audit event happened
fn = target_frame.filename
lineno = target_frame.lineno
print(f"{TARGET_MODULE} imported at {fn}:{lineno}")
Running the above instrument program produces the output:
$ python3 target_program.py
numpy imported at /tmp/whats-importing-that-module/target_program.py:8
Where the output I wanted is:
numpy imported at /tmp/whats-importing-that-module/target_program.py:8
numpy imported at /tmp/whats-importing-that-module/helper.py:1
I've confirmed that I can get the above output if I add sys.modules.pop("numpy") after the first numpy import, but unfortunately this (unreliable!) workaround cannot be used from the audit hook, since the module is not placed there until after the hook has finished executing.
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
從 Doc/reference/simple_stmts.rst 中關於 import 陳述式的文件開始,將其中關於稽核事件的措辭與 Python/import.c 中描述的行為進行比較,尤其關注 import_find_and_load() 和 PyImport_ImportModuleLevelObject()。執行範例程式以重現這項差異。當專案確定這是文件問題還是執行階段問題,且相關行為得到準確涵蓋時,即視為完成。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100