diff options
author | Andrew Svetlov <andrew.svetlov@gmail.com> | 2012-10-31 14:03:14 (GMT) |
---|---|---|
committer | Andrew Svetlov <andrew.svetlov@gmail.com> | 2012-10-31 14:03:14 (GMT) |
commit | e1fa22a8ae02f3321a0878456173d68922e78804 (patch) | |
tree | dfc60772cae79dc04274cfbf964634a22a6878b4 | |
parent | 4deb16dd7585582276714cae2d98b55db7fe6568 (diff) | |
download | cpython-e1fa22a8ae02f3321a0878456173d68922e78804.zip cpython-e1fa22a8ae02f3321a0878456173d68922e78804.tar.gz cpython-e1fa22a8ae02f3321a0878456173d68922e78804.tar.bz2 |
Issue #16370: Mention Py_SetProgramName in example for very high level embedding.
-rw-r--r-- | Doc/extending/embedding.rst | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/Doc/extending/embedding.rst b/Doc/extending/embedding.rst index d004d24..ccbe681 100644 --- a/Doc/extending/embedding.rst +++ b/Doc/extending/embedding.rst @@ -58,6 +58,7 @@ perform some operation on a file. :: int main(int argc, char *argv[]) { + Py_SetProgramName(argv[0]); /* optional but recommended */ Py_Initialize(); PyRun_SimpleString("from time import time,ctime\n" "print('Today is', ctime(time()))\n"); @@ -65,14 +66,18 @@ perform some operation on a file. :: return 0; } -The above code first initializes the Python interpreter with -:c:func:`Py_Initialize`, followed by the execution of a hard-coded Python script -that print the date and time. Afterwards, the :c:func:`Py_Finalize` call shuts -the interpreter down, followed by the end of the program. In a real program, -you may want to get the Python script from another source, perhaps a text-editor -routine, a file, or a database. Getting the Python code from a file can better -be done by using the :c:func:`PyRun_SimpleFile` function, which saves you the -trouble of allocating memory space and loading the file contents. +Function :c:func:`Py_SetProgramName` should be called before +:c:func:`Py_Initialize` to inform the interpreter about paths to +Python run-time libraries. Next initialize the Python interpreter +with :c:func:`Py_Initialize`, followed by the execution of a +hard-coded Python script that prints the date and time. Afterwards, +the :c:func:`Py_Finalize` call shuts the interpreter down, followed by +the end of the program. In a real program, you may want to get the +Python script from another source, perhaps a text-editor routine, a +file, or a database. Getting the Python code from a file can better +be done by using the :c:func:`PyRun_SimpleFile` function, which saves +you the trouble of allocating memory space and loading the file +contents. .. _lower-level-embedding: |