Skip to content

Clarified relationship between __path__ and Package in Ch6 Modules tutorial #116579

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Clarified relationship between __path__ and Package in Ch6 Modules tutorial #116579

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6df9baf
Clarified misleading cause and effect
quazi-irfan Mar 11, 2024
f734db6
Remove unnecessary diff and overflow
quazi-irfan Mar 11, 2024
fae24af
Merge branch 'main' into ch9_path_pkg
StanFromIreland Jul 29, 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
2 changes: 1 addition & 1 deletion Doc/tutorial/modules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,7 +587,7 @@
Packages in Multiple Directories
--------------------------------

Packages support one more special attribute, :attr:`~module.__path__`. This is
All packages have a special attribute :attr:`__path__`. This is

Check warning on line 590 in Doc/tutorial/modules.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

py:attr reference target not found: __path__ [ref.attr]
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
All packages have a special attribute :attr:`__path__`. This is
All packages have a special attribute, :attr:`~module.__path__`. This is

To fix the error.

Copy link
Member

Choose a reason for hiding this comment

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

Note https://docs.python.org/3/reference/import.html#package-path-rules and https://docs.python.org/3/reference/datamodel.html#module.__path__ -- this should promote https://docs.python.org/3/library/importlib.html#importlib.machinery.ModuleSpec.submodule_search_locations, rather than using __path__. Mention of modifying __path__ should be removed, too.

initialized to be a :term:`sequence` of strings containing the name of the
directory holding the
package's :file:`__init__.py` before the code in that file is executed. This
Expand Down
Loading