fix(lint): Fix linting issues (#487)
Some checks failed
Security / sonarqube (push) Failing after 36s
Security / snyk (push) Successful in 1m1s

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
This commit is contained in:
2025-06-06 19:39:11 +02:00
parent 590e0941bf
commit 13097b36fb
8 changed files with 76 additions and 32 deletions

View File

@ -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"]