Merge pull request #7 from lighthouse-web3/python-3.6/support

Python 3.6/support

Author: ravish1729

.gitignore

@@ -25,6 +25,7 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+Pipfile*
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

requirements-dev.txt

@@ -0,0 +1,6 @@
+tox==4.6.4
+certifi==2023.5.7
+charset-normalizer==3.1.0
+idna==3.4
+requests==2.31.0
+urllib3==2.0.2

setup.py

@@ -4,7 +4,7 @@
 
 setup(
     name="lighthouse-web3/Lighthouse-Python-SDK",
-    version="0.1.1",
+    version="0.1.4",
     license="GNU GENERAL PUBLIC LICENSE",
     description="Lighthouse Python SDK",
     author="Ravish Sharma | Ayobami Oki | Nandit Mehra",

src/lighthouseweb3/__init__.py

@@ -2,8 +2,7 @@
 
 import os
 import io
-from typing import List
-from .functions import upload as d, types as t, deal_status, get_uploads as getUploads, download as _download
+from .functions import upload as d,deal_status, get_uploads as getUploads, download as _download
 
 
 class Lighthouse:
@@ -14,7 +13,7 @@ def __init__(self, token: str = ""):
                 "No token provided: Please provide a token or set the LIGHTHOUSE_TOKEN environment variable"
             )
 
-    def upload(self, source: str, tag: str = '') -> t.Upload:
+    def upload(self, source: str, tag: str = ''):
         """
         Upload a file or directory to the Lighthouse.
 
@@ -26,7 +25,7 @@ def upload(self, source: str, tag: str = '') -> t.Upload:
         except Exception as e:
             raise e
 
-    def uploadBlob(self, source: io.BufferedReader, filename: str, tag: str = '') -> t.Upload:
+    def uploadBlob(self, source: io.BufferedReader, filename: str, tag: str = ''):
         """
         Upload Blob a file or directory to the Lighthouse.
 
@@ -41,14 +40,13 @@ def uploadBlob(self, source: io.BufferedReader, filename: str, tag: str = '') ->
             raise e
 
     @staticmethod
-    def downloadBlob(dist: io.BufferedWriter, cid: str, chunk_size=1024*1024*10) -> t.Upload:
+    def downloadBlob(dist: io.BufferedWriter, cid: str, chunk_size=1024*1024*10):
         """
         Download a Blob (file or directory) from the Lighthouse.
 
         :param dist: BufferedWriter, destination to write the downloaded data
         :param cid: str, Content Identifier for the data to be downloaded
         :param chunk_size: int, size of chunks in which the file will be downloaded (default: 10MB)
-        :param useCidAsTag: bool, flag to use CID as a tag (default: False)
         :return: t.Upload, the download result
         """
         if not (hasattr(dist, 'read') and hasattr(dist, 'close')):
@@ -57,24 +55,9 @@ def downloadBlob(dist: io.BufferedWriter, cid: str, chunk_size=1024*1024*10) ->
             return _download.download_file_into_writable(cid, dist, chunk_size)
         except Exception as e:
             raise e
-
-    @staticmethod
-    def downloadBlob(dist: io.BufferedWriter, cid: str, chunk_size=1024*1024*10) -> t.Upload:
-        """
-        Download Blob a file or directory to the Lighthouse.
-
-        :param source: str, path to file or directory
-        :return: t.Upload, the upload result
-        """
-        if not (hasattr(dist, 'read') and hasattr(dist, 'close')):
-            raise TypeError("source must have 'read' and 'close' methods")
-        try:
-            return _download.download_file_into_writable(cid, dist, chunk_size)
-        except Exception as e:
-            raise e
-
+            
     @staticmethod
-    def getDealStatus(cid: str) -> List[t.DealData]:
+    def getDealStatus(cid: str):
         """
         Get deal status from the Lighthouse.
 
@@ -87,7 +70,7 @@ def getDealStatus(cid: str) -> List[t.DealData]:
             raise e
 
     @staticmethod
-    def getUploads(publicKey: str, pageNo: int = 1) -> List[t.DealData]:
+    def getUploads(publicKey: str, pageNo: int = 1):
         """
         Get uploads from the Lighthouse.
 
@@ -101,7 +84,7 @@ def getUploads(publicKey: str, pageNo: int = 1) -> List[t.DealData]:
             raise e
 
     @staticmethod
-    def download(cid: str) -> bytes:
+    def download(cid: str):
         """
         Download content from the Lighthouse using its Content Identifier (CID).
 
@@ -114,7 +97,7 @@ def download(cid: str) -> bytes:
         except Exception as e:
             raise e
 
-    def getTagged(self, tag: str) -> t.Upload:
+    def getTagged(self, tag: str):
         """
         Retrieve an upload from the Lighthouse using its tag.
 

src/lighthouseweb3/functions/axios.py

@@ -2,9 +2,7 @@
 
 from io import BufferedReader
 import json
-from typing import Dict, List, Tuple
 import requests as req
-from . import types as t
 from . import utils
 
 
@@ -14,15 +12,15 @@ class Axios:
     def __init__(self, url: str):
         self.url = url
 
-    def parse_url_query(self, query: Dict[str, str]):
+    def parse_url_query(self, query):
         try:
             if query is not None and isinstance(query, dict):
                 for key, value in query.items():
                     self.url += f"&{key}={value}"
         except Exception as e:
             raise e
 
-    def get(self, headers: Dict[str, str] = None, **kwargs) -> dict | Exception:
+    def get(self, headers = None, **kwargs) :
         try:
             self.parse_url_query(kwargs.get("query", None))
             r = req.get(self.url, headers=headers)
@@ -32,8 +30,8 @@ def get(self, headers: Dict[str, str] = None, **kwargs) -> dict | Exception:
             raise e
 
     def post(
-        self, body=None, headers: Dict[str, str] = None, **kwargs
-    ) -> dict | Exception:
+        self, body=None, headers= None, **kwargs
+    ):
         try:
             self.parse_url_query(kwargs.get("query", None))
             r = req.post(self.url, data=body, headers=headers)
@@ -43,8 +41,8 @@ def post(
             raise e
 
     def post_files(
-        self, file: t.FileDict, headers: Dict[str, str] = None, **kwargs
-    ) -> dict | Exception:
+        self, file, headers = None, **kwargs
+    ) :
         try:
             self.parse_url_query(kwargs.get("query", None))
             files = utils.read_files_for_upload(file)
@@ -61,8 +59,8 @@ def post_files(
             raise e
 
     def post_blob(
-        self, file: BufferedReader, filename: str, headers: Dict[str, str] = None, **kwargs
-    ) -> dict | Exception:
+        self, file: BufferedReader, filename: str, headers = None, **kwargs
+    ) :
         try:
             self.parse_url_query(kwargs.get("query", None))
             files = [(

src/lighthouseweb3/functions/deal_status.py

@@ -1,10 +1,8 @@
 import requests
-from typing import List
 from .config import Config
-from . import types as t
 
 
-def get_deal_status(cid: str) -> List[t.DealData]:
+def get_deal_status(cid: str):
     try:
         url = f"{Config.lighthouse_api}/api/lighthouse/deal_status?cid={cid}"
         response = requests.get(url)

src/lighthouseweb3/functions/get_uploads.py

@@ -1,6 +1,5 @@
 import requests
 from .config import Config
-from . import types as t
 
 
 def bytes_to_size(bytes_size):
@@ -12,7 +11,7 @@ def bytes_to_size(bytes_size):
     return f"{round(bytes_size, 2)} {units[index]}"
 
 
-def get_uploads(publicKey: str, pageNo: int = 1) -> t.UploadsResponseType:
+def get_uploads(publicKey: str, pageNo: int = 1) :
     try:
         url = f"{Config.lighthouse_api}/api/user/files_uploaded?publicKey={publicKey}&pageNo={pageNo}"
         response = requests.get(url)

src/lighthouseweb3/functions/types.py

@@ -5,10 +5,9 @@
 from .axios import Axios
 from .utils import is_dir, walk_dir_tree, extract_file_name, NamedBufferedReader
 from .config import Config
-from . import types as t
 
 
-def upload(source: str | BufferedReader | NamedBufferedReader, token: str, tag: str = "") -> t.Upload:
+def upload(source, token: str, tag: str = ""):
     """
     Deploy a file or directory to the lighthouse network
     @params {source}: str, path to file or directory
@@ -27,7 +26,7 @@ def upload(source: str | BufferedReader | NamedBufferedReader, token: str, tag:
         # create list of files to upload
 
         if (isinstance(source, str)):
-            file_dict: t.FileDict = {}
+            file_dict = {}
 
             # check if source is a directory
             if is_dir(source):
@@ -57,7 +56,7 @@ def upload(source: str | BufferedReader | NamedBufferedReader, token: str, tag:
         raise e
 
 
-def uploadBlob(source:  BufferedReader, filename: str, token: str, tag: str = "") -> t.Upload:
+def uploadBlob(source:  BufferedReader, filename: str, token: str, tag: str = ""):
     """
     Upload a Buffer or readable Object
     @params {source}: str, path to file or directory

src/lighthouseweb3/functions/upload.py

@@ -2,8 +2,6 @@
 
 from io import BufferedReader, BytesIO
 import os
-from typing import List, Tuple
-from . import types as t
 
 
 class NamedBufferedReader:
@@ -19,7 +17,7 @@ def close(self):
 # walk path and return list of file paths
 
 
-def walk_dir_tree(path: str) -> Tuple[List[str], str]:
+def walk_dir_tree(path: str):
     file_list = []
     roots = []
     for root, dirs, files in os.walk(path):
@@ -30,24 +28,24 @@ def walk_dir_tree(path: str) -> Tuple[List[str], str]:
 
 
 # check if file is a directory
-def is_dir(path: str) -> bool:
+def is_dir(path: str):
     return os.path.isdir(path)
 
 
-def extract_file_name(file: str) -> str:
+def extract_file_name(file: str):
     return file.split("/")[-1]
 
 
-def extract_file_name_with_source(file: str, source: str) -> str:
+def extract_file_name_with_source(file: str, source: str):
     if source.endswith("/"):
         source = source[: len(source) - 1]
     base = source.split("/")[-1]
     return base + file.split(base)[-1]
 
 
 def read_files_for_upload(
-    files: t.FileDict,
-) -> List[Tuple[str, Tuple[str, BufferedReader, str]]]:
+    files
+):
     file_list = []
     for file in files["files"]:
         if files["is_dir"]:
@@ -76,7 +74,7 @@ def read_files_for_upload(
 
 
 def close_files_after_upload(
-    files: List[Tuple[str, Tuple[str, BufferedReader, str]]]
+    files
 ) -> None:
     for file in files:
         file[1][1].close()