run_cmd() and friends: Make args a list[str]

This is a code maintenance commit: some run_xxx() helper functions
take a string, some a list, and some just digest all arguments and
pass them on as a list to exec() to be executed. That's highly
inconsistent. This commit changes that to list-only.

Except for the run_cmd() method of SSHClient, which is still run as a
shell method, because, erm, it's a shell. Might be changed in the
future for consistency reasons.

Signed-off-by: Jan Lindemann <jan@janware.com>
This commit is contained in:
Jan Lindemann 2026-02-26 15:55:52 +01:00
commit b81406e11a
12 changed files with 22 additions and 23 deletions

View file

@ -26,7 +26,7 @@ def pretty_cmd(cmd: list[str], wd=None):
return ret
async def run_cmd(
*args: str,
args: list[str],
wd: str|None = None,
throw: bool = True,
verbose: bool = False,
@ -39,7 +39,7 @@ async def run_cmd(
Run a command asynchronously and return its output
Args:
*args: Command and arguments
args: Command and arguments
wd: Optional working directory
throw: Raise an exception on non-zero exit status if True
verbose: Emit log output while the command runs
@ -225,7 +225,7 @@ async def run_curl(args: list[str], parse_json: bool=True, wd=None, throw=None,
if not verbose:
cmd.append('-s')
cmd.extend(args)
ret, stderr = await run_cmd(*cmd, wd=wd, throw=throw, verbose=verbose, cmd_input=cmd_input)
ret, stderr = await run_cmd(cmd, wd=wd, throw=throw, verbose=verbose, cmd_input=cmd_input)
if parse_json:
try:
return json.loads(ret)
@ -259,7 +259,7 @@ async def run_askpass(askpass_env: list[str], key: AskpassKey, host: str|None=No
continue # Can't get user name from SSH_ASKPASS
case AskpassKey.Password:
exe_arg += 'Password'
ret, stderr = await run_cmd(exe, exe_arg, throw=False)
ret, stderr = await run_cmd([exe, exe_arg], throw=False)
if ret is not None:
return ret
return None
@ -279,7 +279,7 @@ async def run_sudo(cmd: list[str], mod_env: dict[str, str] = {}, opts: list[str]
cmdline.extend(cmd)
if interactive:
cmd_input = "mode:interactive"
stdout, stderr = await run_cmd(*cmdline, throw=True, verbose=verbose, env=env, cmd_input=cmd_input)
stdout, stderr = await run_cmd(cmdline, throw=True, verbose=verbose, env=env, cmd_input=cmd_input)
return stdout, stderr
async def get_username(args: Namespace|None=None, url: str|None=None, askpass_env: list[str]=[]) -> str: # export
@ -328,7 +328,7 @@ async def get_profile_env(throw: bool=True, keep: Iterable[str]|bool=False) -> d
}
# Run bash as a login shell, which sources /etc/profile, then print environment as NUL-separated key=value pairs
cmd = ['/usr/bin/env', '-i', '/bin/bash', '-lc', 'env -0']
stdout, stderr = await run_cmd(*cmd, throw=throw, output_encoding="bytes", verbose=True, env=env)
stdout, stderr = await run_cmd(cmd, throw=throw, output_encoding="bytes", verbose=True, env=env)
ret: dict[str, str] = {}
for entry in stdout.split(b"\0"):
if not entry: