gaudiComponentHelp.py

Go to the documentation of this file.

#!/usr/bin/env python3

"""
Print help messages for gaudi components
"""
 
import os
import sys
 
import Configurables
 
from Gaudi import Configuration
 
if __name__ == "__main__":
    from optparse import OptionParser
 
    parser = OptionParser(prog=os.path.basename(sys.argv[0]), usage="%prog [options] ")
    parser.add_option(
        "-l",
        "--list",
        action="store_true",
        dest="list",
        default=False,
        help="list all available components.",
    )
    parser.add_option(
        "-n",
        "--name",
        action="store",
        dest="name",
        help="dump all info about component of given name.",
    )
    parser.set_defaults(root=os.path.join("..", "python"))
    opts, args = parser.parse_args()
 
    if len(args) != 0:
        parser.print_help()
        sys.exit(1)
 
    cfgDb = Configuration.cfgDb
    if opts.list:
        print("Available components:\n%s" % (21 * "="))
        for item in sorted(cfgDb):
            print("  {} (from {})".format(item, cfgDb[item]["lib"]))
        sys.exit()
    elif opts.name:
        name = opts.name
        if name not in cfgDb:
            print(f"Component {name} not found.")
            sys.exit()
        print(
            "\nDumping component information for {}:\n{}".format(
                name, (35 + len(name)) * "="
            )
        )
        print("  Library: {}".format(cfgDb[name]["lib"]))
        print("  Package: {}".format(cfgDb[name]["package"]))
        print("\nProperties:\n%s" % (11 * "-"))
        try:
            properties = getattr(Configurables, name)().getPropertiesWithDescription()
        except AttributeError:
            print("  Not a configurable component. No properties to show.")
            sys.exit()
        for label, (value, desc) in sorted(properties.items()):
            print(
                (
                    "  {}\t : {}\t ({}) ".format(
                        label, value, str(desc).replace("None", " no description ")
                    )
                ).expandtabs(30)
            )
        sys.exit()