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

Add Tree.find_token() method #1467

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
*.pyc
*.pyo
/.tox
/lark.egg-info/**
/lark_parser.egg-info/**
tags
.vscode
Expand Down
10 changes: 10 additions & 0 deletions lark/tree.py
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,16 @@ def find_data(self, data: str) -> 'Iterator[Tree[_Leaf_T]]':

###}

def find_token(self, token_type: str) -> Iterator[_Leaf_T]:
"""Returns all tokens whose type equals the given token_type.

This is a recursive function that will find tokens in all the subtrees.

Example:
>>> term_tokens = tree.find_token('TERM')
"""
return self.scan_values(lambda v: not isinstance(v, Tree) and v.type == token_type)

def expand_kids_by_data(self, *data_values):
"""Expand (inline) children with any of the given data values. Returns True if anything changed"""
changed = False
Expand Down
10 changes: 10 additions & 0 deletions tests/test_trees.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@
class TestTrees(TestCase):
def setUp(self):
self.tree1 = Tree('a', [Tree(x, y) for x, y in zip('bcd', 'xyz')])
self.tree2 = Tree('a', [
Tree('b', [Token('T', 'x')]),
Tree('c', [Token('T', 'y')]),
Tree('d', [Tree('z', [Token('T', 'zz')])]),
])

def test_eq(self):
assert self.tree1 == self.tree1
Expand Down Expand Up @@ -48,6 +53,11 @@ def test_iter_subtrees_topdown(self):
nodes = list(self.tree1.iter_subtrees_topdown())
self.assertEqual(nodes, expected)

def test_find_token(self):
expected = [Token('T', 'x'), Token('T', 'y'), Token('T', 'zz')]
tokens = list(self.tree2.find_token('T'))
self.assertEqual(tokens, expected)

def test_visitor(self):
class Visitor1(Visitor):
def __init__(self):
Expand Down