Utilities¶
Miscellaneous utility functions¶
Running programs¶
- guidata.utils.misc.run_program(name, args: str = '', cwd: str = None, shell: bool = True, wait: bool = False) None ¶
Run program in a separate process.
- Parameters:
- Raises:
RuntimeError – If program is not installed.
- guidata.utils.misc.is_program_installed(basename: str) str | None ¶
Return program absolute path if installed in PATH, otherwise None.
- guidata.utils.misc.run_shell_command(cmdstr, **subprocess_kwargs)¶
Execute the given shell command.
Note that args and kwargs will be passed to the subprocess call.
If ‘shell’ is given in subprocess_kwargs it must be True, otherwise ProgramError will be raised.
If ‘executable’ is not given in subprocess_kwargs, it will be set to the value of the SHELL environment variable.
Note that stdin, stdout and stderr will be set by default to PIPE unless specified in subprocess_kwargs.
- Str cmdstr:
The string run as a shell command.
- Subprocess_kwargs:
These will be passed to subprocess.Popen.