class documentation

class SubprocessSSHVendor(SSHVendor):

View In Hierarchy

SSH vendor that shells out to the local 'ssh' command.

Method run_command Run a git command over SSH.
def run_command(self, host: str, command: bytes, username: str | None = None, port: int | None = None, password: str | None = None, key_filename: str | None = None, ssh_command: str | None = None, protocol_version: int | None = None) -> SubprocessWrapper: ΒΆ

Run a git command over SSH.

Parameters
host:strSSH host to connect to
command:bytesGit command to run
username:str | NoneOptional username
port:int | NoneOptional port number
password:str | NoneOptional password (not supported)
key_filename:str | NoneOptional SSH key file
ssh_command:str | NoneOptional custom SSH command
protocol_version:int | NoneOptional Git protocol version
Returns
SubprocessWrapperTuple of (subprocess.Popen, Protocol, stderr_stream)