Conversation
This branch has not been deployed
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
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.
Summary
Addresses #482.
Since 23.2.0, cattrs skips attrs fields declared with
init=Falseby default. The customization guide explains how to include them for an individual class, but users migrating many classes need a converter-wide recipe.Add a migration example that registers both dict hook factories with
_cattrs_include_init_false=Truebefore the converter is used. It shows a nested pair of mutable attrs classes: the default converter omits the fields, the configured converter preserves their assigned values in both directions, and a separate converter remains unchanged. Link the recipe from the customization guide and the original changelog entry.This documents existing behavior and introduces no converter option or runtime change. Both factories are needed for a round trip; the example is limited to mutable classes because structuring assigns these fields after construction.
Validation on Windows with Python 3.12.2: the 17 new doctest examples and 74 existing related tests pass; the full HTML build passes with warnings treated as errors. The full doctest build has the same two Windows
Pathoutput failures as the unmodified main branch. Ruff lint, formatting, and the environment dependency check pass.Codex drafted the documentation and ran the local checks; a separate Codex agent reviewed the change and independently exercised the recipe. I have reviewed and understand the changes.