Organise blob, deps, and outputs

I've moved dependencies into a convenience module `deps`, so now dependencies, outputs, and
blob subclasses are imported as `lt.blob.MyBlob` etc. to avoid cluttering the global namespace too much.

`deps` is used rather than `dependencies` to avoid circular imports and allow for future rearrangements, as well as keeping type
annotations shorter if it's imported as `lt.deps.Whatever`.

Test code is updated to use the new imports.

Author: rwb27

src/labthings_fastapi/__init__.py

@@ -6,13 +6,9 @@
     thing_action,
     fastapi_endpoint,
 )
-from .dependencies.blocking_portal import BlockingPortal
-from .dependencies.invocation import InvocationID, InvocationLogger, CancelHook
-from .dependencies.metadata import GetThingStates
-from .dependencies.raw_thing import raw_thing_dependency
-from .dependencies.thing import direct_thing_client_dependency
-from .outputs.mjpeg_stream import MJPEGStream, MJPEGStreamDescriptor
-from .outputs.blob import Blob
+from . import deps
+from . import outputs
+from .outputs import blob
 from .server import ThingServer
 
 # The symbols in __all__ are part of our public API.
@@ -29,15 +25,8 @@
     "thing_setting",
     "thing_action",
     "fastapi_endpoint",
-    "BlockingPortal",
-    "InvocationID",
-    "InvocationLogger",
-    "CancelHook",
-    "GetThingStates",
-    "raw_thing_dependency",
-    "direct_thing_client_dependency",
-    "MJPEGStream",
-    "MJPEGStreamDescriptor",
-    "Blob",
+    "deps",
+    "outputs",
+    "blob",
     "ThingServer",
 ]

src/labthings_fastapi/deps.py

@@ -0,0 +1,28 @@
+"""
+FastAPI dependencies for LabThings.
+
+The symbols in this module are type annotations that can be used in
+the arguments of Action methods (or FastAPI endpoints) to
+automatically supply the required dependencies.
+
+See the documentation on dependencies for more details of how to use
+these.
+"""
+
+from .dependencies.blocking_portal import BlockingPortal
+from .dependencies.invocation import InvocationID, InvocationLogger, CancelHook
+from .dependencies.metadata import GetThingStates
+from .dependencies.raw_thing import raw_thing_dependency
+from .dependencies.thing import direct_thing_client_dependency
+
+# The symbols in __all__ are part of our public API. See note
+# in src/labthings_fastapi/__init__.py for more details.
+__all__ = [
+    "BlockingPortal",
+    "InvocationID",
+    "InvocationLogger",
+    "CancelHook",
+    "GetThingStates",
+    "raw_thing_dependency",
+    "direct_thing_client_dependency",
+]

src/labthings_fastapi/outputs/__init__.py

@@ -0,0 +1,10 @@
+from .mjpeg_stream import MJPEGStream, MJPEGStreamDescriptor
+
+# __all__ enables convenience imports from this module.
+# see the note in src/labthings_fastapi/__init__.py for more details.
+# `blob` is intentionally missing: it will likely be promoted out of
+# `outputs` in the future.
+__all__ = [
+    "MJPEGStream",
+    "MJPEGStreamDescriptor",
+]

tests/test_action_cancel.py

@@ -12,7 +12,7 @@ class ThingOne(lt.Thing):
     counter = lt.ThingProperty(int, 0, observable=False)
 
     @lt.thing_action
-    def count_slowly(self, cancel: lt.CancelHook, n: int = 10):
+    def count_slowly(self, cancel: lt.deps.CancelHook, n: int = 10):
         for i in range(n):
             cancel.sleep(0.1)
             self.counter += 1

tests/test_action_logging.py

@@ -16,7 +16,7 @@ class ThingOne(lt.Thing):
     ]
 
     @lt.thing_action
-    def action_one(self, logger: lt.InvocationLogger):
+    def action_one(self, logger: lt.deps.InvocationLogger):
         for m in self.LOG_MESSAGES:
             logger.info(m)
 

tests/test_blob_output.py

@@ -12,7 +12,7 @@
 from labthings_fastapi.client import ThingClient
 
 
-class TextBlob(lt.Blob):
+class TextBlob(lt.blob.Blob):
     media_type: str = "text/plain"
 
 
@@ -49,7 +49,7 @@ def passthrough_blob(self, blob: TextBlob) -> TextBlob:
         return blob
 
 
-ThingOneDep = lt.direct_thing_client_dependency(ThingOne, "/thing_one/")
+ThingOneDep = lt.deps.direct_thing_client_dependency(ThingOne, "/thing_one/")
 
 
 class ThingTwo(lt.Thing):

tests/test_dependencies.py

@@ -5,7 +5,7 @@
 """
 
 from fastapi import Depends, FastAPI, Request
-from labthings_fastapi import InvocationID
+from labthings_fastapi.deps import InvocationID
 from labthings_fastapi.file_manager import FileManagerDep
 from fastapi.testclient import TestClient
 from module_with_deps import FancyIDDep

tests/test_dependencies_2.py

@@ -140,7 +140,7 @@ def test_invocation_id_alias():
     app = FastAPI()
 
     @app.post("/endpoint")
-    def endpoint(id: lt.InvocationID) -> bool:
+    def endpoint(id: lt.deps.InvocationID) -> bool:
         return True
 
     with TestClient(app) as client:

tests/test_dependency_metadata.py

@@ -27,7 +27,7 @@ def thing_state(self):
         return {"a": self.a}
 
 
-ThingOneDep = lt.direct_thing_client_dependency(ThingOne, "/thing_one/")
+ThingOneDep = lt.deps.direct_thing_client_dependency(ThingOne, "/thing_one/")
 
 
 class ThingTwo(lt.Thing):

tests/test_thing_dependencies.py

@@ -24,7 +24,7 @@ def action_one_internal(self) -> str:
         return self.ACTION_ONE_RESULT
 
 
-ThingOneDep = lt.direct_thing_client_dependency(ThingOne, "/thing_one/")
+ThingOneDep = lt.deps.direct_thing_client_dependency(ThingOne, "/thing_one/")
 
 
 class ThingTwo(lt.Thing):
@@ -39,7 +39,7 @@ def action_two_a(self, thing_one: ThingOneDep) -> str:
         return thing_one.action_one()
 
 
-ThingTwoDep = lt.direct_thing_client_dependency(ThingTwo, "/thing_two/")
+ThingTwoDep = lt.deps.direct_thing_client_dependency(ThingTwo, "/thing_two/")
 
 
 class ThingThree(lt.Thing):
@@ -113,7 +113,7 @@ def test_raw_interthing_dependency():
 
     This uses the internal thing client mechanism.
     """
-    ThingOneDep = lt.raw_thing_dependency(ThingOne)
+    ThingOneDep = lt.deps.raw_thing_dependency(ThingOne)
 
     class ThingTwo(lt.Thing):
         @lt.thing_action
@@ -139,7 +139,7 @@ def test_conflicting_dependencies():
     This also checks that dependencies on the same class but different
     actions are recognised as "different".
     """
-    ThingTwoDepNoActions = lt.direct_thing_client_dependency(
+    ThingTwoDepNoActions = lt.deps.direct_thing_client_dependency(
         ThingTwo, "/thing_two/", []
     )
 
@@ -153,7 +153,7 @@ def action_five(self, thing_two: ThingTwoDep) -> str:
             return thing_two.action_two()
 
     with pytest.raises(ValueError):
-        lt.direct_thing_client_dependency(ThingFour, "/thing_four/")
+        lt.deps.direct_thing_client_dependency(ThingFour, "/thing_four/")
 
 
 def check_request():