From 55abd409f37c078cab2f79017a162a9602644d31 Mon Sep 17 00:00:00 2001 From: wulan17 Date: Wed, 4 Oct 2023 10:59:31 +0700 Subject: [PATCH] Pyrofork: Rename StoriesPrivacy to StoriesPrivacyRules Signed-off-by: wulan17 --- docs/source/api/enums/index.rst | 4 ++-- pyrogram/enums/__init__.py | 4 ++-- ...ories_privacy.py => stories_privacy_rules.py} | 4 ++-- pyrogram/methods/users/edit_story.py | 6 +++--- pyrogram/methods/users/send_story.py | 10 +++++----- pyrogram/types/messages_and_media/__init__.py | 4 ++-- ...ories_privacy.py => stories_privacy_rules.py} | 16 ++++++++-------- pyrogram/types/messages_and_media/story.py | 12 ++++++------ 8 files changed, 30 insertions(+), 30 deletions(-) rename pyrogram/enums/{stories_privacy.py => stories_privacy_rules.py} (89%) rename pyrogram/types/messages_and_media/{stories_privacy.py => stories_privacy_rules.py} (76%) diff --git a/docs/source/api/enums/index.rst b/docs/source/api/enums/index.rst index 26065242..8b685dd3 100644 --- a/docs/source/api/enums/index.rst +++ b/docs/source/api/enums/index.rst @@ -27,7 +27,7 @@ to apply only a valid value among the expected ones. SentCodeType NextCodeType UserStatus - StoriesPrivacy + StoriesPrivacyRules .. toctree:: :hidden: @@ -46,4 +46,4 @@ to apply only a valid value among the expected ones. SentCodeType NextCodeType UserStatus - StoriesPrivacy \ No newline at end of file + StoriesPrivacyRules diff --git a/pyrogram/enums/__init__.py b/pyrogram/enums/__init__.py index 042fded3..fcdeff5c 100644 --- a/pyrogram/enums/__init__.py +++ b/pyrogram/enums/__init__.py @@ -29,7 +29,7 @@ from .next_code_type import NextCodeType from .parse_mode import ParseMode from .poll_type import PollType from .sent_code_type import SentCodeType -from .stories_privacy import StoriesPrivacy +from .stories_privacy_rules import StoriesPrivacyRules from .user_status import UserStatus __all__ = [ @@ -46,6 +46,6 @@ __all__ = [ 'ParseMode', 'PollType', 'SentCodeType', - "StoriesPrivacy", + "StoriesPrivacyRules", 'UserStatus' ] diff --git a/pyrogram/enums/stories_privacy.py b/pyrogram/enums/stories_privacy_rules.py similarity index 89% rename from pyrogram/enums/stories_privacy.py rename to pyrogram/enums/stories_privacy_rules.py index 93e2e984..7a6f97c9 100644 --- a/pyrogram/enums/stories_privacy.py +++ b/pyrogram/enums/stories_privacy_rules.py @@ -21,8 +21,8 @@ from enum import auto from .auto_name import AutoName -class StoriesPrivacy(AutoName): - """Poll type enumeration used in :obj:`~pyrogram.types.Story`.""" +class StoriesPrivacyRules(AutoName): + """Stories privacy rules type enumeration used in :obj:`~pyrogram.method.SendStory`.""" PUBLIC = auto() "Public stories" diff --git a/pyrogram/methods/users/edit_story.py b/pyrogram/methods/users/edit_story.py index d810046c..a0dfde68 100644 --- a/pyrogram/methods/users/edit_story.py +++ b/pyrogram/methods/users/edit_story.py @@ -32,7 +32,7 @@ class EditStory: self: "pyrogram.Client", story_id: int, channel_id: int = None, - privacy: "enums.StoriesPrivacy" = None, + privacy: "enums.StoriesPrivacyRules" = None, allowed_users: List[int] = None, denied_users: List[int] = None, allowed_chats: List[int] = None, @@ -76,7 +76,7 @@ class EditStory: pass a file path as string to upload a new video that exists on your local machine, or pass a binary file-like object with its attribute ".name" set for in-memory uploads. - privacy (:obj:`~pyrogram.enums.StoriesPrivacy`, *optional*): + privacy (:obj:`~pyrogram.enums.StoriesPrivacyRules`, *optional*): Story privacy. allowed_chats (List of ``int``, *optional*): @@ -126,7 +126,7 @@ class EditStory: privacy_rules = None if privacy: - privacy_rules = [types.StoriesPrivacy(type=privacy)] + privacy_rules = [types.StoriesPrivacyRules(type=privacy)] if animation: if isinstance(animation, str): diff --git a/pyrogram/methods/users/send_story.py b/pyrogram/methods/users/send_story.py index ac0880d0..3d33130a 100644 --- a/pyrogram/methods/users/send_story.py +++ b/pyrogram/methods/users/send_story.py @@ -31,7 +31,7 @@ class SendStory: async def send_story( self: "pyrogram.Client", channel_id: int = None, - privacy: "enums.StoriesPrivacy" = None, + privacy: "enums.StoriesPrivacyRules" = None, allowed_users: List[int] = None, denied_users: List[int] = None, allowed_chats: List[int] = None, @@ -77,9 +77,9 @@ class SendStory: pass a file path as string to upload a new video that exists on your local machine, or pass a binary file-like object with its attribute ".name" set for in-memory uploads. - privacy (:obj:`~pyrogram.enums.StoriesPrivacy`, *optional*): + privacy (:obj:`~pyrogram.enums.StoriesPrivacyRules`, *optional*): Story privacy. - Defaults to :obj:`~pyrogram.enums.StoriesPrivacy.PUBLIC` + Defaults to :obj:`~pyrogram.enums.StoriesPrivacyRules.PUBLIC` allowed_chats (List of ``int``, *optional*): List of chat_id which participant allowed to view the story. @@ -136,9 +136,9 @@ class SendStory: peer = await self.resolve_peer("me") if privacy: - privacy_rules = [types.StoriesPrivacy(type=privacy)] + privacy_rules = [types.StoriesPrivacyRules(type=privacy)] else: - privacy_rules = [types.StoriesPrivacy(type=enums.StoriesPrivacy.PUBLIC)] + privacy_rules = [types.StoriesPrivacyRules(type=enums.StoriesPrivacyRules.PUBLIC)] if animation: if isinstance(animation, str): diff --git a/pyrogram/types/messages_and_media/__init__.py b/pyrogram/types/messages_and_media/__init__.py index 01aeb229..f839064a 100644 --- a/pyrogram/types/messages_and_media/__init__.py +++ b/pyrogram/types/messages_and_media/__init__.py @@ -31,7 +31,7 @@ from .poll_option import PollOption from .reaction import Reaction from .sticker import Sticker from .stickerset import StickerSet -from .stories_privacy import StoriesPrivacy +from .stories_privacy_rules import StoriesPrivacyRules from .stripped_thumbnail import StrippedThumbnail from .thumbnail import Thumbnail from .venue import Venue @@ -51,5 +51,5 @@ from .exported_story_link import ExportedStoryLink __all__ = [ "Animation", "Audio", "Contact", "Document", "Game", "Location", "Message", "MessageEntity", "Photo", "Thumbnail", "StrippedThumbnail", "Poll", "PollOption", "Sticker", "StickerSet", "Venue", "Video", "VideoNote", "Voice", "WebPage", "Dice", - "Reaction", "WebAppData", "MessageReactions", "MessageStory", "Story", "StoryDeleted", "StorySkipped", "StoryViews", "StoriesPrivacy", "ExportedStoryLink" + "Reaction", "WebAppData", "MessageReactions", "MessageStory", "Story", "StoryDeleted", "StorySkipped", "StoryViews", "StoriesPrivacyRules", "ExportedStoryLink" ] diff --git a/pyrogram/types/messages_and_media/stories_privacy.py b/pyrogram/types/messages_and_media/stories_privacy_rules.py similarity index 76% rename from pyrogram/types/messages_and_media/stories_privacy.py rename to pyrogram/types/messages_and_media/stories_privacy_rules.py index 512930b1..a709c598 100644 --- a/pyrogram/types/messages_and_media/stories_privacy.py +++ b/pyrogram/types/messages_and_media/stories_privacy_rules.py @@ -19,29 +19,29 @@ from pyrogram import enums, raw from ..object import Object -class StoriesPrivacy(Object): +class StoriesPrivacyRules(Object): """A story privacy. Parameters: - type (:obj:`~pyrogram.enums.StoriesPrivacy`): + type (:obj:`~pyrogram.enums.StoriesPrivacyRules`): Story privacy type. """ def __init__( self, *, - type: "enums.StoriesPrivacy" + type: "enums.StoriesPrivacyRules" ): super().__init__() self.type = type def write(self): - if self.type == enums.StoriesPrivacy.PUBLIC: + if self.type == enums.StoriesPrivacyRules.PUBLIC: return raw.types.InputPrivacyValueAllowAll().write() - if self.type == enums.StoriesPrivacy.CLOSE_FRIENDS: + if self.type == enums.StoriesPrivacyRules.CLOSE_FRIENDS: return raw.types.InputPrivacyValueAllowCloseFriends().write() - if self.type == enums.StoriesPrivacy.CONTACTS: + if self.type == enums.StoriesPrivacyRules.CONTACTS: return raw.types.InputPrivacyValueAllowContacts().write() - if self.type == enums.StoriesPrivacy.NO_CONTACTS: + if self.type == enums.StoriesPrivacyRules.NO_CONTACTS: return raw.types.InputPrivacyValueDisallowContacts().write() - if self.type == enums.StoriesPrivacy.PRIVATE: + if self.type == enums.StoriesPrivacyRules.PRIVATE: return raw.types.InputPrivacyValueDisallowAll().write() diff --git a/pyrogram/types/messages_and_media/story.py b/pyrogram/types/messages_and_media/story.py index 954647ee..5d508c5f 100644 --- a/pyrogram/types/messages_and_media/story.py +++ b/pyrogram/types/messages_and_media/story.py @@ -1364,7 +1364,7 @@ class Story(Object, Update): async def edit( self, - privacy: "enums.StoriesPrivacy" = None, + privacy: "enums.StoriesPrivacyRules" = None, allowed_users: List[int] = None, denied_users: List[int] = None, allowed_chats: List[int] = None, @@ -1418,7 +1418,7 @@ class Story(Object, Update): channel=self.sender_chat.id if self.sender_chat else None,new video that exists on your local machine, or pass a binary file-like object with its attribute ".name" set for in-memory uploads. - privacy (:obj:`~pyrogram.enums.StoriesPrivacy`, *optional*): + privacy (:obj:`~pyrogram.enums.StoriesPrivacyRules`, *optional*): Story privacy. allowed_chats (List of ``int``, *optional*): @@ -1548,7 +1548,7 @@ class Story(Object, Update): async def edit_privacy( self, - privacy: "enums.StoriesPrivacy" = None, + privacy: "enums.StoriesPrivacyRules" = None, allowed_users: List[int] = None, denied_users: List[int] = None, allowed_chats: List[int] = None, @@ -1562,16 +1562,16 @@ class Story(Object, Update): await client.edit_story( story_id=story.id, - privacy=enums.StoriesPrivacy.PUBLIC + privacy=enums.StoriesPrivacyRules.PUBLIC ) Example: .. code-block:: python - await story.edit_privacy(enums.StoriesPrivacy.PUBLIC) + await story.edit_privacy(enums.StoriesPrivacyRules.PUBLIC) Parameters: - privacy (:obj:`~pyrogram.enums.StoriesPrivacy`, *optional*): + privacy (:obj:`~pyrogram.enums.StoriesPrivacyRules`, *optional*): Story privacy. allowed_chats (List of ``int``, *optional*):