moved defining module help to the parent Module class

modules/HelpModule.py

@@ -15,7 +15,6 @@
 from textwrap import dedent
 
 from modules.module import IntegrationTest, Module, Response
-from utilities.help_utils import ModuleHelp
 from utilities.serviceutils import ServiceMessage
 
 
@@ -29,7 +28,6 @@ class HelpModule(Module):
 
     def __init__(self):
         super().__init__()
-        self.help = ModuleHelp.from_docstring(self.class_name, __doc__)
         self.re_help = re.compile(r"help \w+", re.I)
 
     def process_message(self, message: ServiceMessage) -> Response:

modules/module.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass, field
+import inspect
 import re
 import random
 from typing import Callable, Iterable, Literal, Optional, TypedDict, Union
@@ -130,23 +131,12 @@ class Module:
     we show it to each module and ask if it can process the message,
     then give it to the module that's most confident"""
 
-    # def make_module_help(
-    #     self,
-    #     descr: Optional[str] = None,
-    #     capabilities: Optional[CapabilitiesDict] = None,
-    # ) -> ModuleHelp:
-    #     return ModuleHelp(
-    #         module_name=self.class_name,
-    #         descr=descr,
-    #         capabilities=capabilities or {},
-    #         docstring=__doc__,
-    #     )
-
     def __init__(self):
         self.utils = Utilities.get_instance()
         self.log = get_logger()
         self.re_replace = re.compile(r".*?({{.+?}})")
-        self.help = ModuleHelp.from_docstring(self.class_name, __doc__)
+        module_docstring = inspect.getmodule(self).__doc__
+        self.help = ModuleHelp.from_docstring(self.class_name, module_docstring)
 
     def process_message(self, message: ServiceMessage) -> Response:
         """Handle the message, return a string which is your response.

modules/question_setter.py

@@ -53,7 +53,6 @@
 from config import ENVIRONMENT_TYPE, coda_api_token
 from modules.module import IntegrationTest, Module, Response
 from utilities.discordutils import DiscordChannel
-from utilities.help_utils import ModuleHelp
 from utilities.serviceutils import ServiceMessage
 from utilities.utilities import (
     has_permissions,
@@ -96,7 +95,6 @@ def __init__(self) -> None:
             raise Exception(exc_msg)
 
         super().__init__()
-        self.help = ModuleHelp.from_docstring(self.class_name, __doc__)
         self.coda_api = CodaAPI.get_instance()
 
         self.msg_id2gdoc_links: dict[str, list[str]] = {}

modules/questions.py

@@ -46,7 +46,6 @@
     meta_editing_channel_id,
 )
 from modules.module import Module, Response
-from utilities.help_utils import ModuleHelp
 from utilities.utilities import (
     has_permissions,
     is_in_testing_mode,
@@ -87,7 +86,6 @@ def __init__(self) -> None:
             raise Exception(exc_msg)
 
         super().__init__()
-        self.help = ModuleHelp.from_docstring(self.class_name, __doc__)
         self.coda_api = CodaAPI.get_instance()
 
         ###################

modules/testModule.py

@@ -38,7 +38,6 @@
 from modules.module import IntegrationTest, Module, Response
 from servicemodules.serviceConstants import Services
 from utilities import get_question_id, is_test_response
-from utilities.help_utils import ModuleHelp
 from utilities.serviceutils import ServiceMessage
 from utilities.utilities import is_bot_dev
 
@@ -65,7 +64,6 @@ class TestModule(Module):
 
     def __init__(self):
         super().__init__()
-        self.help = ModuleHelp.from_docstring(self.class_name, __doc__)
         self.sent_test: list[IntegrationTest] = []
 
     def process_message(self, message: ServiceMessage) -> Response:

utilities/help_utils.py

@@ -20,12 +20,6 @@ class ModuleHelp:
     The **main segment** contains an obligatory short module description (`descr`) and an optional, longer module description (`longdescr`).
     The main segment is followed by one or more **command segments**, each describing one specific command or a set of related commands:
     what they do and how to use them. A detailed specification of command segments can be found in the docstring of the `CommandHelp` class.
-
-    ### How to add `help` to `Module`
-
-    ```py
-    self.help = ModuleHelp.from_docstring(self.class_name, __doc__)
-    ```
     """
 
     module_name: str