OpenHands/opendevin/parse_commands.py

import os
from dataclasses import dataclass

import yaml


@dataclass()
class Command:
    name: str
    docstring: str | None = None
    signature: str | None = None


def parse_command_file() -> str | None:
    if not os.path.exists("commands.sh"):
        return None
    content = open("commands.sh", "r").read()
    lines = content.split("\n")
    commands: list[Command] = []
    idx = 0
    docs: list[str] = []
    while idx < len(lines):
        line = lines[idx]
        idx += 1
        if line.startswith("# "):
            docs.append(line[2:])
        elif line.strip().endswith("() {"):
            name = line.split()[0][:-2]
            while lines[idx].strip() != "}":
                idx += 1
            docstring, signature = None, name
            docs_dict = yaml.safe_load("\n".join(docs).replace("@yaml", ""))
            if docs_dict is not None:
                docstring = docs_dict.get("docstring")
                arguments = docs_dict.get("arguments", None)
                if "signature" in docs_dict:
                    signature = docs_dict["signature"]
                else:
                    if arguments is not None:
                        for param, settings in arguments.items():
                            if "required" in settings:
                                signature += f" <{param}>"
                            else:
                                signature += f" [<{param}>]"
            command = Command(name, docstring, signature)
            commands.append(command)
            docs = []
    function_docs = ""
    for cmd in commands:
        if cmd.docstring is not None:
            function_docs += f"{cmd.signature or cmd.name} - {cmd.docstring}\n"
    return function_docs