Luke Tainton
13097b36fb
This pull request focuses on improving the documentation and readability of the Webex meme bot application by adding docstrings and minor formatting adjustments. Here's a breakdown of the changes:
* **Docstrings:**
* Added module-level docstrings to `app/close.py`, `app/img.py`, and `app/main.py` providing a high-level overview of the purpose of each module.
* Added docstrings to classes (`ExitCommand`, `MakeMemeCommand`, `MakeMemeCallback`) describing their role.
* Added docstrings to methods within those classes (`__init__`, `pre_execute`, `execute`, `post_execute`) explaining their functionality, arguments, and return values where applicable. The `get_templates` and `format_meme_string` functions in `app/img.py` have been documented as well.
* **Formatting:**
* Added a line break before the return type annotation in function definitions (e.g., `def execute(...) -> Response:`).
* Added the disable comment `# pylint: disable=line-too-long` to a line in `app/meme.py` to disable pylint for that line.
* Added the disable comment `# pylint: disable=unused-argument` to the `pre_execute`, `execute`, and `post_execute` methods to disable pylint checks about unused arguments. This is because these methods are part of an interface and must have the same signature even if some arguments are unused.
* **Variable Naming:**
* Renamed the `vars` dictionary to `env_vars` in `tests/test_config.py` for better clarity.
* **Test Update:**
* Added a docstring to the `test_config` function in `tests/test_config.py` to explain its functionality.
* **Imports Update:**
* Updated imports in `tests/test_config.py` to disable pylint for wrong-import-position errors using `# pylint: disable=wrong-import-position`.
In essence, these changes enhance the maintainability and understandability of the codebase through comprehensive documentation and minor code style improvements.
Reviewed-on: #487
29 lines
1.0 KiB
Python
29 lines
1.0 KiB
Python
"""Command module for handling the 'exit' command in the Webex meme bot."""
|
|
|
|
from webex_bot.models.command import Command
|
|
|
|
|
|
class ExitCommand(Command):
|
|
"""Command to handle the 'exit' command in the Webex meme bot."""
|
|
|
|
def __init__(self) -> None:
|
|
"""Initialize the ExitCommand with command keyword and help message."""
|
|
super().__init__(
|
|
command_keyword="exit",
|
|
help_message="Exit",
|
|
delete_previous_message=True,
|
|
)
|
|
self.sender: str = ""
|
|
|
|
def pre_execute(self, message, attachment_actions, activity) -> None: # pylint: disable=unused-argument
|
|
"""Pre-execution logic for the exit command."""
|
|
return
|
|
|
|
def execute(self, message, attachment_actions, activity) -> None: # pylint: disable=unused-argument
|
|
"""Execute the exit command."""
|
|
return
|
|
|
|
def post_execute(self, message, attachment_actions, activity) -> None: # pylint: disable=unused-argument
|
|
"""Post-execution logic for the exit command."""
|
|
return
|