tol-sdk 1.8.4__py3-none-any.whl → 1.8.5__py3-none-any.whl

tol/api_client/view.py

@@ -197,7 +197,7 @@ class DefaultView(View):
             sub_tree = tree.get_sub_tree(rel)
             if sub_tree and rel in data_object._to_many_objects:
                 many_obj = data_object._to_many_objects.get(rel)
-                to_many[rel] = [self.__dump_stub(x, rel) for x in many_obj]
+                to_many[rel] = {'data': [self.__dump_stub(x, rel) for x in many_obj]}
                 for obj in many_obj:
                     included.add_dump(self.__dump_object(obj, included, sub_tree))
             elif quoted_id:

tol/flows/converters/time_string_to_time.py

@@ -0,0 +1,35 @@
+# SPDX-FileCopyrightText: 2025 Genome Research Ltd.
+#
+# SPDX-License-Identifier: MIT
+
+import re
+from datetime import time
+
+from tol.core import DataObject
+
+
+class Converter:
+    def convert(self, obj):
+        raise NotImplementedError()
+
+
+class TimeStringToTimeConverter(Converter):
+    """
+    Converts string fields representing time in HH:MM (24-hour) format to Python time objects.
+    If the string is not in HH:MM, tries to append ':00' and parse as HH:MM:SS.
+    """
+    def __init__(self, field: str):
+        self.field = field
+
+    def convert(self, obj: DataObject) -> DataObject:
+        value = obj.attributes.get(self.field)
+        if isinstance(value, str):
+            match = re.match(r'^(\d{1,2}):(\d{2})(?::(\d{2}))?$', value)
+            if match:
+                h, m = int(match.group(1)), int(match.group(2))
+                s = int(match.group(3)) if match.group(3) else 0
+                try:
+                    obj.attributes[self.field] = time(h, m, s)
+                except ValueError:
+                    pass
+        return obj

tol/validators/ena_checklist.py

@@ -12,6 +12,11 @@ from tol.sources.ena import ena
 
 
 class EnaChecklistValidator(Validator):
+    ENA_TO_INTERNAL_FIELD_MAP = {
+        'geographic location (longitude)': 'DECIMAL_LONGITUDE',
+        'geographic location (latitude)': 'DECIMAL_LATITUDE',
+    }
+
     """
     validates the ENA_CHECKLIST for each samples
     """
@@ -37,16 +42,18 @@ class EnaChecklistValidator(Validator):
             field_name = key
             if 'field' in validation:
                 field_name = validation['field']
+            internal_field = self.ENA_TO_INTERNAL_FIELD_MAP.get(field_name, field_name)
+
             if 'mandatory' in validation and key not in obj.attributes:
-                self.add_error(object_id=obj.id, detail='Must be given', field=[field_name])
+                self.add_error(object_id=obj.id, detail='Must be given', field=[internal_field])
                 continue
             if 'mandatory' in validation and obj.attributes[key] is None:
-                self.add_error(object_id=obj.id, detail='Must be given', field=[field_name])
+                self.add_error(object_id=obj.id, detail='Must be given', field=[internal_field])
                 continue
             if 'mandatory' in validation and obj.attributes.get(key) == '':
                 self.add_error(
                     object_id=obj.id,
-                    detail='Must not be empty', field=[field_name]
+                    detail='Must not be empty', field=[internal_field]
                 )
 
             if 'restricted text' in validation and key in obj.attributes:
@@ -55,12 +62,25 @@ class EnaChecklistValidator(Validator):
                         regex = condition
                 compiled_re = re.compile(regex)
                 if not compiled_re.search(obj.attributes.get(key)):
-                    self.add_error(
-                        object_id=obj.id,
-                        detail='Must match specific pattern', field=[field_name]
-                    )
+                    if internal_field in ('DECIMAL_LONGITUDE', 'DECIMAL_LATITUDE'):
+                        self.add_error(
+                            object_id=obj.id,
+                            detail=(
+                                f'Value for {internal_field} must be a valid decimal in the'
+                                f' format required by ENA (e.g. 12.3456). '
+                                f'See ENA checklist for accepted format.',
+                            ),
+                            field=[internal_field]
+                        )
+                    else:
+                        self.add_error(
+                            object_id=obj.id,
+                            detail=(
+                                f'Value for {internal_field} must match the required pattern.'
+                            ),
+                            field=[internal_field]
+                        )
 
-            # Check against allowed values
             if 'text choice' in validation and key in obj.attributes:
                 for condition in validation:
                     if isinstance(condition, list):
@@ -69,5 +89,5 @@ class EnaChecklistValidator(Validator):
                         [x.lower() for x in allowed_values]:
                     self.add_error(
                         object_id=obj.id,
-                        detail='Must be in allowed values', field=[field_name]
+                        detail='Must be in allowed values', field=[internal_field]
                     )

tol/validators/specimens_have_same_taxon.py

@@ -53,7 +53,7 @@ class SpecimensHaveSameTaxonValidator(Validator):
             if specimen_id in self.__seen and taxon_id != self.__seen[specimen_id]:
                 self.add_error(
                     object_id=obj.id,
-                    detail='A non-symbiont must have a matching Specimen ID and Taxon ID',
+                    detail='All samples from the same specimen_ID must have the same TAXON_ID.',
                     field=self.__config.specimen_id_field,
                 )
             if specimen_id not in self.__seen:

tol/validators/types.py

@@ -55,12 +55,19 @@ class TypesValidator(Validator):
                     continue
                 type_class = type_map.get(expected_type)
                 if type_class and not isinstance(actual_value, type_class):
-                    self.__add_result(
-                        obj,
-                        key,
-                        detail=f'Field {key} value "{actual_value}" is not of type '
-                               f'"{expected_type}"',
-                    )
+                    if expected_type == 'time':
+                        self.__add_result(
+                            obj,
+                            key,
+                            detail='Only HH:MM format is accepted.',
+                        )
+                    else:
+                        self.__add_result(
+                            obj,
+                            key,
+                            detail=f'Field {key} value "{actual_value}" is not of type '
+                                   f'"{expected_type}"',
+                        )
                 if type_class and isinstance(actual_value, type_class):
                     # Special case for bool since isinstance(True, int) is True
                     if expected_type == 'int' and isinstance(actual_value, bool):

tol/validators/value_check.py

@@ -26,11 +26,12 @@ class ValueCheckValidator(Validator):
         self.__config = config
 
     def _validate_data_object(self, obj: DataObject) -> None:
-        # This function is used to check if the data object is SYMBIONT or not
-
-        if obj.attributes.get(self.__config.field) == self.__config.value:
+        if obj.attributes.get(self.__config.field) != self.__config.value:
             self.add_error(
                 object_id=obj.id,
-                detail=f'{self.__config.value} is detected',
+                detail=(
+                    f"Expected '{self.__config.value}' for field "
+                    f"'{self.__config.field}', but got '{obj.attributes.get(self.__config.field)}'"
+                ),
                 field=self.__config.field,
             )

{tol_sdk-1.8.4.dist-info → tol_sdk-1.8.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tol-sdk
-Version: 1.8.4
+Version: 1.8.5
 Summary: SDK for interaction with ToL, Sanger and external services
 Author-email: ToL Platforms Team <tol-platforms@sanger.ac.uk>
 License: MIT

{tol_sdk-1.8.4.dist-info → tol_sdk-1.8.5.dist-info}/RECORD

@@ -39,7 +39,7 @@ tol/api_client/factory.py,sha256=WGHA5wio4XS8OHqG07DLSVjehOeAsVoVCc5phAIq4H8,373
 tol/api_client/filter.py,sha256=D49RIai5Yj4CiQvIkgaEIXdw_oSU7CD5cn9SdXWRYXU,1474
 tol/api_client/parser.py,sha256=88Q2RlPwn9JJsSIukC2_yxfaM2AaXjsGuDOESqY7se4,8351
 tol/api_client/validate.py,sha256=9wFZotTJ4fI21BdO5AuMZok0rDQ4s8zM_WojLdVvA0A,3071
-tol/api_client/view.py,sha256=DvhRTA957Fn5vVPByV7e8ngvJaD9DSa5SaJ48ONWQlU,8753
+tol/api_client/view.py,sha256=LGojaC0vCPkjemV8A83b3T_uDVQ002nQYgAZN7JapIU,8763
 tol/barcodes/__init__.py,sha256=k9KoBO0xJyxg1kanLrN0E3HuVSbbpfSInGEsWX-8UsY,214
 tol/barcodes/main.py,sha256=QxueF2AdrclIaQuu7W4lb4eF5tU_l-p3UMsDFIYgCfo,6213
 tol/benchling/__init__.py,sha256=9VIL6PBxvZRaBrN1j2Di75MdEY261kEHs_D-lUutIlg,229
@@ -198,6 +198,7 @@ tol/flows/converters/sts_sample_project_to_elastic_sample_converter.py,sha256=YE
 tol/flows/converters/sts_sample_to_casm_benchling_converter.py,sha256=Zo577u2v5_Fela2uQVtZsGZmHq4bLecTCC4Ewvq61Xo,39414
 tol/flows/converters/sts_sampleset_to_elastic_sampleset_converter.py,sha256=PUP0Qjy9wTmqp5GHNEd9fukqtWdoMvDfs4rJisfLzcc,3197
 tol/flows/converters/sts_species_to_elastic_species_converter.py,sha256=ELZ_ML8vPlLkfXrx0B_wxUWiPyxkI8UXgSPQZCKknXU,1164
+tol/flows/converters/time_string_to_time.py,sha256=myo9K9pRMT6GtT5vXf3c0UDK5n8bMVbvW7ewhSPkecU,1062
 tol/flows/converters/tolid_specimen_to_elastic_tolid_converter.py,sha256=4Ird6ATYjsjSFZ1AGsxpuWdQ6QtQTvKJ-rF-_TCC_rg,1072
 tol/flows/converters/tolqc_data_to_elastic_run_data_converter.py,sha256=f9PYnsswikskvXpnSlrfYN7wXfyn8iXQpg996ZsQHbw,3799
 tol/flows/converters/tolqc_sample_to_elastic_sequencing_request_converter.py,sha256=MzPcO75Z_3-6nsWC8X0kmmmxJTurV_HOZhseC-tWdFo,1397
@@ -331,25 +332,25 @@ tol/validators/assert_on_condition.py,sha256=eBGgSVfIQ6e45SheM-ZDg7daXJjyZxRVS5L
 tol/validators/branching.py,sha256=7YFjHNjrrTmy4hZ3E7JKDT6MEsBMhrc3P3p3ykv4wKI,5720
 tol/validators/converter_and_validate.py,sha256=O1uYdrU4YDZ8eZjb7Koots4-8fMVOkJFXESg-LVw2o8,2992
 tol/validators/date_sorting.py,sha256=NzYsBfhgeG4NYlYjVUYgcGGwEHns5hESqeaPvXUxjUI,1918
-tol/validators/ena_checklist.py,sha256=M10VAFGpaxnm7rWO4jmFhTWkYRlCmU0Ox2IUEDFGKbo,2812
+tol/validators/ena_checklist.py,sha256=2IfgzdgpumTPPwzoycIpfFFnkTSRlEjpZ8RQYQpBoXY,3771
 tol/validators/ena_submittable.py,sha256=CujF9t4mA4N3Wm_5rA5MRp401aW19kbioOZpfWVXg6I,1965
 tol/validators/min_one_valid_value.py,sha256=gZUHtfRA-Lvpw0d1FJoAA31cRJpLbbxAJCC9DCt5lCY,1442
 tol/validators/mutually_exclusive.py,sha256=6blZK-2IY4Eq79fHKKrm-pxsQ6B5DNH5ldtxOFVCPhU,4492
 tol/validators/regex.py,sha256=dLAi_vQt9_DsT6wQZmbYC7X5-Wp15l0leUE6XkPaItg,2602
 tol/validators/regex_by_value.py,sha256=XM5EnT4vgD17rfpR3bUE9I56IemSw26BI9MZtMakd4E,2582
-tol/validators/specimens_have_same_taxon.py,sha256=m2LLRIZMdhPj1fzyioDJOraI6UHXgy1l963xhezgk7E,2177
+tol/validators/specimens_have_same_taxon.py,sha256=BaJcZ38ZprPcuGTIorSxxC9uGN0_lj6HS6B54EObcuY,2183
 tol/validators/sts_fields.py,sha256=aYbzy15btEg4-ocDT1qrspe7-atoWRrOJ_KmuPU6J14,8936
 tol/validators/tolid.py,sha256=yODebLYbKtlem3IpVcv8XImvq90r-AK68asH9JEawqo,3897
-tol/validators/types.py,sha256=KDBNqx5isJG5XI1l2V9Wmi9135ZwDace3MU6Qij3J6E,2612
+tol/validators/types.py,sha256=jMVpckRp8RS93f7usf58YH_K-5rKWgZIYs7bO9dHhQc,2914
 tol/validators/unique_value_check.py,sha256=sFvDooYkKeORvULGEOTsgIcxlbe0AXDWxY3Gbr3j0KI,1282
 tol/validators/unique_values.py,sha256=o5IrfUNLEmlEp8kpInTtFnTq-FqiHSC9TItKdf-LI1o,3114
 tol/validators/unique_whole_organisms.py,sha256=RdqA1GzIf3LTdrmNGGdxv0aW2udDY2P9EaqZb40hhik,5735
-tol/validators/value_check.py,sha256=lxfhfL8BCIs_B838CQ5znJ6KFD7ms_fSVCS9QuVearE,1052
+tol/validators/value_check.py,sha256=DdNx_B1gns01zgBg5N6Bwia46Aukw6MAteM-M37Kv1k,1122
 tol/validators/interfaces/__init__.py,sha256=jtOxnwnwqV_29xjmmMcS_kvlt-pQiWwQYJn2YRP07_w,172
 tol/validators/interfaces/condition_evaluator.py,sha256=nj8Cb8hi47OBy6OVNfeLhF-Pjwtr8MiOSymYL6hfVes,3766
-tol_sdk-1.8.4.dist-info/licenses/LICENSE,sha256=RF9Jacy-9BpUAQQ20INhTgtaNBkmdTolYCHtrrkM2-8,1077
-tol_sdk-1.8.4.dist-info/METADATA,sha256=g4uV0VKLkExU3Zc1waAU3ukQbtb6wRhzkaZgX-BoT5Y,3142
-tol_sdk-1.8.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-tol_sdk-1.8.4.dist-info/entry_points.txt,sha256=jH3HfTwxjzog7E3lq8CKpUWGIRY9FSXbyL6CpUmv6D0,36
-tol_sdk-1.8.4.dist-info/top_level.txt,sha256=PwKMQLphyZNvagBoriVbl8uwHXQl8IC1niawVG0iXMM,10
-tol_sdk-1.8.4.dist-info/RECORD,,
+tol_sdk-1.8.5.dist-info/licenses/LICENSE,sha256=RF9Jacy-9BpUAQQ20INhTgtaNBkmdTolYCHtrrkM2-8,1077
+tol_sdk-1.8.5.dist-info/METADATA,sha256=Fgyn-UcaEg4JQ7Bge0_hGHUB3gMk3g6hIbBLO3o35PQ,3142
+tol_sdk-1.8.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+tol_sdk-1.8.5.dist-info/entry_points.txt,sha256=jH3HfTwxjzog7E3lq8CKpUWGIRY9FSXbyL6CpUmv6D0,36
+tol_sdk-1.8.5.dist-info/top_level.txt,sha256=PwKMQLphyZNvagBoriVbl8uwHXQl8IC1niawVG0iXMM,10
+tol_sdk-1.8.5.dist-info/RECORD,,