sapiopycommons 2024.8.19a305__tar.gz → 2024.8.26a307__tar.gz

{sapiopycommons-2024.8.19a305 → sapiopycommons-2024.8.26a307}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sapiopycommons
-Version: 2024.8.19a305
+Version: 2024.8.26a307
 Summary: Official Sapio Python API Utilities Package
 Project-URL: Homepage, https://github.com/sapiosciences
 Author-email: Jonathan Steck <jsteck@sapiosciences.com>, Yechen Qiao <yqiao@sapiosciences.com>

{sapiopycommons-2024.8.19a305 → sapiopycommons-2024.8.26a307}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sapiopycommons"
-version='2024.08.19a305'
+version='2024.08.26a307'
 authors = [
     { name="Jonathan Steck", email="jsteck@sapiosciences.com" },
     { name="Yechen Qiao", email="yqiao@sapiosciences.com" },

{sapiopycommons-2024.8.19a305 → sapiopycommons-2024.8.26a307}/src/sapiopycommons/callbacks/callback_util.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import io
-from typing import Any
 from weakref import WeakValueDictionary
 
 from sapiopylib.rest.ClientCallbackService import ClientCallback
@@ -18,7 +17,6 @@ from sapiopylib.rest.pojo.webhook.ClientCallbackRequest import OptionDialogReque
     DataRecordDialogRequest, InputSelectionRequest, FilePromptRequest, MultiFilePromptRequest, \
     TempTableSelectionRequest, DisplayPopupRequest, PopupType
 from sapiopylib.rest.pojo.webhook.ClientCallbackResult import ESigningResponsePojo
-from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
 from sapiopylib.rest.pojo.webhook.WebhookEnums import FormAccessLevel, ScanToSelectCriteria, SearchType
 from sapiopylib.rest.utils.DataTypeCacheManager import DataTypeCacheManager
 from sapiopylib.rest.utils.FormBuilder import FormBuilder
@@ -26,7 +24,8 @@ from sapiopylib.rest.utils.recorddatasinks import InMemoryRecordDataSink
 from sapiopylib.rest.utils.recordmodel.RecordModelWrapper import WrappedType
 
 from sapiopycommons.files.file_util import FileUtil
-from sapiopycommons.general.aliases import FieldMap, SapioRecord, AliasUtil, RecordIdentifier
+from sapiopycommons.general.aliases import FieldMap, SapioRecord, AliasUtil, RecordIdentifier, FieldValue, \
+    UserIdentifier
 from sapiopycommons.general.custom_report_util import CustomReportUtil
 from sapiopycommons.general.exceptions import SapioUserCancelledException, SapioException, SapioUserErrorException
 from sapiopycommons.recordmodel.record_handler import RecordHandler
@@ -42,11 +41,11 @@ class CallbackUtil:
     __instances: WeakValueDictionary[SapioUser, CallbackUtil] = WeakValueDictionary()
     __initialized: bool
 
-    def __new__(cls, context: SapioWebhookContext | SapioUser):
+    def __new__(cls, context: UserIdentifier):
         """
         :param context: The current webhook context or a user object to send requests from.
         """
-        user = context if isinstance(context, SapioUser) else context.user
+        user = AliasUtil.to_sapio_user(context)
         obj = cls.__instances.get(user)
         if not obj:
             obj = object.__new__(cls)
@@ -54,7 +53,7 @@ class CallbackUtil:
             cls.__instances[user] = obj
         return obj
 
-    def __init__(self, context: SapioWebhookContext | SapioUser):
+    def __init__(self, context: UserIdentifier):
         """
         :param context: The current webhook context or a user object to send requests from.
         """
@@ -62,7 +61,7 @@ class CallbackUtil:
             return
         self.__initialized = True
 
-        self.user = context if isinstance(context, SapioUser) else context.user
+        self.user = AliasUtil.to_sapio_user(context)
         self.callback = DataMgmtServer.get_client_callback(self.user)
         self.dt_cache = DataTypeCacheManager(self.user)
         self.width_pixels = None
@@ -281,7 +280,7 @@ class CallbackUtil:
         modifier = FieldModifier(visible=True, editable=editable)
 
         # Build the form using only those fields that are desired.
-        values: dict[str, Any] = {}
+        values: dict[str, FieldValue] = {}
         builder = FormBuilder(data_type, type_def.display_name, type_def.plural_display_name)
         for field_name in fields:
             field_def = field_defs.get(field_name)
@@ -303,7 +302,7 @@ class CallbackUtil:
             raise SapioUserCancelledException()
         return response
 
-    def input_dialog(self, title: str, msg: str, field: AbstractVeloxFieldDefinition) -> Any:
+    def input_dialog(self, title: str, msg: str, field: AbstractVeloxFieldDefinition) -> FieldValue:
         """
         Create an input dialog where the user must input data for a singular field.
 
@@ -314,7 +313,7 @@ class CallbackUtil:
         """
         request = InputDialogCriteria(title, msg, field,
                                       width_in_pixels=self.width_pixels, width_percentage=self.width_percent)
-        response: Any | None = self.callback.show_input_dialog(request)
+        response: FieldValue | None = self.callback.show_input_dialog(request)
         if response is None:
             raise SapioUserCancelledException()
         return response
@@ -606,10 +605,10 @@ class CallbackUtil:
             field_names.append(name)
 
         # Get the values for each row.
-        values: list[dict[str, Any]] = []
+        values: list[dict[str, FieldValue]] = []
         for row in row_contents:
             # The final values for this row:
-            row_values: dict[str, Any] = {}
+            row_values: dict[str, FieldValue] = {}
 
             # Map the records for this row by their data type. If a field map is provided, its data type is Default.
             row_records: dict[str, SapioRecord | FieldMap] = {}
@@ -901,7 +900,7 @@ class CallbackUtil:
         return response
 
     def request_file(self, title: str, exts: list[str] | None = None,
-                     show_image_editor: bool = False, show_camera_button: bool = False) -> (str, bytes):
+                     show_image_editor: bool = False, show_camera_button: bool = False) -> tuple[str, bytes]:
         """
         Request a single file from the user.
 
@@ -934,7 +933,7 @@ class CallbackUtil:
         return file_path, sink.data
 
     def request_files(self, title: str, exts: list[str] | None = None,
-                      show_image_editor: bool = False, show_camera_button: bool = False):
+                      show_image_editor: bool = False, show_camera_button: bool = False) -> dict[str, bytes]:
         """
         Request multiple files from the user.
 
@@ -965,7 +964,7 @@ class CallbackUtil:
         return ret_dict
 
     @staticmethod
-    def __verify_file(file_path: str, file_bytes: bytes, allowed_extensions: list[str]):
+    def __verify_file(file_path: str, file_bytes: bytes, allowed_extensions: list[str]) -> None:
         """
         Verify that the provided file was read (i.e. the file path and file bytes aren't None or empty) and that it
         has the correct file extension. Raises a user error exception if something about the file is incorrect.

{sapiopycommons-2024.8.19a305 → sapiopycommons-2024.8.26a307}/src/sapiopycommons/customreport/term_builder.py

@@ -18,7 +18,7 @@ AND = CompositeTermOperation.AND_OPERATOR
 OR = CompositeTermOperation.OR_OPERATOR
 
 # Forms that field term values can take.
-TermValue = str | int | float | bool | Iterable
+TermValue = str | int | float | bool | Iterable | None
 
 
 class TermBuilder:
@@ -281,9 +281,12 @@ class TermBuilder:
         """
         # If the given value is already a string, then nothing needs to be done with it.
         if not isinstance(value, str):
+            # If the given value is None, then use an empty string for the search instead.
+            if value is None:
+                value = ""
             # If the given value is an iterable object, then the return value is the contents of that iterable
             # in a comma separated list surrounded by curly braces.
-            if isinstance(value, Iterable):
+            elif isinstance(value, Iterable):
                 # When converting a list of values to a string, values in the list which are already strings should be
                 # put in quotation marks so that strings that contain commas do not get split up. All other value
                 # types can be simply converted to a string, though.

{sapiopycommons-2024.8.19a305 → sapiopycommons-2024.8.26a307}/src/sapiopycommons/datatype/attachment_util.py

@@ -1,11 +1,9 @@
 import io
 
 from sapiopylib.rest.DataMgmtService import DataMgmtServer
-from sapiopylib.rest.User import SapioUser
-from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
 from sapiopylib.rest.utils.recordmodel.RecordModelWrapper import WrappedType
 
-from sapiopycommons.general.aliases import AliasUtil, SapioRecord
+from sapiopycommons.general.aliases import AliasUtil, SapioRecord, UserIdentifier
 from sapiopycommons.general.exceptions import SapioException
 from sapiopycommons.recordmodel.record_handler import RecordHandler
 
@@ -13,7 +11,7 @@ from sapiopycommons.recordmodel.record_handler import RecordHandler
 # FR-46064 - Initial port of PyWebhookUtils to sapiopycommons.
 class AttachmentUtil:
     @staticmethod
-    def get_attachment_bytes(context: SapioWebhookContext | SapioUser, attachment: SapioRecord) -> bytes:
+    def get_attachment_bytes(context: UserIdentifier, attachment: SapioRecord) -> bytes:
         """
         Get the data bytes for the given attachment record. Makes a webservice call to retrieve the data.
 
@@ -22,10 +20,7 @@ class AttachmentUtil:
         :return: The bytes for the attachment's file data.
         """
         attachment = AliasUtil.to_data_record(attachment)
-        if isinstance(context, SapioWebhookContext):
-            dr_man = context.data_record_manager
-        else:
-            dr_man = DataMgmtServer.get_data_record_manager(context)
+        dr_man = DataMgmtServer.get_data_record_manager(AliasUtil.to_sapio_user(context))
         with io.BytesIO() as data_sink:
             def consume_data(chunk: bytes):
                 data_sink.write(chunk)
@@ -36,7 +31,7 @@ class AttachmentUtil:
         return file_bytes
 
     @staticmethod
-    def set_attachment_bytes(context: SapioWebhookContext | SapioUser, attachment: SapioRecord,
+    def set_attachment_bytes(context: UserIdentifier, attachment: SapioRecord,
                              file_name: str, file_bytes: bytes) -> None:
         """
         Set the attachment data for a given attachment record. Makes a webservice call to set the data.
@@ -50,15 +45,12 @@ class AttachmentUtil:
             raise SapioException("Provided record cannot have its attachment data set, as it does not exist in the "
                                  "system yet.")
         attachment = AliasUtil.to_data_record(attachment)
-        if isinstance(context, SapioWebhookContext):
-            dr_man = context.data_record_manager
-        else:
-            dr_man = DataMgmtServer.get_data_record_manager(context)
+        dr_man = DataMgmtServer.get_data_record_manager(AliasUtil.to_sapio_user(context))
         with io.BytesIO(file_bytes) as stream:
             dr_man.set_attachment_data(attachment, file_name, stream)
 
     @staticmethod
-    def create_attachment(context: SapioWebhookContext | SapioUser, file_name: str, file_bytes: bytes,
+    def create_attachment(context: UserIdentifier, file_name: str, file_bytes: bytes,
                           wrapper_type: type[WrappedType]) -> WrappedType:
         """
         Create an attachment data type and initialize its attachment bytes at the same time.

{sapiopycommons-2024.8.19a305 → sapiopycommons-2024.8.26a307}/src/sapiopycommons/eln/experiment_handler.py

@@ -23,7 +23,8 @@ from sapiopylib.rest.utils.recordmodel.RecordModelManager import RecordModelInst
 from sapiopylib.rest.utils.recordmodel.RecordModelWrapper import WrappedType
 from sapiopylib.rest.utils.recordmodel.properties import Child
 
-from sapiopycommons.general.aliases import AliasUtil, SapioRecord, ExperimentIdentifier, RecordModel
+from sapiopycommons.general.aliases import AliasUtil, SapioRecord, ExperimentIdentifier, UserIdentifier, \
+    DataTypeIdentifier, RecordModel
 from sapiopycommons.general.exceptions import SapioException
 
 Step = str | ElnEntryStep
@@ -87,8 +88,7 @@ class ExperimentHandler:
     __instances: WeakValueDictionary[str, ExperimentHandler] = WeakValueDictionary()
     __initialized: bool
 
-    def __new__(cls, context: SapioWebhookContext | SapioUser,
-                experiment: ExperimentIdentifier | SapioRecord | None = None):
+    def __new__(cls, context: UserIdentifier, experiment: ExperimentIdentifier | SapioRecord | None = None):
         """
         :param context: The current webhook context or a user object to send requests from.
         :param experiment: If an experiment is provided that is separate from the experiment that is in the context,
@@ -106,8 +106,7 @@ class ExperimentHandler:
             cls.__instances[key] = obj
         return obj
 
-    def __init__(self, context: SapioWebhookContext | SapioUser,
-                 experiment: ExperimentIdentifier | SapioRecord | None = None):
+    def __init__(self, context: UserIdentifier, experiment: ExperimentIdentifier | SapioRecord | None = None):
         """
         Initialization will throw an exception if there is no ELN Experiment in the provided context and no experiment
         is provided.
@@ -146,8 +145,7 @@ class ExperimentHandler:
                     self.__steps.update({entry.entry_name: ElnEntryStep(self.__protocol, entry)})
 
     @staticmethod
-    def __parse_params(context: SapioWebhookContext | SapioUser,
-                       experiment: ExperimentIdentifier | SapioRecord | None = None) \
+    def __parse_params(context: UserIdentifier, experiment: ExperimentIdentifier | SapioRecord | None = None) \
             -> tuple[SapioUser, SapioWebhookContext | None, ElnExperiment]:
         if isinstance(context, SapioWebhookContext):
             user = context.user
@@ -332,11 +330,7 @@ class ExperimentHandler:
         :return: The data record for this experiment. None if it has no record.
         """
         if not hasattr(self, "_ExperimentHandler__exp_record"):
-            drm = DataMgmtServer.get_data_record_manager(self.user)
-            dt = self.__eln_exp.experiment_data_type_name
-            results = drm.query_data_records_by_id(dt, [self.__eln_exp.experiment_record_id]).result_list
-            # PR-46504: Set the exp_record to None if there are no results.
-            self.__exp_record = results[0] if results else None
+            self.__exp_record = self.__protocol.get_record()
         if self.__exp_record is None and exception_on_none:
             raise SapioException(f"Experiment record not found for experiment with ID {self.__exp_id}.")
         return self.__exp_record
@@ -536,7 +530,7 @@ class ExperimentHandler:
             ret_list.append(step)
         return ret_list
 
-    def get_all_steps(self, data_type: str | type[WrappedType] | None = None) -> list[ElnEntryStep]:
+    def get_all_steps(self, data_type: DataTypeIdentifier | None = None) -> list[ElnEntryStep]:
         """
         Get a list of every entry in the experiment. Optionally filter the returned entries by a data type.
 
@@ -552,8 +546,7 @@ class ExperimentHandler:
         all_steps: list[ElnEntryStep] = self.__protocol.get_sorted_step_list()
         if data_type is None:
             return all_steps
-        if not isinstance(data_type, str):
-            data_type: str = data_type.get_wrapper_data_type_name()
+        data_type: str = AliasUtil.to_data_type_name(data_type)
         return [x for x in all_steps if data_type in x.get_data_type_names()]
 
     def get_step_records(self, step: Step) -> list[DataRecord]:
@@ -605,6 +598,10 @@ class ExperimentHandler:
             The records may be provided as either DataRecords, PyRecordModels, or WrappedRecordModels.
         """
         step = self.__to_eln_step(step)
+        dt: str = AliasUtil.to_singular_data_type_name(records)
+        if dt != step.get_data_type_names()[0]:
+            raise SapioException(f"Cannot add {dt} records to entry {step.get_name()} of type "
+                                 f"{step.get_data_type_names()[0]}.")
         step.add_records(AliasUtil.to_data_records(records))
 
     def remove_step_records(self, step: Step, records: Iterable[SapioRecord]) -> None:
@@ -623,6 +620,10 @@ class ExperimentHandler:
             The records may be provided as either DataRecords, PyRecordModels, or WrappedRecordModels.
         """
         step = self.__to_eln_step(step)
+        dt: str = AliasUtil.to_singular_data_type_name(records)
+        if dt != step.get_data_type_names()[0]:
+            raise SapioException(f"Cannot remove {dt} records from entry {step.get_name()} of type "
+                                 f"{step.get_data_type_names()[0]}.")
         step.remove_records(AliasUtil.to_data_records(records))
 
     def set_step_records(self, step: Step, records: Iterable[SapioRecord]) -> None:
@@ -646,6 +647,10 @@ class ExperimentHandler:
             The records may be provided as either DataRecords, PyRecordModels, or WrappedRecordModels.
         """
         step = self.__to_eln_step(step)
+        dt: str = AliasUtil.to_singular_data_type_name(records)
+        if dt != step.get_data_type_names()[0]:
+            raise SapioException(f"Cannot set {dt} records for entry {step.get_name()} of type "
+                                 f"{step.get_data_type_names()[0]}.")
         step.set_records(AliasUtil.to_data_records(records))
 
     # FR-46496 - Provide alias of set_step_records for use with form entries.
@@ -733,8 +738,10 @@ class ExperimentHandler:
         dt: str = step.get_data_type_names()[0]
         if not ElnBaseDataType.is_eln_type(dt):
             raise SapioException("The provided step is not an ELN data type entry.")
-        if any([x.data_type_name != dt for x in records]):
-            raise SapioException("Not all of the provided records match the data type of the step.")
+        record_dt: str = AliasUtil.to_singular_data_type_name(records)
+        if record_dt != dt:
+            raise SapioException(f"Cannot remove {dt} records from entry {step.get_name()} of type "
+                                 f"{step.get_data_type_names()[0]}.")
         # If any rows were provided as data records, turn them into record models before deleting them, as otherwise
         # this function would need to make a webservice call to do the deletion.
         data_records: list[DataRecord] = []

sapiopycommons-2024.8.26a307/src/sapiopycommons/eln/experiment_report_util.py

@@ -0,0 +1,118 @@
+from sapiopylib.rest.User import SapioUser
+from sapiopylib.rest.pojo.datatype.FieldDefinition import FieldType
+from sapiopylib.rest.utils.recordmodel.RecordModelWrapper import WrappedType
+
+from sapiopycommons.customreport.custom_report_builder import CustomReportBuilder
+from sapiopycommons.customreport.term_builder import TermBuilder
+from sapiopycommons.general.aliases import SapioRecord, UserIdentifier, AliasUtil
+from sapiopycommons.general.custom_report_util import CustomReportUtil
+from sapiopycommons.recordmodel.record_handler import RecordHandler
+
+_NOTEBOOK_ID = "EXPERIMENTID"
+_RECORD_ID = "RECORDID"
+
+
+# FR-46908 - Provide a utility class that holds experiment related custom reports e.g. getting all the experiments
+# that given records were used in or getting all records of a datatype used in given experiments.
+class ExperimentReportUtil:
+    @staticmethod
+    def map_records_to_experiment_ids(context: UserIdentifier, records: list[SapioRecord]) \
+            -> dict[SapioRecord, list[int]]:
+        """
+        Return a dictionary mapping each record to a list of ids of experiments that they were used in.
+        If a record wasn't used in any experiments then it will be mapped to an empty list.
+
+        :param context: The current webhook context or a user object to send requests from.
+        :param records: a list of records of the same data type.
+        :return: a dictionary mapping each record to a list of ids of each experiment it was used in.
+        """
+        if not records:
+            return {}
+
+        user: SapioUser = AliasUtil.to_sapio_user(context)
+        data_type_name: str = AliasUtil.to_singular_data_type_name(records)
+
+        record_ids = [record.record_id for record in records]
+        rows = ExperimentReportUtil.__get_record_experiment_relation_rows(user, data_type_name, record_ids=record_ids)
+
+        id_to_record: dict[int, SapioRecord] = RecordHandler.map_by_id(records)
+        record_to_exps: dict[SapioRecord, set[int]] = {record: set() for record in records}
+        for row in rows:
+            record_id: int = row[_RECORD_ID]
+            exp_id: int = row[_NOTEBOOK_ID]
+            record = id_to_record[record_id]
+            record_to_exps[record].add(exp_id)
+
+        return {record: list(exps) for record, exps in record_to_exps.items()}
+
+    @staticmethod
+    def map_experiments_to_records_of_type(context: UserIdentifier, exp_ids: list[int],
+                                           wrapper_type: type[WrappedType]) -> dict[int, list[WrappedType]]:
+        """
+        Return a dictionary mapping each experiment id to a list of records of the given type that were used in each experiment.
+        If an experiment didn't use any records of the given type then it will be mapped to an empty list.
+
+        :param context: The current webhook context or a user object to send requests from.
+        :param exp_ids: a list of experiment ids. These are specifically the Notebook Experiment ids which can be found in the title of the experiment.
+        :param wrapper_type: The record model wrapper to use, corresponds to which data type we will query for.
+        :return: a dictionary mapping each experiment id to a list of records of the given type that were used in that experiment.
+        """
+        if not exp_ids:
+            return {}
+
+        user = AliasUtil.to_sapio_user(context)
+        record_handler = RecordHandler(user)
+        data_type_name: str = wrapper_type.get_wrapper_data_type_name()
+
+        rows = ExperimentReportUtil.__get_record_experiment_relation_rows(user, data_type_name, exp_ids=exp_ids)
+        record_ids: set[int] = {row[_RECORD_ID] for row in rows}
+        records = record_handler.query_models_by_id(wrapper_type, record_ids)
+
+        id_to_record: dict[int, WrappedType] = RecordHandler.map_by_id(records)
+        exp_to_records: dict[int, set[SapioRecord]] = {exp: set() for exp in exp_ids}
+        for row in rows:
+            record_id: int = row[_RECORD_ID]
+            exp_id: int = row[_NOTEBOOK_ID]
+            record = id_to_record[record_id]
+            exp_to_records[exp_id].add(record)
+
+        return {exp: list(records) for exp, records in exp_to_records.items()}
+
+    @staticmethod
+    def __get_record_experiment_relation_rows(user: SapioUser, data_type_name: str, record_ids: list[int] | None = None,
+                                              exp_ids: list[int] | None = None) -> list[dict[str, int]]:
+        """
+        Return a list of dicts mapping \"RECORDID\" to the record id and \"EXPERIMENTID\" to the experiment id.
+        At least one of record_ids and exp_ids should be provided.
+        """
+        assert (record_ids or exp_ids)
+
+        if record_ids:
+            records_term = TermBuilder.is_term(data_type_name, "RECORDID", record_ids)
+        else:
+            # Get all records of the given type
+            records_term = TermBuilder.all_records_term(data_type_name)
+
+        if exp_ids:
+            exp_term = TermBuilder.is_term("NOTEBOOKEXPERIMENT", "EXPERIMENTID", exp_ids)
+        else:
+            # Get all experiments
+            exp_term = TermBuilder.gte_term("NOTEBOOKEXPERIMENT", "EXPERIMENTID", "0")
+
+        root_term = TermBuilder.and_terms(records_term, exp_term)
+
+        # Join records on the experiment entry records that correspond to them.
+        records_entry_join = TermBuilder.compare_is_term("EXPERIMENTENTRYRECORD", "RECORDID", data_type_name, "RECORDID")
+        # Join entry records on the experiment entries they are in.
+        experiment_entry_enb_entry_join = TermBuilder.compare_is_term("ENBENTRY", "ENTRYID", "EXPERIMENTENTRYRECORD", "ENTRYID")
+        # Join entries on the experiments they are in.
+        enb_entry_experiment_join = TermBuilder.compare_is_term("NOTEBOOKEXPERIMENT", "EXPERIMENTID", "ENBENTRY", "EXPERIMENTID")
+
+        report_builder = CustomReportBuilder(data_type_name)
+        report_builder.set_root_term(root_term)
+        report_builder.add_column("RECORDID", FieldType.LONG, data_type=data_type_name)
+        report_builder.add_column("EXPERIMENTID", FieldType.LONG, data_type="NOTEBOOKEXPERIMENT")
+        report_builder.add_join(records_entry_join)
+        report_builder.add_join(experiment_entry_enb_entry_join)
+        report_builder.add_join(enb_entry_experiment_join)
+        return CustomReportUtil.run_custom_report(user, report_builder.build_report_criteria())

{sapiopycommons-2024.8.19a305 → sapiopycommons-2024.8.26a307}/src/sapiopycommons/files/complex_data_loader.py

@@ -1,12 +1,13 @@
 import io
 
 from sapiopylib.rest.User import SapioUser
-from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
+
+from sapiopycommons.general.aliases import UserIdentifier, AliasUtil
 
 
 class CDL:
     @staticmethod
-    def load_cdl(context: SapioWebhookContext | SapioUser, config_name: str, file_name: str, file_data: bytes | str) \
+    def load_cdl(context: UserIdentifier, config_name: str, file_name: str, file_data: bytes | str) \
             -> list[int]:
         """
         Create data records from a file using one of the complex data loader (CDL) configurations in the system.
@@ -22,7 +23,7 @@ class CDL:
             "configName": config_name,
             "fileName": file_name
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         with io.BytesIO(file_data.encode() if isinstance(file_data, str) else file_data) as data_stream:
             response = user.post_data_stream(sub_path, params=params, data_stream=data_stream)
         user.raise_for_status(response)

{sapiopycommons-2024.8.19a305 → sapiopycommons-2024.8.26a307}/src/sapiopycommons/files/file_bridge.py

@@ -4,13 +4,14 @@ import urllib.parse
 
 from requests import Response
 from sapiopylib.rest.User import SapioUser
-from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
+
+from sapiopycommons.general.aliases import UserIdentifier, AliasUtil
 
 
 # FR-46064 - Initial port of PyWebhookUtils to sapiopycommons.
 class FileBridge:
     @staticmethod
-    def read_file(context: SapioWebhookContext | SapioUser, bridge_name: str, file_path: str,
+    def read_file(context: UserIdentifier, bridge_name: str, file_path: str,
                   base64_decode: bool = True) -> bytes:
         """
         Read a file from FileBridge.
@@ -27,7 +28,7 @@ class FileBridge:
         params = {
             'Filepath': f"bridge://{bridge_name}/{file_path}"
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.get(sub_path, params)
         user.raise_for_status(response)
 
@@ -37,7 +38,7 @@ class FileBridge:
         return ret_val
 
     @staticmethod
-    def write_file(context: SapioWebhookContext | SapioUser, bridge_name: str, file_path: str,
+    def write_file(context: UserIdentifier, bridge_name: str, file_path: str,
                    file_data: bytes | str) -> None:
         """
         Write a file to FileBridge.
@@ -53,13 +54,13 @@ class FileBridge:
         params = {
             'Filepath': f"bridge://{bridge_name}/{file_path}"
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         with io.BytesIO(file_data.encode() if isinstance(file_data, str) else file_data) as data_stream:
             response = user.post_data_stream(sub_path, params=params, data_stream=data_stream)
         user.raise_for_status(response)
 
     @staticmethod
-    def list_directory(context: SapioWebhookContext | SapioUser, bridge_name: str,
+    def list_directory(context: UserIdentifier, bridge_name: str,
                        file_path: str | None = "") -> list[str]:
         """
         List the contents of a FileBridge directory.
@@ -74,7 +75,7 @@ class FileBridge:
         params = {
             'Filepath': f"bridge://{bridge_name}/{file_path}"
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response: Response = user.get(sub_path, params=params)
         user.raise_for_status(response)
 
@@ -83,7 +84,7 @@ class FileBridge:
         return [urllib.parse.unquote(value)[path_length:] for value in response_body]
 
     @staticmethod
-    def create_directory(context: SapioWebhookContext | SapioUser, bridge_name: str, file_path: str) -> None:
+    def create_directory(context: UserIdentifier, bridge_name: str, file_path: str) -> None:
         """
         Create a new directory in FileBridge.
 
@@ -97,12 +98,12 @@ class FileBridge:
         params = {
             'Filepath': f"bridge://{bridge_name}/{file_path}"
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.post(sub_path, params=params)
         user.raise_for_status(response)
 
     @staticmethod
-    def delete_file(context: SapioWebhookContext | SapioUser, bridge_name: str, file_path: str) -> None:
+    def delete_file(context: UserIdentifier, bridge_name: str, file_path: str) -> None:
         """
         Delete an existing file in FileBridge.
 
@@ -115,12 +116,12 @@ class FileBridge:
         params = {
             'Filepath': f"bridge://{bridge_name}/{file_path}"
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.delete(sub_path, params=params)
         user.raise_for_status(response)
 
     @staticmethod
-    def delete_directory(context: SapioWebhookContext | SapioUser, bridge_name: str, file_path: str) -> None:
+    def delete_directory(context: UserIdentifier, bridge_name: str, file_path: str) -> None:
         """
         Delete an existing directory in FileBridge.
 
@@ -133,6 +134,6 @@ class FileBridge:
         params = {
             'Filepath': f"bridge://{bridge_name}/{file_path}"
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.delete(sub_path, params=params)
         user.raise_for_status(response)

{sapiopycommons-2024.8.19a305 → sapiopycommons-2024.8.26a307}/src/sapiopycommons/files/file_bridge_handler.py

@@ -3,9 +3,10 @@ from __future__ import annotations
 from abc import abstractmethod, ABC
 from weakref import WeakValueDictionary
 
-from sapiopycommons.files.file_bridge import FileBridge
 from sapiopylib.rest.User import SapioUser
-from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
+
+from sapiopycommons.files.file_bridge import FileBridge
+from sapiopycommons.general.aliases import AliasUtil, UserIdentifier
 
 
 class FileBridgeHandler:
@@ -27,11 +28,11 @@ class FileBridgeHandler:
     __instances: WeakValueDictionary[str, FileBridgeHandler] = WeakValueDictionary()
     __initialized: bool
 
-    def __new__(cls, context: SapioWebhookContext | SapioUser, bridge_name: str):
+    def __new__(cls, context: UserIdentifier, bridge_name: str):
         """
         :param context: The current webhook context or a user object to send requests from.
         """
-        user = context if isinstance(context, SapioUser) else context.user
+        user = AliasUtil.to_sapio_user(context)
         key = f"{user.__hash__()}:{bridge_name}"
         obj = cls.__instances.get(key)
         if not obj:
@@ -40,7 +41,7 @@ class FileBridgeHandler:
             cls.__instances[key] = obj
         return obj
 
-    def __init__(self, context: SapioWebhookContext | SapioUser, bridge_name: str):
+    def __init__(self, context: UserIdentifier, bridge_name: str):
         """
         :param context: The current webhook context or a user object to send requests from.
         :param bridge_name: The name of the bridge to communicate with. This is the "connection name" in the
@@ -50,7 +51,7 @@ class FileBridgeHandler:
             return
         self.__initialized = True
 
-        self.user = context if isinstance(context, SapioUser) else context.user
+        self.user = AliasUtil.to_sapio_user(context)
         self.__bridge = bridge_name
         self.__file_cache = {}
         self.__files = {}
@@ -327,7 +328,7 @@ class Directory(FileBridgeObject):
         return {x: y for x, y in self.contents.items() if not y.is_file()}
 
 
-def split_path(file_path: str) -> (str, str):
+def split_path(file_path: str) -> tuple[str, str]:
     """
     :param file_path: A file path where directories are separated the "/" characters.
     :return: A tuple of two strings that splits the path on its last slash. The first string is the name of the

{sapiopycommons-2024.8.19a305 → sapiopycommons-2024.8.26a307}/src/sapiopycommons/files/file_data_handler.py

@@ -1,13 +1,10 @@
 import re
 from typing import Any, Callable, Iterable
 
-from sapiopycommons.general.exceptions import SapioException
-
-from sapiopycommons.recordmodel.record_handler import RecordHandler
-
 from sapiopycommons.general.aliases import SapioRecord
-
+from sapiopycommons.general.exceptions import SapioException
 from sapiopycommons.general.time_util import TimeUtil
+from sapiopycommons.recordmodel.record_handler import RecordHandler
 
 FilterList = Iterable[int] | range | Callable[[int, dict[str, Any]], bool] | None
 """A FilterList is an object used to determine if a row in the file data should be skipped over. This can take the