clarify frozen class immutability behavior with factories#1565
Open
sahvx655-wq wants to merge 2 commits into
Open
clarify frozen class immutability behavior with factories#1565sahvx655-wq wants to merge 2 commits into
sahvx655-wq wants to merge 2 commits into
Conversation
sahvx655-wq
force-pushed
the
frozen-factory-shallow-immutability
branch
from
43ac362 to
17d7047
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request clarifies the behavior of
frozen=Trueclasses when factory defaults return mutable objects that are shared.In
attrs,frozen=Trueprovides shallow immutability (preventing attribute reassignment), but it does not make the contents of mutable objects (like lists or dicts) immutable. If a factory returns a shared mutable object, all instances of the frozen class share that object, and external mutations will affect all frozen instances.This PR adds documentation and a doctest to clarify this behavior.
Changes
Added a new Factories and Frozen Classes subsection under the Defaults section in
docs/init.mdto explain shallow immutability and document this behavior with a clear doctest example.Key Points
frozen=Truedoes not prevent changes inside mutable objects.Factory defaults that return shared mutable references lead to shared-state behavior across frozen instances.