Skip to content

fix: set __file__ on submodules #5584

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
rwgk merged 6 commits into from
Mar 28, 2025
Merged

fix: set __file__ on submodules #5584

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b77521b
fix: set __file__ on submodules
henryiii Mar 27, 2025
8d579fa
fix: support GraalPy
henryiii Mar 27, 2025
bddc1e0
fix: workaround only for GraalPython
henryiii Mar 28, 2025
8a00fd6
Merge branch 'master' into henryiii/fix/__file__
rwgk Mar 28, 2025
4682e14
Add GRAALPY_VERSION_NUM to GraalPy workaround
rwgk Mar 28, 2025
ef1319e
Fix "GRAALPY_VERSION_NUM not defined" issue
rwgk Mar 28, 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
13 changes: 13 additions & 0 deletions include/pybind11/pybind11.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1336,6 +1336,19 @@ class module_ : public object {
if (doc && options::show_user_defined_docstrings()) {
result.attr("__doc__") = pybind11::str(doc);
}

#ifdef GRAALVM_PYTHON
Copy link
Copy Markdown
Collaborator Author

@henryiii henryiii Mar 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#ifdef GRAALVM_PYTHON
#if defined(GRAALVM_PYTHON) && GRAALPY_VERSION_NUM < 0x190000

Copy link
Copy Markdown
Collaborator

@rwgk rwgk Mar 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion applied with commit 4682e14

// GraalPy doesn't support PyModule_GetFilenameObject,
Copy link
Copy Markdown
Collaborator

@rwgk rwgk Mar 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine if you want to keep it, but the official PyModule_GetFilenameObject() seems most future proof, compared to referencing "__file__" directly.

We have 7 defined(GRAALVM_PYTHON) already under include/pybind11/, I'd lean towards adding another one here.

Copy link
Copy Markdown
Collaborator Author

@henryiii henryiii Mar 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, done.

// so getting by attribute
handle this_module = m_ptr;
result.attr("__file__") = this_module.attr("__file__");
#else
handle this_file = PyModule_GetFilenameObject(m_ptr);
if (!this_file) {
throw error_already_set();
}
result.attr("__file__") = this_file;
#endif
attr(name) = result;
return result;
}
Expand Down
1 change: 1 addition & 0 deletions tests/test_modules.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ def test_nested_modules():
)
assert m.__name__ == "pybind11_tests.modules"
assert ms.__name__ == "pybind11_tests.modules.subsubmodule"
assert m.__file__ == ms.__file__

assert ms.submodule_func() == "submodule_func()"

Expand Down