Change 'ancestor_of'/'descendant_of' to 'with_descendants'/'with_ancestors' #2278
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
aiida/orm/querybuilder.py
Outdated
| @@ -1659,7 +1661,7 @@ def _build(self): | |||
| isouterjoin = verticespec.get('outerjoin') | |||
| edge_tag = verticespec['edge_tag'] | |||
|
|
|||
| if verticespec['joining_keyword'] in ('descendant_of', 'ancestor_of'): | |||
| if verticespec['joining_keyword'] in ('with_ancestors', 'with_descendants'): | |||
There was a problem hiding this comment.
If the user uses the old 'descendant_of', will this still work? Maybe we should keep all four options for now?
There was a problem hiding this comment.
Yes, well spotted. Put these back in.
aiida/orm/querybuilder.py
Outdated
| @@ -1262,7 +1262,7 @@ def _join_descendants_recursive(self, joined_entity, entity_to_join, isouterjoin | |||
| """ | |||
|
|
|||
| self._check_dbentities((joined_entity, self._impl.Node), (entity_to_join, self._impl.Node), | |||
| 'descendant_of_beta') | |||
| 'with_ancestors_beta') | |||
There was a problem hiding this comment.
Is this _beta version still implemented? Probably @lekah can answer this
There was a problem hiding this comment.
No, what we're doing now (transitive closure on the fly) used to be called _beta. This string passed is just for the exception, and can be changed without a problem (i.e. remove _beta in the string).
My suggest: without a new issue within this pull request, if noone objects.
There was a problem hiding this comment.
Made these changes.
- Deprecate ancestor_of and descendant_of - Replace all occurances of ancestor_of with with_descendants - Replace all occurances of descendant_of with with_ancestors - Update docs with this convention
- Remove _beta versions of ancestor_of and descendant_of joins - Add ancestor_of and descendant_of back in to check for valid join keywords.
ConradJohnston
force-pushed
the
fix_2209_replace_ancestor_of
branch
from
ca412b7 to
8758769
Compare
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 #2209 .
Deprecates the Querybuilder 'ancestor_of'/'descendant of' join type specifications and replaces them with 'with_descendants'/'with_ancestors' respectively. All deprecated uses are updated and the docs changed to reflect this new convention.