telegrinder 0.1.dev159__tar.gz → 0.1.dev161__tar.gz

{telegrinder-0.1.dev159 → telegrinder-0.1.dev161}/PKG-INFO

@@ -1,33 +1,34 @@
 Metadata-Version: 2.1
 Name: telegrinder
-Version: 0.1.dev159
+Version: 0.1.dev161
 Summary: Framework for effective and reliable async telegram bot building.
 Home-page: https://github.com/timoniq/telegrinder
 License: MIT
-Keywords: telegram,telegram bot api framework,telegrinder,asyncio,middleware,composition,bot api,async
+Keywords: asyncio,api schema,async,bot building,bot api,custom rules,telegram,telegram bot api framework,telegrinder,middleware,composition
 Author: timoniq
 Author-email: tesseradecades@mail.ru
 Maintainer: luwqz1
+Maintainer-email: howluwqz1@gmail.com
 Requires-Python: >=3.11,<4.0
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: Quality Assurance
 Classifier: Typing :: Typed
 Requires-Dist: PyYAML (>=6.0,<7.0)
 Requires-Dist: aiohttp (>=3.8.1,<4.0.0)
-Requires-Dist: certifi (>=2023.7.22,<2024.0.0)
+Requires-Dist: certifi (>=2024.2.2,<2025.0.0)
 Requires-Dist: choicelib (>=0.1.5,<0.2.0)
 Requires-Dist: colorama (>=0.4.0,<0.5.0)
 Requires-Dist: envparse (>=0.2.0,<0.3.0)
-Requires-Dist: fntypes (>=0.1.1,<0.2.0)
-Requires-Dist: msgspec (>=0.18.4,<0.19.0)
+Requires-Dist: fntypes (>=0.1.2.post1,<0.2.0)
+Requires-Dist: msgspec (>=0.18.6,<0.19.0)
 Requires-Dist: requests (>=2.28.1,<3.0.0)
-Requires-Dist: typing-extensions (>=4.8.0,<5.0.0)
+Requires-Dist: typing-extensions (>=4.10.0,<5.0.0)
 Requires-Dist: vbml (>=1.1.post1,<2.0)
 Project-URL: Repository, https://github.com/timoniq/telegrinder
 Description-Content-Type: text/markdown
@@ -75,9 +76,9 @@ from telegrinder import API, Message, Telegrinder, Token
 from telegrinder.modules import logger
 from telegrinder.rules import Text
 
-logger.set_level("INFO")
 api = API(token=Token("123:token"))
 bot = Telegrinder(api)
+logger.set_level("INFO")
 
 
 @bot.on.message(Text("/start"))

{telegrinder-0.1.dev159 → telegrinder-0.1.dev161}/pyproject.toml

@@ -1,22 +1,25 @@
 [tool.poetry]
 name = "telegrinder"
-version = "0.1.dev159"
+version = "0.1.dev161"
 description = "Framework for effective and reliable async telegram bot building."
 authors = ["timoniq <tesseradecades@mail.ru>"]
-maintainers = ["luwqz1"]
+maintainers = ["luwqz1 <howluwqz1@gmail.com>"]
 license = "MIT"
 readme = "readme.md"
 homepage = "https://github.com/timoniq/telegrinder"
 repository = "https://github.com/timoniq/telegrinder"
 keywords = [
+  "asyncio",
+  "api schema",
+  "async",
+  "bot building",
+  "bot api",
+  "custom rules",
   "telegram",
   "telegram bot api framework",
   "telegrinder",
-  "asyncio",
   "middleware",
   "composition",
-  "bot api",
-  "async",
 ]
 classifiers = [
   "Environment :: Console",
@@ -36,11 +39,11 @@ vbml = "^1.1.post1"
 choicelib = "^0.1.5"
 envparse = "^0.2.0"
 PyYAML = "^6.0"
-certifi = "^2023.7.22"
-msgspec = "^0.18.4"
+certifi = "^2024.2.2"
+msgspec = "^0.18.6"
 requests = "^2.28.1"
-typing-extensions = "^4.8.0"
-fntypes = "^0.1.1"
+typing-extensions = "^4.10.0"
+fntypes = "^0.1.2.post1"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.0.0"
@@ -59,10 +62,14 @@ line-length = 100
 target-version = "py311"
 select = ["I", "N", "ANN", "COM", "YTT", "TCH", "SIM"]
 ignore = [
-    "ANN001", "ANN002", "ANN003", "ANN101", "ANN102", "ANN201", "ANN202",
-    "ANN204", "ANN206", "ANN401", "COM812", "N818", "TCH001", "TCH004"
+  "ANN001", "ANN002", "ANN003", "ANN101", "ANN102", "ANN201", "ANN202",
+  "ANN204", "ANN206", "ANN401", "COM812", "N818", "TCH001", "TCH004"
 ]
 
+[tool.black]
+line-length = 90
+target-version = ["py311"]
+
 [tool.pytest.ini_options]
 asyncio_mode = "auto"
 

{telegrinder-0.1.dev159 → telegrinder-0.1.dev161}/readme.md

@@ -41,9 +41,9 @@ from telegrinder import API, Message, Telegrinder, Token
 from telegrinder.modules import logger
 from telegrinder.rules import Text
 
-logger.set_level("INFO")
 api = API(token=Token("123:token"))
 bot = Telegrinder(api)
+logger.set_level("INFO")
 
 
 @bot.on.message(Text("/start"))

{telegrinder-0.1.dev159 → telegrinder-0.1.dev161}/telegrinder/__init__.py

@@ -39,6 +39,7 @@ from .client import ABCClient, AiohttpClient
 from .model import Model
 from .modules import logger
 from .tools import (
+    ABCErrorHandler,
     ABCGlobalContext,
     ABCLoopWrapper,
     ABCTranslator,
@@ -47,6 +48,7 @@ from .tools import (
     Button,
     CtxVar,
     DelayedTask,
+    ErrorHandler,
     FormatString,
     GlobalContext,
     HTMLFormatter,
@@ -62,7 +64,6 @@ from .tools import (
     SimpleI18n,
     SimpleTranslator,
     ctx_var,
-    keyboard_remove,
     magic_bundle,
 )
 
@@ -76,6 +77,7 @@ __all__ = (
     "ABCAPI",
     "ABCClient",
     "ABCDispatch",
+    "ABCErrorHandler",
     "ABCGlobalContext",
     "ABCHandler",
     "ABCLoopWrapper",
@@ -107,6 +109,7 @@ __all__ = (
     "CtxVar",
     "DelayedTask",
     "Dispatch",
+    "ErrorHandler",
     "FormatString",
     "FuncHandler",
     "GlobalContext",
@@ -139,7 +142,6 @@ __all__ = (
     "ViewBox",
     "WaiterMachine",
     "ctx_var",
-    "keyboard_remove",
     "logger",
     "magic_bundle",
     "register_manager",

{telegrinder-0.1.dev159 → telegrinder-0.1.dev161}/telegrinder/api/abc.py

@@ -17,6 +17,9 @@ class Token(str):
         if token.count(":") != 1 or not token.split(":")[0].isdigit():
             raise InvalidTokenError("Invalid token, it should look like this '123:ABC'.")
         return super().__new__(cls, token)
+    
+    def __repr__(self) -> str:
+        return f"<Token: {self.bot_id}:{''.join(self.split(':')[-1])[:6]}...>"
 
     @classmethod
     def from_env(
@@ -43,6 +46,7 @@ class ABCAPI(ABC):
         self,
         method: str,
         data: dict[str, typing.Any] | None = None,
+        files: dict[str, tuple[str, bytes]] | None = None,
     ) -> Result[list[typing.Any] | dict[str, typing.Any] | bool, APIError]:
         pass
 
@@ -51,6 +55,7 @@ class ABCAPI(ABC):
         self,
         method: str,
         data: dict[str, typing.Any] | None = None,
+        files: dict[str, tuple[str, bytes]] | None = None,
     ) -> Result[msgspec.Raw, APIError]:
         pass
 

{telegrinder-0.1.dev159 → telegrinder-0.1.dev161}/telegrinder/api/api.py

@@ -18,13 +18,13 @@ def compose_data(
 ) -> typing.Any:
     converter = DataConverter(files=files)
     return client.get_form(
-        data={k: converter.convert(v) for k, v in data.items()},
+        data={k: converter(v) for k, v in data.items()},
         files=converter.files,
     )
 
 
 class API(ABCAPI, APIMethods):
-    API_URL: typing.ClassVar[str] = "https://api.telegram.org/"
+    API_URL = "https://api.telegram.org/"
 
     def __init__(self, token: Token, *, http: ABCClient | None = None) -> None:
         self.token = token
@@ -32,9 +32,9 @@ class API(ABCAPI, APIMethods):
         super().__init__(self)
     
     def __repr__(self) -> str:
-        return "<{}: id={}, http={!r}>".format(
+        return "<{}: token={!r}, http={!r}>".format(
             self.__class__.__name__,
-            self.id,
+            self.token,
             self.http,
         )
 

{telegrinder-0.1.dev159 → telegrinder-0.1.dev161}/telegrinder/bot/cute_types/callback_query.py

@@ -2,11 +2,11 @@ import typing
 from contextlib import suppress
 
 import msgspec
-from fntypes.co import Result, Some, Variative
+from fntypes.co import Nothing, Result, Some, Variative, unwrapping
 
 from telegrinder.api import ABCAPI, APIError
 from telegrinder.model import get_params
-from telegrinder.msgspec_utils import Nothing, Option, decoder
+from telegrinder.msgspec_utils import Option, decoder
 from telegrinder.types import (
     CallbackQuery,
     InlineKeyboardMarkup,
@@ -23,22 +23,20 @@ from .base import BaseCute, compose_method_params, shortcut
 from .message import MediaType, MessageCute, ReplyMarkup, execute_method_edit
 
 
-class CallbackQueryCute(
-    BaseCute[CallbackQuery], CallbackQuery, kw_only=True, dict=True
-):
+class CallbackQueryCute(BaseCute[CallbackQuery], CallbackQuery, kw_only=True, dict=True):
     api: ABCAPI
 
     @property
     def from_user(self) -> User:
         return self.from_
-    
+
     @property
     def chat_id(self) -> Option[int]:
         """Optional. Message from chat ID. This will be present if the message is sent
         by the bot with the callback button that originated the query."""
 
         return self.message.map(lambda m: m.v.chat.id)
-    
+
     @property
     def is_topic_message(self) -> Option[bool]:
         """Optional. True, if the message is a topic message with a name,
@@ -46,22 +44,24 @@ class CallbackQueryCute(
         by the bot with the callback button that originated the query."""
 
         return self.message.map(
-            lambda m: m.only().map(
-                lambda m: m.is_topic_message.unwrap_or(False)
-            ).unwrap_or(False)
+            lambda m: m.only()
+            .map(lambda m: m.is_topic_message.unwrap_or(False))
+            .unwrap_or(False)
         )
-    
+
     @property
+    @unwrapping
     def message_thread_id(self) -> Option[int]:
         """Optional. Unique identifier of the target message thread (for forum supergroups only).
         This will be present if the message is sent
         by the bot with the callback button that originated the query."""
 
-        return self.message.map(
-            lambda m: m.only().map(
-                lambda m: m.message_thread_id,
-            ).unwrap_or(Nothing)
-        ).unwrap_or(Nothing)
+        return (
+            self.message.unwrap()
+            .only()
+            .map(lambda m: m.message_thread_id.unwrap())
+            .cast(Some, Nothing)
+        )
 
     @property
     def message_id(self) -> Option[int]:
@@ -71,23 +71,23 @@ class CallbackQueryCute(
 
         return self.message.map(lambda m: m.v.message_id)
 
-    def decode_callback_data(self, *, strict: bool = True) -> Option[dict[str, typing.Any]]:
+    def decode_callback_data(self) -> Option[dict[str, typing.Any]]:
         if "cached_callback_data" in self.__dict__:
             return self.__dict__["cached_callback_data"]
-        data = Nothing
+        data = Nothing()
         with suppress(msgspec.ValidationError):
-            data = Some(decoder.decode(self.data.unwrap(), strict=strict))
+            data = Some(decoder.decode(self.data.unwrap()))
         self.__dict__["cached_callback_data"] = data
         return data
 
     @shortcut("answer_callback_query")
     async def answer(
         self,
-        text: str | Option[str] = Nothing,
-        callback_query_id: str | Option[str] = Nothing,
-        show_alert: bool | Option[bool] = Nothing,
-        url: str | Option[str] = Nothing,
-        cache_time: int | Option[int] = Nothing,
+        text: str | None = None,
+        callback_query_id: str | None = None,
+        show_alert: bool | None = None,
+        url: str | None = None,
+        cache_time: int | None = None,
         **other: typing.Any,
     ) -> Result[bool, APIError]:
         """Shortcut `API.answer_callback_query()`, see the [documentation](https://core.telegram.org/bots/api#answercallbackquery)
@@ -118,26 +118,24 @@ class CallbackQueryCute(
             get_params(locals()), self, default_params={("callback_query_id", "id")}
         )
         return await self.ctx_api.answer_callback_query(**params)
-    
+
     @shortcut(
         "copy_message",
         custom_params={"reply_parameters", "message_thread_id"},
     )
     async def copy(
         self,
-        chat_id: int | str | Option[int | str] = Nothing,
-        from_chat_id: int | str | Option[int | str] = Nothing,
-        message_id: int | Option[int] = Nothing,
-        message_thread_id: Option[int] | int = Nothing,
-        caption: Option[str] | str = Nothing,
-        parse_mode: Option[str] | str = Nothing,
-        caption_entities: Option[list[MessageEntity]] | list[MessageEntity] = Nothing,
-        disable_notification: Option[bool] | bool = Nothing,
-        protect_content: Option[bool] | bool = Nothing,
-        reply_parameters: Option[ReplyParameters | dict[str, typing.Any]]
-        | ReplyParameters
-        | dict[str, typing.Any] = Nothing,
-        reply_markup: Option[ReplyMarkup] | ReplyMarkup = Nothing,
+        chat_id: int | str | None = None,
+        from_chat_id: int | str | None = None,
+        message_id: int | None = None,
+        message_thread_id: int | None = None,
+        caption: str | None = None,
+        parse_mode: str | None = None,
+        caption_entities: list[MessageEntity] | None = None,
+        disable_notification: bool | None = None,
+        protect_content: bool | None = None,
+        reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
+        reply_markup: ReplyMarkup | None = None,
         **other: typing.Any,
     ) -> Result[MessageId, APIError]:
         """Shortcut `API.copy_message()`, see the [documentation](https://core.telegram.org/bots/api#copymessage)
@@ -185,9 +183,9 @@ class CallbackQueryCute(
     @shortcut("delete_message", custom_params={"message_thread_id"})
     async def delete(
         self,
-        chat_id: int | Option[int] = Nothing,
-        message_id: int | Option[int] = Nothing,
-        message_thread_id: int | Option[int] = Nothing,
+        chat_id: int | None = None,
+        message_id: int | None = None,
+        message_thread_id: int | None = None,
         **other: typing.Any,
     ) -> Result[bool, APIError]:
         """Shortcut `API.delete_message()`, see the [documentation](https://core.telegram.org/bots/api#deletemessage)
@@ -217,21 +215,19 @@ class CallbackQueryCute(
     @shortcut(
         "edit_message_text",
         executor=execute_method_edit,
-        custom_params={"message_thread_id", "link_preview_options"}
+        custom_params={"message_thread_id", "link_preview_options"},
     )
     async def edit_text(
         self,
-        text: str | Option[str],
-        inline_message_id: int | Option[int] = Nothing,
-        chat_id: Option[int | str] | int | str = Nothing,
-        message_id: Option[int] | int = Nothing,
-        message_thread_id: int | Option[int] = Nothing,
-        parse_mode: str | Option[str] = Nothing,
-        entities: list[MessageEntity] | Option[list[MessageEntity]] = Nothing,
-        link_preview_options: Option[LinkPreviewOptions | dict[str, typing.Any]]
-        | LinkPreviewOptions
-        | dict[str, typing.Any] = Nothing,
-        reply_markup: InlineKeyboardMarkup | Option[InlineKeyboardMarkup] = Nothing,
+        text: str | None,
+        inline_message_id: int | None = None,
+        chat_id: int | str | None = None,
+        message_id: int | None = None,
+        message_thread_id: int | None = None,
+        parse_mode: str | None = None,
+        entities: list[MessageEntity] | None = None,
+        link_preview_options: LinkPreviewOptions | dict[str, typing.Any] | None = None,
+        reply_markup: InlineKeyboardMarkup | None = None,
         **other: typing.Any,
     ) -> Result[Variative[MessageCute, bool], APIError]:
         """Shortcut `API.edit_message_text()`, see the [documentation](https://core.telegram.org/bots/api#editmessagetext)
@@ -265,7 +261,7 @@ class CallbackQueryCute(
         :param reply_markup: A JSON-serialized object for an inline keyboard."""
 
         ...
-    
+
     @shortcut(
         "edit_message_live_location",
         executor=execute_method_edit,
@@ -275,14 +271,14 @@ class CallbackQueryCute(
         self,
         latitude: float,
         longitude: float,
-        inline_message_id: Option[str] | str = Nothing,
-        message_thread_id: int | Option[int] = Nothing,
-        chat_id: Option[int | str] | int | str = Nothing,
-        message_id: Option[int] | int = Nothing,
-        horizontal_accuracy: Option[float] | float = Nothing,
-        heading: Option[int] | int = Nothing,
-        proximity_alert_radius: Option[int] | int = Nothing,
-        reply_markup: Option[InlineKeyboardMarkup] | InlineKeyboardMarkup = Nothing,
+        inline_message_id: str | None = None,
+        message_thread_id: int | None = None,
+        chat_id: int | str | None = None,
+        message_id: int | None = None,
+        horizontal_accuracy: float | None = None,
+        heading: int | None = None,
+        proximity_alert_radius: int | None = None,
+        reply_markup: InlineKeyboardMarkup | None = None,
         **other: typing.Any,
     ) -> Result[Variative[MessageCute, bool], APIError]:
         """Shortcut `API.edit_message_live_location()`, see the [documentation](https://core.telegram.org/bots/api#editmessagelivelocation)
@@ -319,7 +315,7 @@ class CallbackQueryCute(
         :param reply_markup: A JSON-serialized object for a new inline keyboard."""
 
         ...
-    
+
     @shortcut(
         "edit_message_caption",
         executor=execute_method_edit,
@@ -327,14 +323,14 @@ class CallbackQueryCute(
     )
     async def edit_caption(
         self,
-        caption: Option[str] | str,
-        chat_id: Option[int | str] | int | str = Nothing,
-        message_id: Option[int] | int = Nothing,
-        message_thread_id: int | Option[int] = Nothing,
-        inline_message_id: Option[str] | str = Nothing,
-        parse_mode: Option[str] | str = Nothing,
-        caption_entities: Option[list[MessageEntity]] | list[MessageEntity] = Nothing,
-        reply_markup: Option[InlineKeyboardMarkup] | InlineKeyboardMarkup = Nothing,
+        caption: str,
+        chat_id: int | str | None = None,
+        message_id: int | None = None,
+        message_thread_id: int | None = None,
+        inline_message_id: str | None = None,
+        parse_mode: str | None = None,
+        caption_entities: list[MessageEntity] | None = None,
+        reply_markup: InlineKeyboardMarkup | None = None,
         **other: typing.Any,
     ) -> Result[Variative[MessageCute, bool], APIError]:
         """Shortcut `API.edit_message_caption()`, see the [documentation](https://core.telegram.org/bots/api#editmessagecaption)
@@ -381,15 +377,15 @@ class CallbackQueryCute(
     async def edit_media(
         self,
         media: str | InputFile | InputMedia,
-        type: MediaType | Option[MediaType] = Nothing,
-        caption: Option[str] | str = Nothing,
-        parse_mode: Option[str] | str = Nothing,
-        caption_entities: Option[list[MessageEntity]] | list[MessageEntity] = Nothing,
-        inline_message_id: Option[str] | str = Nothing,
-        chat_id: Option[int | str] | int | str = Nothing,
-        message_id: Option[int] | int = Nothing,
-        message_thread_id: Option[int] | int = Nothing,
-        reply_markup: Option[InlineKeyboardMarkup] | InlineKeyboardMarkup = Nothing,
+        type: MediaType | None = None,
+        caption: str | None = None,
+        parse_mode: str | None = None,
+        caption_entities: list[MessageEntity] | None = None,
+        inline_message_id: str | None = None,
+        chat_id: int | str | None = None,
+        message_id: int | None = None,
+        message_thread_id: int | None = None,
+        reply_markup: InlineKeyboardMarkup | None = None,
         **other: typing.Any,
     ) -> Result[Variative[MessageCute, bool], APIError]:
         """Shortcut `API.edit_message_media()`, see the [documentation](https://core.telegram.org/bots/api#editmessagemedia)
@@ -438,11 +434,11 @@ class CallbackQueryCute(
     )
     async def edit_reply_markup(
         self,
-        inline_message_id: Option[str] | str = Nothing,
-        message_id: Option[int] | int = Nothing,
-        message_thread_id: Option[int] | int = Nothing,
-        chat_id: Option[int | str] | int | str = Nothing,
-        reply_markup: Option[InlineKeyboardMarkup] | InlineKeyboardMarkup = Nothing,
+        inline_message_id: str | None = None,
+        message_id: int | None = None,
+        message_thread_id: int | None = None,
+        chat_id: int | str | None = None,
+        reply_markup: InlineKeyboardMarkup | None = None,
         **other: typing.Any,
     ) -> Result[Variative[MessageCute, bool], APIError]:
         """Shortcut `API.edit_message_reply_markup()`, see the [documentation](https://core.telegram.org/bots/api#editmessagereplymarkup)

telegrinder-0.1.dev161/telegrinder/bot/cute_types/inline_query.py

@@ -0,0 +1,68 @@
+import typing
+
+from fntypes.result import Result
+
+from telegrinder.api import ABCAPI, APIError
+from telegrinder.model import get_params
+from telegrinder.types import (
+    InlineQuery,
+    InlineQueryResult,
+    InlineQueryResultsButton,
+    User,
+)
+
+from .base import BaseCute, compose_method_params, shortcut
+
+
+class InlineQueryCute(BaseCute[InlineQuery], InlineQuery, kw_only=True):
+    api: ABCAPI
+
+    @property
+    def from_user(self) -> User:
+        return self.from_
+
+    @shortcut("answer_inline_query", custom_params={"results"})
+    async def answer(
+        self,
+        results: InlineQueryResult | list[InlineQueryResult],
+        inline_query_id: str | None = None,
+        cache_time: int | None = None,
+        is_personal: bool | None = None,
+        next_offset: str | None = None,
+        button: InlineQueryResultsButton | None = None,
+        **other: typing.Any,
+    ) -> Result[bool, APIError]:
+        """Shortcut `API.answer_inline_query()`, see the [documentation](https://core.telegram.org/bots/api#answerinlinequery)
+
+        Use this method to send answers to an inline query. On success, True is returned. 
+        No more than 50 results per query are allowed.
+
+        :param inline_query_id: Unique identifier for the answered query.
+
+        :param results: A JSON-serialized array of results for the inline query.
+
+        :param cache_time: The maximum amount of time in seconds that the result of the inline query \
+        may be cached on the server. Defaults to 300.
+
+        :param is_personal: Pass True if results may be cached on the server side only for the user that \
+        sent the query. By default, results may be returned to any user who sends \
+        the same query.
+
+        :param next_offset: Pass the offset that a client should send in the next query with the same text \
+        to receive more results. Pass an empty string if there are no more results \
+        or if you don't support pagination. Offset length can't exceed 64 bytes. \
+
+        :param button: A JSON-serialized object describing a button to be shown above inline query \
+        results.
+        """
+
+        params = compose_method_params(
+            get_params(locals()),
+            self,
+            default_params={("inline_query_id", "id")},
+        )
+        params["results"] = [results] if not isinstance(results, list) else results
+        return await self.ctx_api.answer_inline_query(**params)
+
+
+__all__ = ("InlineQueryCute",)