Allow specifying target directory in client.get(…)

Author: ntninja

ipfshttpclient/client/files.py

@@ -366,18 +366,20 @@ def add(self, file: ty.Union[utils.path_t, int, io.IOBase], *files,
 
 
 	@base.returns_no_item
-	def get(self, cid, **kwargs):
-		"""Downloads a file, or directory of files from IPFS.
-
-		Files are placed in the current working directory.
-
+	def get(self, cid, target: utils.path_t = ".", **kwargs):
+		"""Downloads a file, or directory of files from IPFS
+		
 		Parameters
 		----------
 		cid : Union[str, cid.CIDv0, cid.CIDv1]
 			The path to the IPFS object(s) to be outputted
+		target
+			The directory to place the downloaded files in
+			
+			Defaults to the current working directory.
 		"""
 		args = (str(cid),)
-		return self._client.download('/get', args, **kwargs)
+		return self._client.download('/get', target, args, **kwargs)
 
 
 	def cat(self, cid, offset=0, length=-1, **kwargs):

ipfshttpclient/http.py

@@ -519,9 +519,8 @@ def request(
 
 	@pass_defaults
 	def download(
-			self, path: str,
+			self, path: str, target: utils.path_t = ".",
 			args: ty.Sequence[str] = [], *,
-			filepath: ty.Optional[str] = None,
 			opts: ty.Mapping[str, str] = {},
 			compress: bool = False,
 			offline: bool = False,
@@ -547,12 +546,12 @@ def download(
 		----------
 		path
 			The command path relative to the given base
-		args
-			Positional parameters to be sent along with the HTTP request
-		filepath
-			The local path where IPFS will store downloaded files
+		target
+			The local path where downloaded files should be stored at
 			
 			Defaults to the current working directory.
+		args
+			Positional parameters to be sent along with the HTTP request
 		opts
 			Query string paramters to be sent along with the HTTP request
 		compress
@@ -580,7 +579,6 @@ def download(
 			Set this to :py:`math.inf` to disable timeouts entirely.
 		"""
 		url = self.base + path
-		wd = filepath or '.'
 
 		params = []
 		params.append(('stream-channels', 'true'))
@@ -602,4 +600,4 @@ def download(
 		mode = 'r|gz' if compress else 'r|'
 
 		with tarfile.open(fileobj=res.raw, mode=mode) as tf:
-			tf.extractall(path=wd)
+			tf.extractall(path=utils.convert_path(target))

test/functional/test_files.py

@@ -1,6 +1,7 @@
 import os
 import shutil
 import sys
+import tempfile
 
 import pytest
 import pytest_cid
@@ -406,6 +407,16 @@ def test_get_path(client, cleanup_pins):
 		assert "fsdfgh" not in os.listdir(os.getcwd())
 
 
+@pytest.mark.dependency(depends=["test_add_recursive"])
+def test_get_path_with_target(client, cleanup_pins):
+	test_hash = FAKE_DIR_HASH[0]["Hash"] + "/fsdfgh"
+	
+	with tempfile.TemporaryDirectory() as dirpath:
+		client.get(test_hash, dirpath)
+		assert "fsdfgh" in os.listdir(dirpath)
+		assert "fsdfgh" not in os.listdir(os.getcwd())
+
+
 @pytest.mark.dependency(depends=["test_add_recursive"])
 def test_cat_single_file_str(client, cleanup_pins):
 	content = client.cat("QmQcCtMgLVwvMQGu6mvsRYLjwqrZJcYtH4mboM9urWW9vX")