add: get metadata dict from s3 bucket with last modified date and siz…

pyro_risks/utils/s3.py

@@ -19,7 +19,7 @@ class S3Bucket:
                 aws_access_key_id='my_access_key_id',
                 aws_secret_key='my_secret_key'
             )
-        
+
         NOTE: credentials should never be in the code.
 
         To upload a file to the bucket, use:
@@ -49,12 +49,12 @@ class S3Bucket:
 
     def __init__(
         self,
-        bucket_name,
-        endpoint_url,
-        region_name,
-        aws_access_key_id,
-        aws_secret_key,
-    ):
+        bucket_name: str,
+        endpoint_url: str,
+        region_name: str,
+        aws_access_key_id: str,
+        aws_secret_key: str,
+    ) -> None:
         """
         Initializes a new instance of the S3Bucket class.
 
@@ -75,7 +75,7 @@ def __init__(
         self.s3 = self.session.resource("s3", endpoint_url=endpoint_url)
         self.bucket = self.s3.Bucket(bucket_name)
 
-    def upload_file(self, file_path, object_key):
+    def upload_file(self, file_path: str, object_key: str) -> None:
         """
         Uploads a file to the S3 bucket.
 
@@ -85,7 +85,7 @@ def upload_file(self, file_path, object_key):
         """
         self.bucket.upload_file(file_path, object_key)
 
-    def download_file(self, object_key, file_path):
+    def download_file(self, object_key: str, file_path: str) -> None:
         """
         Downloads a file from the S3 bucket.
 
@@ -95,7 +95,7 @@ def download_file(self, object_key, file_path):
         """
         self.bucket.download_file(object_key, file_path)
 
-    def delete_file(self, object_key):
+    def delete_file(self, object_key: str) -> None:
         """
         Deletes a file from the S3 bucket.
 
@@ -104,7 +104,7 @@ def delete_file(self, object_key):
         """
         self.bucket.Object(object_key).delete()
 
-    def list_files(self, pattern=None):
+    def list_files(self, pattern: str = None) -> list[str]:
         """
         Lists files in the S3 bucket.
 
@@ -120,7 +120,7 @@ def list_files(self, pattern=None):
                 files.append(obj.key)
         return files
 
-    def get_file_metadata(self, object_key):
+    def get_file_metadata(self, object_key: str) -> dict:
         """
         Retrieves metadata for a file in the S3 bucket.
 
@@ -133,3 +133,25 @@ def get_file_metadata(self, object_key):
         obj = self.bucket.Object(object_key)
         metadata = obj.metadata
         return metadata
+
+    def get_files_metadata(self, pattern: str = None) -> dict:
+        """
+        Lists files in the S3 bucket with their size in bytes and last modified dates.
+
+        Args:
+            pattern (str): The pattern to filter files by (optional).
+
+        Returns:
+            A dictionnary of file keys (paths), file sizes en GB and last modified dates in the bucket.
+        """
+        files = []
+        for obj in self.bucket.objects.all():
+            if not pattern or pattern in obj.key:
+                files.append(
+                    {
+                        "file_name": obj.key,
+                        "file_size": round(obj.size * 1.0 / (1024), 2), 
+                        "file_last_modified": obj.last_modified,
+                    }
+                )
+        return files