Skip to content

gh-113208: Mention namespace packages don't require __init__.py #113209

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
hugovk merged 2 commits into from
Dec 19, 2023
Merged

gh-113208: Mention namespace packages don't require __init__.py #113209

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f656993
Added exceptional case where __init__.py is not required to make a pa…
Unique-Usman Dec 16, 2023
2174afb
Update Doc/tutorial/modules.rst
Unique-Usman Dec 16, 2023
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
3 changes: 2 additions & 1 deletion Doc/tutorial/modules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,8 @@ When importing the package, Python searches through the directories on
``sys.path`` looking for the package subdirectory.

The :file:`__init__.py` files are required to make Python treat directories
containing the file as packages. This prevents directories with a common name,
containing the file as packages (unless using a :term:`namespace package`, a
relatively advanced feature). This prevents directories with a common name,
such as ``string``, from unintentionally hiding valid modules that occur later

@merwok merwok Jan 24, 2025

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.

So… this line is not true anymore 😢

@Unique-Usman Unique-Usman Jan 24, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Hi @merwok, could you provide a reference to the updated way, I can open a pr for it.

@merwok merwok Feb 14, 2025

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.

Well, now nothing presents a directory on sys.path to shadow a stdlib module name, even without __init__.py file

You could open an issue first, then we’ll see if someone creates a PR!

on the module search path. In the simplest case, :file:`__init__.py` can just be
an empty file, but it can also execute initialization code for the package or
Expand Down