Source code for pyrogram.methods.stories.get_stories

#  Pyrogram - Telegram MTProto API Client Library for Python
#  Copyright (C) 2017-present Dan <https://github.com/delivrance>
#
#  This file is part of Pyrogram.
#
#  Pyrogram 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.
#
#  Pyrogram 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 Pyrogram.  If not, see <http://www.gnu.org/licenses/>.

from __future__ import annotations

import re

import pyrogram
from pyrogram import raw, types
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from collections.abc import Iterable


class GetStories:
    async def get_stories(
        self: pyrogram.Client,
        chat_id: int | str | None = None,
        story_ids: int | Iterable[int] | str | None = None,
    ) -> types.Story | list[types.Story] | None:
        """Get one or more stories from a chat by using stories identifiers.

        .. include:: /_includes/usable-by/users.rst

        Parameters:
            chat_id (``int`` | ``str``, *optional*):
                Unique identifier (int) or username (str) of the target user.
                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 (``int`` | Iterable of ``int`` | ``str``, *optional*):
                Pass a single story identifier or an iterable of story ids (as integers)
                or link to get the content of the story themselves.

        Returns:
            :obj:`~pyrogram.types.Story` | List of :obj:`~pyrogram.types.Story`: In case *story_ids* was not
            a list, a single story is returned, otherwise a list of stories is returned.

        Example:
            .. code-block:: python

                # Get stories by id
                stories = await app.get_stories(chat_id, [1, 2, 3])

                for story in stories:
                    print(story)

        Raises:
            ValueError: In case of invalid arguments.
        """
        is_iterable = not isinstance(story_ids, (int, str)) if story_ids is not None else False
        ids = None if story_ids is None else list(story_ids) if is_iterable else [story_ids]

        if isinstance(story_ids, str):
            match = re.match(
                r"^(?:https?://)?(?:www\.)?(?:t(?:elegram)?\.(?:org|me|dog)/)([\w]+)/s/(\d+)/?$",
                story_ids.lower(),
            )

            if match:
                chat_id = match.group(1)
                ids = [int(match.group(2))]
            else:
                raise ValueError("Invalid story link")
        else:
            if not chat_id:
                raise ValueError("Invalid chat_id.")

            if ids is None:
                raise ValueError("Invalid story_ids.")

        peer = await self.resolve_peer(chat_id)
        r = await self.invoke(raw.functions.stories.GetStoriesByID(peer=peer, id=ids))

        stories = types.List()

        users = {i.id: i for i in r.users}
        chats = {i.id: i for i in r.chats}

        for story in r.stories:
            stories.append(await types.Story._parse(self, story, peer, users, chats))

        return stories if is_iterable else stories[0] if stories else None