def __init__(self,
command: CommandInterface = None,
*,
current_node: CommandGraphNode | None = None) -> None:
"""A client that resolves calls through the command object interface
Exposes a similar API to the command graph, but performs resolution of
objects. Any navigation done on the command graph is resolved at the
point it is invoked. This command resolution is done via the command
interface.
Parameters
----------
command: CommandInterface
The object that is used to resolve command graph calls, as well as
navigate the command graph.
current_node: CommandGraphNode
The current node that is pointed to in the command graph. If not
specified, the command graph root is used.
"""
if command is None:
command = IPCCommandInterface(Client(find_sockfile()))
self._command = command
self._current_node = current_node if current_node is not None else CommandGraphRoot(
)
def __init__(self,
command: CommandInterface = None,
*,
current_node: GraphType = None) -> None:
"""An interactive client that resolves calls through the gives client
Exposes the command graph API in such a way that it can be traversed
directly on this object. The command resolution for this object is
done via the command interface.
Parameters
----------
command: CommandInterface
The object that is used to resolve command graph calls, as well as
navigate the command graph.
current_node: CommandGraphNode
The current node that is pointed to in the command graph. If not
specified, the command graph root is used.
"""
if command is None:
command = IPCCommandInterface(Client(find_sockfile()))
self._command = command
if current_node is None:
self._current_node = CommandGraphRoot() # type: GraphType
else:
self._current_node = current_node
def cmd_obj(args) -> None:
"Runs tool according to specified arguments."
if args.obj_spec:
sock_file = args.socket or find_sockfile()
ipc_client = Client(sock_file)
cmd_object = IPCCommandInterface(ipc_client)
cmd_client = CommandClient(cmd_object)
obj = get_object(cmd_client, args.obj_spec)
if args.function == "help":
try:
print_commands("-o " + " ".join(args.obj_spec), obj)
except CommandError:
if len(args.obj_spec) == 1:
print(
f"{args.obj_spec} object needs a specified identifier e.g. '-o bar top'."
)
sys.exit(1)
else:
raise
elif args.info:
print(
args.function +
get_formated_info(obj, args.function, args=True, short=False))
else:
ret = run_function(obj, args.function, args.args)
if ret is not None:
pprint.pprint(ret)
else:
print_base_objects()
sys.exit(1)
def test_do_cd(manager):
client = ipc.Client(manager.sockfile)
command = IPCCommandInterface(client)
sh = QSh(command)
assert sh.do_cd("layout") == 'layout'
assert sh.do_cd("0") == 'layout[0]'
assert sh.do_cd("..") == '/'
assert sh.do_cd("layout") == 'layout'
assert sh.do_cd("0/wibble") == 'No such path.'
def test_do_cd(manager):
client = ipc.Client(manager.sockfile)
command = IPCCommandInterface(client)
sh = QSh(command)
assert sh.do_cd("layout") == "layout"
assert sh.do_cd("../layout/0") == "layout[0]"
assert sh.do_cd("..") == "/"
assert sh.do_cd("layout") == "layout"
assert sh.do_cd("../layout0/wibble") == "No such path."
assert sh.do_cd(None) == "/"
def test_ls(manager):
client = ipc.Client(manager.sockfile)
command = IPCCommandInterface(client)
sh = QSh(command)
assert sh.do_ls("") == "bar/ group/ layout/ screen/ widget/ window/"
assert sh.do_ls("layout") == "group/ window/ screen/ 0/ "
assert sh.do_cd("layout") == "layout"
assert sh.do_ls("") == "group/ window/ screen/ 0/ "
assert sh.do_ls("screen") == "layout/ window/ bar/ "
def test_columnize(manager):
client = ipc.Client(manager.sockfile)
command = IPCCommandInterface(client)
sh = QSh(command)
assert sh.columnize(["one", "two"]) == "one two"
sh.termwidth = 1
assert sh.columnize(["one", "two"], update_termwidth=False) == "one\ntwo"
sh.termwidth = 15
v = sh.columnize(["one", "two", "three", "four", "five"], update_termwidth=False)
assert v == 'one two \nthree four \nfive '
def test_call(manager):
client = ipc.Client(manager.sockfile)
command = IPCCommandInterface(client)
sh = QSh(command)
assert sh.process_line("status()") == "OK"
v = sh.process_line("nonexistent()")
assert v == "Command does not exist: nonexistent"
v = sh.process_line("status(((")
assert v == "Invalid command: status((("
v = sh.process_line("status(1)")
assert v.startswith("Caught command exception")
def test_complete(manager):
client = ipc.Client(manager.sockfile)
command = IPCCommandInterface(client)
sh = QSh(command)
assert sh._complete("c", "c") == [
"cd",
"commands",
"critical",
]
assert sh._complete("cd l", "l") == ["layout/"]
assert sh._complete("cd layout/", "layout/") == [
"layout/" + x for x in ["group", "window", "screen", "0"]
]
assert sh._complete("cd layout/", "layout/g") == ["layout/group/"]
def cmd_obj(args) -> None:
"Runs tool according to specified arguments."
if args.obj_spec:
sock_file = args.socket or find_sockfile()
ipc_client = Client(sock_file)
cmd_object = IPCCommandInterface(ipc_client)
cmd_client = InteractiveCommandClient(cmd_object)
obj = get_object(cmd_client, args.obj_spec)
if args.function == "help":
print_commands("-o " + " ".join(args.obj_spec), obj)
elif args.info:
print(get_formated_info(obj, args.function, args=True,
short=False))
else:
ret = run_function(obj, args.function, args.args)
if ret is not None:
pprint.pprint(ret)
else:
print_base_objects()
sys.exit(1)
def test_help(manager):
client = ipc.Client(manager.sockfile)
command = IPCCommandInterface(client)
sh = QSh(command)
assert sh.do_help("nonexistent").startswith("No such command")
assert sh.do_help("help")