artiq/frontend/artiq_client.py

#!/usr/bin/env python3

import argparse
import time
import asyncio
import sys
from operator import itemgetter

from prettytable import PrettyTable

from artiq.management.pc_rpc import Client
from artiq.management.sync_struct import Subscriber
from artiq.management.tools import clear_screen, format_run_arguments
from artiq.management import pyon


def _get_args():
    parser = argparse.ArgumentParser(description="ARTIQ CLI client")
    parser.add_argument(
        "-s", "--server", default="::1",
        help="hostname or IP of the master to connect to")
    parser.add_argument(
        "--port", default=None, type=int,
        help="TCP port to use to connect to the master")

    subparsers = parser.add_subparsers(dest="action")
    subparsers.required = True

    parser_add = subparsers.add_parser("submit", help="submit an experiment")
    parser_add.add_argument(
        "-p", "--periodic", default=None, type=float,
        help="run the experiment periodically every given number of seconds")
    parser_add.add_argument(
        "-t", "--timeout", default=None, type=float,
        help="specify a timeout for the experiment to complete")
    parser_add.add_argument("-u", "--unit", default=None,
                            help="unit to run")
    parser_add.add_argument("file", help="file containing the unit to run")
    parser_add.add_argument("arguments", nargs="*",
                            help="run arguments")

    parser_cancel = subparsers.add_parser("cancel",
                                          help="cancel an experiment")
    parser_cancel.add_argument("-p", "--periodic", default=False,
                               action="store_true",
                               help="cancel a periodic experiment")
    parser_cancel.add_argument("rid", type=int,
                               help="run identifier (RID/PRID)")

    parser_set_device = subparsers.add_parser(
        "set-device", help="add or modify a device")
    parser_set_device.add_argument("name", help="name of the device")
    parser_set_device.add_argument("description",
                                   help="description in PYON format")

    parser_del_device = subparsers.add_parser(
        "del-device", help="delete a device")
    parser_del_device.add_argument("name", help="name of the device")

    parser_set_parameter = subparsers.add_parser(
        "set-parameter", help="add or modify a parameter")
    parser_set_parameter.add_argument("name", help="name of the parameter")
    parser_set_parameter.add_argument("value",
                                      help="value in PYON format")

    parser_del_parameter = subparsers.add_parser(
        "del-parameter", help="delete a parameter")
    parser_del_parameter.add_argument("name", help="name of the parameter")

    parser_show = subparsers.add_parser(
        "show", help="show schedule, devices or parameters")
    parser_show.add_argument(
        "what",
        help="select object to show: queue/periodic/devices/parameters")

    return parser.parse_args()


def _parse_arguments(arguments):
    d = {}
    for argument in arguments:
        name, value = argument.split("=")
        d[name] = pyon.decode(value)
    return d


def _action_submit(remote, args):
    try:
        arguments = _parse_arguments(args.arguments)
    except:
        print("Failed to parse run arguments")
        sys.exit(1)

    run_params = {
        "file": args.file,
        "unit": args.unit,
        "arguments": arguments
    }
    if args.periodic is None:
        rid = remote.run_once(run_params, args.timeout)
        print("RID: {}".format(rid))
    else:
        prid = remote.run_periodic(run_params, args.timeout,
                                   args.periodic)
        print("PRID: {}".format(prid))


def _action_cancel(remote, args):
    if args.periodic:
        remote.cancel_periodic(args.rid)
    else:
        remote.cancel_once(args.rid)


def _action_set_device(remote, args):
    remote.set_device(args.name, pyon.decode(args.description))


def _action_del_device(remote, args):
    remote.del_device(args.name)


def _action_set_parameter(remote, args):
    remote.set_parameter(args.name, pyon.decode(args.value))


def _action_del_parameter(remote, args):
    remote.del_parameter(args.name)


def _show_queue(queue):
    clear_screen()
    if queue:
        table = PrettyTable(["RID", "File", "Unit", "Timeout", "Arguments"])
        for rid, run_params, timeout in queue:
            row = [rid, run_params["file"]]
            for x in run_params["unit"], timeout:
                row.append("-" if x is None else x)
            row.append(format_run_arguments(run_params["arguments"]))
            table.add_row(row)
        print(table)
    else:
        print("Queue is empty")


def _show_periodic(periodic):
    clear_screen()
    if periodic:
        table = PrettyTable(["Next run", "PRID", "File", "Unit",
                             "Timeout", "Period", "Arguments"])
        sp = sorted(periodic.items(), key=lambda x: (x[1][0], x[0]))
        for prid, (next_run, run_params, timeout, period) in sp:
            row = [time.strftime("%m/%d %H:%M:%S", time.localtime(next_run)),
                   prid, run_params["file"]]
            for x in run_params["unit"], timeout:
                row.append("-" if x is None else x)
            row.append(period)
            row.append(format_run_arguments(run_params["arguments"]))
            table.add_row(row)
        print(table)
    else:
        print("No periodic schedule")


def _show_devices(devices):
    clear_screen()
    table = PrettyTable(["Name", "Description"])
    table.align["Description"] = "l"
    for k, v in sorted(devices.items(), key=itemgetter(0)):
        table.add_row([k, pyon.encode(v, True)])
    print(table)


def _show_parameters(parameters):
    clear_screen()
    table = PrettyTable(["Parameter", "Value"])
    for k, v in sorted(parameters.items(), key=itemgetter(0)):
        table.add_row([k, str(v)])
    print(table)


def _run_subscriber(host, port, subscriber):
    if port is None:
        port = 8887
    loop = asyncio.get_event_loop()
    try:
        loop.run_until_complete(subscriber.connect(host, port))
        try:
            loop.run_until_complete(asyncio.wait_for(subscriber.receive_task,
                                                     None))
            print("Connection to master lost")
        finally:
            loop.run_until_complete(subscriber.close())
    finally:
        loop.close()


def _show_list(args, notifier_name, display_fun):
    l = []
    def init_l(x):
        l[:] = x
        return l
    subscriber = Subscriber(notifier_name, init_l,
                            lambda: display_fun(l))
    _run_subscriber(args.server, args.port, subscriber)


def _show_dict(args, notifier_name, display_fun):
    d = dict()
    def init_d(x):
        d.clear()
        d.update(x)
        return d
    subscriber = Subscriber(notifier_name, init_d,
                            lambda: display_fun(d))
    _run_subscriber(args.server, args.port, subscriber)


def main():
    args = _get_args()
    action = args.action.replace("-", "_")
    if action == "show":
        if args.what == "queue":
            _show_list(args, "queue", _show_queue)
        elif args.what == "periodic":
            _show_dict(args, "periodic", _show_periodic)
        elif args.what == "devices":
            _show_dict(args, "devices", _show_devices)
        elif args.what == "parameters":
            _show_dict(args, "parameters", _show_parameters)
        else:
            print("Unknown object to show, use -h to list valid names.")
            sys.exit(1)
    else:
        port = 8888 if args.port is None else args.port
        if action in ("submit", "cancel"):
            target_name = "master_schedule"
        else:
            target_name = "master_dpdb"
        remote = Client(args.server, port, target_name)
        try:
            globals()["_action_" + action](remote, args)
        finally:
            remote.close_rpc()

if __name__ == "__main__":
    main()