electrogram 2.185.4__tar.gz → 2.185.5__tar.gz

{electrogram-2.185.4 → electrogram-2.185.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: electrogram
-Version: 2.185.4
+Version: 2.185.5
 Summary: Telegram MTProto API framework in Python, designed for fluid user and bot interactions.
 Project-URL: homepage, https://github.com/5hojib/electrogram
 Project-URL: community, https://t.me/ProjectAeon

{electrogram-2.185.4 → electrogram-2.185.5}/build-docs.sh

@@ -1,10 +1,9 @@
 #!/bin/bash
 
-export DOCS_KEY
+export GITHUB_TOKEN
 VENV="$(pwd)/venv"
 export VENV
 
-
 make clean
 make clean-docs
 make venv
@@ -17,21 +16,20 @@ cd ../..
 
 "$VENV/bin/sphinx-build" -b html "docs/source" "docs/build/html" -j auto
 
-git clone https://5hojib:"$DOCS_KEY"@github.com/5hojib/Electrogram-docs.git
+git clone https://5hojib:"$GITHUB_TOKEN"@github.com/5hojib/Electrogram-docs.git
 cd Electrogram-docs
 
-mkdir -p main
-cd main
-
 rm -rf _includes api genindex.html intro py-modindex.html sitemap.xml \
        support.html topics _static faq index.html objects.inv \
        searchindex.js start telegram
 
-cp -r ../../docs/build/html/* .
-
+cp -r ../docs/build/html/* .
 git config --local user.name "5hojib"
 git config --local user.email "yesiamshojib@gmail.com"
-
 git add --all
-git commit -a -m "docs: main: Update docs $(date '+%Y-%m-%d | %H:%m:%S %p %Z')" --signoff
-git push -u origin --all
+git commit -m "Update docs" --signoff
+git checkout --orphan x
+git commit -m "Update docs" --signoff
+git branch -D main
+git branch -m main
+git push --force origin main

{electrogram-2.185.4 → electrogram-2.185.5}/compiler/docs/compiler.py

@@ -4,21 +4,20 @@ import ast
 import os
 import re
 import shutil
+from pathlib import Path
 
 HOME = "compiler/docs"
 DESTINATION = "docs/source/telegram"
 PYROGRAM_API_DEST = "docs/source/api"
-
 FUNCTIONS_PATH = "pyrogram/raw/functions"
 TYPES_PATH = "pyrogram/raw/types"
 BASE_PATH = "pyrogram/raw/base"
-
 FUNCTIONS_BASE = "functions"
 TYPES_BASE = "types"
 BASE_BASE = "base"
 
 
-def snek(s: str):
+def snake(s: str):
     s = re.sub(r"(.)([A-Z][a-z]+)", r"\1_\2", s)
     return re.sub(r"([a-z0-9])([A-Z])", r"\1_\2", s).lower()
 
@@ -34,7 +33,7 @@ def generate(source_path, base):
                 if not i.startswith("__"):
                     build("/".join([path, i]), level=level + 1)
             except NotADirectoryError:
-                with open(path + "/" + i, encoding="utf-8") as f:
+                with Path(path, i).open(encoding="utf-8") as f:
                     p = ast.parse(f.read())
 
                 for node in ast.walk(p):
@@ -45,10 +44,7 @@ def generate(source_path, base):
                     continue
 
                 full_path = (
-                    os.path.basename(path)
-                    + "/"
-                    + snek(name).replace("_", "-")
-                    + ".rst"
+                    Path(path).name + "/" + snake(name).replace("_", "-") + ".rst"
                 )
 
                 if level:
@@ -60,11 +56,11 @@ def generate(source_path, base):
 
                 full_name = f"{(namespace + '.') if namespace else ''}{name}"
 
-                os.makedirs(
-                    os.path.dirname(DESTINATION + "/" + full_path), exist_ok=True
+                Path(DESTINATION, full_path).parent.mkdir(
+                    parents=True, exist_ok=True
                 )
 
-                with open(DESTINATION + "/" + full_path, "w", encoding="utf-8") as f:
+                with Path(DESTINATION, full_path).open("w", encoding="utf-8") as f:
                     f.write(
                         page_template.format(
                             title=full_name,
@@ -84,10 +80,7 @@ def generate(source_path, base):
 
     for k, v in sorted(all_entities.items()):
         v = sorted(v)
-        entities = []
-
-        for i in v:
-            entities.append(f'{i} <{snek(i).replace("_", "-")}>')
+        entities = [f'{i} <{snake(i).replace("_", "-")}>' for i in v]
 
         if k != base:
             inner_path = base + "/" + k + "/index" + ".rst"
@@ -100,7 +93,7 @@ def generate(source_path, base):
             inner_path = base + "/index" + ".rst"
             module = f"pyrogram.raw.{base}"
 
-        with open(DESTINATION + "/" + inner_path, "w", encoding="utf-8") as f:
+        with Path(DESTINATION, inner_path).open("w", encoding="utf-8") as f:
             if k == base:
                 f.write(":tocdepth: 1\n\n")
                 k = "Raw " + k
@@ -414,12 +407,12 @@ def pyrogram_api():
     root = PYROGRAM_API_DEST + "/methods"
 
     shutil.rmtree(root, ignore_errors=True)
-    os.mkdir(root)
+    Path(root).mkdir()
 
-    with open(HOME + "/template/methods.rst") as f:
+    with Path(HOME, "template/methods.rst").open() as f:
         template = f.read()
 
-    with open(root + "/index.rst", "w") as f:
+    with Path(root, "index.rst").open("w") as f:
         fmt_keys = {}
 
         for k, v in categories.items():
@@ -427,7 +420,7 @@ def pyrogram_api():
             fmt_keys.update({k: "\n    ".join(f"{m} <{m}>" for m in methods)})
 
             for method in methods:
-                with open(root + f"/{method}.rst", "w") as f2:
+                with Path(root, f"{method}.rst").open("w") as f2:
                     title = f"{method}()"
 
                     f2.write(title + "\n" + "=" * len(title) + "\n\n")
@@ -436,7 +429,7 @@ def pyrogram_api():
             functions = ["idle", "compose"]
 
             for func in functions:
-                with open(root + f"/{func}.rst", "w") as f2:
+                with Path(root, f"{func}.rst").open("w") as f2:
                     title = f"{func}()"
 
                     f2.write(title + "\n" + "=" * len(title) + "\n\n")
@@ -503,6 +496,8 @@ def pyrogram_api():
             Venue
             Sticker
             StickerSet
+            ContactRegistered
+            ScreenshotTaken
             Game
             GiftedPremium
             Giveaway
@@ -691,12 +686,12 @@ def pyrogram_api():
     root = PYROGRAM_API_DEST + "/types"
 
     shutil.rmtree(root, ignore_errors=True)
-    os.mkdir(root)
+    Path(root).mkdir()
 
-    with open(HOME + "/template/types.rst") as f:
+    with Path(HOME, "template/types.rst").open() as f:
         template = f.read()
 
-    with open(root + "/index.rst", "w") as f:
+    with Path(root, "index.rst").open("w") as f:
         fmt_keys = {}
 
         for k, v in categories.items():
@@ -705,7 +700,7 @@ def pyrogram_api():
             fmt_keys.update({k: "\n    ".join(types)})
 
             for type in types:
-                with open(root + f"/{type}.rst", "w") as f2:
+                with Path(root, f"{type}.rst").open("w") as f2:
                     title = f"{type}"
 
                     f2.write(title + "\n" + "=" * len(title) + "\n\n")
@@ -836,17 +831,21 @@ def pyrogram_api():
             ChatJoinRequest.approve
             ChatJoinRequest.decline
         """,
+        "active_session": """
+        ActiveSession
+            ActiveSession.reset
+        """,
     }
 
     root = PYROGRAM_API_DEST + "/bound-methods"
 
     shutil.rmtree(root, ignore_errors=True)
-    os.mkdir(root)
+    Path(root).mkdir()
 
-    with open(HOME + "/template/bound-methods.rst") as f:
+    with Path(HOME, "template/bound-methods.rst").open() as f:
         template = f.read()
 
-    with open(root + "/index.rst", "w") as f:
+    with Path(root, "index.rst").open("w") as f:
         fmt_keys = {}
 
         for k, v in categories.items():
@@ -869,9 +868,8 @@ def pyrogram_api():
                 }
             )
 
-            # noinspection PyShadowingBuiltins
             for bm in bound_methods:
-                with open(root + f"/{bm}.rst", "w") as f2:
+                with Path(root, f"{bm}.rst").open("w") as f2:
                     title = f"{bm}()"
 
                     f2.write(title + "\n" + "=" * len(title) + "\n\n")
@@ -881,15 +879,14 @@ def pyrogram_api():
 
 
 def start():
-    global page_template
-    global toctree
+    global page_template, toctree  # noqa: PLW0603
 
     shutil.rmtree(DESTINATION, ignore_errors=True)
 
-    with open(HOME + "/template/page.txt", encoding="utf-8") as f:
+    with Path(HOME, "template/page.txt").open(encoding="utf-8") as f:
         page_template = f.read()
 
-    with open(HOME + "/template/toctree.txt", encoding="utf-8") as f:
+    with Path(HOME, "template/toctree.txt").open(encoding="utf-8") as f:
         toctree = f.read()
 
     generate(TYPES_PATH, TYPES_BASE)

{electrogram-2.185.4 → electrogram-2.185.5}/compiler/docs/template/bound-methods.rst

@@ -27,7 +27,7 @@ Message
 -------
 
 .. hlist::
-    :columns: 3
+    :columns: 1
 
     {message_hlist}
 
@@ -40,7 +40,7 @@ Story
 -----
 
 .. hlist::
-    :columns: 3
+    :columns: 1
 
     {story_hlist}
 
@@ -53,7 +53,7 @@ Chat
 ----
 
 .. hlist::
-    :columns: 4
+    :columns: 1
 
     {chat_hlist}
 
@@ -66,7 +66,7 @@ User
 ----
 
 .. hlist::
-    :columns: 2
+    :columns: 1
 
     {user_hlist}
 
@@ -79,7 +79,7 @@ CallbackQuery
 -------------
 
 .. hlist::
-    :columns: 3
+    :columns: 1
 
     {callback_query_hlist}
 
@@ -92,7 +92,7 @@ InlineQuery
 -----------
 
 .. hlist::
-    :columns: 2
+    :columns: 1
 
     {inline_query_hlist}
 
@@ -105,7 +105,7 @@ PreCheckoutQuery
 ----------------
 
 .. hlist::
-    :columns: 2
+    :columns: 1
 
     {pre_checkout_query_hlist}
 
@@ -118,7 +118,7 @@ ShippingQuery
 -------------
 
 .. hlist::
-    :columns: 2
+    :columns: 1
 
     {shipping_query_hlist}
 
@@ -131,7 +131,7 @@ ChatJoinRequest
 ---------------
 
 .. hlist::
-    :columns: 2
+    :columns: 1
 
     {chat_join_request_hlist}
 
@@ -144,7 +144,7 @@ ActiveSession
 -------------
 
 .. hlist::
-    :columns: 2
+    :columns: 1
 
     {active_session_hlist}
 

{electrogram-2.185.4 → electrogram-2.185.5}/compiler/errors/compiler.py

@@ -8,7 +8,6 @@ from pathlib import Path
 
 ERRORS_HOME_PATH = Path(__file__).parent.resolve()
 REPO_HOME_PATH = ERRORS_HOME_PATH.parent.parent
-
 ERRORS_DEST_PATH = REPO_HOME_PATH / "pyrogram" / "errors" / "exceptions"
 
 

{electrogram-2.185.4 → electrogram-2.185.5}/docs/source/api/decorators.rst

@@ -33,7 +33,7 @@ Index
 -----
 
 .. hlist::
-    :columns: 3
+    :columns: 1
 
     - :meth:`~Client.on_bot_business_connect`
     - :meth:`~Client.on_message`

electrogram-2.185.5/docs/source/api/enums/BusinessSchedule.rst

@@ -0,0 +1,8 @@
+BusinessSchedule
+================
+
+.. autoclass:: pyrogram.enums.BusinessSchedule()
+    :members:
+
+.. raw:: html
+    :file: ./cleanup.html

electrogram-2.185.5/docs/source/api/enums/ChatJoinType.rst

@@ -0,0 +1,8 @@
+ChatJoinType
+============
+
+.. autoclass:: pyrogram.enums.ChatJoinType()
+    :members:
+
+.. raw:: html
+    :file: ./cleanup.html

electrogram-2.185.5/docs/source/api/enums/ClientPlatform.rst

@@ -0,0 +1,8 @@
+ClientPlatform
+==============
+
+.. autoclass:: pyrogram.enums.ClientPlatform()
+    :members:
+
+.. raw:: html
+    :file: ./cleanup.html

electrogram-2.185.5/docs/source/api/enums/PrivacyKey.rst

@@ -0,0 +1,8 @@
+PrivacyKey
+==========
+
+.. autoclass:: pyrogram.enums.PrivacyKey()
+    :members:
+
+.. raw:: html
+    :file: ./cleanup.html

electrogram-2.185.5/docs/source/api/enums/ProfileColor.rst

@@ -0,0 +1,8 @@
+ProfileColor
+============
+
+.. autoclass:: pyrogram.enums.ProfileColor()
+    :members:
+
+.. raw:: html
+    :file: ./cleanup.html

electrogram-2.185.5/docs/source/api/enums/ReplyColor.rst

@@ -0,0 +1,8 @@
+ReplyColor
+==========
+
+.. autoclass:: pyrogram.enums.ReplyColor()
+    :members:
+
+.. raw:: html
+    :file: ./cleanup.html

{electrogram-2.185.4 → electrogram-2.185.5}/docs/source/api/enums/index.rst

@@ -16,43 +16,54 @@ to apply only a valid value among the expected ones.
     BusinessSchedule
     ChatAction
     ChatEventAction
+    ChatJoinType
     ChatMemberStatus
     ChatMembersFilter
     ChatType
+    ClientPlatform
     FolderColor
     ListenerTypes
     MessageEntityType
     MessageMediaType
     MessageServiceType
     MessagesFilter
+    NextCodeType
     ParseMode
     PollType
-    SentCodeType
-    NextCodeType
-    UserStatus
+    PrivacyKey
+    ProfileColor
     ReactionType
+    ReplyColor
+    SentCodeType
     StoriesPrivacyRules
     StoryPrivacy
+    UserStatus
 
 .. toctree::
     :hidden:
 
+    BusinessSchedule
     ChatAction
     ChatEventAction
+    ChatJoinType
     ChatMemberStatus
     ChatMembersFilter
     ChatType
+    ClientPlatform
     FolderColor
     ListenerTypes
     MessageEntityType
     MessageMediaType
     MessageServiceType
     MessagesFilter
+    NextCodeType
     ParseMode
     PollType
-    SentCodeType
-    NextCodeType
-    UserStatus
+    PrivacyKey
+    ProfileColor
     ReactionType
+    ReplyColor
+    SentCodeType
     StoriesPrivacyRules
     StoryPrivacy
+    UserStatus

{electrogram-2.185.4 → electrogram-2.185.5}/docs/source/api/handlers.rst

@@ -33,7 +33,7 @@ Index
 -----
 
 .. hlist::
-    :columns: 3
+    :columns: 1
 
     - :class:`BotBusinessConnectHandler`
     - :class:`MessageHandler`

{electrogram-2.185.4 → electrogram-2.185.5}/docs/source/conf.py

@@ -1,14 +1,14 @@
 from __future__ import annotations
 
-import os
 import sys
+from pathlib import Path
 
 from pygments.styles.friendly import FriendlyStyle
 
 from pyrogram import __version__
 
 # Set the system path
-sys.path.insert(0, os.path.abspath("../.."))
+sys.path.insert(0, str(Path("../..").resolve()))
 
 # Set the background color for Pygments style
 FriendlyStyle.background_color = "#f3f2f1"
@@ -38,7 +38,6 @@ autodoc_member_order = "bysource"
 
 # Paths for templates and static files
 templates_path = ["../resources/templates"]
-html_static_path = ["../resources/static", "_static"]
 
 # HTML options
 html_copy_source = False

{electrogram-2.185.4 → electrogram-2.185.5}/pyrogram/__init__.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-__version__ = "v2.185.4"
+__version__ = "v2.185.5"
 __license__ = "MIT License"
 
 from concurrent.futures.thread import ThreadPoolExecutor

{electrogram-2.185.4 → electrogram-2.185.5}/pyrogram/enums/__init__.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 from .business_schedule import BusinessSchedule
 from .chat_action import ChatAction
 from .chat_event_action import ChatEventAction
+from .chat_join_type import ChatJoinType
 from .chat_member_status import ChatMemberStatus
 from .chat_members_filter import ChatMembersFilter
 from .chat_type import ChatType
@@ -32,6 +33,7 @@ __all__ = [
     "ChatMemberStatus",
     "ChatMembersFilter",
     "ChatType",
+    "ChatJoinType",
     "ClientPlatform",
     "FolderColor",
     "ListenerTypes",

electrogram-2.185.5/pyrogram/enums/chat_join_type.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from enum import auto
+
+from .auto_name import AutoName
+
+
+class ChatJoinType(AutoName):
+    """How the service message :obj:`~pyrogram.enums.MessageServiceType.NEW_CHAT_MEMBERS` was used for the member to join the chat."""
+
+    BY_ADD = auto()
+    "A new member joined the chat via an invite link"
+
+    BY_LINK = auto()
+    "A new member joined the chat via an invite link"
+
+    BY_REQUEST = auto()
+    "A new member was accepted to the chat by an administrator"

{electrogram-2.185.4 → electrogram-2.185.5}/pyrogram/enums/message_service_type.py

@@ -100,3 +100,12 @@ class MessageServiceType(AutoName):
 
     BOT_ALLOWED = auto()
     "Bot allowed"
+
+    CONTACT_REGISTERED = auto()
+    "A contact has registered with Telegram"
+
+    SCREENSHOT_TAKEN = auto()
+    "A screenshot of a message in the chat has been taken"
+
+    UNKNOWN_EMPTY = auto()
+    "This service message is unsupported by the current version of Electrogram"

{electrogram-2.185.4 → electrogram-2.185.5}/pyrogram/types/authorization/active_session.py

@@ -47,7 +47,10 @@ class ActiveSession(Object):
             A human-readable description of the location from which the session was created, based on the IP address.
 
         country (``str``):
-            Country.
+            Country determined from IP.
+
+        region (``str``):
+            Region determined from IP.
 
         is_current (``bool``):
             True, if this session is the current session.
@@ -84,13 +87,14 @@ class ActiveSession(Object):
         ip_address: str | None = None,
         location: str | None = None,
         country: str | None = None,
+        region: str | None = None,
         is_current: bool | None = None,
         is_password_pending: bool | None = None,
         is_unconfirmed: bool | None = None,
         can_accept_secret_chats: bool | None = None,
         can_accept_calls: bool | None = None,
         is_official_application: bool | None = None,
-    ) -> None:
+    ):
         super().__init__()
 
         self.id = id
@@ -105,6 +109,7 @@ class ActiveSession(Object):
         self.ip_address = ip_address
         self.location = location
         self.country = country
+        self.region = region
         self.is_current = is_current
         self.is_password_pending = is_password_pending
         self.is_unconfirmed = is_unconfirmed
@@ -127,6 +132,7 @@ class ActiveSession(Object):
             ip_address=session.ip,
             location=session.region,
             country=session.country,
+            region=session.region,
             is_current=getattr(session, "current", None),
             is_password_pending=getattr(session, "password_pending", None),
             is_unconfirmed=getattr(session, "unconfirmed", None),
@@ -136,3 +142,26 @@ class ActiveSession(Object):
             can_accept_calls=not getattr(session, "call_requests_disabled", False),
             is_official_application=getattr(session, "official_app", None),
         )
+
+    async def reset(self):
+        """Bound method *reset* of :obj:`~pyrogram.types.ActiveSession`.
+
+        Use as a shortcut for:
+
+        .. code-block:: python
+
+            await client.reset_session(123456789)
+
+        Example:
+            .. code-block:: python
+
+                await session.reset()
+
+        Returns:
+            True on success.
+
+        Raises:
+            RPCError: In case of a Telegram RPC error.
+        """
+
+        return await self._client.reset_session(self.id)

{electrogram-2.185.4 → electrogram-2.185.5}/pyrogram/types/input_privacy_rule/input_privacy_rule_allow_all.py

@@ -14,5 +14,8 @@ class InputPrivacyRuleAllowAll(InputPrivacyRule):
     ):
         super().__init__()
 
-    async def write(self, client: pyrogram.Client):
+    async def write(
+        self,
+        client: pyrogram.Client,  # noqa: ARG002
+    ):
         return raw.types.InputPrivacyValueAllowAll()

{electrogram-2.185.4 → electrogram-2.185.5}/pyrogram/types/input_privacy_rule/input_privacy_rule_allow_contacts.py

@@ -14,5 +14,8 @@ class InputPrivacyRuleAllowContacts(InputPrivacyRule):
     ):
         super().__init__()
 
-    async def write(self, client: pyrogram.Client):
+    async def write(
+        self,
+        client: pyrogram.Client,  # noqa: ARG002
+    ):
         return raw.types.InputPrivacyValueAllowContacts()

{electrogram-2.185.4 → electrogram-2.185.5}/pyrogram/types/input_privacy_rule/input_privacy_rule_allow_premium.py

@@ -14,5 +14,8 @@ class InputPrivacyRuleAllowPremium(InputPrivacyRule):
     ):
         super().__init__()
 
-    async def write(self, client: pyrogram.Client):
+    async def write(
+        self,
+        client: pyrogram.Client,  # noqa: ARG002
+    ):
         return raw.types.InputPrivacyValueAllowPremium()