Always add the pip dependencies layer bin directory to PATH#232
Merged
Conversation
colincasey
approved these changes
Jul 29, 2024
Previously the `bin` directory would only be added to `PATH` if it existed (due to it being set by `lifecycle`), which is only the case if one of the installed dependencies has an entry point script, which causes Pip to create the `bin` directory and place a wrapper script inside it for that package's CLI command. This meant: 1. We had to suppress Pip's warning during install (since Pip isn't to know that the `PATH` will be correctly set later) 2. If an app has no dependencies with an entry-point (so the app image doesn't have a `bin` directory), then at run-time tries to pip install a new package that does have an entry point (eg when debugging), then that new script won't be on `PATH`. As such, we now add the `bin` directory to PATH explicitly, instead of relying on `lifecycle` automatic addition.
edmorley
changed the title
bin directory to PATHbin directory to PATH
This was referenced Aug 1, 2024
Merged
edmorley
changed the title
bin directory to PATHbin directory to 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.
Previously the
bindirectory would only be added toPATHif it existed (due to it being set bylifecycle), which is only the case if one of the installed dependencies has an entry point script, which causes pip to create thebindirectory and place a wrapper script inside it for that package's CLI command.This meant:
PATHwill be correctly set later)bindirectory), then at run-time tries to pip install a new package that does have an entry point (eg when debugging), then that new script won't be onPATH.As such, we now add the
bindirectory to PATH explicitly, instead of relying onlifecycleautomatic addition.GUS-W-16359285.