mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-16 23:01:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

#5144: document that PySys_SetArgv prepends the script directory (or the empty string) to sys.path.

Browse source
This commit is contained in:
Georg Brandl 2009-02-05 10:37:07 +00:00
parent 174fbe7742
commit acc802b171
1 changed files with 11 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

18
Doc/c-api/init.rst
View file

@ -353,13 +353,17 @@ Initialization, Finalization, and Threads
single: Py_FatalError() single: Py_FatalError()
single: argv (in module sys) single: argv (in module sys)
Set ``sys.argv`` based on *argc* and *argv*. These parameters are similar to Set :data:`sys.argv` based on *argc* and *argv*. These parameters are
those passed to the program's :cfunc:`main` function with the difference that similar to those passed to the program's :cfunc:`main` function with the
the first entry should refer to the script file to be executed rather than the difference that the first entry should refer to the script file to be
executable hosting the Python interpreter. If there isn't a script that will be executed rather than the executable hosting the Python interpreter. If there
run, the first entry in *argv* can be an empty string. If this function fails isn't a script that will be run, the first entry in *argv* can be an empty
to initialize ``sys.argv``, a fatal condition is signalled using string. If this function fails to initialize :data:`sys.argv`, a fatal
:cfunc:`Py_FatalError`. condition is signalled using :cfunc:`Py_FatalError`.
This function also prepends the executed script's path to :data:`sys.path`.
If no script is executed (in the case of calling ``python -c`` or just the
interactive interpreter), the empty string is used instead.
.. XXX impl. doesn't seem consistent in allowing 0/NULL for the params; .. XXX impl. doesn't seem consistent in allowing 0/NULL for the params;
check w/ Guido. check w/ Guido.