logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

info.py (9177B)

    

  1. """Keyboard information script.
  3. Compile an info.json for a particular keyboard and pretty-print it.
  4. """
  5. import sys
  6. import json
  8. from milc import cli
  10. from qmk.json_encoders import InfoJSONEncoder
  11. from qmk.constants import COL_LETTERS, ROW_LETTERS
  12. from qmk.decorators import automagic_keyboard, automagic_keymap
  13. from qmk.keyboard import keyboard_completer, keyboard_folder, render_layouts, render_layout, rules_mk
  14. from qmk.info import info_json, keymap_json
  15. from qmk.keymap import locate_keymap
  16. from qmk.path import is_keyboard
  18. UNICODE_SUPPORT = sys.stdout.encoding.lower().startswith('utf')
  21. def _strip_api_content(info_json):
  22.     # Ideally this would only be added in the API pathway.
  23.     info_json.pop('platform', None)
  24.     info_json.pop('platform_key', None)
  25.     info_json.pop('processor_type', None)
  26.     info_json.pop('protocol', None)
  27.     info_json.pop('config_h_features', None)
  28.     info_json.pop('keymaps', None)
  29.     info_json.pop('keyboard_folder', None)
  30.     info_json.pop('parse_errors', None)
  31.     info_json.pop('parse_warnings', None)
  33.     for layout in info_json.get('layouts', {}).values():
  34.         layout.pop('filename', None)
  35.         layout.pop('c_macro', None)
  36.         layout.pop('json_layout', None)
  38.     if 'matrix_pins' in info_json:
  39.         info_json.pop('matrix_size', None)
  41.     for feature in ['rgb_matrix', 'led_matrix']:
  42.         if info_json.get(feature, {}).get("layout", None):
  43.             info_json[feature].pop('led_count', None)
  45.     return info_json
  48. def show_keymap(kb_info_json, title_caps=True):
  49.     """Render the keymap in ascii art.
  50.     """
  51.     keymap_path = locate_keymap(cli.config.info.keyboard, cli.config.info.keymap)
  53.     if keymap_path and keymap_path.suffix == '.json':
  54.         keymap_data = json.load(keymap_path.open(encoding='utf-8'))
  56.         # cater for layout-less keymap.json
  57.         if 'layout' not in keymap_data:
  58.             return
  60.         layout_name = keymap_data['layout']
  61.         layout_name = kb_info_json.get('layout_aliases', {}).get(layout_name, layout_name)  # Resolve alias names
  63.         for layer_num, layer in enumerate(keymap_data['layers']):
  64.             if title_caps:
  65.                 cli.echo('{fg_cyan}Keymap %s Layer %s{fg_reset}:', cli.config.info.keymap, layer_num)
  66.             else:
  67.                 cli.echo('{fg_cyan}keymap.%s.layer.%s{fg_reset}:', cli.config.info.keymap, layer_num)
  69.             print(render_layout(kb_info_json['layouts'][layout_name]['layout'], cli.config.info.ascii, layer))
  72. def show_layouts(kb_info_json, title_caps=True):
  73.     """Render the layouts with info.json labels.
  74.     """
  75.     for layout_name, layout_art in render_layouts(kb_info_json, cli.config.info.ascii).items():
  76.         title = f'Layout {layout_name.title()}' if title_caps else f'layouts.{layout_name}'
  77.         cli.echo('{fg_cyan}%s{fg_reset}:', title)
  78.         print(layout_art)  # Avoid passing dirty data to cli.echo()
  81. def show_matrix(kb_info_json, title_caps=True):
  82.     """Render the layout with matrix labels in ascii art.
  83.     """
  84.     for layout_name, layout in kb_info_json['layouts'].items():
  85.         # Build our label list
  86.         labels = []
  87.         for key in layout['layout']:
  88.             if 'matrix' in key:
  89.                 row = ROW_LETTERS[key['matrix'][0]]
  90.                 col = COL_LETTERS[key['matrix'][1]]
  92.                 labels.append(row + col)
  93.             else:
  94.                 labels.append('')
  96.         # Print the header
  97.         if title_caps:
  98.             cli.echo('{fg_blue}Matrix for "%s"{fg_reset}:', layout_name)
  99.         else:
  100.             cli.echo('{fg_blue}matrix_%s{fg_reset}:', layout_name)
  102.         print(render_layout(kb_info_json['layouts'][layout_name]['layout'], cli.config.info.ascii, labels))
  105. def print_friendly_output(kb_info_json):
  106.     """Print the info.json in a friendly text format.
  107.     """
  108.     cli.echo('{fg_blue}Keyboard Name{fg_reset}: %s', kb_info_json.get('keyboard_name', 'Unknown'))
  109.     cli.echo('{fg_blue}Manufacturer{fg_reset}: %s', kb_info_json.get('manufacturer', 'Unknown'))
  110.     if 'url' in kb_info_json:
  111.         cli.echo('{fg_blue}Website{fg_reset}: %s', kb_info_json.get('url', ''))
  112.     if kb_info_json.get('maintainer', 'qmk') == 'qmk':
  113.         cli.echo('{fg_blue}Maintainer{fg_reset}: QMK Community')
  114.     else:
  115.         cli.echo('{fg_blue}Maintainer{fg_reset}: %s', kb_info_json['maintainer'])
  116.     cli.echo('{fg_blue}Layouts{fg_reset}: %s', ', '.join(sorted(kb_info_json['layouts'].keys())))
  117.     cli.echo('{fg_blue}Processor{fg_reset}: %s', kb_info_json.get('processor', 'Unknown'))
  118.     cli.echo('{fg_blue}Bootloader{fg_reset}: %s', kb_info_json.get('bootloader', 'Unknown'))
  119.     if 'layout_aliases' in kb_info_json:
  120.         aliases = [f'{key}={value}' for key, value in kb_info_json['layout_aliases'].items()]
  121.         cli.echo('{fg_blue}Layout aliases:{fg_reset} %s' % (', '.join(aliases),))
  124. def print_text_output(kb_info_json):
  125.     """Print the info.json in a plain text format.
  126.     """
  127.     for key in sorted(kb_info_json):
  128.         if key == 'layouts':
  129.             cli.echo('{fg_blue}layouts{fg_reset}: %s', ', '.join(sorted(kb_info_json['layouts'].keys())))
  130.         else:
  131.             cli.echo('{fg_blue}%s{fg_reset}: %s', key, kb_info_json[key])
  133.     if cli.config.info.layouts:
  134.         show_layouts(kb_info_json, False)
  136.     if cli.config.info.matrix:
  137.         show_matrix(kb_info_json, False)
  139.     if cli.config_source.info.keymap and cli.config_source.info.keymap != 'config_file':
  140.         show_keymap(kb_info_json, False)
  143. def print_dotted_output(kb_info_json, prefix=''):
  144.     """Print the info.json in a plain text format with dot-joined keys.
  145.     """
  146.     for key in sorted(kb_info_json):
  147.         new_prefix = f'{prefix}.{key}' if prefix else key
  149.         if key in ['parse_errors', 'parse_warnings']:
  150.             continue
  151.         elif key == 'layouts' and prefix == '':
  152.             cli.echo('{fg_blue}layouts{fg_reset}: %s', ', '.join(sorted(kb_info_json['layouts'].keys())))
  153.         elif isinstance(kb_info_json[key], dict):
  154.             print_dotted_output(kb_info_json[key], new_prefix)
  155.         elif isinstance(kb_info_json[key], list):
  156.             cli.echo('{fg_blue}%s{fg_reset}: %s', new_prefix, ', '.join(map(str, sorted(kb_info_json[key]))))
  157.         else:
  158.             cli.echo('{fg_blue}%s{fg_reset}: %s', new_prefix, kb_info_json[key])
  161. def print_parsed_rules_mk(keyboard_name):
  162.     rules = rules_mk(keyboard_name)
  163.     for k in sorted(rules.keys()):
  164.         print('%s = %s' % (k, rules[k]))
  165.     return
  168. @cli.argument('-kb', '--keyboard', type=keyboard_folder, completer=keyboard_completer, help='Keyboard to show info for.')
  169. @cli.argument('-km', '--keymap', help='Keymap to show info for (Optional).')
  170. @cli.argument('-l', '--layouts', action='store_true', help='Render the layouts.')
  171. @cli.argument('-m', '--matrix', action='store_true', help='Render the layouts with matrix information.')
  172. @cli.argument('-f', '--format', default='friendly', arg_only=True, help='Format to display the data in (friendly, text, json) (Default: friendly).')
  173. @cli.argument('--ascii', action='store_true', default=not UNICODE_SUPPORT, help='Render layout box drawings in ASCII only.')
  174. @cli.argument('-r', '--rules-mk', action='store_true', help='Render the parsed values of the keyboard\'s rules.mk file.')
  175. @cli.argument('-a', '--api', action='store_true', help='Show fully processed info intended for API consumption.')
  176. @cli.subcommand('Keyboard information.')
  177. @automagic_keyboard
  178. @automagic_keymap
  179. def info(cli):
  180.     """Compile an info.json for a particular keyboard and pretty-print it.
  181.     """
  182.     # Determine our keyboard(s)
  183.     if not cli.config.info.keyboard:
  184.         cli.log.error('Missing parameter: --keyboard')
  185.         cli.subcommands['info'].print_help()
  186.         return False
  188.     if not is_keyboard(cli.config.info.keyboard):
  189.         cli.log.error('Invalid keyboard: "%s"', cli.config.info.keyboard)
  190.         return False
  192.     if bool(cli.args.rules_mk):
  193.         print_parsed_rules_mk(cli.config.info.keyboard)
  194.         return False
  196.     # default keymap stored in config file should be ignored
  197.     if cli.config_source.info.keymap == 'config_file':
  198.         cli.config_source.info.keymap = None
  200.     # Build the info.json file
  201.     if cli.config.info.keymap:
  202.         kb_info_json = keymap_json(cli.config.info.keyboard, cli.config.info.keymap)
  203.     else:
  204.         kb_info_json = info_json(cli.config.info.keyboard)
  206.     if not cli.args.api:
  207.         kb_info_json = _strip_api_content(kb_info_json)
  209.     # Output in the requested format
  210.     if cli.args.format == 'json':
  211.         print(json.dumps(kb_info_json, cls=InfoJSONEncoder, sort_keys=True))
  212.         return True
  213.     elif cli.args.format == 'text':
  214.         print_dotted_output(kb_info_json)
  215.         title_caps = False
  216.     elif cli.args.format == 'friendly':
  217.         print_friendly_output(kb_info_json)
  218.         title_caps = True
  219.     else:
  220.         cli.log.error('Unknown format: %s', cli.args.format)
  221.         return False
  223.     # Output requested extras
  224.     if cli.config.info.layouts:
  225.         show_layouts(kb_info_json, title_caps)
  227.     if cli.config.info.matrix:
  228.         show_matrix(kb_info_json, title_caps)
  230.     if cli.config.info.keymap:
  231.         show_keymap(kb_info_json, title_caps)