gh-61310: Document package precedence over same-named modules#153211
Open
TheD0ubleC wants to merge 1 commit into
Open
gh-61310: Document package precedence over same-named modules#153211TheD0ubleC wants to merge 1 commit into
TheD0ubleC wants to merge 1 commit into
Conversation
Documentation build overview
|
Comment on lines
+668
to
+673
| Within a single file system path entry, the default finder checks for regular | ||
| packages before same-named modules. For example, if the same directory contains | ||
| both ``spam/__init__.py`` and ``spam.py``, ``import spam`` will import the | ||
| package from ``spam/__init__.py``. This does not override the order of | ||
| :data:`sys.path`: a module found in an earlier path entry still takes precedence | ||
| over a package found in a later one. |
Member
There was a problem hiding this comment.
Suggested change
| Within a single file system path entry, the default finder checks for regular | |
| packages before same-named modules. For example, if the same directory contains | |
| both ``spam/__init__.py`` and ``spam.py``, ``import spam`` will import the | |
| package from ``spam/__init__.py``. This does not override the order of | |
| :data:`sys.path`: a module found in an earlier path entry still takes precedence | |
| over a package found in a later one. | |
| Within a single :term:`path entry`, the default path entry finders check for a | |
| :term:`regular package` first, then for extension modules, then for source | |
| files, and finally for bytecode files. For example, if the same directory | |
| contains both ``spam/__init__.py`` and ``spam.py``, ``import spam`` will | |
| import the package from ``spam/__init__.py``. A directory without an | |
| ``__init__.py`` file is treated as a :term:`namespace package` portion only if | |
| no matching module is found. Note that this does not override the order of the | |
| :term:`import path`. |
We should use consistent terminology, and let's link to the glossary when we can, as it is helpful to readers. Your text omits the final step of the search for namespace packages. Additionally let's expand a little and resolve #93435 too. Finally, we don't need to dwell on this not affecting the import path.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Document that the default filesystem finder checks for regular packages before same-named modules within a single path entry.
This clarifies the behavior reported in gh-61310 while preserving the existing
sys.pathordering semantics: a module found in an earlier path entry still takes precedence over a package found in a later one.Validation:
import spamimportsspam/__init__.pywhen bothspam/__init__.pyandspam.pyexist in the same directory.sys.pathorder still takes precedence across different path entries.git diff --check.Docs build was not run because Sphinx is not installed in this environment.