diff --git a/.gitea/workflows/ci.yml b/.gitea/workflows/ci.yml index 7852933..b9c3e2a 100644 --- a/.gitea/workflows/ci.yml +++ b/.gitea/workflows/ci.yml @@ -40,11 +40,15 @@ jobs: - name: Install dependencies run: uv sync + + # - name: Lint + # run: | + # uv run pylint --fail-under=8 --recursive=yes --output-format=parseable --output=lintreport.txt app/ tests/ + # cat lintreport.txt - name: Lint run: | - uv run pylint --fail-under=8 --recursive=yes --output-format=parseable app/ tests/ # --output=lintreport.txt - cat lintreport.txt + uv run pylint --fail-under=8 --recursive=yes --output-format=parseable app/ tests/ - name: Unit Test run: | diff --git a/app/close.py b/app/close.py index 304369c..390471d 100644 --- a/app/close.py +++ b/app/close.py @@ -1,8 +1,13 @@ +"""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", @@ -10,11 +15,14 @@ class ExitCommand(Command): ) self.sender: str = "" - def pre_execute(self, message, attachment_actions, activity) -> None: + 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: + 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: + def post_execute(self, message, attachment_actions, activity) -> None: # pylint: disable=unused-argument + """Post-execution logic for the exit command.""" return diff --git a/app/img.py b/app/img.py index 6a5e19f..a513f21 100644 --- a/app/img.py +++ b/app/img.py @@ -1,3 +1,5 @@ +"""Generates meme images using the memegen.link API.""" + import requests CHAR_REPLACEMENTS: list = [ @@ -17,6 +19,11 @@ CHAR_REPLACEMENTS: list = [ def get_templates() -> list[dict]: + """Fetches available meme templates from the memegen.link API. + + Returns: + list[dict]: A list of dictionaries containing meme template information. + """ url: str = "https://api.memegen.link/templates" req: requests.Response = requests.get(url=url, timeout=10) req.raise_for_status() @@ -40,6 +47,14 @@ def get_templates() -> list[dict]: def format_meme_string(input_string: str) -> str: + """Formats a string for use in a meme image URL. + + Args: + input_string (str): The string to format. + + Returns: + str: The formatted string suitable for meme image URLs. + """ # https://memegen.link/#special-characters out_string: str = input_string for char_replacement in CHAR_REPLACEMENTS: @@ -48,6 +63,16 @@ def format_meme_string(input_string: str) -> str: def generate_api_url(template: str, top_str: str, btm_str: str) -> str: + """Generates a meme image URL using the memegen.link API. + + Args: + template (str): The template identifier in the format "name.ext". + top_str (str): The text for the top line of the meme. + btm_str (str): The text for the bottom line of the meme. + + Returns: + str: The complete URL for the meme image. + """ tmpl_name: str tmpl_ext: str tmpl_name, tmpl_ext = template.split(".") @@ -55,7 +80,5 @@ def generate_api_url(template: str, top_str: str, btm_str: str) -> str: top_str = format_meme_string(top_str) btm_str = format_meme_string(btm_str) - url: str = ( - f"https://api.memegen.link/images/{tmpl_name}/{top_str}/{btm_str}.{tmpl_ext}" - ) + url: str = f"https://api.memegen.link/images/{tmpl_name}/{top_str}/{btm_str}.{tmpl_ext}" return url diff --git a/app/main.py b/app/main.py index d8bd01f..13c299b 100644 --- a/app/main.py +++ b/app/main.py @@ -1,5 +1,7 @@ #!/usr/local/bin/python3 +"""Main entry point for the Webex Bot application.""" + from webex_bot.webex_bot import WebexBot from app import close, meme @@ -18,6 +20,7 @@ def create_bot() -> WebexBot: def main() -> None: + """Main function to run the Webex Bot.""" bot: WebexBot = create_bot() bot.add_command(meme.MakeMemeCommand()) bot.add_command(close.ExitCommand()) diff --git a/app/meme.py b/app/meme.py index dc25e31..95ad893 100644 --- a/app/meme.py +++ b/app/meme.py @@ -1,3 +1,5 @@ +"""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 ( @@ -22,6 +24,7 @@ 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", @@ -29,10 +32,12 @@ class MakeMemeCommand(Command): delete_previous_message=True, ) - def pre_execute(self, message, attachment_actions, activity) -> None: + 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: + 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=[ @@ -45,13 +50,13 @@ class MakeMemeCommand(Command): size=FontSize.MEDIUM, ), TextBlock( - "This bot uses memegen.link to generate memes. Click 'View Templates' to view available templates.", + "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.", + "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, @@ -68,10 +73,7 @@ class MakeMemeCommand(Command): Choices( id="meme_type", isMultiSelect=False, - choices=[ - Choice(title=x["name"], value=x["choiceval"]) - for x in TEMPLATES - ], + choices=[Choice(title=x["name"], value=x["choiceval"]) for x in TEMPLATES], ), Text(id="text_top", placeholder="Top Text", maxLength=100), Text( @@ -103,6 +105,7 @@ 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, @@ -113,7 +116,8 @@ class MakeMemeCallback(Command): self.meme: str = "" self.meme_filename: str = "" - def pre_execute(self, message, attachment_actions, activity) -> 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") @@ -127,13 +131,12 @@ class MakeMemeCallback(Command): return "Generating your meme..." - def execute(self, message, attachment_actions, activity) -> Response | None: + 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 - ) + self.meme_filename: str = img.generate_api_url(self.meme, self.text_top, self.text_bottom) msg: Response = Response( attributes={ "roomId": activity["target"]["globalId"], @@ -143,5 +146,6 @@ class MakeMemeCallback(Command): ) return msg - def post_execute(self, message, attachment_actions, activity) -> None: + def post_execute(self, message, attachment_actions, activity) -> None: # pylint: disable=unused-argument + """Post-execution logic for the MakeMemeCallback.""" return diff --git a/pyproject.toml b/pyproject.toml index aa42eee..b57f890 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -32,3 +32,6 @@ includes = [] [build-system] requires = ["pdm-backend"] build-backend = "pdm.backend" + +[tool.black] +line-length = 120 diff --git a/tests/test_config.py b/tests/test_config.py index 2cf5fc4..e35082a 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -2,19 +2,22 @@ import os -vars: dict = { +env_vars: dict = { "APP_VERSION": "dev", "WEBEX_API_KEY": "testing", } -for var, value in vars.items(): +for var, value in env_vars.items(): os.environ[var] = value # needs to be imported AFTER environment variables are set -from app.config import config # pragma: no cover # noqa: E402 +from app.config import ( + config, +) # pylint: disable=wrong-import-position # pragma: no cover # noqa: E402 def test_config() -> None: - assert config.webex_token == vars["WEBEX_API_KEY"] - assert config.version == vars["APP_VERSION"] + """Test the configuration settings.""" + assert config.webex_token == env_vars["WEBEX_API_KEY"] + assert config.version == env_vars["APP_VERSION"] diff --git a/tests/test_meme.py b/tests/test_meme.py index 3c0a878..28d8aa5 100644 --- a/tests/test_meme.py +++ b/tests/test_meme.py @@ -29,8 +29,4 @@ def test_error_false() -> None: callback.text_top = "TEST" callback.text_bottom = "TEST" result: Response = callback.execute(None, None, {"target": {"globalId": "TEST"}}) - assert ( - isinstance(result, Response) - and result.roomId == "TEST" - and result.files[0] == callback.meme_filename - ) + assert isinstance(result, Response) and result.roomId == "TEST" and result.files[0] == callback.meme_filename