Add C API equivalent for `sys._is_gil_enabled()`

[devinrsmith]

Feature or enhancement

Proposal:

sys._is_gil_enabled is documented as a CPython implementation detail - it would be good to have a C API to expose this in a stable way to C modules. Possibly, something like

int PyInterpreterState_IsGilEnabled(PyInterpreterState *interp)

We'd like to have a stable way to expose this information downstream, jpy-consortium/jpy#218

Has this already been discussed elsewhere?

https://discuss.python.org/t/c-api-for-querying-whether-the-gil-is-enabled-pyinterpreterstate-isgilenabled/105776

Links to previous discussion of this feature:

No response

[VanshAgarwal24036]

The implementation, tests, and documentation for sys._is_gil_enabled() appear to be complete (gh-117514 and follow-ups).
This issue looks resolved to me unless further work is needed.

[encukou]

Hi @devinrsmith,
You've used the issue template that says:

Major feature proposals should generally be discussed on Discourse before opening a GitHub issue. Wait until it's clear that most people support your idea before filling in this form.

Could you do that? Ideally, add some use case that's not solved by existing API (Py_GIL_DISABLED and PySys_GetAttr+PyObject_CallNoArgs).

[VanshAgarwal24036]

Thanks for the clarification.

I’m not the original proposer here — I was only checking whether the implementation and follow-ups for sys._is_gil_enabled() were complete, which they appear to be (gh-117514 and subsequent commits).

I’ll defer to the original author regarding any additional use cases or Discourse discussion.

[encukou]

This issue is for C API like PyInterpreterState_IsGilEnabled, not for sys._is_gil_enabled.

[VanshAgarwal24036]

Thanks for the clarification, understood.

So the remaining scope of this issue is to provide a C API (e.g. PyInterpreterState_IsGilEnabled) for extensions, rather than the Python-level sys._is_gil_enabled() which is already merged.

Before starting on an implementation, could you confirm whether adding such a public C API is desired at this point, or if this should be discussed on Discourse first?

[johnslavik]

Before starting on an implementation, could you confirm whether adding such a public C API is desired at this point, or if this should be discussed on Discourse first?

It should be discussed on Discourse first. #143747 (comment)

[VanshAgarwal24036]

Understood, thanks for the clarification.

I won’t proceed with an implementation until this has been discussed on Discourse.

[VanshAgarwal24036]

I’ve started a Discourse discussion as suggested; it’s currently pending moderation. I’ll add the link once it’s approved.

[VanshAgarwal24036]

Discourse discussion started here:
https://discuss.python.org/t/c-api-for-querying-whether-the-gil-is-enabled-pyinterpreterstate-isgilenabled/105776