Module pipelines.utils.ftp.client

FTP client implementation

Functions

def assert_connected(func)

Expand source code

def assert_connected(func):
    """
    Decorator that asserts that the FTP client is connected before executing the decorated method
    """

    def wrapper(self, *args, **kwargs):
        if not self._connected:  # pylint: disable=protected-access
            raise RuntimeError("FTP client is not connected")
        return func(self, *args, **kwargs)

    return wrapper

Decorator that asserts that the FTP client is connected before executing the decorated method

Classes

class FTPClient (hostname: str,
username: str,
password: str | None = None,
port: int | None = 21,
passive: bool | None = True,
timeout: int | None = None)

Expand source code

class FTPClient:  # pylint: disable=too-many-instance-attributes
    """
    FTP client implementation
    """

    # pylint: disable=too-many-arguments
    def __init__(
        self,
        hostname: str,
        username: str,
        password: Optional[str] = None,
        port: Optional[int] = 21,
        passive: Optional[bool] = True,
        timeout: Optional[int] = None,
    ):
        """
        Initialize the FTP client.

        Args:
            hostname (str): The hostname of the FTP server.
            username (str): The username to use for the FTP server.
            password (str): The password to use for the FTP server.
            port (int, optional): The port to use for the FTP server. Defaults to 21.
            passive (bool, optional): Whether to use passive mode. Defaults to True.
            timeout (int, optional): The timeout to use for the FTP server. Defaults to None.
        """
        self._hostname = hostname
        self._username = username
        self._password = password
        self._port = port
        self._passive = passive
        self._timeout = timeout
        self._ftp = ftplib.FTP()
        self._connected: bool = False

    @property
    def ftp(self) -> ftplib.FTP:
        """
        Returns the underlying FTP object.
        """
        return self._ftp

    @property
    def connected(self) -> bool:
        """
        Returns whether the FTP client is connected.
        """
        return self._connected

    def connect(self) -> None:
        """
        Connect to the FTP server.
        """
        self._ftp.connect(host=self._hostname, port=self._port, timeout=self._timeout)
        self._ftp.login(user=self._username, passwd=self._password)
        self._ftp.set_pasv(val=self._passive)
        self._connected = True

    def close(self) -> None:
        """
        Close the FTP connection.
        """
        self._ftp.quit()
        self._connected = False

    @assert_connected
    def chdir(self, path: str) -> None:
        """
        Change the current working directory.

        Args:
            path (str): The path to change to.
        """
        self._ftp.cwd(path)

    @assert_connected
    def download(self, remote_path: str, local_path: str) -> None:
        """
        Download a file from the FTP server.

        Args:
            remote_path (str): The path to the file on the FTP server.
            local_path (str): The path to the file on the local machine.
        """
        with open(local_path, "wb") as file_handler:
            self._ftp.retrbinary("RETR " + remote_path, file_handler.write)

    @assert_connected
    def list_files(self, path: str = "", pattern: str = None) -> List[str]:
        """
        List the files in a directory on the FTP server.

        Args:
            path (str): The path to the directory on the FTP server.
            pattern (str, optional): A regex pattern to filter the files by. Defaults to None.
        """
        if path == ".":
            path = ""
        files = self._ftp.nlst(path)
        if pattern:
            pattern = re.compile(pattern)
            files = [f for f in files if pattern.match(f)]
        return files

    @assert_connected
    def upload(self, local_path: str, remote_path: str):  # noqa
        """
        Upload a file to the FTP server.

        Args:
            local_path (str): The path to the file on the local machine.
            remote_path (str): The path to the file on the FTP server.
        """
        raise NotImplementedError("Not implemented as we won't be using this yet.")

FTP client implementation

Initialize the FTP client.

Args

hostname : str

The hostname of the FTP server.

username : str

The username to use for the FTP server.

password : str

The password to use for the FTP server.

port : int, optional

The port to use for the FTP server. Defaults to 21.

passive : bool, optional

Whether to use passive mode. Defaults to True.

timeout : int, optional

The timeout to use for the FTP server. Defaults to None.

Instance variables

prop connected : bool

Expand source code

@property
def connected(self) -> bool:
    """
    Returns whether the FTP client is connected.
    """
    return self._connected

Returns whether the FTP client is connected.

prop ftp : ftplib.FTP

Expand source code

@property
def ftp(self) -> ftplib.FTP:
    """
    Returns the underlying FTP object.
    """
    return self._ftp

Returns the underlying FTP object.

Methods

def chdir(self, *args, **kwargs)

Expand source code

def wrapper(self, *args, **kwargs):
    if not self._connected:  # pylint: disable=protected-access
        raise RuntimeError("FTP client is not connected")
    return func(self, *args, **kwargs)

def close(self) ‑> None

Expand source code

def close(self) -> None:
    """
    Close the FTP connection.
    """
    self._ftp.quit()
    self._connected = False

Close the FTP connection.

def connect(self) ‑> None

Expand source code

def connect(self) -> None:
    """
    Connect to the FTP server.
    """
    self._ftp.connect(host=self._hostname, port=self._port, timeout=self._timeout)
    self._ftp.login(user=self._username, passwd=self._password)
    self._ftp.set_pasv(val=self._passive)
    self._connected = True

Connect to the FTP server.

def download(self, *args, **kwargs)

Expand source code

def wrapper(self, *args, **kwargs):
    if not self._connected:  # pylint: disable=protected-access
        raise RuntimeError("FTP client is not connected")
    return func(self, *args, **kwargs)

def list_files(self, *args, **kwargs)

Expand source code

def wrapper(self, *args, **kwargs):
    if not self._connected:  # pylint: disable=protected-access
        raise RuntimeError("FTP client is not connected")
    return func(self, *args, **kwargs)

def upload(self, *args, **kwargs)

Expand source code

def wrapper(self, *args, **kwargs):
    if not self._connected:  # pylint: disable=protected-access
        raise RuntimeError("FTP client is not connected")
    return func(self, *args, **kwargs)