Fix generate-commands-json.py script (#14098) (#14111)

Close https://github.com/redis/redis/issues/14098
This is to handle some optional command docs fields, when the commands
belong to group module.
This commit is contained in:
h.o.t. neglected
2025-06-25 21:47:00 -04:00
committed by GitHub
parent a744411f27
commit a25f0a715e

View File

@@ -2,9 +2,9 @@
import argparse
import json
import os
import sys
import subprocess
from collections import OrderedDict
from sys import argv
def convert_flags_to_boolean_dict(flags):
@@ -69,9 +69,15 @@ def convert_entry_to_objects_array(cmd, docs):
# The command's value is ordered so the interesting stuff that we care about
# is at the start. Optional `None` and empty list values are filtered out.
value = OrderedDict()
value['summary'] = docs.pop('summary')
value['since'] = docs.pop('since')
value['group'] = docs.pop('group')
group = docs.pop('group')
if group == 'module':
set_if_not_none_or_empty(value, 'summary', docs.pop('summary', None))
set_if_not_none_or_empty(value, 'since', docs.pop('since', None))
else:
# "summary" and "since" are required for all non-module commands
value['summary'] = docs.pop('summary')
value['since'] = docs.pop('since')
value['group'] = group
set_if_not_none_or_empty(value, 'complexity', docs.pop('complexity', None))
set_if_not_none_or_empty(value, 'deprecated_since', docs.pop('deprecated_since', None))
set_if_not_none_or_empty(value, 'replaced_by', docs.pop('replaced_by', None))
@@ -103,7 +109,7 @@ srcdir = os.path.abspath(os.path.dirname(os.path.abspath(__file__)) + "/../src")
if __name__ == '__main__':
opts = {
'description': 'Transform the output from `redis-cli --json` using COMMAND and COMMAND DOCS to a single commands.json format.',
'epilog': f'Usage example: {argv[0]} --cli src/redis-cli --port 6379 > commands.json'
'epilog': f'Usage example: {sys.argv[0]} --cli src/redis-cli --port 6379 > commands.json'
}
parser = argparse.ArgumentParser(**opts)
parser.add_argument('--host', type=str, default='localhost')
@@ -133,4 +139,10 @@ if __name__ == '__main__':
name = list(cmd.keys())[0]
payload[name] = cmd[name]
print(json.dumps(payload, indent=4))
# Print the final JSON output. If the output is piped and the pipe is closed (e.g., by 'less' or 'head'),
# catch BrokenPipeError to prevent a traceback and exit gracefully.
try:
print(json.dumps(payload, indent=4))
except BrokenPipeError:
sys.stderr.close()
sys.exit(0)