python-trueconf-bot 1.1.6__tar.gz → 1.1.7__tar.gz

{python_trueconf_bot-1.1.6 → python_trueconf_bot-1.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-trueconf-bot
-Version: 1.1.6
+Version: 1.1.7
 Summary: Lightweight and powerful framework for the TrueConf Server Chatbot API
 Author-email: TrueConf LLC <info@trueconf.com>, Anton Baadzhi <baadzhianton@gmail.com>
 License-Expression: BSD-3-Clause-Clear

python_trueconf_bot-1.1.7/examples/add_big_list_users_to_channel.py

@@ -0,0 +1,48 @@
+from trueconf import Bot
+from trueconf.exceptions import ApiErrorException
+import asyncio
+import logging
+from pathlib import Path
+
+SERVER_ADDR = ""
+BOT_USERNAME = ""
+BOT_PASSWORD = ""
+PATH_LIST_USERS = ""
+CHANNEL_NAME = ""
+
+bot = Bot.from_credentials(
+    server=SERVER_ADDR,
+    username=BOT_USERNAME,
+    password=BOT_PASSWORD,
+    verify_ssl=False,
+)
+
+Path("logs").mkdir(parents=True, exist_ok=True)
+
+logging.basicConfig(
+    level=logging.DEBUG,
+    format="%(asctime)s [%(levelname)s] %(name)s: %(message)s",
+    filename="logs/bot.log",
+    encoding="utf-8",
+)
+
+async def main():
+    await bot.start()
+    await bot.connected_event.wait()
+    await bot.authorized_event.wait()
+
+    resp = await bot.create_channel(title=CHANNEL_NAME)
+    with open(PATH_LIST_USERS, "r") as file:
+        for line in file:
+            user_id = line.strip()
+            if user_id:
+                try:
+                    await bot.add_participant_to_chat(resp.chat_id, user_id=user_id, display_history=True)
+                except ApiErrorException as e:
+                    if e.code == 309:
+                        continue
+
+    await bot.shutdown()
+
+if __name__ == "__main__":
+    asyncio.run(main())

{python_trueconf_bot-1.1.6 → python_trueconf_bot-1.1.7}/python_trueconf_bot.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-trueconf-bot
-Version: 1.1.6
+Version: 1.1.7
 Summary: Lightweight and powerful framework for the TrueConf Server Chatbot API
 Author-email: TrueConf LLC <info@trueconf.com>, Anton Baadzhi <baadzhianton@gmail.com>
 License-Expression: BSD-3-Clause-Clear

{python_trueconf_bot-1.1.6 → python_trueconf_bot-1.1.7}/python_trueconf_bot.egg-info/SOURCES.txt

@@ -53,6 +53,7 @@ docs/ru/learn/types.md
 docs/stylesheets/extra.css
 examples/README-ru.md
 examples/README.md
+examples/add_big_list_users_to_channel.py
 examples/filters.py
 examples/report_bot.py
 examples/update_token.py

python_trueconf_bot-1.1.7/trueconf/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '1.1.7'
+__version_tuple__ = version_tuple = (1, 1, 7)
+
+__commit_id__ = commit_id = 'ga3eb6d111'

{python_trueconf_bot-1.1.6 → python_trueconf_bot-1.1.7}/trueconf/client/bot.py

@@ -7,6 +7,7 @@ import signal
 import ssl
 import tempfile
 import websockets
+import warnings
 from pathlib import Path
 from aiohttp import ClientSession, ClientTimeout, TCPConnector, FormData
 from async_property import async_cached_property
@@ -337,7 +338,7 @@ class Bot:
             preview: InputFile | None = None,
             is_sticker: bool = False,
             timeout: int = 60,
-    ) -> str | None:
+    ) -> str:
         """
            Uploads a file to the server and returns a temporary file identifier (temporalFileId).
 
@@ -390,7 +391,7 @@ class Bot:
 
         try:
             async with ClientSession(connector=connector, timeout=timeout) as session:
-                data = FormData()
+                data = FormData(quote_fields=False)
                 data.add_field(
                     name="file",
                     value= await file.read(),
@@ -1103,6 +1104,12 @@ class Bot:
             SendMessageResponse: Object containing the result of the message delivery.
         """
 
+        warnings.warn(
+            "reply_message is deprecated, use send_message(..., reply_message_id=...) instead",
+            DeprecationWarning,
+            stacklevel=2
+        )
+
         call = SendMessage(
             chat_id=chat_id,
             reply_message_id=message_id,
@@ -1147,6 +1154,7 @@ class Bot:
             file: InputFile,
             caption: str | None = None,
             parse_mode: ParseMode | str = ParseMode.TEXT,
+            reply_message_id: str | None = None
     ) -> SendFileResponse:
         """
         Sends a document or any arbitrary file to the specified chat.
@@ -1163,6 +1171,7 @@ class Bot:
             file (InputFile): The file to be uploaded. Must be a subclass of `InputFile`.
             caption (str | None): Optional caption text to be sent with the file.
             parse_mode (ParseMode | str): Text formatting mode (e.g., Markdown, HTML, or plain text).
+            reply_message_id (str, optional): Optional identifier of the message to which this message is a reply.
 
         Returns:
             SendFileResponse: An object containing the result of the file upload.
@@ -1184,14 +1193,21 @@ class Bot:
             file=file,
         )
 
-        call = SendFile(chat_id=chat_id, temporal_file_id=temporal_file_id, text=caption, parse_mode=parse_mode)
+        call = SendFile(
+            chat_id=chat_id,
+            temporal_file_id=temporal_file_id,
+            text=caption,
+            parse_mode=parse_mode,
+            reply_message_id=reply_message_id
+        )
         return await self(call)
 
     async def send_message(
             self,
             chat_id: str,
             text: str,
-            parse_mode: ParseMode | str = ParseMode.TEXT
+            parse_mode: ParseMode | str = ParseMode.TEXT,
+            reply_message_id: str | None = None
     ) -> SendMessageResponse:
         """
         Sends a message to the specified chat.
@@ -1204,13 +1220,19 @@ class Bot:
             text (str): Text content of the message.
             parse_mode (ParseMode | str, optional): Text formatting mode.
                 Defaults to plain text.
+            reply_message_id (str, optional): Optional identifier of the message to which this message is a reply.
 
         Returns:
             SendMessageResponse: Object containing the result of the message delivery.
         """
 
         loggers.chatbot.info(f"✉️ Sending message to {chat_id}")
-        call = SendMessage(chat_id=chat_id, text=text, parse_mode=parse_mode)
+        call = SendMessage(
+            chat_id=chat_id,
+            text=text,
+            parse_mode=parse_mode,
+            reply_message_id=reply_message_id
+        )
         return await self(call)
 
     async def send_photo(
@@ -1219,7 +1241,8 @@ class Bot:
             file: InputFile,
             preview: InputFile | None,
             caption: str | None = None,
-            parse_mode: ParseMode | str = ParseMode.TEXT
+            parse_mode: ParseMode | str = ParseMode.TEXT,
+            reply_message_id: str | None = None
     ) -> SendFileResponse:
         """
         Sends a photo to the specified chat, with optional caption and preview support.
@@ -1242,6 +1265,7 @@ class Bot:
             preview (InputFile | None): Optional preview image. Must also be an `InputFile` if provided.
             caption (str | None): Optional caption to be sent along with the image.
             parse_mode (ParseMode | str): Formatting mode for the caption (e.g., Markdown, HTML, plain text).
+            reply_message_id (str, optional): Optional identifier of the message to which this message is a reply.
 
         Returns:
             SendFileResponse: An object containing the result of the file upload.
@@ -1265,10 +1289,21 @@ class Bot:
             preview=preview,
         )
 
-        call = SendFile(chat_id=chat_id, temporal_file_id=temporal_file_id, text=caption, parse_mode=parse_mode)
+        call = SendFile(
+            chat_id=chat_id,
+            temporal_file_id=temporal_file_id,
+            text=caption,
+            parse_mode=parse_mode,
+            reply_message_id=reply_message_id
+        )
         return await self(call)
 
-    async def send_sticker(self, chat_id: str, file: InputFile) -> SendFileResponse:
+    async def send_sticker(
+            self,
+            chat_id: str,
+            file: InputFile,
+            reply_message_id: str | None = None
+    ) -> SendFileResponse:
         """
         Sends a sticker in WebP format to the specified chat.
 
@@ -1285,6 +1320,7 @@ class Bot:
         Args:
             chat_id (str): Identifier of the chat to which the sticker will be sent.
             file (InputFile): The sticker file in WebP format. Must be a subclass of `InputFile`.
+            reply_message_id (str, optional): Optional identifier of the message to which this message is a reply.
 
         Returns:
             SendFileResponse: An object containing the result of the file upload.
@@ -1309,7 +1345,11 @@ class Bot:
             is_sticker=True
         )
 
-        call = SendFile(chat_id=chat_id, temporal_file_id=temporal_file_id)
+        call = SendFile(
+            chat_id=chat_id,
+            temporal_file_id=temporal_file_id,
+            reply_message_id=reply_message_id
+        )
         return await self(call)
 
     async def send_survey(
@@ -1317,7 +1357,7 @@ class Bot:
             chat_id: str,
             title: str,
             survey_campaign_id: str,
-            reply_message_id: str = None,
+            reply_message_id: str | None = None,
             survey_type: SurveyType = SurveyType.NON_ANONYMOUS,
     ) -> SendSurveyResponse:
         """
@@ -1330,7 +1370,7 @@ class Bot:
             chat_id (str): Identifier of the chat to send the survey to.
             title (str): Title of the survey displayed in the chat.
             survey_campaign_id (str): Identifier of the survey campaign.
-            reply_message_id (str, optional): Identifier of the message being replied to.
+            reply_message_id (str, optional): Optional identifier of the message to which this message is a reply.
             survey_type (SurveyType, optional): Type of the survey (anonymous or non-anonymous). Defaults to non-anonymous.
 
         Returns:

{python_trueconf_bot-1.1.6 → python_trueconf_bot-1.1.7}/trueconf/methods/send_file.py

@@ -12,8 +12,9 @@ class SendFile(TrueConfMethod[SendFileResponse]):
 
     chat_id: str
     temporal_file_id: str
-    text: str = None
-    parse_mode: str = None
+    text: str | None = None
+    parse_mode: str | None = None
+    reply_message_id: str | None = None
 
     def __post_init__(self):
         super().__init__()
@@ -21,6 +22,7 @@ class SendFile(TrueConfMethod[SendFileResponse]):
     def payload(self):
         return {
             "chatId": self.chat_id,
+            "replyMessageId": self.reply_message_id,
             "content": {
                 "temporalFileId": self.temporal_file_id,
                 "caption":{

{python_trueconf_bot-1.1.6 → python_trueconf_bot-1.1.7}/trueconf/types/message.py

@@ -333,11 +333,12 @@ class Message(BoundToBot, DataClassDictMixin):
 
     async def reply(self, text: str, parse_mode: ParseMode | str = ParseMode.HTML) -> object:
         """
-        Shortcut for the [`reply_message`][trueconf.Bot.reply_message] method of the bot instance. Use this method to send a reply message to the current chat.
+        Shortcut for the [`send_message`][trueconf.Bot.send_message] method.
+        Sends a reply to this message in the current chat.
 
         Automatically fills the following attributes:
-            - `chat_id`
-            - `reply_message_id`
+            - `chat_id`: Current chat identifier.
+            - `reply_message_id`: ID of the current message.
 
         Source: https://trueconf.com/docs/chatbot-connector/en/messages/#replyMessage
 
@@ -349,13 +350,129 @@ class Message(BoundToBot, DataClassDictMixin):
             SendMessageResponse: Object containing the result of the message delivery.
         """
 
-        return await self.bot.reply_message(
+        return await self.bot.send_message(
             chat_id=self.chat_id,
-            message_id=self.message_id,
+            reply_message_id=self.message_id,
             text=text,
             parse_mode=parse_mode,
         )
 
+    async def reply_photo(
+            self,
+            file: InputFile,
+            preview: InputFile | None,
+            caption: str | None = None,
+            parse_mode: ParseMode | str = ParseMode.TEXT,
+
+    ) -> object:
+        """
+        Shortcut for the [`send_photo`][trueconf.Bot.send_photo] method of the bot instance.
+        Sends a photo as a reply to the current message in this chat.
+
+        Automatically fills the following attributes:
+            - `chat_id`: Current chat identifier.
+            - `reply_message_id`: ID of the current message.
+
+        Source:
+            https://trueconf.com/docs/chatbot-connector/en/files/#sending-an-image
+
+        Args:
+            file (InputFile): The photo file to upload. Must be a subclass of `InputFile`.
+            preview (InputFile | None): Optional preview image. Must also be an `InputFile` if provided.
+            caption (str | None): Optional caption to be sent along with the image.
+            parse_mode (ParseMode | str): Formatting mode for the caption (e.g., Markdown, HTML, plain text).
+            reply_message_id (str | None): Optional identifier of the message to which this message is a reply.
+
+        Returns:
+            SendFileResponse: Object containing the result of the photo upload.
+
+        Examples:
+            >>> @<router>.message()
+            >>> async def on_message(message:Message):
+            >>>     await message.answer_photo(file=FSInputFile("sticker.webp"), preview=FSInputFile("sticker.webp"))
+        """
+
+        return await self.bot.send_photo(
+            chat_id=self.chat_id,
+            file=file,
+            caption=caption,
+            preview=preview,
+            parse_mode=parse_mode,
+            reply_message_id=self.message_id
+        )
+
+    async def reply_document(
+            self,
+            file: InputFile,
+            caption: str | None = None,
+            parse_mode: ParseMode | str = ParseMode.TEXT
+    ) -> object:
+        """
+        Shortcut for the [`send_document`][trueconf.Bot.send_document] method of the bot instance.
+        Sends a document as a reply to the current message in this chat.
+
+        Automatically fills the following attributes:
+            - `chat_id`: Current chat identifier.
+            - `reply_message_id`: ID of the current message.
+
+        Source:
+            https://trueconf.com/docs/chatbot-connector/en/files/#working-with-files
+
+        Args:
+            file (InputFile): The file to be uploaded. Must be a subclass of `InputFile`.
+            caption (str | None): Optional caption text to be sent with the file.
+            parse_mode (ParseMode | str): Text formatting mode (e.g., Markdown, HTML, or plain text).
+
+        Returns:
+            SendFileResponse: Object containing the result of the document upload.
+
+        Examples:
+            >>> @<router>.message()
+            >>> async def on_message(message:Message):
+            >>>     await message.answer_document(file=FSInputFile("sticker.webp"))
+        """
+
+        return await self.bot.send_document(
+            chat_id=self.chat_id,
+            file=file,
+            caption=caption,
+            parse_mode=parse_mode,
+            reply_message_id=self.message_id
+        )
+
+    async def reply_sticker(
+            self,
+            file: InputFile
+    ) -> object:
+        """
+        Shortcut for the [`send_sticker`][trueconf.Bot.send_sticker] method of the bot instance.
+        Sends a sticker as a reply to the current message in this chat.
+
+        Automatically fills the following attributes:
+            - `chat_id`: Current chat identifier.
+            - `reply_message_id`: ID of the current message.
+
+        Source:
+            https://trueconf.com/docs/chatbot-connector/en/files/#upload-file-to-server-storage
+
+        Args:
+            file (InputFile): The sticker file in WebP format. Must be a subclass of `InputFile`.
+
+        Returns:
+            SendFileResponse: Object containing the result of the sticker delivery.
+
+        Examples:
+            >>> @<router>.message()
+            >>> async def on_message(message:Message):
+            >>>     await message.answer_sticker(file=FSInputFile("sticker.webp"))
+        """
+
+        return await self.bot.send_sticker(
+            chat_id=self.chat_id,
+            file=file,
+            reply_message_id=self.message_id
+        )
+
     async def forward(self, chat_id: str) -> object:
         """
         Shortcut for the [`forward_message`][trueconf.Bot.forward_message] method of the bot instance. Use this method to forward the current message to another chat.

{python_trueconf_bot-1.1.6 → python_trueconf_bot-1.1.7}/trueconf/types/responses/get_chat_by_id_response.py

@@ -10,4 +10,4 @@ class GetChatByIdResponse(DataClassDictMixin):
     title: str
     chat_type: int = field(metadata={"alias": "chatType"})
     unread_messages: int = field(metadata={"alias": "unreadMessages"})
-    last_message: LastMessage = field(metadata={"alias": "lastMessage"})
+    last_message: LastMessage | None = field(default=None, metadata={"alias": "lastMessage"})

python_trueconf_bot-1.1.6/trueconf/_version.py

@@ -1,34 +0,0 @@
-# file generated by setuptools-scm
-# don't change, don't track in version control
-
-__all__ = [
-    "__version__",
-    "__version_tuple__",
-    "version",
-    "version_tuple",
-    "__commit_id__",
-    "commit_id",
-]
-
-TYPE_CHECKING = False
-if TYPE_CHECKING:
-    from typing import Tuple
-    from typing import Union
-
-    VERSION_TUPLE = Tuple[Union[int, str], ...]
-    COMMIT_ID = Union[str, None]
-else:
-    VERSION_TUPLE = object
-    COMMIT_ID = object
-
-version: str
-__version__: str
-__version_tuple__: VERSION_TUPLE
-version_tuple: VERSION_TUPLE
-commit_id: COMMIT_ID
-__commit_id__: COMMIT_ID
-
-__version__ = version = '1.1.6'
-__version_tuple__ = version_tuple = (1, 1, 6)
-
-__commit_id__ = commit_id = 'g97554760a'