Edit pyproject.toml file's `tool.uv.sources` option if it is a uv-managed project by erral · Pull Request #81 · mxstack/mxdev

erral · 2026-03-27T16:29:22Z

For uv-managed projects (those with [tool.uv] managed=true in pyproject.toml) write in the [tool.uv.sources] option of the pyproject.toml the paths to the downloaded packages.

See erral/mxdev-uv-pyproject-updater#1 and plone/cookieplone-templates#352 for reference

…condition

…NGES

stevepiercy

Fixed heading

README.md

Co-authored-by: Steve Piercy <web@stevepiercy.com>

jensens

Feature concept is sound but needs rework in a few areas before merge. See inline comments.

jensens · 2026-03-29T22:36:46Z

pyproject.toml

    "Programming Language :: Python :: 3.14",
 ]
-dependencies = ["packaging"]
+dependencies = ["packaging", "tomlkit>=0.12.0"]


mxdev's design principle is "Minimal dependencies: Only packaging at runtime." tomlkit should be an optional/extras dependency, not a hard one.

Suggested change

dependencies = ["packaging", "tomlkit>=0.12.0"]

dependencies = ["packaging"]

Add an extras group instead:

[project.optional-dependencies] uv = ["tomlkit>=0.12.0"]

Then lazy-import in the hook with a clear install hint on ImportError.

jensens · 2026-03-29T22:36:46Z

src/mxdev/uv.py

+
+import logging
+import re
+import tomlkit


Top-level import means the module fails to load if tomlkit is not installed. Move this into the methods that need it (lazy import) so the hook class can be loaded without the dependency. Raise a clear RuntimeError with install instructions (pip install mxdev[uv]) when the import fails at call time.

jensens · 2026-03-29T22:36:47Z

src/mxdev/uv.py

+
+def normalize_name(name: str) -> str:
+    """PEP 503 normalization: lowercased, runs of -, _, . become single -"""
+    return re.sub(r"[-_.]+", "-", name).lower()


packaging is already a dependency and provides packaging.utils.canonicalize_name() which does exactly this (PEP 503). No need to reimplement.

Suggested change

return re.sub(r"[-_.]+", "-", name).lower()

from packaging.utils import canonicalize_name as normalize_name

jensens · 2026-03-29T22:36:47Z

src/mxdev/uv.py

+        pass
+
+    def write(self, state: State) -> None:
+        pyproject_path = Path("pyproject.toml")


Path("pyproject.toml") is CWD-relative. If mxdev is invoked with -c /other/path/mx.ini, this reads/writes the wrong file. Should resolve relative to the config file location or accept the path from state/config.

jensens · 2026-03-29T22:36:47Z

src/mxdev/uv.py

+            with pyproject_path.open("r", encoding="utf-8") as f:
+                doc = tomlkit.load(f)
+        except Exception as e:
+            logger.error("[%s] Failed to read pyproject.toml: %s", self.namespace, e)


Catching bare Exception swallows programming errors (TypeError, AttributeError, KeyError). Narrow to OSError (covers permission, encoding, disk-full). Same applies to the write block below at line 59.

jensens · 2026-03-29T22:36:47Z

src/mxdev/uv.py

+            doc.add("project", tomlkit.table())
+
+        if "dependencies" not in doc["project"]:
+            doc["project"]["dependencies"] = tomlkit.array()


This entire block (lines 108–126) should be removed.

Writing to [project.dependencies] mutates the project's public dependency metadata. Problems:

Entries survive after source dirs are removed — no cleanup mechanism

Easily committed to VCS by accident

Changes uv sync / pip install behavior permanently

Only grows, never shrinks (not idempotent)

[tool.uv.sources] is the correct place for dev-time path mappings. Users should manage [project.dependencies] themselves.

jensens · 2026-03-29T22:36:47Z

src/mxdev/uv.py

+from mxdev.hooks import Hook
+from mxdev.state import State
+from pathlib import Path
+from typing import Any


Any is only used for doc param in _update_pyproject. Use tomlkit.TOMLDocument for actual type safety.

jensens · 2026-03-29T22:36:47Z

tests/test_uv.py

+    sources = doc["tool"]["uv"]["sources"]
+    assert sources["editable-pkg"]["editable"] is True
+    assert sources["fixed-pkg"]["editable"] is False
+    assert "skip-pkg" not in sources


Missing test coverage:

subdirectory handling (code line 82–84)

Existing dependencies not duplicated

Error paths (unreadable/unwritable pyproject.toml)

Idempotency (hook run twice → same result)

Hook behavior when tomlkit is not installed (after making it optional)

jensens · 2026-03-29T22:36:47Z

CHANGES.md

+## 5.2.0 (unreleased)
+
+- Feature: Built-in integration with `uv` through `pyproject.toml`. When `mxdev` is run, it checks if the project has a `pyproject.toml` containing `[tool.uv]` with `managed = true`. If so, mxdev automatically adds checked-out packages to `[tool.uv.sources]` and `[project.dependencies]`. This allows for seamless use of `uv sync` or `uv run` with local checkouts. `tomlkit` is now a core dependency to preserve `pyproject.toml` formatting during updates.
+  [erral, 2026-03-27]


Doesn't match the project's established changelog format. Should be:

Suggested change

[erral, 2026-03-27]

[erral]

jensens · 2026-03-29T22:36:47Z

README.md


+## uv pyproject.toml integration
+
+mxdev includes a built-in hook to automatically update your `pyproject.toml` file when working with [uv](https://docs.astral.sh/uv/)-managed projects. 


Trailing whitespace after the period.

erral added 9 commits March 27, 2026 16:01

build: Add tomlkit as a core dependency for uv support

a4e0ab3

feat: Merge UvPyprojectUpdater hook directly into mxdev core

3f94e9b

test: Add proper tests for UvPyprojectUpdater hook with managed=true …

ba6ee86

…condition

docs: Document UV pyproject updater integration

6e3d691

fix: Update entrypoint key to 'hook' and attribute contributor in CHA…

2670512

…NGES

test: Add specific test for managed=false skipping

5ca157c

docs: Move and expand UV Pyproject Integration documentation

b5b0637

docs: Remove duplicate UV Pyproject Integration section

ca05f18

test: Rework test_hook_skips_when_pyproject_toml_missing to use tmp_path

c2b3360

erral mentioned this pull request Mar 27, 2026

Update docs to cover uv managed installations plone/documentation#2072

Merged

stevepiercy suggested changes Mar 27, 2026

View reviewed changes

README.md Outdated Show resolved Hide resolved

stevepiercy mentioned this pull request Mar 28, 2026

Update mxdev managed installations with uv.tool.sources plone/documentation#2076

Open

Update README.md

645f5f7

Co-authored-by: Steve Piercy <web@stevepiercy.com>

stevepiercy approved these changes Mar 28, 2026

View reviewed changes

jensens requested changes Mar 29, 2026

View reviewed changes

	dependencies = ["packaging", "tomlkit>=0.12.0"]
	dependencies = ["packaging"]

	return re.sub(r"[-_.]+", "-", name).lower()
	from packaging.utils import canonicalize_name as normalize_name


		## uv pyproject.toml integration

		mxdev includes a built-in hook to automatically update your `pyproject.toml` file when working with [uv](https://docs.astral.sh/uv/)-managed projects.

Uh oh!

Conversation

erral commented Mar 27, 2026

Uh oh!

stevepiercy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jensens left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants