sapiopycommons 2025.3.6a451__py3-none-any.whl → 2025.3.6a454__py3-none-any.whl

sapiopycommons/customreport/auto_pagers.py

@@ -8,7 +8,6 @@ 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
@@ -111,20 +110,20 @@ class QuickReportDictAutoPager(_DictReportPagerBase):
         super().__init__(user, first_page_criteria)
 
 
-class _RecordReportPagerBase(SapioPyAutoPager[CustomReportCriteria, RecordModel], ABC):
+class _RecordReportPagerBase(SapioPyAutoPager[CustomReportCriteria, WrappedType], ABC):
     """
     A base class for automatically paging through a report and returning the results as a list of records.
     """
     _columns: list[ReportColumn]
-    _query_type: type[WrappedType] | str
+    _wrapper: type[WrappedType]
     _data_type: str
     _rec_handler: RecordHandler
     _report_man: CustomReportManager
 
-    def __init__(self, user: UserIdentifier, first_page_criteria: CustomReportCriteria, wrapper_type: type[WrappedType] | str):
+    def __init__(self, user: UserIdentifier, first_page_criteria: CustomReportCriteria, wrapper_type: type[WrappedType]):
         self._columns = first_page_criteria.column_list
-        self._query_type = wrapper_type
-        self._data_type = AliasUtil.to_data_type_name(wrapper_type)
+        self._wrapper = wrapper_type
+        self._data_type = wrapper_type.get_wrapper_data_type_name()
         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)
@@ -140,9 +139,9 @@ class _RecordReportPagerBase(SapioPyAutoPager[CustomReportCriteria, RecordModel]
     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] | Queue[PyRecordModel]]:
+    def get_next_page_result(self) -> tuple[CustomReportCriteria | None, Queue[WrappedType]]:
         report: CustomReport = self._report_man.run_custom_report(self.next_page_criteria)
-        queue = Queue()
+        queue: Queue[WrappedType] = 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":
@@ -152,7 +151,7 @@ class _RecordReportPagerBase(SapioPyAutoPager[CustomReportCriteria, RecordModel]
             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._query_type, ids, page_size=report.page_size):
+        for row in self._rec_handler.query_models_by_id(self._wrapper, ids, page_size=report.page_size):
             queue.put(row)
         if report.has_next_page:
             next_page_criteria = copy(self.next_page_criteria)
@@ -166,15 +165,12 @@ 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] | str, page_number: int = 0,
-                 page_size: int = _default_record_page_size):
+    def __init__(self, user: UserIdentifier, report_criteria: CustomReportCriteria, wrapper_type: type[WrappedType],
+                 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 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 wrapper_type: The record model wrapper type to use for the records.
         :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.
         """
@@ -192,14 +188,12 @@ 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] | str,
+    def __init__(self, user: UserIdentifier, report_name: str, wrapper_type: type[WrappedType],
                  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 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 wrapper_type: The record model wrapper type to use for the records.
         :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.
         """
@@ -214,14 +208,12 @@ 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] | str,
+    def __init__(self, user: UserIdentifier, report_term: RawReportTerm, wrapper_type: type[WrappedType],
                  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 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 wrapper_type: The record model wrapper type to use for the records.
         :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.
         """
@@ -233,12 +225,12 @@ class QuickReportRecordAutoPager(_RecordReportPagerBase):
         super().__init__(user, first_page_criteria, wrapper_type)
 
 
-def _add_record_id_column(report: CustomReportCriteria, wrapper_type: type[WrappedType] | str) -> None:
+def _add_record_id_column(report: CustomReportCriteria, wrapper_type: type[WrappedType]) -> 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 = AliasUtil.to_data_type_name(wrapper_type)
+    dt: str = wrapper_type.get_wrapper_data_type_name()
     # 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/general/sapio_links.py

@@ -10,8 +10,7 @@ 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.
     """
-    client_url: str
-    webservice_url: str
+    base_url: str
 
     def __init__(self, url: str | SapioUser | SapioWebhookContext):
         """
@@ -22,14 +21,7 @@ class SapioNavigationLinker:
             url = url.user.url
         elif isinstance(url, SapioUser):
             url = url.url
-        self.webservice_url = url.rstrip("/")
-        self.client_url = url.rstrip("/").replace('webservice/api', 'veloxClient')
-
-    def homepage(self) -> str:
-        """
-        :return: A URL for navigating to the system's homepage.
-        """
-        return self.client_url + "/#view=homepage"
+        self.base_url = url.rstrip("/").replace('webservice/api', 'veloxClient')
 
     def data_record(self, record_identifier: RecordIdentifier, data_type_name: DataTypeIdentifier | None = None) -> str:
         """
@@ -47,7 +39,7 @@ class SapioNavigationLinker:
         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.client_url + f"/#dataType={data_type_name};recordId={record_id};view=dataRecord"
+        return self.base_url + f"/#dataType={data_type_name};recordId={record_id};view=dataRecord"
 
     def experiment(self, experiment: ExperimentIdentifier) -> str:
         """
@@ -55,4 +47,4 @@ class SapioNavigationLinker:
             object, experiment protocol, or a notebook ID.
         :return: A URL for navigating to the input experiment.
         """
-        return self.client_url + f"/#notebookExperimentId={AliasUtil.to_notebook_id(experiment)};view=eln"
+        return self.base_url + f"/#notebookExperimentId={AliasUtil.to_notebook_id(experiment)};view=eln"