Implement --json flag for compact machine-readable output - #42
Merged
Conversation
The --json flag was parsed but never read — _print always emitted
indented JSON. When --json is passed, output is now compact minified
JSON (separators=(',',':')) suitable for piping to jq or scripts.
Without the flag, output remains indented as before.
Closes #27.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
The
--jsonflag (historian/cli.py) was parsed intoargs.as_jsonbut never referenced —_print()always emitted indented JSON withindent=2. This was dead code from a planned feature that was never wired up.Changes
historian/cli.py: Added a module-level_compact_jsonflag set fromargs.as_jsoninmain()._print()now outputs compact minified JSON (separators=(",", ":"), no indentation) when--jsonis passed, and indented JSON (indent=2) otherwise. Added a help string to the--jsonargument.tests/test_cli.py: Two new tests:test_default_output_is_indented— verifies default output has newlines and indentation.test_json_flag_produces_compact_output— verifies--jsonproduces single-line minified JSON.Closes #27.
Test commands run
All 84 tests pass; compile check clean.