Class PodmanCommand

dangerzone/podman/command/command.py:17–225

Main class for executing Podman commands. Attributes: runner (cli_runner.Runner): The runner instance to execute commands. machine (machine_manager.MachineManager): Manager for machine operations.

class PodmanCommand:
    """Main class for executing Podman commands.

    Attributes:
        runner (cli_runner.Runner): The runner instance to execute commands.
        machine (machine_manager.MachineManager): Manager for machine operations.
    """

    GlobalOptions = cli_runner.GlobalOptions

    def __init__(
        self,
        path: Path | None = None,
        privileged: bool = False,
        options: cli_runner.GlobalOptions | None = None,
        env: dict | None = None,
    ):
        """Initialize the PodmanCommand.

        Args:
            path (Path, optional): Path to the Podman executable. Defaults to None.
            privileged (bool, optional): Whether to run commands with elevated privileges. Defaults to False.
            options (cli_runner.GlobalOptions, optional): Global options for Podman commands. Defaults to a new instance of GlobalOptions.
            env (dict, optional): Environment variables for the subprocess. Defaults to None.
        """
        if options is None:
            options = cli_runner.GlobalOptions()
        self.runner = cli_runner.Runner(
            path=path,
            privileged=privileged,
            options=options,
            env=env,
        )
        self.machine = machine_manager.MachineManager(self.runner)
        self.proc_service: subprocess.Popen | None = None

    def run(
        self,
        cmd: list[str],
        *,
        check: bool = True,
        capture_output=True,
        wait=True,
        **skwargs,
    ) -> str | subprocess.Popen:
        """Run the specified Podman command.

        Args:
            cmd (list[str]): The command to run, as a list of strings.
            check (bool, optional): Whether to check for errors. Defaults to True.
            capture_output (bool, optional): Whether to capture output. Defaults to True.
            wait (bool, optional): Whether to wait for the command to complete. Defaults to True.
            **skwargs: Additional keyword arguments for subprocess.

        Returns:
            Optional[str]: The output of the command if captured, otherwise the
                subprocess.Popen instance.