diff options
Diffstat (limited to 'lib/python/qmk/cli')
| -rw-r--r-- | lib/python/qmk/cli/__init__.py | 1 | ||||
| -rwxr-xr-x | lib/python/qmk/cli/generate/make_dependencies.py | 3 | ||||
| -rw-r--r-- | lib/python/qmk/cli/new/keyboard.py | 20 | ||||
| -rw-r--r-- | lib/python/qmk/cli/painter/convert_graphics.py | 34 | ||||
| -rw-r--r-- | lib/python/qmk/cli/painter/make_font.py | 36 | ||||
| -rw-r--r-- | lib/python/qmk/cli/test/__init__.py | 0 | ||||
| -rw-r--r-- | lib/python/qmk/cli/test/c.py | 47 | 
7 files changed, 86 insertions, 55 deletions
| diff --git a/lib/python/qmk/cli/__init__.py b/lib/python/qmk/cli/__init__.py index e4a8166349..6d05a5fc21 100644 --- a/lib/python/qmk/cli/__init__.py +++ b/lib/python/qmk/cli/__init__.py @@ -81,6 +81,7 @@ subcommands = [      'qmk.cli.new.keymap',      'qmk.cli.painter',      'qmk.cli.pytest', +    'qmk.cli.test.c',      'qmk.cli.userspace.add',      'qmk.cli.userspace.compile',      'qmk.cli.userspace.doctor', diff --git a/lib/python/qmk/cli/generate/make_dependencies.py b/lib/python/qmk/cli/generate/make_dependencies.py index 9b695e907d..331132a20f 100755 --- a/lib/python/qmk/cli/generate/make_dependencies.py +++ b/lib/python/qmk/cli/generate/make_dependencies.py @@ -18,10 +18,11 @@ from qmk.path import normpath, FileType  @cli.argument('-km', '--keymap', completer=keymap_completer, help='The keymap to build a firmware for. Ignored when a configurator export is supplied.')  @cli.subcommand('Generates the list of dependencies associated with a keyboard build and its generated files.', hidden=True)  def generate_make_dependencies(cli): -    """Generates the list of dependent info.json, rules.mk, and config.h files for a keyboard. +    """Generates the list of dependent config files for a keyboard.      """      interesting_files = [          'info.json', +        'keyboard.json',          'rules.mk',          'post_rules.mk',          'config.h', diff --git a/lib/python/qmk/cli/new/keyboard.py b/lib/python/qmk/cli/new/keyboard.py index cb50acf8bb..37bf2923d6 100644 --- a/lib/python/qmk/cli/new/keyboard.py +++ b/lib/python/qmk/cli/new/keyboard.py @@ -74,6 +74,10 @@ def replace_placeholders(src, dest, tokens):      dest.write_text(content) +def replace_string(src, token, value): +    src.write_text(src.read_text().replace(token, value)) + +  def augment_community_info(src, dest):      """Splice in any additional data into info.json      """ @@ -218,6 +222,11 @@ def new_keyboard(cli):      else:          bootloader = select_default_bootloader(mcu) +    detach_layout = False +    if default_layout == 'none of the above': +        default_layout = "ortho_4x4" +        detach_layout = True +      tokens = {  # Comment here is to force multiline formatting          'YEAR': str(date.today().year),          'KEYBOARD': kb_name, @@ -233,10 +242,6 @@ def new_keyboard(cli):          for key, value in tokens.items():              cli.echo(f"    {key.ljust(10)}:   {value}") -    # TODO: detach community layout and rename to just "LAYOUT" -    if default_layout == 'none of the above': -        default_layout = "ortho_4x4" -      # begin with making the deepest folder in the tree      keymaps_path = keyboard(kb_name) / 'keymaps/'      keymaps_path.mkdir(parents=True) @@ -251,7 +256,12 @@ def new_keyboard(cli):      # merge in infos      community_info = Path(COMMUNITY / f'{default_layout}/info.json') -    augment_community_info(community_info, keyboard(kb_name) / community_info.name) +    augment_community_info(community_info, keyboard(kb_name) / 'keyboard.json') + +    # detach community layout and rename to just "LAYOUT" +    if detach_layout: +        replace_string(keyboard(kb_name) / 'keyboard.json', 'LAYOUT_ortho_4x4', 'LAYOUT') +        replace_string(keymaps_path / 'default/keymap.c', 'LAYOUT_ortho_4x4', 'LAYOUT')      cli.log.info(f'{{fg_green}}Created a new keyboard called {{fg_cyan}}{kb_name}{{fg_green}}.{{fg_reset}}')      cli.log.info(f"Build Command: {{fg_yellow}}qmk compile -kb {kb_name} -km default{{fg_reset}}.") diff --git a/lib/python/qmk/cli/painter/convert_graphics.py b/lib/python/qmk/cli/painter/convert_graphics.py index 2519c49b25..553c26aa5d 100644 --- a/lib/python/qmk/cli/painter/convert_graphics.py +++ b/lib/python/qmk/cli/painter/convert_graphics.py @@ -1,10 +1,8 @@  """This script tests QGF functionality.  """ -import re -import datetime  from io import BytesIO  from qmk.path import normpath -from qmk.painter import render_header, render_source, render_license, render_bytes, valid_formats +from qmk.painter import generate_subs, render_header, render_source, valid_formats  from milc import cli  from PIL import Image @@ -12,7 +10,7 @@ from PIL import Image  @cli.argument('-v', '--verbose', arg_only=True, action='store_true', help='Turns on verbose output.')  @cli.argument('-i', '--input', required=True, help='Specify input graphic file.')  @cli.argument('-o', '--output', default='', help='Specify output directory. Defaults to same directory as input.') [email protected]('-f', '--format', required=True, help='Output format, valid types: %s' % (', '.join(valid_formats.keys()))) [email protected]('-f', '--format', required=True, help=f'Output format, valid types: {", ".join(valid_formats.keys())}')  @cli.argument('-r', '--no-rle', arg_only=True, action='store_true', help='Disables the use of RLE when encoding images.')  @cli.argument('-d', '--no-deltas', arg_only=True, action='store_true', help='Disables the use of delta frames when encoding animations.')  @cli.argument('-w', '--raw', arg_only=True, action='store_true', help='Writes out the QGF file as raw data instead of c/h combo.') @@ -51,43 +49,31 @@ def painter_convert_graphics(cli):      # Convert the image to QGF using PIL      out_data = BytesIO() -    input_img.save(out_data, "QGF", use_deltas=(not cli.args.no_deltas), use_rle=(not cli.args.no_rle), qmk_format=format, verbose=cli.args.verbose) +    metadata = [] +    input_img.save(out_data, "QGF", use_deltas=(not cli.args.no_deltas), use_rle=(not cli.args.no_rle), qmk_format=format, verbose=cli.args.verbose, metadata=metadata)      out_bytes = out_data.getvalue()      if cli.args.raw: -        raw_file = cli.args.output / (cli.args.input.stem + ".qgf") +        raw_file = cli.args.output / f"{cli.args.input.stem}.qgf"          with open(raw_file, 'wb') as raw:              raw.write(out_bytes)          return      # Work out the text substitutions for rendering the output data -    subs = { -        'generated_type': 'image', -        'var_prefix': 'gfx', -        'generator_command': f'qmk painter-convert-graphics -i {cli.args.input.name} -f {cli.args.format}', -        'year': datetime.date.today().strftime("%Y"), -        'input_file': cli.args.input.name, -        'sane_name': re.sub(r"[^a-zA-Z0-9]", "_", cli.args.input.stem), -        'byte_count': len(out_bytes), -        'bytes_lines': render_bytes(out_bytes), -        'format': cli.args.format, -    } - -    # Render the license -    subs.update({'license': render_license(subs)}) +    args_str = " ".join((f"--{arg} {getattr(cli.args, arg.replace('-', '_'))}" for arg in ["input", "output", "format", "no-rle", "no-deltas"])) +    command = f"qmk painter-convert-graphics {args_str}" +    subs = generate_subs(cli, out_bytes, image_metadata=metadata, command=command)      # Render and write the header file      header_text = render_header(subs) -    header_file = cli.args.output / (cli.args.input.stem + ".qgf.h") +    header_file = cli.args.output / f"{cli.args.input.stem}.qgf.h"      with open(header_file, 'w') as header:          print(f"Writing {header_file}...")          header.write(header_text) -        header.close()      # Render and write the source file      source_text = render_source(subs) -    source_file = cli.args.output / (cli.args.input.stem + ".qgf.c") +    source_file = cli.args.output / f"{cli.args.input.stem}.qgf.c"      with open(source_file, 'w') as source:          print(f"Writing {source_file}...")          source.write(source_text) -        source.close() diff --git a/lib/python/qmk/cli/painter/make_font.py b/lib/python/qmk/cli/painter/make_font.py index c0189920d2..19db844931 100644 --- a/lib/python/qmk/cli/painter/make_font.py +++ b/lib/python/qmk/cli/painter/make_font.py @@ -1,12 +1,10 @@  """This script automates the conversion of font files into a format QMK firmware understands.  """ -import re -import datetime  from io import BytesIO  from qmk.path import normpath -from qmk.painter_qff import QFFFont -from qmk.painter import render_header, render_source, render_license, render_bytes, valid_formats +from qmk.painter_qff import _generate_font_glyphs_list, QFFFont +from qmk.painter import generate_subs, render_header, render_source, valid_formats  from milc import cli @@ -31,7 +29,7 @@ def painter_make_font_image(cli):  @cli.argument('-o', '--output', default='', help='Specify output directory. Defaults to same directory as input.')  @cli.argument('-n', '--no-ascii', arg_only=True, action='store_true', help='Disables output of the full ASCII character set (0x20..0x7E), exporting only the glyphs specified.')  @cli.argument('-u', '--unicode-glyphs', default='', help='Also generate the specified unicode glyphs.') [email protected]('-f', '--format', required=True, help='Output format, valid types: %s' % (', '.join(valid_formats.keys()))) [email protected]('-f', '--format', required=True, help=f'Output format, valid types: {", ".join(valid_formats.keys())}')  @cli.argument('-r', '--no-rle', arg_only=True, action='store_true', help='Disable the use of RLE to minimise converted image size.')  @cli.argument('-w', '--raw', arg_only=True, action='store_true', help='Writes out the QFF file as raw data instead of c/h combo.')  @cli.subcommand('Converts an input font image to something QMK firmware understands') @@ -53,43 +51,31 @@ def painter_convert_font_image(cli):      # Render out the data      out_data = BytesIO() -    font.save_to_qff(format, (False if cli.args.no_rle else True), out_data) +    font.save_to_qff(format, not cli.args.no_rle, out_data)      out_bytes = out_data.getvalue()      if cli.args.raw: -        raw_file = cli.args.output / (cli.args.input.stem + ".qff") +        raw_file = cli.args.output / f"{cli.args.input.stem}.qff"          with open(raw_file, 'wb') as raw:              raw.write(out_bytes)          return      # Work out the text substitutions for rendering the output data -    subs = { -        'generated_type': 'font', -        'var_prefix': 'font', -        'generator_command': f'qmk painter-convert-font-image -i {cli.args.input.name} -f {cli.args.format}', -        'year': datetime.date.today().strftime("%Y"), -        'input_file': cli.args.input.name, -        'sane_name': re.sub(r"[^a-zA-Z0-9]", "_", cli.args.input.stem), -        'byte_count': len(out_bytes), -        'bytes_lines': render_bytes(out_bytes), -        'format': cli.args.format, -    } - -    # Render the license -    subs.update({'license': render_license(subs)}) +    args_str = " ".join((f"--{arg} {getattr(cli.args, arg.replace('-', '_'))}" for arg in ["input", "output", "no-ascii", "unicode-glyphs", "format", "no-rle"])) +    command = f"qmk painter-convert-font-image {args_str}" +    metadata = {"glyphs": _generate_font_glyphs_list(not cli.args.no_ascii, cli.args.unicode_glyphs)} +    subs = generate_subs(cli, out_bytes, font_metadata=metadata, command=command)      # Render and write the header file      header_text = render_header(subs) -    header_file = cli.args.output / (cli.args.input.stem + ".qff.h") +    header_file = cli.args.output / f"{cli.args.input.stem}.qff.h"      with open(header_file, 'w') as header:          print(f"Writing {header_file}...")          header.write(header_text) -        header.close()      # Render and write the source file      source_text = render_source(subs) -    source_file = cli.args.output / (cli.args.input.stem + ".qff.c") +    source_file = cli.args.output / f"{cli.args.input.stem}.qff.c"      with open(source_file, 'w') as source:          print(f"Writing {source_file}...")          source.write(source_text) -        source.close() diff --git a/lib/python/qmk/cli/test/__init__.py b/lib/python/qmk/cli/test/__init__.py new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/lib/python/qmk/cli/test/__init__.py diff --git a/lib/python/qmk/cli/test/c.py b/lib/python/qmk/cli/test/c.py new file mode 100644 index 0000000000..7a4e20d5e6 --- /dev/null +++ b/lib/python/qmk/cli/test/c.py @@ -0,0 +1,47 @@ +import fnmatch +import re +from subprocess import DEVNULL + +from milc import cli + +from qmk.commands import find_make, get_make_parallel_args, build_environment + + [email protected]('-j', '--parallel', type=int, default=1, help="Set the number of parallel make jobs; 0 means unlimited.") [email protected]('-e', '--env', arg_only=True, action='append', default=[], help="Set a variable to be passed to make. May be passed multiple times.") [email protected]('-c', '--clean', arg_only=True, action='store_true', help="Remove object files before compiling.") [email protected]('-l', '--list', arg_only=True, action='store_true', help='List available tests.') [email protected]('-t', '--test', arg_only=True, action='append', default=[], help="Test to run from the available list. Supports wildcard globs. May be passed multiple times.") [email protected]("QMK C Unit Tests.", hidden=False if cli.config.user.developer else True) +def test_c(cli): +    """Run native unit tests. +    """ +    list_tests = cli.run([find_make(), 'list-tests', 'SILENT=true']) +    available_tests = sorted(list_tests.stdout.strip().split()) + +    if cli.args.list: +        return print("\n".join(available_tests)) + +    # expand any wildcards +    filtered_tests = set() +    for test in cli.args.test: +        regex = re.compile(fnmatch.translate(test)) +        filtered_tests |= set(filter(regex.match, available_tests)) + +    for invalid in filtered_tests - set(available_tests): +        cli.log.warning(f'Invalid test provided: {invalid}') + +    # convert test names to build targets +    targets = list(map(lambda x: f'test:{x}', filtered_tests or ['all'])) + +    if cli.args.clean: +        targets.insert(0, 'clean') + +    # Add in the environment vars +    for key, value in build_environment(cli.args.env).items(): +        targets.append(f'{key}={value}') + +    command = [find_make(), *get_make_parallel_args(cli.config.test_c.parallel), *targets] + +    cli.log.info('Compiling tests with {fg_cyan}%s', ' '.join(command)) +    return cli.run(command, capture_output=False, stdin=DEVNULL).returncode | 
