Fix qmk cli isues'
This commit is contained in:
0
keyboards/handwired/pytest/.noci
Normal file
0
keyboards/handwired/pytest/.noci
Normal file
0
keyboards/handwired/pytest/basic/.noci
Normal file
0
keyboards/handwired/pytest/basic/.noci
Normal file
9
keyboards/handwired/pytest/basic/info.json
Normal file
9
keyboards/handwired/pytest/basic/info.json
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"layouts": {
|
||||||
|
"LAYOUT_custom": {
|
||||||
|
"layout": [
|
||||||
|
{ "label": "KC_Q", "matrix": [0, 0], "w": 1, "x": 0, "y": 0 }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
#include QMK_KEYBOARD_H
|
||||||
|
|
||||||
|
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
||||||
|
LAYOUT_ortho_1x1(KC_A)
|
||||||
|
};
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"keyboard": "handwired/pytest/basic",
|
||||||
|
"keymap": "default_json",
|
||||||
|
"layout": "LAYOUT_ortho_1x1",
|
||||||
|
"layers": [["KC_A"]],
|
||||||
|
"author": "qmk",
|
||||||
|
"notes": "This file is a keymap.json file for handwired/pytest/basic",
|
||||||
|
"version": 1
|
||||||
|
}
|
||||||
0
keyboards/handwired/pytest/basic/readme.md
Normal file
0
keyboards/handwired/pytest/basic/readme.md
Normal file
1
keyboards/handwired/pytest/basic/rules.mk
Normal file
1
keyboards/handwired/pytest/basic/rules.mk
Normal file
@@ -0,0 +1 @@
|
|||||||
|
MCU = atmega32u4
|
||||||
11
keyboards/handwired/pytest/config.h
Normal file
11
keyboards/handwired/pytest/config.h
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include "config_common.h"
|
||||||
|
|
||||||
|
/* key matrix size */
|
||||||
|
#define MATRIX_ROWS 1
|
||||||
|
#define MATRIX_COLS 1
|
||||||
|
|
||||||
|
#define MATRIX_COL_PINS { F4 }
|
||||||
|
#define MATRIX_ROW_PINS { F5 }
|
||||||
|
#define DIODE_DIRECTION COL2ROW
|
||||||
0
keyboards/handwired/pytest/has_community/.noci
Normal file
0
keyboards/handwired/pytest/has_community/.noci
Normal file
0
keyboards/handwired/pytest/has_community/readme.md
Normal file
0
keyboards/handwired/pytest/has_community/readme.md
Normal file
3
keyboards/handwired/pytest/has_community/rules.mk
Normal file
3
keyboards/handwired/pytest/has_community/rules.mk
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
MCU = atmega32u4
|
||||||
|
|
||||||
|
LAYOUTS = ortho_1x1
|
||||||
0
keyboards/handwired/pytest/has_template/.noci
Normal file
0
keyboards/handwired/pytest/has_template/.noci
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
#include QMK_KEYBOARD_H
|
||||||
|
|
||||||
|
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
||||||
|
LAYOUT_ortho_1x1(KC_A)
|
||||||
|
};
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"keyboard": "handwired/pytest/has_template",
|
||||||
|
"keymap": "default_json",
|
||||||
|
"layout": "LAYOUT_ortho_1x1",
|
||||||
|
"layers": [["KC_A"]],
|
||||||
|
"author": "qmk",
|
||||||
|
"notes": "This file is a keymap.json file for handwired/pytest/has_template",
|
||||||
|
"version": 1
|
||||||
|
}
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
#include QMK_KEYBOARD_H
|
||||||
|
#include "audio.h"
|
||||||
|
|
||||||
|
/* THIS FILE WAS GENERATED AND IS EXPERIMENTAL!
|
||||||
|
*
|
||||||
|
* This file was generated by qmk-compile-json. You may or may not want to
|
||||||
|
* edit it directly.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
||||||
|
[0] = LAYOUT(KC_ENTER)
|
||||||
|
};
|
||||||
|
|
||||||
|
bool encoder_update_user(uint8_t index, bool clockwise) {
|
||||||
|
if (index == 0) {
|
||||||
|
if (clockwise) {
|
||||||
|
tap_code(KC_UP);
|
||||||
|
} else {
|
||||||
|
tap_code(KC_DOWN);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
};
|
||||||
0
keyboards/handwired/pytest/has_template/readme.md
Normal file
0
keyboards/handwired/pytest/has_template/readme.md
Normal file
1
keyboards/handwired/pytest/has_template/rules.mk
Normal file
1
keyboards/handwired/pytest/has_template/rules.mk
Normal file
@@ -0,0 +1 @@
|
|||||||
|
MCU = atmega32u4
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
#include QMK_KEYBOARD_H
|
||||||
|
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {__KEYMAP_GOES_HERE__};
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"documentation": "This file is a keymap.json file for handwired/pytest/has_template"
|
||||||
|
}
|
||||||
10
keyboards/handwired/pytest/info.json
Normal file
10
keyboards/handwired/pytest/info.json
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"keyboard_name": "pytest",
|
||||||
|
"manufacturer": "none",
|
||||||
|
"maintainer": "qmk",
|
||||||
|
"usb": {
|
||||||
|
"vid": "0xFEED",
|
||||||
|
"pid": "0x6465",
|
||||||
|
"device_ver": "0x0001"
|
||||||
|
}
|
||||||
|
}
|
||||||
0
keyboards/handwired/pytest/macro/.noci
Normal file
0
keyboards/handwired/pytest/macro/.noci
Normal file
10
keyboards/handwired/pytest/macro/info.json
Normal file
10
keyboards/handwired/pytest/macro/info.json
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"maintainer": "qmk",
|
||||||
|
"layouts": {
|
||||||
|
"LAYOUT_custom": {
|
||||||
|
"layout": [
|
||||||
|
{ "label": "KC_Q", "matrix": [0, 0], "w": 1, "x": 0, "y": 0 }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
15
keyboards/handwired/pytest/macro/keymaps/default/keymap.json
Normal file
15
keyboards/handwired/pytest/macro/keymaps/default/keymap.json
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
{
|
||||||
|
"keyboard": "handwired/pytest/basic",
|
||||||
|
"keymap": "default_json",
|
||||||
|
"layout": "LAYOUT_ortho_1x1",
|
||||||
|
"layers": [["MACRO_0"]],
|
||||||
|
"macros": [
|
||||||
|
[
|
||||||
|
"Hello, World!",
|
||||||
|
{"action":"tap", "keycodes":["ENTER"]}
|
||||||
|
]
|
||||||
|
],
|
||||||
|
"author": "qmk",
|
||||||
|
"notes": "This file is a keymap.json file for handwired/pytest/basic",
|
||||||
|
"version": 1
|
||||||
|
}
|
||||||
0
keyboards/handwired/pytest/macro/readme.md
Normal file
0
keyboards/handwired/pytest/macro/readme.md
Normal file
1
keyboards/handwired/pytest/macro/rules.mk
Normal file
1
keyboards/handwired/pytest/macro/rules.mk
Normal file
@@ -0,0 +1 @@
|
|||||||
|
MCU = atmega32u4
|
||||||
11
keyboards/handwired/pytest/pytest.h
Normal file
11
keyboards/handwired/pytest/pytest.h
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include "quantum.h"
|
||||||
|
|
||||||
|
#define LAYOUT_ortho_1x1( \
|
||||||
|
k00 \
|
||||||
|
) { \
|
||||||
|
{ k00 } \
|
||||||
|
}
|
||||||
|
|
||||||
|
#define LAYOUT LAYOUT_ortho_1x1
|
||||||
@@ -11,7 +11,7 @@ BOOTMAGIC_ENABLE = yes # Enable Bootmagic Lite
|
|||||||
MOUSEKEY_ENABLE = yes # Mouse keys
|
MOUSEKEY_ENABLE = yes # Mouse keys
|
||||||
EXTRAKEY_ENABLE = yes # Audio control and System control
|
EXTRAKEY_ENABLE = yes # Audio control and System control
|
||||||
CONSOLE_ENABLE = no # Console for debug
|
CONSOLE_ENABLE = no # Console for debug
|
||||||
COMMAND_ENABLE = no # Commands for debug and configuration
|
COMMAND_ENABLE = no # Commands for debug and configurationv
|
||||||
NKRO_ENABLE = yes # Enable N-Key Rollover
|
NKRO_ENABLE = yes # Enable N-Key Rollover
|
||||||
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
|
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
|
||||||
AUDIO_ENABLE = yes # Audio output
|
AUDIO_ENABLE = yes # Audio output
|
||||||
|
|||||||
@@ -1,778 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
# coding=utf-8
|
|
||||||
"""MILC - A CLI Framework
|
|
||||||
|
|
||||||
PYTHON_ARGCOMPLETE_OK
|
|
||||||
|
|
||||||
MILC is an opinionated framework for writing CLI apps. It optimizes for the
|
|
||||||
most common unix tool pattern- small tools that are run from the command
|
|
||||||
line but generally do not feature any user interaction while they run.
|
|
||||||
|
|
||||||
For more details see the MILC documentation:
|
|
||||||
|
|
||||||
<https://github.com/clueboard/milc/tree/master/docs>
|
|
||||||
"""
|
|
||||||
from __future__ import division, print_function, unicode_literals
|
|
||||||
import argparse
|
|
||||||
import logging
|
|
||||||
import os
|
|
||||||
import re
|
|
||||||
import shlex
|
|
||||||
import sys
|
|
||||||
from decimal import Decimal
|
|
||||||
from pathlib import Path
|
|
||||||
from tempfile import NamedTemporaryFile
|
|
||||||
from time import sleep
|
|
||||||
|
|
||||||
try:
|
|
||||||
from ConfigParser import RawConfigParser
|
|
||||||
except ImportError:
|
|
||||||
from configparser import RawConfigParser
|
|
||||||
|
|
||||||
try:
|
|
||||||
import thread
|
|
||||||
import threading
|
|
||||||
except ImportError:
|
|
||||||
thread = None
|
|
||||||
|
|
||||||
import argcomplete
|
|
||||||
import colorama
|
|
||||||
from appdirs import user_config_dir
|
|
||||||
|
|
||||||
# Disable logging until we can configure it how the user wants
|
|
||||||
logging.basicConfig(stream=os.devnull)
|
|
||||||
|
|
||||||
# Log Level Representations
|
|
||||||
EMOJI_LOGLEVELS = {
|
|
||||||
'CRITICAL': '{bg_red}{fg_white}¬_¬{style_reset_all}',
|
|
||||||
'ERROR': '{fg_red}☒{style_reset_all}',
|
|
||||||
'WARNING': '{fg_yellow}⚠{style_reset_all}',
|
|
||||||
'INFO': '{fg_blue}ℹ{style_reset_all}',
|
|
||||||
'DEBUG': '{fg_cyan}☐{style_reset_all}',
|
|
||||||
'NOTSET': '{style_reset_all}¯\\_(o_o)_/¯'
|
|
||||||
}
|
|
||||||
EMOJI_LOGLEVELS['FATAL'] = EMOJI_LOGLEVELS['CRITICAL']
|
|
||||||
EMOJI_LOGLEVELS['WARN'] = EMOJI_LOGLEVELS['WARNING']
|
|
||||||
UNICODE_SUPPORT = sys.stdout.encoding.lower().startswith('utf')
|
|
||||||
|
|
||||||
# ANSI Color setup
|
|
||||||
# Regex was gratefully borrowed from kfir on stackoverflow:
|
|
||||||
# https://stackoverflow.com/a/45448194
|
|
||||||
ansi_regex = r'\x1b(' \
|
|
||||||
r'(\[\??\d+[hl])|' \
|
|
||||||
r'([=<>a-kzNM78])|' \
|
|
||||||
r'([\(\)][a-b0-2])|' \
|
|
||||||
r'(\[\d{0,2}[ma-dgkjqi])|' \
|
|
||||||
r'(\[\d+;\d+[hfy]?)|' \
|
|
||||||
r'(\[;?[hf])|' \
|
|
||||||
r'(#[3-68])|' \
|
|
||||||
r'([01356]n)|' \
|
|
||||||
r'(O[mlnp-z]?)|' \
|
|
||||||
r'(/Z)|' \
|
|
||||||
r'(\d+)|' \
|
|
||||||
r'(\[\?\d;\d0c)|' \
|
|
||||||
r'(\d;\dR))'
|
|
||||||
ansi_escape = re.compile(ansi_regex, flags=re.IGNORECASE)
|
|
||||||
ansi_styles = (
|
|
||||||
('fg', colorama.ansi.AnsiFore()),
|
|
||||||
('bg', colorama.ansi.AnsiBack()),
|
|
||||||
('style', colorama.ansi.AnsiStyle()),
|
|
||||||
)
|
|
||||||
ansi_colors = {}
|
|
||||||
|
|
||||||
for prefix, obj in ansi_styles:
|
|
||||||
for color in [x for x in obj.__dict__ if not x.startswith('_')]:
|
|
||||||
ansi_colors[prefix + '_' + color.lower()] = getattr(obj, color)
|
|
||||||
|
|
||||||
|
|
||||||
def format_ansi(text):
|
|
||||||
"""Return a copy of text with certain strings replaced with ansi.
|
|
||||||
"""
|
|
||||||
# Avoid .format() so we don't have to worry about the log content
|
|
||||||
for color in ansi_colors:
|
|
||||||
text = text.replace('{%s}' % color, ansi_colors[color])
|
|
||||||
return text + ansi_colors['style_reset_all']
|
|
||||||
|
|
||||||
|
|
||||||
class ANSIFormatter(logging.Formatter):
|
|
||||||
"""A log formatter that inserts ANSI color.
|
|
||||||
"""
|
|
||||||
def format(self, record):
|
|
||||||
msg = super(ANSIFormatter, self).format(record)
|
|
||||||
return format_ansi(msg)
|
|
||||||
|
|
||||||
|
|
||||||
class ANSIEmojiLoglevelFormatter(ANSIFormatter):
|
|
||||||
"""A log formatter that makes the loglevel an emoji on UTF capable terminals.
|
|
||||||
"""
|
|
||||||
def format(self, record):
|
|
||||||
if UNICODE_SUPPORT:
|
|
||||||
record.levelname = EMOJI_LOGLEVELS[record.levelname].format(**ansi_colors)
|
|
||||||
return super(ANSIEmojiLoglevelFormatter, self).format(record)
|
|
||||||
|
|
||||||
|
|
||||||
class ANSIStrippingFormatter(ANSIFormatter):
|
|
||||||
"""A log formatter that strips ANSI.
|
|
||||||
"""
|
|
||||||
def format(self, record):
|
|
||||||
msg = super(ANSIStrippingFormatter, self).format(record)
|
|
||||||
return ansi_escape.sub('', msg)
|
|
||||||
|
|
||||||
|
|
||||||
class Configuration(object):
|
|
||||||
"""Represents the running configuration.
|
|
||||||
|
|
||||||
This class never raises IndexError, instead it will return None if a
|
|
||||||
section or option does not yet exist.
|
|
||||||
"""
|
|
||||||
def __contains__(self, key):
|
|
||||||
return self._config.__contains__(key)
|
|
||||||
|
|
||||||
def __iter__(self):
|
|
||||||
return self._config.__iter__()
|
|
||||||
|
|
||||||
def __len__(self):
|
|
||||||
return self._config.__len__()
|
|
||||||
|
|
||||||
def __repr__(self):
|
|
||||||
return self._config.__repr__()
|
|
||||||
|
|
||||||
def keys(self):
|
|
||||||
return self._config.keys()
|
|
||||||
|
|
||||||
def items(self):
|
|
||||||
return self._config.items()
|
|
||||||
|
|
||||||
def values(self):
|
|
||||||
return self._config.values()
|
|
||||||
|
|
||||||
def __init__(self, *args, **kwargs):
|
|
||||||
self._config = {}
|
|
||||||
|
|
||||||
def __getattr__(self, key):
|
|
||||||
return self.__getitem__(key)
|
|
||||||
|
|
||||||
def __getitem__(self, key):
|
|
||||||
"""Returns a config section, creating it if it doesn't exist yet.
|
|
||||||
"""
|
|
||||||
if key not in self._config:
|
|
||||||
self.__dict__[key] = self._config[key] = ConfigurationSection(self)
|
|
||||||
|
|
||||||
return self._config[key]
|
|
||||||
|
|
||||||
def __setitem__(self, key, value):
|
|
||||||
self.__dict__[key] = value
|
|
||||||
self._config[key] = value
|
|
||||||
|
|
||||||
def __delitem__(self, key):
|
|
||||||
if key in self.__dict__ and key[0] != '_':
|
|
||||||
del self.__dict__[key]
|
|
||||||
if key in self._config:
|
|
||||||
del self._config[key]
|
|
||||||
|
|
||||||
|
|
||||||
class ConfigurationSection(Configuration):
|
|
||||||
def __init__(self, parent, *args, **kwargs):
|
|
||||||
super(ConfigurationSection, self).__init__(*args, **kwargs)
|
|
||||||
self.parent = parent
|
|
||||||
|
|
||||||
def __getitem__(self, key):
|
|
||||||
"""Returns a config value, pulling from the `user` section as a fallback.
|
|
||||||
This is called when the attribute is accessed either via the get method or through [ ] index.
|
|
||||||
"""
|
|
||||||
if key in self._config and self._config.get(key) is not None:
|
|
||||||
return self._config[key]
|
|
||||||
|
|
||||||
elif key in self.parent.user:
|
|
||||||
return self.parent.user[key]
|
|
||||||
|
|
||||||
return None
|
|
||||||
|
|
||||||
def __getattr__(self, key):
|
|
||||||
"""Returns the config value from the `user` section.
|
|
||||||
This is called when the attribute is accessed via dot notation but does not exists.
|
|
||||||
"""
|
|
||||||
if key in self.parent.user:
|
|
||||||
return self.parent.user[key]
|
|
||||||
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
def handle_store_boolean(self, *args, **kwargs):
|
|
||||||
"""Does the add_argument for action='store_boolean'.
|
|
||||||
"""
|
|
||||||
disabled_args = None
|
|
||||||
disabled_kwargs = kwargs.copy()
|
|
||||||
disabled_kwargs['action'] = 'store_false'
|
|
||||||
disabled_kwargs['dest'] = self.get_argument_name(*args, **kwargs)
|
|
||||||
disabled_kwargs['help'] = 'Disable ' + kwargs['help']
|
|
||||||
kwargs['action'] = 'store_true'
|
|
||||||
kwargs['help'] = 'Enable ' + kwargs['help']
|
|
||||||
|
|
||||||
for flag in args:
|
|
||||||
if flag[:2] == '--':
|
|
||||||
disabled_args = ('--no-' + flag[2:],)
|
|
||||||
break
|
|
||||||
|
|
||||||
self.add_argument(*args, **kwargs)
|
|
||||||
self.add_argument(*disabled_args, **disabled_kwargs)
|
|
||||||
|
|
||||||
return (args, kwargs, disabled_args, disabled_kwargs)
|
|
||||||
|
|
||||||
|
|
||||||
class SubparserWrapper(object):
|
|
||||||
"""Wrap subparsers so we can track what options the user passed.
|
|
||||||
"""
|
|
||||||
def __init__(self, cli, submodule, subparser):
|
|
||||||
self.cli = cli
|
|
||||||
self.submodule = submodule
|
|
||||||
self.subparser = subparser
|
|
||||||
|
|
||||||
for attr in dir(subparser):
|
|
||||||
if not hasattr(self, attr):
|
|
||||||
setattr(self, attr, getattr(subparser, attr))
|
|
||||||
|
|
||||||
def completer(self, completer):
|
|
||||||
"""Add an arpcomplete completer to this subcommand.
|
|
||||||
"""
|
|
||||||
self.subparser.completer = completer
|
|
||||||
|
|
||||||
def add_argument(self, *args, **kwargs):
|
|
||||||
"""Add an argument for this subcommand.
|
|
||||||
|
|
||||||
This also stores the default for the argument in `self.cli.default_arguments`.
|
|
||||||
"""
|
|
||||||
if kwargs.get('action') == 'store_boolean':
|
|
||||||
# Store boolean will call us again with the enable/disable flag arguments
|
|
||||||
return handle_store_boolean(self, *args, **kwargs)
|
|
||||||
|
|
||||||
self.cli.acquire_lock()
|
|
||||||
argument_name = self.cli.get_argument_name(*args, **kwargs)
|
|
||||||
|
|
||||||
self.subparser.add_argument(*args, **kwargs)
|
|
||||||
|
|
||||||
if kwargs.get('action') == 'store_false':
|
|
||||||
self.cli._config_store_false.append(argument_name)
|
|
||||||
|
|
||||||
if kwargs.get('action') == 'store_true':
|
|
||||||
self.cli._config_store_true.append(argument_name)
|
|
||||||
|
|
||||||
if self.submodule not in self.cli.default_arguments:
|
|
||||||
self.cli.default_arguments[self.submodule] = {}
|
|
||||||
self.cli.default_arguments[self.submodule][argument_name] = kwargs.get('default')
|
|
||||||
self.cli.release_lock()
|
|
||||||
|
|
||||||
|
|
||||||
class MILC(object):
|
|
||||||
"""MILC - An Opinionated Batteries Included Framework
|
|
||||||
"""
|
|
||||||
def __init__(self):
|
|
||||||
"""Initialize the MILC object.
|
|
||||||
|
|
||||||
version
|
|
||||||
The version string to associate with your CLI program
|
|
||||||
"""
|
|
||||||
# Setup a lock for thread safety
|
|
||||||
self._lock = threading.RLock() if thread else None
|
|
||||||
|
|
||||||
# Define some basic info
|
|
||||||
self.acquire_lock()
|
|
||||||
self._config_store_true = []
|
|
||||||
self._config_store_false = []
|
|
||||||
self._description = None
|
|
||||||
self._entrypoint = None
|
|
||||||
self._inside_context_manager = False
|
|
||||||
self.ansi = ansi_colors
|
|
||||||
self.arg_only = {}
|
|
||||||
self.config = self.config_source = None
|
|
||||||
self.config_file = None
|
|
||||||
self.default_arguments = {}
|
|
||||||
self.version = 'unknown'
|
|
||||||
self.release_lock()
|
|
||||||
|
|
||||||
# Figure out our program name
|
|
||||||
self.prog_name = sys.argv[0][:-3] if sys.argv[0].endswith('.py') else sys.argv[0]
|
|
||||||
self.prog_name = self.prog_name.split('/')[-1]
|
|
||||||
|
|
||||||
# Initialize all the things
|
|
||||||
self.read_config_file()
|
|
||||||
self.initialize_argparse()
|
|
||||||
self.initialize_logging()
|
|
||||||
|
|
||||||
@property
|
|
||||||
def description(self):
|
|
||||||
return self._description
|
|
||||||
|
|
||||||
@description.setter
|
|
||||||
def description(self, value):
|
|
||||||
self._description = self._arg_parser.description = value
|
|
||||||
|
|
||||||
def echo(self, text, *args, **kwargs):
|
|
||||||
"""Print colorized text to stdout.
|
|
||||||
|
|
||||||
ANSI color strings (such as {fg-blue}) will be converted into ANSI
|
|
||||||
escape sequences, and the ANSI reset sequence will be added to all
|
|
||||||
strings.
|
|
||||||
|
|
||||||
If *args or **kwargs are passed they will be used to %-format the strings.
|
|
||||||
"""
|
|
||||||
if args and kwargs:
|
|
||||||
raise RuntimeError('You can only specify *args or **kwargs, not both!')
|
|
||||||
|
|
||||||
args = args or kwargs
|
|
||||||
text = format_ansi(text)
|
|
||||||
|
|
||||||
print(text % args)
|
|
||||||
|
|
||||||
def initialize_argparse(self):
|
|
||||||
"""Prepare to process arguments from sys.argv.
|
|
||||||
"""
|
|
||||||
kwargs = {
|
|
||||||
'fromfile_prefix_chars': '@',
|
|
||||||
'conflict_handler': 'resolve',
|
|
||||||
}
|
|
||||||
|
|
||||||
self.acquire_lock()
|
|
||||||
self.subcommands = {}
|
|
||||||
self._subparsers = None
|
|
||||||
self.argwarn = argcomplete.warn
|
|
||||||
self.args = None
|
|
||||||
self._arg_parser = argparse.ArgumentParser(**kwargs)
|
|
||||||
self.set_defaults = self._arg_parser.set_defaults
|
|
||||||
self.print_usage = self._arg_parser.print_usage
|
|
||||||
self.print_help = self._arg_parser.print_help
|
|
||||||
self.release_lock()
|
|
||||||
|
|
||||||
def completer(self, completer):
|
|
||||||
"""Add an argcomplete completer to this subcommand.
|
|
||||||
"""
|
|
||||||
self._arg_parser.completer = completer
|
|
||||||
|
|
||||||
def add_argument(self, *args, **kwargs):
|
|
||||||
"""Wrapper to add arguments and track whether they were passed on the command line.
|
|
||||||
"""
|
|
||||||
if 'action' in kwargs and kwargs['action'] == 'store_boolean':
|
|
||||||
return handle_store_boolean(self, *args, **kwargs)
|
|
||||||
|
|
||||||
self.acquire_lock()
|
|
||||||
|
|
||||||
self._arg_parser.add_argument(*args, **kwargs)
|
|
||||||
if 'general' not in self.default_arguments:
|
|
||||||
self.default_arguments['general'] = {}
|
|
||||||
self.default_arguments['general'][self.get_argument_name(*args, **kwargs)] = kwargs.get('default')
|
|
||||||
|
|
||||||
self.release_lock()
|
|
||||||
|
|
||||||
def initialize_logging(self):
|
|
||||||
"""Prepare the defaults for the logging infrastructure.
|
|
||||||
"""
|
|
||||||
self.acquire_lock()
|
|
||||||
self.log_file = None
|
|
||||||
self.log_file_mode = 'a'
|
|
||||||
self.log_file_handler = None
|
|
||||||
self.log_print = True
|
|
||||||
self.log_print_to = sys.stderr
|
|
||||||
self.log_print_level = logging.INFO
|
|
||||||
self.log_file_level = logging.DEBUG
|
|
||||||
self.log_level = logging.INFO
|
|
||||||
self.log = logging.getLogger(self.__class__.__name__)
|
|
||||||
self.log.setLevel(logging.DEBUG)
|
|
||||||
logging.root.setLevel(logging.DEBUG)
|
|
||||||
self.release_lock()
|
|
||||||
|
|
||||||
self.add_argument('-V', '--version', version=self.version, action='version', help='Display the version and exit')
|
|
||||||
self.add_argument('-v', '--verbose', action='store_true', help='Make the logging more verbose')
|
|
||||||
self.add_argument('--datetime-fmt', default='%Y-%m-%d %H:%M:%S', help='Format string for datetimes')
|
|
||||||
self.add_argument('--log-fmt', default='%(levelname)s %(message)s', help='Format string for printed log output')
|
|
||||||
self.add_argument('--log-file-fmt', default='[%(levelname)s] [%(asctime)s] [file:%(pathname)s] [line:%(lineno)d] %(message)s', help='Format string for log file.')
|
|
||||||
self.add_argument('--log-file', help='File to write log messages to')
|
|
||||||
self.add_argument('--color', action='store_boolean', default=True, help='color in output')
|
|
||||||
self.add_argument('--config-file', help='The location for the configuration file')
|
|
||||||
self.arg_only['config_file'] = ['general']
|
|
||||||
|
|
||||||
def add_subparsers(self, title='Sub-commands', **kwargs):
|
|
||||||
if self._inside_context_manager:
|
|
||||||
raise RuntimeError('You must run this before the with statement!')
|
|
||||||
|
|
||||||
self.acquire_lock()
|
|
||||||
self._subparsers = self._arg_parser.add_subparsers(title=title, dest='subparsers', **kwargs)
|
|
||||||
self.release_lock()
|
|
||||||
|
|
||||||
def acquire_lock(self):
|
|
||||||
"""Acquire the MILC lock for exclusive access to properties.
|
|
||||||
"""
|
|
||||||
if self._lock:
|
|
||||||
self._lock.acquire()
|
|
||||||
|
|
||||||
def release_lock(self):
|
|
||||||
"""Release the MILC lock.
|
|
||||||
"""
|
|
||||||
if self._lock:
|
|
||||||
self._lock.release()
|
|
||||||
|
|
||||||
def find_config_file(self):
|
|
||||||
"""Locate the config file.
|
|
||||||
"""
|
|
||||||
if self.config_file:
|
|
||||||
return self.config_file
|
|
||||||
|
|
||||||
if '--config-file' in sys.argv:
|
|
||||||
return Path(sys.argv[sys.argv.index('--config-file') + 1]).expanduser().resolve()
|
|
||||||
|
|
||||||
filedir = user_config_dir(appname='qmk', appauthor='QMK')
|
|
||||||
filename = '%s.ini' % self.prog_name
|
|
||||||
return Path(filedir) / filename
|
|
||||||
|
|
||||||
def get_argument_name(self, *args, **kwargs):
|
|
||||||
"""Takes argparse arguments and returns the dest name.
|
|
||||||
"""
|
|
||||||
try:
|
|
||||||
return self._arg_parser._get_optional_kwargs(*args, **kwargs)['dest']
|
|
||||||
except ValueError:
|
|
||||||
return self._arg_parser._get_positional_kwargs(*args, **kwargs)['dest']
|
|
||||||
|
|
||||||
def argument(self, *args, **kwargs):
|
|
||||||
"""Decorator to call self.add_argument or self.<subcommand>.add_argument.
|
|
||||||
"""
|
|
||||||
if self._inside_context_manager:
|
|
||||||
raise RuntimeError('You must run this before the with statement!')
|
|
||||||
|
|
||||||
def argument_function(handler):
|
|
||||||
subcommand_name = handler.__name__.replace("_", "-")
|
|
||||||
|
|
||||||
if kwargs.get('arg_only'):
|
|
||||||
arg_name = self.get_argument_name(*args, **kwargs)
|
|
||||||
if arg_name not in self.arg_only:
|
|
||||||
self.arg_only[arg_name] = []
|
|
||||||
self.arg_only[arg_name].append(subcommand_name)
|
|
||||||
del kwargs['arg_only']
|
|
||||||
|
|
||||||
if handler is self._entrypoint:
|
|
||||||
self.add_argument(*args, **kwargs)
|
|
||||||
|
|
||||||
elif subcommand_name in self.subcommands:
|
|
||||||
self.subcommands[subcommand_name].add_argument(*args, **kwargs)
|
|
||||||
|
|
||||||
else:
|
|
||||||
raise RuntimeError('Decorated function is not entrypoint or subcommand!')
|
|
||||||
|
|
||||||
return handler
|
|
||||||
|
|
||||||
return argument_function
|
|
||||||
|
|
||||||
def arg_passed(self, arg):
|
|
||||||
"""Returns True if arg was passed on the command line.
|
|
||||||
"""
|
|
||||||
return self.default_arguments.get(arg) != self.args[arg]
|
|
||||||
|
|
||||||
def parse_args(self):
|
|
||||||
"""Parse the CLI args.
|
|
||||||
"""
|
|
||||||
if self.args:
|
|
||||||
self.log.debug('Warning: Arguments have already been parsed, ignoring duplicate attempt!')
|
|
||||||
return
|
|
||||||
|
|
||||||
argcomplete.autocomplete(self._arg_parser)
|
|
||||||
|
|
||||||
self.acquire_lock()
|
|
||||||
self.args = self._arg_parser.parse_args()
|
|
||||||
|
|
||||||
if 'entrypoint' in self.args:
|
|
||||||
self._entrypoint = self.args.entrypoint
|
|
||||||
|
|
||||||
self.release_lock()
|
|
||||||
|
|
||||||
def read_config_file(self):
|
|
||||||
"""Read in the configuration file and store it in self.config.
|
|
||||||
"""
|
|
||||||
self.acquire_lock()
|
|
||||||
self.config = Configuration()
|
|
||||||
self.config_source = Configuration()
|
|
||||||
self.config_file = self.find_config_file()
|
|
||||||
|
|
||||||
if self.config_file and self.config_file.exists():
|
|
||||||
config = RawConfigParser(self.config)
|
|
||||||
config.read(str(self.config_file))
|
|
||||||
|
|
||||||
# Iterate over the config file options and write them into self.config
|
|
||||||
for section in config.sections():
|
|
||||||
for option in config.options(section):
|
|
||||||
value = config.get(section, option)
|
|
||||||
|
|
||||||
# Coerce values into useful datatypes
|
|
||||||
if value.lower() in ['1', 'yes', 'true', 'on']:
|
|
||||||
value = True
|
|
||||||
elif value.lower() in ['0', 'no', 'false', 'off']:
|
|
||||||
value = False
|
|
||||||
elif value.lower() in ['none']:
|
|
||||||
continue
|
|
||||||
elif value.replace('.', '').isdigit():
|
|
||||||
if '.' in value:
|
|
||||||
value = Decimal(value)
|
|
||||||
else:
|
|
||||||
value = int(value)
|
|
||||||
|
|
||||||
self.config[section][option] = value
|
|
||||||
self.config_source[section][option] = 'config_file'
|
|
||||||
|
|
||||||
self.release_lock()
|
|
||||||
|
|
||||||
def merge_args_into_config(self):
|
|
||||||
"""Merge CLI arguments into self.config to create the runtime configuration.
|
|
||||||
"""
|
|
||||||
self.acquire_lock()
|
|
||||||
for argument in vars(self.args):
|
|
||||||
if argument in ('subparsers', 'entrypoint'):
|
|
||||||
continue
|
|
||||||
|
|
||||||
# Find the argument's section
|
|
||||||
# Underscores in command's names are converted to dashes during initialization.
|
|
||||||
# TODO(Erovia) Find a better solution
|
|
||||||
entrypoint_name = self._entrypoint.__name__.replace("_", "-")
|
|
||||||
if entrypoint_name in self.default_arguments and argument in self.default_arguments[entrypoint_name]:
|
|
||||||
argument_found = True
|
|
||||||
section = self._entrypoint.__name__
|
|
||||||
if argument in self.default_arguments['general']:
|
|
||||||
argument_found = True
|
|
||||||
section = 'general'
|
|
||||||
|
|
||||||
if not argument_found:
|
|
||||||
raise RuntimeError('Could not find argument in `self.default_arguments`. This should be impossible!')
|
|
||||||
exit(1)
|
|
||||||
|
|
||||||
if argument not in self.arg_only or section not in self.arg_only[argument]:
|
|
||||||
# Determine the arg value and source
|
|
||||||
arg_value = getattr(self.args, argument)
|
|
||||||
if argument in self._config_store_true and arg_value:
|
|
||||||
passed_on_cmdline = True
|
|
||||||
elif argument in self._config_store_false and not arg_value:
|
|
||||||
passed_on_cmdline = True
|
|
||||||
elif arg_value is not None:
|
|
||||||
passed_on_cmdline = True
|
|
||||||
else:
|
|
||||||
passed_on_cmdline = False
|
|
||||||
|
|
||||||
# Merge this argument into self.config
|
|
||||||
if passed_on_cmdline and (argument in self.default_arguments['general'] or argument in self.default_arguments[entrypoint_name] or argument not in self.config[entrypoint_name]):
|
|
||||||
self.config[section][argument] = arg_value
|
|
||||||
self.config_source[section][argument] = 'argument'
|
|
||||||
|
|
||||||
self.release_lock()
|
|
||||||
|
|
||||||
def save_config(self):
|
|
||||||
"""Save the current configuration to the config file.
|
|
||||||
"""
|
|
||||||
self.log.debug("Saving config file to '%s'", str(self.config_file))
|
|
||||||
|
|
||||||
if not self.config_file:
|
|
||||||
self.log.warning('%s.config_file file not set, not saving config!', self.__class__.__name__)
|
|
||||||
return
|
|
||||||
|
|
||||||
self.acquire_lock()
|
|
||||||
|
|
||||||
# Generate a sanitized version of our running configuration
|
|
||||||
config = RawConfigParser()
|
|
||||||
for section_name, section in self.config._config.items():
|
|
||||||
config.add_section(section_name)
|
|
||||||
for option_name, value in section.items():
|
|
||||||
if section_name == 'general':
|
|
||||||
if option_name in ['config_file']:
|
|
||||||
continue
|
|
||||||
if value is not None:
|
|
||||||
config.set(section_name, option_name, str(value))
|
|
||||||
|
|
||||||
# Write out the config file
|
|
||||||
config_dir = self.config_file.parent
|
|
||||||
if not config_dir.exists():
|
|
||||||
config_dir.mkdir(parents=True, exist_ok=True)
|
|
||||||
|
|
||||||
with NamedTemporaryFile(mode='w', dir=str(config_dir), delete=False) as tmpfile:
|
|
||||||
config.write(tmpfile)
|
|
||||||
|
|
||||||
# Move the new config file into place atomically
|
|
||||||
if os.path.getsize(tmpfile.name) > 0:
|
|
||||||
os.replace(tmpfile.name, str(self.config_file))
|
|
||||||
else:
|
|
||||||
self.log.warning('Config file saving failed, not replacing %s with %s.', str(self.config_file), tmpfile.name)
|
|
||||||
|
|
||||||
# Housekeeping
|
|
||||||
self.release_lock()
|
|
||||||
cli.log.info('Wrote configuration to %s', shlex.quote(str(self.config_file)))
|
|
||||||
|
|
||||||
def __call__(self):
|
|
||||||
"""Execute the entrypoint function.
|
|
||||||
"""
|
|
||||||
if not self._inside_context_manager:
|
|
||||||
# If they didn't use the context manager use it ourselves
|
|
||||||
with self:
|
|
||||||
return self.__call__()
|
|
||||||
|
|
||||||
if not self._entrypoint:
|
|
||||||
raise RuntimeError('No entrypoint provided!')
|
|
||||||
|
|
||||||
return self._entrypoint(self)
|
|
||||||
|
|
||||||
def entrypoint(self, description):
|
|
||||||
"""Set the entrypoint for when no subcommand is provided.
|
|
||||||
"""
|
|
||||||
if self._inside_context_manager:
|
|
||||||
raise RuntimeError('You must run this before cli()!')
|
|
||||||
|
|
||||||
self.acquire_lock()
|
|
||||||
self.description = description
|
|
||||||
self.release_lock()
|
|
||||||
|
|
||||||
def entrypoint_func(handler):
|
|
||||||
self.acquire_lock()
|
|
||||||
self._entrypoint = handler
|
|
||||||
self.release_lock()
|
|
||||||
|
|
||||||
return handler
|
|
||||||
|
|
||||||
return entrypoint_func
|
|
||||||
|
|
||||||
def add_subcommand(self, handler, description, name=None, hidden=False, **kwargs):
|
|
||||||
"""Register a subcommand.
|
|
||||||
|
|
||||||
If name is not provided we use `handler.__name__`.
|
|
||||||
"""
|
|
||||||
|
|
||||||
if self._inside_context_manager:
|
|
||||||
raise RuntimeError('You must run this before the with statement!')
|
|
||||||
|
|
||||||
if self._subparsers is None:
|
|
||||||
self.add_subparsers(metavar="")
|
|
||||||
|
|
||||||
if not name:
|
|
||||||
name = handler.__name__.replace("_", "-")
|
|
||||||
|
|
||||||
self.acquire_lock()
|
|
||||||
if not hidden:
|
|
||||||
self._subparsers.metavar = "{%s,%s}" % (self._subparsers.metavar[1:-1], name) if self._subparsers.metavar else "{%s%s}" % (self._subparsers.metavar[1:-1], name)
|
|
||||||
kwargs['help'] = description
|
|
||||||
self.subcommands[name] = SubparserWrapper(self, name, self._subparsers.add_parser(name, **kwargs))
|
|
||||||
self.subcommands[name].set_defaults(entrypoint=handler)
|
|
||||||
|
|
||||||
self.release_lock()
|
|
||||||
|
|
||||||
return handler
|
|
||||||
|
|
||||||
def subcommand(self, description, hidden=False, **kwargs):
|
|
||||||
"""Decorator to register a subcommand.
|
|
||||||
"""
|
|
||||||
def subcommand_function(handler):
|
|
||||||
return self.add_subcommand(handler, description, hidden=hidden, **kwargs)
|
|
||||||
|
|
||||||
return subcommand_function
|
|
||||||
|
|
||||||
def setup_logging(self):
|
|
||||||
"""Called by __enter__() to setup the logging configuration.
|
|
||||||
"""
|
|
||||||
if len(logging.root.handlers) != 0:
|
|
||||||
# MILC is the only thing that should have root log handlers
|
|
||||||
logging.root.handlers = []
|
|
||||||
|
|
||||||
self.acquire_lock()
|
|
||||||
|
|
||||||
if self.config['general']['verbose']:
|
|
||||||
self.log_print_level = logging.DEBUG
|
|
||||||
|
|
||||||
self.log_file = self.config['general']['log_file'] or self.log_file
|
|
||||||
self.log_file_format = self.config['general']['log_file_fmt']
|
|
||||||
self.log_file_format = ANSIStrippingFormatter(self.config['general']['log_file_fmt'], self.config['general']['datetime_fmt'])
|
|
||||||
self.log_format = self.config['general']['log_fmt']
|
|
||||||
|
|
||||||
if self.config.general.color:
|
|
||||||
self.log_format = ANSIEmojiLoglevelFormatter(self.args.log_fmt, self.config.general.datetime_fmt)
|
|
||||||
else:
|
|
||||||
self.log_format = ANSIStrippingFormatter(self.args.log_fmt, self.config.general.datetime_fmt)
|
|
||||||
|
|
||||||
if self.log_file:
|
|
||||||
self.log_file_handler = logging.FileHandler(self.log_file, self.log_file_mode)
|
|
||||||
self.log_file_handler.setLevel(self.log_file_level)
|
|
||||||
self.log_file_handler.setFormatter(self.log_file_format)
|
|
||||||
logging.root.addHandler(self.log_file_handler)
|
|
||||||
|
|
||||||
if self.log_print:
|
|
||||||
self.log_print_handler = logging.StreamHandler(self.log_print_to)
|
|
||||||
self.log_print_handler.setLevel(self.log_print_level)
|
|
||||||
self.log_print_handler.setFormatter(self.log_format)
|
|
||||||
logging.root.addHandler(self.log_print_handler)
|
|
||||||
|
|
||||||
self.release_lock()
|
|
||||||
|
|
||||||
def __enter__(self):
|
|
||||||
if self._inside_context_manager:
|
|
||||||
self.log.debug('Warning: context manager was entered again. This usually means that self.__call__() was called before the with statement. You probably do not want to do that.')
|
|
||||||
return
|
|
||||||
|
|
||||||
self.acquire_lock()
|
|
||||||
self._inside_context_manager = True
|
|
||||||
self.release_lock()
|
|
||||||
|
|
||||||
colorama.init()
|
|
||||||
self.parse_args()
|
|
||||||
self.merge_args_into_config()
|
|
||||||
self.setup_logging()
|
|
||||||
|
|
||||||
return self
|
|
||||||
|
|
||||||
def __exit__(self, exc_type, exc_val, exc_tb):
|
|
||||||
self.acquire_lock()
|
|
||||||
self._inside_context_manager = False
|
|
||||||
self.release_lock()
|
|
||||||
|
|
||||||
if exc_type is not None and not isinstance(SystemExit(), exc_type):
|
|
||||||
print(exc_type)
|
|
||||||
logging.exception(exc_val)
|
|
||||||
exit(255)
|
|
||||||
|
|
||||||
|
|
||||||
cli = MILC()
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
|
||||||
|
|
||||||
@cli.argument('-c', '--comma', help='comma in output', default=True, action='store_boolean')
|
|
||||||
@cli.entrypoint('My useful CLI tool with subcommands.')
|
|
||||||
def main(cli):
|
|
||||||
comma = ',' if cli.config.general.comma else ''
|
|
||||||
cli.log.info('{bg_green}{fg_red}Hello%s World!', comma)
|
|
||||||
|
|
||||||
@cli.argument('-n', '--name', help='Name to greet', default='World')
|
|
||||||
@cli.subcommand('Description of hello subcommand here.')
|
|
||||||
def hello(cli):
|
|
||||||
comma = ',' if cli.config.general.comma else ''
|
|
||||||
cli.log.info('{fg_blue}Hello%s %s!', comma, cli.config.hello.name)
|
|
||||||
|
|
||||||
def goodbye(cli):
|
|
||||||
comma = ',' if cli.config.general.comma else ''
|
|
||||||
cli.log.info('{bg_red}Goodbye%s %s!', comma, cli.config.goodbye.name)
|
|
||||||
|
|
||||||
@cli.argument('-n', '--name', help='Name to greet', default='World')
|
|
||||||
@cli.subcommand('Think a bit before greeting the user.')
|
|
||||||
def thinking(cli):
|
|
||||||
comma = ',' if cli.config.general.comma else ''
|
|
||||||
spinner = cli.spinner(text='Just a moment...', spinner='earth')
|
|
||||||
spinner.start()
|
|
||||||
sleep(2)
|
|
||||||
spinner.stop()
|
|
||||||
|
|
||||||
with cli.spinner(text='Almost there!', spinner='moon'):
|
|
||||||
sleep(2)
|
|
||||||
|
|
||||||
cli.log.info('{fg_cyan}Hello%s %s!', comma, cli.config.thinking.name)
|
|
||||||
|
|
||||||
@cli.subcommand('Show off our ANSI colors.')
|
|
||||||
def pride(cli):
|
|
||||||
cli.echo('{bg_red} ')
|
|
||||||
cli.echo('{bg_lightred_ex} ')
|
|
||||||
cli.echo('{bg_lightyellow_ex} ')
|
|
||||||
cli.echo('{bg_green} ')
|
|
||||||
cli.echo('{bg_blue} ')
|
|
||||||
cli.echo('{bg_magenta} ')
|
|
||||||
|
|
||||||
# You can register subcommands using decorators as seen above, or using functions like like this:
|
|
||||||
cli.add_subcommand(goodbye, 'This will show up in --help output.')
|
|
||||||
cli.goodbye.add_argument('-n', '--name', help='Name to bid farewell to', default='World')
|
|
||||||
|
|
||||||
cli() # Automatically picks between main(), hello() and goodbye()
|
|
||||||
@@ -1,116 +0,0 @@
|
|||||||
"""Read and write configuration settings
|
|
||||||
"""
|
|
||||||
from milc import cli
|
|
||||||
|
|
||||||
|
|
||||||
def print_config(section, key):
|
|
||||||
"""Print a single config setting to stdout.
|
|
||||||
"""
|
|
||||||
cli.echo('%s.%s{fg_cyan}={fg_reset}%s', section, key, cli.config[section][key])
|
|
||||||
|
|
||||||
|
|
||||||
def show_config():
|
|
||||||
"""Print the current configuration to stdout.
|
|
||||||
"""
|
|
||||||
for section in cli.config:
|
|
||||||
for key in cli.config[section]:
|
|
||||||
print_config(section, key)
|
|
||||||
|
|
||||||
|
|
||||||
def parse_config_token(config_token):
|
|
||||||
"""Split a user-supplied configuration-token into its components.
|
|
||||||
"""
|
|
||||||
section = option = value = None
|
|
||||||
|
|
||||||
if '=' in config_token and '.' not in config_token:
|
|
||||||
cli.log.error('Invalid configuration token, the key must be of the form <section>.<option>: %s', config_token)
|
|
||||||
return section, option, value
|
|
||||||
|
|
||||||
# Separate the key (<section>.<option>) from the value
|
|
||||||
if '=' in config_token:
|
|
||||||
key, value = config_token.split('=')
|
|
||||||
else:
|
|
||||||
key = config_token
|
|
||||||
|
|
||||||
# Extract the section and option from the key
|
|
||||||
if '.' in key:
|
|
||||||
section, option = key.split('.', 1)
|
|
||||||
else:
|
|
||||||
section = key
|
|
||||||
|
|
||||||
return section, option, value
|
|
||||||
|
|
||||||
|
|
||||||
def set_config(section, option, value):
|
|
||||||
"""Set a config key in the running config.
|
|
||||||
"""
|
|
||||||
log_string = '%s.%s{fg_cyan}:{fg_reset} %s {fg_cyan}->{fg_reset} %s'
|
|
||||||
if cli.args.read_only:
|
|
||||||
log_string += ' {fg_red}(change not written)'
|
|
||||||
|
|
||||||
cli.echo(log_string, section, option, cli.config[section][option], value)
|
|
||||||
|
|
||||||
if not cli.args.read_only:
|
|
||||||
if value == 'None':
|
|
||||||
del cli.config[section][option]
|
|
||||||
else:
|
|
||||||
cli.config[section][option] = value
|
|
||||||
|
|
||||||
|
|
||||||
@cli.argument('-ro', '--read-only', arg_only=True, action='store_true', help='Operate in read-only mode.')
|
|
||||||
@cli.argument('configs', nargs='*', arg_only=True, help='Configuration options to read or write.')
|
|
||||||
@cli.subcommand("Read and write configuration settings.")
|
|
||||||
def config(cli):
|
|
||||||
"""Read and write config settings.
|
|
||||||
|
|
||||||
This script iterates over the config_tokens supplied as argument. Each config_token has the following form:
|
|
||||||
|
|
||||||
section[.key][=value]
|
|
||||||
|
|
||||||
If only a section (EG 'compile') is supplied all keys for that section will be displayed.
|
|
||||||
|
|
||||||
If section.key is supplied the value for that single key will be displayed.
|
|
||||||
|
|
||||||
If section.key=value is supplied the value for that single key will be set.
|
|
||||||
|
|
||||||
If section.key=None is supplied the key will be deleted.
|
|
||||||
|
|
||||||
No validation is done to ensure that the supplied section.key is actually used by qmk scripts.
|
|
||||||
"""
|
|
||||||
if not cli.args.configs:
|
|
||||||
return show_config()
|
|
||||||
|
|
||||||
# Process config_tokens
|
|
||||||
save_config = False
|
|
||||||
|
|
||||||
for argument in cli.args.configs:
|
|
||||||
# Split on space in case they quoted multiple config tokens
|
|
||||||
for config_token in argument.split(' '):
|
|
||||||
section, option, value = parse_config_token(config_token)
|
|
||||||
|
|
||||||
# Validation
|
|
||||||
if option and '.' in option:
|
|
||||||
cli.log.error('Config keys may not have more than one period! "%s" is not valid.', config_token)
|
|
||||||
return False
|
|
||||||
|
|
||||||
# Do what the user wants
|
|
||||||
if section and option and value:
|
|
||||||
# Write a configuration option
|
|
||||||
set_config(section, option, value)
|
|
||||||
if not cli.args.read_only:
|
|
||||||
save_config = True
|
|
||||||
|
|
||||||
elif section and option:
|
|
||||||
# Display a single key
|
|
||||||
print_config(section, option)
|
|
||||||
|
|
||||||
elif section:
|
|
||||||
# Display an entire section
|
|
||||||
for key in cli.config[section]:
|
|
||||||
print_config(section, key)
|
|
||||||
|
|
||||||
# Ending actions
|
|
||||||
if save_config:
|
|
||||||
cli.save_config()
|
|
||||||
|
|
||||||
return True
|
|
||||||
@@ -54,10 +54,7 @@ def check_udev_rules():
|
|||||||
_udev_rule("03eb", "2ff3"), # ATmega16U4
|
_udev_rule("03eb", "2ff3"), # ATmega16U4
|
||||||
_udev_rule("03eb", "2ff4"), # ATmega32U4
|
_udev_rule("03eb", "2ff4"), # ATmega32U4
|
||||||
_udev_rule("03eb", "2ff9"), # AT90USB64
|
_udev_rule("03eb", "2ff9"), # AT90USB64
|
||||||
<<<<<<< HEAD
|
|
||||||
=======
|
|
||||||
_udev_rule("03eb", "2ffa"), # AT90USB162
|
_udev_rule("03eb", "2ffa"), # AT90USB162
|
||||||
>>>>>>> 0.12.52~1
|
|
||||||
_udev_rule("03eb", "2ffb") # AT90USB128
|
_udev_rule("03eb", "2ffb") # AT90USB128
|
||||||
},
|
},
|
||||||
'kiibohd': {_udev_rule("1c11", "b007")},
|
'kiibohd': {_udev_rule("1c11", "b007")},
|
||||||
@@ -108,11 +105,7 @@ def check_udev_rules():
|
|||||||
|
|
||||||
# Collect all rules from the config files
|
# Collect all rules from the config files
|
||||||
for rule_file in udev_rules:
|
for rule_file in udev_rules:
|
||||||
<<<<<<< HEAD
|
|
||||||
for line in rule_file.read_text().split('\n'):
|
|
||||||
=======
|
|
||||||
for line in rule_file.read_text(encoding='utf-8').split('\n'):
|
for line in rule_file.read_text(encoding='utf-8').split('\n'):
|
||||||
>>>>>>> 0.12.52~1
|
|
||||||
line = line.strip()
|
line = line.strip()
|
||||||
if not line.startswith("#") and len(line):
|
if not line.startswith("#") and len(line):
|
||||||
current_rules.add(line)
|
current_rules.add(line)
|
||||||
@@ -149,11 +142,7 @@ def check_modem_manager():
|
|||||||
|
|
||||||
"""
|
"""
|
||||||
if check_systemd():
|
if check_systemd():
|
||||||
<<<<<<< HEAD
|
|
||||||
mm_check = run(["systemctl", "--quiet", "is-active", "ModemManager.service"], timeout=10)
|
|
||||||
=======
|
|
||||||
mm_check = cli.run(["systemctl", "--quiet", "is-active", "ModemManager.service"], timeout=10)
|
mm_check = cli.run(["systemctl", "--quiet", "is-active", "ModemManager.service"], timeout=10)
|
||||||
>>>>>>> 0.12.52~1
|
|
||||||
if mm_check.returncode == 0:
|
if mm_check.returncode == 0:
|
||||||
return True
|
return True
|
||||||
else:
|
else:
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
"""Format C code according to QMK's style.
|
"""Format C code according to QMK's style.
|
||||||
"""
|
"""
|
||||||
from os import path
|
|
||||||
from shutil import which
|
from shutil import which
|
||||||
from subprocess import CalledProcessError, DEVNULL, Popen, PIPE
|
from subprocess import CalledProcessError, DEVNULL, Popen, PIPE
|
||||||
|
|
||||||
@@ -15,6 +14,12 @@ core_dirs = ('drivers', 'quantum', 'tests', 'tmk_core', 'platforms')
|
|||||||
ignored = ('tmk_core/protocol/usb_hid', 'platforms/chibios/boards')
|
ignored = ('tmk_core/protocol/usb_hid', 'platforms/chibios/boards')
|
||||||
|
|
||||||
|
|
||||||
|
def is_relative_to(file, other):
|
||||||
|
"""Provide similar behavior to PurePath.is_relative_to in Python > 3.9
|
||||||
|
"""
|
||||||
|
return str(normpath(file).resolve()).startswith(str(normpath(other).resolve()))
|
||||||
|
|
||||||
|
|
||||||
def find_clang_format():
|
def find_clang_format():
|
||||||
"""Returns the path to clang-format.
|
"""Returns the path to clang-format.
|
||||||
"""
|
"""
|
||||||
@@ -68,18 +73,18 @@ def cformat_run(files):
|
|||||||
def filter_files(files, core_only=False):
|
def filter_files(files, core_only=False):
|
||||||
"""Yield only files to be formatted and skip the rest
|
"""Yield only files to be formatted and skip the rest
|
||||||
"""
|
"""
|
||||||
|
files = list(map(normpath, filter(None, files)))
|
||||||
|
|
||||||
|
for file in files:
|
||||||
if core_only:
|
if core_only:
|
||||||
# Filter non-core files
|
|
||||||
for index, file in enumerate(files):
|
|
||||||
# The following statement checks each file to see if the file path is
|
# The following statement checks each file to see if the file path is
|
||||||
# - in the core directories
|
# - in the core directories
|
||||||
# - not in the ignored directories
|
# - not in the ignored directories
|
||||||
if not any(str(file).startswith(i) for i in core_dirs) or any(str(file).startswith(i) for i in ignored):
|
if not any(is_relative_to(file, i) for i in core_dirs) or any(is_relative_to(file, i) for i in ignored):
|
||||||
files[index] = None
|
|
||||||
cli.log.debug("Skipping non-core file %s, as '--core-only' is used.", file)
|
cli.log.debug("Skipping non-core file %s, as '--core-only' is used.", file)
|
||||||
|
continue
|
||||||
|
|
||||||
for file in files:
|
if file.suffix[1:] in c_file_suffixes:
|
||||||
if file and file.name.split('.')[-1] in c_file_suffixes:
|
|
||||||
yield file
|
yield file
|
||||||
else:
|
else:
|
||||||
cli.log.debug('Skipping file %s', file)
|
cli.log.debug('Skipping file %s', file)
|
||||||
@@ -118,12 +123,8 @@ def format_c(cli):
|
|||||||
print(git_diff.stderr)
|
print(git_diff.stderr)
|
||||||
return git_diff.returncode
|
return git_diff.returncode
|
||||||
|
|
||||||
files = []
|
changed_files = git_diff.stdout.strip().split('\n')
|
||||||
|
files = list(filter_files(changed_files, True))
|
||||||
for file in git_diff.stdout.strip().split('\n'):
|
|
||||||
if not any([file.startswith(ignore) for ignore in ignored]):
|
|
||||||
if path.exists(file) and file.split('.')[-1] in c_file_suffixes:
|
|
||||||
files.append(file)
|
|
||||||
|
|
||||||
# Sanity check
|
# Sanity check
|
||||||
if not files:
|
if not files:
|
||||||
|
|||||||
@@ -25,8 +25,9 @@ def yapf_run(files):
|
|||||||
def filter_files(files):
|
def filter_files(files):
|
||||||
"""Yield only files to be formatted and skip the rest
|
"""Yield only files to be formatted and skip the rest
|
||||||
"""
|
"""
|
||||||
|
files = list(map(normpath, filter(None, files)))
|
||||||
for file in files:
|
for file in files:
|
||||||
if file and normpath(file).name.split('.')[-1] in py_file_suffixes:
|
if file.suffix[1:] in py_file_suffixes:
|
||||||
yield file
|
yield file
|
||||||
else:
|
else:
|
||||||
cli.log.debug('Skipping file %s', file)
|
cli.log.debug('Skipping file %s', file)
|
||||||
|
|||||||
@@ -26,7 +26,8 @@ def system_libs(binary: str) -> List[Path]:
|
|||||||
|
|
||||||
# Actually query xxxxxx-gcc to find its include paths.
|
# Actually query xxxxxx-gcc to find its include paths.
|
||||||
if binary.endswith("gcc") or binary.endswith("g++"):
|
if binary.endswith("gcc") or binary.endswith("g++"):
|
||||||
result = cli.run([binary, '-E', '-Wp,-v', '-'], capture_output=True, check=True, input='\n')
|
# (TODO): Remove 'stdin' once 'input' no longer causes issues under MSYS
|
||||||
|
result = cli.run([binary, '-E', '-Wp,-v', '-'], capture_output=True, check=True, stdin=None, input='\n')
|
||||||
paths = []
|
paths = []
|
||||||
for line in result.stderr.splitlines():
|
for line in result.stderr.splitlines():
|
||||||
if line.startswith(" "):
|
if line.startswith(" "):
|
||||||
|
|||||||
@@ -1,5 +0,0 @@
|
|||||||
"""QMK CLI JSON Subcommands
|
|
||||||
|
|
||||||
We list each subcommand here explicitly because all the reliable ways of searching for modules are slow and delay startup.
|
|
||||||
"""
|
|
||||||
from . import keymap
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
"""Generate a keymap.c from a configurator export.
|
|
||||||
"""
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
from milc import cli
|
|
||||||
|
|
||||||
|
|
||||||
@cli.argument('-o', '--output', arg_only=True, type=Path, help='File to write to')
|
|
||||||
@cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
|
|
||||||
@cli.argument('filename', arg_only=True, help='Configurator JSON file')
|
|
||||||
@cli.subcommand('Creates a keymap.c from a QMK Configurator export.', hidden=True)
|
|
||||||
def json_keymap(cli):
|
|
||||||
"""Renamed to `qmk json2c`.
|
|
||||||
"""
|
|
||||||
cli.log.error('This command has been renamed to `qmk json2c`.')
|
|
||||||
return False
|
|
||||||
@@ -12,7 +12,8 @@ from milc import cli
|
|||||||
def pytest(cli):
|
def pytest(cli):
|
||||||
"""Run several linting/testing commands.
|
"""Run several linting/testing commands.
|
||||||
"""
|
"""
|
||||||
nose2 = cli.run(['nose2', '-v', '-t' 'lib/python', *cli.args.test], capture_output=False, stdin=DEVNULL)
|
nose2 = cli.run(['nose2', '-v', '-t'
|
||||||
|
'lib/python', *cli.args.test], capture_output=False, stdin=DEVNULL)
|
||||||
flake8 = cli.run(['flake8', 'lib/python'], capture_output=False, stdin=DEVNULL)
|
flake8 = cli.run(['flake8', 'lib/python'], capture_output=False, stdin=DEVNULL)
|
||||||
|
|
||||||
return flake8.returncode | nose2.returncode
|
return flake8.returncode | nose2.returncode
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ QMK_FIRMWARE_UPSTREAM = 'qmk/qmk_firmware'
|
|||||||
MAX_KEYBOARD_SUBFOLDERS = 5
|
MAX_KEYBOARD_SUBFOLDERS = 5
|
||||||
|
|
||||||
# Supported processor types
|
# Supported processor types
|
||||||
CHIBIOS_PROCESSORS = 'cortex-m0', 'cortex-m0plus', 'cortex-m3', 'cortex-m4', 'MKL26Z64', 'MK20DX128', 'MK20DX256', 'MK66FX1M0', 'STM32F042', 'STM32F072', 'STM32F103', 'STM32F303', 'STM32F401', 'STM32F407', 'STM32F411', 'STM32F446', 'STM32G431', 'STM32G474', 'STM32L412', 'STM32L422', 'STM32L433', 'STM32L443', 'GD32VF103', 'WB32F3G71'
|
CHIBIOS_PROCESSORS = 'cortex-m0', 'cortex-m0plus', 'cortex-m3', 'cortex-m4', 'MKL26Z64', 'MK20DX128', 'MK20DX256', 'MK66FX1M0', 'STM32F042', 'STM32F072', 'STM32F103', 'STM32F303', 'STM32F401', 'STM32F405', 'STM32F407', 'STM32F411', 'STM32F446', 'STM32G431', 'STM32G474', 'STM32L412', 'STM32L422', 'STM32L433', 'STM32L443', 'GD32VF103', 'WB32F3G71'
|
||||||
LUFA_PROCESSORS = 'at90usb162', 'atmega16u2', 'atmega32u2', 'atmega16u4', 'atmega32u4', 'at90usb646', 'at90usb647', 'at90usb1286', 'at90usb1287', None
|
LUFA_PROCESSORS = 'at90usb162', 'atmega16u2', 'atmega32u2', 'atmega16u4', 'atmega32u4', 'at90usb646', 'at90usb647', 'at90usb1286', 'at90usb1287', None
|
||||||
VUSB_PROCESSORS = 'atmega32a', 'atmega328p', 'atmega328', 'attiny85'
|
VUSB_PROCESSORS = 'atmega32a', 'atmega328p', 'atmega328', 'attiny85'
|
||||||
|
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ def is_keyboard(keyboard_name):
|
|||||||
if keyboard_name:
|
if keyboard_name:
|
||||||
keyboard_path = QMK_FIRMWARE / 'keyboards' / keyboard_name
|
keyboard_path = QMK_FIRMWARE / 'keyboards' / keyboard_name
|
||||||
rules_mk = keyboard_path / 'rules.mk'
|
rules_mk = keyboard_path / 'rules.mk'
|
||||||
|
|
||||||
return rules_mk.exists()
|
return rules_mk.exists()
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +0,0 @@
|
|||||||
{
|
|
||||||
"keyboard":"handwired/onekey/pytest",
|
|
||||||
"keymap":"pytest_unittest",
|
|
||||||
"layout":"LAYOUT",
|
|
||||||
"layers":[["KC_A"]]
|
|
||||||
}
|
|
||||||
@@ -113,21 +113,21 @@ def test_list_keymaps_community():
|
|||||||
|
|
||||||
|
|
||||||
def test_list_keymaps_kb_only():
|
def test_list_keymaps_kb_only():
|
||||||
result = check_subcommand('list-keymaps', '-kb', 'niu_mini')
|
result = check_subcommand('list-keymaps', '-kb', 'moonlander')
|
||||||
check_returncode(result)
|
check_returncode(result)
|
||||||
assert 'default' and 'via' in result.stdout
|
assert 'default' and 'oyrx' and 'webusb' in result.stdout
|
||||||
|
|
||||||
|
|
||||||
def test_list_keymaps_vendor_kb():
|
def test_list_keymaps_vendor_kb():
|
||||||
result = check_subcommand('list-keymaps', '-kb', 'ai03/lunar')
|
result = check_subcommand('list-keymaps', '-kb', 'planck/ez')
|
||||||
check_returncode(result)
|
check_returncode(result)
|
||||||
assert 'default' and 'via' in result.stdout
|
assert 'default' and 'oryx' and 'webusb' in result.stdout
|
||||||
|
|
||||||
|
|
||||||
def test_list_keymaps_vendor_kb_rev():
|
# def test_list_keymaps_vendor_kb_rev():
|
||||||
result = check_subcommand('list-keymaps', '-kb', 'kbdfans/kbd67/mkiirgb/v2')
|
# result = check_subcommand('list-keymaps', '-kb', 'kbdfans/kbd67/mkiirgb/v2')
|
||||||
check_returncode(result)
|
# check_returncode(result)
|
||||||
assert 'default' and 'via' in result.stdout
|
# assert 'default' and 'via' in result.stdout
|
||||||
|
|
||||||
|
|
||||||
def test_list_keymaps_no_keyboard_found():
|
def test_list_keymaps_no_keyboard_found():
|
||||||
|
|||||||
Reference in New Issue
Block a user