TheRock/rocm-libraries/shared/rocroller/scripts/lib/rrperf/cli.py

# Copyright Advanced Micro Devices, Inc., or its affiliates.
# SPDX-License-Identifier: MIT

"""
rocRoller performance tracking suite command line interface.

New, modular way to add subcommands to rrperf:

Make a top-level module inside rrperf. It must implement get_args() and run().

- get_args() should take an argparse.ArgumentParser and add all command-line arguments
  to it.
- run() should take the parsed arguments object and run the relevant command.

The docstring for the module will be used as the description for the subcommand (under
`rrperf <command> --help`).  The docstring for the `run` function will be used as the
 help text for the subcommand (under `rrperf --help`).

"""

import argparse
import inspect

import rrperf


def main():
    parser = argparse.ArgumentParser(
        description="rocRoller performance tracking suite."
    )
    subparsers = parser.add_subparsers(dest="command", required=True)

    for name, mod in rrperf.__dict__.items():
        if hasattr(mod, "get_args") and hasattr(mod, "run"):
            mod_parser = subparsers.add_parser(
                name,
                help=inspect.getdoc(mod.run),
                description=inspect.getdoc(mod),
                formatter_class=argparse.RawDescriptionHelpFormatter,
            )
            mod.get_args(mod_parser)

    args = parser.parse_args()

    if (
        "group_results" in args.__dict__
        and args.group_results
        and not args.exclude_boxplot
    ):
        parser.error("--group_results cannot be used without --exclude_boxplot")

    getattr(rrperf, args.command).run(args)