Add JSON as a format option for `targets` command in `build_examples.py` #25810

nekleo · 2023-03-23T22:55:01Z

The targets command outputs the targets that are available for the build and gen commands in a string format that is easy to read but hard to parse. This change adds a option for the targets command to output JSON so that the available targets can be more easily parsed. To do this, ToDict methods were added to BuildTarget and TargetPart classes. When the --format json option is used with the targets command build_examples.py calls the ToDict method of each BuildTarget object and outputs to stdout a list of Dicts in JSON, one for each BuildTarget.

The `targets` command outputs the targets that are available for the `build` and `gen` commands in a string format that is easy to read but hard to parse. This change adds a option for the `targets` command to output JSON so that the available targets can be more easily parsed. To do this, ToDict methods were added to BuildTarget and TargetPart classes. When the `--format json` option is used with the `targets` command `build_examples.py` calls the ToDict method of each BuildTarget object and outputs to stdout a list of Dicts in JSON, one for each BuildTarget.

CLAassistant · 2023-03-23T22:55:07Z

All committers have signed the CLA.

github-actions · 2023-03-23T23:17:10Z

PR #25810: Size comparison from a4a407b to ba31e34

Full report (1 build for cc32xx)

platform	target	config	section	`a4a407b`	`ba31e34`
cc32xx	lock	CC3235SF_LAUNCHXL		0	0
			(read only)	645825	645825
			(read/write)	203848	203848
			.ARM.attributes	44	44
			.ARM.exidx	8	8
			.bss	197248	197248
			.comment	194	194
			.data	1480	1480
			.debug_abbrev	930266	930266
			.debug_aranges	87376	87376
			.debug_frame	300288	300288
			.debug_info	20229260	20229260
			.debug_line	`2661728`	`2661728`
			.debug_loc	2806516	2806516
			.debug_ranges	283400	283400
			.debug_str	`3028246`	`3028246`
			.ramVecs	780	780
			.resetVecs	64	64
			.rodata	105993	105993
			.shstrtab	232	232
			.stab	204	204
			.stabstr	441	441
			.stack	2048	2048
			.strtab	380469	380469
			.symtab	257408	257408
			.text	537712	537712

github-actions · 2023-03-24T00:25:38Z

PR #25810: Size comparison from a4a407b to 7ab15e0

Full report (1 build for cc32xx)

platform	target	config	section	`a4a407b`	`7ab15e0`
cc32xx	lock	CC3235SF_LAUNCHXL		0	0
			(read only)	645825	645825
			(read/write)	203848	203848
			.ARM.attributes	44	44
			.ARM.exidx	8	8
			.bss	197248	197248
			.comment	194	194
			.data	1480	1480
			.debug_abbrev	930266	930266
			.debug_aranges	87376	87376
			.debug_frame	300288	300288
			.debug_info	20229260	20229260
			.debug_line	`2661728`	`2661728`
			.debug_loc	2806516	2806516
			.debug_ranges	283400	283400
			.debug_str	`3028246`	`3028246`
			.ramVecs	780	780
			.resetVecs	64	64
			.rodata	105993	105993
			.shstrtab	232	232
			.stab	204	204
			.stabstr	441	441
			.stack	2048	2048
			.strtab	380469	380469
			.symtab	257408	257408
			.text	537712	537712

scripts/build/build/target.py

scripts/build/build_examples.py

scripts/build/build/target.py

Simplied the code that ceates dictionaries and lists from data contained within the BuildTarget and TargetPart objects. Also, corrected some comments, and put List and Dict types where appropriate.

github-actions · 2023-03-24T04:03:38Z

PR #25810: Size comparison from a4a407b to ccf235c

Full report (1 build for cc32xx)

platform	target	config	section	`a4a407b`	`ccf235c`
cc32xx	lock	CC3235SF_LAUNCHXL		0	0
			(read only)	645825	645825
			(read/write)	203848	203848
			.ARM.attributes	44	44
			.ARM.exidx	8	8
			.bss	197248	197248
			.comment	194	194
			.data	1480	1480
			.debug_abbrev	930266	930266
			.debug_aranges	87376	87376
			.debug_frame	300288	300288
			.debug_info	20229260	20229260
			.debug_line	`2661728`	`2661728`
			.debug_loc	2806516	2806516
			.debug_ranges	283400	283400
			.debug_str	`3028246`	`3028246`
			.ramVecs	780	780
			.resetVecs	64	64
			.rodata	105993	105993
			.shstrtab	232	232
			.stab	204	204
			.stabstr	441	441
			.stack	2048	2048
			.strtab	380469	380469
			.symtab	257408	257408
			.text	537712	537712

scripts/build/build/target.py

BuildTarget ToDict method was incorrectly converting the fixed_targets list to a dictionary, losing data.

github-actions · 2023-03-24T21:13:26Z

PR #25810: Size comparison from 275dbe1 to 2a9f942

Full report (1 build for cc32xx)

platform	target	config	section	`275dbe1`	`2a9f942`
cc32xx	lock	CC3235SF_LAUNCHXL		0	0
			(read only)	645737	645737
			(read/write)	203848	203848
			.ARM.attributes	44	44
			.ARM.exidx	8	8
			.bss	197248	197248
			.comment	194	194
			.data	1480	1480
			.debug_abbrev	930282	930282
			.debug_aranges	87392	87392
			.debug_frame	300360	300360
			.debug_info	20225165	20225165
			.debug_line	`2661721`	`2661721`
			.debug_loc	2806103	2806103
			.debug_ranges	283440	283440
			.debug_str	3022279	3022279
			.ramVecs	780	780
			.resetVecs	64	64
			.rodata	105953	105953
			.shstrtab	232	232
			.stab	204	204
			.stabstr	441	441
			.stack	2048	2048
			.strtab	380574	380574
			.symtab	257456	257456
			.text	537664	537664

scripts/build/build/target.py

Each time AppendFixedTargets method of BuildTarget is called, a list of TargetPart objects is appended to the fixed_targets list. This change perserves the developer's intent by keeping the list of lists structure intact rather than flatting it out into one list.

github-actions · 2023-03-24T21:49:38Z

PR #25810: Size comparison from 7326cf8 to 466bdab

Decreases (1 build for cc32xx)

platform	target	config	section	`7326cf8`	`466bdab`	change	% change
cc32xx	lock	CC3235SF_LAUNCHXL	.debug_info	20225166	20225165	-1	-0.0

Full report (1 build for cc32xx)

platform	target	config	section	`7326cf8`	`466bdab`	change	% change
cc32xx	lock	CC3235SF_LAUNCHXL		0	0	0	0.0
			(read only)	645737	645737	0	0.0
			(read/write)	203848	203848	0	0.0
			.ARM.attributes	44	44	0	0.0
			.ARM.exidx	8	8	0	0.0
			.bss	197248	197248	0	0.0
			.comment	194	194	0	0.0
			.data	1480	1480	0	0.0
			.debug_abbrev	930282	930282	0	0.0
			.debug_aranges	87392	87392	0	0.0
			.debug_frame	300360	300360	0	0.0
			.debug_info	20225166	20225165	-1	-0.0
			.debug_line	`2661721`	`2661721`	0	0.0
			.debug_loc	2806103	2806103	0	0.0
			.debug_ranges	283440	283440	0	0.0
			.debug_str	3022279	3022279	0	0.0
			.ramVecs	780	780	0	0.0
			.resetVecs	64	64	0	0.0
			.rodata	105953	105953	0	0.0
			.shstrtab	232	232	0	0.0
			.stab	204	204	0	0.0
			.stabstr	441	441	0	0.0
			.stack	2048	2048	0	0.0
			.strtab	380574	380574	0	0.0
			.symtab	257456	257456	0	0.0
			.text	537664	537664	0	0.0

github-actions · 2023-03-24T22:07:48Z

PR #25810: Size comparison from 7326cf8 to 3f775cf

Decreases (1 build for cc32xx)

platform	target	config	section	`7326cf8`	`3f775cf`	change	% change
cc32xx	lock	CC3235SF_LAUNCHXL	.debug_info	20225166	20225165	-1	-0.0

Full report (1 build for cc32xx)

platform	target	config	section	`7326cf8`	`3f775cf`	change	% change
cc32xx	lock	CC3235SF_LAUNCHXL		0	0	0	0.0
			(read only)	645737	645737	0	0.0
			(read/write)	203848	203848	0	0.0
			.ARM.attributes	44	44	0	0.0
			.ARM.exidx	8	8	0	0.0
			.bss	197248	197248	0	0.0
			.comment	194	194	0	0.0
			.data	1480	1480	0	0.0
			.debug_abbrev	930282	930282	0	0.0
			.debug_aranges	87392	87392	0	0.0
			.debug_frame	300360	300360	0	0.0
			.debug_info	20225166	20225165	-1	-0.0
			.debug_line	`2661721`	`2661721`	0	0.0
			.debug_loc	2806103	2806103	0	0.0
			.debug_ranges	283440	283440	0	0.0
			.debug_str	3022279	3022279	0	0.0
			.ramVecs	780	780	0	0.0
			.resetVecs	64	64	0	0.0
			.rodata	105953	105953	0	0.0
			.shstrtab	232	232	0	0.0
			.stab	204	204	0	0.0
			.stabstr	441	441	0	0.0
			.stack	2048	2048	0	0.0
			.strtab	380574	380574	0	0.0
			.symtab	257456	257456	0	0.0
			.text	537664	537664	0	0.0

github-actions bot added the scripts label Mar 23, 2023

Merge branch 'project-chip:master' into master

ba31e34

nekleo marked this pull request as ready for review March 23, 2023 23:53

nekleo marked this pull request as draft March 23, 2023 23:54

restyled-commits added 2 commits March 23, 2023 17:11

Restyled by autopep8

99c81ef

Restyled by isort

7ab15e0

andy31415 reviewed Mar 24, 2023

View reviewed changes

scripts/build/build/target.py Outdated Show resolved Hide resolved

andy31415 reviewed Mar 24, 2023

View reviewed changes

scripts/build/build/target.py Outdated Show resolved Hide resolved

andy31415 reviewed Mar 24, 2023

View reviewed changes

scripts/build/build/target.py Outdated Show resolved Hide resolved

andy31415 reviewed Mar 24, 2023

View reviewed changes

scripts/build/build_examples.py Outdated Show resolved Hide resolved

andy31415 reviewed Mar 24, 2023

View reviewed changes

scripts/build/build/target.py Outdated Show resolved Hide resolved

andy31415 reviewed Mar 24, 2023

View reviewed changes

scripts/build/build/target.py Outdated Show resolved Hide resolved

Simplfy code (loops) for creating Dicts and Lists

ccf235c

Simplied the code that ceates dictionaries and lists from data contained within the BuildTarget and TargetPart objects. Also, corrected some comments, and put List and Dict types where appropriate.

nekleo marked this pull request as ready for review March 24, 2023 03:53

pullapprove bot requested review from amitnj, anush-apple, arkq, bzbarsky-apple, carol-apple, chrisdecenzo, chshu, chulspro, cliffamzn, CodeChronos928, Damian-Nordic and dhrishi March 24, 2023 03:53

pullapprove bot requested review from mrjerryjohns, msandstedt, mspang, nivi-apple, saurabhst, selissia, sharadb-amazon, tcarmelveilleux, tecimovic, tehampson, vijs, vivien-apple, woody-apple, xylophone21, younghak-hwang and yunhanw-google March 24, 2023 03:53

pullapprove bot added the review - pending label Mar 24, 2023

arkq reviewed Mar 24, 2023

View reviewed changes

scripts/build/build/target.py Outdated Show resolved Hide resolved

scripts/build/build/target.py Outdated Show resolved Hide resolved

andy31415 reviewed Mar 24, 2023

View reviewed changes

scripts/build/build/target.py Outdated Show resolved Hide resolved

nekleo and others added 2 commits March 24, 2023 12:29

Fixed BuildTarget ToDict method

5a8ce8c

BuildTarget ToDict method was incorrectly converting the fixed_targets list to a dictionary, losing data.

Merge branch 'project-chip:master' into master

2a9f942

andy31415 approved these changes Mar 24, 2023

View reviewed changes

scripts/build/build/target.py Outdated Show resolved Hide resolved

nekleo and others added 2 commits March 24, 2023 14:38

Merge branch 'project-chip:master' into master

466bdab

andy31415 added the fast track label Mar 25, 2023

andy31415 merged commit 2b65794 into project-chip:master Mar 25, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add JSON as a format option for `targets` command in `build_examples.py` #25810

Add JSON as a format option for `targets` command in `build_examples.py` #25810

nekleo commented Mar 23, 2023

CLAassistant commented Mar 23, 2023 •

edited

Loading

github-actions bot commented Mar 23, 2023

github-actions bot commented Mar 24, 2023

github-actions bot commented Mar 24, 2023

github-actions bot commented Mar 24, 2023

github-actions bot commented Mar 24, 2023

github-actions bot commented Mar 24, 2023

Add JSON as a format option for targets command in build_examples.py #25810

Add JSON as a format option for targets command in build_examples.py #25810

Conversation

nekleo commented Mar 23, 2023

CLAassistant commented Mar 23, 2023 • edited Loading

github-actions bot commented Mar 23, 2023

github-actions bot commented Mar 24, 2023

github-actions bot commented Mar 24, 2023

github-actions bot commented Mar 24, 2023

github-actions bot commented Mar 24, 2023

github-actions bot commented Mar 24, 2023

Add JSON as a format option for `targets` command in `build_examples.py` #25810

Add JSON as a format option for `targets` command in `build_examples.py` #25810

CLAassistant commented Mar 23, 2023 •

edited

Loading