Format fixes

Author: rwb27

docs/source/conf.py

@@ -6,38 +6,38 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'labthings-fastapi'
-copyright = '2024, Richard Bowman'
-author = 'Richard Bowman'
-release = '0.0.1'
+project = "labthings-fastapi"
+copyright = "2024, Richard Bowman"
+author = "Richard Bowman"
+release = "0.0.1"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
     "myst_parser",
     "sphinx.ext.intersphinx",
-    #"sphinx.ext.napoleon",
+    # "sphinx.ext.napoleon",
     "autodoc2",
     "sphinx_rtd_theme",
 ]
 
-templates_path = ['_templates']
+templates_path = ["_templates"]
 exclude_patterns = []
 
 autodoc2_packages = ["../../src/labthings_fastapi"]
 autodoc2_render_plugin = "myst"
 
-#autoapi_dirs = ["../../src/labthings_fastapi"]
-#autoapi_ignore = []
-#autoapi_generate_api_docs = True
-#autoapi_keep_files = True
+# autoapi_dirs = ["../../src/labthings_fastapi"]
+# autoapi_ignore = []
+# autoapi_generate_api_docs = True
+# autoapi_keep_files = True
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'sphinx_rtd_theme'
-html_static_path = ['_static']
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),

src/labthings_fastapi/client/in_server.py

@@ -7,6 +7,7 @@
 This module may get moved in the near future.
 
 """
+
 from __future__ import annotations
 from functools import wraps
 import inspect

src/labthings_fastapi/decorators/__init__.py

@@ -9,7 +9,7 @@
 
 If you have a complex datatype, it's recommended to use a `pydantic` model
 to describe it - this is often the case for complicated properties or events.
-For actions, a model is created automatically based on the function's 
+For actions, a model is created automatically based on the function's
 signature: if you want to add descriptions or validators to individual
 arguments, you may use `pydantic.Field` to do this.
 

src/labthings_fastapi/dependencies/blocking_portal.py

@@ -3,6 +3,7 @@
 This allows dependencies that are called by threaded code to send things back
 to the async event loop.
 """
+
 from __future__ import annotations
 from typing import Annotated
 from fastapi import Depends, Request
@@ -30,4 +31,4 @@ def blocking_portal_from_thing_server(request: Request) -> RealBlockingPortal:
 type `BlockingPortal`, FastAPI will automatically inject the blocking portal.
 This is simply shorthand for {class}`anyio.from_thread.BlockingPortal` annotated with
 `Depends(blocking_portal_from_thing_server)`.
-"""
+"""

src/labthings_fastapi/dependencies/invocation.py

@@ -1,4 +1,5 @@
 """FastAPI dependency for an invocation ID"""
+
 from __future__ import annotations
 import uuid
 from typing import Annotated

src/labthings_fastapi/dependencies/raw_thing.py

@@ -63,7 +63,7 @@ def raw_thing_dependency(cls: type[ThingInstance]) -> type[ThingInstance]:
     prompts FastAPI to supply the instance of the class.
 
     Usage:
-    
+
     ```{code-block} python
 
     from my_other_thing import MyOtherThing as MyOtherThingClass

src/labthings_fastapi/dependencies/thing.py

@@ -1,5 +1,5 @@
 from __future__ import annotations
-from typing import Annotated, Optional, TypeVar
+from typing import Annotated, Optional
 
 from fastapi import Depends
 
@@ -13,13 +13,13 @@ def direct_thing_client_dependency(
     actions: Optional[list[str]] = None,
 ) -> type[Thing]:
     """A type annotation that causes FastAPI to supply a direct thing client
-    
+
     :param thing_class: The class of the thing to connect to
     :param thing_path: The path to the thing on the server
-    :param actions: The actions that the client should be able to perform. 
+    :param actions: The actions that the client should be able to perform.
         If this is specified, only those actions will be available. If it is
         `None` (default), all actions will be available.
-        
+
         Note that the dependencies of all available actions will be added to
         your endpoint - so it is best to only specify the actions you need, in
         order to avoid spurious extra dependencies.

src/labthings_fastapi/descriptors/action.py

@@ -1,10 +1,20 @@
 """
 Define an object to represent an Action, as a descriptor.
 """
+
 from __future__ import annotations
 from functools import partial
 import inspect
-from typing import TYPE_CHECKING, Annotated, Any, Callable, Optional, Literal, Union, overload
+from typing import (
+    TYPE_CHECKING,
+    Annotated,
+    Any,
+    Callable,
+    Optional,
+    Literal,
+    Union,
+    overload,
+)
 from fastapi import Body, FastAPI, Request, BackgroundTasks
 from pydantic import create_model
 from ..actions import InvocationModel
@@ -75,12 +85,10 @@ def __init__(
         self.invocation_model.__name__ = f"{self.name}_invocation"
 
     @overload
-    def __get__(self, obj: Literal[None], type=None) -> ActionDescriptor:
-        ...
+    def __get__(self, obj: Literal[None], type=None) -> ActionDescriptor: ...
 
     @overload
-    def __get__(self, obj: Thing, type=None) -> Callable:
-        ...
+    def __get__(self, obj: Thing, type=None) -> Callable: ...
 
     def __get__(
         self, obj: Optional[Thing], type=None

src/labthings_fastapi/descriptors/endpoint.py

@@ -37,12 +37,10 @@ def __init__(
         self.kwargs = kwargs
 
     @overload
-    def __get__(self, obj: Literal[None], type=None) -> Self:
-        ...
+    def __get__(self, obj: Literal[None], type=None) -> Self: ...
 
     @overload
-    def __get__(self, obj: Thing, type=None) -> Callable:
-        ...
+    def __get__(self, obj: Thing, type=None) -> Callable: ...
 
     def __get__(self, obj: Optional[Thing], type=None) -> Union[Self, Callable]:
         """The function, bound to an object as for a normal method.

src/labthings_fastapi/descriptors/property.py

@@ -1,6 +1,7 @@
 """
 Define an object to represent an Action, as a descriptor.
 """
+
 from __future__ import annotations
 from typing import TYPE_CHECKING, Annotated, Any, Callable, Optional
 from typing_extensions import Self

src/labthings_fastapi/file_manager.py

@@ -8,6 +8,7 @@
 handle finding a temporary storage location, and making it possible to retrieve the
 files via the Invocation object.
 """
+
 from __future__ import annotations
 from tempfile import TemporaryDirectory
 from typing import Annotated, Sequence, Optional

src/labthings_fastapi/notifications.py

@@ -12,11 +12,10 @@
 enables property changes to be fed via a websocket. Events proper should
 not be a big step thereafter.
 
-Currently, this code is more or less all in `websockets.py` and 
+Currently, this code is more or less all in `websockets.py` and
 `descriptors/property.py` but it should get consolidated.
 """
 
-
 from __future__ import annotations
 
 

src/labthings_fastapi/outputs/blob.py

@@ -44,18 +44,15 @@ def media_type(self) -> str:
     def content(self) -> bytes:
         pass
 
-    def save(self, filename: str) -> None:
-        ...
+    def save(self, filename: str) -> None: ...
 
-    def open(self) -> io.IOBase:
-        ...
+    def open(self) -> io.IOBase: ...
 
 
 class ServerSideBlobOutputProtocol(BlobOutputProtocol, Protocol):
     """A BlobOutput protocol for server-side use, i.e. including `response()`"""
 
-    def response(self) -> Response:
-        ...
+    def response(self) -> Response: ...
 
 
 def is_blob_output(obj: Any) -> bool:

src/labthings_fastapi/outputs/mjpeg_stream.py

@@ -92,7 +92,7 @@ def stop(self):
 
     async def ringbuffer_entry(self, i: int) -> RingbufferEntry:
         """Return the ith frame acquired by the camera
-        
+
         :param i: The index of the frame to read
         """
         if i < 0:
@@ -110,7 +110,7 @@ async def ringbuffer_entry(self, i: int) -> RingbufferEntry:
     @asynccontextmanager
     async def buffer_for_reading(self, i: int) -> AsyncIterator[bytes]:
         """Yields the ith frame as a bytes object
-        
+
         :param i: The index of the frame to read
         """
         entry = await self.ringbuffer_entry(i)
@@ -158,7 +158,7 @@ async def mjpeg_stream_response(self) -> MJPEGStreamResponse:
 
     def add_frame(self, frame: bytes, portal: BlockingPortal):
         """Return the next buffer in the ringbuffer to write to
-        
+
         :param frame: The frame to add
         :param portal: The blocking portal to use for scheduling tasks.
             This is necessary because tasks are handled asynchronously.
@@ -191,12 +191,10 @@ def __set_name__(self, owner, name):
         self.name = name
 
     @overload
-    def __get__(self, obj: Literal[None], type=None) -> Self:
-        ...
+    def __get__(self, obj: Literal[None], type=None) -> Self: ...
 
     @overload
-    def __get__(self, obj: Thing, type=None) -> MJPEGStream:
-        ...
+    def __get__(self, obj: Thing, type=None) -> MJPEGStream: ...
 
     def __get__(self, obj: Optional[Thing], type=None) -> Union[MJPEGStream, Self]:
         """The value of the property

src/labthings_fastapi/thing.py

@@ -2,7 +2,7 @@
 The `Thing` class enables most of the functionality of this library,
 and is the way in to most of its features. In the future, we might
 support a stub version of the class in a separate package, so
-that instrument control libraries can be LabThings compatible 
+that instrument control libraries can be LabThings compatible
 without a hard dependency on LabThings. But that is something we
 will do in the future...
 """

src/labthings_fastapi/thing_server.py

@@ -94,7 +94,7 @@ async def lifespan(self, app: FastAPI):
         """Manage set up and tear down
 
         This does two important things:
-        
+
         * It sets up the blocking portal so background threads can run async code
           (important for events)
         * It runs setup/teardown code for Things.

src/labthings_fastapi/thing_settings.py

@@ -3,6 +3,7 @@
 
 ThingSettings is a dictionary-like object that manages settings for one Thing
 """
+
 from __future__ import annotations
 import json
 import os

src/labthings_fastapi/types/numpy.py

@@ -17,6 +17,7 @@ def double(arr: NDArray) -> NDArray:
 
 Complex numbers are currently not supported, again this is left for the future.
 """
+
 from __future__ import annotations
 import numpy as np
 from pydantic import (

src/labthings_fastapi/websockets.py

@@ -19,7 +19,6 @@
 (c) Richard Bowman July 2023, released under GNU-LGPL-3.0
 """
 
-
 from __future__ import annotations
 from anyio import create_memory_object_stream, create_task_group
 from anyio.abc import ObjectReceiveStream, ObjectSendStream

tests/test_action_cancel.py

@@ -1,6 +1,7 @@
 """
 This tests the log that is returned in an action invocation
 """
+
 import uuid
 from fastapi.testclient import TestClient
 from labthings_fastapi.thing_server import ThingServer

tests/test_action_logging.py

@@ -1,6 +1,7 @@
 """
 This tests the log that is returned in an action invocation
 """
+
 import logging
 from fastapi.testclient import TestClient
 from labthings_fastapi.thing_server import ThingServer

tests/test_blob_output.py

@@ -1,6 +1,7 @@
 """
 This tests Things that depend on other Things
 """
+
 import os
 from tempfile import TemporaryDirectory
 from fastapi.testclient import TestClient

tests/test_dependencies_2.py

@@ -13,6 +13,7 @@
 test things from FastAPI that obviously work, but I will leave them in here as
 mitigation against something changing in the future.
 """
+
 from typing import Annotated
 from fastapi import Depends, FastAPI
 from fastapi.testclient import TestClient

tests/test_dependency_metadata.py

@@ -1,6 +1,7 @@
 """
 This tests metadata retrieval, as used by e.g. the camera for EXIF info
 """
+
 from typing import Any, Mapping
 from fastapi.testclient import TestClient
 from labthings_fastapi.thing_server import ThingServer

tests/test_thing_dependencies.py

@@ -1,6 +1,7 @@
 """
 This tests Things that depend on other Things
 """
+
 import inspect
 from fastapi.testclient import TestClient
 from fastapi import Request