bpo-43956: Doc/c-api: Fix default program name#24876
Conversation
|
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 the PSF contributor agreement (CLA). Recognized GitHub usernameWe couldn't find a bugs.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 follow the steps outlined in the CPython devguide to rectify this issue. You can check yourself to see if the CLA has been received. Thanks again for the contribution, we look forward to reviewing it! |
Sorry, something went wrong.
|
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. |
Sorry, something went wrong.
@vstinner do you have an opinion on this? Looks like this part of your commit made it so that |
Sorry, something went wrong.
I already reviewed the PR. IMO it's a bad idea to document the default program in Py_SetProgramName(). It should link to https://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. |
Sorry, something went wrong.
|
I created bpo-44113: "[C API] Deprecate legacy API for configure Python initialization". |
Sorry, something went wrong.
But I had updated it since, in response to your comments.
I updated the PR to only document the specifics of |
Sorry, something went wrong.
The full program name inference is done in Python/initconfig.c and the reference documentation is with PyConfig.program_name.
|
|
Sorry, something went wrong.
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