Support `--with-requirements script.py` and `-r script.py` to include inline dependency metadata from another script by blueraft · Pull Request #12763 · astral-sh/uv

blueraft · 2025-04-08T21:08:47Z

Summary

Closes #6542

Test Plan

cargo test

crates/uv-cli/src/lib.rs

crates/uv/src/commands/tool/run.rs

crates/uv-cli/src/lib.rs

zanieb · 2025-04-08T21:51:27Z

That was more straight-forward than I assumed! I think we'll need to align on the interface.

T-256 · 2025-04-09T00:55:59Z

Also consider it for uv run: Using script entry point with inline dependencies #7032

zanieb · 2025-05-15T14:06:40Z

@blueraft I wonder if we can push this forward? I think support in --with-requirements might make sense still, given we read a bunch of other file types there. I wonder if we can just sniff for a PEP 723 inline metadata entry in the script if there's no file extension?

blueraft · 2025-05-15T15:52:33Z

I wonder if we can just sniff for a PEP 723 inline metadata entry in the script if there's no file extension?

Yeah, I think we could do that. Let me give that a try!

…metadata from another script

zanieb · 2025-08-15T13:35:03Z

crates/uv/src/lib.rs

+            let pep723_results = join_all(
+                args.with_requirements
+                    .iter()
+                    .filter(|file| is_pep723_candidate(file))
+                    .map(|file| async move {
+                        let result = Pep723Script::read(&file).await;
+                        (file, result)
+                    }),
+            )
+            .await;


I'm sorry if this is something we've talked about before (trying to pick this back up now), but why are we doing all this here instead of in RequirementsSource::from_requirements_file? It feels weird to parse these eagerly then filter them from the subsequent call?

As far as I can tell, RequirementsSource::from_requirements_file is used in a bunch of places, but we may not want to support reading requirements from a PEP723 script in all of those instances. I guess we could pass a flag to that function whether to accept PEP723 scripts or not but no strong preference there

I see. I think I probably would expect it to support PEP 723 scripts everywhere, e.g., --with-requirements <path> being equivalent to pip install -r <path> and pip compile <path>. I wonder if there are edge-cases where we wouldn't want it? Like -r script.py inside a requirements.txt file? Do we already allow -r pyproject.toml inside requirements.txt files? If so, I guess this would be fine?

--with-requirements <path> being equivalent to pip install -r <path>

Does this mean we would also support uv pip install -r script.py?

Do we already allow -r pyproject.toml inside requirements.txt files?

This doesn't seem to be supported

❯ cat requirements.txt -r pyproject.toml flask ❯ uv pip install -r requirements.txt error: Error parsing included file in `requirements.txt` at position 0 Caused by: Unexpected '[', expected '-c', '-e', '-r' or the start of a requirement at pyproject.toml:1:1

Does this mean we would also support uv pip install -r script.py?

Yeah, I think so. I think it'd be inconsistent otherwise, and I'm not sure why we shouldn't support it.

This doesn't seem to be supported

Thank goodness :) though I'm confused by that error message 🤔

zanieb · 2025-08-18T17:58:32Z

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

                bail!("Adding requirements from a `setup.py` is not supported in `uv add`");
            }
+            RequirementsSource::Pep723Script(_) => {
+                bail!("Adding requirements from a PEP723 script is not supported in `uv add`");


Suggested change

bail!("Adding requirements from a PEP723 script is not supported in `uv add`");

bail!("Adding requirements from a PEP 723 script is not supported in `uv add`");

We probably could support this fwiw — it seems less confusing than importing from another project. It seems good to wait until there's a clear use-case though.

zanieb · 2025-08-18T18:00:06Z

crates/uv-requirements/src/specification.rs

+                    Ok(Some(script)) => Pep723Item::Script(script),
+                    Ok(None) => {
+                        return Err(anyhow::anyhow!(
+                            "`{}` does not contain a PEP 723 metadata tag; run `{}` to initialize the script",


I'd probably omit the run ... to initialize hint. That belongs outside the error message. The dependencies would be empty too, so it'd have no meaningful effect for this kind of usage.

crates/uv-requirements/src/specification.rs

crates/uv-requirements/src/sources.rs

zanieb · 2025-08-18T18:07:43Z

crates/uv/tests/it/tool_run.rs

+    ----- stdout -----
+
+    ----- stderr -----
+    error: `not_pep723_script.py` does not contain a PEP 723 metadata tag; run `uv init --script not_pep723_script.py` to initialize the script


I wonder if we should just say "script metadata tag"? I generally don't want the specification to be a user-facing concept and prefer to refer to "inline script metadata".

crates/uv-cli/src/lib.rs

zanieb · 2025-08-18T21:33:30Z

crates/uv-requirements/src/specification.rs

+                    Ok(Some(script)) => Pep723Item::Script(script),
+                    Ok(None) => {
+                        return Err(anyhow::anyhow!(
+                            "`{}` does not contain an inline script metadata tag.",


Suggested change

"`{}` does not contain an inline script metadata tag.",

"`{}` does not contain inline script metadata",

Just bike-shedding the message, but note we don't end with a period for single sentence errors..

zanieb · 2025-09-05T16:45:56Z

Thank you so much for your patience here!

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.8.15` -> `0.8.17` | 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.8.17`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0817) [Compare Source](astral-sh/uv@0.8.16...0.8.17) Released on 2025-09-10. ##### Enhancements - Improve error message for HTTP validation in auth services ([#15768](astral-sh/uv#15768)) - Respect `PYX_API_URL` when suggesting `uv auth login` on 401 ([#15774](astral-sh/uv#15774)) - Add pyx as a supported PyTorch index URL ([#15769](astral-sh/uv#15769)) ##### Bug fixes - Avoid initiating login flow for invalid API keys ([#15773](astral-sh/uv#15773)) - Do not search for a password for requests with a token attached already ([#15772](astral-sh/uv#15772)) - Filter pre-release Python versions in `uv init --script` ([#15747](astral-sh/uv#15747)) ### [`v0.8.16`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0816) [Compare Source](astral-sh/uv@0.8.15...0.8.16) ##### Enhancements - Allow `--editable` to override `editable = false` annotations ([#15712](astral-sh/uv#15712)) - Allow `editable = false` for workspace sources ([#15708](astral-sh/uv#15708)) - Show a dedicated error for virtual environments in source trees on build ([#15748](astral-sh/uv#15748)) - Support Android platform tags ([#15646](astral-sh/uv#15646)) - Support iOS platform tags ([#15640](astral-sh/uv#15640)) - Support scripts with inline metadata in `--with-requirements` and `--requirements` ([#12763](astral-sh/uv#12763)) ##### Preview features - Support `--no-project` in `uv format` ([#15572](astral-sh/uv#15572)) - Allow `uv format` in unmanaged projects ([#15553](astral-sh/uv#15553)) ##### Bug fixes - Avoid erroring when `match-runtime` target is optional ([#15671](astral-sh/uv#15671)) - Ban empty usernames and passwords in `uv auth` ([#15743](astral-sh/uv#15743)) - Error early for parent path in build backend ([#15733](astral-sh/uv#15733)) - Retry on IO errors during HTTP/2 streaming ([#15675](astral-sh/uv#15675)) - Support recursive requirements and constraints inclusion ([#15657](astral-sh/uv#15657)) - Use token store credentials for `uv publish` ([#15759](astral-sh/uv#15759)) - Fix virtual environment activation script compatibility with latest nushell ([#15272](astral-sh/uv#15272)) - Skip Python interpreters that cannot be queried with permission errors ([#15685](astral-sh/uv#15685)) ##### Documentation - Clarify that `uv auth` commands take a URL ([#15664](astral-sh/uv#15664)) - Improve the CLI help for options that accept requirements files ([#15706](astral-sh/uv#15706)) - Adds example for caching for managed Python downloads in Docker builds ([#15689](astral-sh/uv#15689)) </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).

zanieb reviewed Apr 8, 2025

View reviewed changes

crates/uv-cli/src/lib.rs Show resolved Hide resolved

zanieb reviewed Apr 8, 2025

View reviewed changes

crates/uv/src/commands/tool/run.rs Outdated Show resolved Hide resolved

zanieb reviewed Apr 8, 2025

View reviewed changes

crates/uv-cli/src/lib.rs Show resolved Hide resolved

zanieb mentioned this pull request Apr 19, 2025

Running unit tests with pytest in scripts #9061

Open

blueraft force-pushed the uvx-with-requirements-scripts branch 3 times, most recently from 76e0820 to 0cf1c92 Compare May 16, 2025 09:02

blueraft added 4 commits May 19, 2025 11:40

Support --with-requirements script.py to include inline dependency …

1a66bb4

…metadata from another script

Support --with-requirements for scripts without an extension

8444f73

Fix tests

83451db

Format

f8d9f5a

blueraft force-pushed the uvx-with-requirements-scripts branch from 0cf1c92 to f8d9f5a Compare May 19, 2025 10:59

blueraft requested a review from zanieb May 19, 2025 14:01

sharkdp mentioned this pull request Jun 23, 2025

Support single-file scripts with PEP 723 metadata astral-sh/ty#691

Open

zanieb mentioned this pull request Jul 23, 2025

How to specify a shebang to run a streamlit app python file with inline requirements? #14472

Open

zanieb self-assigned this Jul 28, 2025

zanieb mentioned this pull request Jul 28, 2025

Passing Python interpreter options when running a uv-managed Python script #14932

Open

blueraft mentioned this pull request Aug 15, 2025

How to run pyright on a uv script #15296

Closed

blueraft added 2 commits August 15, 2025 10:17

Merge branch 'main' into uvx-with-requirements-scripts

c9ee3a5

Update cli.md

f56ee2e

zanieb reviewed Aug 15, 2025

View reviewed changes

blueraft marked this pull request as draft August 15, 2025 16:54

Support scripts dependencies for -r and --with-requirements

08f6789

zanieb reviewed Aug 18, 2025

View reviewed changes

crates/uv-requirements/src/specification.rs Outdated Show resolved Hide resolved

zanieb reviewed Aug 18, 2025

View reviewed changes

crates/uv-requirements/src/sources.rs Outdated Show resolved Hide resolved

zanieb reviewed Aug 18, 2025

View reviewed changes

blueraft added 4 commits August 18, 2025 21:33

Add tests for tool install and pip install

fa8c807

Update cli.md

b5be124

Add todo

a02a50e

Update docstring

13a5080

blueraft changed the title ~~Support --with-requirements script.py to include inline dependency metadata from another script~~ Support --with-requirements script.py and -r script.py to include inline dependency metadata from another script Aug 18, 2025

blueraft marked this pull request as ready for review August 18, 2025 19:38

blueraft added 3 commits August 18, 2025 21:39

Update lock file

724aa97

Merge branch 'main' into uvx-with-requirements-scripts

54ab163

Fix tests

1badd03

zanieb reviewed Aug 18, 2025

View reviewed changes

crates/uv-cli/src/lib.rs Outdated Show resolved Hide resolved

zanieb reviewed Aug 18, 2025

View reviewed changes

blueraft added 2 commits August 19, 2025 10:12

Update error message

01ae395

Update cli.md

8650380

zanieb approved these changes Sep 5, 2025

View reviewed changes

zanieb merged commit 6eefde2 into astral-sh:main Sep 5, 2025
230 of 242 checks passed

zanieb added the enhancement New feature or improvement to existing functionality label Sep 5, 2025

vivodi mentioned this pull request Sep 6, 2025

ci: use --with-requirements script.py to simplify script testing in CI Flexget/Flexget#4611

Merged

sharkdp mentioned this pull request Sep 8, 2025

Respect parent Python interpreter that invoked ty as a candidate Python env astral-sh/ty#989

Closed

BrewTestBot mentioned this pull request Sep 10, 2025

uv 0.8.16 Homebrew/homebrew-core#236804

Merged

zanieb mentioned this pull request Jan 21, 2026

Using script entry point with inline dependencies #7032

Open

	bail!("Adding requirements from a PEP723 script is not supported in `uv add`");
	bail!("Adding requirements from a PEP 723 script is not supported in `uv add`");

	"`{}` does not contain an inline script metadata tag.",
	"`{}` does not contain inline script metadata",

Comments

Conversation

blueraft commented Apr 8, 2025

Summary

Test Plan

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zanieb commented Apr 8, 2025

Uh oh!

T-256 commented Apr 9, 2025

Uh oh!

zanieb commented May 15, 2025

Uh oh!

blueraft commented May 15, 2025

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!

zanieb Aug 18, 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!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zanieb commented Sep 5, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

zanieb Aug 18, 2025 •

edited

Loading