channel_mock

Channel mock for simulating paramiko channel behavior with exit status support.

ChannelMock

Mock class that simulates paramiko channel behavior. This provides the recv_exit_status() method that real paramiko channels have.

Source code in src/paramiko_mock/channel_mock.py

class ChannelMock:
    """
    Mock class that simulates paramiko channel behavior.
    This provides the recv_exit_status() method that real paramiko channels have.
    """

    def __init__(self, exit_status: int = 0):
        """
        Initialize the channel mock with an exit status.

        Args:
            exit_status: The exit status code to return (default: 0)
        """
        self._exit_status = exit_status
        self._closed = False

    def recv_exit_status(self) -> int:
        """
        Simulate the recv_exit_status method of paramiko channels.

        Returns:
            The exit status code
        """
        return self._exit_status

    def set_exit_status(self, exit_status: int) -> None:
        """
        Set the exit status for this channel.

        Args:
            exit_status: The exit status code to set
        """
        self._exit_status = exit_status

    def close(self) -> None:
        """Close the channel."""
        self._closed = True

    @property
    def closed(self) -> bool:
        """Check if the channel is closed."""
        return self._closed

closed property

Check if the channel is closed.

__init__(exit_status=0)

Initialize the channel mock with an exit status.

Parameters:

Name	Type	Description	Default
exit_status	int	The exit status code to return (default: 0)	0

Source code in src/paramiko_mock/channel_mock.py

def __init__(self, exit_status: int = 0):
    """
    Initialize the channel mock with an exit status.

    Args:
        exit_status: The exit status code to return (default: 0)
    """
    self._exit_status = exit_status
    self._closed = False

close()

Close the channel.

Source code in src/paramiko_mock/channel_mock.py

def close(self) -> None:
    """Close the channel."""
    self._closed = True

recv_exit_status()

Simulate the recv_exit_status method of paramiko channels.

Returns:

Type	Description
int	The exit status code

Source code in src/paramiko_mock/channel_mock.py

def recv_exit_status(self) -> int:
    """
    Simulate the recv_exit_status method of paramiko channels.

    Returns:
        The exit status code
    """
    return self._exit_status

set_exit_status(exit_status)

Set the exit status for this channel.

Parameters:

Name	Type	Description	Default
exit_status	int	The exit status code to set	required

Source code in src/paramiko_mock/channel_mock.py

def set_exit_status(self, exit_status: int) -> None:
    """
    Set the exit status for this channel.

    Args:
        exit_status: The exit status code to set
    """
    self._exit_status = exit_status