.. _f-transferapi: module ``filehelper.transfer_api`` ================================== .. inheritance-diagram:: pyquickhelper.filehelper.transfer_api Short summary +++++++++++++ module ``pyquickhelper.filehelper.transfer_api`` API to move files :githublink:`%|py|5` Classes +++++++ +--------------------------------------------------------------------------------------------+---------------------------------------------------------------+ | class | truncated documentation | +============================================================================================+===============================================================+ | :class:`MockTransferAPI ` | Class used for unit test purposes, simple key, value storage. | +--------------------------------------------------------------------------------------------+---------------------------------------------------------------+ | :class:`TransferAPI ` | Defines an API to transfer files over a remote location. | +--------------------------------------------------------------------------------------------+---------------------------------------------------------------+ | :class:`TransferAPI_FileInfo ` | Keeps tracks of transferred files. | +--------------------------------------------------------------------------------------------+---------------------------------------------------------------+ Static Methods ++++++++++++++ +---------------------------------------------------------------------------------------------+---------------------------------------------------+ | staticmethod | truncated documentation | +=============================================================================================+===================================================+ | :meth:`bytes2mapping ` | Deserializes a mapping. | +---------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`bytes2mapping ` | Deserializes a mapping. | +---------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`checksum_md5 ` | Computes MD5 for a file. | +---------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`checksum_md5 ` | Computes MD5 for a file. | +---------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`mapping2bytes ` | Serializes a mapping. | +---------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`mapping2bytes ` | Serializes a mapping. | +---------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`read_json ` | Retrieves information from a :epkg:`json` string. | +---------------------------------------------------------------------------------------------+---------------------------------------------------+ Methods +++++++ +---------------------------------------------------------------------------------------------------+----------------------------------------------------------+ | method | truncated documentation | +===================================================================================================+==========================================================+ | :py:meth:`__init__ ` | | +---------------------------------------------------------------------------------------------------+----------------------------------------------------------+ | :py:meth:`__init__ ` | | +---------------------------------------------------------------------------------------------------+----------------------------------------------------------+ | :py:meth:`__init__ ` | Information about a transferred file. | +---------------------------------------------------------------------------------------------------+----------------------------------------------------------+ | :py:meth:`__str__ ` | usual | +---------------------------------------------------------------------------------------------------+----------------------------------------------------------+ | :meth:`add_piece ` | Adds a piece. | +---------------------------------------------------------------------------------------------------+----------------------------------------------------------+ | :meth:`get_remote_path ` | Produces a remote path. | +---------------------------------------------------------------------------------------------------+----------------------------------------------------------+ | :meth:`get_remote_path ` | Produces a remote path. | +---------------------------------------------------------------------------------------------------+----------------------------------------------------------+ | :meth:`retrieve ` | Retrieves data from path. | +---------------------------------------------------------------------------------------------------+----------------------------------------------------------+ | :meth:`retrieve ` | Retrieves data from path. | +---------------------------------------------------------------------------------------------------+----------------------------------------------------------+ | :meth:`retrieve_mapping ` | Returns the mapping. | +---------------------------------------------------------------------------------------------------+----------------------------------------------------------+ | :meth:`retrieve_mapping ` | Returns the mapping. | +---------------------------------------------------------------------------------------------------+----------------------------------------------------------+ | :meth:`to_json ` | Serializes this class info JSON. | +---------------------------------------------------------------------------------------------------+----------------------------------------------------------+ | :meth:`transfer ` | It assumes a data holds in memory, tansfer data to path. | +---------------------------------------------------------------------------------------------------+----------------------------------------------------------+ | :meth:`transfer ` | It assumes a data holds in memory, tansfer data to path. | +---------------------------------------------------------------------------------------------------+----------------------------------------------------------+ | :meth:`transfer_mapping ` | Transfers the mapping. | +---------------------------------------------------------------------------------------------------+----------------------------------------------------------+ | :meth:`transfer_mapping ` | Transfers the mapping. | +---------------------------------------------------------------------------------------------------+----------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.filehelper.transfer_api :members: :special-members: __init__ :show-inheritance: