Add --gui-script flag for running Python scripts with pythonw.exe on … #9152

rajko-rad · 2024-11-15T14:58:49Z

Addresses #6805

Summary

This PR adds a --gui-script flag to uv run that allows running Python scripts with pythonw.exe on Windows, regardless of file extension. This solves the issue where users need to maintain duplicate .py and .pyw files to run the same script with and without a console window.

The implementation follows the pattern established by the existing --script flag, but uses pythonw.exe instead of python.exe on Windows. On non-Windows platforms, the flag is present but returns an error indicating it's Windows-only functionality.

Changes:

Added --gui-script flag (Windows-only)
Added Windows test to verify GUI script behavior
Added non-Windows test to verify proper error message
Updated CLI documentation

Test Plan

The changes are tested through:

New Windows-specific test that verifies:
- Script runs successfully with pythonw.exe when using --gui-script
- Console output is suppressed in GUI mode but visible in regular mode
- Same script can be run both ways without modification
New non-Windows test that verifies:
- Appropriate error message when --gui-script is used on non-Windows platforms
Documentation updates to clearly indicate Windows-only functionality

…Windows

zanieb · 2024-11-15T20:31:17Z

You can add an ignore for that Clippy complaint, if you want — or we will. We generally take our time about splitting those bools out into a struct.

zanieb · 2024-11-18T15:42:35Z

crates/uv/tests/it/run.rs

+            sys.exit(1)
+    "#})?;
+
+    let output = context.run().arg("--script").arg("script").output()?;


Should this be using --gui-script?

Agreed, but would this pass with exit code 0 on a headless windows CI run?

you are right, and I'm slightly confused why/how we passed tests with that typo... Changing now and will see how it behaves!

zanieb · 2024-11-18T15:49:28Z

Nice! I made some minor tweaks and have one blocking question.

rajko-rad · 2024-11-21T15:56:42Z

You can add an ignore for that Clippy complaint, if you want — or we will. We generally take our time about splitting those bools out into a struct.

Perfect thank you!

removed attempt to detect GUI console & just check execution engine instead

rajko-rad · 2024-11-22T20:02:08Z

Nice! I made some minor tweaks and have one blocking question.

Ok, blocking question addressed! For some reason I am getting a linting error that I think isn't real, see below?
Lint error:

Current codebase

There isn't a double space, not sure what is causing the error...

zanieb · 2024-11-27T16:00:57Z

The difference is some trailing whitespace

zanieb

Thank you!

zanieb · 2024-12-10T20:35:13Z

Just got super confused that this wasn't merged — not sure what happened there.

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.5.7` -> `0.5.8` | 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.8`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#058) [Compare Source](astral-sh/uv@0.5.7...0.5.8) **This release does not include the `powerpc64le-unknown-linux-musl` target due to a build issue. See [#9793](astral-sh/uv#9793) for details. If this change affects you, please file an issue with your use-case.** ##### Enhancements - Omit empty resolution markers in lockfile ([#9738](astral-sh/uv#9738)) - Add `--install-dir` to to `uv python install` and `uninstall` commands ([#7920](astral-sh/uv#7920)) - Add `--show-urls` and `--only-downloads` to `uv python list` ([#8062](astral-sh/uv#8062)) - Add `uv python list --all-arches` ([#9782](astral-sh/uv#9782)) - Add `uv run --gui-script` flag for running Python scripts with `pythonw.exe` ([#9152](astral-sh/uv#9152)) - Allow `--gui-script` on Unix ([#9787](astral-sh/uv#9787)) - Allow download of Python distribution variants optimized for newer x86\_64 microarchitectures ([#9781](astral-sh/uv#9781)) - Allow execution of `pyw` files on Unix ([#9759](astral-sh/uv#9759)) - Allow users to specify URLs in `project.dependencies` and `tool.uv.sources` ([#9718](astral-sh/uv#9718)) - Encode mutually-incompatible pairs of markers ([#9444](astral-sh/uv#9444)) - Improve the error message when a Python install request is not valid ([#9783](astral-sh/uv#9783)) - Preserve directory-level standalone build symlinks ([#9723](astral-sh/uv#9723)) - Add support for `uv publish --index <name>` ([#9694](astral-sh/uv#9694)) - Reframe `--locked` and `--frozen` as `--check` operations for `uv lock` ([#9662](astral-sh/uv#9662)) - Rename Python install scratch directory from `.cache` -> `.temp` ([#9756](astral-sh/uv#9756)) - Enable `uv tool uninstall uv` on Windows ([#8963](astral-sh/uv#8963)) - Improve self-dependency hint to make shadowing clear ([#9716](astral-sh/uv#9716)) - Refactor unavailable metadata to shrink the resolver ([#9769](astral-sh/uv#9769)) - Show 'depends on itself' for proxy packages ([#9717](astral-sh/uv#9717)) - Show a dedicated error for missing subdirectories ([#9761](astral-sh/uv#9761)) - Show a dedicated hint for missing `git+` prefixes ([#9789](astral-sh/uv#9789)) ##### Performance - Eagerly error when parsing `pyproject.toml` requirements ([#9704](astral-sh/uv#9704)) - Use copy-on-write when normalizing paths ([#9710](astral-sh/uv#9710)) ##### Bug fixes - Avoid enforcing non-conflicts in `uv export` ([#9751](astral-sh/uv#9751)) - Don't drop comments between items in TOML tables ([#9784](astral-sh/uv#9784)) - Don't fail with `--no-build` when static metadata is available ([#9785](astral-sh/uv#9785)) - Don't filter non-patch registry version ([#9736](astral-sh/uv#9736)) - Don't read metadata from stale `.egg-info` files ([#9760](astral-sh/uv#9760)) - Enforce correctness of self-dependencies ([#9705](astral-sh/uv#9705)) - Fix projects's typo in resolver error messages ([#9708](astral-sh/uv#9708)) - Ignore `.` prefixed directories during managed Python installation discovery ([#9786](astral-sh/uv#9786)) - Improve handling of invalid virtual environments during interpreter discovery ([#8086](astral-sh/uv#8086)) - Normalize relative paths when `--project` is specified ([#9709](astral-sh/uv#9709)) - Respect self-constraints on recursive extras ([#9714](astral-sh/uv#9714)) - Respect user settings for tracing coloring ([#9733](astral-sh/uv#9733)) - Retry on tar extraction errors ([#9753](astral-sh/uv#9753)) - Add conflict markers to the lock file ([#9370](astral-sh/uv#9370)) - De-duplicate resolution markers ([#9780](astral-sh/uv#9780)) - Avoid 403 error hint for PyTorch URLs ([#9750](astral-sh/uv#9750)) - Avoid treating non-existent `--find-links` as relative URLs ([#9720](astral-sh/uv#9720)) - Omit Windows Store `python3.13.exe` et al ([#9679](astral-sh/uv#9679)) - Replace executables with broken symlinks during `uv python install` ([#9706](astral-sh/uv#9706)) ##### Documentation - Fix build failure links ([#9740](astral-sh/uv#9740)) </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 self-assigned this Nov 15, 2024

konstin requested a review from zanieb November 15, 2024 15:00

Add --gui-script flag for running Python scripts with pythonw.exe on …

4740ff3

…Windows

rajko-rad force-pushed the add-gui-script-flag-6805 branch from e6ca059 to 4740ff3 Compare November 15, 2024 17:56

rajko-rad added 6 commits November 15, 2024 13:10

fix formatting

cec8d41

remove comments

44868ab

remove space

d92c175

lint fix

8730f91

add etter logging for windows gui test

a24e5f8

fix docs fmt

eb31a61

rajko-rad added 2 commits November 15, 2024 15:32

adjusted test

8da30db

add os

149b007

zanieb reviewed Nov 18, 2024

View reviewed changes

zanieb added 2 commits November 18, 2024 09:42

Ignore clippy error

1c47157

Add hint to use --script on unix

1a54f3a

samypr100 added the windows Specific to the Windows platform label Nov 21, 2024

rajko-rad added 7 commits November 21, 2024 12:04

correct test to run --gui-script and exit with 0

e0cf8a9

removed attempt to detect GUI console & just check execution engine instead

script vs. script.pyw

bab6950

change test output

94a10b5

revert test changes

c96d2f9

resolved and audited times

f819352

removed extra line

bdb5e5d

added ###

785dc6b

Format

444273f

zanieb approved these changes Nov 27, 2024

View reviewed changes

zanieb merged commit f6f9179 into astral-sh:main Dec 10, 2024
64 checks passed

BrewTestBot mentioned this pull request Dec 11, 2024

uv 0.5.8 Homebrew/homebrew-core#200827

Merged

Choudhry18 mentioned this pull request Dec 31, 2024

Add an option to uv run to run a .py script with pythonw.exe instead of python.exe #6805

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add --gui-script flag for running Python scripts with pythonw.exe on … #9152

Add --gui-script flag for running Python scripts with pythonw.exe on … #9152

rajko-rad commented Nov 15, 2024

zanieb commented Nov 15, 2024

zanieb Nov 18, 2024

samypr100 Nov 21, 2024 •

edited

Loading

rajko-rad Nov 21, 2024

zanieb commented Nov 18, 2024

rajko-rad commented Nov 21, 2024

rajko-rad commented Nov 22, 2024

zanieb commented Nov 27, 2024

zanieb left a comment

zanieb commented Dec 10, 2024

Add --gui-script flag for running Python scripts with pythonw.exe on … #9152

Add --gui-script flag for running Python scripts with pythonw.exe on … #9152

Conversation

rajko-rad commented Nov 15, 2024

Summary

Test Plan

zanieb commented Nov 15, 2024

zanieb Nov 18, 2024

Choose a reason for hiding this comment

samypr100 Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

rajko-rad Nov 21, 2024

Choose a reason for hiding this comment

zanieb commented Nov 18, 2024

rajko-rad commented Nov 21, 2024

rajko-rad commented Nov 22, 2024

zanieb commented Nov 27, 2024

zanieb left a comment

Choose a reason for hiding this comment

zanieb commented Dec 10, 2024

samypr100 Nov 21, 2024 •

edited

Loading