PyO3 / PyO3/pyo3

Trait_bounds example should not need to acquire GIL

Open
#1,042 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs-design
Dominant language
Rust
Stars
16.2k
Forks
1k
Avg merge
2d 6h
Merged PRs (30d)
66

Description

In the trait_bounds example, the trait signature impl Model for UserModel has no way to pass a Python into the trait methods. The idea for this example is to show how to wrap a Rust trait which doesn't know anything about Python, so I don't think changing the trait definition is a solution either.

Originally posted by @davidhewitt in https://github.com/PyO3/pyo3/pull/1037/review_comment/create

It would be nice to come up with a pattern here which allows #[pyclass] structs which work like in this example to implement Rust traits without needing to acquire GIL.

The trait doesn't even have to be a complicated one like in the trait_bounds example. For some #[pyclass] structs even their Display implementation may need to acquire the GIL.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the trait_bounds example and the surrounding discussion about #[pyclass] trait implementations and GIL acquisition. Determine a pattern that lets Rust traits such as Display work without changing the trait definition; done means the example and relevant behavior no longer require acquiring the GIL unnecessarily.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, rust
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.