Mercurial > cpython-lru_cache-weakref
changeset 51330:ca423008fa4a legacy-trunk
#5144: document that PySys_SetArgv prepends the script directory (or the empty string) to sys.path.
| author | Georg Brandl <georg@python.org> |
|---|---|
| date | Thu, 05 Feb 2009 10:37:07 +0000 |
| parents | 1b233c83f2a9 |
| children | 8aa71c19dcb8 |
| files | Doc/c-api/init.rst |
| diffstat | 1 files changed, 11 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/Doc/c-api/init.rst Thu Feb 05 10:30:57 2009 +0000 +++ b/Doc/c-api/init.rst Thu Feb 05 10:37:07 2009 +0000 @@ -353,13 +353,17 @@ single: Py_FatalError() single: argv (in module sys) - Set ``sys.argv`` based on *argc* and *argv*. These parameters are similar to - those passed to the program's :cfunc:`main` function with the difference that - the first entry should refer to the script file to be executed rather than the - executable hosting the Python interpreter. If there isn't a script that will be - run, the first entry in *argv* can be an empty string. If this function fails - to initialize ``sys.argv``, a fatal condition is signalled using - :cfunc:`Py_FatalError`. + Set :data:`sys.argv` based on *argc* and *argv*. These parameters are + similar to those passed to the program's :cfunc:`main` function with the + difference that the first entry should refer to the script file to be + executed rather than the executable hosting the Python interpreter. If there + isn't a script that will be run, the first entry in *argv* can be an empty + string. If this function fails to initialize :data:`sys.argv`, a fatal + 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; check w/ Guido.