Change contextvars C API to use PyObject

[1st1]

BPO	34762
Nosy	@gvanrossum, @rhettinger, @scoder, @vstinner, @ned-deily, @ericsnowcurrently, @serhiy-storchaka, @1st1, @miss-islington
PRs	bpo-34762: Fix contextvars C API to use PyObject* pointer types. #9473 [3.7] bpo-34762: Fix contextvars C API to use PyObject* pointer types. (GH-9473) #9478 bpo-34762: Update PyContext* refs to PyObject* in asyncio and decimal #9609 [3.7] bpo-34762: Update PyContext* refs to PyObject* in asyncio and decimal #9610

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2018-09-27.19:35:15.549>
created_at = <Date 2018-09-21.15:06:32.391>
labels = ['interpreter-core', '3.8', 'type-feature', '3.7']
title = 'Change contextvars C API to use PyObject'
updated_at = <Date 2018-09-27.19:35:15.547>
user = 'https://github.com/1st1'

bugs.python.org fields:

activity = <Date 2018-09-27.19:35:15.547>
actor = 'yselivanov'
assignee = 'none'
closed = True
closed_date = <Date 2018-09-27.19:35:15.549>
closer = 'yselivanov'
components = ['Interpreter Core']
creation = <Date 2018-09-21.15:06:32.391>
creator = 'yselivanov'
dependencies = []
files = []
hgrepos = []
issue_num = 34762
keywords = ['patch']
message_count = 20.0
messages = ['325989', '325990', '325991', '325993', '325999', '326000', '326002', '326003', '326004', '326007', '326009', '326022', '326025', '326027', '326028', '326574', '326575', '326582', '326585', '326586']
nosy_count = 9.0
nosy_names = ['gvanrossum', 'rhettinger', 'scoder', 'vstinner', 'ned.deily', 'eric.snow', 'serhiy.storchaka', 'yselivanov', 'miss-islington']
pr_nums = ['9473', '9478', '9609', '9610']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue34762'
versions = ['Python 3.7', 'Python 3.8']

[1st1]

Unfortunately, the current C API for PEP-567 has a flaw: it uses non-PyObject pointers.

This causes problems with integrating with tools like Cython, where PyObject is special and a lot of machinery recognizes it and manages refcounts correctly.

It also goes against the recent push to improve C API; one of the things we want to fix is to eliminate non-PyObject pointer types from public APIs entirely.

Because this C API is new (landed in 3.7.0) I think it might make sense to change it in 3.7.1. I *think* this is a relatively safe (albeit annoying) change:

1. I don't expect that a lot of people use this new C API. I googled recently if anyone uses contextvars at all, and found that some people are using the Python API. The only user of C API that I'm aware of is uvloop, which I'll be happy to fix.

2. My current understanding is that this change won't break existing extensions compiled against Python 3.7.0, as it's just a change in pointers' types.

3. For example, clang spits out the following *warning* if it sees mismatched pointer types (and still compiles the extension):

   warning: incompatible pointer types passing 'PyContextVar *' (aka
   'struct _pycontextvarobject *') to parameter of type 'PyObject *' (aka 'struct _object *')
   [-Wincompatible-pointer-types]

4. This would make it slightly harder to create extension that supports both 3.7.0 and 3.7.1 and compiles without warnings. (It's possible to avoid warnings by adding some #ifdefs macro).

If we don't change this API now, we'll likely have to either live with it, or face a very slow deprecation period.

[1st1]

Just to add to this issue: I originally realized that something is wrong with the design when we had a super hard to track memory leak in uvloop, caused by Cython being unable to automatically manage increfs/decrefs for PyContext* pointers. So I do believe this is a serious pitfall.

Adding Guido to the nosy list as he accepted the PEP and IMO still has a say in this.

[vstinner]

IMHO it's not too late to change the public C API in Python 3.7.1, since it's a very new API, I don't expect many users, and I only expect compiler warnings nor hard error if existing code pass PyContextVar* instead of PyObject*.

I agree that it's way better to use PyObject* rather than specific PyContextVar*. The C API should not leak implementation details ;-)

[gvanrossum]

Let’s change it ASAP. It’s still up to Ned whether to hold up 3.7.1, if he
won’t it should go into 3.7.2.

On Fri, Sep 21, 2018 at 8:28 AM STINNER Victor <report@bugs.python.org>
wrote:

STINNER Victor <vstinner@redhat.com> added the comment:

IMHO it's not too late to change the public C API in Python 3.7.1, since
it's a very new API, I don't expect many users, and I only expect compiler
warnings nor hard error if existing code pass PyContextVar* instead of
PyObject*.

I agree that it's way better to use PyObject* rather than specific
PyContextVar*. The C API should not leak implementation details ;-)

----------
nosy: +vstinner

---

Python tracker <report@bugs.python.org>
<https://bugs.python.org/issue34762\>

---

--
--Guido (mobile)

[rhettinger]

I concur that the sooner the change is applied, the better it will be for everyone. We'll need to make a prominent notice in the release notes though.

[vstinner]

We'll need to make a prominent notice in the release notes though.

Something can be added at:
https://docs.python.org/dev/whatsnew/3.7.html#notable-changes-in-python-3-7-1

[1st1]

> We'll need to make a prominent notice in the release notes though.

Something can be added at:
https://docs.python.org/dev/whatsnew/3.7.html#notable-changes-in-python-3-7-1

Yeah, thank you for suggestion, I'll do that. I'll also update the PEP, docs in other places, and try to spread the word.

Now I'm just waiting for Ned to confirm if this goes into 3.7.1 or 3.7.2. It's his say.

[ericsnowcurrently]

one of the things we want to fix is to eliminate non-PyObject
pointer types from public APIs entirely.

A notable exception is Py_buffer. [1] As well, cross-interpreter data must not be PyObject, though that isn't much of an issue (yet). :) At some point it may make sense to make _PyCrossInterpreterData [2] part of the public C-API. However, we can cross *that* bridge later. :)

Using PyObject for contextvars makes sense (for the reasons you described) as long as they won't be shared between interpreters. I'm not super familiar with the contextvars C-API, but it looks like cross-interpreter issues are *not* a factor. If that's the case then there's nothing further to discuss. :)

[1] https://docs.python.org/3/c-api/buffer.html#buffer-structure
[2] https://github.com/python/cpython/blob/master/Include/internal/pystate.h#L137

[1st1]

> one of the things we want to fix is to eliminate non-PyObject
pointer types from public APIs entirely.

A notable exception is Py_buffer. [1]

Right, because Py_buffer isn't a PyObject at all :)

Using PyObject for contextvars makes sense (for the reasons you described) as long as they won't be shared between interpreters.

Yeah, PyContext, PyContextVar, and PyContextToken aren't supposed to be shared between sub-interpreters directly. Context is essentially a mapping of Context Variables to arbitrary Python Objects, so sharing it transparently isn't possible.

[scoder]

because Py_buffer isn't a PyObject at all :)

It owns a PyObject reference to the buffer owner, though.

[ned-deily]

Since we've already delayed 3.7.1rc cutoff for a few days, let's get it into 3.7.1 if you have the time, Yury.

[1st1]

New changeset 2ec872b by Yury Selivanov in branch 'master':
bpo-34762: Fix contextvars C API to use PyObject* pointer types. (GH-9473)
2ec872b