feat: Add support for alternative video qualities in messages.

5hojib · web-flow · commit 26a8f7bb7bd0 · 2024-11-08T23:41:40.000+06:00
New Features:

- Introduce support for alternative video qualities in the message handling, allowing for different video resolutions and codecs.

CI:

- Update the CI workflow to use the latest version of the 'create-pull-request' action and specify the version for 'setup-rye'.

Documentation:

- Add documentation for the new 'AlternativeVideo' class, describing its attributes and usage.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "22:00"
+    open-pull-requests-limit: 10
diff --git a/.github/workflows/error_scrape.yml b/.github/workflows/error_scrape.yml
@@ -22,7 +22,7 @@ jobs:
           python sort.py sort
 
     - name: Open Pull Request
-      uses: peter-evans/create-pull-request@v4
+      uses: peter-evans/create-pull-request@v7
       with:
         commit-message: >
           Update unknown_errors
@@ -32,4 +32,4 @@ jobs:
           This is an automated PR. Please check the diff, and the action logs, to check for any funky behaviour.
         branch: automated/api-error-scrape
         labels: automated
-        delete-branch: true
+        delete-branch: true
diff --git a/.github/workflows/format_and_test.yml b/.github/workflows/format_and_test.yml
@@ -20,6 +20,8 @@ jobs:
 
       - name: Install the latest version of rye
         uses: eifinger/setup-rye@v4
+        with:
+          version: 'latest'
 
       - name: Install dependencies
         run: |
diff --git a/.github/workflows/tag_and_publish.yml b/.github/workflows/tag_and_publish.yml
@@ -41,7 +41,7 @@ jobs:
 
       - name: Create New Release
         if: env.RELEASE_EXISTS == 'false'
-        uses: actions/create-release@v1
+        uses: comnoco/create-release-action@v2
         env:
           GITHUB_TOKEN: ${{ secrets.GX_TOKEN }}
         with:
diff --git a/compiler/docs/compiler.py b/compiler/docs/compiler.py
@@ -476,6 +476,7 @@ def get_title_list(s: str) -> list:
             AvailableEffect
             Document
             Animation
+            AlternativeVideo
             LabeledPrice
             Video
             Voice
diff --git a/compiler/errors/sort.py b/compiler/errors/sort.py
@@ -1,103 +1,67 @@
+# ruff: noqa: E741
 from __future__ import annotations
 
 import csv
 import re
 import sys
 from pathlib import Path
 
-import requests  # requests==2.28.1
+import requests
 
+if len(sys.argv) != 2:
+    sys.exit(1)
 
-def sort_tsv_files():
-    """Sorts TSV files in the 'source' directory by their keys."""
+if sys.argv[1] == "sort":
     for p in Path("source").glob("*.tsv"):
-        with p.open() as f:  # Replaced open() with Path.open()
+        with p.open() as f:
             reader = csv.reader(f, delimiter="\t")
-            dct = {k: v for k, v in reader if k != "id"}  # Dictionary comprehension
+            dct = {k: v for k, v in reader if k != "id"}
             keys = sorted(dct)
 
-        with p.open("w") as f:  # Replaced open() with Path.open()
+        with p.open("w") as f:
             f.write("id\tmessage\n")
             for i, item in enumerate(keys, start=1):
                 f.write(f"{item}\t{dct[item]}")
                 if i != len(keys):
                     f.write("\n")
 
+elif sys.argv[1] == "scrape":
+    b = "https://core.telegram.org"
+    c = "/api/errors"
+    a = requests.get(b + c)
+    d = a.text
+    e = r"\<a\ href\=\"(.*)\"\>here.*\<\/a\>"
+    f = re.search(e, d)
+    if f:
+        a = requests.get(b + f.group(1))
+        d = a.json()
+        e = d.get("errors", [])
+        for h in e:
+            dct = {}
+            j = d.get("errors").get(h)
+            for k in j:
+                if k.endswith("_*"):
+                    continue
+                g = d.get("descriptions")
+                l = g.get(k)
+                m = k.replace("_%d", "_X")
+                l = l.replace("%d", "{value}")
+                l = l.replace("&raquo;", "»")
+                l = l.replace("&laquo;", "«")
+                l = l.replace("](/api/", f"]({b}/api/")
+                dct[m] = l
+
+            for p in Path("source/").glob(f"{h}*.tsv"):
+                with p.open() as f:
+                    reader = csv.reader(f, delimiter="\t")
+                    for k, v in reader:
+                        if k != "id":
+                            dct[k] = v
 
-def scrape_telegram_errors():
-    """Scrapes error data from Telegram's API and updates corresponding TSV files."""
-    base_url = "https://corefork.telegram.org"
-    api_errors_path = "/api/errors"
-    response = requests.get(base_url + api_errors_path)
-    if response.status_code != 200:
-        print("Failed to fetch errors from Telegram API")
-        sys.exit(1)
-
-    # Extract link to additional error details
-    html_content = response.text
-    link_pattern = r'<a href="(.*)">here.*</a>'
-    match = re.search(link_pattern, html_content)
-    if not match:
-        print("No error details found")
-        return
-
-    error_url = base_url + match[1]
-    error_response = requests.get(error_url)
-    if error_response.status_code != 200:
-        print("Failed to fetch detailed errors")
-        sys.exit(1)
-
-    errors_data = error_response.json()
-    process_errors(errors_data, base_url)
-
-
-def process_errors(errors_data: dict, base_url: str):
-    """Processes errors and updates the TSV files with error messages."""
-    error_entries = errors_data.get("errors", {})
-    descriptions = errors_data.get("descriptions", {})
-
-    for error_code, error_list in error_entries.items():
-        dct = {}
-
-        # Process each error
-        for error in error_list:
-            if error.endswith("_*"):
-                continue
-
-            description = descriptions.get(error, "")
-            description = format_description(description, base_url)
-            formatted_key = error.replace("_%d", "_X")
-            dct[formatted_key] = description
-
-        update_tsv_files(error_code, dct)
-
-
-def format_description(description: str, base_url: str) -> str:
-    """Formats the description by replacing specific characters and links."""
-    description = description.replace("%d", "{value}")
-    description = description.replace("&raquo;", "»")
-    description = description.replace("&laquo;", "«")
-    return description.replace("](/api/", f"]({base_url}/api/")
-
-
-def update_tsv_files(error_code: str, dct: dict):
-    """Updates the TSV files for the given error code with the provided dictionary of error messages."""
-    for p in Path("source/").glob(f"{error_code}*.tsv"):
-        with p.open() as f:  # Replaced open() with Path.open()
-            reader = csv.reader(f, delimiter="\t")
-            dct.update(
-                {k: v for k, v in reader if k != "id"}
-            )  # Dictionary comprehension
-
-        keys = sorted(dct)
-
-        with p.open("w") as f:  # Replaced open() with Path.open()
-            f.write("id\tmessage\n")
-            for i, item in enumerate(keys, start=1):
-                f.write(f"{item}\t{dct[item]}\n")
-
+            keys = sorted(dct)
 
-if sys.argv[1] == "sort":
-    sort_tsv_files()
-elif sys.argv[1] == "scrape":
-    scrape_telegram_errors()
+            for p in Path("source/").glob(f"{h}*.tsv"):
+                with p.open("w") as f:
+                    f.write("id\tmessage\n")
+                    for i, item in enumerate(keys, start=1):
+                        f.write(f"{item}\t{dct[item]}\n")
diff --git a/pyrogram/__init__.py b/pyrogram/__init__.py
@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-__version__ = "v0.0.192"
+__version__ = "v0.1.192"
 __license__ = "MIT License"
 
 from concurrent.futures.thread import ThreadPoolExecutor
diff --git a/pyrogram/types/messages_and_media/__init__.py b/pyrogram/types/messages_and_media/__init__.py
@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from .alternative_video import AlternativeVideo
 from .animation import Animation
 from .audio import Audio
 from .available_effect import AvailableEffect
@@ -62,6 +63,7 @@
 from .web_page_preview import WebPagePreview
 
 __all__ = [
+    "AlternativeVideo",
     "Animation",
     "Audio",
     "AvailableEffect",
diff --git a/pyrogram/types/messages_and_media/alternative_video.py b/pyrogram/types/messages_and_media/alternative_video.py
@@ -0,0 +1,136 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import pyrogram
+from pyrogram import raw, types, utils
+from pyrogram.file_id import (
+    FileId,
+    FileType,
+    FileUniqueId,
+    FileUniqueType,
+)
+from pyrogram.types.object import Object
+
+if TYPE_CHECKING:
+    from datetime import datetime
+
+
+class AlternativeVideo(Object):
+    """Describes an alternative reencoded quality of a video file.
+
+    Parameters:
+        file_id (``str``):
+            Identifier for this file, which can be used to download or reuse the file.
+
+        file_unique_id (``str``):
+            Unique identifier for this file, which is supposed to be the same over time and for different accounts.
+            Can't be used to download or reuse the file.
+
+        width (``int``):
+            Video width as defined by sender.
+
+        height (``int``):
+            Video height as defined by sender.
+
+        codec (``str``):
+            Codec used for video file encoding, for example, "h264", "h265", or "av1".
+
+        duration (``int``):
+            Duration of the video in seconds as defined by sender.
+
+        file_name (``str``, *optional*):
+            Video file name.
+
+        mime_type (``str``, *optional*):
+            Mime type of a file as defined by sender.
+
+        file_size (``int``, *optional*):
+            File size.
+
+        supports_streaming (``bool``, *optional*):
+            True, if the video was uploaded with streaming support.
+
+        date (:py:obj:`~datetime.datetime`, *optional*):
+            Date the video was sent.
+
+        thumbs (List of :obj:`~pyrogram.types.Thumbnail`, *optional*):
+            Video thumbnails.
+
+    """
+
+    def __init__(
+        self,
+        *,
+        client: pyrogram.Client = None,
+        file_id: str,
+        file_unique_id: str,
+        width: int,
+        height: int,
+        codec: str,
+        duration: int,
+        file_name: str | None = None,
+        mime_type: str | None = None,
+        file_size: int | None = None,
+        supports_streaming: bool | None = None,
+        date: datetime | None = None,
+        thumbs: list[types.Thumbnail] | None = None,
+    ):
+        super().__init__(client)
+        self.file_id = file_id
+        self.file_unique_id = file_unique_id
+        self.width = width
+        self.height = height
+        self.codec = codec
+        self.duration = duration
+        self.file_name = file_name
+        self.mime_type = mime_type
+        self.file_size = file_size
+        self.supports_streaming = supports_streaming
+        self.date = date
+        self.thumbs = thumbs
+
+    @staticmethod
+    def _parse(
+        client: pyrogram.Client,
+        video: raw.types.Document,
+        video_attributes: raw.types.DocumentAttributeVideo,
+        file_name: str,
+    ) -> AlternativeVideo:
+        file_id = (
+            FileId(
+                file_type=FileType.VIDEO,
+                dc_id=video.dc_id,
+                media_id=video.id,
+                access_hash=video.access_hash,
+                file_reference=video.file_reference,
+            ).encode()
+            if video
+            else None
+        )
+
+        file_unique_id = (
+            FileUniqueId(
+                file_unique_type=FileUniqueType.DOCUMENT, media_id=video.id
+            ).encode()
+            if video
+            else None
+        )
+
+        return AlternativeVideo(
+            client=client,
+            file_id=file_id,
+            file_unique_id=file_unique_id,
+            width=video_attributes.w if video_attributes else 0,
+            height=video_attributes.h if video_attributes else 0,
+            codec=video_attributes.video_codec if video_attributes else "",
+            duration=video_attributes.duration if video_attributes else 0,
+            file_name=file_name,
+            mime_type=video.mime_type if video else "",
+            supports_streaming=video_attributes.supports_streaming
+            if video_attributes
+            else False,
+            file_size=video.size if video else 0,
+            date=utils.timestamp_to_datetime(video.date) if video else None,
+            thumbs=types.Thumbnail._parse(client, video) if video else None,
+        )
diff --git a/pyrogram/types/messages_and_media/message.py b/pyrogram/types/messages_and_media/message.py
