Add __replace__ magic method to BaseContainer for copy.replace() support#2093
Conversation
AdrianAcalaforce-pushed the 1920-support-copy-replace-for-3-13 branch 3 times, most recently from 5e23f16 to 3169b17Compare
Uh oh!
There was an error while loading. Please reload this page.
tests/test_primitives/test_container/test_base_container/test_replace.py Outdated Show resolvedHide resolved
Uh oh!
There was an error while loading. Please reload this page.
tests/test_primitives/test_container/test_base_container/test_replace.py Outdated Show resolvedHide resolved
Uh oh!
There was an error while loading. Please reload this page.
tests/test_primitives/test_container/test_base_container/test_replace.py Outdated Show resolvedHide resolved
Uh oh!
There was an error while loading. Please reload this page.
| assertcopy.replace(container) iscontainer# 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.
AdrianAcalaforce-pushed the 1920-support-copy-replace-for-3-13 branch 2 times, most recently from 41b4bfb to 288301eCompareAdrianAcalaforce-pushed the 1920-support-copy-replace-for-3-13 branch from 288301e to 77b5252Compare
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.
AdrianAcalaforce-pushed the 1920-support-copy-replace-for-3-13 branch 2 times, most recently from c515492 to 9c764ceCompareAdrianAcalaforce-pushed the 1920-support-copy-replace-for-3-13 branch 2 times, most recently from 76db12c to 0ed959bCompareAdrianAcalaforce-pushed the 1920-support-copy-replace-for-3-13 branch from 0ed959b to 118084cComparedocs/pages/container.rst Outdated
| >>> 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.
Uh oh!
There was an error while loading. Please reload this page.
AdrianAcalaforce-pushed the 1920-support-copy-replace-for-3-13 branch from 118084c to 2fa9fdaCompare
AdrianAcala commented Apr 14, 2025
@sobolevn , sorry about the delay. My family got sick and then I got sick and then work has been busy since I missed some time. I went through this again and resolved what I think is what you want. Please review again please. |
AdrianAcalaforce-pushed the 1920-support-copy-replace-for-3-13 branch 4 times, most recently from 828b34c to 3b9768dCompareAdrianAcalaforce-pushed the 1920-support-copy-replace-for-3-13 branch 2 times, most recently from 69cab3c to c68ea9fCompare…) support - Added the __replace__ magic method to BaseContainer, enabling the creation of modified copies of immutable containers in line with Python 3.13's copy.replace() functionality. - Updated documentation to include usage examples and clarify the behavior of the new method. - 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 and its implications for container usage. Closesdry-python#1920.
AdrianAcalaforce-pushed the 1920-support-copy-replace-for-3-13 branch from c68ea9f to 51936c3CompareAdrianAcala commented Apr 19, 2025
@sobolevn , this is ready for your review. Thanks so much! |
2 participants
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.