Add the --format option with 'text' and 'ndjson' #11
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
The CLI now offers a new `--format` option that supports the following formats: - `text` - `ndjson` The `text` format renders the result using tables. This is the default format. The `ndjson` format renders the result as JSON objects separated by a "\n". This is useful for using the data with other tools. *** The `Result` classes now must support a `ndjson()` method alongside the current `str()` method. The `ndjson()` method must return an NDJSON representation of the data. We added a new `result.render()` function for the `cli` module. This the function will take care of calling the proper method on the `Result` object, according to the `format` argument. refs: #7
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.
Motivation
The CLI now offers a new
--formatoption that supports the following formats:textndjsonThe
textformat renders the result using tables. This is the default format.The
ndjsonformat renders the result as JSON objects separated by a "\n". This is useful for using the data with other tools.Change description
The
Resultclasses now must support andjson()method alongside the currentstr()method. Thendjson()method must return an NDJSON representation of the data.We added a new
result.render()function for theclimodule. This the function will take care of calling the proper method on theResultobject, according to theformatargument.Additional Notes
Reviewer checklist
main.README.md, if needed).CONTRIBUTING.md) and are well-formatted.