Skip to content

Added optional arguments to /dag/put #238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 24, 2020
Merged

Added optional arguments to /dag/put #238

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
86f3bf1
Added optional arguments
meyer1994 Sep 7, 2020
6f6d6d0
Fixed style check
meyer1994 Sep 7, 2020
6bfcece
Added docs for new args
meyer1994 Sep 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions ipfshttpclient/client/dag.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ def get(self, cid: base.cid_t, **kwargs: base.CommonArgs):
return self._client.request('/dag/get', args, decoder='json', **kwargs)

@base.returns_single_item(base.ResponseBase)
def put(self, data: utils.clean_file_t, **kwargs: base.CommonArgs):
def put(self, data: utils.clean_file_t, format: str = 'cbor',
input_enc: str = 'json', **kwargs: base.CommonArgs):
"""Decodes the given input file as a DAG object and returns their key

.. code-block:: python
Expand All @@ -63,12 +64,18 @@ def put(self, data: utils.clean_file_t, **kwargs: base.CommonArgs):
----------
data
IO stream object of path to a file containing the data to put
format
Format that the object will be added as. Default: cbor
input_enc
Format that the input object will be. Default: json

Returns
-------
dict
Cid with the address of the dag object
"""
opts = {'format': format, 'input-enc': input_enc}
kwargs.setdefault('opts', {}).update(opts)
body, headers = multipart.stream_files(data, chunk_size=self.chunk_size)
return self._client.request('/dag/put', decoder='json', data=body,
headers=headers, **kwargs)
Expand Down Expand Up @@ -105,7 +112,7 @@ def imprt(self, data: utils.clean_file_t, **kwargs: base.CommonArgs):
.. code-block:: python

>>> with open('data.car', 'rb') as file
... client.dag.imprt(file)
... client.dag.imprt(file)
{'Root': {
'Cid': {
'/': 'bafyreidepjmjhvhlvp5eyxqpmyyi7rxwvl7wsglwai3cnvq63komq4tdya'
Expand Down