Merge remote-tracking branch 'origin/main' into tests

# Conflicts:
#	build_status.py
#	translators.py

Author: StanFromIreland

.github/workflows/update.yml

@@ -21,7 +21,6 @@ jobs:
       - run: sudo apt-get install -y gettext
       - run: pip install -r requirements.txt
       - run: uv run generate.py  # generates index.html and index.json
-      - run: mkdir -p build && cp index.* style.css build
       - name: Deploy 🚀
         if: github.event_name != 'pull_request'
         uses: JamesIves/github-pages-deploy-action@v4
@@ -55,10 +54,9 @@ jobs:
         if: github.event_name == 'pull_request'
         run: |
           curl -Lo index.html-public https://github.com/python-docs-translations/dashboard/raw/refs/heads/gh-pages/index.html
-          diff --color=always -u index.html-public index.html || :
-          cat index.html
+          diff --color=always -u index.html-public build/index.html || :
+          cat build/index.html
       - run: uv run generate_metadata.py  # generates metadata.html
-      - run: cp metadata.html warnings* build
       - name: Deploy metadata view 🚀
         if: github.event_name != 'pull_request'
         uses: JamesIves/github-pages-deploy-action@v4

.gitignore

@@ -1,4 +1,3 @@
-index.html
-metadata.html
-warnings-*.txt
+build
 clones
+venv

build_status.py

@@ -1,8 +1,7 @@
 """
-Fetch build status of languages in the https://docs.python.org.
+Fetch translated names of languages.
 
-Yield a tuple of language code and a Boolean indicating
-whether it is in the language switcher.
+Yield a tuple of language code and a string with the translated name.
 """
 
 import tomllib
@@ -11,13 +10,13 @@
 from urllib3 import PoolManager
 
 
-def get_languages(http: PoolManager) -> Iterator[tuple[str, bool]]:
+def get_languages(http: PoolManager) -> Iterator[tuple[str, str]]:
     data = http.request(
         'GET',
         'https://raw.githubusercontent.com/python/docsbuild-scripts/refs/heads/main/config.toml',
     ).data
     config = tomllib.loads(data.decode())
     for code, language in config['languages'].items():
         language_code = code.lower().replace('_', '-')
-        in_switcher = language.get('in_prod', config['defaults']['in_prod'])
-        yield language_code, in_switcher
+        translated_name = language.get('translated_name')
+        yield language_code, translated_name

build_warnings.py

@@ -33,5 +33,5 @@ def number(clones_dir: str, repo: str, language_code: str) -> int:
             f'./sphinxbuild/{language_code}',  # outputdir
         )
     )
-    copyfile(warning_file, f'warnings-{language_code}.txt')
+    copyfile(warning_file, f'build/warnings-{language_code}.txt')
     return len(findall('ERROR|WARNING', Path(warning_file).read_text()))

completion.py

@@ -1,15 +1,11 @@
 import json
-from dataclasses import dataclass
 from functools import cache
 from pathlib import Path
 from tempfile import TemporaryDirectory
-from typing import Literal
 
 import git
 from potodo import potodo
 
-import translators
-
 
 @cache
 def branches_from_devguide(devguide_dir: Path) -> list[str]:
@@ -22,9 +18,7 @@ def branches_from_devguide(devguide_dir: Path) -> list[str]:
     ]
 
 
-def get_completion(
-    clones_dir: str, repo: str
-) -> tuple[float, 'TranslatorsData', str, float]:
+def get_completion(clones_dir: str, repo: str) -> tuple[float, str, float]:
     clone_path = Path(clones_dir, 'translations', repo)
     for branch in branches_from_devguide(Path(clones_dir, 'devguide')) + [
         'master',
@@ -36,13 +30,9 @@ def get_completion(
             )
         except git.GitCommandError:
             print(f'failed to clone {repo} {branch}')
-            translators_data = TranslatorsData(0, False)
             branch = ''
             continue
         else:
-            translators_number = translators.get_number(clone_path)
-            translators_link = translators.get_link(clone_path, repo, branch)
-            translators_data = TranslatorsData(translators_number, translators_link)
             break
     path_for_merge = Path(clones_dir, 'rebased_translations', repo)
     completion = potodo.merge_and_scan_path(
@@ -77,10 +67,4 @@ def get_completion(
 
     change = completion - month_ago_completion
 
-    return completion, translators_data, branch, change
-
-
-@dataclass(frozen=True)
-class TranslatorsData:
-    number: int
-    link: str | Literal[False]
+    return completion, branch, change

generate.py

@@ -9,13 +9,12 @@
 from pathlib import Path
 
 from git import Repo
-from jinja2 import Template
+from jinja2 import Environment, FileSystemLoader
 from urllib3 import PoolManager
 
 import build_status
 import contribute
-from completion import branches_from_devguide, get_completion, TranslatorsData
-from counts import get_counts
+from completion import branches_from_devguide, get_completion
 from repositories import Language, get_languages_and_repos
 
 generation_time = datetime.now(timezone.utc)
@@ -37,7 +36,11 @@ def get_completion_progress() -> Iterator['LanguageProjectData']:
     )
     subprocess.run(['make', '-C', cpython_dir / 'Doc', 'venv'], check=True)
     subprocess.run(['make', '-C', cpython_dir / 'Doc', 'gettext'], check=True)
-    languages_built = dict(build_status.get_languages(PoolManager()))
+
+    languages_built: dict[str, str] = {
+        language: translated_name
+        for language, translated_name in build_status.get_languages(PoolManager())
+    }
 
     with concurrent.futures.ThreadPoolExecutor() as executor:
         return executor.map(
@@ -51,26 +54,25 @@ def get_completion_progress() -> Iterator['LanguageProjectData']:
 def get_project_data(
     language: Language,
     repo: str | None,
-    languages_built: dict[str, bool],
+    languages_built: dict[str, str],
     clones_dir: str,
 ) -> 'LanguageProjectData':
     built = language.code in languages_built
     if repo:
-        completion, translators_data, branch, change = get_completion(clones_dir, repo)
+        completion, branch, change = get_completion(clones_dir, repo)
     else:
         completion = 0.0
-        translators_data = TranslatorsData(0, False)
         change = 0.0
         branch = ''
+
     return LanguageProjectData(
         language,
         repo,
         branch,
         completion,
         change,
-        translators_data,
         built,
-        in_switcher=languages_built.get(language.code),
+        translated_name=languages_built.get(language.code, ''),
         uses_platform=language.code in contribute.pulling_from_transifex,
         contribution_link=contribute.get_contrib_link(language.code, repo),
     )
@@ -83,26 +85,30 @@ class LanguageProjectData:
     branch: str
     completion: float
     change: float
-    translators: TranslatorsData
     built: bool
-    in_switcher: bool | None
+    translated_name: str
     uses_platform: bool
     contribution_link: str | None
 
 
 if __name__ == '__main__':
     logging.basicConfig(level=logging.INFO)
     logging.info(f'starting at {generation_time}')
-    template = Template(Path('template.html.jinja').read_text())
+    Path('build').mkdir(parents=True, exist_ok=True)
 
-    output = template.render(
-        completion_progress=(completion_progress := list(get_completion_progress())),
+    completion_progress = list(get_completion_progress())
+
+    env = Environment(loader=FileSystemLoader('templates'))
+    index = env.get_template('index.html.jinja').render(
+        completion_progress=completion_progress,
         generation_time=generation_time,
         duration=(datetime.now(timezone.utc) - generation_time).seconds,
-        counts=get_counts(Path('clones', 'cpython', 'Doc', 'build', 'gettext')),
     )
 
-    Path('index.html').write_text(output)
-    Path('index.json').write_text(
-        json.dumps(completion_progress, indent=2, default=asdict)
+    Path('build/style.css').write_bytes(Path('src/style.css').read_bytes())
+    Path('build/logo.png').write_bytes(Path('src/logo.png').read_bytes())
+    Path('build/index.html').write_text(index)
+
+    Path('build/index.json').write_text(
+        json.dumps([asdict(project) for project in completion_progress], indent=2)
     )

generate_metadata.py

@@ -9,7 +9,7 @@
 
 import dacite
 from git import Repo
-from jinja2 import Template
+from jinja2 import Environment, FileSystemLoader
 from urllib3 import request
 
 import build_warnings
@@ -55,20 +55,20 @@ def get_language_repo_and_completion(
 if __name__ == '__main__':
     logging.basicConfig(level=logging.INFO)
     logging.info(f'starting at {generation_time}')
-    template = Template(Path('metadata.html.jinja').read_text())
-    if (index_path := Path('index.json')).exists():
-        index_json = loads(Path('index.json').read_text())
+    env = Environment(loader=FileSystemLoader('templates'))
+    if (index_path := Path('build/index.json')).exists():
+        index_json = loads(Path('build/index.json').read_text())
     else:
         index_json = request('GET', argv[1]).json()
 
     completion_progress = [
         dacite.from_dict(LanguageProjectData, project) for project in index_json
     ]
 
-    output = template.render(
+    output = env.get_template('metadata.html.jinja').render(
         metadata=zip(completion_progress, get_projects_metadata(completion_progress)),
         generation_time=generation_time,
         duration=(datetime.now(timezone.utc) - generation_time).seconds,
     )
 
-    Path('metadata.html').write_text(output)
+    Path('build/metadata.html').write_text(output)

metadata.html.jinja

@@ -7,8 +7,12 @@
 
 def store_and_count_failures(clones_dir: str, repo: str, language_code: str) -> int:
     failed_checks = list(chain.from_iterable(yield_failures(clones_dir, repo)))
-    filepath = Path(f'warnings-lint-{language_code}.txt')
-    filepath.write_text('\n'.join([str(c) for c in failed_checks]))
+    prefix = f'{Path(clones_dir, "rebased_translations", repo)}/'
+    log = '\n'.join(
+        map(lambda check: check.removeprefix(prefix), map(str, failed_checks))
+    )
+    filepath = Path(f'build/warnings-lint-{language_code}.txt')
+    filepath.write_text(log)
     return len(failed_checks)