Implement next and iter for the Node.open deprecation wrapper
#4399
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
Codecov Report
@@ Coverage Diff @@
## develop #4399 +/- ##
===========================================
+ Coverage 79.22% 79.22% +0.01%
===========================================
Files 475 475
Lines 34822 34826 +4
===========================================
+ Hits 27583 27588 +5
+ Misses 7239 7238 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
greschd
previously approved these changes
Sep 25, 2020
The return value of `Node.open` was wrapped in `WarnWhenNotEntered` in `aiida-core==1.4.0` in order to warn users that use the method without a context manager, which will start to raise in v2.0. Unfortunately, the raising came a little early as the wrapper does not implement the `__iter__` and `__next__` methods, which can be called by clients. An example is `numpy.getfromtxt` which will notice the return value of `Node.open` is filelike and so will wrap it in `iter`. Without the current fix, this raises a `TypeError`. The proper fix would be to forward all magic methods to the wrapped filelike object, but it is not clear how to do this.
sphuber
force-pushed
the
fix/4396/node-open-deprecation-wrapper
branch
from
378a3f9 to
1b97877
Compare
Done |
|
@greschd I added a test, this is ready for second review |
greschd
approved these changes
Sep 25, 2020
sphuber
added a commit
to sphuber/aiida-core
that referenced
this pull request
Sep 25, 2020
…iidateam#4399) The return value of `Node.open` was wrapped in `WarnWhenNotEntered` in `aiida-core==1.4.0` in order to warn users that use the method without a context manager, which will start to raise in v2.0. Unfortunately, the raising came a little early as the wrapper does not implement the `__iter__` and `__next__` methods, which can be called by clients. An example is `numpy.getfromtxt` which will notice the return value of `Node.open` is filelike and so will wrap it in `iter`. Without the current fix, this raises a `TypeError`. The proper fix would be to forward all magic methods to the wrapped filelike object, but it is not clear how to do this.
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.
Fixes #4396
The return value of
Node.openwas wrapped inWarnWhenNotEnteredinaiida-core==1.4.0in order to warn users that use the method without acontext manager, which will start to raise in v2.0. Unfortunately, the
raising came a little early as the wrapper does not implement the
__iter__and__next__methods, which can be called by clients.An example is
numpy.genfromtxtwhich will notice the return value ofNode.openis filelike and so will wrap it initer. Without thecurrent fix, this raises a
TypeError. The proper fix would be toforward all magic methods to the wrapped filelike object, but it is not
clear how to do this.