PyO3/pyo3

RFC: Make pyclass immutable by default

Open

#4,369 opened on Jul 21, 2024

View on GitHubContributor guide
 (6 comments) (0 reactions) (0 assignees)Rust (668 forks)batch import
Good First Issuerefactoring

Repository metrics

Stars
 (10,152 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Understand the current #[pyclass] macro and the existing #[pyclass(frozen)] attribute. The goal is to make immutability the default, requiring explicit #[pyclass(mutable)] for mutable classes. Review the linked PR #1979 discussion for context. Then propose code changes to flip the default.
Tech stack
rustpython
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50