Add `uv sync --script` by charliermarsh · Pull Request #11361 · astral-sh/uv

charliermarsh · 2025-02-09T19:14:24Z

Summary

The environment is located at a stable path within the cache, based on the script's absolute path.

If a lockfile exists for the script, then we use our standard lockfile semantics (i.e., update the lockfile if necessary, etc.); if not, we just do a uv pip sync (roughly).

Example usage:

❯ uv init --script hello.py
Initialized script at `hello.py`

❯ uv add --script hello.py requests
Updated `hello.py`

❯ cargo run sync --script hello.py
Using script environment at: /Users/crmarsh/.cache/uv/environments-v1/hello-84e289fe3f6241a0
Resolved 5 packages in 3ms
Installed 5 packages in 12ms
 + certifi==2025.1.31
 + charset-normalizer==3.4.1
 + idna==3.10
 + requests==2.32.3
 + urllib3==2.3.0

Closes #6637.

konstin · 2025-02-10T11:05:59Z

crates/uv-cli/src/lib.rs

+    /// adherence with PEP 723.
+    #[arg(
+        long,
+        conflicts_with = "active",


Does it make sense to allow active e.g. for uv sync --script --active scripts/publish/test_publish.py? My use case is getting IDE support without explicit uv IDE support, having a shortcut for uv export --script scripts/publish/test_publish.py | uv pip install -. (I remember we had a discussion about that, but i can't find it)

I sort of defer to @zanieb here because it could cause complications if we ever want to allow "run a script in the context of a project".

"run a script in the context of a project".

Can you describe what this means briefly? Layered on top of the project environment?

I think --active makes sense here. I presume it's awkward to support given how I implemented --active though?

I think --active wouldn't be too bad to support. I thought there was some thought that we might want you to be able to "run a script in the context of a project" -- I don't know what it means exactly, but there's some vague allusions to it in the code. Maybe, like, layering the script's dependencies atop the project's dependencies (like you said)?

Should we... warn, if VIRTUAL_ENV is set but the user didn't provide --active (following projects)?

Did this separately: #11433

konstin · 2025-02-10T11:20:01Z

crates/uv/src/commands/project/sync.rs

-            VirtualProject::NonProject(workspace) => DependencyGroupsTarget::Workspace(workspace),
-        };
-        target.validate(&dev)?;
+            SyncTarget::Script(_) => {}


uv sync --group foo --script scripts/publish/test_publish.py passes without warnings, is that intended? Same for --extra, both are banned by uv run.

With syncing support there's new a cause for groups in scripts (say a lint group that requires ruff because you want to format and lint the script), but i assume that discussion is for later.

They should be banned. Groups and extras are not supported in scripts — they’re not in the standard.

konstin · 2025-02-10T11:29:06Z

crates/uv/tests/it/sync.rs

+            r"environments-v1/script-\w+",
+            "environments-v1/script-[HASH]",


Should we add this filter to the test context, given that it's an unstable part of stderr for this workflow?

zanieb · 2025-02-11T14:22:33Z

Perhaps controversially, running uv sync --script does create a lockfile for the script, if it doesn't exist. We can avoid that... it's just more work and more code.

It's pretty surprising that it does this, given it's otherwise opt-in. I'm hesitant to ask you to do more work, but...

Is there a reason it's that way — other than it being the easier implementation?

charliermarsh · 2025-02-11T14:23:18Z

I can change it, it will just be a lot more code, since it requires sync to support these alternative semantics.

charliermarsh · 2025-02-11T14:23:33Z

It's not a lot of work, it's just a lot more code (plus some test coverage).

zanieb · 2025-02-11T14:34:21Z

Yeah that stinks... I think we should only change it if we want to take a firmer stance on scripts having lockfiles? The part that bothers me is that we'd create one on uv sync but not uv run. Should we create one during uv run too?

charliermarsh · 2025-02-11T16:42:24Z

Sounds good -- I think I should just change it to be consistent with uv run for now.

charliermarsh · 2025-02-12T02:40:21Z

Updated the PR to avoid creating a lockfile if it doesn't already exist.

zanieb · 2025-02-12T14:28:43Z

crates/uv-cli/src/lib.rs

+    #[arg(
+        long,
+        conflicts_with = "active",
+        conflicts_with = "all_packages",


You know conflicts_with_all exists, right? :)

zanieb · 2025-02-12T14:30:04Z

crates/uv-cli/src/lib.rs

+    /// Sync the virtual environment for the specified PEP 723 Python script, rather than the current
+    /// project.


Minor preference to keep this on one line for brevity / readability in the CLI short help.

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.5.30` -> `0.5.31` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>astral-sh/uv (astral-sh/uv)</summary> ### [`v0.5.31`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0531) [Compare Source](astral-sh/uv@0.5.30...0.5.31) ##### Enhancements - Add `uv sync --script` ([#11361](astral-sh/uv#11361)) - Allow PEP 508 requirements in tool requests ([#11337](astral-sh/uv#11337)) - Allow source distributions to produce wheels with `+local` suffixes ([#11429](astral-sh/uv#11429)) - Bring parity to `uvx` and `uv tool install` requests ([#11345](astral-sh/uv#11345)) - Use a stable directory for local, remote, and stdin script virtual environments ([#11347](astral-sh/uv#11347), [#11364](astral-sh/uv#11364)) - Detect infinite recursion in `uv run` ([#11386](astral-sh/uv#11386)) ##### Python The managed Python distributions have been updated, including: - CPython 3.14.0a5, which includes a new [tail calling interpreter](https://docs.python.org/3.14/whatsnew/3.14.html#whatsnew314-tail-call) for a significant performance improvement - The bundled OpenSSL version was updated from 3.0.15 to 3.0.16 which fixes a [security advisory](https://openssl-library.org/news/secadv/20241016.txt) See the [`python-build-standalone` release notes](https://github.com/astral-sh/python-build-standalone/releases/tag/20250212) for more details. ##### Bug fixes - Fix cross-drive script installation ([#11167](astral-sh/uv#11167)) - Add indexes in priority order ([#11451](astral-sh/uv#11451)) - Allow `--python <dir>` requests to match existing environments if `sys.executable` is the same file ([#11290](astral-sh/uv#11290)) - Avoid comparing to system site packages in `--dry-run` mode ([#11427](astral-sh/uv#11427)) - Prefer running executables in the environment with `<name>` over `<name>/__main__.py` ([#11431](astral-sh/uv#11431)) - Retry local clones without hardlinks if they fail ([#11421](astral-sh/uv#11421)) ##### Documentation - Update alternative-indexes.md to use `UV_INDEX` instead of `UV_EXTRA_INDEX_URL` ([#11381](astral-sh/uv#11381)) - Update scripts guide to include using package indexes ([#11443](astral-sh/uv#11443)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

## Summary See: #11361 (comment)

## Summary The environment is located at a stable path within the cache, based on the script's absolute path. If a lockfile exists for the script, then we use our standard lockfile semantics (i.e., update the lockfile if necessary, etc.); if not, we just do a `uv pip sync` (roughly). Example usage: ``` ❯ uv init --script hello.py Initialized script at `hello.py` ❯ uv add --script hello.py requests Updated `hello.py` ❯ cargo run sync --script hello.py Using script environment at: /Users/crmarsh/.cache/uv/environments-v1/hello-84e289fe3f6241a0 Resolved 5 packages in 3ms Installed 5 packages in 12ms + certifi==2025.1.31 + charset-normalizer==3.4.1 + idna==3.10 + requests==2.32.3 + urllib3==2.3.0 ``` Closes astral-sh#6637.

## Summary See: astral-sh#11361 (comment)

charliermarsh changed the base branch from main to charlie/stable-dir February 9, 2025 19:14

charliermarsh added the enhancement New feature or improvement to existing functionality label Feb 9, 2025

charliermarsh force-pushed the charlie/sync-dir branch from 9626138 to f45a246 Compare February 9, 2025 19:20

charliermarsh added the no-build Disable building binaries in CI label Feb 9, 2025

charliermarsh force-pushed the charlie/stable-dir branch from 8e6f8ed to b8f6f85 Compare February 9, 2025 19:33

charliermarsh force-pushed the charlie/sync-dir branch from f45a246 to 794d063 Compare February 9, 2025 19:33

charliermarsh force-pushed the charlie/stable-dir branch from b8f6f85 to 610e1a4 Compare February 9, 2025 20:02

charliermarsh force-pushed the charlie/sync-dir branch from 794d063 to e92124d Compare February 9, 2025 20:04

konstin reviewed Feb 10, 2025

View reviewed changes

zanieb mentioned this pull request Feb 10, 2025

Suggestions on language server support when using inline script metadata #11197

Open

charliermarsh requested a review from zanieb February 11, 2025 02:25

charliermarsh force-pushed the charlie/stable-dir branch from 610e1a4 to ad3294b Compare February 11, 2025 21:18

charliermarsh force-pushed the charlie/sync-dir branch from e92124d to 4a1e9f7 Compare February 11, 2025 21:18

charliermarsh force-pushed the charlie/stable-dir branch 5 times, most recently from 8614745 to d810803 Compare February 12, 2025 00:37

Base automatically changed from charlie/stable-dir to main February 12, 2025 00:45

Add uv sync --script

d404d8f

charliermarsh force-pushed the charlie/sync-dir branch from 4a1e9f7 to d404d8f Compare February 12, 2025 01:54

charliermarsh mentioned this pull request Feb 12, 2025

Support --active for PEP 723 script environments #11433

Merged

charliermarsh force-pushed the charlie/sync-dir branch from dc808ba to c60b315 Compare February 12, 2025 03:05

zanieb reviewed Feb 12, 2025

View reviewed changes

zanieb approved these changes Feb 12, 2025

View reviewed changes

Avoid creating lockfile

c480945

charliermarsh force-pushed the charlie/sync-dir branch from c60b315 to c480945 Compare February 12, 2025 15:54

charliermarsh enabled auto-merge (squash) February 12, 2025 15:54

charliermarsh merged commit 792dc9d into main Feb 12, 2025
73 checks passed

charliermarsh deleted the charlie/sync-dir branch February 12, 2025 16:02

BrewTestBot mentioned this pull request Feb 12, 2025

uv 0.5.31 Homebrew/homebrew-core#207491

Merged

zanieb pushed a commit that referenced this pull request Feb 13, 2025

Support --active for PEP 723 script environments (#11433)

ceb22fc

## Summary See: #11361 (comment)

isak102 mentioned this pull request Feb 26, 2025

Get path to virtual environment for script #11794

Closed

loic-lescoat pushed a commit to loic-lescoat/uv that referenced this pull request Mar 2, 2025

Support --active for PEP 723 script environments (astral-sh#11433)

ccd9c30

## Summary See: astral-sh#11361 (comment)

		r"environments-v1/script-\w+",
		"environments-v1/script-[HASH]",

		/// Sync the virtual environment for the specified PEP 723 Python script, rather than the current
		/// project.

Comments

Conversation

charliermarsh commented Feb 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

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!

konstin Feb 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

zanieb commented Feb 11, 2025

Uh oh!

charliermarsh commented Feb 11, 2025

Uh oh!

charliermarsh commented Feb 11, 2025

Uh oh!

zanieb commented Feb 11, 2025

Uh oh!

charliermarsh commented Feb 11, 2025

Uh oh!

charliermarsh commented Feb 12, 2025

Uh oh!

zanieb Feb 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

charliermarsh commented Feb 9, 2025 •

edited

Loading

konstin Feb 10, 2025 •

edited

Loading

zanieb Feb 12, 2025 •

edited

Loading