-
Notifications
You must be signed in to change notification settings - Fork 201
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
pc_rpc: support for method listing, frontend: artiq_rpctool, +fixes b…
…y SB
1 parent
6d11da3
commit b396f5d
Showing
7 changed files
with
217 additions
and
43 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
#!/usr/bin/env python3 | ||
|
||
import argparse | ||
import textwrap | ||
import sys | ||
|
||
from artiq.protocols.pc_rpc import Client | ||
|
||
|
||
def get_argparser(): | ||
parser = argparse.ArgumentParser( | ||
description="ARTIQ RPC tool") | ||
parser.add_argument("server", | ||
help="hostname or IP of the controller to connect to") | ||
parser.add_argument("port", type=int, | ||
help="TCP port to use to connect to the controller") | ||
subparsers = parser.add_subparsers(dest="action") | ||
subparsers.required = True | ||
subparsers.add_parser("list-targets", help="list existing targets") | ||
parser_list_methods = subparsers.add_parser("list-methods", | ||
help="list target's methods") | ||
parser_list_methods.add_argument("-t", "--target", help="target name") | ||
parser_call = subparsers.add_parser("call", help="call a target's method") | ||
parser_call.add_argument("-t", "--target", help="target name") | ||
parser_call.add_argument("method", help="method name") | ||
parser_call.add_argument("args", nargs=argparse.REMAINDER, | ||
help="arguments") | ||
return parser | ||
|
||
|
||
def list_targets(target_names, id_parameters): | ||
print("Target(s): " + ", ".join(target_names)) | ||
if id_parameters is not None: | ||
print("Parameters: " + id_parameters) | ||
|
||
|
||
def list_methods(remote): | ||
methods = remote.get_rpc_method_list() | ||
for name, (argspec, docstring) in sorted(methods.items()): | ||
args = "" | ||
for arg in argspec["args"]: | ||
args += arg | ||
if argspec["defaults"] is not None: | ||
kword_index = len(argspec["defaults"]) - len(argspec["args"])\ | ||
+ argspec["args"].index(arg) | ||
if kword_index >= 0: | ||
if argspec["defaults"][kword_index] == Ellipsis: | ||
args += "=..." | ||
else: | ||
args += "={}".format(argspec["defaults"][kword_index]) | ||
if argspec["args"].index(arg) < len(argspec["args"]) - 1: | ||
args += ", " | ||
if argspec["varargs"] is not None: | ||
args += ", *{}".format(argspec["varargs"]) | ||
elif len(argspec["kwonlyargs"]) > 0: | ||
args += ", *" | ||
for kwonlyarg in argspec["kwonlyargs"]: | ||
args += ", {}".format(kwonlyarg) | ||
if kwonlyarg in argspec["kwonlydefaults"]: | ||
if argspec["kwonlydefaults"][kwonlyarg] == Ellipsis: | ||
args += "=..." | ||
else: | ||
args += "={}".format(argspec["kwonlydefaults"][kwonlyarg]) | ||
if argspec["varkw"] is not None: | ||
args += ", **{}".format(argspec["varkw"]) | ||
print("{}({})".format(name, args)) | ||
if docstring is not None: | ||
print(textwrap.indent(docstring, " ")) | ||
print() | ||
|
||
|
||
def call_method(remote, method_name, args): | ||
method = getattr(remote, method_name) | ||
if args != []: | ||
args = eval(" ".join(args)) | ||
try: | ||
iter(args) | ||
except TypeError: | ||
# not iterable | ||
ret = method(args) | ||
else: | ||
# iterable | ||
ret = method(*args) | ||
else: | ||
ret = method() | ||
if ret is not None: | ||
print("{}".format(ret)) | ||
|
||
|
||
def main(): | ||
args = get_argparser().parse_args() | ||
|
||
remote = Client(args.server, args.port, None) | ||
|
||
targets, id_parameters = remote.get_rpc_id() | ||
|
||
if args.action != "list-targets": | ||
# If no target specified and remote has only one, then use this one. | ||
# Exit otherwise. | ||
if len(targets) > 1 and args.target is None: | ||
print("Remote server has several targets, please supply one with " | ||
"-t") | ||
sys.exit(1) | ||
elif args.target is None: | ||
args.target = targets[0] | ||
remote.select_rpc_target(args.target) | ||
|
||
if args.action == "list-targets": | ||
list_targets(targets, id_parameters) | ||
elif args.action == "list-methods": | ||
list_methods(remote) | ||
elif args.action == "call": | ||
call_method(remote, args.method, args.args) | ||
else: | ||
print("Unrecognized action: {}".format(args.action)) | ||
|
||
if __name__ == "__main__": | ||
main() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters