← 返回首页
[PEP 741] gh-107954: Add PyInitConfig C API by vstinner · Pull Request #110176 · python/cpython · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

[PEP 741] gh-107954: Add PyInitConfig C API#110176

Closed
vstinner wants to merge 2 commits into
python:mainfrom
vstinner:config_set_abi
Closed

[PEP 741] gh-107954: Add PyInitConfig C API#110176
vstinner wants to merge 2 commits into
python:mainfrom
vstinner:config_set_abi

Conversation

vstinner commented Oct 1, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

Add PyInitConfig functions:

  • PyInitConfig_Python_New()
  • PyInitConfig_Isolated_New()
  • PyInitConfig_Free(config)
  • PyInitConfig_SetInt(config, key, value)
  • PyInitConfig_SetStr(config, key, value)
  • PyInitConfig_SetWStr(config, key, value)
  • PyInitConfig_SetStrList(config, key, length, items)
  • PyInitConfig_SetWStrList(config, key, length, items)
  • PyInitConfig_GetErrorMsg(config)

Add also functions using it:

  • Py_InitializeFromInitConfig(config)
  • Py_ExitWithInitConfig(config)

Changes:

  • Add Include/initconfig.h header.

Discussion: https://discuss.python.org/t/fr-allow-private-runtime-config-to-enable-extending-without-breaking-the-pyconfig-abi/18004/20

bedevere-app Bot mentioned this pull request Oct 1, 2023
Closed
vstinner marked this pull request as draft October 1, 2023 12:22

vstinner commented Oct 1, 2023

Copy link
Copy Markdown
Member Author

Discussion: https://discuss.python.org/t/fr-allow-private-runtime-config-to-enable-extending-without-breaking-the-pyconfig-abi/18004/20

vstinner commented Oct 1, 2023

Copy link
Copy Markdown
Member Author

TODO: once we reach an consensus on the API, I will document the API.

vstinner mentioned this pull request Oct 2, 2023
Closed
vstinner mentioned this pull request Nov 13, 2023
Closed
vstinner marked this pull request as ready for review November 30, 2023 22:20
vstinner requested review from a team and encukou as code owners November 30, 2023 22:20

vstinner commented Nov 30, 2023

Copy link
Copy Markdown
Member Author

I documented the API. I decided to add a new Doc/c-api/config.rst documentation for that.

encukou reviewed Dec 1, 2023
View reviewed changes

encukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Thank you!
Now that I see all the docs, it looks the design is missing a function: https://discuss.python.org/t/fr-allow-private-runtime-config-to-enable-extending-without-breaking-the-pyconfig-abi/18004/49?u=encukou

I also have a few docs nitpicks. I didn't look very closely at the implementation yet.

Comment thread Doc/c-api/config.rst Outdated Show resolved Hide resolved
Comment thread Doc/c-api/config.rst Outdated Show resolved Hide resolved
Comment thread Doc/c-api/config.rst Outdated Show resolved Hide resolved
Comment thread Doc/c-api/config.rst Outdated
Comment on lines +94 to +95
Return ``-1`` if Python wants to exit and on error. Call
:c:func:`Py_ExitWithInitConfig` in this case.

encukou Dec 1, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

What happens if you don't call it? (If it needs to be called, why does Py_InitializeFromInitConfig not call it itself?)

vstinner Dec 1, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

The idea is to let the caller decide how to handle an error or an exit code. When you embed Python, you may not want the process to exit. It's a similar design than Py_InitializeFromConfig() and the PyStatus C API.

What happens if you don't call it?

Python is in an undefined state. The error/exit code stays in PyInitConfig. It's safer to handle the init error :-)

Comment thread Doc/c-api/config.rst Outdated Show resolved Hide resolved
Comment thread Doc/c-api/config.rst Outdated Show resolved Hide resolved
vstinner force-pushed the config_set_abi branch 2 times, most recently from fee8cc4 to 7d59519 Compare December 1, 2023 16:08

vstinner commented Dec 1, 2023

Copy link
Copy Markdown
Member Author

This change is quite big, so I moved PyConfig_Get() API to a separated PR: PR #112609.

vstinner mentioned this pull request Dec 7, 2023
Closed
4 tasks
pythongh-107954: Add PyInitConfig C API …
6d02e9e
Add PyInitConfig functions: * PyInitConfig_Python_New() * PyInitConfig_Isolated_New() * PyInitConfig_Free(config) * PyInitConfig_SetInt(config, key, value) * PyInitConfig_SetStr(config, key, value) * PyInitConfig_SetWStr(config, key, value) * PyInitConfig_SetStrList(config, key, length, items) * PyInitConfig_SetWStrList(config, key, length, items) * PyInitConfig_Exception(config) * PyInitConfig_GetError(config, &err_msg) * PyInitConfig_GetExitCode(config, &exitcode) Add also functions using it: * Py_InitializeFromInitConfig(config) * Py_ExitWithInitConfig(config) Add these functions to the limited C API. Changes: * Add Doc/c-api/config.rst. * Add Include/initconfig.h header.

vstinner commented Dec 20, 2023

Copy link
Copy Markdown
Member Author

This API is kind of complicated (there are multiple use cases). I created PR #112609 as a starting point, just to add two functions. But apparently, adding PyConfig_Get() and PyConfig_GetInt() functions is more complicated than what I expected. I don't have the bandwidth to deal with such large API for now, so I prefer to close the PR. See also my comment on the PyConfig_Get() PR.

vstinner closed this Dec 20, 2023
vstinner deleted the config_set_abi branch December 20, 2023 11:09
vstinner mentioned this pull request Jan 16, 2024
Closed
vstinner restored the config_set_abi branch February 7, 2024 02:04
vstinner changed the title gh-107954: Add PyInitConfig C API [PEP 741] gh-107954: Add PyInitConfig C API May 3, 2024

vstinner commented Aug 30, 2024

Copy link
Copy Markdown
Member Author

New PR: #123502

vstinner mentioned this pull request Aug 30, 2024
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

encukou encukou left review comments

Assignees

No one assigned

Labels

awaiting core review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Footer

© 2026 GitHub, Inc.