Improve language details page

Author: StanFromIreland

build_status.py

@@ -11,7 +11,7 @@
 from urllib3 import PoolManager
 
 
-def get_languages(http: PoolManager) -> Iterator[tuple[str, bool]]:
+def get_languages(http: PoolManager) -> Iterator[tuple[str, str, bool]]:
     data = http.request(
         'GET',
         'https://raw.githubusercontent.com/python/docsbuild-scripts/refs/heads/main/config.toml',
@@ -20,12 +20,14 @@ def get_languages(http: PoolManager) -> Iterator[tuple[str, bool]]:
     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, in_switcher
 
 
 def main() -> None:
     languages = {
-        language: in_switcher for language, in_switcher in get_languages(PoolManager())
+        language: in_switcher
+        for language, translated_name, in_switcher in get_languages(PoolManager())
     }
     print(languages)
     for code in ('en', 'pl', 'ar', 'zh-cn', 'id'):

completion.py

@@ -36,13 +36,15 @@ def get_completion(
             )
         except git.GitCommandError:
             print(f'failed to clone {repo} {branch}')
-            translators_data = TranslatorsData(0, False)
+            translators_data = TranslatorsData(0, set(), False)
             branch = ''
             continue
         else:
-            translators_number = translators.get_number(clone_path)
+            translators_list, translators_number = translators.get_number(clone_path)
             translators_link = translators.get_link(clone_path, repo, branch)
-            translators_data = TranslatorsData(translators_number, translators_link)
+            translators_data = TranslatorsData(
+                translators_number, translators_list, translators_link
+            )
             break
     path_for_merge = Path(clones_dir, 'rebased_translations', repo)
     completion = potodo.merge_and_scan_path(
@@ -83,4 +85,5 @@ def get_completion(
 @dataclass(frozen=True)
 class TranslatorsData:
     number: int
+    list: set
     link: str | Literal[False]

generate.py

@@ -6,6 +6,7 @@
 from collections.abc import Iterator
 from dataclasses import dataclass, asdict
 from datetime import datetime, timezone
+from typing import Any, Dict
 from pathlib import Path
 
 from git import Repo
@@ -37,7 +38,13 @@ 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, Dict[str, Any]] = {
+        code: {'in_switcher': in_switcher, 'translated_name': translated_name}
+        for code, translated_name, in_switcher in build_status.get_languages(
+            PoolManager()
+        )
+    }
 
     with concurrent.futures.ThreadPoolExecutor() as executor:
         return executor.map(
@@ -51,17 +58,22 @@ def get_completion_progress() -> Iterator['LanguageProjectData']:
 def get_project_data(
     language: Language,
     repo: str | None,
-    languages_built: dict[str, bool],
+    languages_built: Dict[str, Dict[str, Any]],
     clones_dir: str,
 ) -> 'LanguageProjectData':
     built = language.code in languages_built
     if repo:
         completion, translators_data, branch, change = get_completion(clones_dir, repo)
     else:
         completion = 0.0
-        translators_data = TranslatorsData(0, False)
+        translators_data = TranslatorsData(0, set(), False)
         change = 0.0
         branch = ''
+
+    language_data = languages_built.get(language.code, {})
+    translated_name = language_data.get('translated_name', '')
+    in_switcher = language_data.get('in_switcher', False)
+
     return LanguageProjectData(
         language,
         repo,
@@ -70,7 +82,8 @@ def get_project_data(
         change,
         translators_data,
         built,
-        in_switcher=languages_built.get(language.code),
+        translated_name=translated_name,
+        in_switcher=in_switcher,
         uses_platform=language.code in contribute.pulling_from_transifex,
         contribution_link=contribute.get_contrib_link(language.code, repo),
     )
@@ -85,6 +98,7 @@ class LanguageProjectData:
     change: float
     translators: TranslatorsData
     built: bool
+    translated_name: str
     in_switcher: bool | None
     uses_platform: bool
     contribution_link: str | None

templates/language.html.jinja

@@ -1,9 +1,44 @@
 {% extends "base.html.jinja" %}
 
 {% block main %}
+<div style="margin-left: 3rem; margin-right: 3rem;">
   {% if project.built %}
-    <h1><a href="https://docs.python.org/{{ project.language.code }}/3">{{ project.language.name }}</a></h1>
+    <h2 style="text-align: center;"><a href="https://docs.python.org/{{ project.language.code }}/3">{{ project.language.name }}</a></h2>
+    <h1 style="text-align: center;"><a href="https://docs.python.org/{{ project.language.code }}/3">{{ project.translated_name }}</a></h1>
   {% else %}
-    <h1>{{ project.language.name }}</h1>
+    <h1 style="text-align: center;">{{ project.language.name }}</h1>
   {% endif %}
+
+  {% if project.built and project.in_switcher %}
+    <h6 style="text-align: center;">This project is built and is in the switcher.</h6>
+  {% elif project.built %}
+    <h6 style="text-align: center;">This project is built but is not yet in the switcher.</h6>
+  {% else %}
+    <h6 style="text-align: center;">This project is not built yet.</h6>
+  {% endif %}
+
+    <h4 style="text-align: center;">
+      {% if project.translators.link %}
+        <a href="{{ project.translators.link }}" style="color: #1595fe;">Contribute!</a>
+      {% elif project.uses_platform %}
+        <a href="https://app.transifex.com/join/?o=python-doc&p=python-newest&t=opensource" style="color: #1595fe;">Contribute!</a>
+      {% else %}
+        <a href="https://devguide.python.org/documentation/translations/translating/" style="color: #1595fe;">Contribute!</a>
+      {% endif %}
+      •
+      <a href="https://github.com/{{ project.repository }}" style="color: #1595fe;">Repository</a>
+    </h4>
+
+<div class="row">
+  <div class="card-container w-100">
+    <div class="card">
+      <div class="card-body">
+        <h3 class="card-title">Translators ({{ project.translators.number }})</h3>
+        <h4 class="card-subtitle mb-2 text-muted">{{ project.translators.list | join(', ') }}</h4>
+      </div>
+    </div>
+  </div>
+</div>
+
+</div>
 {% endblock %}

translators.py

@@ -1,22 +1,29 @@
 from collections.abc import Iterator
 from pathlib import Path
-from re import fullmatch
+from re import fullmatch, sub
 from tempfile import TemporaryDirectory
 from typing import Literal
 
 from git import Repo
 from polib import pofile
 
 
-def get_number(path: Path) -> int:
-    from_headers = len(set(yield_from_headers(path)))
-    from_git_history = get_number_from_git_history(path)
-    from_translators_file = len(get_from_translators_file(path))
-    return max(from_headers, from_git_history, from_translators_file)
+def _format_translator(translator: str) -> str:
+    translator = translator.strip()
+    return sub(r'<.*?>', '', translator).strip()
 
 
-def get_number_from_git_history(path: Path) -> int:
-    return len(Repo(path).git.shortlog('-s', 'HEAD').splitlines())
+def get_number(path: Path) -> tuple[set, int]:
+    from_po_headers = set(yield_from_headers(path))
+    from_git_history = set(get_from_git_history(path))
+    from_translators_file = set(get_from_translators_file(path))
+    largest_set = max(from_po_headers, from_git_history, from_translators_file)
+    return largest_set, len(largest_set)
+
+
+def get_from_git_history(path: Path) -> list[str]:
+    raw_lines = Repo(path).git.shortlog('-s', 'HEAD').splitlines()
+    return [_format_translator(line.split('\t', 1)[-1]) for line in raw_lines]
 
 
 def yield_from_headers(path: Path) -> Iterator[str]:
@@ -31,16 +38,17 @@ def yield_from_headers(path: Path) -> Iterator[str]:
             try:
                 translator, _year = translator_record.split(', ')
             except ValueError:
-                yield translator_record
-            else:
-                yield translator
+                translator = translator_record
+            if translator.strip() == 'Transifex Bot <>':
+                continue
+            yield _format_translator(translator)
 
 
 def get_from_translators_file(path: Path) -> list[str]:
     if not (file := path.joinpath('TRANSLATORS')).exists():
         return []
     return list(
-        line
+        _format_translator(line)
         for line in file.read_text().splitlines()
         if line != 'Translators'
         and not fullmatch(r'-*', line)
@@ -72,7 +80,7 @@ def get_link(clone_path: Path, repo: str, branch: str) -> str | Literal[False]:
                 branch=branch,
             )
             from_headers = len(set(yield_from_headers(path := Path(directory))))
-            from_git_history = get_number_from_git_history(path)
+            from_git_history = get_from_git_history(path)
             from_translators_file = len(get_from_translators_file(path))
             print(
                 f'{lang}: {from_headers=}, {from_git_history=}, {from_translators_file=}'