Clarified relationship between __path__ and Package in Ch6 Modules tutorial
#116579
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CAM-Gerlach
reviewed
Mar 11, 2024
| @@ -587,7 +587,7 @@ as the main module of a Python application must always use absolute imports. | |||
| 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 | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In Ch 6 Modules tutorial, the first line of section 6.4.3. Packages in Multiple Directories says, "Packages support one more special attribute,
__path__.".But this reverses the cause and effect since, in the glossary, Package is defined as Python module with a
__path__variable.This pull request attempts to fix that by updating the line to "All packages have a special attribute
__path__.".Discussion link to Discord thread.
📚 Documentation preview 📚: https://cpython-previews--116579.org.readthedocs.build/