Skip to content

Always add size summary report to sketches report #128

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Mar 31, 2023
Merged

Always add size summary report to sketches report #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e96af16
Use unique memory maximum value in test input
per1234 Mar 26, 2023
f7b700d
Always add size summary report to sketches report
per1234 Mar 26, 2023
935f8a9
Increase test coverage of `get_sizes_from_output` function
per1234 Mar 26, 2023
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
130 changes: 47 additions & 83 deletions compilesketches/compilesketches.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1300,55 +1300,52 @@ def get_sizes_summary_report(self, sketch_report_list):
sizes_summary_report = []
for sketch_report in sketch_report_list:
for size_report in sketch_report[self.ReportKeys.sizes]:
if self.ReportKeys.delta in size_report:
# Determine the sizes_summary_report index for this memory type
size_summary_report_index_list = [
index
for index, size_summary in enumerate(sizes_summary_report)
if size_summary.get(self.ReportKeys.name) == size_report[self.ReportKeys.name]
]
if not size_summary_report_index_list:
# There is no existing entry in the summary list for this memory type, so create one
sizes_summary_report.append(
{
self.ReportKeys.name: size_report[self.ReportKeys.name],
self.ReportKeys.maximum: size_report[self.ReportKeys.maximum],
self.ReportKeys.delta: {
self.ReportKeys.absolute: {
self.ReportKeys.minimum: size_report[self.ReportKeys.delta][
self.ReportKeys.absolute
],
self.ReportKeys.maximum: size_report[self.ReportKeys.delta][
self.ReportKeys.absolute
],
},
self.ReportKeys.relative: {
self.ReportKeys.minimum: size_report[self.ReportKeys.delta][
self.ReportKeys.relative
],
self.ReportKeys.maximum: size_report[self.ReportKeys.delta][
self.ReportKeys.relative
],
},
},
}
)
else:
size_summary_report_index = size_summary_report_index_list[0]
# Determine the sizes_summary_report index for this memory type
size_summary_report_index_list = [
index
for index, size_summary in enumerate(sizes_summary_report)
if size_summary.get(self.ReportKeys.name) == size_report[self.ReportKeys.name]
]
if not size_summary_report_index_list:
# There is no existing entry in the summary list for this memory type, so create one
sizes_summary_report.append({self.ReportKeys.name: size_report[self.ReportKeys.name]})
size_summary_report_index = len(sizes_summary_report) - 1
else:
size_summary_report_index = size_summary_report_index_list[0]

if (
sizes_summary_report[size_summary_report_index][self.ReportKeys.maximum]
== self.not_applicable_indicator
):
sizes_summary_report[size_summary_report_index][self.ReportKeys.maximum] = size_report[
self.ReportKeys.maximum
]
if (
self.ReportKeys.maximum not in sizes_summary_report[size_summary_report_index]
or sizes_summary_report[size_summary_report_index][self.ReportKeys.maximum]
== self.not_applicable_indicator
):
sizes_summary_report[size_summary_report_index][self.ReportKeys.maximum] = size_report[
self.ReportKeys.maximum
]

if self.ReportKeys.delta in size_report:
if (
self.ReportKeys.delta not in sizes_summary_report[size_summary_report_index]
or sizes_summary_report[size_summary_report_index][self.ReportKeys.delta][
self.ReportKeys.absolute
][self.ReportKeys.minimum]
== self.not_applicable_indicator
):
sizes_summary_report[size_summary_report_index][self.ReportKeys.delta] = {
self.ReportKeys.absolute: {
self.ReportKeys.minimum: size_report[self.ReportKeys.delta][self.ReportKeys.absolute],
self.ReportKeys.maximum: size_report[self.ReportKeys.delta][self.ReportKeys.absolute],
},
self.ReportKeys.relative: {
self.ReportKeys.minimum: size_report[self.ReportKeys.delta][self.ReportKeys.relative],
self.ReportKeys.maximum: size_report[self.ReportKeys.delta][self.ReportKeys.relative],
},
}
elif size_report[self.ReportKeys.delta][self.ReportKeys.absolute] != self.not_applicable_indicator:
if (
sizes_summary_report[size_summary_report_index][self.ReportKeys.delta][
size_report[self.ReportKeys.delta][self.ReportKeys.absolute]
< sizes_summary_report[size_summary_report_index][self.ReportKeys.delta][
self.ReportKeys.absolute
][self.ReportKeys.minimum]
== self.not_applicable_indicator
):
sizes_summary_report[size_summary_report_index][self.ReportKeys.delta][
self.ReportKeys.absolute
Expand All @@ -1358,6 +1355,12 @@ def get_sizes_summary_report(self, sketch_report_list):
self.ReportKeys.relative
][self.ReportKeys.minimum] = size_report[self.ReportKeys.delta][self.ReportKeys.relative]

if (
size_report[self.ReportKeys.delta][self.ReportKeys.absolute]
> sizes_summary_report[size_summary_report_index][self.ReportKeys.delta][
self.ReportKeys.absolute
][self.ReportKeys.maximum]
):
sizes_summary_report[size_summary_report_index][self.ReportKeys.delta][
self.ReportKeys.absolute
][self.ReportKeys.maximum] = size_report[self.ReportKeys.delta][self.ReportKeys.absolute]
Expand All @@ -1366,45 +1369,6 @@ def get_sizes_summary_report(self, sketch_report_list):
self.ReportKeys.relative
][self.ReportKeys.maximum] = size_report[self.ReportKeys.delta][self.ReportKeys.relative]

elif size_report[self.ReportKeys.delta][self.ReportKeys.absolute] != (
self.not_applicable_indicator
):
if (
size_report[self.ReportKeys.delta][self.ReportKeys.absolute]
< sizes_summary_report[size_summary_report_index][self.ReportKeys.delta][
self.ReportKeys.absolute
][self.ReportKeys.minimum]
):
sizes_summary_report[size_summary_report_index][self.ReportKeys.delta][
self.ReportKeys.absolute
][self.ReportKeys.minimum] = size_report[self.ReportKeys.delta][
self.ReportKeys.absolute
]

sizes_summary_report[size_summary_report_index][self.ReportKeys.delta][
self.ReportKeys.relative
][self.ReportKeys.minimum] = size_report[self.ReportKeys.delta][
self.ReportKeys.relative
]

if (
size_report[self.ReportKeys.delta][self.ReportKeys.absolute]
> sizes_summary_report[size_summary_report_index][self.ReportKeys.delta][
self.ReportKeys.absolute
][self.ReportKeys.maximum]
):
sizes_summary_report[size_summary_report_index][self.ReportKeys.delta][
self.ReportKeys.absolute
][self.ReportKeys.maximum] = size_report[self.ReportKeys.delta][
self.ReportKeys.absolute
]

sizes_summary_report[size_summary_report_index][self.ReportKeys.delta][
self.ReportKeys.relative
][self.ReportKeys.maximum] = size_report[self.ReportKeys.delta][
self.ReportKeys.relative
]

return sizes_summary_report

def get_warnings_summary_report(self, sketch_report_list):
Expand Down
35 changes: 33 additions & 2 deletions compilesketches/tests/test_compilesketches.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1803,6 +1803,28 @@ def checkout(self):
" ^~~~~\n"
"Sketch uses {flash} bytes (4%) of program storage space. Maximum is {maximum_flash} bytes.\n",
12636,
25272,
50.0,
get_compilesketches_object().not_applicable_indicator,
get_compilesketches_object().not_applicable_indicator,
get_compilesketches_object().not_applicable_indicator,
),
(
True,
"/home/per/Arduino/libraries/Servo/src/samd/Servo.cpp: In function 'void _initISR(Tc*, uint8_t, uint32_t, IRQn_Ty"
"pe, uint8_t, uint8_t)':\n"
"/home/per/Arduino/libraries/Servo/src/samd/Servo.cpp:120:56: warning: unused parameter 'id' [-Wunused-parameter]"
"\n"
" static void _initISR(Tc *tc, uint8_t channel, uint32_t id, IRQn_Type irqn, uint8_t gcmForTimer, uint8_t intEnab"
" leBit)\n"
" ^~\n"
"/home/per/Arduino/libraries/Servo/src/samd/Servo.cpp: In function 'void finISR(timer16_Sequence_t)':\n"
"/home/per/Arduino/libraries/Servo/src/samd/Servo.cpp:174:39: warning: unused parameter 'timer' [-Wunused-paramet"
"er]\n"
" static void finISR(timer16_Sequence_t timer)\n"
" ^~~~~\n"
"Sketch uses {flash} bytes (4%) of program storage space.\n",
12636,
get_compilesketches_object().not_applicable_indicator,
get_compilesketches_object().not_applicable_indicator,
get_compilesketches_object().not_applicable_indicator,
Expand Down Expand Up @@ -2621,7 +2643,7 @@ def test_get_sizes_summary_report():
},
{
compilesketches.CompileSketches.ReportKeys.name: "Bar memory type",
compilesketches.CompileSketches.ReportKeys.maximum: 111,
compilesketches.CompileSketches.ReportKeys.maximum: 222,
compilesketches.CompileSketches.ReportKeys.current: {
compilesketches.CompileSketches.ReportKeys.absolute: 33,
compilesketches.CompileSketches.ReportKeys.relative: 3.342,
Expand All @@ -2631,7 +2653,16 @@ def test_get_sizes_summary_report():
},
]

expected_sizes_summary_report = []
expected_sizes_summary_report = [
{
compilesketches.CompileSketches.ReportKeys.name: "Foo memory type",
compilesketches.CompileSketches.ReportKeys.maximum: 111,
},
{
compilesketches.CompileSketches.ReportKeys.name: "Bar memory type",
compilesketches.CompileSketches.ReportKeys.maximum: 222,
},
]

assert compile_sketches.get_sizes_summary_report(sketch_report_list=sketch_report_list) == (
expected_sizes_summary_report
Expand Down