Merge branch 'main' into update-copyright

Author: Bibo-Joshi

.github/workflows/test.yml

@@ -29,7 +29,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Start MongoDB
         if: ${{ matrix.os == 'ubuntu-latest' }}
-        uses: supercharge/mongodb-github-action@1.10.0
+        uses: supercharge/mongodb-github-action@1.11.0
         with:
           mongodb-version: latest
       - name: Install dependencies
@@ -67,7 +67,7 @@ jobs:
 
       - name: Test Summary
         id: test_summary
-        uses: test-summary/action@v2.2
+        uses: test-summary/action@v2.4
         if: always()  # always run, even if tests fail
         with:
           paths: ".test-reports/*.xml"

.pre-commit-config.yaml

@@ -4,18 +4,18 @@ ci:
 
 repos:
 -   repo: https://github.com/psf/black
-    rev: 23.7.0
+    rev: 24.10.0
     hooks:
     -   id: black
         args:
         - --diff
         - --check
 -   repo: https://github.com/PyCQA/flake8
-    rev: 6.1.0
+    rev: 7.1.1
     hooks:
     -   id: flake8
 -   repo: https://github.com/PyCQA/pylint
-    rev: v3.0.0a6
+    rev: v3.3.2
     hooks:
     -   id: pylint
         name: pylint
@@ -25,18 +25,18 @@ repos:
         #  run pylint across multiple cpu cores to speed it up-
         - --jobs=0  # See https://pylint.pycqa.org/en/latest/user_guide/run.html?#parallel-execution to know more
 -   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.4.1
+    rev: v1.13.0
     hooks:
     -   id: mypy
         exclude: ^tests/
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v3.10.1
+    rev: v3.19.0
     hooks:
     -   id: pyupgrade
         args:
           - --py37-plus
 -   repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
     -   id: isort
         name: isort

ptbcontrib/log_forwarder/README.md

@@ -0,0 +1,21 @@
+# Logging handler for python-telegram-bot
+Extension to forward application logs to specific Telegram chats through a `logging.Handler` class.
+
+## Usage
+Initialize the log forwarder in a method that runs in the `post_init` hook of `Application`:
+
+```python
+async def on_startup(app: Application):
+    error_forwarder = LogForwarder(
+        app.bot, [CHAT_ID], log_levels=["ERROR", "WARNING"]
+    )
+    # Add handler to the root logger to apply to all other loggers
+    logging.getLogger().addHandler(error_forwarder)
+
+application: Application = (
+    ApplicationBuilder()
+    .token("BOT_TOKEN")
+    .post_init(on_startup)
+    .build()
+)
+```

ptbcontrib/log_forwarder/__init__.py

@@ -0,0 +1,26 @@
+# A library containing community-based extension for the python-telegram-bot library
+# Copyright (C) 2020-2024
+# The ptbcontrib developers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser Public License for more details.
+#
+# You should have received a copy of the GNU Lesser Public License
+# along with this program.  If not, see [http://www.gnu.org/licenses/].
+"""
+This module contains a subclass for the `logging.Handler`
+that forwards specific logs to Telegram chats.
+"""
+
+from .log_forwarder import LogForwarder
+
+__all__ = [
+    "LogForwarder",
+]

ptbcontrib/log_forwarder/log_forwarder.py

@@ -0,0 +1,72 @@
+# A library containing community-based extension for the python-telegram-bot library
+# Copyright (C) 2020-2024
+# The ptbcontrib developers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser Public License for more details.
+#
+# You should have received a copy of the GNU Lesser Public License
+# along with this program.  If not, see [http://www.gnu.org/licenses/].
+"""This module contains LogForwarder class"""
+
+from __future__ import annotations
+
+import asyncio
+import logging
+from collections.abc import Iterable
+
+from telegram.constants import ParseMode
+from telegram.ext import ExtBot
+
+
+class LogForwarder(logging.Handler):
+    """
+    Logging handler to forward specific logs to Telegram chats.
+    """
+
+    def __init__(
+        self,
+        bot: ExtBot,
+        chat_ids: Iterable[int],
+        parse_mode: ParseMode = ParseMode.MARKDOWN_V2,
+        log_levels: Iterable[str] = ("WARN", "ERROR"),
+    ):
+        super().__init__()
+        self._bot = bot
+        self._chat_ids = chat_ids
+        self._parse_mode = parse_mode
+        self._log_levels = log_levels
+        self._loop = asyncio.get_event_loop()
+
+    def format_tg_msg(self, text: str) -> str:
+        """
+        Formats the log message to be sent to Telegram.
+        Override this method to customize the message.
+        The default implementation applies the handler's formatter
+        and puts the result in a Markdown code block.
+        """
+
+        msg = "```\n" + text + "\n```"
+        return msg
+
+    def emit(self, record: logging.LogRecord) -> None:
+        try:
+            formatted = self.format(record)
+            msg = self.format_tg_msg(formatted)
+            if record.levelname in self._log_levels:
+                for chat_id in self._chat_ids:
+                    f = self._bot.send_message(
+                        chat_id=chat_id, text=msg, parse_mode=self._parse_mode
+                    )
+                    asyncio.run_coroutine_threadsafe(f, self._loop)
+        except RecursionError:  # https://bugs.python.org/issue36272
+            raise
+        except Exception:  # pylint: disable=W0703
+            self.handleError(record)

ptbcontrib/log_forwarder/requirements.txt

@@ -0,0 +1 @@
+python-telegram-bot>=20.0

ptbcontrib/ptb_jobstores/mongodb/mongodb.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python
+# pylint: disable=duplicate-code
 #
 # A library containing community-based extension for the python-telegram-bot library
 # Copyright (C) 2020-2025

ptbcontrib/ptb_jobstores/sqlalchemy/sqlalchemy.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python
+# pylint: disable=duplicate-code
 #
 # A library containing community-based extension for the python-telegram-bot library
 # Copyright (C) 2020-2025

tests/test_log_forwarder.py

@@ -0,0 +1,21 @@
+import logging
+from unittest.mock import MagicMock
+
+from telegram.constants import ParseMode
+
+from ptbcontrib.log_forwarder import LogForwarder
+
+
+async def test_log_forwarder():
+    root_logger = logging.getLogger()
+    chat_ids = [69420]
+    bot = MagicMock()
+    log_forwarder = LogForwarder(bot, chat_ids)
+    root_logger.addHandler(log_forwarder)
+
+    logger = logging.getLogger("test_logger")
+    logger.error("TEST")
+
+    bot.send_message.assert_called_with(
+        chat_id=69420, text="```\nTEST\n```", parse_mode=ParseMode.MARKDOWN_V2
+    )