Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a comment to the x.py shebang, using /usr/bin/env #98747

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README_ENTRYPOINT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
There is no file shebang for python that works on all platforms (#71818).
To minimize breakage we have chosen to make this work when `bash` is available, or when using python/python2/python3 directly.
Unfortunately, this breaks users using the `py` wrapper on Windows, where `bash` isn't supported outside of MingW shells.
Existing versions of `py` will see the bash shebang line and try to respect it and interpret the file with `bash`.

You can do one of the following things to get x.py working:
1. Use any of `python`, `python2`, `python3`, `py -2`, or `py -3` to invoke x.py.
2. Use a MingW shell (often installed as "Git Bash", or through Cygwin).
3. Set the default file handler for .py files, which will allow using `./x.py` directly: `ftype Python.File="C:\Windows\py.exe" "-3" "%L" %*`.
`py` may be installed in a different location; use `where py` to determine where.
4. Set a default python interpreter for the `py` wrapper: Add
```ini
[commands]
bash=python
```
to `%APPDATA%\py.ini`.

5. Wait until October and update to the latest `py` wrapper, which fixes this bug: https://github.com/python/cpython/issues/94399#issuecomment-1170649407
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a year to this in case someone forgets to update this and it remains in place next year?

4 changes: 3 additions & 1 deletion x.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
#!/usr/bin/env bash
#!/usr/bin/env -S -u If_this_file_fails_to_run,read_README_ENTRYPOINT.md bash
# `py` fails when using a shebang other than /usr/bin/python{,2,3}.
# Try and give a better error by embedding a comment in the shebang.

# Modern Linux and macOS systems commonly only have a thing called `python3` and
# not `python`, while Windows commonly does not have `python3`, so we cannot
Expand Down