Add __repr__ for classes to appear in log messages

Author: GDYendell

src/fastcs/attributes.py

@@ -128,6 +128,9 @@ def update_datatype(self, datatype: DataType[T]) -> None:
         for callback in self._update_datatype_callbacks:
             callback(datatype)
 
+    def __repr__(self):
+        return f"{self.__class__.__name__}({self._datatype})"
+
 
 class AttrR(Attribute[T]):
     """A read-only ``Attribute``."""

src/fastcs/controller.py

@@ -122,6 +122,11 @@ def register_sub_controller(self, name: str, sub_controller: SubController):
     def get_sub_controllers(self) -> dict[str, SubController]:
         return self.__sub_controller_tree
 
+    def __repr__(self):
+        return f"""\
+{type(self).__name__}({self.path}, {list(self.__sub_controller_tree.keys())})\
+"""
+
 
 class Controller(BaseController):
     """Top-level controller for a device.

src/fastcs/controller_api.py

@@ -29,3 +29,8 @@ def walk_api(self) -> Iterator["ControllerAPI"]:
         yield self
         for api in self.sub_apis.values():
             yield from api.walk_api()
+
+    def __repr__(self):
+        return f"""\
+ControllerAPI(path={self.path}, sub_apis=[{", ".join(self.sub_apis.keys())}])\
+"""

src/fastcs/transport/epics/ca/transport.py

@@ -51,3 +51,6 @@ def context(self) -> dict[str, Any]:
             for command_name in softioc.command_names
             if command_name != "exit"
         }
+
+    def __repr__(self):
+        return f"EpicsCATransport({self._pv_prefix})"

src/fastcs/transport/epics/pva/transport.py

@@ -40,3 +40,6 @@ def create_docs(self) -> None:
 
     def create_gui(self) -> None:
         PvaEpicsGUI(self._controller_api, self._pv_prefix).create_gui(self.gui)
+
+    def __repr__(self):
+        return f"EpicsPVATransport({self._pv_prefix})"

src/fastcs/transport/graphql/transport.py

@@ -23,3 +23,6 @@ def initialise(
 
     async def serve(self) -> None:
         await self._server.serve(self.graphql)
+
+    def __repr__(self) -> str:
+        return f"GraphQLTransport({self.graphql.host}:{self.graphql.port})"

src/fastcs/transport/rest/transport.py

@@ -23,3 +23,6 @@ def initialise(
 
     async def serve(self) -> None:
         await self._server.serve(self.rest)
+
+    def __repr__(self) -> str:
+        return f"RestTransport({self.rest.host}:{self.rest.port})"