2.4.1 - Fix bug in format checking

Make more attempts to get GitHub release data.

Try to fix some flakiness.

.github/workflows/python-package.yml

@@ -75,7 +75,7 @@ jobs:
 
       - run: |
           mk python-release owner=vkottler \
-                            repo=yambs version=2.4.0
+                            repo=yambs version=2.4.1
         if: |
           matrix.python-version == '3.11'
           && matrix.system == 'ubuntu-latest'

README.md

@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.1.3
-    hash=56e5498dfc3e0d2dbd23a5dfbfe11761
+    hash=2c699e065c46c9a82b34dd32519fb24e
     =====================================
 -->
 
-# yambs ([2.4.0](https://pypi.org/project/yambs/))
+# yambs ([2.4.1](https://pypi.org/project/yambs/))
 
 [![python](https://img.shields.io/pypi/pyversions/yambs.svg)](https://pypi.org/project/yambs/)
 ![Build Status](https://github.com/vkottler/yambs/workflows/Python%20Package/badge.svg)

local/variables/package.yaml

@@ -1,5 +1,5 @@
 ---
 major: 2
 minor: 4
-patch: 0
+patch: 1
 entry: mbs

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta:__legacy__"
 
 [project]
 name = "yambs"
-version = "2.4.0"
+version = "2.4.1"
 description = "Yet another meta build-system."
 readme = "README.md"
 requires-python = ">=3.11"
@@ -36,6 +36,8 @@ test = [
   "yamllint",
   "yambs",
   "vmklib",
+  "sphinx",
+  "sphinx-book-theme",
   "setuptools-wrapper",
   "types-setuptools",
   "types-requests"

tests/commands/test_native.py

@@ -31,6 +31,5 @@ def test_native_command_basic():
         assert yambs_main([PKG_NAME, "native"]) == 0
 
         # Try to build (if we can).
-        # Re-enable this when we fix the third party script.
         if platform == "linux" and which("ninja"):
-            run(["ninja", "all"], check=True)
+            run(["ninja", "all", "format-check"], check=True)

yambs/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.1.3
-# hash=97870f506d5d2f9b5b8e3527f76efa07
+# hash=24e206542fae6896b37aff43eec1c8ec
 # =====================================
 
 """
@@ -10,4 +10,4 @@
 
 DESCRIPTION = "Yet another meta build-system."
 PKG_NAME = "yambs"
-VERSION = "2.4.0"
+VERSION = "2.4.1"

yambs/dependency/handlers/yambs/github.py

@@ -50,16 +50,17 @@ def audit_downloads(
 
         dest = root.joinpath(name)
 
-        if dest.is_file():
-            continue
-
         for suffix in to_download:
             if name.endswith(suffix):
-                # Download the file.
-                req = requests.get(asset["browser_download_url"], timeout=10)
-                with dest.open("wb") as dest_fd:
-                    for chunk in req.iter_content(chunk_size=4096):
-                        dest_fd.write(chunk)
+                # Download if necessary.
+                if not dest.is_file():
+                    # Download the file.
+                    req = requests.get(
+                        asset["browser_download_url"], timeout=10
+                    )
+                    with dest.open("wb") as dest_fd:
+                        for chunk in req.iter_content(chunk_size=4096):
+                            dest_fd.write(chunk)
 
                 data["assets"][suffix] = str(dest)
                 break
@@ -73,6 +74,7 @@ def audit_extract(root: Path, data: DependencyData) -> Path:
     if "directory" not in data:
         # The expected directory is just the name of the tarball with no
         # suffix.
+        assert TARBALL in data["assets"], data["assets"]
         expected = Path(data["assets"][TARBALL].replace(TARBALL, ""))
 
         # The name of the project is the directory name without the version

yambs/dev_requirements.txt

@@ -7,6 +7,8 @@ isort
 yamllint
 yambs
 vmklib
+sphinx
+sphinx-book-theme
 setuptools-wrapper
 types-setuptools
 types-requests

yambs/generate/ninja/format.py

@@ -42,7 +42,7 @@ def write_format_target(
 
     # Just checks formatting.
     stream.write("rule clang-format-check" + linesep)
-    stream.write("  command = {cmd} -n --Werror $in" + linesep)
+    stream.write(f"  command = {cmd} -n --Werror $in" + linesep)
 
     paths = list(paths)
     if paths:

yambs/github/__init__.py

@@ -14,6 +14,12 @@
 # internal
 from yambs.schemas import YambsDictCodec as _YambsDictCodec
 
+GIHTUB_HEADERS = {
+    "Accept": "application/vnd.github+json",
+    "X-GitHub-Api-Version": "2022-11-28",
+}
+ReleaseData = Dict[str, Any]
+
 
 class Github(_YambsDictCodec, _BasicDictCodec):
     """GitHub repository information."""
@@ -50,12 +56,6 @@ def latest_repo_release_api_url(owner: str, repo: str) -> str:
     ).geturl()
 
 
-GIHTUB_HEADERS = {
-    "Accept": "application/vnd.github+json",
-    "X-GitHub-Api-Version": "2022-11-28",
-}
-
-
 def check_api_token() -> None:
     """Check for a GitHub API token set via the environment."""
 
@@ -66,20 +66,34 @@ def check_api_token() -> None:
             ] = f"Bearer {os.environ['GITHUB_API_TOKEN']}"
 
 
-ReleaseData = Dict[str, Any]
-
-
 def latest_release_data(
     owner: str, repo: str, *args, timeout: float = None, **kwargs
 ) -> ReleaseData:
     """Get latest-release data."""
 
     check_api_token()
 
-    return requests.get(  # type: ignore
-        latest_repo_release_api_url(owner, repo),
-        *args,
-        timeout=timeout,
-        headers=GIHTUB_HEADERS,
-        **kwargs,
-    ).json()
+    result: ReleaseData = {}
+
+    # codecov was bugging out.
+    tries = kwargs.get("tries", 5)
+
+    while not validate_release(result) and tries:
+        result = requests.get(
+            latest_repo_release_api_url(owner, repo),
+            *args,
+            timeout=timeout,
+            headers=GIHTUB_HEADERS,
+            **kwargs,
+        ).json()
+        tries -= 1
+
+    assert validate_release(result), result
+
+    return result
+
+
+def validate_release(data: ReleaseData) -> bool:
+    """Ensure that GitHub release data actually contains data."""
+
+    return all(x in data for x in ["name", "html_url", "assets"])