mirror of
https://github.com/Mayuri-Chan/pyrofork.git
synced 2025-12-29 20:14:51 +00:00
96 lines
3.5 KiB
Python
96 lines
3.5 KiB
Python
# Pyrofork - Telegram MTProto API Client Library for Python
|
|
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
|
|
# Copyright (C) 2022-present Mayuri-Chan <https://github.com/Mayuri-Chan>
|
|
#
|
|
# This file is part of Pyrofork.
|
|
#
|
|
# Pyrofork is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Lesser General Public License as published
|
|
# by the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Pyrofork 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 General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser General Public License
|
|
# along with Pyrofork. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
import logging
|
|
from typing import Union, Optional, AsyncGenerator
|
|
|
|
import pyrogram
|
|
from pyrogram import raw
|
|
from pyrogram import types
|
|
from pyrogram import utils
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
class GetForumTopics:
|
|
async def get_forum_topics(
|
|
self: "pyrogram.Client",
|
|
chat_id: Union[int, str],
|
|
limit: int = 0,
|
|
offset_date: int = 0,
|
|
offset_topic: int = 0
|
|
) -> Optional[AsyncGenerator["types.ForumTopic", None]]:
|
|
"""Get one or more topic from a chat.
|
|
|
|
.. include:: /_includes/usable-by/users.rst
|
|
|
|
Parameters:
|
|
chat_id (``int`` | ``str``):
|
|
Unique identifier (int) or username (str) of the target chat.
|
|
You can also use chat public link in form of *t.me/<username>* (str).
|
|
|
|
limit (``int``, *optional*):
|
|
Limits the number of topics to be retrieved.
|
|
|
|
offset_date (``int``, *optional*):
|
|
The date of the topic to be used as offset.
|
|
|
|
offset_topic (``int``, *optional*):
|
|
The topic ID to be used as offset.
|
|
|
|
Returns:
|
|
``Generator``: On success, a generator yielding :obj:`~pyrogram.types.ForumTopic` objects is returned.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
# get all forum topics
|
|
async for topic in app.get_forum_topics(chat_id):
|
|
print(topic)
|
|
|
|
# get more than 100 forum topics
|
|
count = await app.get_forum_topics_count(chat_id) # get the count of all topics
|
|
slice = 100 # limit per request
|
|
pages = count // slice + 1 # number of requests needed
|
|
all_topics = [] # list to store all topics
|
|
for i in range(pages):
|
|
last_date = all_topics[-1].date if all_topics else 0 # date of the last found topic
|
|
last_topic = all_topics[-1].id if all_topics else 0 # id of the last found topic
|
|
async for topic in app.get_forum_topics(chat_id, limit=slice, offset_date=last_date, offset_topic=last_topic):
|
|
if topic not in all_topics:
|
|
all_topics.append(topic)
|
|
|
|
Raises:
|
|
ValueError: In case of invalid arguments.
|
|
"""
|
|
|
|
peer = await self.resolve_peer(chat_id)
|
|
|
|
rpc = raw.functions.channels.GetForumTopics(
|
|
channel=peer,
|
|
offset_date=offset_date,
|
|
offset_id=offset_topic,
|
|
offset_topic=offset_topic,
|
|
limit=limit
|
|
)
|
|
|
|
r = await self.invoke(rpc, sleep_threshold=-1)
|
|
|
|
for _topic in r.topics:
|
|
yield types.ForumTopic._parse(_topic)
|