Merge branch 'main' into css-improvements

Author: StanFromIreland

.github/workflows/run-tests.yml

@@ -0,0 +1,21 @@
+name: Run test suite
+on:
+  pull_request:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - run: pip install -r requirements.txt
+      - run: python -m unittest discover -s tests

build_warnings.py

@@ -33,5 +33,11 @@ def number(clones_dir: str, repo: str, language_code: str) -> int:
             f'./sphinxbuild/{language_code}',  # outputdir
         )
     )
+    prefix = f'{Path(clones_dir).resolve()}/cpython/Doc/'
+    log = '\n'.join(
+        line.removeprefix(prefix)
+        for line in Path(warning_file).read_text().splitlines()
+    )
+    Path(warning_file).write_text(log)
     copyfile(warning_file, f'build/warnings-{language_code}.txt')
     return len(findall('ERROR|WARNING', Path(warning_file).read_text()))

repositories.py

@@ -2,11 +2,9 @@
 from collections.abc import Iterator
 from dataclasses import dataclass
 from pathlib import Path
-from tempfile import TemporaryDirectory
 
 from docutils import core
 from docutils.nodes import table, row
-from git import Repo
 
 
 def get_languages_and_repos(
@@ -15,10 +13,14 @@ def get_languages_and_repos(
     translating = devguide_dir.joinpath(
         'documentation/translations/translating.rst'
     ).read_text()
-    doctree = core.publish_doctree(translating)
-
-    for node in doctree.traverse(table):
-        for row_node in node.traverse(row)[1:]:
+    doctree = core.publish_doctree(
+        translating,
+        settings_overrides={'report_level': 5},
+        # docutils errors on Sphinx directives, but this does not matter for us
+    )
+
+    for node in doctree.findall(table):
+        for row_node in list(node.findall(row))[1:]:
             language = row_node[0].astext()
             repo = row_node[2].astext()
             language_match = re.match(r'(.*) \((.*)\)', language)
@@ -39,10 +41,3 @@ def get_languages_and_repos(
 class Language:
     code: str
     name: str
-
-
-if __name__ == '__main__':
-    with TemporaryDirectory() as directory:
-        Repo.clone_from('https://github.com/python/devguide.git', directory, depth=1)
-        for item in get_languages_and_repos(Path(directory)):
-            print(item)

src/style.css

@@ -113,6 +113,7 @@ td[data-label="warnings"], td[data-label="lint"] {
   tr {
     border: 1px solid #ccc;
     margin-bottom: 5px;
+    overflow-x: auto;
   }
   td {
     border: none;

templates/build-details.html.jinja

@@ -13,25 +13,27 @@
   </thead>
   <tbody>
     {% for project, metadata in build_details | sort(attribute='0.completion') | reverse %}
-      <tr>
-        <td data-label="language">{{ project.language.name }} ({{ project.language.code }})</td>
-        <td data-label="branch">{{ project.branch }}</td>
-        <td data-label="updated">{{ metadata[2].strftime('%Y/%m/%d %T') if metadata[2] else '' }}</td>
-        <td data-label="warnings">
-          {% if project.completion %}
-            <a href="warnings-{{ project.language.code }}.txt">{{ metadata[0] }}</a>
-          {% else %}
-            {{ metadata[0] }}
-          {% endif %}
-        </td>
-        <td data-label="lint">
-          {% if project.completion %}
-            <a href="warnings-lint-{{ project.language.code }}.txt">{{ metadata[1] }}</a>
-          {% else %}
-            {{ metadata[1] }}
-          {% endif %}
-        </td>
-      </tr>
+      {% if project.repository %}
+        <tr>
+          <td data-label="language">{{ project.language.name }} ({{ project.language.code }})</td>
+          <td data-label="branch">{{ project.branch }}</td>
+          <td data-label="updated">{{ metadata[2].strftime('%Y/%m/%d %T') if metadata[2] else '' }}</td>
+          <td data-label="warnings">
+            {% if project.completion %}
+              <a href="warnings-{{ project.language.code }}.txt">{{ metadata[0] }}</a>
+            {% else %}
+              {{ metadata[0] }}
+            {% endif %}
+          </td>
+          <td data-label="lint">
+            {% if project.completion %}
+              <a href="warnings-lint-{{ project.language.code }}.txt">{{ metadata[1] }}</a>
+            {% else %}
+              {{ metadata[1] }}
+            {% endif %}
+          </td>
+        </tr>
+      {% endif %}
     {% endfor %}
   </tbody>
 </table>

tests/support.py

@@ -0,0 +1,25 @@
+import sys
+import contextlib
+
+# -------------------------------- Imports ----------------------------------- #
+
+
+# Support functions borrowed from CPython's test.support
+@contextlib.contextmanager
+def import_scripts(dir='..'):
+    with DirsOnSysPath(dir) as cm:
+        yield cm
+
+
+class DirsOnSysPath(object):
+    def __init__(self, *paths):
+        self.original_value = sys.path[:]
+        self.original_object = sys.path
+        sys.path.extend(paths)
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, *ignore_exc):
+        sys.path = self.original_object
+        sys.path[:] = self.original_value

tests/test_build_status.py

@@ -0,0 +1,27 @@
+import unittest
+import support
+
+from urllib3 import PoolManager
+
+with support.import_scripts():
+    import build_status
+
+
+class testBuildStatus(unittest.TestCase):
+    def test_get_languages(self):
+        result = {
+            language: translated_name
+            for language, translated_name in build_status.get_languages(PoolManager())
+        }
+
+        self.assertIn('en', result)
+        self.assertIn('pl', result)
+        self.assertIn('zh-cn', result)
+
+        self.assertEqual(result.get('en'), None)
+        self.assertEqual(result.get('pl'), 'polski')
+        self.assertEqual(result.get('zh-cn'), '简体中文')
+
+
+if __name__ == '__main__':
+    unittest.main()

tests/test_repositories.py

@@ -0,0 +1,57 @@
+import unittest
+import support
+import tempfile
+import shutil
+
+from pathlib import Path
+from git import Repo
+
+with support.import_scripts():
+    import repositories
+    from repositories import Language
+
+
+class testRepositories(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.tempdir = tempfile.mkdtemp()
+        cls.test_repo_path = Path(cls.tempdir) / 'devguide'
+        cls.test_repo = Repo.clone_from(
+            'https://github.com/python/devguide',
+            cls.test_repo_path,
+            branch='main',
+            depth=1,
+        )
+
+    @classmethod
+    def tearDownClass(cls):
+        shutil.rmtree(cls.tempdir)
+
+    def test_get_languages_and_repos(self):
+        result = list(repositories.get_languages_and_repos(self.test_repo_path))
+
+        for entry in result:
+            info, repo = entry
+            self.assertIsInstance(info, Language)
+
+        self.assertIn(
+            (Language(code='tr', name='Turkish'), 'python/python-docs-tr'), result
+        )
+        self.assertIn(
+            (Language(code='es', name='Spanish'), 'python/python-docs-es'), result
+        )
+        self.assertIn(
+            (Language(code='pl', name='Polish'), 'python/python-docs-pl'), result
+        )
+        self.assertIn(
+            (
+                Language(code='zh-tw', name='Traditional Chinese'),
+                'python/python-docs-zh-tw',
+            ),
+            result,
+        )
+        self.assertIn(
+            (Language(code='it', name='Italian'), 'python/python-docs-it'), result
+        )
+
+        self.assertGreater(len(result), 23 - 1)