cli.py

"""
This module is a CLI for helping with development of the Baboon Tracking Project.
"""

# These are default python packages.  No installed modules here.
import argparse
import importlib
import json
import os
import subprocess
import sys

from src.cli_plugins.cli_plugin import CliPlugin


def _short_circuit():
    if len(sys.argv) > 1 and sys.argv[1].lower() != "shell":
        os.environ["CLI_ACTIVE"] = "1"

        subprocess.check_call(
            ["poetry", "run", "python", "./cli.py"] + sys.argv[1:],
            shell=(sys.platform == "win32"),
        )
    elif len(sys.argv) > 1 and sys.argv[1].lower() == "shell":
        from src.cli_plugins.shell import (  # pylint: disable=import-outside-toplevel
            shell,
        )

        shell()
    else:
        return False

    return True


def main():
    """
    Main entry point for CLI.
    """

    sys.path.append(os.getcwd() + "/src")

    if os.getenv("VIRTUAL_ENV") is None or (
        os.getenv("TRAVIS") is not None and os.getenv("CLI_ACTIVE") is None
    ):
        from src.cli_plugins.install import (  # pylint: disable=import-outside-toplevel
            install,
        )

        install()

        if _short_circuit():
            return

    parser = argparse.ArgumentParser(description="Baboon Command Line Interface")

    subparsers = parser.add_subparsers(dest="command")
    subparsers.required = True

    # We import the Cli plugin list from a json file instead of yaml,
    # Python's yaml support is not built in
    with open("./src/cli_plugins/plugins.json", "r", encoding="utf8") as f:
        plugins_dict = json.load(f)

    # Plugins are loaded dynamically from ./src/cli_plugins/plugins.json
    for plugin in plugins_dict["plugins"]:
        for subcommand in plugin["subcommands"]:
            subparser = subparsers.add_parser(
                subcommand, description=plugin["description"]
            )

            try:
                module = importlib.import_module(
                    "." + plugin["module"], "src.cli_plugins"
                )
            except ModuleNotFoundError as err:
                print(
                    "While loading plugins, ran into error: " + str(err),
                    file=sys.stderr,
                )
                print(
                    "Please run `./cli shell` to enter python environment",
                    file=sys.stderr,
                )
                sys.exit(1)

            class_type = getattr(module, plugin["class"])

            cli_plugin: CliPlugin = class_type(subparser)
            subparser.set_defaults(run_plugin=cli_plugin.execute)

    args = parser.parse_args()
    args.run_plugin(args)


if __name__ == "__main__":
    main()