Improve documented types of methods that accept all of: filepaths (as text, binary or PathLike), open binary files, file descriptors on Unix

Also mark methods returning binary strings as returning `bytes` (not the Python 2 `str` type)

Author: ntninja

ipfshttpclient/client/block.py

@@ -26,7 +26,7 @@ def get(self, multihash, **kwargs):
 
 		Returns
 		-------
-			str : Value of the requested block
+			bytes : Value of the requested block
 		"""
 		args = (multihash,)
 		return self._client.request('/block/get', args, **kwargs)
@@ -43,7 +43,7 @@ def put(self, file, **kwargs):
 
 		Parameters
 		----------
-		file : io.RawIOBase
+		file : str | bytes | os.PathLike | io.IOBase | int
 			The data to be stored as an IPFS block
 
 		Returns

ipfshttpclient/client/files.py

@@ -39,7 +39,7 @@ def cp(self, source, dest, **kwargs):
 		source : str
 			Filepath within the MFS to copy from
 		dest : str
-			Destination filepath with the MFS to which the file will be
+			Destination filepath within the MFS to which the file will be
 			copied to
 		"""
 		args = (source, dest)
@@ -132,7 +132,7 @@ def read(self, path, offset=0, count=None, **kwargs):
 
 		Returns
 		-------
-			str : MFS file contents
+			bytes : MFS file contents
 		"""
 		opts = {"offset": offset}
 		if count is not None:
@@ -149,7 +149,6 @@ def rm(self, path, recursive=False, **kwargs):
 		.. code-block:: python
 
 			>>> client.files.rm("/bla/file")
-			b''
 
 		Parameters
 		----------
@@ -199,7 +198,7 @@ def write(self, path, file, offset=0, create=False, truncate=False, count=None,
 		----------
 		path : str
 			Filepath within the MFS
-		file : io.RawIOBase
+		file : str | bytes | os.PathLike | io.RawIOBase | int
 			IO stream object with data that should be written
 		offset : int
 			Byte offset at which to begin writing at
@@ -237,10 +236,10 @@ def add(self, files, recursive=False, pattern='**', *args, **kwargs):
 
 		Parameters
 		----------
-		files : str
+		files : str | bytes | os.PathLike | int | io.IOBase | collections.abc.Iterable
 			A filepath to either a file or directory
 		recursive : bool
-			Controls if files in subdirectories are added or not
+			Controls whether files in subdirectories are added or not
 		pattern : str | list
 			Single `*glob* <https://docs.python.org/3/library/glob.html>`_
 			pattern or list of *glob* patterns and compiled regular expressions
@@ -366,7 +365,7 @@ def cat(self, multihash, offset=0, length=-1, **kwargs):
 
 		Returns
 		-------
-			str : File contents
+			bytes : File contents
 		"""
 		args = (multihash,)
 		opts = {}

ipfshttpclient/client/object.py

@@ -57,7 +57,7 @@ def append_data(self, multihash, new_data, **kwargs):
 		----------
 		multihash : str
 			The hash of an ipfs object to modify
-		new_data : io.RawIOBase
+		new_data : str | bytes | os.PathLike | io.IOBase | int
 			The data to append to the object's data section
 
 		Returns
@@ -116,7 +116,7 @@ def set_data(self, root, data, **kwargs):
 		----------
 		root : str
 			IPFS hash of the object to modify
-		data : io.RawIOBase
+		data : str | bytes | os.PathLike | io.IOBase | int
 			The new data to store in root
 
 		Returns
@@ -149,15 +149,15 @@ def data(self, multihash, **kwargs):
 
 		Returns
 		-------
-			str : Raw object data
+			bytes : Raw object data
 		"""
 		args = (multihash,)
 		return self._client.request('/object/data', args, **kwargs)
 
 
 	def get(self, multihash, **kwargs):
 		"""Get and serialize the DAG node named by multihash.
-
+		
 		.. code-block:: python
 
 			>>> client.object.get('QmTkzDwWqPbnAh5YiV5VwcTLnGdwSNsNTn2aDxdXBFca7D')
@@ -269,7 +269,7 @@ def put(self, file, **kwargs):
 
 		Parameters
 		----------
-		file : io.RawIOBase
+		file : str | bytes | os.PathLike | io.IOBase | int
 			(JSON) object from which the DAG object will be created
 
 		Returns