src: Add compact JSON to Printer #22697
Open
+20
−5
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
Venefilyn
added
the
no-test
Venefilyn
force-pushed
the
src/misc-print-compact
branch
from
13f534c to
caed9bb
Compare
jelly
reviewed
Dec 18, 2025
Member
jelly
left a comment
jelly
left a comment
There was a problem hiding this comment.
If you go to the effort add pretty printing why not add a flag for it for the cli? I assume you want to pretty print:
PYTHONPATH=src python3 -m cockpit.misc.print open echo channel=x
And you can't use jq because it emits Cockpit protocol frames.
| """Send a json message (built from **kwargs) on a channel""" | ||
| self.data(channel, json.dumps(kwargs, indent=2).encode() + b'\n') | ||
| # Cockpit expect JSON values to be compact, otherwise it won't parse it correctly | ||
| params: Any = {"separators": None, "indent": None} |
Member
There was a problem hiding this comment.
Nitpick/hint, we have JsonObject in Python
Member
Author
There was a problem hiding this comment.
Doesn't pass local checks due to params["key"] assignment below
Argument of type "tuple[Literal[','], Literal[':']]" cannot be assigned to parameter "value" of type "None" in function "__setitem__"
"tuple[Literal[','], Literal[':']]" is not assignable to "None"PylancereportArgumentType
src/cockpit/misc/print.py
Outdated
| ) -> None: | ||
| """Send a json message (built from **kwargs) on a channel""" | ||
| self.data(channel, json.dumps(kwargs, indent=2).encode() + b'\n') | ||
| # Cockpit expect JSON values to be compact, otherwise it won't parse it correctly |
Member
There was a problem hiding this comment.
Is that true?
PYTHONPATH=src python3 -m cockpit.misc.print open echo channel=x : data x "b'foo'" : done x | PYTHONPATH=src python3 -m cockpit.bridge
Works fine with indent is 40, we also don't set separators by default so they are (',', ': '). So you can simplify this by just making it pretty print more indented but that doesn't seem to change too much
Member
Author
There was a problem hiding this comment.
It is true when it comes to authorize specifically
Member
Author
There was a problem hiding this comment.
Improved the comment a bit
By default the printer now outputs compact JSON which is more aligned with what is expected of Cockpit. When using `control` it will now print it compact by default. This can be changed by using `--pretty-json` argument. Signed-off-by: Freya Gustavsson <[email protected]>
Venefilyn
force-pushed
the
src/misc-print-compact
branch
from
caed9bb to
270ad58
Compare
Member
Author
|
Added 📦[spytec@cockpit]~/projects/cockpit/cockpit% PYTHONPATH=src python3 -m cockpit.misc.print control authorize cookie="session26151766064575" response="Basic YWRtaW46Zm9vYmFy"
51
{"command":"init","host":"localhost","version":1}
94
{"command":"authorize","cookie":"session26151766064575","response":"Basic YWRtaW46Zm9vYmFy"}
📦[spytec@cockpit]~/projects/cockpit/cockpit% PYTHONPATH=src python3 -m cockpit.misc.print --pretty-json control authorize cookie="session26151766064575" response="Basic YWRtaW46Zm9vYmFy"
70
{
"command": "init",
"host": "localhost",
"version": 1
}
113
{
"command": "authorize",
"cookie": "session26151766064575",
"response": "Basic YWRtaW46Zm9vYmFy"
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
By default the printer now outputs compact JSON which is more aligned
with what is expected of Cockpit. When using
controlit will now printit compact by default.
Signed-off-by: Freya Gustavsson [email protected]