Add a cli command to pin a recipe (#122)

Also restore the recipe at the same time for good measure.

Author: hoodmane

pyodide_build/cli/skeleton.py

@@ -83,6 +83,32 @@ def disable(
     sys.exit(status)
 
 
+@app.command("pin")
+def pin(
+    names: list[str],
+    message: str = typer.Option(
+        "", "--message", "-m", help="Comment to explain why it was pinned"
+    ),
+    recipe_dir: str | None = typer.Option(
+        None,
+        help="The directory containing the recipe of packages. "
+        "If not specified, the default is ``<cwd>/packages``.",
+    ),
+) -> int:
+    recipe_dir_ = get_recipe_dir(recipe_dir)
+    status = 0
+    for name in names:
+        try:
+            skeleton.pin_package(recipe_dir_, name, message)
+        except skeleton.MkpkgFailedException as e:
+            status = -1
+            logger.error("%s update failed: %s", name, e)
+        except Exception:
+            print(name)
+            raise
+    sys.exit(status)
+
+
 @app.command("pypi")
 def new_recipe_pypi(
     name: str,

pyodide_build/recipe/skeleton.py

@@ -474,3 +474,21 @@ def enable_package(recipe_dir: Path, package: str) -> None:
     del pkg["_disabled"]
 
     store_meta_yaml(yaml, meta_path, yaml_content)
+
+
+def pin_package(recipe_dir: Path, package: str, message: str) -> None:
+    yaml = YAML()
+    meta_path = recipe_dir / package / "meta.yaml"
+    # Try to restore the file to its original state. If git isn't installed or
+    # the file isn't tracked, just ignore the error.
+    subprocess.run(["git", "restore", meta_path], check=False, capture_output=True)
+    yaml_content = load_meta_yaml(yaml, meta_path)
+    pkg = yaml_content["package"]
+    pkg_keys = list(pkg)
+    # Insert after the version key
+    version_idx = pkg_keys.index("version") + 1
+    pkg.insert(version_idx, "pinned", True)
+    # Add message above it
+    if message:
+        pkg.yaml_set_comment_before_after_key("pinned", before=message)
+    store_meta_yaml(yaml, meta_path, yaml_content)

pyodide_build/tests/recipe/test_skeleton.py

@@ -121,6 +121,43 @@ def test_enable_disable(tmpdir):
     assert meta_path.read_text().strip() == disabled
 
 
+def test_pin(tmpdir):
+    base_dir = Path(str(tmpdir))
+
+    pinned = dedent(
+        """\
+        package:
+          name: jedi
+          version: 0.19.1
+          # Here is some information
+          pinned: true
+          top-level:
+            - jedi
+        source:
+          sha256: shasum
+          url: aurlhere
+        requirements:
+          run:
+            - parso
+        about:
+          home: https://github.com/davidhalter/jedi
+          PyPI: https://pypi.org/project/jedi
+          summary: An autocompletion tool for Python that can be used for text editors.
+          license: MIT
+        """
+    ).strip()
+    unpinned_lines = pinned.splitlines()
+    del unpinned_lines[3:5]
+    unpinned = "\n".join(unpinned_lines)
+
+    package_dir = base_dir / "jedi"
+    package_dir.mkdir(parents=True)
+    meta_path = package_dir / "meta.yaml"
+    meta_path.write_text(unpinned)
+    skeleton.pin_package(base_dir, "jedi", "Here is some information")
+    assert meta_path.read_text().strip() == pinned
+
+
 def test_mkpkg_update_pinned(tmpdir):
     base_dir = Path(str(tmpdir))