PyO3/pyo3

RFC: Make pyclass immutable by default

Open

#4,369 opened on Jul 21, 2024

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Rust (10,152 stars) (668 forks)batch import
Good First Issuerefactoring

Description

In https://github.com/PyO3/pyo3/pull/1979#pullrequestreview-803253395 we discussed that we'd like to have #[pyclass(mutable)], making pyclasses immutable by default and mutability opt-in.

Currently we have #[pyclass(frozen)] where this is the other way around; they are mutable by default.

Contributor guide

Tech stack
rustpython
Domain
backenddeveloper experience
Issue type
research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
5
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Rust programmingPyO3 internalsunderstanding of Rust attributes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
10
Research direction
Study the current implementation of `#[pyclass(frozen)]` in the PyO3 source code, particularly in `pyo3 macros/src/pyclass.rs`. Read the discussion in the referenced PR #1979 to understand the motivations and constraints. Then propose a design document or a prototype for making pyclass immutable by default, including migration strategy for existing code.
RFC: Make pyclass immutable by default · PyO3/pyo3#4369 | Good First Issue