.. _f-ftptransfermock:

module ``filehelper.ftp_transfer_mock``
=======================================





.. inheritance-diagram:: pyquickhelper.filehelper.ftp_transfer_mock


Short summary
+++++++++++++

module ``pyquickhelper.filehelper.ftp_transfer_mock``

Mock class :class:`TransferFTP`


:githublink:`%|py|5`




Classes
+++++++

+---------------------------------------------------------------------------------------+---------------------------+
| class                                                                                 | truncated documentation   |
+=======================================================================================+===========================+
| :class:`MockTransferFTP <pyquickhelper.filehelper.ftp_transfer_mock.MockTransferFTP>` | mock :class:`TransferFTP` |
+---------------------------------------------------------------------------------------+---------------------------+






Properties
++++++++++

+--------------------------------------------------------------------------------+-------------------------+
| property                                                                       | truncated documentation |
+================================================================================+=========================+
| :meth:`Site <pyquickhelper.filehelper.ftp_transfer_mock.MockTransferFTP.Site>` | return the website      |
+--------------------------------------------------------------------------------+-------------------------+






Methods
+++++++

+-------------------------------------------------------------------------------------------+----------------------------------------+
| method                                                                                    | truncated documentation                |
+===========================================================================================+========================================+
| :py:meth:`__init__ <pyquickhelper.filehelper.ftp_transfer_mock.MockTransferFTP.__init__>` | same signature as :class:`TransferFTP` |
+-------------------------------------------------------------------------------------------+----------------------------------------+
| :meth:`close <pyquickhelper.filehelper.ftp_transfer_mock.MockTransferFTP.close>`          | does noting                            |
+-------------------------------------------------------------------------------------------+----------------------------------------+
| :meth:`transfer <pyquickhelper.filehelper.ftp_transfer_mock.MockTransferFTP.transfer>`    | does nothing, returns True             |
+-------------------------------------------------------------------------------------------+----------------------------------------+


Documentation
+++++++++++++

.. automodule:: pyquickhelper.filehelper.ftp_transfer_mock
    :members:
    :special-members: __init__
    :show-inheritance: