Use dataclasses instead of named tuples, add visitors column comment, break bottom description into paragraphs, refactor code in main module

Author: m-aciek

completion.py

@@ -1,9 +1,10 @@
 import json
 from collections.abc import Iterator
+from dataclasses import dataclass
 from functools import cache
 from pathlib import Path
 from tempfile import TemporaryDirectory
-from typing import Literal, NamedTuple
+from typing import Literal
 
 import git
 from potodo import potodo
@@ -58,7 +59,8 @@ def get_completion(clones_dir: str, repo: str) -> tuple[float, 'TranslatorsData'
     return completion, translators_data
 
 
-class TranslatorsData(NamedTuple):
+@dataclass(frozen=True)
+class TranslatorsData:
     number: int
     link: str | Literal[False]
 

generate.py

@@ -10,21 +10,20 @@
 # ///
 import subprocess
 from collections.abc import Iterator
+from dataclasses import dataclass
 from datetime import datetime, timezone
 from logging import info
 from pathlib import Path
 from tempfile import TemporaryDirectory
-from typing import cast, NamedTuple
 
 from git import Repo
 from jinja2 import Template
 
 import contribute
-import repositories
 import build_status
-import visitors
+from visitors import get_number_of_visitors
 from completion import latest_branch_from_devguide, get_completion, TranslatorsData
-from repositories import Language
+from repositories import get_languages_and_repos, Language
 
 generation_time = datetime.now(timezone.utc)
 
@@ -38,57 +37,41 @@ def get_completion_progress() -> Iterator['LanguageProjectData']:
         )
         Repo.clone_from(
             'https://github.com/python/cpython.git',
-            Path(clones_dir, 'cpython'),
+            cpython_dir := Path(clones_dir, 'cpython'),
             depth=1,
             branch=latest_branch_from_devguide(devguide_dir),
         )
-        subprocess.run(
-            ['make', '-C', Path(clones_dir, 'cpython/Doc'), 'venv'], check=True
-        )
-        subprocess.run(
-            ['make', '-C', Path(clones_dir, 'cpython/Doc'), 'gettext'], check=True
-        )
+        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())
-        for language, repo in repositories.get_languages_and_repos(devguide_dir):
+        for language, repo in get_languages_and_repos(devguide_dir):
             built = language.code in languages_built
-            in_switcher = languages_built.get(language.code)
-            tx = language.code in contribute.pulling_from_transifex
-            contrib_link = contribute.get_contrib_link(language.code, repo)
-            if not repo:
-                yield LanguageProjectData(
-                    language,
-                    cast(str, repo),
-                    0.0,
-                    TranslatorsData(0, False),
-                    0,
-                    built,
-                    in_switcher,
-                    False,
-                    None,
-                )
-                continue
-            completion, translators_data = get_completion(clones_dir, repo)
-            visitors_num = (
-                visitors.get_number_of_visitors(language.code) if built else 0
-            )
+            if repo:
+                completion, translators_data = get_completion(clones_dir, repo)
+                visitors_num = get_number_of_visitors(language.code) if built else 0
+            else:
+                completion = 0.0
+                translators_data = TranslatorsData(0, False)
+                visitors_num = 0
             yield LanguageProjectData(
                 language,
                 repo,
                 completion,
                 translators_data,
                 visitors_num,
                 built,
-                in_switcher,
-                tx,
-                contrib_link,
+                in_switcher=languages_built.get(language.code),
+                uses_platform=language.code in contribute.pulling_from_transifex,
+                contribution_link=contribute.get_contrib_link(language.code, repo),
             )
 
 
-class LanguageProjectData(NamedTuple):
+@dataclass(frozen=True)
+class LanguageProjectData:
     language: Language
-    repository: str
+    repository: str | None
     completion: float
-    translators: 'TranslatorsData'
+    translators: TranslatorsData
     visitors: int
     built: bool
     in_switcher: bool | None

repositories.py

@@ -1,8 +1,8 @@
 import re
 from collections.abc import Iterator
+from dataclasses import dataclass
 from pathlib import Path
 from tempfile import TemporaryDirectory
-from typing import NamedTuple
 
 from docutils import core
 from docutils.nodes import table, row
@@ -33,7 +33,8 @@ def get_languages_and_repos(
             )
 
 
-class Language(NamedTuple):
+@dataclass(frozen=True)
+class Language:
     code: str
     name: str
 

template.html.jinja

@@ -12,7 +12,7 @@
   <th>language</th>
   <th>contribute</th>
   <th>build</th>
-  <th><a href="https://plausible.io/data-policy#how-we-count-unique-users-without-cookies" target="_blank">visitors</a></th>
+  <th>visitors*</th>
   <th>translators</th>
   <th>completion</th>
 </tr>
@@ -55,7 +55,9 @@
 {% endfor %}
 </tbody>
 </table>
-<p>For more information about translations, see the <a href="https://devguide.python.org/documentation/translating/" target="_blank">Python Developer’s Guide</a>. <br> Last updated at {{ generation_time.strftime('%A, %-d %B %Y, %-H:%M:%S %Z') }} (in {{ duration // 60 }}:{{ "{:02}".format(duration % 60) }} minutes).</p>
+<p>* sum of <a href="https://plausible.io/data-policy#how-we-count-unique-users-without-cookies" target="_blank">daily unique visitors</a> since 8 June 2024</p>
+<p>For more information about translations, see the <a href="https://devguide.python.org/documentation/translating/" target="_blank">Python Developer’s Guide</a>.</p>
+<p>Last updated at {{ generation_time.strftime('%A, %-d %B %Y, %-H:%M:%S %Z') }} (in {{ duration // 60 }}:{{ "{:02}".format(duration % 60) }} minutes).</p>
 </body>
 <script>
   function updateProgressBarVisibility() {