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
152 lines
5.7 KiB
Python
152 lines
5.7 KiB
Python
"""Generates meme images using the memegen.link API."""
|
|
|
|
from webex_bot.models.command import Command
|
|
from webex_bot.models.response import Response, response_from_adaptive_card
|
|
from webexteamssdk.models.cards import (
|
|
AdaptiveCard,
|
|
Choice,
|
|
Choices,
|
|
Column,
|
|
ColumnSet,
|
|
FontSize,
|
|
FontWeight,
|
|
Text,
|
|
TextBlock,
|
|
)
|
|
from webexteamssdk.models.cards.actions import OpenUrl, Submit
|
|
|
|
from app import img
|
|
|
|
TEMPLATES = img.get_templates()
|
|
|
|
|
|
class MakeMemeCommand(Command):
|
|
"""Class for initial Webex interactive card."""
|
|
|
|
def __init__(self) -> None:
|
|
"""Initialize the MakeMemeCommand with command keyword and help message."""
|
|
super().__init__(
|
|
command_keyword="/meme",
|
|
help_message="Make a Meme",
|
|
chained_commands=[MakeMemeCallback()],
|
|
delete_previous_message=True,
|
|
)
|
|
|
|
def pre_execute(self, message, attachment_actions, activity) -> None: # pylint: disable=unused-argument
|
|
"""Pre-execution logic for the MakeMemeCommand."""
|
|
return
|
|
|
|
def execute(self, message, attachment_actions, activity) -> Response: # pylint: disable=unused-argument
|
|
"""Execute the MakeMemeCommand and return an adaptive card."""
|
|
card_body: list = [
|
|
ColumnSet(
|
|
columns=[
|
|
Column(
|
|
width=1,
|
|
items=[
|
|
TextBlock(
|
|
"Make a Meme",
|
|
weight=FontWeight.BOLDER,
|
|
size=FontSize.MEDIUM,
|
|
),
|
|
TextBlock(
|
|
"This bot uses memegen.link to generate memes. Click 'View Templates' to view available templates.", # pylint: disable=line-too-long
|
|
weight=FontWeight.LIGHTER,
|
|
size=FontSize.SMALL,
|
|
wrap=True,
|
|
),
|
|
TextBlock(
|
|
"Both fields are required. If you do not want to specify a value, please type a space.", # pylint: disable=line-too-long
|
|
weight=FontWeight.LIGHTER,
|
|
size=FontSize.SMALL,
|
|
wrap=True,
|
|
),
|
|
],
|
|
),
|
|
]
|
|
),
|
|
ColumnSet(
|
|
columns=[
|
|
Column(
|
|
width=1,
|
|
items=[
|
|
Choices(
|
|
id="meme_type",
|
|
isMultiSelect=False,
|
|
choices=[Choice(title=x["name"], value=x["choiceval"]) for x in TEMPLATES],
|
|
),
|
|
Text(id="text_top", placeholder="Top Text", maxLength=100),
|
|
Text(
|
|
id="text_bottom",
|
|
placeholder="Bottom Text",
|
|
maxLength=100,
|
|
),
|
|
],
|
|
),
|
|
]
|
|
),
|
|
]
|
|
|
|
card: AdaptiveCard = AdaptiveCard(
|
|
body=card_body,
|
|
actions=[
|
|
Submit(
|
|
title="Go!",
|
|
data={"callback_keyword": "make_meme_callback_rbamzfyx"},
|
|
),
|
|
OpenUrl(url="https://memegen.link/#templates", title="View Templates"),
|
|
Submit(title="Cancel", data={"command_keyword": "exit"}),
|
|
],
|
|
)
|
|
return response_from_adaptive_card(card)
|
|
|
|
|
|
class MakeMemeCallback(Command):
|
|
"""Class to process user data and return meme."""
|
|
|
|
def __init__(self) -> None:
|
|
"""Initialize the MakeMemeCallback with command keyword and help message."""
|
|
super().__init__(
|
|
card_callback_keyword="make_meme_callback_rbamzfyx",
|
|
delete_previous_message=True,
|
|
)
|
|
self.error: bool = False
|
|
self.text_top: str = ""
|
|
self.text_bottom: str = ""
|
|
self.meme: str = ""
|
|
self.meme_filename: str = ""
|
|
|
|
def pre_execute(self, message, attachment_actions, activity) -> str: # pylint: disable=unused-argument
|
|
"""Pre-execution logic for the MakeMemeCallback."""
|
|
self.meme: str = attachment_actions.inputs.get("meme_type")
|
|
self.text_top: str = attachment_actions.inputs.get("text_top")
|
|
self.text_bottom: str = attachment_actions.inputs.get("text_bottom")
|
|
|
|
if not self.text_top and not self.text_bottom:
|
|
self.error = True
|
|
return "Please provide at least one positional text argument."
|
|
|
|
if ".gif" in self.meme:
|
|
return "Generating your meme. GIF-based memes take a little longer. Please wait..."
|
|
|
|
return "Generating your meme..."
|
|
|
|
def execute(self, message, attachment_actions, activity) -> Response | None: # pylint: disable=unused-argument
|
|
"""Execute the MakeMemeCallback and return a response with the meme image."""
|
|
if self.error:
|
|
return None
|
|
|
|
self.meme_filename: str = img.generate_api_url(self.meme, self.text_top, self.text_bottom)
|
|
msg: Response = Response(
|
|
attributes={
|
|
"roomId": activity["target"]["globalId"],
|
|
"parentId": "",
|
|
"files": [self.meme_filename],
|
|
}
|
|
)
|
|
return msg
|
|
|
|
def post_execute(self, message, attachment_actions, activity) -> None: # pylint: disable=unused-argument
|
|
"""Post-execution logic for the MakeMemeCallback."""
|
|
return
|