WEB: Better management of releases (#56207)

Author: Dukastlik

.github/workflows/docbuild-and-upload.yml

@@ -46,6 +46,9 @@ jobs:
     - name: Build Pandas
       uses: ./.github/actions/build_pandas
 
+    - name: Test website
+      run: python -m pytest web/
+
     - name: Build website
       run: python web/pandas_web.py web/pandas --target-path=web/build
 

web/pandas_web.py

@@ -27,6 +27,7 @@
 import collections
 import datetime
 import importlib
+import itertools
 import json
 import operator
 import os
@@ -40,6 +41,7 @@
 import feedparser
 import jinja2
 import markdown
+from packaging import version
 import requests
 import yaml
 
@@ -245,6 +247,7 @@ def home_add_releases(context):
             context["releases"].append(
                 {
                     "name": release["tag_name"].lstrip("v"),
+                    "parsed_version": version.parse(release["tag_name"].lstrip("v")),
                     "tag": release["tag_name"],
                     "published": published,
                     "url": (
@@ -254,7 +257,17 @@ def home_add_releases(context):
                     ),
                 }
             )
-
+        # sorting out obsolete versions
+        grouped_releases = itertools.groupby(
+            context["releases"],
+            key=lambda r: (r["parsed_version"].major, r["parsed_version"].minor),
+        )
+        context["releases"] = [
+            max(release_group, key=lambda r: r["parsed_version"].minor)
+            for _, release_group in grouped_releases
+        ]
+        # sorting releases by version number
+        context["releases"].sort(key=lambda r: r["parsed_version"], reverse=True)
         return context
 
     @staticmethod

web/tests/test_pandas_web.py

@@ -0,0 +1,88 @@
+from unittest.mock import (
+    mock_open,
+    patch,
+)
+
+import pytest
+import requests
+
+from web.pandas_web import Preprocessors
+
+
+class MockResponse:
+    def __init__(self, status_code: int, response: dict):
+        self.status_code = status_code
+        self._resp = response
+
+    def json(self):
+        return self._resp
+
+    @staticmethod
+    def raise_for_status():
+        return
+
+
+@pytest.fixture
+def context() -> dict:
+    return {
+        "main": {"github_repo_url": "pandas-dev/pandas"},
+        "target_path": "test_target_path",
+    }
+
+
+@pytest.fixture(scope="function")
+def mock_response(monkeypatch, request):
+    def mocked_resp(*args, **kwargs):
+        status_code, response = request.param
+        return MockResponse(status_code, response)
+
+    monkeypatch.setattr(requests, "get", mocked_resp)
+
+
+_releases_list = [
+    {
+        "prerelease": False,
+        "published_at": "2024-01-19T03:34:05Z",
+        "tag_name": "v1.5.6",
+        "assets": None,
+    },
+    {
+        "prerelease": False,
+        "published_at": "2023-11-10T19:07:37Z",
+        "tag_name": "v2.1.3",
+        "assets": None,
+    },
+    {
+        "prerelease": False,
+        "published_at": "2023-08-30T13:24:32Z",
+        "tag_name": "v2.1.0",
+        "assets": None,
+    },
+    {
+        "prerelease": False,
+        "published_at": "2023-04-30T13:24:32Z",
+        "tag_name": "v2.0.0",
+        "assets": None,
+    },
+    {
+        "prerelease": True,
+        "published_at": "2023-01-19T03:34:05Z",
+        "tag_name": "v1.5.3xd",
+        "assets": None,
+    },
+    {
+        "prerelease": False,
+        "published_at": "2027-01-19T03:34:05Z",
+        "tag_name": "v10.0.1",
+        "assets": None,
+    },
+]
+
+
+@pytest.mark.parametrize("mock_response", [(200, _releases_list)], indirect=True)
+def test_web_preprocessor_creates_releases(mock_response, context):
+    m = mock_open()
+    with patch("builtins.open", m):
+        context = Preprocessors.home_add_releases(context)
+        release_versions = [release["name"] for release in context["releases"]]
+        assert release_versions == ["10.0.1", "2.1.3", "2.0.0", "1.5.6"]