112 lines
4.8 KiB
Python
112 lines
4.8 KiB
Python
import argparse
|
|
import sys
|
|
|
|
# Import each command module so we can register its subparser.
|
|
# Импортируем каждый модуль команды, чтобы зарегистрировать его подпарсер.
|
|
from cobot.commands import delete as cmd_delete
|
|
from cobot.commands import docker_setup as cmd_docker_setup
|
|
from cobot.commands import doc_setup as cmd_doc_setup
|
|
from cobot.commands import local_setup as cmd_local_setup
|
|
from cobot.commands import robot_setup as cmd_robot_setup
|
|
from cobot.commands import run as cmd_run
|
|
from cobot.commands import setup as cmd_setup
|
|
from cobot.commands import update as cmd_update
|
|
|
|
# Command groups shown in --help output.
|
|
# Add new commands here when introducing other categories.
|
|
# Группы команд, отображаемые в --help.
|
|
# Добавляйте новые команды сюда при создании новых категорий.
|
|
_GROUPS = [
|
|
("Setup", [
|
|
("setup", "first-time setup: docs, build environment, robot config"),
|
|
("local-setup", "install ROS2 Jazzy natively and build the project with colcon"),
|
|
("docker-setup", "build or pull Docker images for KUKA iiwa7"),
|
|
("doc-setup", "deploy or stop the MkDocs documentation server"),
|
|
("robot-setup", "configure cobot-setting.yaml interactively"),
|
|
]),
|
|
("Run", [
|
|
("run", "launch the robot controller or Webots simulator (local or Docker)"),
|
|
]),
|
|
("Management", [
|
|
("update", "pull latest changes from the remote git branch and reinstall cobot"),
|
|
("delete", "remove the project, Docker images, containers, and optionally ROS2"),
|
|
]),
|
|
]
|
|
|
|
_DESCRIPTION = "Lightweight Cobot"
|
|
|
|
|
|
# Custom --help action that prints commands grouped by category instead of a flat list.
|
|
# Кастомный обработчик --help, который выводит команды по категориям, а не одним списком.
|
|
class _GroupedHelpAction(argparse.Action):
|
|
"""Custom argparse action that replaces the default --help output with a grouped
|
|
command listing organized by category (Setup, Run, Management).
|
|
Кастомный обработчик argparse, заменяющий стандартный вывод --help на сгруппированный
|
|
список команд по категориям (Setup, Run, Management).
|
|
"""
|
|
|
|
def __init__(self, option_strings, dest, default=None, required=False, help=None):
|
|
super().__init__(
|
|
option_strings=option_strings,
|
|
dest=dest,
|
|
nargs=0,
|
|
default=default,
|
|
required=required,
|
|
help=help,
|
|
)
|
|
|
|
def __call__(self, parser, namespace, values, option_string=None):
|
|
print(f"usage: cobot [-h] <command> ...\n")
|
|
print(f"{_DESCRIPTION}\n")
|
|
for group_title, commands in _GROUPS:
|
|
print(f"{group_title} commands:")
|
|
for cmd, help_text in commands:
|
|
print(f" {cmd:<22} {help_text}")
|
|
print()
|
|
print("options:")
|
|
print(" -h, --help show this help message and exit")
|
|
parser.exit()
|
|
|
|
|
|
def main():
|
|
"""Entry point for the cobot CLI. Parses arguments and dispatches to the correct command.
|
|
Точка входа CLI cobot. Разбирает аргументы и вызывает нужную команду.
|
|
"""
|
|
parser = argparse.ArgumentParser(
|
|
prog="cobot",
|
|
description=_DESCRIPTION,
|
|
add_help=False,
|
|
)
|
|
parser.add_argument(
|
|
"-h", "--help",
|
|
action=_GroupedHelpAction,
|
|
default=argparse.SUPPRESS,
|
|
help="show this help message and exit",
|
|
)
|
|
|
|
subparsers = parser.add_subparsers(dest="command", metavar="<command>")
|
|
subparsers.required = True
|
|
|
|
_register_commands(subparsers)
|
|
|
|
args = parser.parse_args()
|
|
args.func(args)
|
|
|
|
|
|
def _register_commands(subparsers):
|
|
"""Register all command subparsers. Each command module calls register() which adds its
|
|
own subparser and sets args.func to its run() function.
|
|
Регистрирует все подпарсеры команд. Каждый модуль вызывает register(), добавляет свой
|
|
подпарсер и устанавливает args.func на свою функцию run().
|
|
"""
|
|
# Each module registers its own subparser and sets args.func to its run() function.
|
|
# Каждый модуль регистрирует свой подпарсер и устанавливает args.func на свою функцию run().
|
|
cmd_setup.register(subparsers)
|
|
cmd_local_setup.register(subparsers)
|
|
cmd_docker_setup.register(subparsers)
|
|
cmd_doc_setup.register(subparsers)
|
|
cmd_robot_setup.register(subparsers)
|
|
cmd_run.register(subparsers)
|
|
cmd_update.register(subparsers)
|
|
cmd_delete.register(subparsers)
|