.. _f-ftptransfer: module ``filehelper.ftp_transfer`` ================================== .. inheritance-diagram:: pyquickhelper.filehelper.ftp_transfer Short summary +++++++++++++ module ``pyquickhelper.filehelper.ftp_transfer`` provides some functionalities to upload file to a website :githublink:`%|py|5` Classes +++++++ +--------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ | class | truncated documentation | +================================================================================================================================+==========================================================================================================+ | :class:`CannotCompleteWithoutNewLoginException ` | raised when a transfer is interrupted by a new login | +--------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ | :class:`CannotReturnToFolderException ` | raised when a transfer is interrupted by an exception and the class cannot return to the original folder | +--------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ | :class:`TransferFTP ` | This class uploads files to a website, if the remote does not exists, it creates it first. | +--------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ Properties ++++++++++ +-----------------------------------------------------------------------+-------------------------+ | property | truncated documentation | +=======================================================================+=========================+ | :meth:`Site ` | return the website | +-----------------------------------------------------------------------+-------------------------+ Methods +++++++ +----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | method | truncated documentation | +====================================================================================================+===========================================================================================================+ | :py:meth:`__init__ ` | | +----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :py:meth:`_check_can_logged ` | | +----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :py:meth:`_private_login ` | logs in | +----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :meth:`close ` | Closes the connection. | +----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :meth:`cwd ` | Goes to a directory, if it does not exist, creates it (if *create* is True). | +----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :meth:`dir ` | Lists the content of a path. | +----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :meth:`enumerate_ls ` | Enumerates the content of a path. | +----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :meth:`ls ` | Lists the content of a path. | +----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :meth:`mkd ` | Creates a directory. | +----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :meth:`print_list ` | Returns the list of files in the current directory the function sends everything to the logging function. | +----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :meth:`pwd ` | Returns the pathname of the current directory on the server. | +----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :meth:`retrieve ` | Downloads a file. | +----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :meth:`run_command ` | Runs a FTP command. | +----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :meth:`transfer ` | Transfers a file. | +----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.filehelper.ftp_transfer :members: :special-members: __init__ :show-inheritance: