Implement a --group flag for dependency-group parsing for pip-compile
#2175
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
Define the option, but don't implement any behavior other than parsing yet. This is defined very similarly to `--group` for `pip` commands, but allows for a double-colon as a delimiter, rather than requiring only one.
Import and adapt the dependency-groups support code from within pip, for use in the pip-compile CLI context.
When parsing `--group` inputs, use a custom type to record the input argument value. This allows the writer to more accurately reproduce the input command as part of the output.
And apply fixes and changes as required. Tests include a simple positive test case and a number of error checking cases for different scenarios. Minor fixes to output are needed and `--group` is treated as an alternative to having a source file when determining whether or not sufficient input options were given.
10 tasks
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.
Resolves #2062 1
This is an initial proposed implementation, but even after finishing it, I have two major outstanding questions.
Q1: Should
--groupbe considered a source file?I didn't merge parsed
--groupinputs intosrc_files, but I did countlen(src_files) + len(groups)in a couple of contexts to make it behave similarly.I'm not sure if this was the right approach, or if I missed or misunderstood the goals of the
src_fileschecking in any way.Extra attention in this area during review would be appreciated -- as a new contributor, I did my best to follow the existing code and keep the changes small, but may have made mistakes.
Q2: What tests are missing?
The iniital tests are pretty simple and limited. Probably, more tests would be worthwhile, but it's hard to tell what cases would be useful vs redundant with existing tests.
What additional checks seem important?
Note: Accepts
pyproject.toml:Xandpyproject.toml::XBoth
:and::syntax are accepted, noted in helptext with double-:as[pyproject-path::]groupname.I decided on this after weighing the options from #2062 and would be willing to adjust if there's a strong objection, but think this is the best approach.
pip-compilecan have its own syntax, but accepting thepip installsyntax is an easy gain for compatibility.Because the filename part is already optional, the behavior which handles output of options also naturally handles the
:vs::variation.Commits
--grouptopip-compileoptionsChecklists
Contributor checklist
Maintainer checklist
backwards incompatible,feature,enhancement,deprecation,bug,dependency,docsorskip-changelogas they determine changelog listing.Footnotes
Aside: sorry it took so long to submit a PR! This has been on my to-do list for a while. ↩