IPFS的Python API参考手册

2019独角兽企业重金招聘Python工程师标准>>>

IPFS是一个分布式的全球一致性（参见 DHT与分布式一致性 ）文件系统，结合了BT、P2P、DHT等的优势。目前IPFS已经提供了python api，可以访问集群中的IPFS服务。

• 本文地址，https://my.oschina.net/u/2306127/blog/2046243

基础服务准备

• 通过Helm在Kubernetes集群上安装IPFS。
• IPFS在Kubernetes部署的服务开放。
• IPFS服务的Python访问。
• Kubernetes中通过python api访问IPFS服务。

安装ipfsapi库

pip install ipfsapi

获取API对象

import ipfsapi

api = ipfsapi.connect('ipfs2-ipfs.ipfs2', 5001)

获取帮助信息

help(api)

返回的IPFS Python API接口信息如下：

模块 ipfsapi.client 对象的说明信息:

class Client(builtins.object)
 |  TCP client对象，与IPFS daemon进行交互。
 |  
 |  A :class:`~ipfsapi.Client` 实例并不会立即建立一个到daemon的连接，直到其中的方法被调用.
 |  
 |  Parameters，#参数
 |  ----------
 |  host : str，#主机名或IP地址，字符串
 |      Hostname or IP address of the computer running the ``ipfs daemon``
 |      node (defaults to the local system)
 |  port : int，#端口，通常是5001
 |      The API port of the IPFS deamon (usually 5001)
 |  base : str，API的路径，目前是``api/v0``
 |      Path of the deamon's API (currently always ``api/v0``)
 |  chunk_size : int，# 分割的chunks的大小
 |      The size of the chunks to break uploaded files and text content into
 |  
 |  Methods defined here: # 方法定义
 |  
 |  __init__(self, host='localhost', port=5001, base='api/v0', chunk_size=4096, **defaults)
 |      Connects to the API port of an IPFS node.
 |  
 ##########################################################################
 #  添加文件
 |  add(self, files, recursive=False, pattern='**', *args, **kwargs)
 |      Add a file, or directory of files to IPFS.
 |      
 |      .. code-block:: python
 |      
 |          >>> with io.open('nurseryrhyme.txt', 'w', encoding='utf-8') as f:
 |          ...     numbytes = f.write('Mary had a little lamb')
 |          >>> c.add('nurseryrhyme.txt')
 |          {'Hash': 'QmZfF6C9j4VtoCsTp4KSrhYH47QMd3DNXVZBKaxJdhaPab',
 |           'Name': 'nurseryrhyme.txt'}
 |      
 |      Parameters
 |      ----------
 |      files : str
 |          A filepath to either a file or directory
 |      recursive : bool
 |          Controls if files in subdirectories are added or not
 |      pattern : str | list
 |          Single `*glob* `_
 |          pattern or list of *glob* patterns and compiled regular expressions
 |          to match the names of the filepaths to keep
 |      trickle : bool
 |          Use trickle-dag format (optimized for streaming) when generating
 |          the dag; see `the FAQ ` for
 |          more information (Default: ``False``)
 |      only_hash : bool
 |          Only chunk and hash, but do not write to disk (Default: ``False``)
 |      wrap_with_directory : bool
 |          Wrap files with a directory object to preserve their filename
 |          (Default: ``False``)
 |      chunker : str
 |          The chunking algorithm to use
 |      pin : bool
 |          Pin this object when adding (Default: ``True``)
 |      
 |      Returns
 |      -------
 |          dict: File name and hash of the added file node
 |  
 ##########################################################################
 #  添加bytes数组到IPFS 
 |  add_bytes(self, data, **kwargs)
 |      Adds a set of bytes as a file to IPFS.
 |      
 |      .. code-block:: python
 |      
 |          >>> c.add_bytes(b"Mary had a little lamb")
 |          'QmZfF6C9j4VtoCsTp4KSrhYH47QMd3DNXVZBKaxJdhaPab'
 |      
 |      Also accepts and will stream generator objects.
 |      
 |      Parameters
 |      ----------
 |      data : bytes
 |          Content to be added as a file
 |      
 |      Returns
 |      -------
 |          str : Hash of the added IPFS object
 |  
 ##########################################################################
 # 添加Json字符串到IPFS
 |  add_json(self, json_obj, **kwargs)
 |      Adds a json-serializable Python dict as a json file to IPFS.
 |      
 |      .. code-block:: python
 |      
 |          >>> c.add_json({'one': 1, 'two': 2, 'three': 3})
 |          'QmVz9g7m5u3oHiNKHj2CJX1dbG1gtismRS3g9NaPBBLbob'
 |      
 |      Parameters
 |      ----------
 |      json_obj : dict
 |          A json-serializable Python dictionary
 |      
 |      Returns
 |      -------
 |          str : Hash of the added IPFS object
 | 
 ##########################################################################
 #  添加python对象到IPFS。 
 |  add_pyobj(self, py_obj, **kwargs)
 |      Adds a picklable Python object as a file to IPFS.
 |      
 |      .. deprecated:: 0.4.2
 |         The ``*_pyobj`` APIs allow for arbitrary code execution if abused.
 |         Either switch to :meth:`~ipfsapi.Client.add_json` or use
 |         ``client.add_bytes(pickle.dumps(py_obj))`` instead.
 |      
 |      Please see :meth:`~ipfsapi.Client.get_pyobj` for the
 |      **security risks** of using these methods!
 |      
 |      .. code-block:: python
 |      
 |          >>> c.add_pyobj([0, 1.0, 2j, '3', 4e5])
 |          'QmWgXZSUTNNDD8LdkdJ8UXSn55KfFnNvTP1r7SyaQd74Ji'
 |      
 |      Parameters
 |      ----------
 |      py_obj : object
 |          A picklable Python object
 |      
 |      Returns
 |      -------
 |          str : Hash of the added IPFS object
 |
 ##########################################################################
 # 添加字符串对象到IPFS。  
 |  add_str(self, string, **kwargs)
 |      Adds a Python string as a file to IPFS.
 |      
 |      .. code-block:: python
 |      
 |          >>> c.add_str(u"Mary had a little lamb")
 |          'QmZfF6C9j4VtoCsTp4KSrhYH47QMd3DNXVZBKaxJdhaPab'
 |      
 |      Also accepts and will stream generator objects.
 |      
 |      Parameters
 |      ----------
 |      string : str
 |          Content to be added as a file
 |      
 |      Returns
 |      -------
 |          str : Hash of the added IPFS object
 |
 ##########################################################################
 #  传输状态统计。  
 |  bitswap_stat(self, **kwargs)
 |      Returns some diagnostic information from the bitswap agent.
 |      
 |      .. code-block:: python
 |      
 |          >>> c.bitswap_stat()
 |          {'BlocksReceived': 96,
 |           'DupBlksReceived': 73,
 |           'DupDataReceived': 2560601,
 |           'ProviderBufLen': 0,
 |           'Peers': [
 |              'QmNZFQRxt9RMNm2VVtuV2Qx7q69bcMWRVXmr5CEkJEgJJP',
 |              'QmNfCubGpwYZAQxX8LQDsYgB48C4GbfZHuYdexpX9mbNyT',
 |              'QmNfnZ8SCs3jAtNPc8kf3WJqJqSoX7wsX7VqkLdEYMao4u',
 |              …
 |           ],
 |           'Wantlist': [
 |              'QmeV6C6XVt1wf7V7as7Yak3mxPma8jzpqyhtRtCvpKcfBb',
 |              'QmdCWFLDXqgdWQY9kVubbEHBbkieKd3uo7MtCm7nTZZE9K',
 |              'QmVQ1XvYGF19X4eJqz1s7FJYJqAxFC4oqh3vWJJEXn66cp'
 |           ]
 |          }
 |      
 |      Returns
 |      -------
 |          dict : Statistics, peers and wanted blocks
 | 
 ##########################################################################
 # 移除指定的block。  
 |  bitswap_unwant(self, key, **kwargs)
 |      Remove a given block from wantlist.
 |      
 |      Parameters
 |      ----------
 |      key : str
 |          Key to remove from wantlist.
 |
 ##########################################################################
 # 返回待传输块列表。   
 |  bitswap_wantlist(self, peer=None, **kwargs)
 |      Returns blocks currently on the bitswap wantlist.
 |      
 |      .. code-block:: python
 |      
 |          >>> c.bitswap_wantlist()
 |          {'Keys': [
 |              'QmeV6C6XVt1wf7V7as7Yak3mxPma8jzpqyhtRtCvpKcfBb',
 |              'QmdCWFLDXqgdWQY9kVubbEHBbkieKd3uo7MtCm7nTZZE9K',
 |              'QmVQ1XvYGF19X4eJqz1s7FJYJqAxFC4oqh3vWJJEXn66cp'
 |          ]}
 |      
 |      Parameters
 |      ----------
 |      peer : str
 |          Peer to show wantlist for.
 |      
 |      Returns
 |      -------
 |          dict : List of wanted blocks
 |
 ##########################################################################
 # 返回给定块的原始内容。   
 |  block_get(self, multihash, **kwargs)
 |      Returns the raw contents of a block.
 |      
 |      .. code-block:: python
 |      
 |          >>> c.block_get('QmTkzDwWqPbnAh5YiV5VwcTLnGdwSNsNTn2aDxdXBFca7D')
 |          b'\x121\n"\x12 \xdaW>\x14\xe5\xc1\xf6\xe4\x92\xd1 … \n\x02\x08\x01'
 |      
 |      Parameters
 |      ----------
 |      multihash : str
 |          The base58 multihash of an existing block to get
 |      
 |      Returns
 |      -------
 |          str : Value of the requested block
 |
 ##########################################################################
 # 将文件作为IPFS块放入。   
 |  block_put(self, file, **kwargs)
 |      Stores the contents of the given file object as an IPFS block.
 |      
 |      .. code-block:: python
 |      
 |          >>> c.block_put(io.BytesIO(b'Mary had a little lamb'))
 |              {'Key':  'QmeV6C6XVt1wf7V7as7Yak3mxPma8jzpqyhtRtCvpKcfBb',
 |               'Size': 22}
 |      
 |      Parameters
 |      ----------
 |      file : io.RawIOBase
 |          The data to be stored as an IPFS block
 |      
 |      Returns
 |      -------
 |          dict : Information about the new block
 |      
 |                 See :meth:`~ipfsapi.Client.block_stat`
 | 
 ##########################################################################
 # 统计块信息。  
 |  block_stat(self, multihash, **kwargs)
 |      Returns a dict with the size of the block with the given hash.
 |      
 |      .. code-block:: python
 |      
 |          >>> c.block_stat('QmTkzDwWqPbnAh5YiV5VwcTLnGdwSNsNTn2aDxdXBFca7D')
 |          {'Key':  'QmTkzDwWqPbnAh5YiV5VwcTLnGdwSNsNTn2aDxdXBFca7D',
 |           'Size': 258}
 |      
 |      Parameters
 |      ----------
 |      multihash : str
 |          The base58 multihash of an existing block to stat
 |      
 |      Returns
 |      -------
 |          dict : Information about the requested block
 |
 ##########################################################################
 # 启动节点。   
 |  bootstrap(self, **kwargs)
 |      Compatiblity alias for :meth:`~ipfsapi.Client.bootstrap_list`.
 |
 ##########################################################################
 # 添加启动节点。  
 |  bootstrap_add(self, peer, *peers, **kwargs)
 |      Adds peers to the bootstrap list.
 |      
 |      Parameters
 |      ----------
 |      peer : str
 |          IPFS MultiAddr of a peer to add to the list
 |      
 |      Returns
 |      -------
 |          dict
 |
 ##########################################################################
 # 返回启动节点列表。  
 |  bootstrap_list(self, **kwargs)
 |      Returns the addresses of peers used during initial discovery of the
 |      IPFS network.
 |      
 |      Peers are output in the format ``/``.
 |      
 |      .. code-block:: python
 |      
 |          >>> c.bootstrap_list()
 |          {'Peers': [
 |              '/ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYER … uvuJ',
 |              '/ip4/104.236.176.52/tcp/4001/ipfs/QmSoLnSGccFuZQJzRa … ca9z',
 |              '/ip4/104.236.179.241/tcp/4001/ipfs/QmSoLPppuBtQSGwKD … KrGM',
 |              …
 |              '/ip4/178.62.61.185/tcp/4001/ipfs/QmSoLMeWqB7YGVLJN3p … QBU3']}
 |      
 |      Returns
 |      -------
 |          dict : List of known bootstrap peers
 |
 ##########################################################################
 # 移除启动节点。  
 |  bootstrap_rm(self, peer, *peers, **kwargs)
 |      Removes peers from the bootstrap list.
 |      
 |      Parameters
 |      ----------
 |      peer : str
 |          IPFS MultiAddr of a peer to remove from the list
 |      
 |      Returns
 |      -------
 |          dict
 | 
 ##########################################################################
 # 根据Hash返回内容。 
 |  cat(self, multihash, **kwargs)
 |      Retrieves the contents of a file identified by hash.
 |      
 |      .. code-block:: python
 |      
 |          >>> c.cat('QmTkzDwWqPbnAh5YiV5VwcTLnGdwSNsNTn2aDxdXBFca7D')
 |          Traceback (most recent call last):
 |            ...
 |          ipfsapi.exceptions.Error: this dag node is a directory
 |          >>> c.cat('QmeKozNssnkJ4NcyRidYgDY2jfRZqVEoRGfipkgath71bX')
 |          b'\n\n\n\n