paramiko_mock

This module provides a set of classes to mock the paramiko library.

Classes that do not contain a docstring will not be included in the documentation. Some classes are intended to be used internally for the and are not recommended to be used directly without the public interfaces.

We cannot guarantee that the internal classes will not change in minor release so proceed with caution when using them.

`BadSetupError`

Bases: Exception

This exception is raised when the setup of the ParamikoMock is incorrect

Source code in src/paramiko_mock/exceptions.py

class BadSetupError(Exception):
    """
    This exception is raised when the setup of the ParamikoMock is incorrect
    """
    pass

`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

`LocalFileMock`

This class mocks a file in the local filesystem.

Source code in src/paramiko_mock/local_filesystem_mock.py

class LocalFileMock():
    """
    This class mocks a file in the local filesystem.
    """
    write_history: list[Any] = []
    file_content: Any = None

    def write(self, data: Any) -> None:
        self.write_history.append(data)
        if self.file_content is None:
            self.file_content = data
        else:
            self.file_content += data

`LocalFilesystemMock`

LocalFilesystemMock is a class that stores the mocked local filesystem. This is mainly an internal class and should not be used directly.

Source code in src/paramiko_mock/local_filesystem_mock.py

class LocalFilesystemMock():
    """
    LocalFilesystemMock is a class that stores the mocked local filesystem.
    __This is mainly an internal class and should not be used directly.__
    """
    file_system: dict[str, LocalFileMock] = {}

    def add_file(self, path: str, file_mock: LocalFileMock) -> None:
        self.file_system[path] = file_mock

    def get_file(self, path: str) -> LocalFileMock | None:
        return self.file_system.get(path)

    def remove_file(self, path: str) -> None:
        self.file_system.pop(path, None)

`ParamikoMockEnviron`

This class is the Coordinator for the ParamikoMock environment. It stores information about the remote devices and the local filesystem.