Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added function to tree widget to find a node by the data field #5362

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions src/textual/widgets/_tree.py
Original file line number Diff line number Diff line change
Expand Up @@ -1046,6 +1046,30 @@ def get_node_by_id(self, node_id: NodeID) -> TreeNode[TreeDataType]:
except KeyError:
raise UnknownNodeID(f"Unknown NodeID ({node_id}) in tree") from None

def get_node_with_data(self, value: str | int, *keys) -> TreeNode[TreeDataType] | None:
"""Returns the first node that got a matching value in the json data field
under the chain of *keys given.

usage example: Tree.get_node_with_data(42, 'database', 'id')
Args:
value: str|int of the desired data in the data json
*keys: chain of keys to the nested value

Returns:
The first Node with the desired value or None
"""
for treeline in self._tree_lines:
if treeline.node.data:
data = treeline.node.data
try:
for key in keys:
data = data[key]
if data == value:
return treeline.node
except(KeyError, TypeError):
continue
return None # if nothing was found

def validate_cursor_line(self, value: int) -> int:
"""Prevent cursor line from going outside of range.

Expand Down