Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32.4k
bpo-43956: Doc/c-api: Fix default program name#24876
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
the-knights-who-say-ni commentedMar 15, 2021
Hello, and thanks for your contribution! I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed thePSF contributor agreement (CLA). Recognized GitHub usernameWe couldn't find abugs.python.org (b.p.o) account corresponding to the following GitHub usernames: This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please followthe steps outlined in the CPython devguide to rectify this issue. You cancheck yourself to see if the CLA has been received. Thanks again for the contribution, we look forward to reviewing it! |
Additionally, the documentation currently says:
The code, however, duplicates the string, so I am not sure this is true. Because the duplication might be an implementation detail that is intentionally left open to change, I did not remove this sentence. |
@vstinner do you have an opinion on this? Looks like this part of your commit made it so that |
Doc/c-api/init.rst Outdated
| argument should point to a zero-terminated wide character string in static | ||
| storage whose contents will not change for the duration of the program's | ||
| execution. No code in the Python interpreter will change the contents of | ||
| this storage. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I suggest to link tohttps://docs.python.org/dev/c-api/init_config.html#c.PyConfig.program_name which documents the default value.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Good point. I extended the text with a bit more detail. This includes removing the 'static lifetime' remark. Please let me know if that should be reinstated.
I already reviewed the PR. IMO it's a bad idea to document the default program in Py_SetProgramName(). It should link tohttps://docs.python.org/dev/c-api/init_config.html#c.PyConfig.program_name which is the reference. Py_SetProgramName() is a legacy API and should be avoided. |
vstinner commentedMay 12, 2021 • edited by bedevere-bot
Loading Uh oh!
There was an error while loading.Please reload this page.
edited by bedevere-bot
Uh oh!
There was an error while loading.Please reload this page.
I createdbpo-44113: "[C API] Deprecate legacy API for configure Python initialization". |
But I had updated it since, in response to your comments.
I updated the PR to only document the specifics of |
The full program name inference is done in Python/initconfig.c and thereference documentation is with PyConfig.program_name.
|
Uh oh!
There was an error while loading.Please reload this page.
This is a minor documentation fix.
The default program name is set in
Python/pathconfig.c. It ispythonon Windows, andpython3elsewhere.https://bugs.python.org/issue43956