andreas/heartbeat
Public Access
1
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases 44 Wiki Activity

fix: document skip_reason in Plugin docstring; remove unused import in test

Browse Source
This commit is contained in:
Andreas Wrede
2026-04-25 16:10:35 +02:00
parent aeb78dcb8e
commit c9c2ed772f
2 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
hbd/client/plugin.py
+2 -1
View File
@@ -22,13 +22,14 @@ from typing import Any, Dict, List, Optional, Type
class Plugin(ABC): class Plugin(ABC):
"""Base class for all plugins. """Base class for all plugins.
Attributes: Attributes:
name: Unique plugin identifier (e.g., "os_info", "cpu_monitor") name: Unique plugin identifier (e.g., "os_info", "cpu_monitor")
version: Plugin version string version: Plugin version string
description: Human-readable description description: Human-readable description
interval: Collection interval in seconds (0 for InfoPlugin = collect once) interval: Collection interval in seconds (0 for InfoPlugin = collect once)
enabled: Whether plugin is active (can be disabled via config) enabled: Whether plugin is active (can be disabled via config)
skip_reason: Optional[str] = None # Set before returning False from initialize() so loader logs INFO not WARNING
""" """
name: str = "" name: str = ""
tests/test_plugin.py
+1 -1
View File
@@ -2,7 +2,7 @@ import asyncio
import logging import logging
import textwrap import textwrap
from hbd.client.plugin import Plugin, PluginLoader, PluginRegistry from hbd.client.plugin import PluginLoader, PluginRegistry
def test_plugin_skip_reason_defaults_none(tmp_path): def test_plugin_skip_reason_defaults_none(tmp_path):