feat: MCC-1496348 dataset versions

Author: ibaig-mdsol

.gitignore

@@ -6,6 +6,10 @@ __pycache__/
 # C extensions
 *.so
 
+# Jupyter Notebook
+.ipynb_checkpoints
+*.ipynb
+
 # Distribution / packaging
 .Python
 build/

.pre-commit-config.yaml

@@ -12,7 +12,10 @@
 #   pre-commit autoupdate
 
 default_language_version:
-  python: python3.11
+  # Use the system 'python3' interpreter so pre-commit picks up the active
+  # Python in your PATH (or the project's virtualenv). This avoids failures
+  # when a specific patch-level interpreter like python3.11 is not installed.
+  python: python3
 
 repos:
   # ---------------------------------------------------------------------------

README.md

@@ -1,5 +1,3 @@
-from dataconnect import DataConnectClientfrom dataconnect import DataConnectClient
-
 # dataconnect-library-python
 
 Python SDK for the [Medidata DataConnect](https://github.com/mdsol/dataconnect-library-r) service.
@@ -8,8 +6,7 @@ Python SDK for the [Medidata DataConnect](https://github.com/mdsol/dataconnect-l
 
 ## Transport note
 
-The DataConnect service uses **Apache Arrow Flight** (gRPC binary protocol),
-**not** a plain REST/HTTP API.  `pyarrow.flight` is the primary transport
+The DataConnect service uses **Apache Arrow Flight** (gRPC binary protocol), and **not** a plain REST/HTTP API.  `pyarrow.flight` is the primary transport
 dependency.
 
 ---

dataconnect/__init__.py

@@ -13,14 +13,15 @@
     ServerError,
     ValidationError,
 )
-from dataconnect.models import Study, StudyEnvironment
+from dataconnect.models import DatasetVersion, Study, StudyEnvironment
 
 __all__ = [
     # Client
     "DataConnectClient",
     # Domain models
     "Study",
     "StudyEnvironment",
+    "DatasetVersion",
     # Exceptions — catch these in user application code
     "DataConnectError",
     "ConnectionError",

dataconnect/client.py

@@ -8,8 +8,9 @@
 from __future__ import annotations
 
 from types import TracebackType
+from uuid import UUID
 
-from dataconnect.models import Study
+from dataconnect.models import DatasetVersion, Study
 from dataconnect.service import DataConnectService, DefaultDataConnectService
 
 _DEFAULT_HOST = "enodia-gateway.platform.imedidata.com"
@@ -46,6 +47,10 @@ def get_studies(self) -> list[Study]:
         """List the studies the client is authorized to access."""
         return self._service.get_studies()
 
+    def get_dataset_versions(self, dataset_uuid: UUID) -> list[DatasetVersion]:
+        """List the dataset versions the client is authorized to access."""
+        return self._service.get_dataset_versions(dataset_uuid)
+
     # Lifecycle
 
     def close(self) -> None:

dataconnect/models.py

@@ -15,3 +15,12 @@ class Study:
     uuid: UUID
     name: str
     environments: list[StudyEnvironment] = field(default_factory=list)
+
+
+@dataclass(frozen=True)
+class DatasetVersion:
+    study_uuid: UUID
+    study_env_uuid: UUID
+    dataset_uuid: UUID
+    dataset_name: str
+    dataset_version: str

dataconnect/service/base.py

@@ -3,8 +3,9 @@
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
+from uuid import UUID
 
-from dataconnect.models import Study
+from dataconnect.models import DatasetVersion, Study
 
 
 class DataConnectService(ABC):
@@ -13,5 +14,8 @@ class DataConnectService(ABC):
     @abstractmethod
     def get_studies(self) -> list[Study]: ...
 
+    @abstractmethod
+    def get_dataset_versions(self, dataset_uuid: UUID) -> list[DatasetVersion]: ...
+
     @abstractmethod
     def close(self) -> None: ...

dataconnect/service/default.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+from uuid import UUID
+
 from dataconnect.exceptions import (
     AuthenticationError,
     AuthorizationError,
@@ -12,9 +14,9 @@
     ServerError,
     ValidationError,
 )
-from dataconnect.models import Study
+from dataconnect.models import DatasetVersion, Study
 from dataconnect.service.base import DataConnectService
-from dataconnect.service.mappers import resource_to_study
+from dataconnect.service.mappers import resource_to_dataset_version, resource_to_study
 from dataconnect.transport.base import Transport
 from dataconnect.transport.errors import (
     TransportAuthenticationError,
@@ -29,6 +31,7 @@
 
 # Server action identifiers
 _ACTION_LIST_STUDIES = "studies.list"
+_ACTION_LIST_DATASET_VERSIONS = "dataset_versions.list"
 
 
 def _translate_error(ex: TransportError) -> DataConnectError:
@@ -69,9 +72,22 @@ def get_studies(self) -> list[Study]:
 
         try:
             return [resource_to_study(r) for r in resources]
-        except (KeyError, TypeError, ValueError) as ex:
+        except (IndexError, KeyError, TypeError, ValueError) as ex:
             raise ValidationError(f"Unexpected studies response format: {ex}") from ex
 
+    def get_dataset_versions(self, dataset_uuid: UUID) -> list[DatasetVersion]:
+        request = ResourceQuery(action=_ACTION_LIST_DATASET_VERSIONS).append_body({"dataset_uuid": str(dataset_uuid)})
+
+        try:
+            resources = self._transport.list_resources(request)
+        except TransportError as ex:
+            raise _translate_error(ex) from ex
+
+        try:
+            return [resource_to_dataset_version(r) for r in resources]
+        except (IndexError, KeyError, TypeError, ValueError) as ex:
+            raise ValidationError(f"Unexpected dataset versions response format: {ex}") from ex
+
     def close(self) -> None:
 
         try:

dataconnect/service/mappers.py

@@ -10,17 +10,38 @@
 import json
 from uuid import UUID
 
-from dataconnect.models import Study, StudyEnvironment
+from dataconnect.exceptions import NotFoundError
+from dataconnect.models import DatasetVersion, Study, StudyEnvironment
 from dataconnect.transport.models import ResourceInfo
 
 
 def resource_to_study(resource: ResourceInfo) -> Study:
     """Parse a transport-layer ``ResourceInfo`` into a ``Study`` domain object."""
 
+    if not resource or not resource.endpoints or not resource.endpoints[0].ticket:
+        raise NotFoundError("Invalid resource: missing endpoints or ticket")
+
     data = json.loads(resource.endpoints[0].ticket.decode("utf-8"))
 
     return Study(
         uuid=UUID(data["uuid"]),
         name=data["name"],
         environments=[StudyEnvironment(uuid=UUID(e["uuid"]), name=e["name"]) for e in data.get("environments", [])],
     )
+
+
+def resource_to_dataset_version(resource: ResourceInfo) -> DatasetVersion:
+    """Parse a transport-layer ``ResourceInfo`` into a ``DatasetVersion`` domain object."""
+
+    if not resource or not resource.endpoints or not resource.endpoints[0].ticket:
+        raise NotFoundError("Invalid resource: missing endpoints or ticket")
+
+    data = json.loads(resource.endpoints[0].ticket.decode("utf-8"))
+
+    return DatasetVersion(
+        study_uuid=UUID(data["study_uuid"]),
+        study_env_uuid=UUID(data["study_env_uuid"]),
+        dataset_uuid=UUID(data["dataset_uuid"]),
+        dataset_name=data["dataset_name"],
+        dataset_version=data["dataset_version"],
+    )

dataconnect/transport/arrow_flight/transport.py

@@ -39,6 +39,7 @@ def _to_resource_info(info: flight.FlightInfo) -> ResourceInfo:
 # Maps service-layer action names to the flight_type value the Arrow Flight server expects.
 _ACTION_FLIGHT_TYPE: dict[str, str] = {
     "studies.list": "STUDIES",
+    "dataset_versions.list": "VERSIONS",
 }
 
 
@@ -77,7 +78,9 @@ def list_resources(self, request: ResourceQuery) -> list[ResourceInfo]:
         flight_type = _ACTION_FLIGHT_TYPE.get(request.action)
 
         if flight_type is None:
-            raise TransportConnectionError(f"Unknown action: {request.action!r}")
+            raise TransportStatusError(
+                f"Unknown action: {request.action!r}", status_code=3, grpc_status="INVALID_ARGUMENT"
+            )
 
         body = json.loads(request.body) if request.body else {}
         criteria = json.dumps({**body, "flight_type": flight_type}, separators=(",", ":")).encode("utf-8")