bpo-43956: Doc/c-api: Fix default program name

[joukewitteveen]

This is a minor documentation fix.

The default program name is set in Python/pathconfig.c. It is python on Windows, and python3 elsewhere.

https://bugs.python.org/issue43956

[the-knights-who-say-ni]

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 username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@joukewitteveen

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!

[joukewitteveen]

Additionally, the documentation currently says:

The 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.

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.

[ammaraskar]

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 Py_SetProgramName duplicates the string:

• af5a895#diff-09327e0a986b458413322c8ef2c9f7ff06f191cc79520787f95db7598e633415R202

[vstinner]

I suggest to link to https://docs.python.org/dev/c-api/init_config.html#c.PyConfig.program_name which documents the default value.

[joukewitteveen]

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.

[vstinner]

@joukewitteveen joukewitteveen requested a review from vstinner 5 days ago

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.

[vstinner]

I created bpo-44113: "[C API] Deprecate legacy API for configure Python initialization".

[joukewitteveen]

@joukewitteveen joukewitteveen requested a review from vstinner 5 days ago

I already reviewed the PR.

But I had updated it since, in response to your comments.

I created bpo-44113: "[C API] Deprecate legacy API for configure Python initialization".

I updated the PR to only document the specifics of Py_SetProgramName(). Even though it may be legacy, there is no reason to have incorrect documentation.

[erlend-aasland]

Py_SetProgramName and its docs were removed by #105154; closing this PR as out of date.