sapiopycommons 2025.3.21a458__tar.gz → 2025.3.26a460__tar.gz

{sapiopycommons-2025.3.21a458 → sapiopycommons-2025.3.26a460}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sapiopycommons
-Version: 2025.3.21a458
+Version: 2025.3.26a460
 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-2025.3.21a458 → sapiopycommons-2025.3.26a460}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sapiopycommons"
-version='2025.03.21a458'
+version='2025.03.26a460'
 authors = [
     { name="Jonathan Steck", email="jsteck@sapiosciences.com" },
     { name="Yechen Qiao", email="yqiao@sapiosciences.com" },

{sapiopycommons-2025.3.21a458 → sapiopycommons-2025.3.26a460}/src/sapiopycommons/callbacks/callback_util.py

@@ -28,6 +28,7 @@ from sapiopylib.rest.pojo.webhook.WebhookEnums import FormAccessLevel, ScanToSel
 from sapiopylib.rest.utils.DataTypeCacheManager import DataTypeCacheManager
 from sapiopylib.rest.utils.FormBuilder import FormBuilder
 from sapiopylib.rest.utils.recorddatasinks import InMemoryRecordDataSink
+from sapiopylib.rest.utils.recordmodel.PyRecordModel import PyRecordModel
 from sapiopylib.rest.utils.recordmodel.RecordModelWrapper import WrappedType
 
 from sapiopycommons.callbacks.field_builder import FieldBuilder, AnyFieldInfo
@@ -182,7 +183,7 @@ class CallbackUtil:
     def ok_dialog(self, title: str, msg: str) -> None:
         """
         Create an option dialog where the only option is "OK". Doesn't allow the user to cancel the
-        dialog using the X at the top right corner. Returns nothing.
+        dialog using the X in the top right corner. Returns nothing.
 
         :param title: The title of the dialog.
         :param msg: The message to display in the dialog. This can be formatted using HTML elements.
@@ -407,15 +408,17 @@ class CallbackUtil:
                                                     default_modifier=default_modifier, field_modifiers=field_modifiers)
         record.set_field_values(results)
 
+    # CR-47491: Support providing a data type name string to receive PyRecordModels instead of requiring a WrapperType.
     def create_record_form_dialog(self,
                                   title: str,
                                   msg: str,
                                   fields: list[FieldIdentifier | FieldFilterCriteria] | DataTypeLayoutIdentifier,
-                                  wrapper_type: type[WrappedType],
+                                  wrapper_type: type[WrappedType] | str,
                                   column_positions: dict[str, tuple[int, int]] | None = None,
                                   *,
                                   default_modifier: FieldModifier | None = None,
-                                  field_modifiers: dict[FieldIdentifier, FieldModifier] | None = None) -> WrappedType:
+                                  field_modifiers: dict[FieldIdentifier, FieldModifier] | None = None) \
+            -> WrappedType | PyRecordModel:
         """
         Create a form dialog where the user may input data into the fields of the form. The form is constructed from
         a record that is created using the given record model wrapper. After the user submits this dialog, the values
@@ -431,7 +434,9 @@ class CallbackUtil:
             [Extension Data Type Name].[Data Field Name]. This parameter may also be an identifier for a data type
             layout from the data type of the provided records. If None, then the layout assigned to the current user's
             group for this data type will be used. FieldFilterCriteria may also be provided in lieu of field names.
-        :param wrapper_type: The record model wrapper of the record to be created and updated.
+        :param wrapper_type: The record model wrapper or data type name of the record to be created and updated.
+            If a data type name is provided, the returned record will be a PyRecordModel instead of a
+            WrappedRecordModel.
         :param column_positions: If a tuple is provided for a field name, alters that field's column position and column
             span. (Field order is still determined by the fields list.) Has no effect if the fields parameter provides
             a data type layout.
@@ -446,7 +451,7 @@ class CallbackUtil:
             None, then the default modifier will be used.
         :return: The record model that was created and updated by the user.
         """
-        record: WrappedType = self.rec_handler.add_model(wrapper_type)
+        record: WrappedType | PyRecordModel = self.rec_handler.add_model(wrapper_type)
         self.set_record_form_dialog(title, msg, fields, record, column_positions,
                                     default_modifier=default_modifier, field_modifiers=field_modifiers)
         return record
@@ -794,7 +799,7 @@ class CallbackUtil:
                                    title: str,
                                    msg: str,
                                    fields: list[FieldValue] | DataTypeLayoutIdentifier,
-                                   wrapper_type: type[WrappedType],
+                                   wrapper_type: type[WrappedType] | str,
                                    count: int | tuple[int, int],
                                    *,
                                    default_modifier: FieldModifier | None = None,
@@ -803,7 +808,7 @@ class CallbackUtil:
                                    image_data: list[bytes] | None = None,
                                    require_input: bool = False,
                                    repeat_message: str | None = "Please provide a value to continue.") \
-            -> list[WrappedType]:
+            -> list[WrappedType] | list[PyRecordModel]:
         """
         Create a table dialog where the user may input data into the fields of the table. The table is constructed from
         a list of records that are created using the given record model wrapper. After the user submits this dialog,
@@ -819,7 +824,8 @@ class CallbackUtil:
             [Extension Data Type Name].[Data Field Name]. This parameter may also be an identifier for a data type
             layout from the data type of the provided records. If None, then the layout assigned to the current user's
             group for this data type will be used.
-        :param wrapper_type: The record model wrapper of the records to be created and updated.
+        :param wrapper_type: The record model wrapper or data type name of the records to be created and updated. If
+            a data type name is provided, the returned records will be PyRecordModels instead of WrappedRecordModels.
         :param count: The number of records to create. If provided as a tuple of two integers, the user will first be
             prompted to select an integer between the two values in the tuple.
         :param default_modifier: A default field modifier that will be applied to the given fields. This can be used to
@@ -844,7 +850,7 @@ class CallbackUtil:
         count: int = self.__prompt_for_count(count, wrapper_type, require_input, repeat_message)
         if count <= 0:
             return []
-        records: list[WrappedType] = self.rec_handler.add_models(wrapper_type, count)
+        records: list[WrappedType] | list[PyRecordModel] = self.rec_handler.add_models(wrapper_type, count)
         self.set_record_table_dialog(title, msg, fields, records,
                                      default_modifier=default_modifier, field_modifiers=field_modifiers,
                                      group_by=group_by, image_data=image_data)
@@ -974,7 +980,7 @@ class CallbackUtil:
                                       title: str,
                                       msg: str,
                                       fields: list[FieldValue] | DataTypeLayoutIdentifier,
-                                      wrapper_type: type[WrappedType],
+                                      wrapper_type: type[WrappedType] | str,
                                       count: int | tuple[int, int],
                                       *,
                                       default_modifier: FieldModifier | None = None,
@@ -1003,7 +1009,8 @@ class CallbackUtil:
             [Extension Data Type Name].[Data Field Name]. This parameter may also be an identifier for a data type
             layout from the data type of the provided records. If None, then the layout assigned to the current user's
             group for this data type will be used.
-        :param wrapper_type: The record model wrapper of the records to be created and updated.
+        :param wrapper_type: The record model wrapper or data type name of the records to be created and updated. If
+            a data type name is provided, the returned records will be PyRecordModels instead of WrappedRecordModels.
         :param count: The number of records to create. If provided as a tuple of two integers, the user will first be
             prompted to select an integer between the two values in the tuple.
         :param default_modifier: A default field modifier that will be applied to the given fields. This can be used to
@@ -1427,7 +1434,7 @@ class CallbackUtil:
 
     # CR-47377: Add allow_creation and default_creation_number to cover new parameters of this request type from 24.12.
     def input_selection_dialog(self,
-                               wrapper_type: type[WrappedType],
+                               wrapper_type: type[WrappedType] | str,
                                msg: str,
                                multi_select: bool = True,
                                only_key_fields: bool = False,
@@ -1442,13 +1449,14 @@ class CallbackUtil:
                                *,
                                require_selection: bool = False,
                                repeat_message: str | None = "Please provide a selection to continue.") \
-            -> list[WrappedType]:
+            -> list[WrappedType] | list[PyRecordModel]:
         """
         Display a table of records that exist in the system matching the given data type and filter criteria and have
         the user select one or more records from the table.
         The title of a selection dialog will always be "Select [plural display name]".
 
-        :param wrapper_type: The record model wrapper for the records to display in the dialog.
+        :param wrapper_type: The record model wrapper or data type name for the records to display in the dialog. If
+            a data type name is provided, the returned records will be PyRecordModels instead of WrappedRecordModels.
         :param msg: The message to show near the top of the dialog, below the title. This can be used to
             instruct the user on what is desired from the dialog. This can be formatted using HTML elements.
         :param multi_select: Whether the user may select multiple items at once in this dialog.
@@ -1489,7 +1497,7 @@ class CallbackUtil:
         :return: A list of the records selected by the user in the dialog, wrapped as record models using the provided
             wrapper.
         """
-        data_type: str = wrapper_type.get_wrapper_data_type_name()
+        data_type: str = AliasUtil.to_data_type_name(wrapper_type)
 
         # Reduce the provided lists of records down to lists of record IDs.
         if preselected_records:
@@ -1795,7 +1803,7 @@ class CallbackUtil:
             temp_dt.set_field_definition(modifier.modify_field(field_def))
         return temp_dt
 
-    def __prompt_for_count(self, count: tuple[int, int] | int, wrapper_type: type[WrappedType],
+    def __prompt_for_count(self, count: tuple[int, int] | int, wrapper_type: type[WrappedType] | str,
                            require_input: bool, repeat_message: str) -> int:
         """
         Given a count value, if it is a tuple representing an allowable range of values for a number of records to
@@ -1806,7 +1814,7 @@ class CallbackUtil:
             if hasattr(wrapper_type, "PLURAL_DISPLAY_NAME"):
                 plural: str = wrapper_type.PLURAL_DISPLAY_NAME
             else:
-                plural: str = self.dt_cache.get_plural_display_name(wrapper_type.get_wrapper_data_type_name())
+                plural: str = self.dt_cache.get_plural_display_name(AliasUtil.to_data_type_name(wrapper_type))
             min_val, max_val = count
             msg: str = f"How many {plural} should be created? ({min_val} to {max_val})"
             count: int = self.integer_input_dialog(f"Create {plural}", msg, "Count", min_val, min_val, max_val,

{sapiopycommons-2025.3.21a458 → sapiopycommons-2025.3.26a460}/src/sapiopycommons/customreport/auto_pagers.py

@@ -8,6 +8,7 @@ from sapiopylib.rest.pojo.CustomReport import CustomReportCriteria, CustomReport
 from sapiopylib.rest.pojo.datatype.FieldDefinition import FieldType
 from sapiopylib.rest.utils.autopaging import SapioPyAutoPager, PagerResultCriteriaType, _default_report_page_size, \
     _default_record_page_size
+from sapiopylib.rest.utils.recordmodel.PyRecordModel import PyRecordModel
 from sapiopylib.rest.utils.recordmodel.RecordModelWrapper import WrappedType
 
 from sapiopycommons.general.aliases import FieldValue, UserIdentifier, AliasUtil, RecordModel
@@ -110,20 +111,22 @@ class QuickReportDictAutoPager(_DictReportPagerBase):
         super().__init__(user, first_page_criteria)
 
 
-class _RecordReportPagerBase(SapioPyAutoPager[CustomReportCriteria, WrappedType], ABC):
+# CR-47491: Support providing a data type name string to receive PyRecordModels instead of requiring a WrapperType.
+class _RecordReportPagerBase(SapioPyAutoPager[CustomReportCriteria, WrappedType | PyRecordModel], ABC):
     """
     A base class for automatically paging through a report and returning the results as a list of records.
     """
     _columns: list[ReportColumn]
-    _wrapper: type[WrappedType]
+    _query_type: type[WrappedType] | str
     _data_type: str
     _rec_handler: RecordHandler
     _report_man: CustomReportManager
 
-    def __init__(self, user: UserIdentifier, first_page_criteria: CustomReportCriteria, wrapper_type: type[WrappedType]):
+    def __init__(self, user: UserIdentifier, first_page_criteria: CustomReportCriteria,
+                 wrapper_type: type[WrappedType] | str):
         self._columns = first_page_criteria.column_list
-        self._wrapper = wrapper_type
-        self._data_type = wrapper_type.get_wrapper_data_type_name()
+        self._query_type = wrapper_type
+        self._data_type = AliasUtil.to_data_type_name(wrapper_type)
         self._rec_handler = RecordHandler(user)
         super().__init__(AliasUtil.to_sapio_user(user), first_page_criteria)
         self._report_man = DataMgmtServer.get_custom_report_manager(self.user)
@@ -139,9 +142,9 @@ class _RecordReportPagerBase(SapioPyAutoPager[CustomReportCriteria, WrappedType]
     def default_first_page_criteria(self) -> PagerResultCriteriaType:
         raise ValueError("Cannot generate a default first page criteria for custom reports.")
 
-    def get_next_page_result(self) -> tuple[CustomReportCriteria | None, Queue[WrappedType]]:
+    def get_next_page_result(self) -> tuple[CustomReportCriteria | None, Queue[WrappedType] | Queue[PyRecordModel]]:
         report: CustomReport = self._report_man.run_custom_report(self.next_page_criteria)
-        queue: Queue[WrappedType] = Queue()
+        queue = Queue()
         id_index: int = -1
         for i, column in enumerate(self._columns):
             if column.data_type_name == self._data_type and column.data_field_name == "RecordId":
@@ -151,7 +154,7 @@ class _RecordReportPagerBase(SapioPyAutoPager[CustomReportCriteria, WrappedType]
             raise SapioException(f"This report does not contain a Record ID column for the given record model type "
                                  f"{self._data_type}.")
         ids: list[int] = [row[id_index] for row in report.result_table]
-        for row in self._rec_handler.query_models_by_id(self._wrapper, ids, page_size=report.page_size):
+        for row in self._rec_handler.query_models_by_id(self._query_type, ids, page_size=report.page_size):
             queue.put(row)
         if report.has_next_page:
             next_page_criteria = copy(self.next_page_criteria)
@@ -165,12 +168,15 @@ class CustomReportRecordAutoPager(_RecordReportPagerBase):
     """
     A class that automatically pages through a custom report and returns the results as a list of records.
     """
-    def __init__(self, user: UserIdentifier, report_criteria: CustomReportCriteria, wrapper_type: type[WrappedType],
-                 page_number: int = 0, page_size: int = _default_record_page_size):
+    def __init__(self, user: UserIdentifier, report_criteria: CustomReportCriteria,
+                 wrapper_type: type[WrappedType] | str, page_number: int = 0,
+                 page_size: int = _default_record_page_size):
         """
         :param user: The current webhook context or a user object to send requests from.
         :param report_criteria: The custom report criteria to run.
-        :param wrapper_type: The record model wrapper type to use for the records.
+        :param wrapper_type: The record model wrapper type or data type name of the records being searched for.
+            If a data type name was used instead of a model wrapper, then the returned records will be PyRecordModels
+            instead of WrappedRecordModels.
         :param page_number: The page number to start on. The first page is page 0.
         :param page_size: The number of results to return per page.
         """
@@ -188,12 +194,14 @@ class SystemReportRecordAutoPager(_RecordReportPagerBase):
     System reports are also known as predefined searches in the system and must be defined in the data designer for
     a specific data type. That is, saved searches created by users cannot be run using this function.
     """
-    def __init__(self, user: UserIdentifier, report_name: str, wrapper_type: type[WrappedType],
+    def __init__(self, user: UserIdentifier, report_name: str, wrapper_type: type[WrappedType] | str,
                  page_number: int = 0, page_size: int = _default_record_page_size):
         """
         :param user: The current webhook context or a user object to send requests from.
         :param report_name: The name of the system report to run.
-        :param wrapper_type: The record model wrapper type to use for the records.
+        :param wrapper_type: The record model wrapper type or data type name of the records being searched for.
+            If a data type name was used instead of a model wrapper, then the returned records will be PyRecordModels
+            instead of WrappedRecordModels.
         :param page_number: The page number to start on. The first page is page 0.
         :param page_size: The number of results to return per page.
         """
@@ -208,16 +216,18 @@ class QuickReportRecordAutoPager(_RecordReportPagerBase):
     """
     A class that automatically pages through a quick report and returns the results as a list of records.
     """
-    def __init__(self, user: UserIdentifier, report_term: RawReportTerm, wrapper_type: type[WrappedType],
+    def __init__(self, user: UserIdentifier, report_term: RawReportTerm, wrapper_type: type[WrappedType] | str,
                  page_number: int = 0, page_size: int = _default_record_page_size):
         """
         :param user: The current webhook context or a user object to send requests from.
         :param report_term: The raw report term to use for the quick report.
-        :param wrapper_type: The record model wrapper type to use for the records.
+        :param wrapper_type: The record model wrapper type or data type name of the records being searched for.
+            If a data type name was used instead of a model wrapper, then the returned records will be PyRecordModels
+            instead of WrappedRecordModels.
         :param page_number: The page number to start on. The first page is page 0.
         :param page_size: The number of results to return per page.
         """
-        if report_term.data_type_name != wrapper_type.get_wrapper_data_type_name():
+        if report_term.data_type_name != AliasUtil.to_data_type_name(wrapper_type):
             raise SapioException("The data type name of the report term must match the data type name of the wrapper type.")
         first_page_criteria: CustomReportCriteria = CustomReportUtil.get_quick_report_criteria(user, report_term)
         first_page_criteria.page_number = page_number
@@ -225,12 +235,12 @@ class QuickReportRecordAutoPager(_RecordReportPagerBase):
         super().__init__(user, first_page_criteria, wrapper_type)
 
 
-def _add_record_id_column(report: CustomReportCriteria, wrapper_type: type[WrappedType]) -> None:
+def _add_record_id_column(report: CustomReportCriteria, wrapper_type: type[WrappedType] | str) -> None:
     """
     Given a custom report criteria, ensure that the report contains a Record ID column for the given record model's
     data type. Add one if it is missing.
     """
-    dt: str = wrapper_type.get_wrapper_data_type_name()
+    dt: str = AliasUtil.to_data_type_name(wrapper_type)
     # Ensure that the root data type is the one we're looking for.
     report.root_data_type = dt
     # Enforce that the given custom report has a record ID column.

{sapiopycommons-2025.3.21a458 → sapiopycommons-2025.3.26a460}/src/sapiopycommons/datatype/attachment_util.py

@@ -1,6 +1,7 @@
 import io
 
 from sapiopylib.rest.DataMgmtService import DataMgmtServer
+from sapiopylib.rest.utils.recordmodel.PyRecordModel import PyRecordModel
 from sapiopylib.rest.utils.recordmodel.RecordModelWrapper import WrappedType
 
 from sapiopycommons.general.aliases import AliasUtil, SapioRecord, UserIdentifier
@@ -49,9 +50,10 @@ class AttachmentUtil:
         with io.BytesIO(file_bytes) as stream:
             dr_man.set_attachment_data(attachment, file_name, stream)
 
+    # CR-47491: Support providing a data type name string to receive PyRecordModels instead of requiring a WrapperType.
     @staticmethod
     def create_attachment(context: UserIdentifier, file_name: str, file_bytes: bytes,
-                          wrapper_type: type[WrappedType]) -> WrappedType:
+                          wrapper_type: type[WrappedType] | str) -> WrappedType | PyRecordModel:
         """
         Create an attachment data type and initialize its attachment bytes at the same time.
         Makes a webservice call to create the attachment record and a second to set its bytes.
@@ -62,6 +64,6 @@ class AttachmentUtil:
         :param wrapper_type: The attachment type to create.
         :return: A record model for the newly created attachment.
         """
-        attachment: WrappedType = RecordHandler(context).create_models(wrapper_type, 1)[0]
+        attachment: WrappedType | PyRecordModel = RecordHandler(context).create_models(wrapper_type, 1)[0]
         AttachmentUtil.set_attachment_bytes(context, attachment, file_name, file_bytes)
         return attachment

{sapiopycommons-2025.3.21a458 → sapiopycommons-2025.3.26a460}/src/sapiopycommons/datatype/data_fields.py

@@ -59,3 +59,25 @@ class ProcessWorkflowTrackingFields:
     WORKFLOW_START_USER_ID__FIELD = WrapperField("WorkflowStartUserId", FieldType.STRING)
     WORKFLOW_TAT__FIELD = WrapperField("WorkflowTAT", FieldType.DOUBLE)
     WORKFLOW_VERSION__FIELD = WrapperField("WorkflowVersion", FieldType.LONG)
+
+class PlateDesignerWellElementFields:
+    DATA_TYPE_NAME = 'PlateDesignerWellElement'
+    ACTUAL_VOLUME_REMOVED__FIELD = WrapperField("ActualVolumeRemoved", FieldType.DOUBLE)
+    ALIQUOT_SAMPLE_RECORD_ID__FIELD = WrapperField("AliquotSampleRecordId", FieldType.LONG)
+    COL_POSITION__FIELD = WrapperField("ColPosition", FieldType.SELECTION)
+    CONCENTRATION__FIELD = WrapperField("Concentration", FieldType.DOUBLE)
+    CONCENTRATION_UNITS__FIELD = WrapperField("ConcentrationUnits", FieldType.STRING)
+    CONTROL_TYPE__FIELD = WrapperField("ControlType", FieldType.STRING)
+    DILUTION_SCHEME__FIELD = WrapperField("DilutionScheme", FieldType.DOUBLE)
+    IS_CONTROL__FIELD = WrapperField("IsControl", FieldType.BOOLEAN)
+    LAYER__FIELD = WrapperField("Layer", FieldType.INTEGER)
+    PLATE_RECORD_ID__FIELD = WrapperField("PlateRecordId", FieldType.LONG)
+    ROW_POSITION__FIELD = WrapperField("RowPosition", FieldType.SELECTION)
+    SOURCE_DATA_TYPE_NAME__FIELD = WrapperField("SourceDataTypeName", FieldType.STRING)
+    SOURCE_RECORD_ID__FIELD = WrapperField("SourceRecordId", FieldType.LONG)
+    SOURCE_SAMPLE_CONCENTRATION__FIELD = WrapperField("SourceSampleConcentration", FieldType.DOUBLE)
+    SOURCE_SAMPLE_MASS__FIELD = WrapperField("SourceSampleMass", FieldType.DOUBLE)
+    SOURCE_SAMPLE_VOLUME__FIELD = WrapperField("SourceSampleVolume", FieldType.DOUBLE)
+    SOURCE_VOLUME_TO_REMOVE__FIELD = WrapperField("SourceVolumeToRemove", FieldType.DOUBLE)
+    TARGET_MASS__FIELD = WrapperField("TargetMass", FieldType.DOUBLE)
+    VOLUME__FIELD = WrapperField("Volume", FieldType.DOUBLE)