sapiopycommons 2025.1.7rc401__py3-none-any.whl → 2025.1.20a403__py3-none-any.whl

sapiopycommons/eln/experiment_handler.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import time
 from collections.abc import Mapping, Iterable
+from typing import TypeAlias
 from weakref import WeakValueDictionary
 
 from sapiopylib.rest.DataMgmtService import DataMgmtServer
@@ -28,7 +29,7 @@ from sapiopycommons.general.aliases import AliasUtil, SapioRecord, ExperimentIde
     DataTypeIdentifier, RecordModel
 from sapiopycommons.general.exceptions import SapioException
 
-Step = str | ElnEntryStep
+Step: TypeAlias = str | ElnEntryStep
 """An object representing an identifier to an ElnEntryStep. May be either the name of the step or the ElnEntryStep
 itself."""
 

sapiopycommons/files/file_bridge.py

@@ -1,6 +1,7 @@
 import base64
 import io
 import urllib.parse
+from typing import Any
 
 from requests import Response
 from sapiopylib.rest.User import SapioUser
@@ -8,6 +9,36 @@ from sapiopylib.rest.User import SapioUser
 from sapiopycommons.general.aliases import UserIdentifier, AliasUtil
 
 
+# FR-47387: Add support for the metadata endpoints in FileBridge.
+class FileBridgeMetadata:
+    """
+    Metadata for a file or directory in FileBridge.
+    """
+    file_name: str
+    """The name of the file or directory."""
+    is_file: bool
+    """True if the metadata is for a file, False if it is for a directory."""
+    is_directory: bool
+    """True if the metadata is for a directory, False if it is for a file."""
+    size: int
+    """The size of the file in bytes. For directories, this value will always be zero."""
+    creation_time: int
+    """The time the file or directory was created, in milliseconds since the epoch."""
+    last_accessed_time: int
+    """The time the file or directory was last accessed, in milliseconds since the epoch."""
+    last_modified_time: int
+    """The time the file or directory was last modified, in milliseconds since the epoch."""
+
+    def __init__(self, json_dict: dict[str, Any]):
+        self.file_name = json_dict['fileName']
+        self.is_file = json_dict['isFile']
+        self.is_directory = json_dict['isDirectory']
+        self.size = json_dict['size']
+        self.creation_time = json_dict['creationTime']
+        self.last_accessed_time = json_dict['lastAccessTime']
+        self.last_modified_time = json_dict['lastModifiedTime']
+
+
 # FR-46064 - Initial port of PyWebhookUtils to sapiopycommons.
 class FileBridge:
     @staticmethod
@@ -137,3 +168,48 @@ class FileBridge:
         user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.delete(sub_path, params=params)
         user.raise_for_status(response)
+
+    @staticmethod
+    def file_metadata(context: UserIdentifier, bridge_name: str, file_path: str) -> FileBridgeMetadata:
+        """
+        Get metadata for a file or directory in FileBridge.
+
+        The file path may be to a directory, in which case only the metadata for that directory will be returned. If you
+        want the metadata for the contents of a directory, then use the directory_metadata function.
+
+        :param context: The current webhook context or a user object to send requests from.
+        :param bridge_name: The name of the bridge to use. This is the "connection name" in the
+            file bridge configurations.
+        :param file_path: The path to the file to retrieve the metadata from.
+        :return: The metadata for the file.
+        """
+        sub_path = '/ext/filebridge/file/metadata'
+        params = {
+            'Filepath': f"bridge://{bridge_name}/{file_path}"
+        }
+        user: SapioUser = AliasUtil.to_sapio_user(context)
+        response = user.get(sub_path, params=params)
+        user.raise_for_status(response)
+        response_body: dict[str, Any] = response.json()
+        return FileBridgeMetadata(response_body)
+
+    @staticmethod
+    def directory_metadata(context: UserIdentifier, bridge_name: str, file_path: str) -> list[FileBridgeMetadata]:
+        """
+        Get metadata for every file or nested directory in a directory in FileBridge.
+
+        :param context: The current webhook context or a user object to send requests from.
+        :param bridge_name: The name of the bridge to use. This is the "connection name" in the
+            file bridge configurations.
+        :param file_path: The path to the directory to retrieve the metadata of the contents.
+        :return: A list of the metadata for the contents of the directory.
+        """
+        sub_path = '/ext/filebridge/directory/metadata'
+        params = {
+            'Filepath': f"bridge://{bridge_name}/{file_path}"
+        }
+        user: SapioUser = AliasUtil.to_sapio_user(context)
+        response = user.get(sub_path, params=params)
+        user.raise_for_status(response)
+        response_body: list[dict[str, Any]] = response.json()
+        return [FileBridgeMetadata(x) for x in response_body]