Tidy up imports in tests, docstrings, and code

Imports of `labthings_fastapi` within the package are now consistently changed to relative (.) imports.

Tests now use `import labthings_fastapi as lt` wherever possible.

Documentation has been updated to use the new import style.

Author: rwb27

src/labthings_fastapi/actions/__init__.py

@@ -11,8 +11,8 @@
 from fastapi.responses import FileResponse
 from pydantic import BaseModel
 
-from labthings_fastapi.utilities import model_to_dict
-from labthings_fastapi.utilities.introspection import EmptyInput
+from ..utilities import model_to_dict
+from ..utilities.introspection import EmptyInput
 from ..thing_description.model import LinkElement
 from ..file_manager import FileManager
 from .invocation_model import InvocationModel, InvocationStatus

src/labthings_fastapi/actions/invocation_model.py

@@ -7,7 +7,7 @@
 
 from pydantic import BaseModel, ConfigDict, model_validator
 
-from labthings_fastapi.thing_description.model import Links
+from ..thing_description.model import Links
 
 
 class InvocationStatus(Enum):

src/labthings_fastapi/client/in_server.py

@@ -14,10 +14,10 @@
 import logging
 from typing import Any, Mapping, Optional, Union
 from pydantic import BaseModel
-from labthings_fastapi.descriptors.action import ActionDescriptor
+from ..descriptors.action import ActionDescriptor
 
-from labthings_fastapi.descriptors.property import ThingProperty
-from labthings_fastapi.utilities import attributes
+from ..descriptors.property import ThingProperty
+from ..utilities import attributes
 from . import PropertyClientDescriptor
 from ..thing import Thing
 from ..dependencies.thing_server import find_thing_server

src/labthings_fastapi/dependencies/thing_server.py

@@ -12,7 +12,7 @@
 from fastapi import FastAPI, Request
 
 if TYPE_CHECKING:
-    from labthings_fastapi.server import ThingServer
+    from ..server import ThingServer
 
 _thing_servers: WeakSet[ThingServer] = WeakSet()
 

src/labthings_fastapi/descriptors/endpoint.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 from functools import partial, wraps
 
-from labthings_fastapi.utilities.introspection import get_docstring, get_summary
+from ..utilities.introspection import get_docstring, get_summary
 
 from typing import (
     Callable,

src/labthings_fastapi/server/__init__.py

@@ -10,7 +10,7 @@
 from collections.abc import Mapping
 from types import MappingProxyType
 
-from labthings_fastapi.utilities.object_reference_to_object import (
+from ..utilities.object_reference_to_object import (
     object_reference_to_object,
 )
 from ..actions import ActionManager

src/labthings_fastapi/server/cli.py

@@ -2,7 +2,7 @@
 from typing import Optional
 import json
 
-from labthings_fastapi.utilities.object_reference_to_object import (
+from ..utilities.object_reference_to_object import (
     object_reference_to_object,
 )
 import uvicorn

src/labthings_fastapi/utilities/__init__.py

@@ -4,7 +4,7 @@
 from pydantic import BaseModel, ConfigDict, Field, RootModel, create_model
 from pydantic.dataclasses import dataclass
 from anyio.from_thread import BlockingPortal
-from labthings_fastapi.utilities.introspection import EmptyObject
+from .introspection import EmptyObject
 
 if TYPE_CHECKING:
     from ..thing import Thing

tests/test_blob_output.py

@@ -8,8 +8,6 @@
 from fastapi.testclient import TestClient
 import pytest
 import labthings_fastapi as lt
-from labthings_fastapi.outputs.blob import blob_type
-from labthings_fastapi.client import ThingClient
 
 
 class TextBlob(lt.blob.Blob):
@@ -71,8 +69,8 @@ def check_passthrough(self, thing_one: ThingOneDep) -> bool:
 def test_blob_type():
     """Check we can't put dodgy values into a blob output model"""
     with pytest.raises(ValueError):
-        blob_type(media_type="text/plain\\'DROP TABLES")
-    M = blob_type(media_type="text/plain")
+        lt.blob.blob_type(media_type="text/plain\\'DROP TABLES")
+    M = lt.blob.blob_type(media_type="text/plain")
     assert M.from_bytes(b"").media_type == "text/plain"
 
 
@@ -99,7 +97,7 @@ def test_blob_output_client():
     server = lt.ThingServer()
     server.add_thing(ThingOne(), "/thing_one")
     with TestClient(server.app) as client:
-        tc = ThingClient.from_url("/thing_one/", client=client)
+        tc = lt.ThingClient.from_url("/thing_one/", client=client)
         check_actions(tc)
 
 
@@ -115,7 +113,7 @@ def test_blob_output_inserver():
     server.add_thing(ThingOne(), "/thing_one")
     server.add_thing(ThingTwo(), "/thing_two")
     with TestClient(server.app) as client:
-        tc = ThingClient.from_url("/thing_two/", client=client)
+        tc = lt.ThingClient.from_url("/thing_two/", client=client)
         output = tc.check_both()
         assert output is True
 
@@ -145,7 +143,7 @@ def test_blob_input():
     server.add_thing(ThingOne(), "/thing_one")
     server.add_thing(ThingTwo(), "/thing_two")
     with TestClient(server.app) as client:
-        tc = ThingClient.from_url("/thing_one/", client=client)
+        tc = lt.ThingClient.from_url("/thing_one/", client=client)
         output = tc.action_one()
         print(f"Output is {output}")
         assert output is not None
@@ -157,7 +155,7 @@ def test_blob_input():
         assert passthrough.content == ThingOne.ACTION_ONE_RESULT
 
         # Check that the same thing works on the server side
-        tc2 = ThingClient.from_url("/thing_two/", client=client)
+        tc2 = lt.ThingClient.from_url("/thing_two/", client=client)
         assert tc2.check_passthrough() is True
 
 

tests/test_dependencies_2.py

@@ -2,13 +2,16 @@
 
 Class-based dependencies in modules with `from __future__ import annotations`
 fail if they have sub-dependencies, because the global namespace is not found by
-pydantic. The work-around is to add a line to each class definition:
+pydantic. The work-around was to add a line to each class definition:
 ```
 __globals__ = globals()
 ```
 This bakes in the global namespace of the module, and allows FastAPI to correctly
 traverse the dependency tree.
 
+This is related to https://github.com/fastapi/fastapi/issues/4557 and may have
+been fixed upstream in FastAPI.
+
 The tests in this module were written while I was figuring this out: they mostly
 test things from FastAPI that obviously work, but I will leave them in here as
 mitigation against something changing in the future.
@@ -19,9 +22,7 @@
 from fastapi.testclient import TestClient
 from module_with_deps import FancyIDDep, FancyID, ClassDependsOnFancyID
 import labthings_fastapi as lt
-from labthings_fastapi.dependencies.invocation import invocation_id
 from labthings_fastapi.file_manager import FileManager
-from uuid import UUID
 
 
 def test_dep_from_module():
@@ -127,7 +128,7 @@ def test_invocation_id():
     app = FastAPI()
 
     @app.post("/endpoint")
-    def invoke_fancy(id: Annotated[UUID, Depends(invocation_id)]) -> bool:
+    def invoke_fancy(id: lt.deps.InvocationID) -> bool:
         return True
 
     with TestClient(app) as client: