ORM: deprecate double underscores in LinkManager contains
#5067
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
sphuber
force-pushed
the
fix/4953/deprecate-double-underscore-contains
branch
from
8766f33
to
6c34e1a
Compare
Codecov Report
@@ Coverage Diff @@
## develop #5067 +/- ##
===========================================
+ Coverage 80.38% 80.39% +0.02%
===========================================
Files 529 529
Lines 36867 36881 +14
===========================================
+ Hits 29632 29647 +15
+ Misses 7235 7234 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
|
Just a small comment: the breaking change was released with v1.6.2 (see "Commits on Apr 26, 2021") so perhaps it would be nice if we could add this to the v1.6.5 release branch you were preparing. Maybe this was your original idea, but since you only mention 2.0 in the OP I just wanted to mention this explicitly. |
ramirezfranciscof
approved these changes
Aug 12, 2021
The use of double underscores in the interface of the `LinkManager` was
recently deprecated for v2.0, however, it unintentionally broke the
`__contains__` operator. Legacy code that was using code like:
if 'some__nested__namespace' in node.inputs
which used to work, will now return false, breaking existing code. The
solution is to override the `__contains__` operator and check for the
presence of a double underscore in the key. If that is the case, now a
deprecation warning is emitted, but the key is split on the double
underscores and the namespaces are used to fetch the intended nested
dictionary before applying the actual contains check on the leaf node.
sphuber
force-pushed
the
fix/4953/deprecate-double-underscore-contains
branch
from
6c34e1a
to
4dd16e9
Compare
|
Yes, this should also go in the backport release. Once merged, I will cherry-pick it. |
sphuber
added a commit
that referenced
this pull request
Aug 12, 2021
The use of double underscores in the interface of the `LinkManager` was
recently deprecated for v2.0, however, it unintentionally broke the
`__contains__` operator. Legacy code that was using code like:
if 'some__nested__namespace' in node.inputs
which used to work, will now return false, breaking existing code. The
solution is to override the `__contains__` operator and check for the
presence of a double underscore in the key. If that is the case, now a
deprecation warning is emitted, but the key is split on the double
underscores and the namespaces are used to fetch the intended nested
dictionary before applying the actual contains check on the leaf node.
Cherry-pick: bf80fde
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 #4953
The use of double underscores in the interface of the
LinkManagerwasrecently deprecated for v2.0, however, it unintentionally broke the
__contains__operator. Legacy code that was using code like:which used to work, will now return false, breaking existing code. The
solution is to override the
__contains__operator and check for thepresence of a double underscore in the key. If that is the case, now a
deprecation warning is emitted, but the key is split on the double
underscores and the namespaces are used to fetch the intended nested
dictionary before applying the actual contains check on the leaf node.