Source code for reemote.operations.sftp.rmdir

# Copyright (c) 2025 Kim Jarvis TPF Software Services S.A. kim.jarvis@tpfsystems.com 
# This software is licensed under the MIT License. See the LICENSE file for details.
#
import asyncssh
from reemote.command import Command




class Rmdir:
    """
    A class to encapsulate the functionality of rmdir in Unix-like operating systems.

    Attributes:
        path (str): The directory path to remove.

    **Examples:**

    .. code:: python

        yield Rmdir(path='/home/user/empty_directory')

    Usage:
        This class is designed to be used in a generator-based workflow where commands
        are yielded for execution.

    Notes:
        The directory must be empty for rmdir to succeed.
    """

    def __init__(self, path: str):
        self.path = path

    def __repr__(self):
        return f"Rmdir(path={self.path!r})"

    @staticmethod
    async def _rmdir_callback(host_info, global_info, command, cp, caller):
        """Static callback method for directory removal"""

        # Validate host_info (matching Remove error handling)
        required_keys = ['host', 'username', 'password']
        for key in required_keys:
            if key not in host_info or host_info[key] is None:
                raise ValueError(f"Missing or invalid value for '{key}' in host_info.")

        # Validate caller attributes (matching Remove error handling)
        if caller.path is None:
            raise ValueError("The 'path' attribute of the caller cannot be None.")

        try:
            # Connect to the SSH server and remove the directory
            async with asyncssh.connect(**host_info) as conn:
                async with conn.start_sftp_client() as sftp:
                    await sftp.rmdir(path=caller.path)
        except (OSError, asyncssh.Error) as exc:
            raise  # Re-raise the exception to handle it in the caller

    def execute(self):
        r = yield Command(
            f"{self}",
            local=True,
            callback=self._rmdir_callback,
            caller=self
        )
        r.executed = True
        r.changed = False
        return r