[issue32122] Improve -x option documentation

[STINNER Victor]

STINNER Victor  added the comment:

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;

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue32122] Improve -x option documentation

[Inada Naoki]

Change by Inada Naoki :


--
keywords: +newcomer friendly
versions: +Python 3.10 -Python 2.7, Python 3.6, Python 3.7

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue32122] Improve -x option documentation

[Serhiy Storchaka]

Serhiy Storchaka  added the comment:

AFAIK this should work in Windows XP. And maybe even in Windows 2000.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue32122] Improve -x option documentation

[Steve Dower]

Steve Dower  added the comment:

Those examples look fine to me

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue32122] Improve -x option documentation

[STINNER Victor]

STINNER Victor  added the comment:

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 :-)

--
nosy: +vstinner

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue32122] Improve -x option documentation

[Serhiy Storchaka]

New submission from Serhiy Storchaka :

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.

--
assignee: docs@python
components: Documentation, Windows
messages: 306878
nosy: docs@python, paul.moore, serhiy.storchaka, steve.dower, tim.golden, 
zach.ware
priority: normal
severity: normal
stage: needs patch
status: open
title: Improve -x option documentation
type: enhancement
versions: Python 2.7, Python 3.6, Python 3.7

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com