Skip to content

GH-141148: ensure tasks/threads get fresh copy of decimal.Context#146482

Draft
nascheme wants to merge 3 commits intopython:mainfrom
nascheme:decimal_ctx_inherit
Draft

GH-141148: ensure tasks/threads get fresh copy of decimal.Context#146482
nascheme wants to merge 3 commits intopython:mainfrom
nascheme:decimal_ctx_inherit

Conversation

@nascheme
Copy link
Copy Markdown
Member

@nascheme nascheme commented Mar 26, 2026

Ensure that decimal.getcontext() returns a per-task copy of the decimal.Context so that mutations are isolated between asyncio tasks and threads when sys.flags.thread_inherit_context is set.

This change is required because decimal.Context instances are mutable. The contextvars.Context object uses an immutable data structure (HAMT) to store variable bindings. That ensures each task has its own set of contextvar bindings. However, it doesn't help if the contextvar value itself is mutated.

To fix this bug, the ContextVar.get_changed() method was added. This allows the decimal module to check if the contextvar value is newly set in this task/thread or if it is a value inherited. In the latter case, we copy the decimal.Context object to ensure that potential mutations to it are isolated.

There is a downside to this change. The contextvars.Context object has gained an additional pointer value PyHamtObject *ctx_vars_origin. I think the memory overhead of that pointer itself is negligible. That reference also keeps the entries in the "origin" HAMT object alive for as long as the new context exists. That could keep some contextvar values alive for longer.

I think in practice this is okay as well. Generally the contextvar values should be small objects. Also, if the task/thread that calls Context.run() is still around then the ctx_vars_origin object is likely still alive anyhow, due to that task holding a reference to it. It is only if the original task calls ContextVar.set() that you might free something.


📚 Documentation preview 📚: https://cpython-previews--146482.org.readthedocs.build/

Ensure that decimal.getcontext() returns a per-task copy of the
decimal.Context() so that mutations are isolated between async tasks
and threads using sys.flags.thread_inherit_context.
@skirpichev
Copy link
Copy Markdown
Member

I think it's a correct approach.

This introduce new C function, shouldn't it be discussed first with the C-API WG?

@nascheme
Copy link
Copy Markdown
Member Author

This introduce new C function, shouldn't it be discussed first with the C-API WG?

Yes, I think so. We could make APIs private so that only the decimal module could use them. However, I think a pattern where you have contextvar values that you copy-on-update would be useful (the get_changed() method enables this). Otherwise, you have to "flatten" your data structure so that all of the bindings are inside the contextvars.Context() object. Or I suppose you can make those values immutable and re-bind a new one when you update.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants