[issue-388] Update CLI tools for the new parsers/writers #401
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
armintaenzertng
force-pushed
the
newCLI
branch
from
0f12d02
to
454b68f
Compare
armintaenzertng
force-pushed
the
refactor-python-tools
branch
from
48c4e72
to
5eb63e4
Compare
Signed-off-by: Armin Tänzer <armin.taenzer@tngtech.com>
Signed-off-by: Armin Tänzer <armin.taenzer@tngtech.com>
Signed-off-by: Armin Tänzer <armin.taenzer@tngtech.com>
Signed-off-by: Armin Tänzer <armin.taenzer@tngtech.com>
Signed-off-by: Armin Tänzer <armin.taenzer@tngtech.com>
armintaenzertng
force-pushed
the
newCLI
branch
from
454b68f
to
ca81a12
Compare
maxhbr
reviewed
Jan 3, 2023
src/formats.py
Outdated
| YAML = auto() | ||
| XML = auto() | ||
| TAG_VALUE = auto() | ||
| RDF = auto() |
There was a problem hiding this comment.
We use these interchangeably, but RDF_XML is more precise, I guess. Fixed.
src/clitools/parser.py
Outdated
| if validate: | ||
| validation_messages: List[ValidationMessage] = validate_full_spdx_document(document, version) | ||
| if validation_messages: | ||
| print("The document is invalid. The following issues have been found:") |
There was a problem hiding this comment.
If not valid, the cli should exit with 1
There was a problem hiding this comment.
Parser and converter have been merged into a single tool.
src/clitools/parser.py
Outdated
| print("Please note that this project is currently undergoing a major refactoring and therefore missing " | ||
| "a few features which will be added in time.\n" | ||
| "In the meanwhile, please use the current PyPI release version 0.7.0.") | ||
| return |
There was a problem hiding this comment.
in case of error, it should also exit with 1
There was a problem hiding this comment.
Parser and converter have been merged into a single tool.
src/clitools/parser.py
Outdated
| document: Document = parse_file(file) | ||
| except NotImplementedError as err: | ||
| print(err.args[0]) | ||
| print("Please note that this project is currently undergoing a major refactoring and therefore missing " |
src/clitools/convertor.py
Outdated
| write_file(document, outfile) | ||
| except NotImplementedError as err: | ||
| print(err.args[0]) | ||
| print("Please note that this project is currently undergoing a major refactoring and therefore missing " |
There was a problem hiding this comment.
also here: on error exit with code 1
src/clitools/parser.py
Outdated
| def main(file, force): | ||
| @click.option("--version", prompt="SPDX version", help="The SPDX version to be used during validation") | ||
| @click.option("--validate", is_flag=True, help="validate the provided document") | ||
| @click.option("--printout", is_flag=True, help="print the parsed document to stdout in tag-value format") |
There was a problem hiding this comment.
this is a pure debug option?
An often seen convention, to print to stdout, is to use the argument -. So -o - implies output is stdout.
src/clitools/parser.py
Outdated
| @click.option("--version", prompt="SPDX version", help="The SPDX version to be used during validation") | ||
| @click.option("--validate", is_flag=True, help="validate the provided document") | ||
| @click.option("--printout", is_flag=True, help="print the parsed document to stdout in tag-value format") | ||
| def main(file, version, validate, printout): |
There was a problem hiding this comment.
why is there a parser and a converter? I think they both could be the same tool.
There was a problem hiding this comment.
Parser and converter have been merged into a single tool.
Signed-off-by: Armin Tänzer <armin.taenzer@tngtech.com>
…the README Signed-off-by: Armin Tänzer <armin.taenzer@tngtech.com>
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.
fixes #388
parsing output uses the tag-value writer to output to stdout