uv run: List available scripts when a script is not specified #7687

kakkoyun · 2024-09-25T15:46:30Z

Signed-off-by: Kemal Akkoyun kakkoyun@gmail.com

Summary

This PR adds the ability to list available scripts in the environment
when uv run is invoked without any arguments.
It somewhat mimics the behavior of rye run command
(See https://rye.astral.sh/guide/commands/run).

This is an attempt to fix #4024.

Test Plan

I added test cases. The CI pipeline should pass.

Manuel Tests

❯ uv run
Provide a command or script to invoke with `uv run <command>` or `uv run script.py`.

The following scripts are available:

normalizer
python
python3
python3.12

See `uv run --help` for more information.

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

zanieb · 2024-09-25T16:58:28Z

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

+            .filter(|entry| {
+                entry
+                    .file_type()
+                    .is_ok_and(|file_type| file_type.is_file() || file_type.is_symlink())


Should we handle symlinks like we do in uv python list? i.e. displaying "/opt/homebrew/opt/python@3.12/bin/python3.12 -> ../Frameworks/Python.framework/Versions/3.12/bin/python3.12"

I think we should show the filename. We don't need to be super descriptive here. Propabaly this usage flow will be like:

❯ cargo run -q -- run Provide a command or script to invoke with `uv run <command>` or `uv run script.py`. The following scripts are available: python3 python3.12 python normalizer See `uv run --help` for more information.

❯ cargo run -q -- run python No entry for terminal type "xterm-256color"; using dumb terminal settings. Python 3.12.1 (main, Jan 8 2024, 05:57:25) [Clang 17.0.6 ] on linux Type "help", "copyright", "credits" or "license" for more information. >>>

zanieb · 2024-09-25T16:59:00Z

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

+            })
+            .map(|entry| entry.path())
+            .filter(|path| is_executable(path))
+            .for_each(|path| println!("{}", path.display()));


We should probably just display the name of the file, not the full path since we're making suggestions for uv run <name>.

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

zanieb · 2024-09-25T17:02:00Z

crates/uv/src/lib.rs

-            Some(RunCommand::try_from(command)?)
+            match command {
+                Some(command) => Some(RunCommand::try_from(command)?),
+                None => Some(RunCommand::Empty),


How is Some(RunCommand::Empty) different than None?

I'm just following the existing function signatures here. I preferred to use Empty since it was available rather than changing to Option<RunCommand>.

I'm not sure if there is a general convention/style to follow here.

Isn't run_command already Option<RunCommand> though?

Not in this particular context

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

Lines 52 to 77 in 26a3552

pub(crate) async fn run(

project_dir: &Path,

script: Option<Pep723Script>,

command: RunCommand,

requirements: Vec<RequirementsSource>,

show_resolution: bool,

locked: bool,

frozen: bool,

no_sync: bool,

isolated: bool,

package: Option<PackageName>,

no_project: bool,

no_config: bool,

extras: ExtrasSpecification,

dev: DevMode,

editable: EditableMode,

python: Option<String>,

settings: ResolverInstallerSettings,

python_preference: PythonPreference,

python_downloads: PythonDownloads,

connectivity: Connectivity,

concurrency: Concurrency,

native_tls: bool,

cache: &Cache,

printer: Printer,

) -> anyhow::Result<ExitStatus> {

Ah but it is at

uv/crates/uv/src/lib.rs

Line 133 in 106633a

let run_command = if let Commands::Project(command) = &*cli.command {

and

uv/crates/uv/src/lib.rs

Line 1149 in 106633a

command: Option<RunCommand>,

then we unwrap at

uv/crates/uv/src/lib.rs

Line 1230 in 106633a

let command = command.expect("run command is required");

The Empty variant is stale code i.e. we actually don't do this anymore

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

Lines 846 to 847 in 77c2496

/// Execute an empty command (in practice, `python` with no arguments).

Empty,

I'd think I'd prefer to just make it an Option<...> and remove the expect call, but I don't feel strongly. I guess if it's an Option someone could make a mistake upstream while developing and we wouldn't notice? Regardless we should update the RunCommand::Empty documentation.

Signed-off-by: Kemal Akkoyun <kakkoyun@gmail.com>

zanieb · 2024-09-25T20:05:47Z

crates/uv/tests/run.rs

+    activate.bat
+    activate.csh
+    activate.fish
+    activate.nu
+    activate.ps1
+    activate_this.py
+    deactivate.bat


I think we'll want to exclude all the shell activation scripts

zanieb · 2024-09-25T20:06:11Z

crates/uv/tests/run.rs

+    python.exe
+    pythonw.exe


We'll probably also want to exclude the .exe suffix since it's implied during invocation.

zanieb · 2024-09-25T20:07:10Z

crates/uv/tests/run.rs

+    success: true
+    exit_code: 0
+    ----- stdout -----
+    Provide a command or script to invoke with `uv run <command>` or `uv run script.py`.


Suggested change

Provide a command or script to invoke with `uv run <command>` or `uv run script.py`.

Provide a command or script to invoke with `uv run <command>` or `uv run <script>.py`.

zanieb · 2024-09-25T20:07:49Z

crates/uv/tests/run.rs

+    ----- stdout -----
+    Provide a command or script to invoke with `uv run <command>` or `uv run script.py`.
+
+    The following scripts are available:


We should probably say "commands" here not "scripts" since above you suggest running a script as script.py and it risks user's conflating the concepts.

zanieb · 2024-09-25T20:09:11Z

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

+            "\nSee `uv run --help` for more information."
+        )?;
+
+        return Ok(ExitStatus::Success);


Should we exit with a non-zero exit code? I'm not sure but I think so?

zanieb · 2024-09-25T20:10:22Z

crates/uv/tests/run.rs

+
+    python
+    python3
+    python3.12


I think I have a minor preference for omitting the leading empty newline and listing these with the prefix - .

zanieb · 2024-09-25T20:10:52Z

crates/uv-python/src/which.rs

-pub(crate) fn is_executable(path: &Path) -> bool {
+pub fn is_executable(path: &Path) -> bool {


We might want to move this to uv-fs instead of uv-python now.

kakkoyun force-pushed the list_available_scripts_and_executables branch from 3b07e17 to e95ee42 Compare September 25, 2024 15:48

zanieb reviewed Sep 25, 2024

View reviewed changes

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

zanieb reviewed Sep 25, 2024

View reviewed changes

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

zanieb reviewed Sep 25, 2024

View reviewed changes

kakkoyun force-pushed the list_available_scripts_and_executables branch from e95ee42 to 26a3552 Compare September 25, 2024 17:28

uv run: List available scripts when a script is not specified

3c1be57

Signed-off-by: Kemal Akkoyun <kakkoyun@gmail.com>

kakkoyun force-pushed the list_available_scripts_and_executables branch from 26a3552 to 3c1be57 Compare September 25, 2024 17:44

kakkoyun marked this pull request as ready for review September 25, 2024 17:44

Update tests for windows

1c3691e

Signed-off-by: Kemal Akkoyun <kakkoyun@gmail.com>

kakkoyun force-pushed the list_available_scripts_and_executables branch from acc79e2 to 1c3691e Compare September 25, 2024 19:45

kakkoyun requested a review from zanieb September 25, 2024 19:55

zanieb reviewed Sep 25, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

uv run: List available scripts when a script is not specified #7687

uv run: List available scripts when a script is not specified #7687

kakkoyun commented Sep 25, 2024 •

edited

Loading

zanieb Sep 25, 2024

kakkoyun Sep 25, 2024

zanieb Sep 25, 2024

zanieb Sep 25, 2024 •

edited

Loading

kakkoyun Sep 25, 2024

zanieb Sep 25, 2024

kakkoyun Sep 25, 2024

zanieb Sep 25, 2024 •

edited

Loading

zanieb Sep 25, 2024

zanieb Sep 25, 2024

zanieb Sep 25, 2024

zanieb Sep 25, 2024

zanieb Sep 25, 2024

zanieb Sep 25, 2024

zanieb Sep 25, 2024

	pub(crate) async fn run(
	project_dir: &Path,
	script: Option<Pep723Script>,
	command: RunCommand,
	requirements: Vec<RequirementsSource>,
	show_resolution: bool,
	locked: bool,
	frozen: bool,
	no_sync: bool,
	isolated: bool,
	package: Option<PackageName>,
	no_project: bool,
	no_config: bool,
	extras: ExtrasSpecification,
	dev: DevMode,
	editable: EditableMode,
	python: Option<String>,
	settings: ResolverInstallerSettings,
	python_preference: PythonPreference,
	python_downloads: PythonDownloads,
	connectivity: Connectivity,
	concurrency: Concurrency,
	native_tls: bool,
	cache: &Cache,
	printer: Printer,
	) -> anyhow::Result<ExitStatus> {

	/// Execute an empty command (in practice, `python` with no arguments).
	Empty,

	Provide a command or script to invoke with `uv run <command>` or `uv run script.py`.
	Provide a command or script to invoke with `uv run <command>` or `uv run <script>.py`.

		pub(crate) fn is_executable(path: &Path) -> bool {
		pub fn is_executable(path: &Path) -> bool {

uv run: List available scripts when a script is not specified #7687

Are you sure you want to change the base?

uv run: List available scripts when a script is not specified #7687

Conversation

kakkoyun commented Sep 25, 2024 • edited Loading

Summary

Test Plan

Manuel Tests

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zanieb Sep 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zanieb Sep 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kakkoyun commented Sep 25, 2024 •

edited

Loading

zanieb Sep 25, 2024 •

edited

Loading

zanieb Sep 25, 2024 •

edited

Loading