cli.py

#!/usr/bin/env python3
#
# Copyright (c) 2010 - 2026, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
# All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this
#    list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions and the following disclaimer in the documentation
#    and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its
#    contributors may be used to endorse or promote products derived from
#    this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# We kindly request you to use one or more of the following phrases to refer to
# foxBMS in your hardware, software, documentation or advertising materials:
#
# - "This product uses parts of foxBMS®"
# - "This product includes parts of foxBMS®"
# - "This product is derived from foxBMS®"

"""Define and register the foxBMS command-line interface commands."""

import warnings

import click
import colorama

from .commands.c_bms import bms
from .commands.c_bootloader import bootloader
from .commands.c_com import com_test
from .commands.c_db import db
from .commands.c_etl import etl
from .commands.c_gui import gui
from .commands.c_log import log
from .commands.c_plot import plot
from .commands.c_run_program import run_program
from .commands.c_run_script import run_script
from .foxbms_version import __version__
from .helpers.click_helpers import HELP_NAMES, echo
from .helpers.logger import ignore_third_party_logging
from .helpers.misc import (
    ROOT_IS_PROJECT,
    create_pre_commit_file,
    initialize_path_variable_for_foxbms,
    set_other_environment_variables_for_foxbms,
)

colorama.init()
warnings.simplefilter(action="ignore", category=FutureWarning)


def get_program_config() -> dict[str, str]:
    """Return a mapping with high-level foxBMS configuration details."""
    return {
        "foxBMS 2": __version__,
    }


# Options for main
@click.group(context_settings=HELP_NAMES, invoke_without_command=True)
@click.version_option(version=__version__)
@click.option(
    "-s",
    "--show-config",
    default=False,
    is_flag=True,
    help="Shows foxBMS configuration information.",
)
@click.pass_context
def main(ctx: click.Context, show_config: bool) -> None:
    """Run the top-level ``fox.py`` command group.

    Args:
        ctx: Click context for command dispatch and help rendering.
        show_config: If ``True``, print version/configuration information.
    """
    ignore_third_party_logging()
    initialize_path_variable_for_foxbms()
    set_other_environment_variables_for_foxbms()
    create_pre_commit_file()
    if show_config:
        config = get_program_config()
        padding = max(len(x) for x in config)
        for key, value in config.items():
            echo(f"{key}:{' ' * (padding - len(key))} {value}")
    elif not ctx.invoked_subcommand:
        echo(main.get_help(ctx))


if ROOT_IS_PROJECT:
    from .commands.c_build import waf
    from .commands.c_cli_unittest import cli_unittest
    from .commands.c_embedded_ut import ceedling
    from .commands.c_ide import ide
    from .commands.c_install import install
    from .commands.c_misc import misc
    from .commands.c_pre_commit import pre_commit
    from .commands.c_release import release

    main.add_command(ceedling)
    main.add_command(cli_unittest)
    main.add_command(ide)
    main.add_command(install)
    main.add_command(misc)
    main.add_command(pre_commit)
    main.add_command(release)
    main.add_command(waf)

main.add_command(bootloader)
main.add_command(bms)
main.add_command(com_test)
main.add_command(db)
main.add_command(etl)
main.add_command(gui)
main.add_command(log)
main.add_command(plot)
main.add_command(run_program)
main.add_command(run_script)