"""
Contains possible interactions with the Galaxy FTP Files
"""
from typing import (
List,
TYPE_CHECKING,
)
from bioblend.galaxy.client import Client
if TYPE_CHECKING:
from bioblend.galaxy import GalaxyInstance
[docs]
class FTPFilesClient(Client):
module = "ftp_files"
def __init__(self, galaxy_instance: "GalaxyInstance") -> None:
super().__init__(galaxy_instance)
[docs]
def get_ftp_files(self, deleted: bool = False) -> List[dict]:
"""
Get a list of local files.
:type deleted: bool
:param deleted: Whether to include deleted files
:rtype: list
:return: A list of dicts with details on individual files on FTP
"""
return self._get()