Method walk_nodes

tables/file.py:2264–2306

Recursively iterate over nodes hanging from where. Parameters ---------- where : str or Group, optional If supplied, the iteration starts from (and includes) this group. It can be a path string or a Group instance (see :ref:`GroupClassDesc

(
        self, where: Group | str = "/", classname: str | None = None
    )

        return self.walk_nodes("/")

    def walk_nodes(
        self, where: Group | str = "/", classname: str | None = None
    ) -> Generator[Node]:
        """Recursively iterate over nodes hanging from where.

        Parameters
        ----------
        where : str or Group, optional
            If supplied, the iteration starts from (and includes)
            this group. It can be a path string or a
            Group instance (see :ref:`GroupClassDescr`).
        classname
            If the name of a class derived from
            Node (see :ref:`GroupClassDescr`) is supplied, only instances of
            that class (or subclasses of it) will be returned.

        Notes
        -----
        This version iterates over the leaves in the same group in order
        to avoid having a list referencing to them and thus, preventing
        the LRU cache to remove them after their use.

        Examples
        --------
        ::

            # Recursively print all the nodes hanging from '/detector'.
            print("Nodes hanging from group '/detector':")
            for node in h5file.walk_nodes('/detector', classname='EArray'):
                print(node)

        """
        class_ = get_class_by_name(classname)

        if class_ is Group:  # only groups
            yield from self.walk_groups(where)
        elif class_ is Node:  # all nodes
            yield self.get_node(where)
            for group in self.walk_groups(where):
                yield from self.iter_nodes(group)
        else:  # only nodes of the named type
            for group in self.walk_groups(where):
                yield from self.iter_nodes(group, classname)

    def walk_groups(self, where: Group | str = "/") -> Generator[Group]:
        """Recursively iterate over groups (not leaves) hanging from where.