feat: add some new types.

Author: 5hojib

.github/workflows/docs.yml

@@ -2,12 +2,8 @@ name: Build-docs
 
 on:
   push:
-    tags:
-    - "*"
     branches:
-    - err
-  workflow_dispatch:
-    {}
+    - test
 
 jobs:
   build:
@@ -19,4 +15,4 @@ jobs:
       - name: Build
         run: bash build-docs.sh
         env:
-          DOCS_KEY: ${{ secrets.GX_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GX_TOKEN }}

.github/workflows/format_and_test.yml

@@ -3,7 +3,7 @@ name: Format and Test Code with Rye
 on: 
   push:
     branches:
-      - err
+      - test
 
 jobs:
   lint-format-and-test:
@@ -39,7 +39,7 @@ jobs:
           if git diff-index --quiet HEAD --; then
             echo "No changes to commit."
           else
-            git commit -m "InkyPinkyPonky [no ci]"
+            git commit -m "InkyPinkyPonky [no ci]" --signoff
             git push origin ${{ github.ref }}
           fi
         env:

.github/workflows/tag_and_publish.yml

@@ -13,36 +13,40 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set Version from File
+      - name: Extract Version from File
         id: version
         run: |
           VERSION=$(grep -E '__version__ = ".*"' pyrogram/__init__.py | cut -d\" -f2)
           echo "VERSION=$VERSION" >> $GITHUB_ENV
 
-      - name: Check Existing Tag
-        id: check_tag
+      - name: Check for Existing Release
+        id: check_release
         run: |
-          TAG_EXISTS=$(git tag -l "${{ env.VERSION }}")
-          if [ -n "$TAG_EXISTS" ]; then
-            echo "Tag ${{ env.VERSION }} already exists."
-            echo "TAG_EXISTS=true" >> $GITHUB_ENV  # Set environment variable
+          TAG_EXISTS=$(curl -s -o /dev/null -w "%{http_code}" https://api.github.com/repos/$GITHUB_REPOSITORY/releases/tags/${{ env.VERSION }})
+          if [ "$TAG_EXISTS" -eq 200 ]; then
+            echo "Release with tag ${{ env.VERSION }} already exists."
+            echo "RELEASE_EXISTS=true" >> $GITHUB_ENV
           else
-            echo "TAG_EXISTS=false" >> $GITHUB_ENV
+            echo "RELEASE_EXISTS=false" >> $GITHUB_ENV
           fi
 
-      - name: Create Tag
-        if: env.TAG_EXISTS != 'true'
-        run: |
-          git tag ${{ env.VERSION }}
-          git push origin ${{ env.VERSION }}
+      - name: Create New Release
+        if: env.RELEASE_EXISTS == 'false'
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GX_TOKEN }}
+        with:
+          tag_name: ${{ env.VERSION }}
+          release_name: Release ${{ env.VERSION }}
+          body: Release ${{ env.VERSION }}
 
-      - name: Upload Python Package
-        if: env.TAG_EXISTS != 'true'
+      - name: Build and Publish Python Package
+        if: env.RELEASE_EXISTS == 'false'
         run: |
           python -m pip install --upgrade pip
           pip install -e '.[dev]'
           hatch build
           hatch publish
         env:
           HATCH_INDEX_USER: __token__
-          HATCH_INDEX_AUTH: ${{ secrets.PYPI_API_TOKEN }}
+          HATCH_INDEX_AUTH: ${{ secrets.PYPI_API_TOKEN }}

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

compiler/docs/compiler.py

@@ -4,21 +4,20 @@
 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 build(path, level=0):
                 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 build(path, level=0):
                     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 build(path, level=0):
 
                 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 build(path, level=0):
 
     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 build(path, level=0):
             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,20 +407,20 @@ def get_title_list(s: str) -> list:
     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():
             name, *methods = get_title_list(v)
             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 get_title_list(s: str) -> list:
             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 get_title_list(s: str) -> list:
             Venue
             Sticker
             StickerSet
+            ContactRegistered
+            ScreenshotTaken
             Game
             GiftedPremium
             Giveaway
@@ -691,12 +686,12 @@ def get_title_list(s: str) -> list:
     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 get_title_list(s: str) -> list:
             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 get_title_list(s: str) -> list:
             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 get_title_list(s: str) -> list:
                 }
             )
 
-            # 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 get_title_list(s: str) -> list:
 
 
 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)