.. _f-ftptransferfiles: module ``filehelper.ftp_transfer_files`` ======================================== .. inheritance-diagram:: pyquickhelper.filehelper.ftp_transfer_files Short summary +++++++++++++ module ``pyquickhelper.filehelper.ftp_transfer_files`` Class to transfer files to a website using FTP, it only transfers updated files :githublink:`%|py|5` Classes +++++++ +--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | class | truncated documentation | +==============================================================================================================+=====================================================================================================================+ | :class:`FolderTransferFTP ` | This class aims at transfering a folder to a FTP website, it checks that a file was updated before transfering, ... | +--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :class:`FolderTransferFTPException ` | custom exception for :class:`FolderTransferFTP` | +--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ Functions +++++++++ +-------------------------------------------------------------------------------------------+----------------------------------------------------------------+ | function | truncated documentation | +===========================================================================================+================================================================+ | :func:`content_as_binary ` | determines if filename is binary or None before transfering it | +-------------------------------------------------------------------------------------------+----------------------------------------------------------------+ Methods +++++++ +-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ | method | truncated documentation | +=====================================================================================================================================+=============================================================================================================+ | :py:meth:`__init__ ` | | +-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | usual | +-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ | :meth:`close_stream ` | Closes a stream opened by :meth:`preprocess_before_transfering`. | +-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ | :meth:`iter_eligible_files ` | Iterates on eligible file for transfering (if they have been modified). | +-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ | :meth:`preprocess_before_transfering ` | Applies some preprocessing to the file to transfer. It adds the footer for example. It returns a stream ... | +-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ | :meth:`start_transfering ` | Starts transfering files to a remote :epkg:`FTP` website. | +-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ | :meth:`update_status ` | Updates the status of a file. | +-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.filehelper.ftp_transfer_files :members: :special-members: __init__ :show-inheritance: