uv hook: write resolved constraints to [tool.uv] constraint-dependencies

Author: jensens

src/mxdev/uv.py

@@ -1,3 +1,4 @@
+from mxdev.config import to_bool
 from mxdev.hooks import Hook
 from mxdev.state import State
 from pathlib import Path
@@ -132,9 +133,17 @@ def _update_pyproject(self, doc: "tomlkit.TOMLDocument", state: State) -> None:
 
         packages = state.configuration.packages
         overrides = state.configuration.overrides
+        settings = state.configuration.settings
 
-        if not packages and not overrides:
-            return
+        write_constraints = to_bool(settings.get("uv-constraint-dependencies", "true"))
+        constraint_items = _constraints_to_uv(state.constraints) if write_constraints else []
+
+        if not packages and not overrides and not constraint_items:
+            # Nothing to add. The only reason to continue is to drop a stale
+            # mxdev-managed constraint-dependencies array when the feature is on.
+            uv_table = doc.get("tool", {}).get("uv")
+            if not write_constraints or uv_table is None or "constraint-dependencies" not in uv_table:
+                return
 
         if "tool" not in doc:
             doc.add("tool", tomlkit.table())
@@ -184,3 +193,19 @@ def _update_pyproject(self, doc: "tomlkit.TOMLDocument", state: State) -> None:
             override_array.extend(overrides.values())
             override_array.multiline(True)
             doc["tool"]["uv"]["override-dependencies"] = override_array
+
+        # 3. Update [tool.uv] constraint-dependencies from resolved constraints
+        if write_constraints:
+            if constraint_items:
+                constraint_array = tomlkit.array()
+                constraint_array.multiline(True)
+                constraint_array.add_line(comment="managed by mxdev - do not edit")
+                for kind, text in constraint_items:
+                    if kind == "comment":
+                        constraint_array.add_line(comment=text)
+                    else:
+                        constraint_array.add_line(text)
+                doc["tool"]["uv"]["constraint-dependencies"] = constraint_array
+            elif "constraint-dependencies" in doc["tool"]["uv"]:
+                # Resolved set is empty: drop a stale mxdev-managed array.
+                del doc["tool"]["uv"]["constraint-dependencies"]

tests/test_uv.py

@@ -487,3 +487,116 @@ def test_constraints_to_uv_filters_and_preserves_order():
 def test_constraints_to_uv_empty_input():
     assert _constraints_to_uv([]) == []
     assert _constraints_to_uv(["\n", "#" * 79 + "\n", "   \n"]) == []
+
+
+def test_writes_constraint_dependencies(tmp_path, monkeypatch):
+    monkeypatch.chdir(tmp_path)
+    hook = UvPyprojectUpdater()
+    (tmp_path / "mx.ini").write_text("[settings]")
+    config = Configuration("mx.ini")
+    state = State(config)
+    state.constraints = [
+        "# begin constraints from: https://example.com/a.txt\n",
+        "Zope==6.0\n",
+        "# AccessControl==7.3 -> mxdev disabled (source)\n",
+        "# end constraints from: https://example.com/a.txt\n",
+    ]
+
+    (tmp_path / "pyproject.toml").write_text(
+        '[project]\nname = "test"\ndependencies = []\n\n[tool.uv]\nmanaged = true\n'
+    )
+
+    hook.write(state)
+
+    content = (tmp_path / "pyproject.toml").read_text()
+    assert "# managed by mxdev - do not edit" in content
+    assert "# begin constraints from: https://example.com/a.txt" in content
+    assert "# AccessControl==7.3 -> mxdev disabled (source)" in content
+    doc = tomlkit.parse(content)
+    assert list(doc["tool"]["uv"]["constraint-dependencies"]) == ["Zope==6.0"]
+
+
+def test_opt_out_disables_constraint_dependencies(tmp_path, monkeypatch):
+    monkeypatch.chdir(tmp_path)
+    hook = UvPyprojectUpdater()
+    (tmp_path / "mx.ini").write_text("[settings]\nuv-constraint-dependencies = false\n")
+    config = Configuration("mx.ini")
+    state = State(config)
+    state.constraints = ["Zope==6.0\n"]
+
+    (tmp_path / "pyproject.toml").write_text(
+        '[project]\nname = "test"\ndependencies = []\n\n[tool.uv]\nmanaged = true\n'
+    )
+
+    hook.write(state)
+
+    doc = tomlkit.parse((tmp_path / "pyproject.toml").read_text())
+    assert "constraint-dependencies" not in doc["tool"]["uv"]
+
+
+def test_replaces_existing_constraint_dependencies(tmp_path, monkeypatch):
+    monkeypatch.chdir(tmp_path)
+    hook = UvPyprojectUpdater()
+    (tmp_path / "mx.ini").write_text("[settings]")
+    config = Configuration("mx.ini")
+    state = State(config)
+    state.constraints = ["Zope==6.0\n"]
+
+    (tmp_path / "pyproject.toml").write_text(
+        '[project]\nname = "test"\ndependencies = []\n\n'
+        "[tool.uv]\nmanaged = true\n"
+        'constraint-dependencies = [\n    "OldPin==0.0.1",\n]\n'
+    )
+
+    hook.write(state)
+
+    content = (tmp_path / "pyproject.toml").read_text()
+    assert "OldPin" not in content
+    doc = tomlkit.parse(content)
+    assert list(doc["tool"]["uv"]["constraint-dependencies"]) == ["Zope==6.0"]
+
+
+def test_constraint_dependencies_idempotency(tmp_path, monkeypatch):
+    monkeypatch.chdir(tmp_path)
+    hook = UvPyprojectUpdater()
+    (tmp_path / "mx.ini").write_text("[settings]")
+    config = Configuration("mx.ini")
+    state = State(config)
+    state.constraints = [
+        "# begin constraints from: https://example.com/a.txt\n",
+        "Zope==6.0\n",
+        "AccessControl==7.3\n",
+        "# end constraints from: https://example.com/a.txt\n",
+    ]
+
+    (tmp_path / "pyproject.toml").write_text(
+        '[project]\nname = "test"\ndependencies = []\n\n[tool.uv]\nmanaged = true\n'
+    )
+
+    hook.write(state)
+    first = (tmp_path / "pyproject.toml").read_text()
+    hook.write(state)
+    second = (tmp_path / "pyproject.toml").read_text()
+    assert first == second
+
+
+def test_empty_constraints_removes_stale_managed_array(tmp_path, monkeypatch):
+    monkeypatch.chdir(tmp_path)
+    hook = UvPyprojectUpdater()
+    # A package ensures _update_pyproject does not early-return.
+    mx_ini = "[settings]\n[pkg1]\nurl = https://example.com/pkg1.git\n" "target = sources\ninstall-mode = editable\n"
+    (tmp_path / "mx.ini").write_text(mx_ini)
+    config = Configuration("mx.ini")
+    state = State(config)
+    state.constraints = []  # nothing resolved
+
+    (tmp_path / "pyproject.toml").write_text(
+        '[project]\nname = "test"\ndependencies = []\n\n'
+        "[tool.uv]\nmanaged = true\n"
+        'constraint-dependencies = [\n    "StalePin==9.9.9",\n]\n'
+    )
+
+    hook.write(state)
+
+    doc = tomlkit.parse((tmp_path / "pyproject.toml").read_text())
+    assert "constraint-dependencies" not in doc["tool"]["uv"]