Merge pull request #2569 from half-duplex/cap-req-reg-log

plugin: add capability.__str__ for better logs

sopel/plugin.py

@@ -273,6 +273,13 @@ def __init__(
         self._cap_req: tuple[str, ...] = tuple(sorted(cap_req))
         self._handler: Optional[CapabilityHandler] = handler
 
+    def __str__(self) -> str:
+        caps = ", ".join(repr(cap) for cap in self._cap_req)
+        handler = ""
+        if self._handler and hasattr(self._handler, "__name__"):
+            handler = " ({}())".format(self._handler.__name__)
+        return "<capability {}{}>".format(caps, handler)
+
     @property
     def cap_req(self) -> tuple[str, ...]:
         """Capability request as a sorted tuple.

sopel/plugins/capabilities.py

@@ -233,7 +233,7 @@ def register(self, plugin_name: str, request: capability) -> None:
         plugin_caps[plugin_name] = (
             request, False,
         )
-        LOGGER.debug('Capability Request registered: %s', str(request))
+        LOGGER.debug('Capability Request registered: %s', request)
 
     def request_available(
         self,

test/test_plugin.py

@@ -33,6 +33,19 @@ def test_capability(cap_ack_wrapped):
     assert result == (True, None)
 
 
+def test_capability_as_string():
+    handler = plugin.capability('batch')
+    assert str(handler).startswith('<capability')
+    assert str(handler).endswith("'batch'>")
+
+    def _batch_callback(cap_req, bot, acknowledged):
+        ...
+
+    handler = plugin.capability('batch', handler=_batch_callback)
+
+    assert '(_batch_callback())' in str(handler)
+
+
 def test_capability_handler_define_once():
     @plugin.capability('away-notify')
     def handler(name, bot, acknowledged):