sapiopycommons 2024.11.7a354__py3-none-any.whl → 2024.11.8a359__py3-none-any.whl

sapiopycommons/general/popup_util.py

@@ -1,5 +1,3 @@
-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, \
@@ -53,7 +51,6 @@ 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:
@@ -100,7 +97,6 @@ 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)
@@ -159,7 +155,6 @@ 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,
@@ -196,7 +191,6 @@ 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,
@@ -235,7 +229,6 @@ 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,
@@ -267,7 +260,6 @@ 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:
@@ -303,9 +295,6 @@ 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 not records:
-            raise SapioException("No records provided.")
         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.")
@@ -358,9 +347,6 @@ 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 not records:
-            raise SapioException("No records provided.")
         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.")
@@ -405,7 +391,6 @@ 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)
@@ -430,7 +415,6 @@ 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)
@@ -453,7 +437,6 @@ 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
@@ -475,7 +458,6 @@ 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)
 
@@ -488,7 +470,6 @@ 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)
 
@@ -500,7 +481,6 @@ 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
@@ -510,5 +490,4 @@ 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/time_util.py

@@ -1,5 +1,3 @@
-from __future__ import annotations
-
 import time
 from datetime import datetime
 
@@ -94,10 +92,9 @@ class TimeUtil:
         return TimeUtil.current_time(timezone).strftime(time_format)
 
     @staticmethod
-    def millis_to_format(millis: int, time_format: str, timezone: str | int = None) -> str | None:
+    def millis_to_format(millis: int, time_format: str, timezone: str | int = None) -> str:
         """
-        Convert the input time in milliseconds to the provided format. If None is passed to the millis parameter,
-        None will be returned
+        Convert the input time in milliseconds to the provided format.
 
         :param millis: The time in milliseconds to convert from.
         :param time_format: The format to display the input time in. Documentation for how the time formatting works
@@ -106,9 +103,6 @@ class TimeUtil:
             timezone variable set by the TimeUtil. A list of valid timezones can be found at
             https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. May also accept a UTC offset in seconds.
         """
-        if millis is None:
-            return None
-
         tz = TimeUtil.__to_tz(timezone)
         return datetime.fromtimestamp(millis / 1000, tz).strftime(time_format)
 

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, DataTypeIdentifier, \
-    UserIdentifier
+from sapiopycommons.general.aliases import RecordIdentifier, AliasUtil, ExperimentIdentifier
 
 
 class ProcessTracking:
     @staticmethod
-    def assign_to_process(context: UserIdentifier, data_type: DataTypeIdentifier, records: list[RecordIdentifier],
+    def assign_to_process(context: SapioWebhookContext | SapioUser, data_type: str, 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": AliasUtil.to_data_type_name(data_type),
+            "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 = AliasUtil.to_sapio_user(context)
+        user: SapioUser = context if isinstance(context, SapioUser) else context.user
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def begin_protocol(context: UserIdentifier, data_type: DataTypeIdentifier, records: list[RecordIdentifier],
+    def begin_protocol(context: SapioWebhookContext | SapioUser, data_type: str, 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": AliasUtil.to_data_type_name(data_type),
+            "data-type-name": data_type,
             "record-ids": AliasUtil.to_record_ids(records),
             "experiment-id": AliasUtil.to_notebook_id(experiment),
         }
-        user: SapioUser = AliasUtil.to_sapio_user(context)
+        user: SapioUser = context if isinstance(context, SapioUser) else context.user
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def complete_protocol(context: UserIdentifier, data_type: DataTypeIdentifier, records: list[RecordIdentifier],
+    def complete_protocol(context: SapioWebhookContext | SapioUser, data_type: str, 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": AliasUtil.to_data_type_name(data_type),
+            "data-type-name": data_type,
             "record-ids": AliasUtil.to_record_ids(records),
             "experiment-id": AliasUtil.to_notebook_id(experiment),
         }
-        user: SapioUser = AliasUtil.to_sapio_user(context)
+        user: SapioUser = context if isinstance(context, SapioUser) else context.user
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def fail(context: UserIdentifier, data_type: DataTypeIdentifier, records: list[RecordIdentifier],
+    def fail(context: SapioWebhookContext | SapioUser, data_type: str, 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": AliasUtil.to_data_type_name(data_type),
+            "data-type-name": data_type,
             "record-ids": AliasUtil.to_record_ids(records),
             "experiment-id": AliasUtil.to_notebook_id(experiment),
         }
-        user: SapioUser = AliasUtil.to_sapio_user(context)
+        user: SapioUser = context if isinstance(context, SapioUser) else context.user
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def promote_to_next_by_experiment(context: UserIdentifier, data_type: DataTypeIdentifier,
+    def promote_to_next_by_experiment(context: SapioWebhookContext | SapioUser, data_type: str,
                                       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": AliasUtil.to_data_type_name(data_type),
+            "data-type-name": data_type,
             "record-ids": AliasUtil.to_record_ids(records),
             "experiment-id": AliasUtil.to_notebook_id(experiment),
         }
-        user: SapioUser = AliasUtil.to_sapio_user(context)
+        user: SapioUser = context if isinstance(context, SapioUser) else context.user
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def promote_to_next_by_step(context: UserIdentifier, data_type: DataTypeIdentifier,
+    def promote_to_next_by_step(context: SapioWebhookContext | SapioUser, data_type: str,
                                 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": AliasUtil.to_data_type_name(data_type),
+            "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 = AliasUtil.to_sapio_user(context)
+        user: SapioUser = context if isinstance(context, SapioUser) else context.user
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def reprocess(context: UserIdentifier, records: list[RecordIdentifier]) -> None:
+    def reprocess(context: SapioWebhookContext | SapioUser, 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 = AliasUtil.to_sapio_user(context)
+        user: SapioUser = context if isinstance(context, SapioUser) else context.user
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)