Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add script for handling translations #195

Merged
merged 15 commits into from
Oct 28, 2024
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .babel.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[jinja2: **.html]
35 changes: 35 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,38 @@ jobs:
with:
name: doc-html-${{ matrix.branch }}
path: www/

translations:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: ["ubuntu-latest", "windows-latest"]
# Test minimum supported and latest stable from 3.x series
python-version: ["3.8", "3"]
rffontenelle marked this conversation as resolved.
Show resolved Hide resolved
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
allow-prereleases: true
cache: pip
- name: Install dependencies
run: |
pip install --upgrade pip
pip install -r requirements.txt
- run: python babel_runner.py extract
- run: python babel_runner.py init -l pt_BR
- run: python babel_runner.py update
- run: python babel_runner.py update -l pt_BR
- run: python babel_runner.py compile
- run: python babel_runner.py compile -l pt_BR
- name: Print .pot file
shell: bash
run: cat locales/messages.pot
- name: Print .po file
shell: bash
run: cat locales/pt_BR/LC_MESSAGES/messages.po
- name: list files in locales dir
shell: bash
run: ls -R locales/
119 changes: 119 additions & 0 deletions babel_runner.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
#!/usr/bin/venv python3
"""Script for handling translations with Babel"""
from __future__ import annotations

import argparse
import subprocess
from pathlib import Path

try:
import tomllib
except ImportError:
try:
import tomli as tomllib
except ImportError as ie:
raise ImportError(
"tomli or tomllib is required to parse pyproject.toml"
) from ie

PROJECT_DIR = Path(__file__).resolve().parent

# Global variables used by pybabel below (paths relative to PROJECT_DIR)
DOMAIN = "messages"
COPYRIGHT_HOLDER = "Python Software Foundation"
LOCALES_DIR = "locales"
POT_FILE = Path(LOCALES_DIR, f"{DOMAIN}.pot")
SOURCE_DIR = "python_docs_theme"
MAPPING_FILE = ".babel.cfg"


def get_project_info() -> dict:
"""Retrieve project's info to populate the message catalog template"""
with open(Path(PROJECT_DIR / "pyproject.toml"), "rb") as f:
data = tomllib.load(f)
return data["project"]


def extract_messages():
rffontenelle marked this conversation as resolved.
Show resolved Hide resolved
"""Extract messages from all source files into message catalog template"""
Path(PROJECT_DIR, LOCALES_DIR).mkdir(parents=True, exist_ok=True)
project_data = get_project_info()
subprocess.run(
[
"pybabel",
"extract",
"-F",
MAPPING_FILE,
"--copyright-holder",
COPYRIGHT_HOLDER,
"--project",
project_data["name"],
"--version",
project_data["version"],
"--msgid-bugs-address",
project_data["urls"]["Issue tracker"],
"-o",
POT_FILE,
SOURCE_DIR,
],
cwd=PROJECT_DIR,
check=True,
)


def init_locale(locale: str):
rffontenelle marked this conversation as resolved.
Show resolved Hide resolved
"""Initialize a new locale based on existing message catalog template"""
pofile = PROJECT_DIR / LOCALES_DIR / locale / "LC_MESSAGES" / f"{DOMAIN}.po"
if pofile.exists():
print(f"There is already a message catalog for locale {locale}, skipping.")
return
cmd = ["pybabel", "init", "-i", POT_FILE, "-d", LOCALES_DIR, "-l", locale]
subprocess.run(cmd, cwd=PROJECT_DIR, check=True)


def update_catalogs(locale: str):
rffontenelle marked this conversation as resolved.
Show resolved Hide resolved
"""Update translations from existing message catalogs"""
cmd = ["pybabel", "update", "-i", POT_FILE, "-d", LOCALES_DIR]
if locale != "":
rffontenelle marked this conversation as resolved.
Show resolved Hide resolved
cmd.extend(["-l", locale])
subprocess.run(cmd, cwd=PROJECT_DIR, check=True)


def compile_catalogs(locale: str):
rffontenelle marked this conversation as resolved.
Show resolved Hide resolved
"""Compile existing message catalogs"""
cmd = ["pybabel", "compile", "-d", LOCALES_DIR]
if locale != "":
rffontenelle marked this conversation as resolved.
Show resolved Hide resolved
cmd.extend(["-l", locale])
subprocess.run(cmd, cwd=PROJECT_DIR, check=True)


def main():
rffontenelle marked this conversation as resolved.
Show resolved Hide resolved
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument(
"command",
choices=["init", "extract", "update", "compile"],
help="command to be executed",
)
parser.add_argument(
"-l",
"--locale",
help="language code (needed for init, optional for update and compile)",
)

args = parser.parse_args()
locale = args.locale if args.locale else ""
rffontenelle marked this conversation as resolved.
Show resolved Hide resolved

if args.command == "extract":
extract_messages()
elif args.command == "init":
if locale == "":
rffontenelle marked this conversation as resolved.
Show resolved Hide resolved
parser.error("init requires passing the --locale option")
init_locale(locale)
elif args.command == "update":
update_catalogs(locale)
elif args.command == "compile":
compile_catalogs(locale)


if __name__ == "__main__":
main()
5 changes: 5 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# for babel_runner.py
setuptools
Babel
Jinja2
tomli; python_version < "3.10"
Loading