r.info: Output comments as one string in JSON #4216
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
The part of history which appears under the comments key can be multiple lines and is stored in a format which limits line length. This is basically how r.info shows it by default in the plain output for humans. Long lines can be split and continuation is marked using a backslash. This adds a function which puts the continued lines back together and adds newlines between the other lines. There is no newline at the end. This string is then serialized in JSON instead of the original list of strings. This also avoids serializing the history twice when the h flag is not used, but it does change the behavior for what keys are included.
github-actions
bot
added
raster
|
I assume that following #4304, I should replace strcat by G_strlcat here, no? |
I think that would be good, and replace |
|
Nice. I just noticed that the parsed history may contain empty lines. See e.g.: No problem, but probably worth removing? |
|
Why to remove the empty line? That's what was stored. Why to remove it? See the results with this PR: $ grass-dev ~/grassdata/nc_spm_08_grass7/ --tmp-mapset --exec python>>> import grass.script as gs
>>> import json
>>> print(json.loads(gs.read_command("r.info", format="json", map="basin_50K"))["comments"])
Processing mode: All in RAM
r.watershed elevation="elevation" threshold=50000 accumulation="accum_50K" drainage="draindir_50K" basin="basin_50K"
>>> print(gs.parse_command("r.info", format="json", map="basin_50K")["comments"])
Processing mode: All in RAM
r.watershed elevation="elevation" threshold=50000 accumulation="accum_50K" drainage="draindir_50K" basin="basin_50K" |
|
What do you think about showing it in JSON just as it is stored in terms of newlines? Can you review this @ninsbl? |
ninsbl
approved these changes
Dec 31, 2024
8 tasks
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.
The part of history which appears under the comments key can be multiple lines and is stored in a format which limits line length. This is basically how r.info shows it by default in the plain output for humans. Long lines can be split and continuation is marked using a backslash.
This adds a function which puts the continued lines back together and adds newlines between the other lines. There is no newline at the end. This string is then serialized in JSON instead of the original list of strings.
This also avoids serializing the history twice when the h flag is not used, but it does change the behavior for what keys are included.