Support annotations on pip packages with extras. #865
Merged
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
E.g., the following requirement: ``` requests[security]>=2.8.1 ``` This is handled correctly by all of the other plumbing, but trying to add an annotation to `requests` will fail. This is because annotations have separate logic for parsing requirements in the generated .bzl file. It would previously turn the requirement into `requests[security]` rather than just `requests`.
william-smith-skydio
requested review from
brandjon,
lberki and
thundergolfer
as code owners
william-smith-skydio
force-pushed
the
annotation_extras_fix
branch
from
7b76c3b
to
e4821e6
Compare
f0rmiga
requested review from
hrfuller
and removed request for
brandjon,
lberki and
thundergolfer
hrfuller
approved these changes
Nov 4, 2022
There was a problem hiding this comment.
LGTM as well. IIRC the requirement strings come from the requirements lock file. Ideal the lock file should have "simple" requirement strings and then extras should just be on their own lines in the lock file. Given that pip_compile doesn't work like that this seems like the best solution.
ianpegg-bc
pushed a commit
to ianpegg-bc/rules_python
that referenced
this pull request
May 12, 2023
* Support annotations on pip packages with extras. E.g., the following requirement: ``` requests[security]>=2.8.1 ``` This is handled correctly by all of the other plumbing, but trying to add an annotation to `requests` will fail. This is because annotations have separate logic for parsing requirements in the generated .bzl file. It would previously turn the requirement into `requests[security]` rather than just `requests`. * Add test verifying that annotations work for packages with extras.
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
When using
pip_parsewith packages with extras, e.g.requests[security]>=2.8.1, it is not possible to add annotations. Therequestspackage will otherwise work correctly, but trying to add an annotation torequestswill not result in the annotation actually being applied. This is because annotations have separate logic for parsing requirements in the generated .bzl file. It would previously turn the requirement intorequests[security]rather than justrequestsand fail to match, as justrequestsis expected.What is the new behavior?
The custom parsing logic has been changed to support extras, e.g.
requests[security]>=2.8.1.Does this PR introduce a breaking change?
Other information