Support PEP 723 scripts in `uv add` and `uv remove` #5995

blueraft · 2024-08-10T14:45:13Z

Summary

Resolves #4667

Test Plan

cargo test

charliermarsh

Thanks, look forward to reviewing, this feature is gonna be amazing.

If you haven’t already (sorry, on phone), can you ensure there’s test coverage for:

Adding a dep with an existing script tag
Adding a dep without an existing script tag (with a shebang present, with a docstring present, etc.)
Removing the last dep in an existing script tag (I think it’s fine to leave the script tag rather than removing it entirely, even if the dep list is empty).

blueraft · 2024-08-10T15:09:58Z

Adding a dep with an existing script tag
Adding a dep without an existing script tag (this is not supported yet, but I can take a look tomorrow)
Removing the last dep in an existing script tag

crates/uv-scripts/src/lib.rs

charliermarsh · 2024-08-10T16:13:49Z

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

-                Err(err) => return Err(err.into()),
-            };
+        let (requirement, source) = match dependency_destination {
+            DependencyDestination::Script(_) => (pep508_rs::Requirement::from(requirement), None),


These actually do support sources now.

Added support for sources and a test for this

charliermarsh · 2024-08-10T16:15:34Z

crates/uv-scripts/src/lib.rs

@@ -163,11 +157,13 @@ fn extract_script_tag(contents: &[u8]) -> Result<Option<String>, Pep723Error> {

        // Otherwise, the line _must_ start with ` `.
        let Some(line) = line.strip_prefix(' ') else {
+            python_script.push(line);
+            python_script.extend(lines);


Since we break, doesn't the python_script get truncated?

python_script gets all of the remaining lines for the files before we break so it should contain the rest of the script file.

charliermarsh · 2024-08-10T16:15:47Z

crates/uv-scripts/src/lib.rs

 /// Given the contents of a Python file, extract the `script` metadata block, with leading comment
-/// hashes removed.
+/// hashes removed and the python script.


What is the "python script"? Can you show an example in the docstring here?

By this I meant the python code in the rest of the script, I've added an example and some further explanation for this.

crates/uv/src/lib.rs

charliermarsh · 2024-08-10T16:21:10Z

crates/uv-cli/src/lib.rs

@@ -2509,6 +2513,9 @@ pub struct RemoveArgs {
    #[arg(long, conflicts_with = "isolated")]
    pub package: Option<PackageName>,

+    /// Specifies the Python script where the dependency will be removed.
+    #[arg(long)]


I think --script should be marked as conflicting with a bunch of other options, like: --locked, --frozen, --dev, etc. Or, we can warn in add and remove if those are set, to indicate that they're ignored, like in #5977. Fine to just follow that pattern.

I've added a warning for the other options, let me know if I missed something

Looks good. I marked --dev and --optional as conflicting, since those should truly error. The rest are more "redundant".

charliermarsh · 2024-08-10T16:21:22Z

Pumped for this!

zanieb · 2024-08-10T16:25:01Z

Wow so exciting!

blueraft · 2024-08-10T19:16:23Z

Adding a dep without an existing script tag

Can you expand on this a little about what we want to support here?

Just to clarify, do we want to support the following use case with uv add?

Suppose the script file contains this code:

import requests
from rich.pretty import pprint

resp = requests.get("https://peps.python.org/api/peps.json")
data = resp.json()
pprint([(k, v["title"]) for k, v in data.items()][:10])

If the user runs:

uv add rich requests --script example.py

Do we intend for uv add to transform the script by adding a metadata block like this at the top?

# /// script
# requires-python = ">=3.11"
# dependencies = [
#   "requests",
#   "rich",
# ]
# ///

import requests
from rich.pretty import pprint

resp = requests.get("https://peps.python.org/api/peps.json")
data = resp.json()
pprint([(k, v["title"]) for k, v in data.items()][:10])

charliermarsh · 2024-08-10T19:18:22Z

Yeah that’s what I was thinking.

My guess is it needs to appear after any shebang though (but maybe before any docstrings?)

blueraft · 2024-08-10T20:33:54Z

Thank you, that makes sense. I'll look into adding that.

blueraft · 2024-08-10T20:53:44Z

Adding a dep without an existing script tag

This should now support adding a dependency even when there is no existing script tag in the file.

charliermarsh · 2024-08-11T00:27:02Z

Great! I assume that means ready to review, I'll go through it now.

charliermarsh · 2024-08-11T01:19:09Z

Great, thank you!