[Feat]: Add lint-requirements command #545
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
paradigm
reviewed
Feb 7, 2025
paradigm
reviewed
Feb 7, 2025
|
This LGTM |
dhellmann
reviewed
Feb 7, 2025
rd4398
force-pushed
the
lint-reqs-cmd
branch
from
829b8ab to
d03eb08
Compare
rd4398
force-pushed
the
lint-reqs-cmd
branch
from
501bd62 to
5e76d8a
Compare
dhellmann
reviewed
Feb 10, 2025
|
|
||
| # Get all the files to check in a list | ||
| files_to_check = list( | ||
| itertools.chain.from_iterable(glob.glob(path) for path in input_files_path) |
There was a problem hiding this comment.
By the time the linter is invoked, the shell will have expanded the wildcard for us, so we don't need this glob call.
dhellmann
reviewed
Feb 10, 2025
|
|
||
| @click.command() | ||
| @click.argument("input_files_path", nargs=-1, type=click.Path(exists=False)) | ||
| def lint_requirements(input_files_path: str) -> None: |
There was a problem hiding this comment.
Suggested change
| def lint_requirements(input_files_path: str) -> None: | |
| def lint_requirements(input_files_path: list[click.Path]) -> None: |
rd4398
force-pushed
the
lint-reqs-cmd
branch
from
7caf39f to
2ada5b7
Compare
rd4398
commented
Feb 10, 2025
| flag = True | ||
|
|
||
| for path in input_files_path: | ||
| parsed_lines = requirements_file.parse_requirements_file(str(path)) |
There was a problem hiding this comment.
We need to convert this to string because the function parse_requirements_file only accepts str | pathlib.Path
There was a problem hiding this comment.
This is fine. For future reference, https://github.com/python-wheel-build/fromager/blob/main/src/fromager/clickext.py#L10 defines a class that can convert click.Path() to pathlib.Path(). We use that in a few other places.
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.
This commit adds the
lint-requirementscommand to fromager.This command can be used to check the formatting of
requirements.txtandconstraints.txtalong with the entries in these files being valid or not.The command can process multiple files at the same time.
Usage:
fromager lint-requirements "path/to/constraints.txt" "path/to/requirements.txt"Signed-off by Rohan Devasthale