From df8186d4ceeb7e75e37587bfbe948097aff5bbe4 Mon Sep 17 00:00:00 2001 From: Nyuan Zhang Date: Thu, 3 Aug 2023 15:08:39 +0800 Subject: [PATCH] Update to Python 3.12 (#301) * Update to Python 3.11 * Update python-311.yml * Fix transifex cli position * Fix config generation script * Add 3.11 to workflows * chore: update 3.11 links and badges * chore: Add 3.12 to workflow --- .github/scripts/generate_tx_config.py | 135 ++++++++++++++------------ .github/scripts/prepare.sh | 2 +- .github/scripts/transifex_pull.py | 38 -------- .github/scripts/update.sh | 17 +--- .github/workflows/python-310.yml | 2 +- .github/workflows/python-311.yml | 29 ++++++ .github/workflows/python-312.yml | 29 ++++++ .github/workflows/python-37.yml | 2 +- .github/workflows/python-38.yml | 2 +- .github/workflows/python-39.yml | 2 +- README.rst | 18 +++- 11 files changed, 150 insertions(+), 126 deletions(-) delete mode 100755 .github/scripts/transifex_pull.py create mode 100644 .github/workflows/python-311.yml create mode 100644 .github/workflows/python-312.yml diff --git a/.github/scripts/generate_tx_config.py b/.github/scripts/generate_tx_config.py index 0e72833f1..ca3bb39e4 100755 --- a/.github/scripts/generate_tx_config.py +++ b/.github/scripts/generate_tx_config.py @@ -1,76 +1,83 @@ -#!/usr/bin/env python3 +"""Please note that this script requires a Transifex API token to run.""" import glob -import json -import os +import subprocess +from functools import partial +from pathlib import Path import re -import sys -import urllib.request +import os + +run = partial(subprocess.run, check=True) + +def init_project(): + run(["tx", "init"]) -def list_resources(token, project): - auth_handler = urllib.request.HTTPBasicAuthHandler() - auth_handler.add_password( - realm="api", uri="https://api.transifex.com/", user="api", passwd=token + +def add_files(project_name: str): + run( + [ + "tx", + "add", + "remote", + "--file-filter", + "trans//.", + f"https://www.transifex.com/python-doc/{project_name}/dashboard/", + ] ) - opener = urllib.request.build_opener(auth_handler) - urllib.request.install_opener(opener) - next_ = ( - "https://api.transifex.com/organizations/python-doc/projects/" - + project - + "/resources/" + + +FILTER_PATTERN = re.compile( + r"^(?Pfile_filter( *)=( *))(?P.+)$", re.MULTILINE +) + + +def name_replacer(match: re.Match[str]): + prefix, resource = match.group("prefix", "resource") + override_prefix = prefix.replace("file_filter", "trans.zh_CN") + pattern = ( + resource.replace("trans//", "") + .replace("glossary_", "glossary") + .replace("--", "/") + .replace("_", "?") ) - resources = [] - while True: - resp = urllib.request.urlopen(next_) - result = json.loads(resp.read().decode("utf-8")) - resources.extend([i["slug"] for i in result]) - link = re.findall('<([^<]*)>; rel="next"', resp.getheader("Link") or "") - if not link: - break - next_ = link[0] - return resources - - -def render_config(doc_dir, project, resources): - os.chdir(doc_dir) - tpl = """ - -[{project}.{resource}] -trans.zh_CN = {filename} -source_lang = en -type = PO""" - conf = """[main] -host = https://www.transifex.com""" - for resource in sorted(resources): - if resource == "glossary_": - filename = "glossary.po" - elif resource == "sphinx": - filename = "sphinx.po" - else: - pattern = resource.replace("--", "/").replace("_", "?") - matches = glob.glob(pattern + ".rst") - if len(matches) == 0: - print("missing", resource, file=sys.stderr) - continue - elif len(matches) == 1: - filename = matches[0].replace(".rst", ".po") - else: - print("multi match", resource, pattern, matches, file=sys.stderr) - conf += tpl.format(project=project, resource=resource, filename=filename) - return conf + matches = list(glob.glob(pattern.replace(".po", ".rst"))) + if not matches: + print("missing", pattern) + return f"{prefix}{resource}\n{override_prefix}{pattern.replace('?', '_')}" + elif len(matches) == 1: + filename = matches[0].replace(".rst", ".po").replace("\\", "/") + else: + raise ValueError("multi match", resource, pattern, matches) + return f"{prefix}{resource}\n{override_prefix}{filename}" + + +def patch_config(path: str): + tx_config_path = Path(".tx", "config") + + config_content = tx_config_path.read_text("utf-8") + + cwd = os.getcwd() + os.chdir(path) + config_content = FILTER_PATTERN.sub(name_replacer, config_content) + os.chdir(cwd) + + tx_config_path.write_text(config_content, "utf-8") if __name__ == "__main__": - import argparse + from argparse import ArgumentParser + + parser = ArgumentParser() + + parser.add_argument("--token", default="") + parser.add_argument("--project-name", required=True) + parser.add_argument("--doc-path", required=True) - parser = argparse.ArgumentParser() - parser.add_argument("--token") - parser.add_argument("--project") - parser.add_argument("--doc-dir") - args = parser.parse_args() + params = parser.parse_args() - resources = list_resources(args.token, args.project) - conf = render_config(args.doc_dir, args.project, resources) - print(conf) + if params.token: + os.environ["TX_TOKEN"] = params.token -# vim: set et ts=4 sw=4 sts=4: + init_project() + add_files(params.project_name) + patch_config(params.doc_path) diff --git a/.github/scripts/prepare.sh b/.github/scripts/prepare.sh index d16dbc056..cf1326646 100755 --- a/.github/scripts/prepare.sh +++ b/.github/scripts/prepare.sh @@ -6,6 +6,6 @@ git clone --depth=1 --branch="$VERSION" https://github.com/python/cpython cpytho git clone --branch="$VERSION" https://github.com/"$GITHUB_REPOSITORY" docs pip3 install --user setuptools -pip3 install --user transifex-client +curl -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh | bash sudo apt-get update sudo apt-get install -y python3-venv diff --git a/.github/scripts/transifex_pull.py b/.github/scripts/transifex_pull.py deleted file mode 100755 index 66c4046d9..000000000 --- a/.github/scripts/transifex_pull.py +++ /dev/null @@ -1,38 +0,0 @@ -#!/usr/bin/env python3 - -from txclib import project -from txclib.utils import perform_parallel_requests - - -def pull(path, lang): - skip_decode = False - params = {} - parallel = True - - prj = project.Project(path) - resource_list = prj.get_chosen_resources([]) - for resource in resource_list: - project_slug, resource_slug = resource.split(".", 1) - host = prj.get_resource_host(resource) - prj._set_url_info(host=host, project=project_slug, resource=resource_slug) - - files = prj.get_resource_files(resource) - url = prj._get_url_by_pull_mode(None) - local_file = files.get(lang) - prj.do_url_request( - url, - language=lang, - skip_decode=skip_decode, - params=params, - parallel=parallel, - callback=prj._save_file, - callback_args={"local_file": local_file}, - ) - - perform_parallel_requests() - - -if __name__ == "__main__": - import os - - pull(os.getcwd(), os.getenv("LOCALE", "zh_CN")) diff --git a/.github/scripts/update.sh b/.github/scripts/update.sh index 544a31ae5..bcdb2d7d9 100755 --- a/.github/scripts/update.sh +++ b/.github/scripts/update.sh @@ -1,18 +1,5 @@ #!/bin/bash -set -ex - -script_dir="$(dirname "$(realpath "$0")")" - -if [[ -n "$TRANSIFEX_APIKEY" ]]; then - cat > ~/.transifexrc << EOF -[https://www.transifex.com] -api_hostname = https://api.transifex.com -hostname = https://www.transifex.com -password = $TRANSIFEX_APIKEY -username = api -EOF -fi - +tx=$(realpath ./tx) cd docs || exit 1 -"$script_dir"/transifex_pull.py +$tx pull --languages "$LOCALE" -t --use-git-timestamps diff --git a/.github/workflows/python-310.yml b/.github/workflows/python-310.yml index 54037983e..5524337ef 100644 --- a/.github/workflows/python-310.yml +++ b/.github/workflows/python-310.yml @@ -20,7 +20,7 @@ jobs: - name: update run: .github/scripts/update.sh env: - TRANSIFEX_APIKEY: ${{ secrets.TRANSIFEX_APIKEY }} + TX_TOKEN: ${{ secrets.TRANSIFEX_APIKEY }} - name: build run: .github/scripts/build.sh - name: commit diff --git a/.github/workflows/python-311.yml b/.github/workflows/python-311.yml new file mode 100644 index 000000000..d2f7aee35 --- /dev/null +++ b/.github/workflows/python-311.yml @@ -0,0 +1,29 @@ +name: python-311 + +on: + push: + branches: + - master + schedule: + - cron: "11 * * * *" + +jobs: + sync: + runs-on: ubuntu-latest + env: + LOCALE: zh_CN + VERSION: "3.11" + steps: + - uses: actions/checkout@v2 + - name: prepare + run: .github/scripts/prepare.sh + - name: update + run: .github/scripts/update.sh + env: + TX_TOKEN: ${{ secrets.TRANSIFEX_APIKEY }} + - name: build + run: .github/scripts/build.sh + - name: commit + run: .github/scripts/commit.sh + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/python-312.yml b/.github/workflows/python-312.yml new file mode 100644 index 000000000..51c5b3f6a --- /dev/null +++ b/.github/workflows/python-312.yml @@ -0,0 +1,29 @@ +name: python-312 + +on: + push: + branches: + - master + schedule: + - cron: "42 * * * *" + +jobs: + sync: + runs-on: ubuntu-latest + env: + LOCALE: zh_CN + VERSION: "3.12" + steps: + - uses: actions/checkout@v2 + - name: prepare + run: .github/scripts/prepare.sh + - name: update + run: .github/scripts/update.sh + env: + TX_TOKEN: ${{ secrets.TRANSIFEX_APIKEY }} + - name: build + run: .github/scripts/build.sh + - name: commit + run: .github/scripts/commit.sh + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/python-37.yml b/.github/workflows/python-37.yml index c35d61d2b..6864df933 100644 --- a/.github/workflows/python-37.yml +++ b/.github/workflows/python-37.yml @@ -20,7 +20,7 @@ jobs: - name: update run: .github/scripts/update.sh env: - TRANSIFEX_APIKEY: ${{ secrets.TRANSIFEX_APIKEY }} + TX_TOKEN: ${{ secrets.TRANSIFEX_APIKEY }} - name: build run: .github/scripts/build.sh - name: commit diff --git a/.github/workflows/python-38.yml b/.github/workflows/python-38.yml index a99f0e20e..35948544c 100644 --- a/.github/workflows/python-38.yml +++ b/.github/workflows/python-38.yml @@ -20,7 +20,7 @@ jobs: - name: update run: .github/scripts/update.sh env: - TRANSIFEX_APIKEY: ${{ secrets.TRANSIFEX_APIKEY }} + TX_TOKEN: ${{ secrets.TRANSIFEX_APIKEY }} - name: build run: .github/scripts/build.sh - name: commit diff --git a/.github/workflows/python-39.yml b/.github/workflows/python-39.yml index 76a6793bb..4b16958a5 100644 --- a/.github/workflows/python-39.yml +++ b/.github/workflows/python-39.yml @@ -20,7 +20,7 @@ jobs: - name: update run: .github/scripts/update.sh env: - TRANSIFEX_APIKEY: ${{ secrets.TRANSIFEX_APIKEY }} + TX_TOKEN: ${{ secrets.TRANSIFEX_APIKEY }} - name: build run: .github/scripts/build.sh - name: commit diff --git a/README.rst b/README.rst index 4ff062bc4..604acc8ba 100644 --- a/README.rst +++ b/README.rst @@ -12,26 +12,36 @@ Maintained versions: * - Version - Sync status - Translation progress + * - `3.12 `_ + - .. image:: https://github.com/python/python-docs-zh-cn/workflows/python-312/badge.svg + :target: https://github.com/python/python-docs-zh-cn/actions?workflow=python-312 + - .. image:: https://img.shields.io/badge/dynamic/json.svg?label=zh_CN&query=%24.zh_CN&url=http://gce.zhsj.me/python/312 + :target: https://app.transifex.com/python-doc/python-newest/ + * - `3.11 `_ + - .. image:: https://github.com/python/python-docs-zh-cn/workflows/python-311/badge.svg + :target: https://github.com/python/python-docs-zh-cn/actions?workflow=python-311 + - .. image:: https://img.shields.io/badge/dynamic/json.svg?label=zh_CN&query=%24.zh_CN&url=http://gce.zhsj.me/python/311 + :target: https://app.transifex.com/python-doc/python-311/ * - `3.10 `_ - .. image:: https://github.com/python/python-docs-zh-cn/workflows/python-310/badge.svg :target: https://github.com/python/python-docs-zh-cn/actions?workflow=python-310 - .. image:: https://img.shields.io/badge/dynamic/json.svg?label=zh_CN&query=%24.zh_CN&url=http://gce.zhsj.me/python/310 - :target: https://www.transifex.com/python-doc/python-39/ + :target: https://app.transifex.com/python-doc/python-310/ * - `3.9 `_ - .. image:: https://github.com/python/python-docs-zh-cn/workflows/python-39/badge.svg :target: https://github.com/python/python-docs-zh-cn/actions?workflow=python-39 - .. image:: https://img.shields.io/badge/dynamic/json.svg?label=zh_CN&query=%24.zh_CN&url=http://gce.zhsj.me/python/39 - :target: https://www.transifex.com/python-doc/python-39/ + :target: https://app.transifex.com/python-doc/python-39/ * - `3.8 `_ - .. image:: https://github.com/python/python-docs-zh-cn/workflows/python-38/badge.svg :target: https://github.com/python/python-docs-zh-cn/actions?workflow=python-38 - .. image:: https://img.shields.io/badge/dynamic/json.svg?label=zh_CN&query=%24.zh_CN&url=http://gce.zhsj.me/python/38 - :target: https://www.transifex.com/python-doc/python-38/ + :target: https://app.transifex.com/python-doc/python-38/ * - `3.7 `_ - .. image:: https://github.com/python/python-docs-zh-cn/workflows/python-37/badge.svg :target: https://github.com/python/python-docs-zh-cn/actions?workflow=python-37 - .. image:: https://img.shields.io/badge/dynamic/json.svg?label=zh_CN&query=%24.zh_CN&url=http://gce.zhsj.me/python/37 - :target: https://www.transifex.com/python-doc/python-37/ + :target: https://app.transifex.com/python-doc/python-37/ Documentation Contribution Agreement ------------------------------------