Method get_node

tables/file.py:1746–1817

Get the node under where with the given name. Parameters ---------- where : str or Node This can be a path string leading to a node or a Node instance (see :ref:`NodeClassDescr`). If no name is specified, that node is returned.

(
        self,
        where: Node | str,
        name: str | None = None,
        classname: str | None = None,
    )

        return node

    def get_node(
        self,
        where: Node | str,
        name: str | None = None,
        classname: str | None = None,
    ) -> Node:
        """Get the node under where with the given name.

        Parameters
        ----------
        where : str or Node
            This can be a path string leading to a node or a Node instance (see
            :ref:`NodeClassDescr`). If no name is specified, that node is
            returned.

            .. note::

                If where is a Node instance from a different file than the one
                on which this function is called, the returned node will also
                be from that other file.

        name : str, optional
            If a name is specified, this must be a string with the name of
            a node under where.  In this case the where argument can only
            lead to a Group (see :ref:`GroupClassDescr`) instance (else a
            TypeError is raised). The node called name under the group
            where is returned.
        classname : str, optional
            If the classname argument is specified, it must be the name of
            a class derived from Node (e.g. Table). If the node is found but it
            is not an instance of that class, a NoSuchNodeError is also raised.

        Notes
        -----
        If the node to be returned does not exist, a NoSuchNodeError is
        raised. Please note that hidden nodes are also considered.

        """
        self._check_open()

        if isinstance(where, Node):
            where._g_check_open()

            basepath = where._v_pathname
            nodepath = join_path(basepath, name or "") or "/"
            node = where._v_file._get_node(nodepath)
        elif isinstance(where, (str, np.str_)):
            if not where.startswith("/"):
                raise NameError("``where`` must start with a slash ('/')")

            basepath = where
            nodepath = join_path(basepath, name or "") or "/"
            node = self._get_node(nodepath)
        else:
            raise TypeError(f"``where`` must be a string or a node: {where!r}")

        # Finally, check whether the desired node is an instance
        # of the expected class.