Skip to content

gh-131885: Clarify lazy import filters have positional-only parameters #144856

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

Open
johnslavik wants to merge 4 commits into
base: main
Choose a base branch
from
+3 −1
Open

gh-131885: Clarify lazy import filters have positional-only parameters #144856

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f869e9c
Clarify lazy import filters have positional-only arguments
johnslavik Feb 15, 2026
4eebd62
Don't describe arguments as positional in written sentences
johnslavik Feb 16, 2026
d4c5563
Make the docs more correct
johnslavik Jul 24, 2026
ca4de39
Remove the trailing `/`
johnslavik Jul 24, 2026
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
4 changes: 3 additions & 1 deletion Doc/library/sys.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1779,7 +1779,7 @@ always available. Unless explicitly noted otherwise, all variables are read-only
callable or ``None`` to clear the filter.

The filter function is called for every potentially lazy import to
determine whether it should actually be lazy. It must have the following
determine whether it should actually be lazy. It has the following

@encukou encukou Jul 24, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It must accept 3 positional arguments. The exact signature is not a hard requirement.

Suggested change
determine whether it should actually be lazy. It has the following
determine whether it should actually be lazy. It should have the following

signature::

def filter(importing_module: str, imported_module: str,
Expand All @@ -1792,6 +1792,8 @@ always available. Unless explicitly noted otherwise, all variables are read-only
* *fromlist* is the tuple of names being imported (for ``from ... import``
statements), or ``None`` for regular imports

These arguments are passed positionally.

The filter should return ``True`` to allow the import to be lazy, or
``False`` to force an eager import.

Expand Down
Loading