classification
Title: Improve -x option documentation
Type: enhancement Stage: needs patch
Components: Documentation, Windows Versions: Python 3.10
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, paul.moore, serhiy.storchaka, steve.dower, tim.golden, vstinner, zach.ware
Priority: normal Keywords: newcomer friendly

Created on 2017-11-24 06:26 by serhiy.storchaka, last changed 2020-10-27 03:10 by vstinner.

Messages (5)
msg306878 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2017-11-24 06:26
The documentation of the -x option is virtually not existing. The current short line of the description was enough to me for understanding what is the purpose of this option and how it can be used (I didn't use Windows for more than 10 years). But I was surprised not founding more detailed information about this feature in the documentation. Definitely it should be better documented. Most of users will have no ideas about this feature.

The purpose of this option is turning Python scripts into Windows batch files which can be ran as other executables. Similarly as adding she-bang and setting the executable bit allows to run them on Unix. The extension of the Python script should be changed to ".bat", and the following line should be added at the start of the script:

    @path\to\python -x %0 %* & exit /b

Or

    @py -3 -x %0 %* & exit /b

Unlike a she-bang line which is a Python comment, this line is not valid Python syntax, and the -x option is used for skipping it.
msg307190 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2017-11-28 23:29
I don't know if "@path\to\python -x %0 %* & exit /b" and "@py -3 -x %0 %* & exit /b" are correct and well supported on all recent Windows versions.

Apart of that, I like your new documentation :-)
msg307203 - (view) Author: Steve Dower (steve.dower) * (Python committer) Date: 2017-11-29 02:58
Those examples look fine to me
msg307212 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2017-11-29 08:07
AFAIK this should work in Windows XP. And maybe even in Windows 2000.
msg379721 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2020-10-27 03:10
The -x command line option is now stored as PyConfig.skip_source_first_line, documented as:
"Skip the first line of the source?"
https://docs.python.org/dev/c-api/init_config.html#c.PyConfig.skip_source_first_line

Include/cpython/initconfig.h contains a longer comment:

    /* Skip the first line of the source ('run_filename' parameter),
       allowing use of non-Unix forms of "#!cmd".
       This is intended for a DOS specific hack only.

       Set by the -x command line option. */
    int skip_source_first_line;
History
Date User Action Args
2020-10-27 03:10:18vstinnersetmessages: + msg379721
2020-10-26 04:11:24methanesetkeywords: + newcomer friendly
versions: + Python 3.10, - Python 2.7, Python 3.6, Python 3.7
2017-11-29 08:07:51serhiy.storchakasetmessages: + msg307212
2017-11-29 02:58:01steve.dowersetmessages: + msg307203
2017-11-28 23:29:35vstinnersetnosy: + vstinner
messages: + msg307190
2017-11-24 06:26:48serhiy.storchakacreate