Merge branch 'main' into tkp/docsfix

timkpaine · web-flow · commit 021ddb1b8374 · 2025-07-08T10:57:00.000-04:00
diff --git a/csp_bot/__init__.py b/csp_bot/__init__.py
@@ -1,11 +1,7 @@
 __version__ = "1.0.0"
 
 
-# reexport
-from csp_adapter_discord import DiscordAdapterConfig
-from csp_adapter_slack import SlackAdapterConfig
-from csp_adapter_symphony import SymphonyAdapterConfig
-
+from .backends import *
 from .bot import Bot
 from .bot_config import *
 from .commands import *
diff --git a/csp_bot/backends/__init__.py b/csp_bot/backends/__init__.py
@@ -0,0 +1,3 @@
+from .discord import *
+from .slack import *
+from .symphony import *
diff --git a/csp_bot/backends/discord.py b/csp_bot/backends/discord.py
@@ -0,0 +1,23 @@
+from csp import Struct
+from pydantic import BaseModel
+
+__all__ = (
+    "DiscordAdapterConfig",
+    "DiscordAdapterManager",
+    "DiscordMessage",
+    "mention_user_discord",
+)
+
+try:
+    from csp_adapter_discord import DiscordAdapterConfig, DiscordAdapterManager, DiscordMessage, mention_user as mention_user_discord
+except ImportError:
+
+    class DiscordAdapterConfig(BaseModel):
+        pass
+
+    DiscordAdapterManager = None
+
+    class DiscordMessage(Struct):
+        _ignore: str = ""
+
+    mention_user_discord = lambda x: x  # noqa: E731
diff --git a/csp_bot/backends/slack.py b/csp_bot/backends/slack.py
@@ -0,0 +1,24 @@
+from csp import Struct
+from pydantic import BaseModel
+
+__all__ = (
+    "SlackAdapterConfig",
+    "SlackAdapterManager",
+    "SlackMessage",
+    "mention_user_slack",
+)
+
+# reexport
+try:
+    from csp_adapter_slack import SlackAdapterConfig, SlackAdapterManager, SlackMessage, mention_user as mention_user_slack
+except ImportError:
+
+    class SlackAdapterConfig(BaseModel):
+        pass
+
+    SlackAdapterManager = None
+
+    class SlackMessage(Struct):
+        _ignore: str = ""
+
+    mention_user_slack = lambda x: x  # noqa: E731
diff --git a/csp_bot/backends/symphony.py b/csp_bot/backends/symphony.py
@@ -0,0 +1,27 @@
+from csp import Struct
+from pydantic import BaseModel
+
+__all__ = (
+    "SymphonyAdapterConfig",
+    "SymphonyAdapter",
+    "SymphonyMessage",
+    "Presence",
+    "mention_user_symphony",
+)
+
+# reexport
+try:
+    from csp_adapter_symphony import SymphonyAdapter, SymphonyAdapterConfig, SymphonyMessage, mention_user as mention_user_symphony
+    from csp_adapter_symphony.adapter import Presence
+except ImportError:
+
+    class SymphonyAdapterConfig(BaseModel):
+        pass
+
+    SymphonyAdapter = None
+    Presence = None
+
+    class SymphonyMessage(Struct):
+        _ignore: str = ""
+
+    mention_user_symphony = lambda x: x  # noqa: E731
diff --git a/csp_bot/bot.py b/csp_bot/bot.py
@@ -1,29 +1,35 @@
-import logging
 import re
 import threading
 import time
 from csv import reader
 from datetime import datetime, timedelta
 from io import StringIO
+from logging import getLogger
 from types import MappingProxyType
 from typing import Any, Dict, List, Optional, Set, Tuple, Union
 
 import csp
 from bs4 import BeautifulSoup, Tag
 from croniter import croniter
 from csp import Outputs, ts
-from csp_adapter_discord import DiscordAdapterManager, DiscordMessage as RawDiscordMessage
-from csp_adapter_slack import SlackAdapterManager, SlackMessage as RawSlackMessage
-from csp_adapter_symphony import SymphonyAdapter, SymphonyMessage as RawSymphonyMessage
-from csp_adapter_symphony.adapter import Presence
 from pydantic import PrivateAttr
 
+from .backends import (
+    DiscordAdapterManager,
+    DiscordMessage as RawDiscordMessage,
+    Presence,
+    SlackAdapterManager,
+    SlackMessage as RawSlackMessage,
+    SymphonyAdapter,
+    SymphonyMessage as RawSymphonyMessage,
+)
 from .bot_config import BotConfig
 from .commands import (
     BaseCommand,
     BaseCommandModel,
     HelpCommand,
     ScheduleCommand,
+    StatusCommand,
 )
 from .gateway import GatewayChannels, GatewayModule
 from .structs import (
@@ -34,7 +40,7 @@
 )
 from .utils import Backend
 
-log = logging.getLogger(__name__)
+log = getLogger(__name__)
 
 SLACK_ENTITY_REGEX = re.compile("<@.+?>")
 DISCORD_ENTITY_REGEX = re.compile("<@.+?>")
@@ -59,12 +65,18 @@ class Bot(GatewayModule):
 
     def connect(self, channels: GatewayChannels) -> None:
         if self.config.discord_config:
+            if DiscordAdapterManager is None:
+                raise ImportError("Discord adapter not installed. Please install csp-adapter-discord.")
             self._configs["discord"] = self.config.discord_config
             self._adapters["discord"] = DiscordAdapterManager(self.config.discord_config.adapter_config)
         if self.config.slack_config:
+            if SlackAdapterManager is None:
+                raise ImportError("Slack adapter not installed. Please install csp-adapter-slack.")
             self._configs["slack"] = self.config.slack_config
             self._adapters["slack"] = SlackAdapterManager(self.config.slack_config.adapter_config)
         if self.config.symphony_config:
+            if SymphonyAdapter is None:
+                raise ImportError("Symphony adapter not installed. Please install csp-adapter-symphony.")
             self._configs["symphony"] = self.config.symphony_config
             self._adapters["symphony"] = SymphonyAdapter(self.config.symphony_config.adapter_config)
 
@@ -198,10 +210,10 @@ def message_to_bot_commands(self, message: ts[Message]) -> Outputs(bot_commands=
                     log.info("Ignoring message (not to bot)")
                 else:
                     if not self.is_authorized(message):
-                        if self._config[message.backend].unauthorized_msg:
+                        if self._configs[message.backend].unauthorized_msg:
                             channel = message.channel if message.channel != "IM" else message.user
                             unauthorized_message = Message(
-                                msg=self._config[message.backend].unauthorized_msg, channel=channel, source=message.backend
+                                msg=self._configs[message.backend].unauthorized_msg, channel=channel, source=message.backend
                             )
                             csp.output(unauthorized_message=unauthorized_message)
                     else:
@@ -458,10 +470,14 @@ def extract_bot_commands(self, message: Message, channel: str, text: str, entiti
 
                 command_runner = self._commands[command]
 
+                # TODO generalize by interrogating the command signature
                 if isinstance(command_runner, ScheduleCommand):
                     # Special command, gets access to schedule of commands
                     return command_runner.preexecute(command_instance, self._scheduled, self)
-                return self._commands[command].preexecute(command_instance)
+                elif isinstance(command_runner, StatusCommand):
+                    # Special command, gets access to status of commands
+                    return command_runner.preexecute(command_instance, self)
+                return command_runner.preexecute(command_instance)
             else:
                 log.info(f"Defaulting to help command from message to bot with no command: {message}")
                 command_runner = self._commands["help"]
diff --git a/csp_bot/bot_config.py b/csp_bot/bot_config.py
@@ -1,11 +1,10 @@
 from typing import List, Optional, Union
 
 from ccflow import BaseModel
-from csp_adapter_discord import DiscordAdapterConfig
-from csp_adapter_slack import SlackAdapterConfig
-from csp_adapter_symphony import SymphonyAdapterConfig
 from pydantic import Field
 
+from .backends import DiscordAdapterConfig, SlackAdapterConfig, SymphonyAdapterConfig
+
 __all__ = (
     "BaseConfig",
     "BotConfig",
diff --git a/csp_bot/cli.py b/csp_bot/cli.py
@@ -1,4 +1,4 @@
-import logging
+from logging import getLogger
 from pprint import pprint
 
 import csp_gateway
@@ -8,7 +8,7 @@
 
 from csp_bot import __version__
 
-log = logging.getLogger(__name__)
+log = getLogger(__name__)
 
 __all__ = (
     "load",
diff --git a/csp_bot/commands/__init__.py b/csp_bot/commands/__init__.py
@@ -11,3 +11,4 @@
 from .echo import EchoCommand, EchoCommandModel
 from .help import HelpCommand, HelpCommandModel
 from .schedule import ScheduleCommand, ScheduleCommandModel
+from .status import StatusCommand, StatusCommandModel
diff --git a/csp_bot/commands/echo.py b/csp_bot/commands/echo.py
@@ -1,11 +1,11 @@
-import logging
+from logging import getLogger
 from typing import Optional, Type
 
 from csp_bot.structs import BotCommand, Message
 
 from .base import BaseCommand, BaseCommandModel, ReplyToOtherCommand
 
-log = logging.getLogger(__name__)
+log = getLogger(__name__)
 
 
 class EchoCommand(ReplyToOtherCommand):
diff --git a/csp_bot/commands/help.py b/csp_bot/commands/help.py
@@ -1,5 +1,5 @@
-import logging
 from html import escape, unescape
+from logging import getLogger
 from typing import Mapping, Type
 
 import pandas as pd
@@ -8,7 +8,7 @@
 
 from .base import BaseCommand, BaseCommandModel, ReplyCommand
 
-log = logging.getLogger(__name__)
+log = getLogger(__name__)
 
 
 class HelpCommand(ReplyCommand):
diff --git a/csp_bot/commands/schedule.py b/csp_bot/commands/schedule.py
@@ -1,5 +1,5 @@
-import logging
 from html import escape
+from logging import getLogger
 from typing import TYPE_CHECKING, Mapping, Type
 
 from croniter import CroniterBadCronError, croniter
@@ -12,7 +12,7 @@
 if TYPE_CHECKING:
     from csp_bot import Bot
 
-log = logging.getLogger(__name__)
+log = getLogger(__name__)
 
 
 class ScheduleCommand(ReplyCommand):
diff --git a/csp_bot/commands/status.py b/csp_bot/commands/status.py
@@ -0,0 +1,69 @@
+from datetime import datetime
+from getpass import getuser
+from logging import getLogger
+from socket import gethostname
+from threading import active_count
+from typing import TYPE_CHECKING, Optional, Type
+
+import psutil
+
+from csp_bot.structs import BotCommand, Message
+
+from .base import BaseCommand, BaseCommandModel, ReplyCommand
+
+if TYPE_CHECKING:
+    from csp_bot import Bot
+
+log = getLogger(__name__)
+
+_HOSTNAME = gethostname()
+_USER = getuser()
+
+
+class StatusCommand(ReplyCommand):
+    def command(self) -> str:
+        return "status"
+
+    def name(self) -> str:
+        return "status"
+
+    def help(self) -> str:
+        return "System information. Syntax: /status [/channel <channel>]"
+
+    def preexecute(self, command: BotCommand, bot_instance: "Bot") -> BotCommand:
+        # TODO: pull out everything except auth keys?
+        self._adapters = list(bot_instance._adapters.keys())
+        return command
+
+    def execute(self, command: BotCommand) -> Optional[Message]:
+        log.info(f"Status command: {command}")
+
+        message = ""
+
+        # Time information
+        message += f"Now\n\t{datetime.utcnow()}\n"
+
+        # Adapter information
+        message += f"Backends:\n\t{', '.join(self._adapters)}\n"
+
+        # Machine information
+        message += f"CPU\n\t{psutil.cpu_percent()}\n"
+        message += f"Memory\n\t{psutil.virtual_memory().percent}\n"
+        message += f"Memory Available\n\t{round(psutil.virtual_memory().available * 100 / psutil.virtual_memory().total, 2)}\n"
+        message += f"Host\n\t{_HOSTNAME}\n"
+        message += f"User\n\t{_USER}\n"
+
+        # Process and thread information
+        current_process = psutil.Process()
+        message += f"PID\n\t{current_process.pid}\n"
+        message += f"Active Threads\n\t{active_count()}\n"
+
+        return Message(
+            msg=message,
+            channel=command.channel,
+            backend=command.backend,
+        )
+
+
+class StatusCommandModel(BaseCommandModel):
+    command: Type[BaseCommand] = StatusCommand
diff --git a/csp_bot/config/__init__.py b/csp_bot/config/__init__.py
@@ -1,12 +1,12 @@
-import logging
+from logging import getLogger
 from pathlib import Path
 from typing import List, Optional
 
 from ccflow import RootModelRegistry, load_config as load_config_base
 
 from csp_bot import __version__
 
-log = logging.getLogger(__name__)
+log = getLogger(__name__)
 
 __all__ = ("load_config",)
 
diff --git a/csp_bot/config/commands.yaml b/csp_bot/config/commands.yaml
@@ -6,3 +6,6 @@ echo:
 
 schedule:
   _target_: csp_bot.commands.ScheduleCommandModel
+
+status:
+  _target_: csp_bot.commands.StatusCommandModel
diff --git a/csp_bot/config/conf.yaml b/csp_bot/config/conf.yaml
@@ -28,6 +28,7 @@ gateway:
     - /commands/help
     - /commands/echo
     - /commands/schedule
+    - /commands/status
   settings:
     PORT: ${port}
     AUTHENTICATE: ${authenticate}
diff --git a/csp_bot/gateway/gateway.py b/csp_bot/gateway/gateway.py
@@ -1,5 +1,5 @@
-import logging
 from functools import wraps
+from logging import getLogger
 from typing import List
 
 from csp import ts
@@ -16,7 +16,7 @@
 from csp_bot.commands import BaseCommandModel
 from csp_bot.structs import BotCommand, Message
 
-log = logging.getLogger(__name__)
+log = getLogger(__name__)
 
 
 class GatewayChannels(GatewayChannelsBase):
diff --git a/csp_bot/structs.py b/csp_bot/structs.py
diff --git a/csp_bot/utils.py b/csp_bot/utils.py
diff --git a/pyproject.toml b/pyproject.toml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+from .discord import *`
	`2`	`+from .slack import *`
	`3`	`+from .symphony import *`