1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
import unittest
from typing import List
from examples.jsonParser import jsonObject
from examples.simpleBool import boolExpr
from examples.simpleSQL import simpleSQL
from examples.mozillaCalendarParser import calendars
from pyparsing.diagram import to_railroad, railroad_to_html, NamedDiagram
import pyparsing as pp
import tempfile
import os
import sys
class TestRailroadDiagrams(unittest.TestCase):
def railroad_debug(self) -> bool:
"""
Returns True if we're in debug mode (determined by either setting
environment var, or running in a debugger which sets sys.settrace)
"""
return os.environ.get("RAILROAD_DEBUG", False) or sys.gettrace()
def get_temp(self):
"""
Returns an appropriate temporary file for writing a railroad diagram
"""
return tempfile.NamedTemporaryFile(
dir=".",
delete=not self.railroad_debug(),
mode="w",
encoding="utf-8",
suffix=".html",
)
def generate_railroad(
self, expr: pp.ParserElement, label: str, show_results_names: bool = False
) -> List[NamedDiagram]:
"""
Generate an intermediate list of NamedDiagrams from a pyparsing expression.
"""
with self.get_temp() as temp:
railroad = to_railroad(expr, show_results_names=show_results_names)
temp.write(railroad_to_html(railroad))
if self.railroad_debug():
print(f"{label}: {temp.name}")
return railroad
def test_bool_expr(self):
railroad = self.generate_railroad(boolExpr, "boolExpr")
assert len(railroad) == 5
railroad = self.generate_railroad(boolExpr, "boolExpr", show_results_names=True)
assert len(railroad) == 5
def test_json(self):
railroad = self.generate_railroad(jsonObject, "jsonObject")
assert len(railroad) == 9
railroad = self.generate_railroad(jsonObject, "jsonObject", show_results_names=True)
assert len(railroad) == 9
def test_sql(self):
railroad = self.generate_railroad(simpleSQL, "simpleSQL")
assert len(railroad) == 18
railroad = self.generate_railroad(simpleSQL, "simpleSQL", show_results_names=True)
assert len(railroad) == 18
def test_calendars(self):
railroad = self.generate_railroad(calendars, "calendars")
assert len(railroad) == 13
railroad = self.generate_railroad(calendars, "calendars", show_results_names=True)
assert len(railroad) == 13
def test_nested_forward_with_inner_and_outer_names(self):
outer = pp.Forward().setName("outer")
inner = pp.Word(pp.alphas)[...].setName("inner")
outer <<= inner
railroad = self.generate_railroad(outer, "inner_outer_names")
assert len(railroad) == 2
railroad = self.generate_railroad(outer, "inner_outer_names", show_results_names=True)
assert len(railroad) == 2
def test_nested_forward_with_inner_name_only(self):
outer = pp.Forward()
inner = pp.Word(pp.alphas)[...].setName("inner")
outer <<= inner
railroad = self.generate_railroad(outer, "inner_only")
assert len(railroad) == 2
railroad = self.generate_railroad(outer, "inner_only", show_results_names=True)
assert len(railroad) == 2
def test_each_grammar(self):
grammar = pp.Each(
[
pp.Word(pp.nums),
pp.Word(pp.alphas),
pp.pyparsing_common.uuid,
]
).setName("int-word-uuid in any order")
railroad = self.generate_railroad(grammar, "each_expression")
assert len(railroad) == 2
railroad = self.generate_railroad(grammar, "each_expression", show_results_names=True)
assert len(railroad) == 2
def test_none_name(self):
grammar = pp.Or(["foo", "bar"])
railroad = to_railroad(grammar)
assert len(railroad) == 1
assert railroad[0].name is not None
def test_none_name2(self):
grammar = pp.Or(["foo", "bar"]) + pp.Word(pp.nums).setName("integer")
railroad = to_railroad(grammar)
assert len(railroad) == 2
assert railroad[0].name is not None
railroad = to_railroad(grammar, show_results_names=True)
assert len(railroad) == 2
def test_complete_combine_element(self):
ints = pp.Word(pp.nums)
grammar = pp.Combine(
ints('hours') + pp.Literal(":") + ints('minutes') + pp.Literal(":") + ints('seconds')
)
railroad = to_railroad(grammar)
assert len(railroad) == 1
railroad = to_railroad(grammar, show_results_names=True)
assert len(railroad) == 1
|
