aiogram-testing 1.2.0__tar.gz → 1.3.0__tar.gz

{aiogram_testing-1.2.0 → aiogram_testing-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aiogram-testing
-Version: 1.2.0
+Version: 1.3.0
 Summary: A library for testing your bots on aiogram
 License: MIT
 Author: k0te1ch
@@ -101,7 +101,28 @@ calls.assert_not_called(AnswerCallbackQuery)
 ```
 
 Accessing a method that was not called (`calls.edit_message_text`) raises `MethodIsNotCalledError`, an
-`AttributeError`, so `hasattr(calls, "edit_message_text")` works.
+`AttributeError`, so `hasattr(calls, "edit_message_text")` works. `calls.result` is what the dispatcher returned for
+the update (a handler's return value, or `UNHANDLED` when nothing matched).
+
+### Bot API answers and failures
+
+With `auto_mock_success` on (the default) the bot answers like Telegram would: `send_message` returns a `Message`
+with a fresh `message_id`, the target chat and the text; edits return the edited message (or `True` for inline
+messages); boolean methods return `True`; `get_me` returns the bot. Queue a specific answer or a failure with
+`add_result_for`; queued answers are used first, in order:
+
+```python
+from aiogram.exceptions import TelegramBadRequest, TelegramRetryAfter
+
+bot.add_result_for(SendMessage, ok=False, error_code=400, description="Bad Request: chat not found")
+bot.add_result_for(SendMessage, ok=False, error_code=429, description="Too Many Requests", retry_after=3)
+```
+
+aiogram raises `TelegramRetryAfter` only for a non-zero `retry_after`; with `0` the failure is a plain
+`TelegramAPIError`. Patch `asyncio.sleep` in the code under test if a retry should not actually wait.
+
+Code that talks to the bot outside the dispatcher (background jobs, notifiers) can use a `MockedBot` directly;
+`bot.calls` holds every call it made.
 
 ### Testing a whole router: `BotTester`
 

{aiogram_testing-1.2.0 → aiogram_testing-1.3.0}/README.md

@@ -79,7 +79,28 @@ calls.assert_not_called(AnswerCallbackQuery)
 ```
 
 Accessing a method that was not called (`calls.edit_message_text`) raises `MethodIsNotCalledError`, an
-`AttributeError`, so `hasattr(calls, "edit_message_text")` works.
+`AttributeError`, so `hasattr(calls, "edit_message_text")` works. `calls.result` is what the dispatcher returned for
+the update (a handler's return value, or `UNHANDLED` when nothing matched).
+
+### Bot API answers and failures
+
+With `auto_mock_success` on (the default) the bot answers like Telegram would: `send_message` returns a `Message`
+with a fresh `message_id`, the target chat and the text; edits return the edited message (or `True` for inline
+messages); boolean methods return `True`; `get_me` returns the bot. Queue a specific answer or a failure with
+`add_result_for`; queued answers are used first, in order:
+
+```python
+from aiogram.exceptions import TelegramBadRequest, TelegramRetryAfter
+
+bot.add_result_for(SendMessage, ok=False, error_code=400, description="Bad Request: chat not found")
+bot.add_result_for(SendMessage, ok=False, error_code=429, description="Too Many Requests", retry_after=3)
+```
+
+aiogram raises `TelegramRetryAfter` only for a non-zero `retry_after`; with `0` the failure is a plain
+`TelegramAPIError`. Patch `asyncio.sleep` in the code under test if a retry should not actually wait.
+
+Code that talks to the bot outside the dispatcher (background jobs, notifiers) can use a `MockedBot` directly;
+`bot.calls` holds every call it made.
 
 ### Testing a whole router: `BotTester`
 

aiogram_testing-1.3.0/aiogram_tests/__init__.py

@@ -0,0 +1,8 @@
+from .calls import Calls
+from .calls import CallsList
+from .mocked_bot import MockedBot
+from .requester import MockedRequester
+from .tester import BotTester
+
+__all__ = ["BotTester", "Calls", "CallsList", "MockedBot", "MockedRequester"]
+__version__ = "1.3.0"  # x-release-please-version

aiogram_testing-1.2.0/aiogram_tests/requester.py → aiogram_testing-1.3.0/aiogram_tests/calls.py

@@ -1,13 +1,11 @@
+from collections.abc import Iterable
 from collections.abc import Iterator
 from typing import Any
 from typing import TypeVar
 
 from aiogram.methods import TelegramMethod
-from aiogram.methods.base import Response
-from aiogram.methods.base import TelegramType
 
 from .exceptions import MethodIsNotCalledError
-from .handler.base import RequestHandler
 from .utils import camel_case2snake_case
 
 M = TypeVar("M", bound=TelegramMethod)
@@ -32,8 +30,11 @@ class Calls:
     the IDE and type checkers understand.
     """
 
-    def __init__(self, methods: list[TelegramMethod] | tuple = ()):
+    def __init__(self, methods: Iterable[TelegramMethod] = (), result: Any = None):
         self._methods = list(methods)
+        # What the dispatcher returned for the update: a handler's return value, UNHANDLED, True after an error
+        # handler...
+        self.result = result
         # Same list on every access: tests pop() from calls.send_message
         self._groups: dict[str, CallsList] = {}
         for m in self._methods:
@@ -84,47 +85,3 @@ class Calls:
         if calls:
             made = "\n".join(f"  {call!r}" for call in calls)
             raise AssertionError(f"{method.__name__} was called {len(calls)} time(s):\n{made}")
-
-
-class MockedRequester:
-    def __init__(self, request_handler: RequestHandler):
-        self._handler: RequestHandler = request_handler
-
-    async def query(self, *args, **kwargs) -> Calls:
-        self._check_arguments(*args, **kwargs)
-
-        methods = self._handler.bot.session.methods
-        already_made = len(methods)
-        await self._handler(*args, **kwargs)
-
-        return Calls(list(methods)[already_made:])
-
-    def add_result_for(
-        self,
-        method: type[TelegramMethod[TelegramType]],
-        ok: bool,
-        result: TelegramType = None,
-        description: str | None = None,
-        error_code: int = 200,
-        migrate_to_chat_id: int | None = None,
-        retry_after: int | None = None,
-    ) -> Response[TelegramType]:
-        response = self._handler.add_result_for(
-            method=method,
-            ok=ok,
-            result=result,
-            description=description,
-            error_code=error_code,
-            migrate_to_chat_id=migrate_to_chat_id,
-            retry_after=retry_after,
-        )
-        return response
-
-    def _check_arguments(self, *args, **kwargs) -> None:
-        build_update = getattr(self._handler, "build_update", None)
-        if build_update is None:
-            return
-        try:
-            build_update(*args, **kwargs)
-        except TypeError as e:
-            raise AttributeError(f"incorrect argument name. {e}") from e

{aiogram_testing-1.2.0 → aiogram_testing-1.3.0}/aiogram_tests/handler/handler.py

@@ -65,7 +65,7 @@ class TelegramEventObserverHandler(RequestHandler):
             await state.set_state(self._state)
             await state.update_data(**self._state_data)
 
-        await self.dp.feed_update(self.bot, update)
+        return await self.dp.feed_update(self.bot, update)
 
     def _get_state_context(self, update: types.Update) -> FSMContext:
         """

{aiogram_testing-1.2.0 → aiogram_testing-1.3.0}/aiogram_tests/mocked_bot.py

@@ -1,5 +1,10 @@
+import itertools
+import typing
 from collections import deque
 from collections.abc import AsyncGenerator
+from datetime import UTC
+from datetime import datetime
+from typing import Any
 
 from aiogram import Bot
 from aiogram.client.session.base import BaseSession
@@ -7,10 +12,13 @@ from aiogram.methods import TelegramMethod
 from aiogram.methods.base import Request
 from aiogram.methods.base import Response
 from aiogram.methods.base import TelegramType
+from aiogram.types import Chat
+from aiogram.types import Message
 from aiogram.types import ResponseParameters
 from aiogram.types import User
 from aiogram.types.base import UNSET_TYPE
 
+from .calls import Calls
 from .exceptions import MockedResponseMissingError
 
 DEFAULT_AUTO_MOCK_SUCCESS = True
@@ -47,6 +55,9 @@ class MockedSession(BaseSession):
         request = Request(method=method.__api_method__, data=method.__dict__, files=None)
         self.requests.append(request)
         self.methods.append(method)
+        if not self.responses and getattr(bot, "auto_mock_success", False):
+            # Answer at request time, so a failure queued earlier is never followed by a stale success
+            bot.add_result_for(type(method), ok=True, result=bot.default_result(method))
         if not self.responses:
             raise MockedResponseMissingError(
                 f"no mocked response for {method.__api_method__}: call "
@@ -79,6 +90,7 @@ class MockedBot(Bot):
             language_code="ru",
         )
         self.auto_mock_success = auto_mock_success
+        self._message_ids = itertools.count(1)
 
     def add_result_for(
         self,
@@ -103,10 +115,39 @@ class MockedBot(Bot):
         self.session.add_result(response)
         return response
 
-    async def __call__(self, method: TelegramMethod, request_timeout: int | None = None):
-        if self.auto_mock_success:
-            self.add_result_for(method.__class__, ok=True)
-        return await super().__call__(method, request_timeout)
+    @property
+    def calls(self) -> Calls:
+        """
+        Every Bot API call this bot made, including ones outside the dispatcher (background jobs, notifiers)
+        """
+
+        return Calls(self.session.methods)
+
+    def default_result(self, method: TelegramMethod) -> Any:
+        """
+        What Telegram would plausibly answer to ``method`` when no result was queued: the sent or edited message
+        for message methods, ``True`` for boolean ones, the bot itself for ``getMe``
+        """
+
+        returning = method.__returning__
+        options = typing.get_args(returning) or (returning,)
+        if User in options:
+            return self._me
+        if Message in options and getattr(method, "inline_message_id", None) is None:
+            chat_id = getattr(method, "chat_id", None)
+            return Message(
+                message_id=getattr(method, "message_id", None) or next(self._message_ids),
+                date=datetime.now(UTC),
+                chat=Chat(id=chat_id if isinstance(chat_id, int) else -1, type="private"),
+                from_user=self._me,
+                text=getattr(method, "text", None),
+                caption=getattr(method, "caption", None),
+            )
+        if bool in options:
+            return True
+        if typing.get_origin(returning) is list:
+            return []
+        return None
 
     def get_request(self) -> Request:
         return self.session.get_request()

aiogram_testing-1.3.0/aiogram_tests/requester.py

@@ -0,0 +1,53 @@
+from aiogram.methods import TelegramMethod
+from aiogram.methods.base import Response
+from aiogram.methods.base import TelegramType
+
+from .calls import Calls
+from .calls import CallsList
+from .handler.base import RequestHandler
+
+__all__ = ["Calls", "CallsList", "MockedRequester"]
+
+
+class MockedRequester:
+    def __init__(self, request_handler: RequestHandler):
+        self._handler: RequestHandler = request_handler
+
+    async def query(self, *args, **kwargs) -> Calls:
+        self._check_arguments(*args, **kwargs)
+
+        methods = self._handler.bot.session.methods
+        already_made = len(methods)
+        result = await self._handler(*args, **kwargs)
+
+        return Calls(list(methods)[already_made:], result=result)
+
+    def add_result_for(
+        self,
+        method: type[TelegramMethod[TelegramType]],
+        ok: bool,
+        result: TelegramType = None,
+        description: str | None = None,
+        error_code: int = 200,
+        migrate_to_chat_id: int | None = None,
+        retry_after: int | None = None,
+    ) -> Response[TelegramType]:
+        response = self._handler.add_result_for(
+            method=method,
+            ok=ok,
+            result=result,
+            description=description,
+            error_code=error_code,
+            migrate_to_chat_id=migrate_to_chat_id,
+            retry_after=retry_after,
+        )
+        return response
+
+    def _check_arguments(self, *args, **kwargs) -> None:
+        build_update = getattr(self._handler, "build_update", None)
+        if build_update is None:
+            return
+        try:
+            build_update(*args, **kwargs)
+        except TypeError as e:
+            raise AttributeError(f"incorrect argument name. {e}") from e

{aiogram_testing-1.2.0 → aiogram_testing-1.3.0}/aiogram_tests/tester.py

@@ -12,9 +12,9 @@ from aiogram.methods import TelegramMethod
 from aiogram.methods.base import Response
 from aiogram.methods.base import TelegramType
 
+from .calls import Calls
 from .mocked_bot import DEFAULT_AUTO_MOCK_SUCCESS
 from .mocked_bot import MockedBot
-from .requester import Calls
 from .types.dataset import CALLBACK_QUERY
 from .types.dataset import CHAT
 from .types.dataset import MESSAGE
@@ -81,8 +81,8 @@ class BotTester:
 
         methods = self.bot.session.methods
         already_made = len(methods)
-        await self.dp.feed_update(self.bot, update, **self._workflow_data)
-        self._last_calls = Calls(list(methods)[already_made:])
+        result = await self.dp.feed_update(self.bot, update, **self._workflow_data)
+        self._last_calls = Calls(list(methods)[already_made:], result=result)
         return self._last_calls
 
     async def send_message(

{aiogram_testing-1.2.0 → aiogram_testing-1.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "aiogram-testing"
-version = "1.2.0"
+version = "1.3.0"
 description = "A library for testing your bots on aiogram"
 authors = ["k0te1ch <khvostov40@gmail.com>"]
 readme = "README.md"

aiogram_testing-1.2.0/aiogram_tests/__init__.py

@@ -1,6 +0,0 @@
-from .requester import Calls
-from .requester import MockedRequester
-from .tester import BotTester
-
-__all__ = ["BotTester", "Calls", "MockedRequester"]
-__version__ = "1.2.0"  # x-release-please-version