Update imports in test suite

By using the top level imports in our tests, we make
it more likely we'll catch any issues if something changes.

Author: rwb27

tests/test_action_cancel.py

@@ -4,26 +4,22 @@
 
 import uuid
 from fastapi.testclient import TestClient
-from labthings_fastapi.server import ThingServer
 from temp_client import poll_task, task_href
-from labthings_fastapi.thing import Thing
-from labthings_fastapi.decorators import thing_action
-from labthings_fastapi.descriptors import ThingProperty
-from labthings_fastapi.dependencies.invocation import CancelHook
+import labthings_fastapi as lt
 
 
-class ThingOne(Thing):
-    counter = ThingProperty(int, 0, observable=False)
+class ThingOne(lt.Thing):
+    counter = lt.ThingProperty(int, 0, observable=False)
 
-    @thing_action
-    def count_slowly(self, cancel: CancelHook, n: int = 10):
+    @lt.thing_action
+    def count_slowly(self, cancel: lt.CancelHook, n: int = 10):
         for i in range(n):
             cancel.sleep(0.1)
             self.counter += 1
 
 
 def test_invocation_cancel():
-    server = ThingServer()
+    server = lt.ThingServer()
     thing_one = ThingOne()
     server.add_thing(thing_one, "/thing_one")
     with TestClient(server.app) as client:

tests/test_action_logging.py

@@ -4,29 +4,26 @@
 
 import logging
 from fastapi.testclient import TestClient
-from labthings_fastapi.server import ThingServer
 from temp_client import poll_task
-from labthings_fastapi.thing import Thing
-from labthings_fastapi.decorators import thing_action
-from labthings_fastapi.dependencies.invocation import InvocationLogger
+import labthings_fastapi as lt
 from labthings_fastapi.actions.invocation_model import LogRecordModel
 
 
-class ThingOne(Thing):
+class ThingOne(lt.Thing):
     LOG_MESSAGES = [
         "message 1",
         "message 2",
     ]
 
-    @thing_action
-    def action_one(self, logger: InvocationLogger):
+    @lt.thing_action
+    def action_one(self, logger: lt.InvocationLogger):
         for m in self.LOG_MESSAGES:
             logger.info(m)
 
 
 def test_invocation_logging(caplog):
     caplog.set_level(logging.INFO)
-    server = ThingServer()
+    server = lt.ThingServer()
     server.add_thing(ThingOne(), "/thing_one")
     with TestClient(server.app) as client:
         r = client.post("/thing_one/action_one")

tests/test_action_manager.py

@@ -1,27 +1,24 @@
 from fastapi.testclient import TestClient
 import pytest
 import httpx
-from labthings_fastapi.server import ThingServer
 from temp_client import poll_task
 import time
-from labthings_fastapi.thing import Thing
-from labthings_fastapi.decorators import thing_action
-from labthings_fastapi.descriptors import ThingProperty
+import labthings_fastapi as lt
 
 
-class TestThing(Thing):
-    @thing_action(retention_time=0.01)
+class TestThing(lt.Thing):
+    @lt.thing_action(retention_time=0.01)
     def increment_counter(self):
         """Increment the counter"""
         self.counter += 1
 
-    counter = ThingProperty(
+    counter = lt.ThingProperty(
         model=int, initial_value=0, readonly=True, description="A pointless counter"
     )
 
 
 thing = TestThing()
-server = ThingServer()
+server = lt.ThingServer()
 server.add_thing(thing, "/thing")
 
 

tests/test_actions.py

@@ -1,12 +1,11 @@
 from fastapi.testclient import TestClient
 import pytest
-from labthings_fastapi.server import ThingServer
 from temp_client import poll_task, get_link
-from labthings_fastapi.decorators import thing_action
 from labthings_fastapi.example_things import MyThing
+import labthings_fastapi as lt
 
 thing = MyThing()
-server = ThingServer()
+server = lt.ThingServer()
 server.add_thing(thing, "/thing")
 
 
@@ -49,7 +48,7 @@ def test_varargs():
     """Test that we can't use *args in an action"""
     with pytest.raises(TypeError):
 
-        @thing_action
+        @lt.thing_action
         def action_with_varargs(self, *args) -> None:
             """An action that takes *args"""
             pass

tests/test_blob_output.py

@@ -7,61 +7,59 @@
 
 from fastapi.testclient import TestClient
 import pytest
-from labthings_fastapi.server import ThingServer
-from labthings_fastapi.thing import Thing
-from labthings_fastapi.decorators import thing_action
-from labthings_fastapi.dependencies.thing import direct_thing_client_dependency
+import labthings_fastapi as lt
 from labthings_fastapi.outputs.blob import blob_type
 from labthings_fastapi.client import ThingClient
 
 
-TextBlob = blob_type(media_type="text/plain")
+class TextBlob(lt.Blob):
+    media_type: str = "text/plain"
 
 
-class ThingOne(Thing):
+class ThingOne(lt.Thing):
     ACTION_ONE_RESULT = b"Action one result!"
 
     def __init__(self):
         self._temp_directory = TemporaryDirectory()
 
-    @thing_action
+    @lt.thing_action
     def action_one(self) -> TextBlob:
         """An action that makes a blob response from bytes"""
         return TextBlob.from_bytes(self.ACTION_ONE_RESULT)
 
-    @thing_action
+    @lt.thing_action
     def action_two(self) -> TextBlob:
         """An action that makes a blob response from a file and tempdir"""
         td = TemporaryDirectory()
         with open(os.path.join(td.name, "serverside"), "wb") as f:
             f.write(self.ACTION_ONE_RESULT)
         return TextBlob.from_temporary_directory(td, "serverside")
 
-    @thing_action
+    @lt.thing_action
     def action_three(self) -> TextBlob:
         """An action that makes a blob response from a file"""
         fpath = os.path.join(self._temp_directory.name, "serverside")
         with open(fpath, "wb") as f:
             f.write(self.ACTION_ONE_RESULT)
         return TextBlob.from_file(fpath)
 
-    @thing_action
+    @lt.thing_action
     def passthrough_blob(self, blob: TextBlob) -> TextBlob:
         """An action that passes through a blob response"""
         return blob
 
 
-ThingOneDep = direct_thing_client_dependency(ThingOne, "/thing_one/")
+ThingOneDep = lt.direct_thing_client_dependency(ThingOne, "/thing_one/")
 
 
-class ThingTwo(Thing):
-    @thing_action
+class ThingTwo(lt.Thing):
+    @lt.thing_action
     def check_both(self, thing_one: ThingOneDep) -> bool:
         """An action that checks the output of ThingOne"""
         check_actions(thing_one)
         return True
 
-    @thing_action
+    @lt.thing_action
     def check_passthrough(self, thing_one: ThingOneDep) -> bool:
         """An action that checks the passthrough of ThingOne"""
         output = thing_one.action_one()
@@ -98,7 +96,7 @@ def test_blob_output_client():
 
     This uses the internal thing client mechanism.
     """
-    server = ThingServer()
+    server = lt.ThingServer()
     server.add_thing(ThingOne(), "/thing_one")
     with TestClient(server.app) as client:
         tc = ThingClient.from_url("/thing_one/", client=client)
@@ -113,7 +111,7 @@ def test_blob_output_direct():
 
 def test_blob_output_inserver():
     """Test that the blob output works the same when used directly"""
-    server = ThingServer()
+    server = lt.ThingServer()
     server.add_thing(ThingOne(), "/thing_one")
     server.add_thing(ThingTwo(), "/thing_two")
     with TestClient(server.app) as client:
@@ -143,7 +141,7 @@ def check_actions(thing):
 
 def test_blob_input():
     """Check that blobs can be used as input."""
-    server = ThingServer()
+    server = lt.ThingServer()
     server.add_thing(ThingOne(), "/thing_one")
     server.add_thing(ThingTwo(), "/thing_two")
     with TestClient(server.app) as client:

tests/test_dependencies.py

@@ -5,7 +5,7 @@
 """
 
 from fastapi import Depends, FastAPI, Request
-from labthings_fastapi.dependencies.invocation import InvocationID
+from labthings_fastapi 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

@@ -18,7 +18,8 @@
 from fastapi import Depends, FastAPI
 from fastapi.testclient import TestClient
 from module_with_deps import FancyIDDep, FancyID, ClassDependsOnFancyID
-from labthings_fastapi.dependencies.invocation import InvocationID, invocation_id
+import labthings_fastapi as lt
+from labthings_fastapi.dependencies.invocation import invocation_id
 from labthings_fastapi.file_manager import FileManager
 from uuid import UUID
 
@@ -122,7 +123,7 @@ def endpoint(id: DepClass = Depends()) -> bool:
 
 
 def test_invocation_id():
-    """Add an endpoint that uses a dependency from another file"""
+    """Add an endpoint that uses a dependency imported from another file"""
     app = FastAPI()
 
     @app.post("/endpoint")
@@ -135,11 +136,11 @@ def invoke_fancy(id: Annotated[UUID, Depends(invocation_id)]) -> bool:
 
 
 def test_invocation_id_alias():
-    """Add an endpoint that uses a dependency from another file"""
+    """Add an endpoint that uses a dependency alias from another file"""
     app = FastAPI()
 
     @app.post("/endpoint")
-    def endpoint(id: InvocationID) -> bool:
+    def endpoint(id: lt.InvocationID) -> bool:
         return True
 
     with TestClient(app) as client:

tests/test_dependency_metadata.py

@@ -4,20 +4,17 @@
 
 from typing import Any, Mapping
 from fastapi.testclient import TestClient
-from labthings_fastapi.server import ThingServer
 from temp_client import poll_task
-from labthings_fastapi.thing import Thing
-from labthings_fastapi.decorators import thing_action, thing_property
-from labthings_fastapi.dependencies.thing import direct_thing_client_dependency
 from labthings_fastapi.dependencies.metadata import GetThingStates
+import labthings_fastapi as lt
 
 
-class ThingOne(Thing):
+class ThingOne(lt.Thing):
     def __init__(self):
-        Thing.__init__(self)
+        lt.Thing.__init__(self)
         self._a = 0
 
-    @thing_property
+    @lt.thing_property
     def a(self):
         return self._a
 
@@ -30,17 +27,17 @@ def thing_state(self):
         return {"a": self.a}
 
 
-ThingOneDep = direct_thing_client_dependency(ThingOne, "/thing_one/")
+ThingOneDep = lt.direct_thing_client_dependency(ThingOne, "/thing_one/")
 
 
-class ThingTwo(Thing):
+class ThingTwo(lt.Thing):
     A_VALUES = [1, 2, 3]
 
     @property
     def thing_state(self):
         return {"a": 1}
 
-    @thing_action
+    @lt.thing_action
     def count_and_watch(
         self, thing_one: ThingOneDep, get_metadata: GetThingStates
     ) -> Mapping[str, Mapping[str, Any]]:
@@ -52,7 +49,7 @@ def count_and_watch(
 
 
 def test_fresh_metadata():
-    server = ThingServer()
+    server = lt.ThingServer()
     server.add_thing(ThingOne(), "/thing_one/")
     server.add_thing(ThingTwo(), "/thing_two/")
     with TestClient(server.app) as client:

tests/test_endpoint_decorator.py

@@ -1,7 +1,5 @@
 from fastapi.testclient import TestClient
-from labthings_fastapi.server import ThingServer
-from labthings_fastapi.thing import Thing
-from labthings_fastapi.decorators import fastapi_endpoint
+from labthings_fastapi import ThingServer, Thing, fastapi_endpoint
 from pydantic import BaseModel
 
 

tests/test_numpy_type.py

@@ -4,8 +4,7 @@
 import numpy as np
 
 from labthings_fastapi.types.numpy import NDArray, DenumpifyingDict
-from labthings_fastapi.thing import Thing
-from labthings_fastapi.decorators import thing_action
+import labthings_fastapi as lt
 
 
 class ArrayModel(RootModel):
@@ -63,8 +62,8 @@ class Model(BaseModel):
     m.model_dump_json()
 
 
-class MyNumpyThing(Thing):
-    @thing_action
+class MyNumpyThing(lt.Thing):
+    @lt.thing_action
     def action_with_arrays(self, a: NDArray) -> NDArray:
         return a * 2