api: Add a display property to all components

src/mewbot/api/v1.py

@@ -25,6 +25,7 @@
 
 import abc
 import functools
+import inspect
 
 from mewbot.api.registry import ComponentRegistry
 from mewbot.core import (
@@ -52,6 +53,32 @@ class Component(metaclass=ComponentRegistry):
 
     _id: str
 
+    def help(self) -> str:
+        """
+        Returns a human-readable help string for this Component.
+        """
+        return inspect.getsource(type(self))
+
+    def display_name(self) -> str:
+        """
+        Return a human-readable display name for this Component.
+        """
+        return type(self).__name__
+
+    def description(self) -> str:
+        """
+        Return a human-readable description of this Component.
+        """
+        if (cand_str := type(self).__doc__) is not None:
+            return cand_str
+        return f"{self.display_name()} has no doc string set."
+
+    def status(self) -> str:
+        """
+        Returns a human-readable status string for this Component.
+        """
+        return f"Status for class {self.display_name()} is not defined."
+
     def serialise(self) -> ConfigBlock:
         """
         Create a Loader compatible configuration block for this Component.
@@ -158,6 +185,32 @@ class Input:
     def __init__(self) -> None:
         self.queue = None
 
+    def help(self) -> str:
+        """
+        Returns a human-readable help string for this Input.
+        """
+        return inspect.getsource(type(self))
+
+    def display_name(self) -> str:
+        """
+        Return a human-readable display name for this Input.
+        """
+        return type(self).__name__
+
+    def description(self) -> str:
+        """
+        Return a human-readable description of this Input.
+        """
+        if (cand_str := type(self).__doc__) is not None:
+            return cand_str
+        return f"{self.display_name()} has no doc string set."
+
+    def status(self) -> str:
+        """
+        Returns a human-readable status string for this Input.
+        """
+        return f"Status for class {self.display_name()} is not defined."
+
     @staticmethod
     @abc.abstractmethod
     def produces_inputs() -> set[type[InputEvent]]:
@@ -191,6 +244,32 @@ class Output:
     they can consume it.
     """
 
+    def help(self) -> str:
+        """
+        Returns a human-readable help string for this Output.
+        """
+        return inspect.getsource(type(self))
+
+    def display_name(self) -> str:
+        """
+        Return a human-readable display name for this Output.
+        """
+        return type(self).__name__
+
+    def description(self) -> str:
+        """
+        Return a human-readable description of this Output.
+        """
+        if (cand_str := type(self).__doc__) is not None:
+            return cand_str
+        return f"{self.display_name()} has no doc string set."
+
+    def status(self) -> str:
+        """
+        Returns a human-readable status string for this Output.
+        """
+        return f"Status for class {self.display_name()} is not defined."
+
     @staticmethod
     @abc.abstractmethod
     def consumes_outputs() -> set[type[OutputEvent]]: