Add __replace__ magic method to BaseContainer for copy.replace() support #2093
+225
−118
Conversation
This file contains 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
AdrianAcala
force-pushed
the
1920-support-copy-replace-for-3-13
branch
3 times, most recently
from
5e23f16 to
3169b17
Compare
sobolevn
reviewed
Apr 2, 2025
tests/test_primitives/test_container/test_base_container/test_replace.py
Outdated
Show resolved
Hide resolved
tests/test_primitives/test_container/test_base_container/test_replace.py
Outdated
Show resolved
Hide resolved
tests/test_primitives/test_container/test_base_container/test_replace.py
Outdated
Show resolved
Hide resolved
| assert copy.replace(container) is container # type: ignore[attr-defined] | ||
|
|
||
| new_value = 'new_value' | ||
| new_container = copy.replace(container, _inner_value=new_value) # type: ignore[attr-defined] |
There was a problem hiding this comment.
The problem with copy.replace is that it breaks typing :(
It does not know that copy.replace(Success(1), 'a') will be Result[str, Any] and not Result[int, Any]
We need a typed wrapper around it for our containers. With HKT support.
AdrianAcala
force-pushed
the
1920-support-copy-replace-for-3-13
branch
2 times, most recently
from
41b4bfb to
288301e
Compare
AdrianAcala
force-pushed
the
1920-support-copy-replace-for-3-13
branch
from
288301e to
77b5252
Compare
AdrianAcala
commented
Apr 3, 2025
There was a problem hiding this comment.
@sobolevn , thanks for your review. I'll try to fix things and get back to you.
Edit: sorry. I missed something.
AdrianAcala
force-pushed
the
1920-support-copy-replace-for-3-13
branch
2 times, most recently
from
c515492 to
9c764ce
Compare
AdrianAcala
force-pushed
the
1920-support-copy-replace-for-3-13
branch
2 times, most recently
from
76db12c to
0ed959b
Compare
added 3 commits
April 3, 2025 09:02
- Added WPS453 to the per-file ignores in setup.cfg for docs/conf.py. - Updated docs/conf.py to include a noqa comment for WPS453, suppressing the warning in the documentation configuration file.
- Implemented the __replace__ method in BaseContainer to allow for the creation of new container instances with modified internal values, in line with the copy.replace() function introduced in Python 3.13. - Updated documentation to reflect this new feature and provided usage examples. - Added tests to ensure the correct functionality of the __replace__ method and its integration with the copy module. - Updated CHANGELOG to reflect this new feature.
- Updated the documentation to clarify the usage of the __replace__ method and introduced examples for both pre- and post-Python 3.13 approaches. - Refactored test cases to improve clarity and ensure they accurately validate the behavior of the __replace__ method and its integration with the copy module. - Renamed test functions for consistency and better readability.
AdrianAcala
force-pushed
the
1920-support-copy-replace-for-3-13
branch
from
0ed959b to
118084c
Compare
sobolevn
reviewed
Apr 3, 2025
| >>> from returns.result import Success | ||
| >>> | ||
| >>> value = Success(1) | ||
| >>> # We can use map to effectively replace the inner value |
There was a problem hiding this comment.
Nope, that's not correct :(
This way we can only replace values in "truthy" values. It will not replace a value in Failure(1), for example.
| @@ -299,121 +336,4 @@ We can also change the initial element to some other value: | |||
| ... sum_two_numbers, | |||
| ... ) == IO(25) | |||
|
|
|||
| ``Fold.loop`` is eager. It will be executed for all items in your iterable. | |||
|
|
|||
| Collecting an iterable of containers into a single container | |||
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.
I have made things!
Checklist
CHANGELOG.mdRelated issues
copy.replacefrom 3.13 #1920🙏 Please, if you or your company finds
dry-pythonvaluable, help us sustain the project by sponsoring it transparently on https://github.com/sponsors/dry-python. As a thank you, your profile/company logo will be added to our main README which receives hundreds of unique visitors per day.