sapiopycommons 2024.8.29a317__py3-none-any.whl → 2024.8.30a320__py3-none-any.whl

sapiopycommons/general/popup_util.py

@@ -1,3 +1,5 @@
+import warnings
+
 from sapiopylib.rest.DataMgmtService import DataMgmtServer
 from sapiopylib.rest.pojo.datatype.DataType import DataTypeDefinition
 from sapiopylib.rest.pojo.datatype.FieldDefinition import VeloxStringFieldDefinition, AbstractVeloxFieldDefinition, \
@@ -51,6 +53,7 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         if display_name is None:
             display_name = data_type
         if plural_display_name is None:
@@ -97,6 +100,7 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         # Get the field definitions of the data type.
         data_type: str = record.data_type_name
         type_man = DataMgmtServer.get_data_type_manager(context.user)
@@ -155,6 +159,7 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         if max_length is None:
             max_length = len(default_value) if default_value else 100
         string_field = VeloxStringFieldDefinition(data_type, field_name, field_name, default_value=default_value,
@@ -191,6 +196,7 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         if default_value is None:
             default_value = max(0, min_value)
         integer_field = VeloxIntegerFieldDefinition(data_type, field_name, field_name, default_value=default_value,
@@ -229,6 +235,7 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         if default_value is None:
             default_value = min_value
         double_field = VeloxDoubleFieldDefinition(data_type, field_name, field_name, default_value=default_value,
@@ -260,6 +267,7 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         if display_name is None:
             display_name = data_type
         if plural_display_name is None:
@@ -295,6 +303,7 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         data_types: set[str] = {x.data_type_name for x in records}
         if len(data_types) > 1:
             raise SapioException("Multiple data type names encountered in records list for record table popup.")
@@ -347,6 +356,7 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         data_types: set[str] = {x.data_type_name for x in records}
         if len(data_types) > 1:
             raise SapioException("Multiple data type names encountered in records list for record table popup.")
@@ -391,6 +401,7 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         callback = ListDialogRequest(title, multi_select, options,
                                      callback_context_data=request_context)
         return SapioWebhookResult(True, client_callback_request=callback)
@@ -415,6 +426,7 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         callback = OptionDialogRequest(title, msg, options, default_option, user_can_cancel,
                                        callback_context_data=request_context)
         return SapioWebhookResult(True, client_callback_request=callback)
@@ -437,6 +449,7 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         return PopupUtil.option_popup(title, msg, ["OK"], 0, user_can_cancel, request_context=request_context)
 
     @staticmethod
@@ -458,6 +471,7 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         return PopupUtil.option_popup(title, msg, ["Yes", "No"], 0 if default_yes else 1, user_can_cancel,
                                       request_context=request_context)
 
@@ -470,6 +484,7 @@ class PopupUtil:
 
         Deprecated for PopupUtil.text_field_popup.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         return PopupUtil.string_field_popup(title, "", field_name, msg, len(msg), False, data_type,
                                             request_context=request_context, auto_size=True)
 
@@ -481,6 +496,7 @@ class PopupUtil:
 
         Deprecated for PopupUtil.option_popup.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         return PopupUtil.option_popup(title, msg, options, 0, user_can_cancel, request_context=request_context)
 
     @staticmethod
@@ -490,4 +506,5 @@ class PopupUtil:
 
         Deprecated for PopupUtil.ok_popup.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         return PopupUtil.ok_popup(title, msg, False, request_context=request_context)

sapiopycommons/general/sapio_links.py

@@ -0,0 +1,50 @@
+from sapiopylib.rest.User import SapioUser
+from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
+
+from sapiopycommons.general.aliases import RecordIdentifier, ExperimentIdentifier, AliasUtil, DataTypeIdentifier
+from sapiopycommons.general.exceptions import SapioException
+
+
+class SapioNavigationLinker:
+    """
+    Given a URL to a system's webservice API (example: https://company.exemplareln.com/webservice/api), construct
+    URLs for navigation links to various locations in the system.
+    """
+    base_url: str
+
+    def __init__(self, url: str | SapioUser | SapioWebhookContext):
+        """
+        :param url: A user or context object that is being used to send requests to a Sapio system, or a URL to a
+            system's webservice API.
+        """
+        if isinstance(url, SapioWebhookContext):
+            url = url.user.url
+        elif isinstance(url, SapioUser):
+            url = url.url
+        self.base_url = url.rstrip("/").replace('webservice/api', 'veloxClient')
+
+    def data_record(self, record_identifier: RecordIdentifier, data_type_name: DataTypeIdentifier | None = None) -> str:
+        """
+        :param record_identifier: An object that can be used to identify a record in the system, be that a record ID,
+            a data record, or a record model.
+        :param data_type_name: If the provided record identifier is a record ID, then the data type name of the record
+            must be provided in this parameter. Otherwise, this parameter is ignored.
+        :return: A URL for navigating to the input record.
+        """
+        record_id: int = AliasUtil.to_record_id(record_identifier)
+        if data_type_name:
+            data_type_name = AliasUtil.to_data_type_name(data_type_name)
+        if not isinstance(record_identifier, int):
+            data_type_name = AliasUtil.to_data_type_name(record_identifier)
+        if not data_type_name:
+            raise SapioException("Unable to create a data record link without a data type name. "
+                                 "Only a record ID was provided.")
+        return self.base_url + f"/#dataType={data_type_name};recordId={record_id};view=dataRecord"
+
+    def experiment(self, experiment: ExperimentIdentifier) -> str:
+        """
+        :param experiment: An object that can be used to identify an experiment in the system, be that an experiment
+            object, experiment protocol, or a notebook ID.
+        :return: A URL for navigating to the input experiment.
+        """
+        return self.base_url + f"/#notebookExperimentId={AliasUtil.to_notebook_id(experiment)};view=eln"

sapiopycommons/general/time_util.py

@@ -1,8 +1,12 @@
+from __future__ import annotations
+
 import time
 from datetime import datetime
 
 import pytz
 
+from sapiopycommons.general.exceptions import SapioException
+
 __timezone = None
 """The default timezone. Use TimeUtil.set_default_timezone in a global context before making use of TimeUtil."""
 
@@ -137,3 +141,39 @@ class TimeUtil:
             return True
         except Exception:
             return False
+
+
+class DateRange:
+    start: int | None
+    end: int | None
+
+    @staticmethod
+    def from_string(value: str | None) -> DateRange:
+        """
+        Construct a DateRange object from a string. The field value of date range fields is a string of the form
+        <start timestamp>/<end timestamp>.
+
+        :param value: A date range field value.
+        :return: A DateRange object matching the input field value.
+        """
+        if not value:
+            return DateRange(None, None)
+        values: list[str] = value.split("/")
+        return DateRange(int(values[0]), int(values[1]))
+
+    def __init__(self, start: int | None, end: int | None):
+        """
+        :param start: The timestamp for the start of the date range.
+        :param end: The timestamp for the end of the date rate.
+        """
+        if (start and end is None) or (end and start is None):
+            raise SapioException("Both start and end values must be present in a date range.")
+        if start and end and end < start:
+            raise SapioException(f"End timestamp {end} is earlier than the start timestamp {start}.")
+        self.start = start
+        self.end = end
+
+    def __str__(self) -> str | None:
+        if not self.start and not self.end:
+            return None
+        return f"{self.start}/{self.end}"

sapiopycommons/multimodal/multimodal_data.py

@@ -6,7 +6,6 @@ from typing import Any
 
 from databind.core import ExtraKeys
 from databind.core.dataclasses import dataclass
-from sapiopylib.rest.pojo.DataRecord import DataRecord
 
 
 @dataclass

sapiopycommons/processtracking/endpoints.py

@@ -1,12 +1,12 @@
 from sapiopylib.rest.User import SapioUser
-from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
 
-from sapiopycommons.general.aliases import RecordIdentifier, AliasUtil, ExperimentIdentifier
+from sapiopycommons.general.aliases import RecordIdentifier, AliasUtil, ExperimentIdentifier, DataTypeIdentifier, \
+    UserIdentifier
 
 
 class ProcessTracking:
     @staticmethod
-    def assign_to_process(context: SapioWebhookContext | SapioUser, data_type: str, records: list[RecordIdentifier],
+    def assign_to_process(context: UserIdentifier, data_type: DataTypeIdentifier, records: list[RecordIdentifier],
                           process_name: str, step_number: int | None = None, branch_id: int | None = None,
                           request: RecordIdentifier | None = None) -> None:
         """
@@ -27,19 +27,19 @@ class ProcessTracking:
         """
         sub_path = '/ext/process-tracking/assign-to-process'
         payload = {
-            "data-type-name": data_type,
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
             "record-ids": AliasUtil.to_record_ids(records),
             "process-name": process_name,
             "step-number": step_number,
             "branch-id": branch_id,
             "request-record-id": AliasUtil.to_record_ids([request])[0] if request is not None else None
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def begin_protocol(context: SapioWebhookContext | SapioUser, data_type: str, records: list[RecordIdentifier],
+    def begin_protocol(context: UserIdentifier, data_type: DataTypeIdentifier, records: list[RecordIdentifier],
                        experiment: ExperimentIdentifier) -> None:
         """
         Begin the assigned processes of the given tracked records as the given experiment. This sets the status of the
@@ -54,16 +54,16 @@ class ProcessTracking:
         """
         sub_path = '/ext/process-tracking/begin-protocol'
         payload = {
-            "data-type-name": data_type,
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
             "record-ids": AliasUtil.to_record_ids(records),
             "experiment-id": AliasUtil.to_notebook_id(experiment),
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def complete_protocol(context: SapioWebhookContext | SapioUser, data_type: str, records: list[RecordIdentifier],
+    def complete_protocol(context: UserIdentifier, data_type: DataTypeIdentifier, records: list[RecordIdentifier],
                           experiment: ExperimentIdentifier) -> None:
         """
         Complete the current step that the given tracked records are at given the experiment.
@@ -80,16 +80,16 @@ class ProcessTracking:
         """
         sub_path = '/ext/process-tracking/complete-protocol'
         payload = {
-            "data-type-name": data_type,
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
             "record-ids": AliasUtil.to_record_ids(records),
             "experiment-id": AliasUtil.to_notebook_id(experiment),
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def fail(context: SapioWebhookContext | SapioUser, data_type: str, records: list[RecordIdentifier],
+    def fail(context: UserIdentifier, data_type: DataTypeIdentifier, records: list[RecordIdentifier],
              experiment: ExperimentIdentifier) -> None:
         """
         Fail the assigned processes of the given tracked records, changing their statuses to "Failed -". The tracked
@@ -103,16 +103,16 @@ class ProcessTracking:
         """
         sub_path = '/ext/process-tracking/fail'
         payload = {
-            "data-type-name": data_type,
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
             "record-ids": AliasUtil.to_record_ids(records),
             "experiment-id": AliasUtil.to_notebook_id(experiment),
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def promote_to_next_by_experiment(context: SapioWebhookContext | SapioUser, data_type: str,
+    def promote_to_next_by_experiment(context: UserIdentifier, data_type: DataTypeIdentifier,
                                       records: list[RecordIdentifier], experiment: ExperimentIdentifier) -> None:
         """
         Promote the status of the given tracked records to the next status in their process using an experiment.
@@ -129,16 +129,16 @@ class ProcessTracking:
         """
         sub_path = '/ext/process-tracking/promote-status-to-next'
         payload = {
-            "data-type-name": data_type,
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
             "record-ids": AliasUtil.to_record_ids(records),
             "experiment-id": AliasUtil.to_notebook_id(experiment),
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def promote_to_next_by_step(context: SapioWebhookContext | SapioUser, data_type: str,
+    def promote_to_next_by_step(context: UserIdentifier, data_type: DataTypeIdentifier,
                                 records: list[RecordIdentifier], process_name: str, step_number: int,
                                 branch_id: int | None = None) -> None:
         """
@@ -159,7 +159,7 @@ class ProcessTracking:
         """
         sub_path = '/ext/process-tracking/promote-status-to-next'
         payload = {
-            "data-type-name": data_type,
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
             "record-ids": AliasUtil.to_record_ids(records),
             "current-process-status": {
                 "process-name": process_name,
@@ -167,12 +167,12 @@ class ProcessTracking:
                 "branch-id": branch_id
             }
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def reprocess(context: SapioWebhookContext | SapioUser, records: list[RecordIdentifier]) -> None:
+    def reprocess(context: UserIdentifier, records: list[RecordIdentifier]) -> None:
         """
         Reprocess tracked records to a previous step in their process. Reprocessing is controlled by ReturnPoint records
         which are children of the AssignedProcess on the tracked records. Creates a new AssignedProcess record for the
@@ -187,6 +187,6 @@ class ProcessTracking:
         payload = {
             "record-ids": AliasUtil.to_record_ids(records)
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)