Skip to content

Clarify evolve behavior for init=False fields #1587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ahmojo wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −1
Open

Clarify evolve behavior for init=False fields #1587

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,8 @@ All objects from ``attrs.filters`` are also available from ``attr.filters`` (it'
This fact has several implications:

* private attributes should be specified without the leading underscore, just like in ``__init__``.
* attributes with ``init=False`` can't be set with ``evolve``.
* ``evolve`` doesn't copy existing values from attributes with ``init=False``.
With an *attrs*-generated ``__init__``, such attributes can't be passed as changes to ``evolve`` and are initialized as they would be on a newly constructed instance, which may involve defaults, factories, or ``__attrs_post_init__``.
* the usual ``__init__`` validators will validate the new values.

.. autofunction:: attrs.validate
Expand Down