Skip to content

Commit 29c5462

Browse files
authored
Skip invalid scripts in uv workspace list --scripts (#21416)
Signed-off-by: William Woodruff <[email protected]>
1 parent bf1d7e8 commit 29c5462

2 files changed

Lines changed: 53 additions & 5 deletions

File tree

‎crates/uv/src/commands/workspace/list.rs‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,19 @@ pub(crate) async fn list(
4444

4545
if scripts {
4646
let mut scripts = find_scripts(workspace.install_path(), cache)
47+
.filter_map(|script| match script {
48+
Ok(script) => Some(Ok(script)),
49+
Err(ScriptDiscoveryError::Parse { path, source }) => {
50+
warn_user!(
51+
"Skipping invalid PEP 723 script `{}`: {source}",
52+
path.simplified_display()
53+
);
54+
None
55+
}
56+
Err(
57+
error @ (ScriptDiscoveryError::Walk(_) | ScriptDiscoveryError::Read { .. }),
58+
) => Some(Err(error)),
59+
})
4760
.collect::<Result<Vec<_>, _>>()
4861
.with_context(|| {
4962
format!(

‎crates/uv/tests/workspace/workspace_list.rs‎

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ fn workspace_list_scripts() -> Result<()> {
365365
Ok(())
366366
}
367367

368-
/// Explicit script discovery should identify both the invalid script and the workspace root.
368+
/// Script discovery should warn about invalid metadata and continue listing valid scripts.
369369
#[test]
370370
fn workspace_list_scripts_invalid_metadata() -> Result<()> {
371371
let context = uv_test::test_context!("3.12");
@@ -379,6 +379,14 @@ fn workspace_list_scripts_invalid_metadata() -> Result<()> {
379379
requires-python = ">=3.12"
380380
dependencies = []
381381
"#})?;
382+
context
383+
.temp_dir
384+
.child("scripts/valid-script.py")
385+
.write_str(indoc::indoc! {r"
386+
# /// script
387+
# dependencies = []
388+
# ///
389+
"})?;
382390
context
383391
.temp_dir
384392
.child("fixtures/invalid-script.py")
@@ -393,12 +401,39 @@ fn workspace_list_scripts_invalid_metadata() -> Result<()> {
393401
"})?;
394402

395403
uv_snapshot!(context.filters(), context.workspace_list().arg("--scripts"), @"
396-
exit_code: 2 (failure)
404+
exit_code: 0 (success)
405+
----- stdout -----
406+
scripts/valid-script.py
407+
397408
----- stderr -----
398409
warning: The `--scripts` option is experimental and may change without warning. Pass `--preview-features workspace-list-scripts` to disable this warning.
399-
error: Failed to discover PEP 723 scripts under workspace root `[TEMP_DIR]/`
400-
Caused by: Failed to parse PEP 723 script: [TEMP_DIR]/fixtures/invalid-script.py
401-
Caused by: The script contains multiple PEP 723 metadata blocks
410+
warning: Skipping invalid PEP 723 script `[TEMP_DIR]/fixtures/invalid-script.py`: The script contains multiple PEP 723 metadata blocks
411+
");
412+
413+
// Invalid TOML should also be skipped, including when the preview feature is enabled.
414+
context
415+
.temp_dir
416+
.child("fixtures/invalid-script.py")
417+
.write_str(indoc::indoc! {r"
418+
# /// script
419+
# dependencies = [
420+
# ///
421+
"})?;
422+
423+
uv_snapshot!(context.filters(), context.workspace_list()
424+
.arg("--scripts")
425+
.arg("--preview-features")
426+
.arg("workspace-list-scripts"), @"
427+
exit_code: 0 (success)
428+
----- stdout -----
429+
scripts/valid-script.py
430+
431+
----- stderr -----
432+
warning: Skipping invalid PEP 723 script `[TEMP_DIR]/fixtures/invalid-script.py`: TOML parse error at line 1, column 17
433+
|
434+
1 | dependencies = [
435+
| ^
436+
unclosed array, expected `]`
402437
");
403438

404439
Ok(())

0 commit comments

Comments
 (0)