Source code for osprofiler.cmd.shell

# Copyright 2014 Mirantis Inc.
# All Rights Reserved.
#
#    Licensed under the Apache License, Version 2.0 (the "License"); you may
#    not use this file except in compliance with the License. You may obtain
#    a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.


"""
Command-line interface to the OpenStack Profiler.
"""

import argparse
import inspect
import sys
from typing import Any

from oslo_config import cfg

import osprofiler
from osprofiler.cmd import commands
from osprofiler import exc
from osprofiler import opts




class OSProfilerShell:
    def __init__(self, argv: list[str]) -> None:
        args = self._get_base_parser().parse_args(argv)
        opts.set_defaults(cfg.CONF)

        args.func(args)

    def _get_base_parser(self) -> argparse.ArgumentParser:
        parser = argparse.ArgumentParser(
            prog="osprofiler", description=__doc__.strip(), add_help=True
        )

        parser.add_argument(
            "-v", "--version", action="version", version=osprofiler.__version__
        )

        self._append_subcommands(parser)

        return parser

    def _append_subcommands(
        self, parent_parser: argparse.ArgumentParser
    ) -> None:
        subcommands = parent_parser.add_subparsers(help="<subcommands>")
        for group_cls in commands.BaseCommand.__subclasses__():
            if group_cls.group_name is None:
                continue
            group_parser = subcommands.add_parser(group_cls.group_name)
            subcommand_parser = group_parser.add_subparsers()

            for name, callback in inspect.getmembers(
                group_cls(), predicate=inspect.ismethod
            ):
                command = name.replace("_", "-")
                desc = callback.__doc__ or ""
                help_message = desc.strip().split("\n")[0]
                arguments = getattr(callback, "arguments", [])

                command_parser = subcommand_parser.add_parser(
                    command, help=help_message, description=desc
                )
                for args, kwargs in arguments:
                    command_parser.add_argument(*args, **kwargs)
                command_parser.set_defaults(func=callback)

    def _no_project_and_domain_set(self, args: Any) -> bool:
        if not (
            args.os_project_id
            or (
                args.os_project_name
                and (args.os_user_domain_name or args.os_user_domain_id)
            )
            or (args.os_tenant_id or args.os_tenant_name)
        ):
            return True
        else:
            return False





def main(args: list[str] | None = None) -> int | None:
    if args is None:
        args = sys.argv[1:]

    try:
        OSProfilerShell(args)
    except exc.CommandError as e:
        print(e.message)
        return 1
    return None



if __name__ == "__main__":
    main()