NGPIris 5.3.0__tar.gz → 5.3.1__tar.gz

{ngpiris-5.3.0 → ngpiris-5.3.1}/NGPIris/hcp/hcp.py

@@ -340,7 +340,7 @@ class HCPHandler:
             return False
 
     @check_mounted
-    def download_file(self, key : str, local_file_path : str) -> None:
+    def download_file(self, key : str, local_file_path : str, show_progress_bar : bool = True) -> None:
         """
         Download one object file from the mounted bucket
 
@@ -349,25 +349,38 @@ class HCPHandler:
 
         :param local_file_path: Path to a file on your local system where the contents of the object file can be put
         :type local_file_path: str
+
+        :param show_progress_bar: Boolean choice of displaying a progress bar. Defaults to True
+        :type show_progress_bar: bool, optional
+
+        :raises ObjectDoesNotExist: If the object does not exist in the bucket
         """
         try:
             self.get_object(key)
         except:
             raise ObjectDoesNotExist("Could not find object", "\"" + key + "\"", "in bucket", "\"" + str(self.bucket_name) + "\"")
         try:
-            file_size : int = self.s3_client.head_object(Bucket = self.bucket_name, Key = key)["ContentLength"]
-            with tqdm(
-                total = file_size, 
-                unit = "B", 
-                unit_scale = True, 
-                desc = key
-            ) as pbar:
+            if show_progress_bar:
+                file_size : int = self.s3_client.head_object(Bucket = self.bucket_name, Key = key)["ContentLength"]
+                with tqdm(
+                    total = file_size, 
+                    unit = "B", 
+                    unit_scale = True, 
+                    desc = key
+                ) as pbar:
+                    self.s3_client.download_file(
+                        Bucket = self.bucket_name, 
+                        Key = key, 
+                        Filename = local_file_path, 
+                        Config = self.transfer_config,
+                        Callback = lambda bytes_transferred : pbar.update(bytes_transferred)
+                    )
+            else:
                 self.s3_client.download_file(
                     Bucket = self.bucket_name, 
                     Key = key, 
                     Filename = local_file_path, 
                     Config = self.transfer_config,
-                    Callback = lambda bytes_transferred : pbar.update(bytes_transferred)
                 )
         except ClientError as e0: 
             print(str(e0))
@@ -376,7 +389,14 @@ class HCPHandler:
             raise Exception(e)
 
     @check_mounted
-    def download_folder(self, folder_key : str, local_folder_path : str, use_download_limit : bool = False, download_limit_in_bytes : Byte = TiB(1).to_Byte()) -> None:
+    def download_folder(
+            self, 
+            folder_key : str, 
+            local_folder_path : str, 
+            use_download_limit : bool = False, 
+            download_limit_in_bytes : Byte = TiB(1).to_Byte(), 
+            show_progress_bar : bool = True
+        ) -> None:  
         """
         Download multiple objects from a folder in the mounted bucket
 
@@ -392,7 +412,13 @@ class HCPHandler:
         :param download_limit_in_bytes: The optional download limit in Byte (from the package `bitmath`). Defaults to 1 TB (`TiB(1).to_Byte()`)
         :type download_limit_in_bytes: Byte, optional
 
+        :param show_progress_bar: Boolean choice of displaying a progress bar. Defaults to True
+        :type show_progress_bar: bool, optional
+        
+        :raises ObjectDoesNotExist: If the object does not exist in the bucket
+        
         :raises DownloadLimitReached: If download limit was reached while downloading files
+        
         :raises NotADirectory: If local_folder_path is not a directory
         """
         try:
@@ -409,12 +435,12 @@ class HCPHandler:
                     current_download_size_in_bytes += Byte(object["Size"])
                     if current_download_size_in_bytes >= download_limit_in_bytes and use_download_limit:
                         raise DownloadLimitReached("The download limit was reached when downloading files")
-                    self.download_file(object["Key"], p.as_posix())
+                    self.download_file(object["Key"], p.as_posix(), show_progress_bar = show_progress_bar)
         else:
             raise NotADirectory(local_folder_path + " is not a directory")
 
     @check_mounted
-    def upload_file(self, local_file_path : str, key : str = "") -> None:
+    def upload_file(self, local_file_path : str, key : str = "", show_progress_bar : bool = True) -> None:
         """
         Upload one file to the mounted bucket
 
@@ -423,6 +449,13 @@ class HCPHandler:
 
         :param key: An optional new name for the file object on the bucket. Defaults to the same name as the file
         :type key: str, optional
+
+        :param show_progress_bar: Boolean choice of displaying a progress bar. Defaults to True
+        :type show_progress_bar: bool, optional
+
+        :raises RuntimeError: If the \"\\\" is used in the file path 
+        
+        :raises ObjectAlreadyExist: If the object already exist on the mounted bucket
         """
         raise_path_error(local_file_path)
 
@@ -436,30 +469,43 @@ class HCPHandler:
         if self.object_exists(key):
             raise ObjectAlreadyExist("The object \"" + key + "\" already exist in the mounted bucket")
         else:
-            file_size : int = stat(local_file_path).st_size
-            with tqdm(
-                total = file_size, 
-                unit = "B", 
-                unit_scale = True, 
-                desc = local_file_path
-            ) as pbar:
+            if show_progress_bar:
+                file_size : int = stat(local_file_path).st_size
+                with tqdm(
+                    total = file_size, 
+                    unit = "B", 
+                    unit_scale = True, 
+                    desc = local_file_path
+                ) as pbar:
+                    self.s3_client.upload_file(
+                        Filename = local_file_path, 
+                        Bucket = self.bucket_name, 
+                        Key = key,
+                        Config = self.transfer_config,
+                        Callback = lambda bytes_transferred : pbar.update(bytes_transferred)
+                    )
+            else:
                 self.s3_client.upload_file(
                     Filename = local_file_path, 
                     Bucket = self.bucket_name, 
                     Key = key,
                     Config = self.transfer_config,
-                    Callback = lambda bytes_transferred : pbar.update(bytes_transferred)
                 )
 
+
     @check_mounted
-    def upload_folder(self, local_folder_path : str, key : str = "") -> None:
+    def upload_folder(self, local_folder_path : str, key : str = "", show_progress_bar : bool = True) -> None:
         """
         Upload the contents of a folder to the mounted bucket
 
         :param local_folder_path: Path to the folder to be uploaded
         :type local_folder_path: str
+
         :param key: An optional new name for the folder path on the bucket. Defaults to the same name as the local folder path
         :type key: str, optional
+
+        :param show_progress_bar: Boolean choice of displaying a progress bar. Defaults to True
+        :type show_progress_bar: bool, optional
         """
         raise_path_error(local_folder_path)
 
@@ -468,7 +514,7 @@ class HCPHandler:
         filenames = listdir(local_folder_path)
 
         for filename in filenames:
-            self.upload_file(local_folder_path + filename, key + filename)
+            self.upload_file(local_folder_path + filename, key + filename, show_progress_bar = show_progress_bar)
 
     @check_mounted
     def delete_objects(self, keys : list[str], verbose : bool = True) -> None:

{ngpiris-5.3.0 → ngpiris-5.3.1/NGPIris.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: NGPIris
-Version: 5.3.0
+Version: 5.3.1
 Author-email: Erik Brink <erik.brink@gu.se>, Isak Sylvin <isak.sylvin@gu.se>
 Description-Content-Type: text/markdown
 License-File: LICENSE

{ngpiris-5.3.0/NGPIris.egg-info → ngpiris-5.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: NGPIris
-Version: 5.3.0
+Version: 5.3.1
 Author-email: Erik Brink <erik.brink@gu.se>, Isak Sylvin <isak.sylvin@gu.se>
 Description-Content-Type: text/markdown
 License-File: LICENSE

{ngpiris-5.3.0 → ngpiris-5.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "NGPIris"
-version = "5.3.0"
+version = "5.3.1"
 readme = "README.md"
 dependencies = [
     "requests >= 2.31.0",

{ngpiris-5.3.0 → ngpiris-5.3.1}/tests/test_hcp.py

@@ -56,7 +56,19 @@ def test_list_objects_without_mounting(custom_config : CustomConfig) -> None:
 
 def test_upload_file(custom_config : CustomConfig) -> None:
     test_mount_bucket(custom_config)
-    custom_config.hcp_h.upload_file(custom_config.test_file_path) 
+    
+    # With progress bar
+    custom_config.hcp_h.upload_file(
+        custom_config.test_file_path, 
+        custom_config.test_file_path
+    )
+    
+    # Without progress bar
+    custom_config.hcp_h.upload_file(
+        custom_config.test_file_path, 
+        custom_config.test_file_path + "_no_progress_bar", 
+        show_progress_bar = False
+    )
 
 def test_upload_file_without_mounting(custom_config : CustomConfig) -> None:
     _hcp_h = custom_config.hcp_h 
@@ -104,16 +116,29 @@ def test_get_folder_without_mounting(custom_config : CustomConfig) -> None:
 
 def test_get_file_in_sub_directory(custom_config : CustomConfig) -> None:
     test_mount_bucket(custom_config)
-    test_file = Path(custom_config.test_file_path).name 
-    assert custom_config.hcp_h.object_exists(test_file) 
-    assert custom_config.hcp_h.get_object(test_file) 
+    assert custom_config.hcp_h.object_exists(custom_config.test_file_path) 
+    assert custom_config.hcp_h.get_object(custom_config.test_file_path) 
+
+from icecream import ic
 
 def test_download_file(custom_config : CustomConfig) -> None:
     test_mount_bucket(custom_config)
-    Path(custom_config.result_path).mkdir() 
-    test_file = Path(custom_config.test_file_path).name 
-    custom_config.hcp_h.download_file(test_file, custom_config.result_path + test_file) 
-    assert cmp(custom_config.result_path + test_file, custom_config.test_file_path) 
+    Path(custom_config.result_path).mkdir()
+    
+    test_folder_path = str(custom_config.test_file_path).rsplit("/", maxsplit = 1)[0] + "/"
+    Path(custom_config.result_path + test_folder_path).mkdir(parents = True, exist_ok = True)
+
+    # With progress bar
+    custom_config.hcp_h.download_file(custom_config.test_file_path, custom_config.result_path + custom_config.test_file_path)
+    assert cmp(custom_config.result_path + custom_config.test_file_path, custom_config.test_file_path) 
+
+    # Without progress bar
+    custom_config.hcp_h.download_file(
+        custom_config.test_file_path + "_no_progress_bar", 
+        custom_config.result_path + custom_config.test_file_path + "_no_progress_bar",
+        show_progress_bar = False
+    )
+    assert cmp(custom_config.result_path + custom_config.test_file_path, custom_config.test_file_path) 
 
 def test_download_file_without_mounting(custom_config : CustomConfig) -> None:
     _hcp_h = custom_config.hcp_h 
@@ -152,8 +177,7 @@ def test_fuzzy_search_in_bucket_without_mounting(custom_config : CustomConfig) -
 
 def test_get_object_acl(custom_config : CustomConfig) -> None:
     test_mount_bucket(custom_config)
-    test_file = Path(custom_config.test_file_path).name 
-    custom_config.hcp_h.get_object_acl(test_file) 
+    custom_config.hcp_h.get_object_acl(custom_config.test_file_path) 
 
 def test_get_object_acl_without_mounting(custom_config : CustomConfig) -> None:
     _hcp_h = custom_config.hcp_h 
@@ -189,8 +213,8 @@ def test_get_bucket_acl_without_mounting(custom_config : CustomConfig) -> None:
 
 def test_delete_file(custom_config : CustomConfig) -> None:
     test_mount_bucket(custom_config)
-    test_file = Path(custom_config.test_file_path).name 
-    custom_config.hcp_h.delete_object(test_file) 
+    custom_config.hcp_h.delete_object(custom_config.test_file_path) 
+    custom_config.hcp_h.delete_object(custom_config.test_file_path + "_no_progress_bar")
     custom_config.hcp_h.delete_object("a_sub_directory/a_file") 
     custom_config.hcp_h.delete_object("a_sub_directory")