diff --git a/doc/whats-new.rst b/doc/whats-new.rst index e421eeb3a7f..41b39bf2b1a 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -113,6 +113,9 @@ Internal Changes - Migrates ``datatree`` functionality into ``xarray/core``. (:pull: `8789`) By `Owen Littlejohns `_, `Matt Savoie `_ and `Tom Nicholas `_. +- Migrates ``iterator`` functionality into ``xarray/core`` (:pull: `8879`) + By `Owen Littlejohns `_, `Matt Savoie + `_ and `Tom Nicholas `_. .. _whats-new.2024.02.0: diff --git a/licenses/ANYTREE_LICENSE b/licenses/ANYTREE_LICENSE new file mode 100644 index 00000000000..8dada3edaf5 --- /dev/null +++ b/licenses/ANYTREE_LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/xarray/core/iterators.py b/xarray/core/iterators.py new file mode 100644 index 00000000000..5c0c0f652e8 --- /dev/null +++ b/xarray/core/iterators.py @@ -0,0 +1,131 @@ +from __future__ import annotations + +from collections import abc +from collections.abc import Iterator +from typing import Callable + +from xarray.core.treenode import Tree + +"""These iterators are copied from anytree.iterators, with minor modifications.""" + + +class LevelOrderIter(abc.Iterator): + """Iterate over tree applying level-order strategy starting at `node`. + This is the iterator used by `DataTree` to traverse nodes. + + Parameters + ---------- + node : Tree + Node in a tree to begin iteration at. + filter_ : Callable, optional + Function called with every `node` as argument, `node` is returned if `True`. + Default is to iterate through all ``node`` objects in the tree. + stop : Callable, optional + Function that will cause iteration to stop if ``stop`` returns ``True`` + for ``node``. + maxlevel : int, optional + Maximum level to descend in the node hierarchy. + + Examples + -------- + >>> from xarray.core.datatree import DataTree + >>> from xarray.core.iterators import LevelOrderIter + >>> f = DataTree(name="f") + >>> b = DataTree(name="b", parent=f) + >>> a = DataTree(name="a", parent=b) + >>> d = DataTree(name="d", parent=b) + >>> c = DataTree(name="c", parent=d) + >>> e = DataTree(name="e", parent=d) + >>> g = DataTree(name="g", parent=f) + >>> i = DataTree(name="i", parent=g) + >>> h = DataTree(name="h", parent=i) + >>> print(f) + DataTree('f', parent=None) + ├── DataTree('b') + │ ├── DataTree('a') + │ └── DataTree('d') + │ ├── DataTree('c') + │ └── DataTree('e') + └── DataTree('g') + └── DataTree('i') + └── DataTree('h') + >>> [node.name for node in LevelOrderIter(f)] + ['f', 'b', 'g', 'a', 'd', 'i', 'c', 'e', 'h'] + >>> [node.name for node in LevelOrderIter(f, maxlevel=3)] + ['f', 'b', 'g', 'a', 'd', 'i'] + >>> [ + ... node.name + ... for node in LevelOrderIter(f, filter_=lambda n: n.name not in ("e", "g")) + ... ] + ['f', 'b', 'a', 'd', 'i', 'c', 'h'] + >>> [node.name for node in LevelOrderIter(f, stop=lambda n: n.name == "d")] + ['f', 'b', 'g', 'a', 'i', 'h'] + """ + + def __init__( + self, + node: Tree, + filter_: Callable | None = None, + stop: Callable | None = None, + maxlevel: int | None = None, + ): + self.node = node + self.filter_ = filter_ + self.stop = stop + self.maxlevel = maxlevel + self.__iter = None + + def __init(self): + node = self.node + maxlevel = self.maxlevel + filter_ = self.filter_ or LevelOrderIter.__default_filter + stop = self.stop or LevelOrderIter.__default_stop + children = ( + [] + if LevelOrderIter._abort_at_level(1, maxlevel) + else LevelOrderIter._get_children([node], stop) + ) + return self._iter(children, filter_, stop, maxlevel) + + @staticmethod + def __default_filter(node: Tree) -> bool: + return True + + @staticmethod + def __default_stop(node: Tree) -> bool: + return False + + def __iter__(self) -> Iterator[Tree]: + return self + + def __next__(self) -> Iterator[Tree]: + if self.__iter is None: + self.__iter = self.__init() + item = next(self.__iter) # type: ignore[call-overload] + return item + + @staticmethod + def _abort_at_level(level: int, maxlevel: int | None) -> bool: + return maxlevel is not None and level > maxlevel + + @staticmethod + def _get_children(children: list[Tree], stop: Callable) -> list[Tree]: + return [child for child in children if not stop(child)] + + @staticmethod + def _iter( + children: list[Tree], filter_: Callable, stop: Callable, maxlevel: int | None + ) -> Iterator[Tree]: + level = 1 + while children: + next_children = [] + for child in children: + if filter_(child): + yield child + next_children += LevelOrderIter._get_children( + list(child.children.values()), stop + ) + children = next_children + level += 1 + if LevelOrderIter._abort_at_level(level, maxlevel): + break diff --git a/xarray/core/treenode.py b/xarray/core/treenode.py index 8cee3f69d70..6f51e1ffa38 100644 --- a/xarray/core/treenode.py +++ b/xarray/core/treenode.py @@ -333,9 +333,9 @@ def subtree(self: Tree) -> Iterator[Tree]: -------- DataTree.descendants """ - from xarray.datatree_.datatree import iterators + from xarray.core.iterators import LevelOrderIter - return iterators.PreOrderIter(self) + return LevelOrderIter(self) @property def descendants(self: Tree) -> tuple[Tree, ...]: diff --git a/xarray/datatree_/datatree/iterators.py b/xarray/datatree_/datatree/iterators.py deleted file mode 100644 index 68e75c4f612..00000000000 --- a/xarray/datatree_/datatree/iterators.py +++ /dev/null @@ -1,116 +0,0 @@ -from abc import abstractmethod -from collections import abc -from typing import Callable, Iterator, List, Optional - -from xarray.core.treenode import Tree - -"""These iterators are copied from anytree.iterators, with minor modifications.""" - - -class AbstractIter(abc.Iterator): - def __init__( - self, - node: Tree, - filter_: Optional[Callable] = None, - stop: Optional[Callable] = None, - maxlevel: Optional[int] = None, - ): - """ - Iterate over tree starting at `node`. - Base class for all iterators. - Keyword Args: - filter_: function called with every `node` as argument, `node` is returned if `True`. - stop: stop iteration at `node` if `stop` function returns `True` for `node`. - maxlevel (int): maximum descending in the node hierarchy. - """ - self.node = node - self.filter_ = filter_ - self.stop = stop - self.maxlevel = maxlevel - self.__iter = None - - def __init(self): - node = self.node - maxlevel = self.maxlevel - filter_ = self.filter_ or AbstractIter.__default_filter - stop = self.stop or AbstractIter.__default_stop - children = ( - [] - if AbstractIter._abort_at_level(1, maxlevel) - else AbstractIter._get_children([node], stop) - ) - return self._iter(children, filter_, stop, maxlevel) - - @staticmethod - def __default_filter(node): - return True - - @staticmethod - def __default_stop(node): - return False - - def __iter__(self) -> Iterator[Tree]: - return self - - def __next__(self) -> Iterator[Tree]: - if self.__iter is None: - self.__iter = self.__init() - item = next(self.__iter) # type: ignore[call-overload] - return item - - @staticmethod - @abstractmethod - def _iter(children: List[Tree], filter_, stop, maxlevel) -> Iterator[Tree]: - ... - - @staticmethod - def _abort_at_level(level, maxlevel): - return maxlevel is not None and level > maxlevel - - @staticmethod - def _get_children(children: List[Tree], stop) -> List[Tree]: - return [child for child in children if not stop(child)] - - -class PreOrderIter(AbstractIter): - """ - Iterate over tree applying pre-order strategy starting at `node`. - Start at root and go-down until reaching a leaf node. - Step upwards then, and search for the next leafs. - """ - - @staticmethod - def _iter(children, filter_, stop, maxlevel): - for child_ in children: - if stop(child_): - continue - if filter_(child_): - yield child_ - if not AbstractIter._abort_at_level(2, maxlevel): - descendantmaxlevel = maxlevel - 1 if maxlevel else None - for descendant_ in PreOrderIter._iter( - list(child_.children.values()), filter_, stop, descendantmaxlevel - ): - yield descendant_ - - -class LevelOrderIter(AbstractIter): - """ - Iterate over tree applying level-order strategy starting at `node`. - """ - - @staticmethod - def _iter(children, filter_, stop, maxlevel): - level = 1 - while children: - next_children = [] - for child in children: - if filter_(child): - yield child - next_children += AbstractIter._get_children( - list(child.children.values()), stop - ) - children = next_children - level += 1 - if AbstractIter._abort_at_level(level, maxlevel): - break diff --git a/xarray/datatree_/datatree/mapping.py b/xarray/datatree_/datatree/mapping.py index 7742ece9738..9546905e1ac 100644 --- a/xarray/datatree_/datatree/mapping.py +++ b/xarray/datatree_/datatree/mapping.py @@ -8,7 +8,7 @@ from xarray import DataArray, Dataset -from .iterators import LevelOrderIter +from xarray.core.iterators import LevelOrderIter from xarray.core.treenode import NodePath, TreeNode if TYPE_CHECKING: diff --git a/xarray/tests/test_datatree.py b/xarray/tests/test_datatree.py index c7359b3929e..3de2fa62dc6 100644 --- a/xarray/tests/test_datatree.py +++ b/xarray/tests/test_datatree.py @@ -494,11 +494,11 @@ def test_full(self, simple_datatree): assert paths == [ "/", "/set1", + "/set2", + "/set3", "/set1/set1", "/set1/set2", - "/set2", "/set2/set1", - "/set3", ] def test_datatree_values(self): diff --git a/xarray/tests/test_treenode.py b/xarray/tests/test_treenode.py index b0e737bd317..a7de2e39af6 100644 --- a/xarray/tests/test_treenode.py +++ b/xarray/tests/test_treenode.py @@ -5,8 +5,8 @@ import pytest +from xarray.core.iterators import LevelOrderIter from xarray.core.treenode import InvalidTreeError, NamedNode, NodePath, TreeNode -from xarray.datatree_.datatree.iterators import LevelOrderIter, PreOrderIter class TestFamilyTree: @@ -259,23 +259,6 @@ def create_test_tree() -> tuple[NamedNode, NamedNode]: class TestIterators: - def test_preorderiter(self): - root, _ = create_test_tree() - result: list[str | None] = [ - node.name for node in cast(Iterator[NamedNode], PreOrderIter(root)) - ] - expected = [ - "a", - "b", - "d", - "e", - "f", - "g", - "c", - "h", - "i", - ] - assert result == expected def test_levelorderiter(self): root, _ = create_test_tree() @@ -321,12 +304,12 @@ def test_subtree(self): expected = [ "a", "b", + "c", "d", "e", + "h", "f", "g", - "c", - "h", "i", ] for node, expected_name in zip(subtree, expected): @@ -337,12 +320,12 @@ def test_descendants(self): descendants = root.descendants expected = [ "b", + "c", "d", "e", + "h", "f", "g", - "c", - "h", "i", ] for node, expected_name in zip(descendants, expected):