sapiopycommons 2025.2.6a421__tar.gz → 2025.2.11a427__tar.gz

{sapiopycommons-2025.2.6a421 → sapiopycommons-2025.2.11a427}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sapiopycommons
-Version: 2025.2.6a421
+Version: 2025.2.11a427
 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.2.6a421 → sapiopycommons-2025.2.11a427}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sapiopycommons"
-version='2025.02.06a421'
+version='2025.02.11a427'
 authors = [
     { name="Jonathan Steck", email="jsteck@sapiosciences.com" },
     { name="Yechen Qiao", email="yqiao@sapiosciences.com" },

{sapiopycommons-2025.2.6a421 → sapiopycommons-2025.2.11a427}/src/sapiopycommons/elain/tool_of_tools.py

@@ -8,13 +8,13 @@ from sapiopylib.rest.ELNService import ElnManager
 from sapiopylib.rest.User import SapioUser
 from sapiopylib.rest.pojo.DataRecord import DataRecord
 from sapiopylib.rest.pojo.chartdata.DashboardDefinition import GaugeChartDefinition
-from sapiopylib.rest.pojo.chartdata.DashboardEnums import ChartGroupingType, ChartOperationType, ChartType
+from sapiopylib.rest.pojo.chartdata.DashboardEnums import ChartGroupingType, ChartOperationType
 from sapiopylib.rest.pojo.chartdata.DashboardSeries import GaugeChartSeries
 from sapiopylib.rest.pojo.datatype.FieldDefinition import AbstractVeloxFieldDefinition, FieldType
 from sapiopylib.rest.pojo.eln.ElnExperiment import ElnExperiment
 from sapiopylib.rest.pojo.eln.ExperimentEntry import ExperimentEntry
 from sapiopylib.rest.pojo.eln.ExperimentEntryCriteria import ElnEntryCriteria, ElnFormEntryUpdateCriteria, \
-    ElnDashboardEntryUpdateCriteria, AbstractElnEntryUpdateCriteria
+    ElnDashboardEntryUpdateCriteria, ElnTextEntryUpdateCriteria
 from sapiopylib.rest.pojo.eln.SapioELNEnums import ElnEntryType, ElnBaseDataType
 from sapiopylib.rest.pojo.eln.eln_headings import ElnExperimentTabAddCriteria, ElnExperimentTab
 from sapiopylib.rest.pojo.eln.field_set import ElnFieldSetInfo
@@ -22,6 +22,7 @@ from sapiopylib.rest.utils.ProtocolUtils import ELNStepFactory
 from sapiopylib.rest.utils.Protocols import ElnEntryStep, ElnExperimentProtocol
 
 from sapiopycommons.callbacks.field_builder import FieldBuilder
+from sapiopycommons.general.aliases import AliasUtil, SapioRecord
 from sapiopycommons.general.exceptions import SapioException
 from sapiopycommons.general.time_util import TimeUtil
 
@@ -126,33 +127,28 @@ def create_experiment_details_from_json(user: SapioUser,
     fb = FieldBuilder()
     fields: list[AbstractVeloxFieldDefinition] = []
     fields_by_name: dict[str, AbstractVeloxFieldDefinition] = {}
-    valid_keys: list[str] = []
-    display_to_field_name: dict[str, str] = {}
     for key, value in json_list[0].items():
         field_name: str = key.replace(" ", "_")
-        display_to_field_name[key] = field_name
         if isinstance(value, str):
             field = fb.string_field(field_name, display_name=key)
             fields.append(field)
-            fields_by_name[field_name] = field
-            valid_keys.append(key)
+            fields_by_name[key] = field
         elif isinstance(value, (int, float)):
             field = fb.double_field(field_name, display_name=key, precision=3)
             fields.append(field)
-            fields_by_name[field_name] = field
-            valid_keys.append(key)
+            fields_by_name[key] = field
 
     # Extract the valid field values from the JSON.
     field_maps: list[dict[str, Any]] = []
     for json_dict in json_list:
         field_map: dict[str, Any] = {}
-        for key in valid_keys:
+        for key, field in fields_by_name.items():
             # Watch out for NaN values or other special values.
             val: Any = json_dict.get(key)
-            if (fields_by_name[key].data_field_type == FieldType.DOUBLE
+            if (field.data_field_type == FieldType.DOUBLE
                     and (not isinstance(val, (int, float))) or (isinstance(val, float) and math.isnan(val))):
                 val = None
-            field_map[display_to_field_name[key]] = val
+            field_map[field.data_field_name] = val
         field_maps.append(field_map)
 
     detail_entry = ElnEntryCriteria(ElnEntryType.Table, entry_name,
@@ -172,6 +168,43 @@ def tab_next_entry_order(user: SapioUser, exp_id: int, tab: ElnExperimentTab) ->
     return max_order + 1
 
 
+def set_text_entry(timestamp: str, description: str, text_entry: ExperimentEntry, exp_id: int, user: SapioUser) -> None:
+    """
+    Set the text of a text entry.
+
+    :param timestamp: The timestamp to display at the top of the text entry.
+    :param description: The description to display in the text entry.
+    :param text_entry: The text entry to set the text of.
+    :param exp_id: The ID of the experiment that the text entry is in.
+    :param user: The user to send the request from.
+    """
+    description: str = f"""<p><span style="color: rgb(35, 111, 161); font-size: 12pt; font-weight:500;">{timestamp}</span>
+    <br><span style="font-size: 15pt;">{description}</span></p>"""
+    protocol = ElnExperimentProtocol(ElnExperiment(exp_id, "", 0), user)
+    step = ElnEntryStep(protocol, text_entry)
+    text_record: DataRecord = step.get_records()[0]
+    text_record.set_field_value(ElnBaseDataType.get_text_entry_data_field_name(), description)
+    DataRecordManager(user).commit_data_records([text_record])
+
+
+def add_to_text_entry(description: str, text_entry: ExperimentEntry, exp_id: int, user: SapioUser) -> None:
+    """
+    Add to the text of a text entry.
+
+    :param description: The text to add to the text entry.
+    :param text_entry: The text entry to add the text to.
+    :param exp_id: The ID of the experiment that the text entry is in.
+    :param user: The user to send the request from.
+    """
+    protocol = ElnExperimentProtocol(ElnExperiment(exp_id, "", 0), user)
+    step = ElnEntryStep(protocol, text_entry)
+    text_record: DataRecord = step.get_records()[0]
+    update: str = text_record.get_field_value(ElnBaseDataType.get_text_entry_data_field_name())
+    update += f"""<p style="padding-top: 10px;"><span style="font-size: 15pt;">{description}</span></p>"""
+    text_record.set_field_value(ElnBaseDataType.get_text_entry_data_field_name(), update)
+    DataRecordManager(user).commit_data_records([text_record])
+
+
 class ToolOfToolsHelper:
     """
     A class with helper methods utilized by the Tool of Tools for the creation and updating of experiment tabs that
@@ -320,7 +353,7 @@ class ToolOfToolsHelper:
         self.description_record = text_entry.get_records()[0]
 
         # Shrink the text entry by one column.
-        text_update_crit = _ElnTextEntryUpdateCriteria()
+        text_update_crit = ElnTextEntryUpdateCriteria()
         text_update_crit.column_span = 2
         self.eln_man.update_experiment_entry(self.exp_id, self.description_entry.get_id(), text_update_crit)
 
@@ -380,6 +413,16 @@ class ToolOfToolsHelper:
         self.progress_record.set_field_value("StatusMsg", status_msg)
         self.dr_man.commit_data_records([self.progress_record])
 
+    def add_results(self, results: list[SapioRecord]) -> None:
+        """
+        Add the results of the tool to the results entry.
+
+        :param results: The result records to add to the results entry.
+        """
+        if not self._initialized:
+            raise SapioException("The tab for this tool has not been initialized.")
+        self.results_entry.add_records(AliasUtil.to_data_records(results))
+
     def add_results_bar_chart(self, x_axis: str, y_axis: str) -> ExperimentEntry:
         """
         Create a bar chart entry for the results of the tool.
@@ -451,7 +494,7 @@ class ToolOfToolsHelper:
             file_contents: bytes = f.read()
             return self.add_attachment_entry(file_path, file_contents, entry_name, tab)
 
-    # TODO: Remove this once pylib has a gauge chart function in ElnStepFactory.
+    # TODO: Remove this once pylib's gauge chart definition is up to date.
     @staticmethod
     def _create_gauge_chart(protocol: ElnExperimentProtocol, data_source_step: ElnEntryStep, step_name: str,
                             field_name: str, status_field: str, group_by_field_name: str = "DataRecordName") \
@@ -473,19 +516,16 @@ class ToolOfToolsHelper:
         chart.grouping_type = ChartGroupingType.GROUP_BY_FIELD
         chart.grouping_type_data_type_name = data_type_name
         chart.grouping_type_data_field_name = group_by_field_name
-        dashboard, step = ELNStepFactory._create_dashboard_step_from_chart(chart, data_source_step, protocol, step_name)
+        dashboard, step = ELNStepFactory._create_dashboard_step_from_chart(chart, data_source_step, protocol, step_name,
+                                                                           None)
         protocol.invalidate()
         return step
 
 
-# TODO: This is only here because the get_chart_type function in pylib is wrong. Remove this once pylib is fixed.
-#  Also using this to set the new status field setting.
+# TODO: Using this to set the new status field setting.
 class _GaugeChartDefinition(GaugeChartDefinition):
     status_field: str
 
-    def get_chart_type(self) -> ChartType:
-        return ChartType.GAUGE_CHART
-
     def to_json(self) -> dict[str, Any]:
         result = super().to_json()
         result["statusValueField"] = {
@@ -493,18 +533,3 @@ class _GaugeChartDefinition(GaugeChartDefinition):
             "dataFieldName": self.status_field
         }
         return result
-
-
-# TODO: Remove once the ElnTextEntryUpdateCriteria is fixed.
-class _ElnTextEntryUpdateCriteria(AbstractElnEntryUpdateCriteria):
-    """
-    Text Entry Update Data Payload
-    Create this payload object and set the attributes you want to update before sending the request.
-    """
-
-    def __init__(self):
-        super().__init__(ElnEntryType.Text)
-
-    def to_json(self) -> dict[str, Any]:
-        ret = super().to_json()
-        return ret

{sapiopycommons-2025.2.6a421 → sapiopycommons-2025.2.11a427}/src/sapiopycommons/files/file_util.py

@@ -21,10 +21,14 @@ class FileUtil:
     Utilities for the handling of files, including the requesting of files from the user and the parsing of files into
     tokenized lists. Makes use of Pandas DataFrames for any file parsing purposes.
     """
+    # PR-47433: Add a keep_default_na argument to FileUtil.tokenize_csv and FileUtil.tokenize_xlsx so that N/A values
+    # don't get returned as NoneType, and add **kwargs in case any other Pandas input parameters need changed by the
+    # caller.
     @staticmethod
     def tokenize_csv(file_bytes: bytes, required_headers: list[str] | None = None, header_row_index: int | None = 0,
                      seperator: str = ",", *, encoding: str | None = None, encoding_error: str | None = "strict",
-                     exception_on_empty: bool = True) -> tuple[list[dict[str, str]], list[list[str]]]:
+                     exception_on_empty: bool = True, keep_default_na: bool = False, **kwargs) \
+            -> tuple[list[dict[str, str]], list[list[str]]]:
         """
         Tokenize a CSV file. The provided file must be uniform. That is, if row 1 has 10 cells, all the rows in the file
         must have 10 cells. Otherwise, the Pandas parser throws a tokenizer exception.
@@ -46,6 +50,9 @@ class FileUtil:
             https://docs.python.org/3/library/codecs.html#error-handlers
         :param exception_on_empty: Throw a user error exception if the provided file bytes result in an empty list in
             the first element of the returned tuple.
+        :param keep_default_na: If False, values that are recognized as NaN (e.g. N/A, NA, NaN) will remain as strings.
+            If True, these values will be converted to a NoneType value.
+        :param kwargs: Additional arguments to be passed to the pandas read_csv function.
         :return: The CSV parsed into a list of dicts where each dict is a row, mapping the headers to the cells for
             that row. Also returns a list of each row above the headers (the metadata), parsed into a list of each cell.
             If the header row index is 0 or None, this list will be empty.
@@ -53,7 +60,8 @@ class FileUtil:
         # Parse the file bytes into two DataFrames. The first is metadata of the file located above the header row,
         # while the second is the body of the file below the header row.
         file_body, file_metadata = FileUtil.csv_to_data_frames(file_bytes, header_row_index, seperator,
-                                                               encoding=encoding, encoding_error=encoding_error)
+                                                               encoding=encoding, encoding_error=encoding_error,
+                                                               keep_default_na=keep_default_na, **kwargs)
         # Parse the metadata from above the header row index into a list of lists.
         metadata: list[list[str]] = FileUtil.data_frame_to_lists(file_metadata)
         # Parse the data from the file body into a list of dicts.
@@ -64,7 +72,8 @@ class FileUtil:
 
     @staticmethod
     def tokenize_xlsx(file_bytes: bytes, required_headers: list[str] | None = None, header_row_index: int | None = 0,
-                      *, exception_on_empty: bool = True) -> tuple[list[dict[str, str]], list[list[str]]]:
+                      *, exception_on_empty: bool = True, keep_default_na: bool = False, **kwargs) \
+            -> tuple[list[dict[str, str]], list[list[str]]]:
         """
         Tokenize an XLSX file row by row.
 
@@ -77,13 +86,17 @@ class FileUtil:
             is assumed to be the header row.
         :param exception_on_empty: Throw a user error exception if the provided file bytes result in an empty list in
             the first element of the returned tuple.
+        :param keep_default_na: If False, values that are recognized as NaN (e.g. N/A, NA, NaN) will remain as strings.
+            If True, these values will be converted to a NoneType value.
+        :param kwargs: Additional arguments to be passed to the pandas read_excel function.
         :return: The XLSX parsed into a list of dicts where each dict is a row, mapping the headers to the cells for
             that row. Also returns a list of each row above the headers (the metadata), parsed into a list of each cell.
             If the header row index is 0 or None, this list will be empty.
         """
         # Parse the file bytes into two DataFrames. The first is metadata of the file located above the header row,
         # while the second is the body of the file below the header row.
-        file_body, file_metadata = FileUtil.xlsx_to_data_frames(file_bytes, header_row_index)
+        file_body, file_metadata = FileUtil.xlsx_to_data_frames(file_bytes, header_row_index,
+                                                                keep_default_na=keep_default_na, **kwargs)
         # Parse the metadata from above the header row index into a list of lists.
         metadata: list[list[str]] = FileUtil.data_frame_to_lists(file_metadata)
         # Parse the data from the file body into a list of dicts.
@@ -94,7 +107,8 @@ class FileUtil:
 
     @staticmethod
     def csv_to_data_frames(file_bytes: bytes, header_row_index: int | None = 0, seperator: str = ",",
-                           *, encoding: str | None = None, encoding_error: str | None = "strict") \
+                           *, encoding: str | None = None, encoding_error: str | None = "strict",
+                           keep_default_na: bool = False, **kwargs) \
             -> tuple[DataFrame, DataFrame | None]:
         """
         Parse the file bytes for a CSV into DataFrames. The provided file must be uniform. That is, if row 1 has 10
@@ -113,6 +127,9 @@ class FileUtil:
             is "strict", meaning that encoding errors raise an exception. Change this to "ignore" to skip over invalid
             characters or "replace" to replace invalid characters with a ? character. For a full list of options, see
             https://docs.python.org/3/library/codecs.html#error-handlers
+        :param keep_default_na: If False, values that are recognized as NaN (e.g. N/A, NA, NaN) will remain as strings.
+            If True, these values will be converted to a NoneType value.
+        :param kwargs: Additional arguments to be passed to the pandas read_csv function.
         :return: A tuple of two DataFrames. The first is the frame for the CSV table body, while the second is for the
             metadata from above the header row, or None if there is no metadata.
         """
@@ -125,19 +142,21 @@ class FileUtil:
                 file_metadata = pandas.read_csv(file_io, header=None, dtype=dtype(str),
                                                 skiprows=lambda x: x >= header_row_index,
                                                 skip_blank_lines=False, sep=seperator, encoding=encoding,
-                                                encoding_errors=encoding_error)
+                                                encoding_errors=encoding_error, keep_default_na=keep_default_na,
+                                                **kwargs)
         with io.BytesIO(file_bytes) as file_io:
             # The use of the dtype argument is to ensure that everything from the file gets read as a string. Added
             # because some numerical values would get ".0" appended to them, even when casting the DataFrame cell to a
             # string.
             file_body: DataFrame = pandas.read_csv(file_io, header=header_row_index, dtype=dtype(str),
-                                                   skip_blank_lines=False, sep=seperator, encoding=encoding)
+                                                   skip_blank_lines=False, sep=seperator, encoding=encoding,
+                                                   keep_default_na=keep_default_na, **kwargs)
 
         return file_body, file_metadata
 
     @staticmethod
-    def xlsx_to_data_frames(file_bytes: bytes, header_row_index: int | None = 0) \
-            -> tuple[DataFrame, DataFrame | None]:
+    def xlsx_to_data_frames(file_bytes: bytes, header_row_index: int | None = 0, *, keep_default_na: bool = False,
+                            **kwargs) -> tuple[DataFrame, DataFrame | None]:
         """
         Parse the file bytes for an XLSX into DataFrames.
 
@@ -146,6 +165,9 @@ class FileUtil:
             row is returned in the metadata list. If input is None, then no row is considered to be the header row,
             meaning that required headers are also ignored if any are provided. By default, the first row (0th index)
             is assumed to be the header row.
+        :param keep_default_na: If False, values that are recognized as NaN (e.g. N/A, NA, NaN) will remain as strings.
+            If True, these values will be converted to a NoneType value.
+        :param kwargs: Additional arguments to be passed to the pandas read_excel function.
         :return: A tuple of two DataFrames. The first is the frame for the XLSX table body, while the second is for the
             metadata from above the header row, or None if there is no metadata.
         """
@@ -155,12 +177,14 @@ class FileUtil:
                 # The metadata DataFrame has no headers and only consists of the rows above the header row index.
                 # Therefore, we skip every row including and past the header.
                 file_metadata = pandas.read_excel(file_io, header=None, dtype=dtype(str),
-                                                  skiprows=lambda x: x >= header_row_index)
+                                                  skiprows=lambda x: x >= header_row_index,
+                                                  keep_default_na=keep_default_na, **kwargs)
         with io.BytesIO(file_bytes) as file_io:
             # The use of the dtype argument is to ensure that everything from the file gets read as a string. Added
             # because some numerical values would get ".0" appended to them, even when casting the DataFrame cell to a
             # string.
-            file_body: DataFrame = pandas.read_excel(file_io, header=header_row_index, dtype=dtype(str))
+            file_body: DataFrame = pandas.read_excel(file_io, header=header_row_index, dtype=dtype(str),
+                                                     keep_default_na=keep_default_na, **kwargs)
 
         return file_body, file_metadata
 
@@ -255,6 +279,7 @@ class FileUtil:
             data_frame = pandas.read_csv(csv, sep=",", header=None)
 
         with io.BytesIO() as output:
+            # noinspection PyTypeChecker
             with pandas.ExcelWriter(output, engine='xlsxwriter') as writer:
                 # Setting header and index to false makes the CSV convert to an XLSX as-is.
                 data_frame.to_excel(writer, sheet_name='Sheet1', header=False, index=False)

sapiopycommons-2025.2.11a427/src/sapiopycommons/samples/aliquot.py

@@ -0,0 +1,48 @@
+from sapiopycommons.general.aliases import SapioRecord
+from sapiopylib.rest.User import SapioUser
+from sapiopylib.rest.utils.MultiMap import SetMultimap
+
+# FR-47421 Added module
+
+def create_aliquot_for_samples(parent_sample_to_num_aliquots_map: dict[SapioRecord, int], user: SapioUser) -> SetMultimap[SapioRecord, int]:
+    """"
+    Ask server to create aliquot records for provided sample parent records.
+    :param parent_sample_to_num_aliquots_map: The dictionary containing (parent sample record) -> (number of aliquots to create) mapping.
+    :return: The dictionary containing (parent sample record) -> (list of new aliquot record ids) mapping.
+    """
+    # throw error if at least one record id is blank
+    has_negative_record_ids = any([record.record_id < 0 for record in parent_sample_to_num_aliquots_map.keys()])
+    if has_negative_record_ids:
+        raise ValueError("At least one record requested for aliquot has a negative record ID. "
+                         "You should have stored record model changes first.")
+    has_blank_record_ids = any([record.record_id is None for record in parent_sample_to_num_aliquots_map.keys()])
+    if has_blank_record_ids:
+        raise ValueError("At least one record requested for aliquot does not currently have a record ID.")
+    record_id_to_sapio_record_map = {record.record_id: record for record in parent_sample_to_num_aliquots_map.keys()}
+    parent_record_id_to_num_aliquots_map = {record.record_id: num_aliquots for record, num_aliquots in parent_sample_to_num_aliquots_map.items()}
+    aliquot_result: SetMultimap[int, int] = create_aliquot_for_samples_record_ids(parent_record_id_to_num_aliquots_map, user)
+    ret: SetMultimap[SapioRecord, int] = SetMultimap()
+    for parent_record_id in aliquot_result.keys():
+        parent_record = record_id_to_sapio_record_map[parent_record_id]
+        for aliquot_record_id in aliquot_result.get(parent_record_id):
+            ret.put(parent_record, aliquot_record_id)
+    return ret
+
+
+def create_aliquot_for_samples_record_ids(parent_record_id_to_num_aliquots_map: dict[int, int], user: SapioUser) -> SetMultimap[int, int]:
+    """
+    Ask the server to create aliquot records for the provided sample record IDs.
+    :param sample_record_id_list: The dictionary containing (parent sample record id) -> (number of aliquots to create) mapping.
+    :return: The dictionary containing (parent sample record id) -> (list of new aliquot record ids) mapping.
+    """
+    if not parent_record_id_to_num_aliquots_map:
+        return SetMultimap()
+    endpoint_path = 'sample/aliquot'
+    response = user.plugin_put(endpoint_path, payload=parent_record_id_to_num_aliquots_map)
+    user.raise_for_status(response)
+    response_map: dict[int, list[int]] = response.json()
+    ret: SetMultimap[int, int] = SetMultimap()
+    for parent_record_id, aliquot_record_ids in response_map.items():
+        for aliquot_record_id in aliquot_record_ids:
+            ret.put(int(parent_record_id), int(aliquot_record_id))
+    return ret

{sapiopycommons-2025.2.6a421 → sapiopycommons-2025.2.11a427}/src/sapiopycommons/webhook/webhook_handlers.py

@@ -73,7 +73,7 @@ class CommonsWebhookHandler(AbstractWebhookHandler):
     """A class for making requests to the accession webservice endpoints."""
     fnd_acc_man: FoundationAccessionManager
     """A class for making requests to the Foundations accession webservice endpoints."""
-    custom_report_man: CustomReportManager
+    report_man: CustomReportManager
     """A class for making requests to the custom report webservice endpoints."""
     dash_man: DashboardManager
     """A class for making requests to the dashboard management webservice endpoints."""
@@ -179,7 +179,7 @@ class CommonsWebhookHandler(AbstractWebhookHandler):
 
         # Initialize basic manager classes from sapiopylib.
         self.acc_man = DataMgmtServer.get_accession_manager(self.user)
-        self.custom_report_man = DataMgmtServer.get_custom_report_manager(self.user)
+        self.report_man = DataMgmtServer.get_custom_report_manager(self.user)
         self.dash_man = DataMgmtServer.get_dashboard_manager(self.user)
         self.xml_data_man = DataMgmtServer.get_data_manager(self.user)
         self.dr_man = context.data_record_manager

sapiopycommons-2025.2.11a427/tests/aliquot_test.py

@@ -0,0 +1,47 @@
+import unittest
+
+from sapiopylib.rest.DataMgmtService import DataMgmtServer
+from sapiopylib.rest.DataRecordManagerService import DataRecordManager
+from sapiopylib.rest.User import SapioUser
+from sapiopylib.rest.utils.recordmodel.RecordModelManager import RecordModelManager, RecordModelInstanceManager, \
+    RecordModelRelationshipManager
+from sapiopylib.rest.utils.recordmodel.properties import Children
+
+from sapiopycommons.samples.aliquot import create_aliquot_for_samples
+from sapiopycommons.general.accession_service import AccessionService
+from data_type_models import *
+
+# FR-47421 Added module
+
+user = SapioUser(url="https://linux-vm:8443/webservice/api", verify_ssl_cert=False,
+                 guid="66c2bea5-7cb2-4bfc-a413-304a3f4c3f33",
+                 username="yqiao_api", password="Password1!")
+data_record_manager: DataRecordManager = DataMgmtServer.get_data_record_manager(user)
+rec_man: RecordModelManager = RecordModelManager(user)
+inst_man: RecordModelInstanceManager = rec_man.instance_manager
+relationship_man: RecordModelRelationshipManager = rec_man.relationship_manager
+accession_service = AccessionService(user)
+
+class AliquotTest(unittest.TestCase):
+    def test_aliquot_samples(self):
+        parent_sample_1 = inst_man.add_new_record_of_type(SampleModel)
+        parent_sample_2 = inst_man.add_new_record_of_type(SampleModel)
+        id_list = accession_service.accession_with_config(SampleModel.DATA_TYPE_NAME, SampleModel.SAMPLEID__FIELD_NAME.field_name, 2)
+        parent_sample_1.set_SampleId_field(id_list[0])
+        parent_sample_2.set_SampleId_field(id_list[1])
+        aliquot_request = {parent_sample_1: 2, parent_sample_2: 3}
+        rec_man.store_and_commit()
+        aliquot_map = create_aliquot_for_samples(aliquot_request, user)
+        self.assertTrue(len(aliquot_map) == 2)
+        self.assertTrue(parent_sample_1 in aliquot_map and parent_sample_2 in aliquot_map)
+        self.assertTrue(len(aliquot_map.get(parent_sample_1)) == 2)
+        self.assertTrue(len(aliquot_map.get(parent_sample_2)) == 3)
+
+        relationship_man.load_children_of_type([parent_sample_1, parent_sample_2], SampleModel)
+        child_id_list_sample_1 = [child.get_SampleId_field() for child in parent_sample_1.get(Children.of_type(SampleModel))]
+        child_id_list_sample_2 = [child.get_SampleId_field() for child in parent_sample_2.get(Children.of_type(SampleModel))]
+        # Check the format of all ids of parent sample id "_" number is in the child list.
+        for i in range(2):
+            self.assertTrue(f"{parent_sample_1.get_SampleId_field()}_{i+1}" in child_id_list_sample_1)
+        for i in range(3):
+            self.assertTrue(f"{parent_sample_2.get_SampleId_field()}_{i+1}" in child_id_list_sample_2)