Use a protocol

.vscode/settings.json

@@ -102,7 +102,6 @@
     ],
     "python.analysis.typeCheckingMode": "basic",
     "python.testing.pytestArgs": [
-            "--cov=servicex",
 	        "tests"
     ],
     "python.testing.unittestEnabled": false,

servicex/configuration.py

@@ -39,6 +39,8 @@ class Endpoint(BaseModel):
     endpoint: str
     name: str
     token: Optional[str] = ""
+    # TODO: don't know how to use ServiceXAdapterProtocol here as pydantic can't handle it
+    adapter: Optional[object] = None
 
 
 g_registered_endpoints: List[Endpoint] = []
@@ -155,8 +157,11 @@ def register_endpoint(cls, ep: Endpoint):
         '''Store this endpoint registration
 
         Args:
-            ep (Endpoint): The endpoint to store
+            ep: Endpoint object to register
         '''
+        # TODO: This requires exposing Endpoint
+        # There is no check in this setup that the adaptor is a valid ServiceXAdapterProtocol
+        # because I couldn't figure out how to make pydantic handle a protocol object.
         global g_registered_endpoints
         g_registered_endpoints.append(ep)
 

servicex/protocols.py

@@ -0,0 +1,31 @@
+from typing import List, Protocol
+
+from servicex.models import CachedDataset, TransformRequest, TransformStatus
+
+
+class ServiceXAdapterProtocol(Protocol):
+    async def get_transforms(self) -> List[TransformStatus]:
+        ...
+
+    def get_code_generators(self):
+        ...
+
+    async def get_datasets(
+        self, did_finder=None, show_deleted=False
+    ) -> List[CachedDataset]:
+        ...
+
+    async def get_dataset(self, dataset_id=None) -> CachedDataset:
+        ...
+
+    async def delete_dataset(self, dataset_id=None) -> bool:
+        ...
+
+    async def delete_transform(self, transform_id=None):
+        ...
+
+    async def submit_transform(self, transform_request: TransformRequest) -> str:
+        ...
+
+    async def get_transform_status(self, request_id: str) -> TransformStatus:
+        ...

tests/test_config.py

@@ -102,3 +102,24 @@ def test_config_register(tempdir):
     # Make sure we get back what we expect
     ep = endpoints["servicex-cern"]
     assert ep.endpoint == "https://servicex.cern.ch"
+
+
+@patch("servicex.configuration.tempfile.gettempdir", return_value="./mytemp")
+def test_config_register_adaptor(tempdir):
+    'Make sure we can do this with an adaptor'
+    class MyAdaptor:
+        pass
+
+    Configuration.register_endpoint(
+        Endpoint(
+            name="my-adaptor",
+            adapter=MyAdaptor,
+            endpoint="",
+        )
+    )
+
+    os.environ["UserName"] = "p_higgs"
+    c = Configuration.read(config_path="tests/example_config.yaml")
+    endpoints = c.endpoint_dict()
+    assert len(endpoints) == 4
+    assert "my-adaptor" in endpoints