SkyLull · SkyLull · Nov 16, 2024 · Nov 20, 2024 · Nov 22, 2024 · Nov 22, 2024
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,5 +1,11 @@
 name: build
 
+concurrency: preview-${{ github.ref }}
+
+permissions:
+  contents: write
+  pull-requests: write
+
 on:
   pull_request:
 
@@ -9,8 +15,26 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
       - name: Install Dependencies
         run: sudo apt-get install gettext
 
-      - name: Validate
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Build HTML Docs
         run: VERSION=${{ github.event.repository.default_branch }} JOBS=4 MODE=html make all
+
+      - name: Deploy PR Doc Preview
+        # PR from the forked repo would be denied as the permission is not granted.
+        # Allow only PR from this repo.
+        if: ${{ ( github.event.pull_request.head.repo.full_name == github.event.pull_request.base.repo.full_name ) }}
+        uses: rossjrw/pr-preview-action@v1
+        with:
+          source-dir: ../cpython/Doc/build/html
+          preview-branch: gh-pages
+          umbrella-dir: pr-preview
+          action: auto
diff --git a/.github/workflows/deploy-gh-page.yml b/.github/workflows/deploy-gh-page.yml
@@ -14,13 +14,17 @@ jobs:
       - name: Install Dependencies
         run: sudo apt-get install gettext
 
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
       - name: Build
         run: JOBS=4 MODE=html make all
 
       - name: Deploy to gh page
-        uses: JamesIves/github-pages-deploy-action@v4.6.8
+        uses: JamesIves/github-pages-deploy-action@v4.7.3
         with:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH: gh-pages
-          FOLDER: ../cpython/Doc/build/html
-          CLEAN: true
+          token: ${{ secrets.GITHUB_TOKEN }}
+          branch: gh-pages
+          folder: ../cpython/Doc/build/html
+          clean: true
+          clean-exclude: pr-preview/
diff --git a/.github/workflows/py313-sync-cpython.yml b/.github/workflows/py313-sync-cpython.yml
@@ -30,20 +30,23 @@ jobs:
       - name: Install Dependencies
         run: sudo apt-get install gettext
 
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
       - name: Sync with CPython
-        run: make clone && make merge && make rm_cpython
+        run: make clone merge rm_cpython wrap
 
-      - uses: tibdex/github-app-token@v2
-        id: generate-token
+      - uses: actions/create-github-app-token@v2
+        id: app-token
         with:
-          app_id: ${{ secrets.APP_ID }}
-          private_key: ${{ secrets.APP_PRIVATE_KEY }}
+          app-id: ${{ secrets.APP_ID }}
+          private-key: ${{ secrets.APP_PRIVATE_KEY }}
 
       - name: Create Pull Request
         id: cpr
         uses: peter-evans/create-pull-request@v6
         with:
-          token: ${{ steps.generate-token.outputs.token }}
+          token: ${{ steps.app-token.outputs.token }}
           commit-message: sync with cpython ${{ env.LATEST_COMMIT_ID }}
           committer: GitHub <noreply@github.com>
           author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

diff --git a/.github/workflows/summarize_progress.yml b/.github/workflows/summarize_progress.yml
@@ -1,6 +1,7 @@
 name: summarize_progress
 
 on:
+  workflow_dispatch:
   schedule:
     - cron:  '30 23 * * 5'
 
@@ -16,7 +17,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Install poetry
-        uses: abatilo/actions-poetry@v3
+        uses: abatilo/actions-poetry@v4
 
       - name: Execute Check Process
         run: |
@@ -37,7 +38,7 @@ jobs:
         shell: bash
 
       - name: Commit wiki code
-        uses: stefanzweifel/git-auto-commit-action@v5
+        uses: stefanzweifel/git-auto-commit-action@v6
         with:
             commit_message: Weekly Update -- Summarize Progress
-            repository: markdown
+            repository: markdown
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -7,6 +7,6 @@
 repos:
 - repo: https://git.afpy.org/AFPy/powrap
   # there's no release tag in repo, use the latest commit hash id instead
-  rev: a34a9fed116d24562fbe4bb8d456ade85f056c36
+  rev: v1.0.2
   hooks:
   - id: powrap
diff --git a/.scripts/google_translate/utils.py b/.scripts/google_translate/utils.py
@@ -46,6 +46,7 @@
     '變量': '變數',  # variable
     '常量': '常數',  # constant
     '添加': '新增',  # add
+    '轉義': '跳脫',  # escape
     '基類': '基底類別',  # base class
 }
 

diff --git a/.scripts/summarize_progress/main.py b/.scripts/summarize_progress/main.py
@@ -6,27 +6,6 @@
 from pathlib import Path
 
 
-def entry_check(pofile: polib.POFile) -> str:
-    '''
-    Check the po file with how many entries are translated or not.
-    '''
-
-    lines_tranlated = len(pofile.translated_entries())
-    lines_untranlated = len(pofile.untranslated_entries())
-
-    if lines_tranlated == 0:
-        result = "❌"
-    elif lines_untranlated == 0:
-        result = "✅"
-    else:
-        lines_all = lines_tranlated + lines_untranlated
-        progress = lines_tranlated / lines_all
-        progress_percentage = round(progress * 100, 2)
-        result = f"{progress_percentage} %"
-
-    return result
-
-
 def get_open_issues_count() -> int:
     '''
     Fetch GitHub API to get the number of OPEN ISSUES.
@@ -89,20 +68,23 @@ def get_github_issues() -> list:
 
 
 def format_line_table_header() -> list:
-    return [f"|Filename|Progress|Issue|Assignee|\r\n",
+    return [f"|Filename|Progress (#string)|Issue|Assignee|\r\n",
             f"|-------:|:-------|:----|:-------|\r\n"]
 
 
-def format_issue_link(url: str) -> str:
-    return f"[{url.split('/')[-1]}]({url})" if len(url) > 0 else ''
-
-
-def format_line_file(filename: str, data: dict) -> str:
-    return f"|`{filename}`|{data['progress']}|{format_issue_link(data['issue'])}|{data['assignee']}|\r\n"
+def format_line_po_issue_display(issue_link: str, issue_number: str, progress: float, create_issue_link: str) -> str:
+    if issue_link:
+        return f"[{issue_number}]({issue_link})"
+    if progress != 100.:
+        return f"[create issue]({create_issue_link})"
+    return ""
 
 
-def format_line_directory(dirname: str) -> str:
-    return f"## {dirname}\r\n"
+def format_line_po(filename: str, po_link: str, progress: str, num_entries: str, issue_display: str, assignee: str) -> str:
+    progress_display = f"{progress} %"
+    if progress == 100:
+        progress_display = "✅"
+    return f"|[`{filename}`]({po_link})|{progress_display} ({num_entries:,})|{issue_display}|{assignee}|\r\n"
 
 
 if __name__ == "__main__":
@@ -117,11 +99,17 @@ def format_line_directory(dirname: str) -> str:
     for filepath in glob.glob(str(BASE_DIR / "**/*.po"), recursive=True):
         path = Path(filepath)
         filename = path.name
-        dirname = path.parent.name if path.parent.name != BASE_DIR.name else '/'
+        dirname = path.parent.name if path.parent.name != BASE_DIR.name else 'root'
         po = polib.pofile(filepath)
 
+        num_entries = len(list(filter(lambda e: not e.obsolete, po)))
+        num_translated = len(po.translated_entries())
         summary.setdefault(dirname, {})[filename] = {
-            'progress': entry_check(po),
+            'po_info': {
+                'num_entries': num_entries,
+                'num_translated': num_translated,
+                'progress': round(num_translated / num_entries * 100, 2),
+            },
             'issue': '',
             'assignee': '',
         }
@@ -137,25 +125,47 @@ def format_line_directory(dirname: str) -> str:
             pass
 
     '''
-    Adding Space for Formatting Markdown Link
-    '''
-
-    '''
-    Format the lines that will write into the markdown file,
+    Format the lines that will be written into the markdown file,
     also sort the directory name and file name.
     '''
     writeliner = []
     summary_sorted = dict(sorted(summary.items()))
+    total_entries, total_translated = 0, 0
     for dirname, filedict in summary_sorted.items():
-        writeliner.append(format_line_directory(dirname))
-        writeliner.extend(format_line_table_header())
-
+        dir_total_entries, dir_total_translated = 0, 0
+        lines = []
         filedict_sorted = dict(sorted(filedict.items()))
         for filename, filedata in filedict_sorted.items():
-            writeliner.append(format_line_file(filename, filedata))
+            file_path = f"{dirname}/{filename}" if dirname else filename
+            po_link = f"https://github.com/python/python-docs-zh-tw/tree/3.13/{file_path}"
+            issue_link = filedata['issue']
+            issue_number = f"#{issue_link.split('/')[-1]}"
+            create_issue_link = f"https://github.com/python/python-docs-zh-tw/issues/new?title=Translate%20`{file_path}`"
+            issue_display = format_line_po_issue_display(issue_link, issue_number, filedata['po_info']['progress'], create_issue_link)
+            line_po = format_line_po(
+                filename,
+                po_link,
+                filedata['po_info']['progress'],
+                filedata['po_info']['num_entries'],
+                issue_display,
+                filedata['assignee'],
+            )
+            lines.append(line_po)
+
+            dir_total_entries += filedata['po_info']['num_entries']
+            dir_total_translated += filedata['po_info']['num_translated']
+
+        dir_progress = round(dir_total_translated / dir_total_entries * 100, 2)
+        writeliner.append(f"## {dirname} ({dir_progress}%)\r\n")
+        writeliner.extend(format_line_table_header())
+        writeliner.extend(lines)
+
+        total_entries += dir_total_entries
+        total_translated += dir_total_translated
+
+    overall_progress = round(total_translated / total_entries * 100, 2)
+    title = f"## Overall Progress: {overall_progress}% ({total_translated:,} / {total_entries:,})\r\n"
+    writeliner = [title] + writeliner
 
-    with open(
-        f"summarize_progress/result.md",
-        "w",
-    ) as file:
+    with open(f"summarize_progress/result.md", "w") as file:
         file.writelines(writeliner)
diff --git a/Makefile b/Makefile
@@ -89,21 +89,21 @@ prepare_cpython:  ## Prepare CPython clone at `../cpython/`.
 
 
 $(VENV)/bin/activate:
-	python3 -m venv $(VENV)
+	uv venv $(VENV)
 
 $(VENV)/bin/sphinx-build: $(VENV)/bin/activate
-	. $(VENV)/bin/activate; python3 -m pip install sphinx python-docs-theme
+	. $(VENV)/bin/activate; uv pip install sphinx python-docs-theme
 
 $(VENV)/bin/sphinx-lint: $(VENV)/bin/activate
-	. $(VENV)/bin/activate; python3 -m pip install sphinx-lint
+	. $(VENV)/bin/activate; uv pip install sphinx-lint
 
 $(VENV)/bin/blurb: $(VENV)/bin/activate
-	. $(VENV)/bin/activate; python3 -m pip install blurb
+	. $(VENV)/bin/activate; uv pip install blurb
 
 
 .PHONY: upgrade_venv
 upgrade_venv: $(VENV)/bin/activate ## Upgrade the venv that compiles the doc
-	@. $(VENV)/bin/activate; python3 -m pip install -q --upgrade sphinx python-docs-theme blurb sphinx-lint
+	@. $(VENV)/bin/activate; uv pip install -q --upgrade sphinx python-docs-theme blurb sphinx-lint
 
 
 .PHONY: progress
@@ -156,6 +156,10 @@ rm_cpython: ## Remove cloned cpython repo
 lint:  $(VENV)/bin/sphinx-lint  ## Run sphinx-lint
 	$(VENV)/bin/sphinx-lint --enable default-role
 
+.PHONY: wrap
+wrap:  ## Run powrap on modified po files
+	uvx powrap --modified
+
 # This allows us to accept extra arguments (by doing nothing when we get a job that doesn't match, rather than throwing an error)
 %:
 	@:
diff --git a/README.rst b/README.rst
@@ -52,7 +52,7 @@ the PSF for inclusion in the documentation.
 請注意此予翻譯專案的授權：Python 的說明文件是以全球的志工社群來維護。透過張貼\
 此專案在 Transifex、GitHub 以及其他公眾場合，以及邀請你參與，我們向你提出一個\
 協議：你必須將你對於 Python 說明文件或是 Python 說明文件翻譯的貢獻以 CC0\
-（請參考 https://creativecommons.org/publicdomain/zero/1.0/legalcode/ 
+（請參考 https://creativecommons.org/publicdomain/zero/1.0/legalcode/
 ）的方式授權給 PSF 使用。你可以公開地聲明你所貢獻翻譯的部分，並且如果你的翻譯被 PSF
 採用，你可以（但並不須要）送出一個修改，其包含在 Misc/ACKS 或是 TRANSLATORS
 檔案裡增加合適的注釋。雖然這個說明文件貢獻協議並沒有說明 PSF 有義務納入你的\
@@ -84,6 +84,7 @@ the PSF for inclusion in the documentation.
 - `安裝好 git <https://help.github.com/articles/set-up-git/>`_\ （Windows
   上請參考 https://gitforwindows.org/）
 - 一個 ``.po`` 檔的編輯器。推薦使用 `Poedit <https://poedit.net>`_，若熟悉 po 檔用一般文字編輯器亦可。
+- 參考 `uv Installation <https://docs.astral.sh/uv/getting-started/installation/>`_ 安裝 uv，以便在本機端預覽翻譯成果。
 - macOS 的使用者還需要先利用 `homebrew <https://brew.sh/index_zh-tw>`_ 安裝 gettext，屆時 Sphinx 會使用到。
 
   .. code-block:: bash
@@ -232,7 +233,7 @@ the PSF for inclusion in the documentation.
 其中最簡單的貢獻方式就是更新 *fuzzy entries*，讓曾經翻譯的內容保持與最新版本的文件
 同步。請參考\ `尋找有翻譯過但需校閱的 fuzzy entries`_ 段落。
 
-此外，當前的目標為完成 **Tutorial** 的翻譯，因此在 ``tutorial/`` 底下的所有
+此外，目前的目標為完成 **Tutorial** 的翻譯，因此在 ``tutorial/`` 底下的所有
 po 檔皆為首要的翻譯對象。你也可以幫忙校對已經翻譯過的內容。