tol-sdk 1.8.5__tar.gz → 1.8.7__tar.gz

{tol_sdk-1.8.5/src/tol_sdk.egg-info → tol_sdk-1.8.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tol-sdk
-Version: 1.8.5
+Version: 1.8.7
 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.5 → tol_sdk-1.8.7}/pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tol-sdk"
-version = "1.8.5"
+version = "1.8.7"
 description = "SDK for interaction with ToL, Sanger and external services"
 readme = "README.md"
 authors = [

{tol_sdk-1.8.5 → tol_sdk-1.8.7}/src/tol/api_base/system.py

@@ -2,6 +2,8 @@
 #
 # SPDX-License-Identifier: MIT
 
+import glob
+
 from flask import Blueprint
 
 
@@ -16,6 +18,7 @@ def system_blueprint(
     By default includes:
     - /healthz      - used for health probes in kubernetes
     - /environment  - indicates the deployment environment
+    - /package-versions  - indicates the deployment package versions
 
     Parameters:
     - url_prefix    - the prefix under which to serve this blueprint's
@@ -40,4 +43,19 @@ def system_blueprint(
             k: env_vars.get(v) for k, v in env_map.items()
         }, 200
 
+    @system_blueprint.route('/package-versions')
+    def package_versions():
+        glob_paths = glob.glob('./**/requirements.txt', recursive=True)
+        with open(glob_paths[0], 'r') as f:
+            requirements = f.readlines()
+            for requirement in requirements:
+                if 'tol-sdk' in requirement:
+                    tol_sdk_version = requirement.split('==')[1].strip()
+                    break
+            f.close()
+
+        result = {'tol_sdk': tol_sdk_version}
+
+        return result, 200
+
     return system_blueprint

{tol_sdk-1.8.5 → tol_sdk-1.8.7}/src/tol/api_client/api_datasource.py

@@ -35,6 +35,7 @@ from ..core.operator import (
     Upserter,
 )
 from ..core.relationship import RelationshipConfig
+from ..core.requested_fields import ReqFieldsTree, requested_fields_to_tree
 
 if typing.TYPE_CHECKING:
     from ..core.session import OperableSession
@@ -133,31 +134,34 @@ class ApiDataSource(
             for k, v in transfer.items()
         }
 
+    @requested_fields_to_tree
     @validate('detailGet')
     def get_by_id(
         self,
         object_type: str,
         object_ids: Iterable[str],
         session: Optional[OperableSession] = None,
-        requested_fields: list[str] | None = None,
+        requested_tree: ReqFieldsTree | None = None,
     ) -> Iterable[Optional[DataObject]]:
 
         client = self.__client_factory()
+
         json_responses = (
             client.get_detail(
                 object_type,
                 id_,
-                requested_fields=requested_fields,
+                requested_tree=requested_tree,
             )
             for id_ in object_ids
         )
-        json_converter = self.__jc_factory(object_type, requested_fields)
+        json_converter = self.__jc_factory(object_type, requested_tree)
         return (
             json_converter.convert(r)
             if r is not None else None
             for r in json_responses
         )
 
+    @requested_fields_to_tree
     @validate('listGet')
     def get_list_page(
         self,
@@ -167,7 +171,7 @@ class ApiDataSource(
         object_filters: Optional[DataSourceFilter] = None,
         sort_by: Optional[str] = None,
         session: Optional[OperableSession] = None,
-        requested_fields: list[str] | None = None,
+        requested_tree: ReqFieldsTree | None = None,
     ) -> tuple[Iterable[DataObject], int]:
 
         filter_string = self.__get_filter_string(object_filters)
@@ -177,28 +181,30 @@ class ApiDataSource(
             page_size,
             filter_string=filter_string,
             sort_string=sort_by,
-            requested_fields=requested_fields,
+            requested_tree=requested_tree,
         )
-        return self.__jc_factory(object_type, requested_fields).convert_list(transfer)
 
+        return self.__jc_factory(object_type, requested_tree).convert_list(transfer)
+
+    @requested_fields_to_tree
     def get_list(
         self,
         object_type: str,
         object_filters: Optional[DataSourceFilter] = None,
         session: Optional[OperableSession] = None,
-        requested_fields: list[str] | None = None,
+        requested_tree: ReqFieldsTree | None = None,
     ) -> Iterable[DataObject]:
         if self.__can_cursor(object_type, object_filters):
             return self._get_list_by_cursor(
                 object_type,
                 object_filters,
-                requested_fields=requested_fields,
+                requested_tree=requested_tree,
             )
         else:
             return self.__get_list_regular(
                 object_type,
                 object_filters,
-                requested_fields=requested_fields,
+                requested_tree=requested_tree,
             )
 
     @validate('count')
@@ -263,7 +269,7 @@ class ApiDataSource(
         object_filters: Optional[DataSourceFilter] = None,
         search_after: list[str] | None = None,
         session: Optional[OperableSession] = None,
-        requested_fields: list[str] | None = None
+        requested_tree: ReqFieldsTree | None = None,
     ) -> tuple[Iterable[DataObject], list[str] | None]:
 
         filter_string = self.__get_filter_string(object_filters)
@@ -272,9 +278,10 @@ class ApiDataSource(
             page_size,
             search_after,
             filter_string=filter_string,
-            requested_fields=requested_fields,
+            requested_tree=requested_tree,
         )
-        return self.__jc_factory(object_type, requested_fields).convert_cursor_page(transfer)
+
+        return self.__jc_factory(object_type, requested_tree).convert_cursor_page(transfer)
 
     @validate('delete')
     def delete(
@@ -436,13 +443,14 @@ class ApiDataSource(
         self,
         object_type: str,
         object_filters: Optional[DataSourceFilter],
-        requested_fields: list[str] | None = None,
+        requested_tree: ReqFieldsTree | None = None,
     ) -> Iterable[DataObject]:
 
         page = 1
         page_size = self.get_page_size()
         client = self.__client_factory()
-        jc_converter = self.__jc_factory(object_type, requested_fields)
+
+        jc_converter = self.__jc_factory(object_type, requested_tree)
         filter_string = self.__get_filter_string(object_filters)
 
         while True:
@@ -451,7 +459,7 @@ class ApiDataSource(
                 page,
                 page_size,
                 filter_string=filter_string,
-                requested_fields=requested_fields,
+                requested_tree=requested_tree,
             )
             (results_page, _) = jc_converter.convert_list(transfer)
 

{tol_sdk-1.8.5 → tol_sdk-1.8.7}/src/tol/api_client/client.py

@@ -11,6 +11,7 @@ from .converter import JsonApiTransfer, JsonRelationshipConfig
 from ..core import HttpClient
 from ..core.datasource_error import DataSourceError
 from ..core.operator import OperatorDict
+from ..core.requested_fields import ReqFieldsTree
 
 
 class JsonApiClient(HttpClient):
@@ -43,7 +44,7 @@ class JsonApiClient(HttpClient):
         self,
         object_type: str,
         object_id: str,
-        requested_fields: list[str] | None = None,
+        requested_tree: ReqFieldsTree | None = None,
     ) -> Optional[JsonApiTransfer]:
         """
         Gets a single JSON:API transfer for the object of specified
@@ -53,11 +54,13 @@ class JsonApiClient(HttpClient):
         url = self.__detail_url(object_type, object_id)
         headers = self._merge_headers()
 
+        params = {}
+        if requested_tree:
+            params['requested_fields'] = requested_tree.to_paths()
+
         return self.__fetch_detail(
             url,
-            params={
-                'requested_fields': requested_fields,
-            },
+            params=params,
             headers=headers,
         )
 
@@ -68,7 +71,7 @@ class JsonApiClient(HttpClient):
         page_size: int,
         filter_string: Optional[str] = None,
         sort_string: Optional[str] = None,
-        requested_fields: list[str] | None = None,
+        requested_tree: ReqFieldsTree | None = None,
     ) -> JsonApiTransfer:
         """
         Gets a (paged) list-JSON:API transfer for the objects of specified
@@ -81,7 +84,7 @@ class JsonApiClient(HttpClient):
             page_size=page_size,
             filter=filter_string,
             sort_by=sort_string,
-            requested_fields=requested_fields
+            requested_fields=requested_tree.to_paths() if requested_tree else None,
         )
         headers = self._merge_headers()
         return self.__fetch_list(
@@ -157,7 +160,7 @@ class JsonApiClient(HttpClient):
         page_size: int,
         search_after: list[str] | None,
         filter_string: Optional[str] = None,
-        requested_fields: list[str] | None = None,
+        requested_tree: ReqFieldsTree | None = None,
     ) -> JsonApiTransfer:
         """Cursor-pagination."""
 
@@ -165,7 +168,7 @@ class JsonApiClient(HttpClient):
         params = self.__no_none_value_dict(
             filter=filter_string,
             page_size=page_size,
-            requested_fields=requested_fields,
+            requested_fields=requested_tree.to_paths() if requested_tree else None,
         )
         headers = self._merge_headers()
         body = {'search_after': search_after}
@@ -462,5 +465,7 @@ class JsonApiClient(HttpClient):
         for k, v in kwargs.items():
             if v is None:
                 continue
+            if isinstance(v, list) and not v:
+                continue
             str_params[k] = ','.join([str(x) for x in v]) if isinstance(v, list) else str(v)
         return str_params

{tol_sdk-1.8.5 → tol_sdk-1.8.7}/src/tol/api_client/factory.py

@@ -59,23 +59,20 @@ class _ConverterFactory:
     def json_converter_factory(
         self,
         object_type: str | None = None,
-        requested_fields: list[str] | None = None,
+        requested_tree: ReqFieldsTree | None = None,
     ) -> JsonConverterFactory:
         """
         Returns an instantiated `JsonApiConverter`.
         """
 
-        req_fields_tree = (
-            ReqFieldsTree(
-                object_type,
-                self.__data_source,
-                requested_fields=requested_fields,
-            )
-            if object_type
-            else None
-        )
-
-        parser = DefaultParser(self.__ds_dict, req_fields_tree)
+        # If we're going to parse a JSON:API data object (i.e. we have been
+        # passed an `object_type`), we need to add a ReqFieldsTree so that
+        # DataSources with default loading of to-one objects correctly
+        # process the to-ones from the `included` array.
+        if object_type and not requested_tree:
+            requested_tree = ReqFieldsTree(object_type, self.__data_source)
+
+        parser = DefaultParser(self.__ds_dict, requested_tree)
         return JsonApiConverter(parser)
 
     @property

{tol_sdk-1.8.5 → tol_sdk-1.8.7}/src/tol/benchling/benchling_warehouse_datasource.py

@@ -45,6 +45,7 @@ class BenchlingWarehouseDataSource(DataSource, ListGetter):
             'sample': 'sts_id',
             'sequencing_request': 'sanger_sample_id',
             'extraction': 'extraction_id',
+            'extraction_container': 'fluidx_container_id',
             'tissue_prep': 'eln_tissue_prep_id'
         }
 
@@ -70,7 +71,7 @@ class BenchlingWarehouseDataSource(DataSource, ListGetter):
             yield self.data_object_factory(
                 object_type,
                 id_=obj[id_col],
-                attributes=obj
+                attributes={k: v for k, v in obj.items() if k != id_col}
             )
 
     def get_list(
@@ -82,7 +83,9 @@ class BenchlingWarehouseDataSource(DataSource, ListGetter):
         file_suffix = ''
         if object_filters is not None:
             if isinstance(object_filters.and_, dict):
-                for field_name in ['sequencing_platform', 'extraction_type']:
+                for field_name in [
+                    'sequencing_platform', 'extraction_type', 'extraction.extraction_type'
+                ]:
                     if field_name in object_filters.and_:
                         # For an in_list, treat as multiple eq
                         if 'in_list' in object_filters.and_[field_name]:
@@ -101,7 +104,7 @@ class BenchlingWarehouseDataSource(DataSource, ListGetter):
                                 ) for val in object_filters.and_[field_name]['in_list']['value']
                             )
                         elif 'eq' in object_filters.and_[field_name]:
-                            file_suffix = '_' + field_name + '_' \
+                            file_suffix = '_' + field_name.replace('.', '_') + '_' \
                                           + object_filters.and_[field_name]['eq']['value']
             else:
                 raise DataSourceError('Filtering only on sequencing platform and extraction '

tol_sdk-1.8.5/src/tol/benchling/sql/extraction_containers_dna.sql → tol_sdk-1.8.7/src/tol/benchling/sql/extraction_container_extraction_extraction_type_dna.sql

@@ -9,28 +9,29 @@ Output: Table with columns:
 
 1) taxon_id: [character] Tissue metadata. Origin: STS
 2) eln_tissue_id: [character] Benchling ID for the tissue the extraction is derived from.
-3) eln_tissue_prep_id: [character] Benchling ID for the tissue prep the extraction is derived from.
-4) extraction_id: [character] DNA extraction entity ID (Benchling).
-5) programme_id: [character] ToLID. Origin: BWH.
-6) specimen_id: [character] Specimen ID. Origin: STS.
-7) creation_date: [date] Date the container was created.
-8) fluidx_container_id: [character] Primary key for the FluidX container.
-9) fluidx_id: [character] FluidX barcode.
-10) tube_type: [character] Type of tube/container.
-11) volume_ul: [numeric] Volume in microliters (0 if archived as 'Retired' or 'Expended').
-12) location: [character] Storage location name.
-13) rack: [character] Box/rack barcode.
-14) archive_purpose: [character] Reason for archiving the DNA extraction.
-15) nanodrop_concentration_ngul: [numeric] Latest Nanodrop concentration (ng/µL).
-16) dna_260_280_ratio: [numeric] Latest Nanodrop 260/280 ratio.
-17) dna_260_230_ratio: [numeric] Latest Nanodrop 260/230 ratio.
-18) qubit_concentration_ngul: [numeric] Latest Qubit concentration (ng/µL).
-19) yield_ng: [numeric] Latest yield (ng).
-20) femto_date_code: [character] Latest Femto date code.
-21) femto_description: [character] Latest Femto profile description.
-22) gqn_index: [numeric] Latest GQN index from Femto.
-23) next_step: [character] Latest decision making next step.
-24) extraction_qc_result: [character] Latest extraction QC result.
+3) tissue_sts_id: [character] STS ID for the tissue the extraction is derived from.
+4) eln_tissue_prep_id: [character] Benchling ID for the tissue prep the extraction is derived from.
+5) extraction_id: [character] DNA extraction entity ID (Benchling).
+6) programme_id: [character] ToLID. Origin: BWH.
+7) specimen_id: [character] Specimen ID. Origin: STS.
+8) creation_date: [date] Date the container was created.
+9) fluidx_container_id: [character] Primary key for the FluidX container.
+10) fluidx_id: [character] FluidX barcode.
+11) tube_type: [character] Type of tube/container.
+12) volume_ul: [numeric] Volume in microliters (0 if archived as 'Retired' or 'Expended').
+13) location: [character] Storage location name.
+14) rack: [character] Box/rack barcode.
+15) archive_purpose: [character] Reason for archiving the DNA extraction.
+16) nanodrop_concentration_ngul: [numeric] Latest Nanodrop concentration (ng/µL).
+17) dna_260_280_ratio: [numeric] Latest Nanodrop 260/280 ratio.
+18) dna_260_230_ratio: [numeric] Latest Nanodrop 260/230 ratio.
+19) qubit_concentration_ngul: [numeric] Latest Qubit concentration (ng/µL).
+20) yield_ng: [numeric] Latest yield (ng).
+21) femto_date_code: [character] Latest Femto date code.
+22) femto_description: [character] Latest Femto profile description.
+23) gqn_index: [numeric] Latest GQN index from Femto.
+24) next_step: [character] Latest decision making next step.
+25) extraction_qc_result: [character] Latest extraction QC result.
 
 NOTES:
 1) Only extractions from the 'ToL Core Lab' project and relevant folders are included.
@@ -109,6 +110,7 @@ latest_decision_making AS (
 SELECT DISTINCT
     t.taxon_id,
     t.id AS eln_tissue_id,
+    t.sts_id AS tissue_sts_id,
     tp.id AS eln_tissue_prep_id,
     dna.id AS extraction_id,
     t.programme_id,
@@ -170,4 +172,4 @@ LEFT JOIN entry$raw AS ent
 WHERE proj.name = 'ToL Core Lab'
     AND  (f.name IN ('Routine Throughput', 'DNA', 'Core Lab Entities', 'Benchling MS Project Move') OR f.name IS NULL)
     AND (con.archive_purpose$ != ('Made in error') OR con.archive_purpose$ IS NULL)
-    AND ent.name NOT LIKE '%Nuclei isolation and tagmentation%'
+    AND COALESCE(ent.name, '') NOT LIKE '%Nuclei isolation and tagmentation%'

{tol_sdk-1.8.5 → tol_sdk-1.8.7}/src/tol/benchling/sql/sequencing_request_sequencing_platform_pacbio.sql

@@ -24,7 +24,7 @@ Output: Table with cols:
 4) eln_file_registry_id: [character] id in Benchling Registry. Origin: BWH
 5) extraction_id: [character] Original DNA extract entity name. For pooled samples, the first DNA extract pooled. Origin: BWH
 6) submission_sample_name: [character] Entity name. Origin: BWH
-7) fluidx_id: [character] Container barcode of the DNA fluidx tube. Origin: BWH
+7) fluidx_container_id: [character] Container id of the DNA fluidx tube. Origin: BWH
 8) programme_id: [character] ToLID. Origin: BWH
 9) specimen_id: [character] Specimen ID. Origin: STS
 10) tube_name: [character] Name of the submission tube/container.
@@ -73,7 +73,7 @@ pacbio_submissions_container_routine AS (
 		subsam.file_registry_id$ AS eln_file_registry_id,
 		subsam.original_dna_extract AS extraction_id,
 		subsam.name$ AS submission_sample_name,
-		c_dna.barcode AS fluidx_id,
+		c_dna.id AS fluidx_container_id,
 		t.programme_id, 
 		t.specimen_id, 
 		con.name AS tube_name,
@@ -145,7 +145,7 @@ pacbio_submissions_container_pooled AS (
 		subsam.file_registry_id$ AS eln_file_registry_id,
 		subsam.pooled_sample  AS extraction_id,
 		subsam.name$ AS eln_submission_sample_name,
-		c_pool.barcode AS fluidx_id,
+		c_pool.id AS fluidx_container_id,
 		t.programme_id, 
 		t.specimen_id,
 		con.name AS tube_name,
@@ -219,7 +219,7 @@ pacbio_submissions_container_legacy_deprecated AS (
 		subsam.file_registry_id$ AS eln_file_registry_id,
 		subsam.original_dna_extract AS extraction_id,
 		subsam.name$ AS submission_sample_name,
-		c_dna.barcode AS fluidx_id,
+		c_dna.id AS fluidx_container_id,
 		t.programme_id,
 		t.specimen_id,
 		con.name AS tube_name,
@@ -283,7 +283,7 @@ pacbio_submissions_plate_automated_manifest AS (
 		subsam.file_registry_id$ AS eln_file_registry_id,
 		subsam.originaL_dna_extract AS extraction_id,
 		subsam.name$ AS submission_sample_name,
-		c_dna.barcode AS fluidx_id,
+		c_dna.id AS fluidx_container_id,
 		t.programme_id,
 		t.specimen_id,
 		con.name AS tube_name,
@@ -350,7 +350,7 @@ pacbio_submissions_plate_automated_manifest_pooled AS (
 		subsam.file_registry_id$ AS eln_file_registry_id,
 		subsam.pooled_sample AS extraction_id,
 		subsam.name$ AS submission_sample_name,
-		c_pool.barcode AS fluidx_id,
+		c_pool.id AS fluidx_container_id,
 		t.programme_id,
 		t.specimen_id,
 		con.name AS tube_name,
@@ -415,7 +415,7 @@ pacbio_submissions_plate_routine AS (
 		subsam.file_registry_id$ AS eln_file_registry_id,
 		subsam.original_dna_extract AS extraction_id,
 		subsam.name$ AS submission_sample_name,
-		c_dna.barcode AS fluidx_id,
+		c_dna.id AS fluidx_container_id,
 		t.programme_id,
 		t.specimen_id,
 		c_subsam.name AS tube_name,
@@ -485,7 +485,7 @@ pacbio_submissions_plate_routine_pooled AS (
 		subsam.file_registry_id$ AS eln_file_registry_id,
 		subsam.pooled_sample AS extraction_id,
 		subsam.name$ AS submission_sample_name,
-		c_pool.barcode AS fluidx_id,
+		c_pool.id AS fluidx_container_id,
 		t.programme_id,
 		t.specimen_id,
 		c_subsam.name AS tube_name,

{tol_sdk-1.8.5 → tol_sdk-1.8.7}/src/tol/core/factory.py

@@ -189,7 +189,7 @@ def core_data_object(
                 if object_from_datasource is not None:
                     self.__type = object_from_datasource.type
                     self.__attributes = object_from_datasource.attributes
-                    self.__to_one_objects = object_from_datasource.to_one_objects
+                    self.__to_one_objects = object_from_datasource._to_one_objects
                     break
 
         @property

{tol_sdk-1.8.5 → tol_sdk-1.8.7}/src/tol/core/requested_fields.py

@@ -11,6 +11,27 @@ from .operator import Relational
 from .relationship import RelationshipConfig
 
 
+def requested_fields_to_tree(func):
+    """
+    Allows `requested_fields` keyword arguments to be supplied to methods if a
+    `requested_tree` object has not been given.
+    """
+
+    def wrapper(self, tablename, *args, **kwargs):
+        if 'requested_fields' in kwargs:
+            if 'requested_tree' in kwargs:
+                msg = 'Both requested_fields and requested_tree arguments given'
+                raise TypeError(msg)
+            flds = kwargs.pop('requested_fields')
+            if flds and tablename:
+                kwargs['requested_tree'] = ReqFieldsTree(
+                    tablename, self, requested_fields=flds
+                )
+        return func(self, tablename, *args, **kwargs)
+
+    return wrapper
+
+
 class ReqFieldsTree:
     """
     Acts as a template for which related objects and attributes to fetch from

tol_sdk-1.8.7/src/tol/dummy/__init__.py

@@ -0,0 +1,6 @@
+# SPDX-FileCopyrightText: 2026 Genome Research Ltd.
+#
+# SPDX-License-Identifier: MIT
+
+from .dummy_datasource import DummyDataSource  # noqa
+from .factory import create_dummy_datasource  # noqa

tol_sdk-1.8.7/src/tol/dummy/client.py

@@ -0,0 +1,88 @@
+# SPDX-FileCopyrightText: 2024 Genome Research Ltd.
+#
+# SPDX-License-Identifier: MIT
+
+import string
+from typing import Iterable, Optional
+
+from .converter import DummyTransfer
+from ..core import HttpClient
+
+
+class DummyClient(HttpClient):
+    """
+    Simulates dummy objects retrieval from a remote API.
+    """
+
+    def __init__(
+        self,
+    ) -> None:
+        super().__init__()
+
+    def get_detail(
+        self,
+        object_type: str,
+        object_ids: Iterable[str]
+    ) -> Optional[DummyTransfer]:
+        """
+        Gets a list of Dummy transfers for the objects of specified
+        `object_type` and `object_id`, or returns None if not found.
+        """
+        return self.__get_detail_data(object_type, object_ids)
+
+    def get_list(
+        self,
+        object_type: str
+    ) -> Optional[DummyTransfer]:
+        return self.__get_detail_data(object_type, range(10000))
+
+    def __get_detail_data(
+        self,
+        object_type: str,
+        object_ids: Iterable[str]
+    ) -> Optional[DummyTransfer]:
+        if object_type == 'category':
+            return self.__get_detail_category(object_type, object_ids)
+        return self.__get_detail_record(object_type, object_ids)
+
+    def __get_detail_record(
+        self,
+        object_type: str,
+        object_ids: Iterable[str]
+    ) -> Optional[DummyTransfer]:
+        """
+        Gets a list of dummy objects
+        """
+        ret = []
+        for object_id in object_ids:
+            if object_id < 10000:
+                ret.append({
+                    'id': object_id,
+                    'little_string': ['a', 'b', 'c'][int(object_id) % 3],
+                    'big_string': string.ascii_letters[int(object_id) % 52],
+                    'int': object_id,
+                    'bool': int(object_id) % 2 == 0,
+                    'date': f'2024-01-{(int(object_id) % 28) + 1:02d}',
+                    'type': object_type,
+                    'category': ['cat1', 'cat2', 'cat3', 'cat4'][int(object_id) % 4],
+                })
+            else:
+                ret.append(None)
+        return ret
+
+    def __get_detail_category(
+        self,
+        object_type: str,
+        object_ids: Iterable[str]
+    ) -> Optional[DummyTransfer]:
+        """
+        Gets a list of dummy objects
+        """
+        ret = []
+        for object_id in object_ids:
+            ret.append({
+                'id': object_id,
+                'name': object_id.upper(),
+                'type': object_type
+            })
+        return ret

tol_sdk-1.8.7/src/tol/dummy/converter.py

@@ -0,0 +1,48 @@
+# SPDX-FileCopyrightText: 2024 Genome Research Ltd.
+#
+# SPDX-License-Identifier: MIT
+
+from typing import Any, List, Optional
+
+from .parser import Parser
+from ..core import DataObject
+
+
+DummyObject = dict[str, Any]
+DummyTransfer = List[DummyObject]
+
+
+class DummyConverter():
+
+    """
+    Converts from Dummy transfers to instances of
+    `DataObject`.
+    """
+
+    def __init__(
+        self,
+        parser: Parser
+    ) -> None:
+
+        self.__parser = parser
+
+    def convert(self, input_: DummyTransfer) -> DataObject:
+        """
+        Converts a DummyTransfer containing a detail (single) result
+        """
+        return self.__parser.parse(input_)
+
+    def convert_list(
+        self,
+        input_: DummyTransfer
+    ) -> tuple[list[DataObject], Optional[int]]:
+        """
+        Converts a DummyTransfer containing a list of results. Also
+        returns a count of the total results meeting.
+        """
+
+        return [
+            self.__parser.parse(json_obj)
+            for json_obj in input_
+            if json_obj is not None
+        ], None