TeamPGM/pyrogram
2
0
Fork 0
mirror of https://github.com/TeamPGM/pyrogram.git synced 2024-11-23 23:34:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update story methods description

Browse Source
This commit is contained in:
KurimuzonAkuma 2023-12-07 23:09:17 +03:00
parent 750dd00105
commit fc0d9af76a
18 changed files with 92 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
compiler/docs/compiler.py
View File

@ -347,20 +347,22 @@ def pyrogram_api():
""",
stories="""
Stories
can_send_story
copy_story
delete_stories
edit_story
export_story_link
forward_story
get_all_stories
get_chat_stories
get_pinned_stories
get_stories_archive
get_stories
hide_stories
increment_story_views
pin_stories
read_stories
send_story
pin_stories
hide_stories
can_send_story
get_pinned_stories
copy_story
forward_story
""",
premium="""
Premium

4
pyrogram/methods/stories/__init__.py
View File

@ -23,7 +23,7 @@ from .edit_story import EditStory
from .export_story_link import ExportStoryLink
from .forward_story import ForwardStory
from .get_all_stories import GetAllStories
from .get_peer_stories import GetPeerStories
from .get_chat_stories import GetChatStories
from .get_pinned_stories import GetPinnedStories
from .get_stories import GetStories
from .get_stories_archive import GetStoriesArchive
@ -41,7 +41,7 @@ class Stories(
ExportStoryLink,
ForwardStory,
GetAllStories,
GetPeerStories,
GetChatStories,
GetPinnedStories,
GetStories,
GetStoriesArchive,

5
pyrogram/methods/stories/can_send_story.py
View File

@ -16,11 +16,10 @@
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
from typing import Union, Iterable
from typing import Union
import pyrogram
from pyrogram import raw
from pyrogram import types
class CanSendStory:
@ -30,7 +29,7 @@ class CanSendStory:
) -> bool:
"""Can send story
.. include:: /_includes/usable-by/users-bots.rst
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):

9
pyrogram/methods/stories/copy_story.py
View File

@ -17,11 +17,10 @@
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
import logging
from datetime import datetime
from typing import Union, List, Optional
import pyrogram
from pyrogram import types, enums, utils
from pyrogram import types, enums
log = logging.getLogger(__name__)
@ -43,7 +42,7 @@ class CopyStory:
) -> "types.Story":
"""Copy story.
.. include:: /_includes/usable-by/users-bots.rst
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):
@ -71,13 +70,13 @@ class CopyStory:
Story privacy.
Defaults to :obj:`~pyrogram.enums.StoriesPrivacyRules.PUBLIC`
allowed_users (List of ``int``, *optional*):
allowed_users (List of ``int`` | ``str``, *optional*):
List of user_id or chat_id of chat users who are allowed to view stories.
Note: chat_id available only with :obj:`~pyrogram.enums.StoriesPrivacyRules.SELECTED_USERS`.
Works with :obj:`~pyrogram.enums.StoriesPrivacyRules.CLOSE_FRIENDS`
and :obj:`~pyrogram.enums.StoriesPrivacyRules.SELECTED_USERS` only
disallowed_users (List of ``int``, *optional*):
disallowed_users (List of ``int`` | ``str``, *optional*):
List of user_id whos disallow to view the stories.
Note: Works with :obj:`~pyrogram.enums.StoriesPrivacyRules.PUBLIC`
and :obj:`~pyrogram.enums.StoriesPrivacyRules.CONTACTS` only

4
pyrogram/methods/stories/delete_stories.py
View File

@ -31,7 +31,7 @@ class DeleteStories:
) -> List[int]:
"""Delete stories.
.. include:: /_includes/usable-by/users-bots.rst
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):
@ -39,7 +39,7 @@ class DeleteStories:
For your personal cloud (Saved Messages) you can simply use "me" or "self".
For a contact that exists in your Telegram address book you can use his phone number (str).
story_ids (``int`` | ``list``):
story_ids (``int`` | Iterable of ``int``, *optional*):
Unique identifier (int) or list of unique identifiers (list of int) for the target stories.
Returns:

49
pyrogram/methods/stories/edit_story.py
View File

@ -17,7 +17,6 @@
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
import os
import re
from typing import List, Union, BinaryIO, Callable
import pyrogram
@ -81,7 +80,6 @@ class EditStory:
privacy (:obj:`~pyrogram.enums.StoriesPrivacyRules`, *optional*):
Story privacy.
Defaults to :obj:`~pyrogram.enums.StoriesPrivacyRules.PUBLIC`
allowed_users (List of ``int``, *optional*):
List of user_id or chat_id of chat users who are allowed to view stories.
@ -118,20 +116,53 @@ class EditStory:
Example:
.. code-block:: python
# Send new photo story
photo_id = "abcd12345"
await app.edit_story(meida=photo_id, caption='Hello guys.')
# Edit story in your profile
await app.edit_story("me", "story.png", caption='My new story!')
# Edit story in channel
await app.edit_story(123456, "story.png", caption='My new story!')
Raises:
ValueError: In case of invalid arguments.
"""
# TODO: media_areas
if privacy:
privacy_rules = [types.StoriesPrivacyRules(type=privacy)]
message, entities = (await utils.parse_text_entities(self, caption, parse_mode, caption_entities)).values()
privacy_rules = []
if privacy:
if privacy == enums.StoriesPrivacyRules.PUBLIC:
privacy_rules.append(raw.types.InputPrivacyValueAllowAll())
if disallowed_users:
users = [await self.resolve_peer(user_id) for user_id in disallowed_users]
privacy_rules.append(raw.types.InputPrivacyValueDisallowUsers(users=users))
elif privacy == enums.StoriesPrivacyRules.CONTACTS:
privacy_rules = [raw.types.InputPrivacyValueAllowContacts()]
if disallowed_users:
users = [await self.resolve_peer(user_id) for user_id in disallowed_users]
privacy_rules.append(raw.types.InputPrivacyValueDisallowUsers(users=users))
elif privacy == enums.StoriesPrivacyRules.CLOSE_FRIENDS:
privacy_rules = [raw.types.InputPrivacyValueAllowCloseFriends()]
if allowed_users:
users = [await self.resolve_peer(user_id) for user_id in allowed_users]
privacy_rules.append(raw.types.InputPrivacyValueAllowUsers(users=users))
elif privacy == enums.StoriesPrivacyRules.SELECTED_USERS:
_allowed_users = []
_allowed_chats = []
for user in allowed_users:
peer = await self.resolve_peer(user)
if isinstance(peer, raw.types.InputPeerUser):
_allowed_users.append(peer)
elif isinstance(peer, raw.types.InputPeerChat):
_allowed_chats.append(peer)
if _allowed_users:
privacy_rules.append(raw.types.InputPrivacyValueAllowUsers(users=_allowed_users))
if _allowed_chats:
privacy_rules.append(raw.types.InputPrivacyValueAllowChatParticipants(chats=_allowed_chats))
try:
if isinstance(media, str):
if os.path.isfile(media):
@ -208,7 +239,7 @@ class EditStory:
peer = await self.resolve_peer(user)
if isinstance(peer, raw.types.InputPeerUser):
_allowed_users.append(peer)
elif isinstance(peer, raw.types.InputPeerChat):
elif isinstance(peer, (raw.types.InputPeerChat, raw.types.InputPeerChannel)):
_allowed_chats.append(peer)
if _allowed_users:

5
pyrogram/methods/stories/export_story_link.py
View File

@ -20,7 +20,6 @@ from typing import Union
import pyrogram
from pyrogram import raw
from pyrogram import types
class ExportStoryLink:
@ -28,10 +27,10 @@ class ExportStoryLink:
self: "pyrogram.Client",
chat_id: Union[int, str],
story_id: int,
) -> "types.ExportedStoryLink":
) -> str:
"""Export a story link.
.. include:: /_includes/usable-by/users-bots.rst
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):

8
pyrogram/methods/stories/forward_story.py
View File

@ -36,7 +36,7 @@ class ForwardStory:
) -> Optional["types.Message"]:
"""Send story.
.. include:: /_includes/usable-by/users-bots.rst
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):
@ -53,7 +53,7 @@ class ForwardStory:
Unique identifier of story.
disable_notification (``bool``, *optional*):
Sends the message silently.
Sends the message with story silently.
Users will receive a notification with no sound.
message_thread_id (``int``, *optional*):
@ -64,13 +64,13 @@ class ForwardStory:
Date when the message will be automatically sent.
Returns:
:obj:`~pyrogram.types.Message`: On success, the sent stoty message is returned.
:obj:`~pyrogram.types.Message`: On success, the sent story message is returned.
Example:
.. code-block:: python
# Send your story to chat_id
await app.forward_story(chat_id, "me", 1)
await app.forward_story(to_chat, from_chat, 123)
"""
r = await self.invoke(
raw.functions.messages.SendMedia(

2
pyrogram/methods/stories/get_all_stories.py
View File

@ -16,7 +16,7 @@
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
from typing import AsyncGenerator, Union, Optional
from typing import AsyncGenerator, Optional
import pyrogram
from pyrogram import raw

12
pyrogram/methods/stories/get_peer_stories.py → pyrogram/methods/stories/get_chat_stories.py
View File

@ -16,19 +16,19 @@
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
from typing import AsyncGenerator, Union, Optional
from typing import AsyncGenerator, Union
import pyrogram
from pyrogram import raw
from pyrogram import types
class GetPeerStories:
async def get_peer_stories(
class GetChatStories:
async def get_chat_stories(
self: "pyrogram.Client",
chat_id: Union[int, str]
) -> AsyncGenerator["types.Story", None]:
"""Get all active stories from an user by using user identifiers.
"""Get all non expired stories from a chat by using chat identifier.
.. include:: /_includes/usable-by/users.rst
@ -44,8 +44,8 @@ class GetPeerStories:
Example:
.. code-block:: python
# Get all active story from spesific user
async for story in app.get_peer_stories(chat_id):
# Get all non expired stories from spesific chat
async for story in app.get_chat_stories(chat_id):
print(story)
Raises:

6
pyrogram/methods/stories/get_pinned_stories.py
View File

@ -16,7 +16,7 @@
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
from typing import AsyncGenerator, Union, Optional
from typing import AsyncGenerator, Union
import pyrogram
from pyrogram import raw
@ -31,7 +31,7 @@ class GetPinnedStories:
offset_id: int = 0,
limit: int = 0,
) -> AsyncGenerator["types.Story", None]:
"""Get pinned stories stories.
"""Get all pinned stories from a chat by using chat identifier.
.. include:: /_includes/usable-by/users.rst
@ -54,7 +54,7 @@ class GetPinnedStories:
.. code-block:: python
# Get all pinned story
async for story in app.get_pinned_stories():
async for story in app.get_pinned_stories(chat_id):
print(story)
"""
current = 0

8
pyrogram/methods/stories/get_stories.py
View File

@ -29,9 +29,9 @@ class GetStories:
chat_id: Union[int, str],
story_ids: Union[int, Iterable[int]],
) -> "types.Stories":
"""Get stories by id.
"""Get one or more stories from a chat by using stories identifiers.
.. include:: /_includes/usable-by/users-bots.rst
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):
@ -39,7 +39,7 @@ class GetStories:
For your personal story you can simply use "me" or "self".
For a contact that exists in your Telegram address book you can use his phone number (str).
story_ids (List of ``int`` ``32-bit``):
story_ids (``int`` | Iterable of ``int``, *optional*):
Pass a single story identifier or an iterable of story ids (as integers) to get the content of the
story themselves.
@ -51,7 +51,7 @@ class GetStories:
.. code-block:: python
# Get stories by id
stories = await app.get_stories_by_id(chat_id, [1, 2, 3])
stories = await app.get_stories(chat_id, [1, 2, 3])
for story in stories:
print(story)

4
pyrogram/methods/stories/get_stories_archive.py
View File

@ -16,7 +16,7 @@
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
from typing import AsyncGenerator, Union, Optional
from typing import AsyncGenerator, Union
import pyrogram
from pyrogram import raw
@ -30,7 +30,7 @@ class GetStoriesArchive:
limit: int = 0,
offset_id: int = 0
) -> AsyncGenerator["types.Story", None]:
"""Get stories archive.
"""Get all archived stories from a chat by using chat identifier.
.. include:: /_includes/usable-by/users.rst

2
pyrogram/methods/stories/hide_stories.py
View File

@ -30,7 +30,7 @@ class HideStories:
) -> bool:
"""Toggle peer stories hidden
.. include:: /_includes/usable-by/users-bots.rst
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):

3
pyrogram/methods/stories/increment_story_views.py
View File

@ -30,12 +30,11 @@ class IncrementStoryViews:
) -> bool:
"""Increment story views.
.. include:: /_includes/usable-by/users-bots.rst
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
For your personal cloud (Saved Messages) you can simply use "me" or "self".
For a contact that exists in your Telegram address book you can use his phone number (str).
story_id (``int``):

6
pyrogram/methods/stories/pin_stories.py
View File

@ -30,16 +30,16 @@ class PinStories:
stories_ids: Union[int, Iterable[int]],
pinned: bool = False,
) -> List[int]:
"""Toggle stories pinned.
"""Pin one or more stories in a chat by using stories identifiers.
.. include:: /_includes/usable-by/users-bots.rst
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
For your personal cloud (Saved Messages) you can simply use "me" or "self".
stories_ids (List of ``int`` ``32-bit``):
stories_ids (``int`` | Iterable of ``int``, *optional*):
List of unique identifiers of the target stories.
pinned (``bool``):

3
pyrogram/methods/stories/read_stories.py
View File

@ -30,12 +30,11 @@ class ReadStories:
) -> List[int]:
"""Read stories.
.. include:: /_includes/usable-by/users-bots.rst
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
For your personal cloud (Saved Messages) you can simply use "me" or "self".
For a contact that exists in your Telegram address book you can use his phone number (str).
max_id (``int``, *optional*):

9
pyrogram/methods/stories/send_story.py
View File

@ -131,8 +131,11 @@ class SendStory:
Example:
.. code-block:: python
# Send new story
await app.send_story(media=file_id, caption='Hello guys.')
# Post story to your profile
await app.send_story("me", "story.png", caption='My new story!')
# Post story to channel
await app.send_story(123456, "story.png", caption='My new story!')
Raises:
ValueError: In case of invalid arguments.
@ -217,7 +220,7 @@ class SendStory:
peer = await self.resolve_peer(user)
if isinstance(peer, raw.types.InputPeerUser):
_allowed_users.append(peer)
elif isinstance(peer, raw.types.InputPeerChat):
elif isinstance(peer, (raw.types.InputPeerChat, raw.types.InputPeerChannel)):
_allowed_chats.append(peer)
if _allowed_users: