pw_console/py/pw_console/__main__.py

# Copyright 2020 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
"""Pigweed console main entry point."""

import asyncio
import argparse
import logging
import os
import pprint
import sys
from collections import OrderedDict
from configparser import ConfigParser
from datetime import datetime
from pathlib import Path

import pw_cli.log
from pw_tokenizer.database import LoadTokenDatabases

from pw_console.color_scheme import ColorScheme
from pw_console.console_app import ConsoleApp
from pw_console.key_bindings import KeyBindings

_LOG = logging.getLogger(__name__)

_pretty_print = pprint.PrettyPrinter(indent=1, width=120).pprint
_pretty_format = pprint.PrettyPrinter(indent=1, width=120).pformat


def build_argument_parser():
    """Setup argparse."""
    def log_level(arg: str) -> int:
        try:
            return getattr(logging, arg.upper())
        except AttributeError as err:
            raise argparse.ArgumentTypeError(
                f"{arg.upper()} is not a valid log level") from err

    parser = argparse.ArgumentParser(description=__doc__)

    parser.add_argument("-l",
                        "--loglevel",
                        type=log_level,
                        default=logging.INFO,
                        help="Set the log level "
                        "(debug, info, warning, error, critical)")
    parser.add_argument("--logfile", help="Pigweed Console debug log file.")

    pw_root_path = Path(
        os.environ.get('PW_ROOT',
                       Path(__file__).parent.parent.parent.parent))
    config_file_name = '.pw_console.conf'
    config_file_path = pw_root_path / config_file_name
    parser.add_argument("-c",
                        "--config-file",
                        default=config_file_path.as_posix(),
                        help="File to write device logs. "
                        f"Default: {config_file_path.as_posix()}")

    parser.add_argument("--tokenizer-databases",
                        metavar='elf_or_token_database',
                        nargs="+",
                        action=LoadTokenDatabases,
                        help="Path to tokenizer database csv file(s).")

    parser.add_argument("--show-default-keybinds",
                        action="store_true",
                        help="Show default keybindings.")

    log_default_filename = datetime.now().strftime(
        "%Y-%m-%d_%H%M") + "_log.txt"
    parser.add_argument("--device-logfile",
                        default=log_default_filename,
                        help="File to write device logs. "
                        f"Default: {log_default_filename}")

    parser.add_argument('terminal_args',
                        nargs=argparse.REMAINDER,
                        help='Arguments to forward to the terminal widget.')

    return parser


def load_config_file(args):
    """Load config file."""
    cfg = ConfigParser(allow_no_value=True)

    cfg.add_section('keys')

    if args.show_default_keybinds:
        binds = {
            k: ", ".join(v)
            for k, v in KeyBindings({}).key_bindings.items()
        }
        cfg['keys'] = OrderedDict(sorted(binds.items(), key=lambda t: t[0]))
        cfg.write(sys.stdout)
        return cfg

    cfg.add_section('settings')

    if args.config_file:
        cfg.read(Path(args.config_file).as_posix())

    return cfg


def main() -> int:
    """Pigweed Console."""

    parser = build_argument_parser()
    args, unused_extra_args = parser.parse_known_args()

    if "--" in args.terminal_args:
        args.terminal_args.remove("--")

    pw_cli.log.install(args.loglevel, True, False, args.logfile)

    _LOG.debug(_pretty_format(args))
    _LOG.debug(_pretty_format(unused_extra_args))

    if args.show_default_keybinds:
        cfg = ConfigParser(allow_no_value=True)
        cfg.add_section('keys')
        binds = {
            k: ", ".join(v)
            for k, v in KeyBindings({}).key_bindings.items()
        }
        cfg['keys'] = OrderedDict(sorted(binds.items(), key=lambda t: t[0]))
        cfg.write(sys.stdout)
        return 0

    cfg = load_config_file(args)

    unused_key_bindings = KeyBindings(dict(cfg.items('keys')))
    unused_color_scheme = ColorScheme(
        dict(cfg.items('settings')).get('colorscheme', 'default'), cfg)
    console_app = ConsoleApp(
        args.device_logfile,
        # keys=key_bindings,
        # colors=color_scheme,
        token_databases=args.tokenizer_databases,
        terminal_args=args.terminal_args)
    async_debug = args.loglevel == logging.DEBUG
    asyncio.run(console_app.run(), debug=async_debug)
    return 0


if __name__ == '__main__':
    sys.exit(main())