kmk_firmware/kmk/key_validators.py

import sys

from kmk.consts import TYPING_PLATFORMS
from kmk.types import (
    KeySeqSleepMeta,
    LayerKeyMeta,
    ModTapKeyMeta,
    TapDanceKeyMeta,
    UnicodeModeKeyMeta,
)

if sys.platform in TYPING_PLATFORMS:
    from typing import List, Optional

    # Avoid cyclical imports
    from kmk.keys import Key


def key_seq_sleep_validator(ms):
    # type: (float) -> KeySeqSleepMeta
    return KeySeqSleepMeta(ms)


def layer_key_validator(layer, kc=None):
    # type: (int, Optional[Key]) -> LayerKeyMeta
    '''
    Validates the syntax (but not semantics) of a layer key call.  We won't
    have access to the keymap here, so we can't verify much of anything useful
    here (like whether the target layer actually exists). The spirit of this
    existing is mostly that Python will catch extraneous args/kwargs and error
    out.
    '''
    return LayerKeyMeta(layer=layer, kc=kc)


def mod_tap_validator(kc, mods):
    # type: (Key, Optional[List[Key]]) -> ModTapKeyMeta
    '''
    Validates that mod tap keys are correctly used
    '''
    return ModTapKeyMeta(kc=kc, mods=mods)


def tap_dance_key_validator(*codes):
    # type: (*Key) -> TapDanceKeyMeta
    return TapDanceKeyMeta(codes)


def unicode_mode_key_validator(mode):
    # type: (int) -> UnicodeModeKeyMeta
    return UnicodeModeKeyMeta(mode)