Merge pull request #214 from labthings/rename-endpoint

Rename fastapi_endpoint to endpoint

Author: rwb27

src/labthings_fastapi/__init__.py

@@ -24,7 +24,7 @@
 from .thing_server_interface import ThingServerInterface
 from .properties import property, setting, DataProperty, DataSetting
 from .actions import action
-from .endpoints import fastapi_endpoint
+from .endpoints import endpoint
 from . import deps
 from . import outputs
 from .outputs import blob
@@ -52,7 +52,7 @@
     "DataSetting",
     "action",
     "thing_slot",
-    "fastapi_endpoint",
+    "endpoint",
     "deps",
     "outputs",
     "blob",

src/labthings_fastapi/endpoints.py

@@ -9,7 +9,7 @@
 arguments through to the relevant `fastapi` decorator.
 
 This will most usually be applied as a decorator with arguments, available
-as :deco:`.fastapi_endpoint`. See the documentation for that function for
+as :deco:`.endpoint`. See the documentation for that function for
 more detail.
 """
 
@@ -34,7 +34,7 @@
     from .thing import Thing
 
 HTTPMethod = Literal["get", "post", "put", "delete"]
-"""Valid HTTP verbs to use with `.fastapi_endpoint` or `.EndpointDescriptor`."""
+"""Valid HTTP verbs to use with `.endpoint` or `.EndpointDescriptor`."""
 
 
 class EndpointDescriptor(BaseDescriptor):
@@ -49,7 +49,7 @@ def __init__(
     ) -> None:
         r"""Initialise an EndpointDescriptor.
 
-        See `.fastapi_endpoint`, which is the usual way of instantiating this
+        See `.endpoint`, which is the usual way of instantiating this
         class.
 
         :param func: is the method (defined on a `.Thing`) wrapped by this
@@ -107,19 +107,19 @@ def add_to_fastapi(self, app: FastAPI, thing: Thing) -> None:
                 "path set on the Thing. This usually means it is not connected "
                 "to a ThingServer."
             )
-        # fastapi_endpoint is equivalent to app.get/app.post/whatever
-        fastapi_endpoint = getattr(app, self.http_method)
+        # endpoint is equivalent to app.get/app.post/whatever
+        endpoint = getattr(app, self.http_method)
         bound_function = partial(self.func, thing)
         # NB the line above can't use self.__get__ as wraps() confuses FastAPI
         kwargs: dict[str, Any] = {  # Auto-populate description and summary
             "description": f"## {self.title}\n\n {self.description}",
             "summary": self.title,
         }
         kwargs.update(self.kwargs)
-        fastapi_endpoint(thing.path + self.path, **kwargs)(bound_function)
+        endpoint(thing.path + self.path, **kwargs)(bound_function)
 
 
-def fastapi_endpoint(
+def endpoint(
     method: HTTPMethod, path: Optional[str] = None, **kwargs: Any
 ) -> Callable[[Callable], EndpointDescriptor]:
     r"""Mark a function as a FastAPI endpoint without making it an action.
@@ -140,7 +140,7 @@ def fastapi_endpoint(
     .. code-block:: python
 
         class DownloadThing(Thing):
-            @fastapi_endpoint("get")
+            @endpoint("get")
             def plain_text_response(self) -> str:
                 return "example string"
 

tests/test_endpoint_decorator.py

@@ -9,15 +9,15 @@ class PostBodyModel(BaseModel):
 
 
 class MyThing(lt.Thing):
-    @lt.fastapi_endpoint("get")
+    @lt.endpoint("get")
     def path_from_name(self) -> str:
         return "path_from_name"
 
-    @lt.fastapi_endpoint("get", path="path_from_path")
+    @lt.endpoint("get", path="path_from_path")
     def get_method(self) -> str:
         return "get_method"
 
-    @lt.fastapi_endpoint("post", path="path_from_path")
+    @lt.endpoint("post", path="path_from_path")
     def post_method(self, body: PostBodyModel) -> str:
         return f"post_method {body.a} {body.b}"