Skip to content

gh-138310: Adds sys.audit event for import_module #138311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Sep 19, 2025
Merged

gh-138310: Adds sys.audit event for import_module #138311

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
391e1de
Adds sys.audit event for import_module.
Aug 31, 2025
441de32
Moves audit to _gcd_import.
Sep 3, 2025
e6436c4
Removes audit from import.c, moves to _find_and_load_unlocked.
Sep 4, 2025
ac56ef0
Removes unneeded change.
Sep 4, 2025
5207807
Moves audit and uses path argument.
Sep 5, 2025
9bc4407
Adds more tests and cleans up import.c.
Sep 14, 2025
135539f
Fixes rel imports, test whole tuple, fixes args.
Sep 18, 2025
2387863
Uses swap_item for globals().
Sep 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions Lib/importlib/_bootstrap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1306,15 +1306,15 @@ def _sanity_check(name, package, level):
_ERR_MSG_PREFIX = 'No module named '

def _find_and_load_unlocked(name, import_):
path = None
sys.audit(
"import",
name,
None,
getattr(sys, "path"),
getattr(sys, "meta_path"),
getattr(sys, "path_hooks")
path,
getattr(sys, "path", None),
getattr(sys, "meta_path", None),
getattr(sys, "path_hooks", None)
)
path = None
parent = name.rpartition('.')[0]
parent_spec = None
if parent:
Expand Down
58 changes: 32 additions & 26 deletions Lib/test/audit-tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import contextlib
import os
import sys
import unittest.mock


class TestHook:
Expand Down Expand Up @@ -683,16 +684,16 @@ def test_import_module():
importlib.import_module("test.audit_test_data.submodule2") # absolute import
importlib.import_module("_testcapi") # extension module

actual = [a[0] for e, a in hook.seen if e == "import"]
actual = [a for e, a in hook.seen if e == "import"]
assertSequenceEqual(
[
"email",
"pythoninfo",
"test.audit_test_data.submodule",
"test.audit_test_data",
"test.audit_test_data.submodule2",
"_testcapi",
"_testcapi",
("email", None, sys.path, sys.meta_path, sys.path_hooks),
("pythoninfo", None, sys.path, sys.meta_path, sys.path_hooks),
("test.audit_test_data.submodule", None, sys.path, sys.meta_path, sys.path_hooks),
("test.audit_test_data", None, sys.path, sys.meta_path, sys.path_hooks),
("test.audit_test_data.submodule2", None, sys.path, sys.meta_path, sys.path_hooks),
("_testcapi", None, sys.path, sys.meta_path, sys.path_hooks),
("_testcapi", unittest.mock.ANY, None, None, None)
],
actual,
)
Expand All @@ -704,47 +705,52 @@ def test_builtin__import__():
__import__("importlib")
__import__("email")
__import__("pythoninfo")
__import__("test.audit_test_data.submodule", fromlist=["audit_test_data"])
__import__("audit_test_data.submodule", level=1, globals={"__package__": "test"})
__import__("test.audit_test_data.submodule2")
__import__("_testcapi")

actual = [a[0] for e, a in hook.seen if e == "import"]
actual = [a for e, a in hook.seen if e == "import"]
assertSequenceEqual(
[
"email",
"pythoninfo",
"test.audit_test_data.submodule",
"test.audit_test_data",
"test.audit_test_data.submodule2",
"_testcapi",
"_testcapi",
("email", None, sys.path, sys.meta_path, sys.path_hooks),
("pythoninfo", None, sys.path, sys.meta_path, sys.path_hooks),
("test.audit_test_data.submodule", None, sys.path, sys.meta_path, sys.path_hooks),
("test.audit_test_data", None, sys.path, sys.meta_path, sys.path_hooks),
("test.audit_test_data.submodule2", None, sys.path, sys.meta_path, sys.path_hooks),
("_testcapi", None, sys.path, sys.meta_path, sys.path_hooks),
("_testcapi", unittest.mock.ANY, None, None, None)
],
actual,
)

def test_import_statement():
import importlib # noqa: F401
# Set __package__ so relative imports work
old_package = globals().get("__package__", None)
globals()["__package__"] = "test"

with TestHook() as hook:
import importlib # noqa: F401
import email # noqa: F401
import pythoninfo # noqa: F401
from test.audit_test_data import submodule # noqa: F401
from .audit_test_data import submodule # noqa: F401
import test.audit_test_data.submodule2 # noqa: F401
import _testcapi # noqa: F401

actual = [a[0] for e, a in hook.seen if e == "import"]
globals()["__package__"] = old_package

actual = [a for e, a in hook.seen if e == "import"]
# Import statement ordering is different because the package is
# loaded first and then the submodule
assertSequenceEqual(
[
"email",
"pythoninfo",
"test.audit_test_data",
"test.audit_test_data.submodule",
"test.audit_test_data.submodule2",
"_testcapi",
"_testcapi",
("email", None, sys.path, sys.meta_path, sys.path_hooks),
("pythoninfo", None, sys.path, sys.meta_path, sys.path_hooks),
("test.audit_test_data", None, sys.path, sys.meta_path, sys.path_hooks),
("test.audit_test_data.submodule", None, sys.path, sys.meta_path, sys.path_hooks),
("test.audit_test_data.submodule2", None, sys.path, sys.meta_path, sys.path_hooks),
("_testcapi", None, sys.path, sys.meta_path, sys.path_hooks),
("_testcapi", unittest.mock.ANY, None, None, None)
],
actual,
)
Expand Down
1 change: 1 addition & 0 deletions Makefile.pre.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2590,6 +2590,7 @@ TESTSUBDIRS= idlelib/idle_test \
test/test_ast \
test/test_ast/data \
test/archivetestdata \
test/audit_test_data \
test/audiodata \
test/certdata \
test/certdata/capath \
Expand Down
Loading