just raise a 'NotImplementedError' for 'build_vlm_response_from_caf_data' for now instead of trying to guess how things will be formatted

Author: jennifer-bowser

src/anyvlm/functions/build_vlm_response.py

@@ -3,54 +3,16 @@
 from ga4gh.va_spec.base.core import CohortAlleleFrequencyStudyResult
 
 from anyvlm.schemas.vlm import (
-    HandoverType,
-    ResponseField,
-    ResponseSummary,
-    ResultSet,
     VlmResponse,
 )
-from anyvlm.utils.types import Zygosity
 
 
-def _get_caf_zygosity() -> Zygosity:
-    """Extracts a zygosity from a CohortAlleleFrequencyStudyResult.
-    #TODO: We will need to implement this function during or after Issue #16 based on how we choose to
-    store CAF data/implement the CAF data pull.
-
-    :param caf_study_result: The CohortAlleleFrequencyStudyResult whose zygosity we wish to determine.
-    :return: The `Zygosity` of the study result.
-    """
-    raise NotImplementedError
-
-
-def build_vlm_response(caf_data: list[CohortAlleleFrequencyStudyResult]) -> VlmResponse:
+def build_vlm_response_from_caf_data(
+    caf_data: list[CohortAlleleFrequencyStudyResult],
+) -> VlmResponse:
     """Craft a VlmResponse object from a list of CohortAlleleFrequencyStudyResults.
 
     :param caf_data: A list of `CohortAlleleFrequencyStudyResult` objects that will be used to build the VlmResponse
     :return: A `VlmResponse` object.
     """
-    result_sets: list[ResultSet] = []
-    if caf_data:
-        total: int = sum(
-            [caf_study_result.focusAlleleCount for caf_study_result in caf_data]
-        )  # TODO: I'm not sure this is the right field? Will need to verify during/after Issue #16.
-        response_summary = ResponseSummary(exists=True, total=total)
-
-        for caf_study_result in caf_data:
-            result_sets.extend(
-                [
-                    ResultSet(
-                        exists=True,
-                        # TODO - HandoverType.id represents the ID of the node from which the dataset was pulled.
-                        # In the future, this ID should be set dynamically.
-                        id=f"{HandoverType.id} {_get_caf_zygosity()}",
-                        resultsCount=caf_study_result.focusAlleleCount,
-                    )
-                ]
-            )
-    else:
-        response_summary = ResponseSummary(exists=False, total=0)
-
-    return VlmResponse(
-        responseSummary=response_summary, response=ResponseField(resultSets=result_sets)
-    )
+    raise NotImplementedError  # TODO: Implement this during/after Issue #16

src/anyvlm/restapi/vlm.py

@@ -7,7 +7,7 @@
 from ga4gh.va_spec.base.core import CohortAlleleFrequencyStudyResult
 
 from anyvlm.anyvar.base_client import BaseAnyVarClient
-from anyvlm.functions.build_vlm_response import build_vlm_response
+from anyvlm.functions.build_vlm_response import build_vlm_response_from_caf_data
 from anyvlm.functions.get_caf import get_caf
 from anyvlm.main import app
 from anyvlm.schemas.vlm import (
@@ -67,4 +67,4 @@ def vlm_query(
     caf_data: list[CohortAlleleFrequencyStudyResult] = get_caf(
         anyvar_client, assemblyId, referenceName, start, referenceBases, alternateBases
     )
-    return build_vlm_response(caf_data)
+    return build_vlm_response_from_caf_data(caf_data)

src/anyvlm/schemas/vlm.py

@@ -63,7 +63,7 @@ class ResultSet(BaseModel):
     exists: bool
     id: str = Field(
         ...,
-        description="id should be constructed of the `HandoverType.id` + the ResultSet's zygosity",
+        description="id should be constructed of the `HandoverType.id` + the ResultSet's zygosity. See `validate_resultset_ids` validator in `VlmResponse` class.",
         examples=["Geno2MP Homozygous", "MyGene2 Heterozygous"],
     )
     results: list = Field(