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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
|
# SPDX-FileCopyrightText: Copyright 2022, Arm Limited and/or its affiliates.
# SPDX-License-Identifier: Apache-2.0
"""Tests for reporting module."""
from typing import List
import pytest
from mlia.core.reporting import BytesCell
from mlia.core.reporting import Cell
from mlia.core.reporting import ClockCell
from mlia.core.reporting import Column
from mlia.core.reporting import CyclesCell
from mlia.core.reporting import Format
from mlia.core.reporting import NestedReport
from mlia.core.reporting import ReportItem
from mlia.core.reporting import SingleRow
from mlia.core.reporting import Table
from mlia.utils.console import remove_ascii_codes
@pytest.mark.parametrize(
"cell, expected_repr",
[
(BytesCell(None), ""),
(BytesCell(0), "0 bytes"),
(BytesCell(1), "1 byte"),
(BytesCell(100000), "100,000 bytes"),
(ClockCell(None), ""),
(ClockCell(0), "0 Hz"),
(ClockCell(1), "1 Hz"),
(ClockCell(100000), "100,000 Hz"),
(CyclesCell(None), ""),
(CyclesCell(0), "0 cycles"),
(CyclesCell(1), "1 cycle"),
(CyclesCell(100000), "100,000 cycles"),
],
)
def test_predefined_cell_types(cell: Cell, expected_repr: str) -> None:
"""Test predefined cell types."""
assert str(cell) == expected_repr
@pytest.mark.parametrize(
"with_notes, expected_text_report",
[
[
True,
"""
Sample table:
┌──────────┬──────────┬──────────┐
│ Header 1 │ Header 2 │ Header 3 │
╞══════════╪══════════╪══════════╡
│ 1 │ 2 │ 3 │
├──────────┼──────────┼──────────┤
│ 4 │ 5 │ 123,123 │
└──────────┴──────────┴──────────┘
Sample notes
""".strip(),
],
[
False,
"""
Sample table:
┌──────────┬──────────┬──────────┐
│ Header 1 │ Header 2 │ Header 3 │
╞══════════╪══════════╪══════════╡
│ 1 │ 2 │ 3 │
├──────────┼──────────┼──────────┤
│ 4 │ 5 │ 123,123 │
└──────────┴──────────┴──────────┘
""".strip(),
],
],
)
def test_table_representation(with_notes: bool, expected_text_report: str) -> None:
"""Test table report representation."""
def sample_table(with_notes: bool) -> Table:
columns = [
Column("Header 1", alias="header1", only_for=["plain_text"]),
Column("Header 2", alias="header2", fmt=Format(wrap_width=5)),
Column("Header 3", alias="header3"),
]
rows = [(1, 2, 3), (4, 5, Cell(123123, fmt=Format(str_fmt="0,d")))]
return Table(
columns,
rows,
name="Sample table",
alias="sample_table",
notes="Sample notes" if with_notes else None,
)
table = sample_table(with_notes)
csv_repr = table.to_csv()
assert csv_repr == [["Header 2", "Header 3"], [2, 3], [5, 123123]]
json_repr = table.to_json()
assert json_repr == {
"sample_table": [
{"header2": 2, "header3": 3},
{"header2": 5, "header3": 123123},
]
}
text_report = remove_ascii_codes(table.to_plain_text())
assert text_report == expected_text_report
def test_csv_nested_table_representation() -> None:
"""Test representation of the nested tables in csv format."""
def sample_table(num_of_cols: int) -> Table:
columns = [
Column("Header 1", alias="header1"),
Column("Header 2", alias="header2"),
]
rows = [
(
1,
Table(
columns=[
Column(f"Nested column {i+1}") for i in range(num_of_cols)
],
rows=[[f"value{i+1}" for i in range(num_of_cols)]],
name="Nested table",
),
)
]
return Table(columns, rows, name="Sample table", alias="sample_table")
assert sample_table(num_of_cols=2).to_csv() == [
["Header 1", "Header 2"],
[1, "value1;value2"],
]
assert sample_table(num_of_cols=1).to_csv() == [
["Header 1", "Header 2"],
[1, "value1"],
]
assert sample_table(num_of_cols=0).to_csv() == [
["Header 1", "Header 2"],
[1, ""],
]
@pytest.mark.parametrize(
"report, expected_plain_text, expected_json_data, expected_csv_data",
[
(
NestedReport(
"Sample report",
"sample_report",
[
ReportItem("Item", "item", "item_value"),
],
),
"""
Sample report:
Item item_value
""".strip(),
{
"sample_report": {"item": "item_value"},
},
[
("item",),
("item_value",),
],
),
(
NestedReport(
"Sample report",
"sample_report",
[
ReportItem(
"Item",
"item",
"item_value",
[ReportItem("Nested item", "nested_item", "nested_item_value")],
),
],
),
"""
Sample report:
Item item_value
Nested item nested_item_value
""".strip(),
{
"sample_report": {
"item": {"nested_item": "nested_item_value"},
},
},
[
("item", "nested_item"),
("item_value", "nested_item_value"),
],
),
(
NestedReport(
"Sample report",
"sample_report",
[
ReportItem(
"Item",
"item",
"item_value",
[ReportItem("Nested item", "nested_item", BytesCell(10))],
),
],
),
"""
Sample report:
Item item_value
Nested item 10 bytes
""".strip(),
{
"sample_report": {
"item": {"nested_item": {"unit": "bytes", "value": 10}},
},
},
[
("item", "nested_item_value", "nested_item_unit"),
("item_value", 10, "bytes"),
],
),
(
NestedReport(
"Sample report",
"sample_report",
[
ReportItem(
"Item",
"item",
"item_value",
[
ReportItem(
"Nested item",
"nested_item",
Cell(
10, fmt=Format(str_fmt=lambda x: f"{x} cell value")
),
)
],
),
],
),
"""
Sample report:
Item item_value
Nested item 10 cell value
""".strip(),
{
"sample_report": {
"item": {"nested_item": 10},
},
},
[
("item", "nested_item"),
("item_value", 10),
],
),
(
NestedReport(
"Sample report",
"sample_report",
[
ReportItem(
"Item",
"item",
"item_value",
[
ReportItem(
"Nested item",
"nested_item",
Cell(
10, fmt=Format(str_fmt=lambda x: f"{x} cell value")
),
)
],
),
],
),
"""
Sample report:
Item item_value
Nested item 10 cell value
""".strip(),
{
"sample_report": {
"item": {"nested_item": 10},
},
},
[
("item", "nested_item"),
("item_value", 10),
],
),
(
NestedReport(
"Sample report",
"sample_report",
[
ReportItem(
"Item",
"item",
"item_value",
[
ReportItem("Nested item", "nested_item", Cell(10)),
],
),
],
),
"""
Sample report:
Item item_value
Nested item 10
""".strip(),
{
"sample_report": {
"item": {"nested_item": 10},
},
},
[
("item", "nested_item"),
("item_value", 10),
],
),
(
NestedReport(
"Sample report",
"sample_report",
[
ReportItem(
"Item",
"item",
"item_value",
[
ReportItem(
"Nested item", "nested_item", Cell(10, fmt=Format())
),
],
),
],
),
"""
Sample report:
Item item_value
Nested item 10
""".strip(),
{
"sample_report": {
"item": {"nested_item": 10},
},
},
[
("item", "nested_item"),
("item_value", 10),
],
),
],
)
def test_nested_report_representation(
report: NestedReport,
expected_plain_text: str,
expected_json_data: dict,
expected_csv_data: List,
) -> None:
"""Test representation of the NestedReport."""
plain_text = report.to_plain_text()
assert plain_text == expected_plain_text
json_data = report.to_json()
assert json_data == expected_json_data
csv_data = report.to_csv()
assert csv_data == expected_csv_data
def test_single_row_representation() -> None:
"""Test representation of the SingleRow."""
single_row = SingleRow(
columns=[
Column("column1", "column1"),
],
rows=[("value1", "value2")],
name="Single row example",
alias="simple_row_example",
)
expected_text = """
Single row example:
column1 value1
""".strip()
assert single_row.to_plain_text() == expected_text
assert single_row.to_csv() == [["column1"], ["value1"]]
assert single_row.to_json() == {"simple_row_example": [{"column1": "value1"}]}
with pytest.raises(Exception, match="Table should have only one row"):
wrong_single_row = SingleRow(
columns=[
Column("column1", "column1"),
],
rows=[
("value1", "value2"),
("value1", "value2"),
],
name="Single row example",
alias="simple_row_example",
)
wrong_single_row.to_plain_text()
|
