fix(jsii-pacmak): different packages sharing a namespace fail in Bazel #4437
Conversation
This file contains 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
In Bazel, every package is extracted into a separate directory that are
all put into the `$PYTHONPATH` individually. However when searching,
Python will latch onto the directory that has an `__init__.py` in it and
only import from that directory.
Example:
```
eco_package1/
└── site-packages/
└── eco/
└── package1/
└── __init__.py
eco/
└── site-packages/
└── eco/
└── __init__.py
```
In this case, the following command will fail:
```py
import eco.package1
```
Because `eco/package1/__init__.py` is not in the same root directory as
`eco/__init__.py`.
We can fix this by generating a command into every `__init__.py` that
uses `pkgutil` to extend the search path for a package; it will put
all directories in `$PYTHONPATH` that contain the same package onto
the search path for submodules. The command looks like this:
```py
from pkgutil import extend_path
__path__ = extend_path(__path__, __name__)
```
mrgrain
approved these changes
Mar 4, 2024
|
Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it! |
|
Merging (with squash)... |
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 Bazel, every package is extracted into a separate directory that are all put into the
$PYTHONPATHindividually. However when searching, Python will latch onto the directory that has an__init__.pyin it and only import from that directory.Example:
In this case, the following command will fail:
Because
eco/package1/__init__.pyis not in the same directory aseco/__init__.py.We can fix this by generating a command into every
__init__.pythat usespkgutilto extend the search path for a package; it will put all directories in$PYTHONPATHthat contain the same package onto the search path for submodules. The command looks like this:Resolves #3881, thanks to @psalvaggio-dl for providing a repro and doing the research for a fix.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.