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

scripts/build/build/target.py

@@ -95,6 +95,24 @@ def Accept(self, full_input: str):
 
         return True
 
+    def ToDict(self):
+        """Converts a TargetPart into a dictionary
+        """
+
+        result: Dict[str, str] = {}
+        result['name'] = self.name
+        bld_args_keys = list(self.build_arguments.keys())
+        for key in bld_args_keys:
+            result[key] = str(self.build_arguments[key])
+
+        if self.only_if_re is not None:
+            result['only_if_re'] = str(self.only_if_re.pattern)
+
+        if self.except_if_re is not None:
+            result['except_if_re'] = str(self.except_if_re.pattern)
+
+        return result
+
 
 def _HasVariantPrefix(value: str, prefix: str):
     """Checks if the given value is <prefix> or starts with "<prefix>-".
@@ -264,6 +282,50 @@ def HumanString(self):
 
         return result
 
+    def ToDict(self):
+        """Outputs a parseable description of the available variants
+        and modifiers:
+
+            like:
+
+            "foo": {
+                "builder": "<class 'builders.foo.FooBuilder'>",
+                "shorthand": "foo-bar-baz[-m1]
+                "fixed_targets": [
+                    {
+                        "name": "foo",
+                        "board": "bar"
+                    }
+                    {
+                        "name": "baz",
+                        "app": "foo.baz"
+                    }
+                ],
+                "modifiers": [
+                    {
+                        "name": "modifier1",
+                        "m1": "True"
+                    }
+                ]
+            },
+        """
+        result: Dict[str, Any] = {}
+
+        result['name'] = self.name
+        result['builder'] = str(self.builder_class)
+        result['shorthand'] = self.HumanString()
+        result['parts'] = []
+        result['modifiers'] = []
+
+        for target in self.fixed_targets:
+            for target_part in target:
+                result['parts'].append(target_part.ToDict())
+
+        for target_part in self.modifiers:
+            result['modifiers'].append(target_part.ToDict())
+
+        return result
+
     def AllVariants(self) -> Iterable[str]:
         """Returns all possible accepted variants by this target.
 

scripts/build/build_examples.py

@@ -14,6 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import json
 import logging
 import os
 import sys
@@ -177,21 +178,34 @@ def cmd_generate(context):
 
 @main.command(
     'targets',
-    help=('List the targets that would be generated/built given '
-          'the input arguments'))
+    help=('Lists the targets that can be used with the build and gen commands'))
 @click.option(
-    '--expand',
-    default=False,
-    is_flag=True,
-    help='Expand all possible targets rather than the shorthand string')
+    '--format',
+    default='summary',
+    type=click.Choice(['summary', 'expanded', 'json'], case_sensitive=False),
+    help="""
+        summary - list of shorthand strings summarzing the available targets;
+
+        expanded - list all possible targets rather than the shorthand string;
+
+        json - a JSON representation of the available targets
+        """)
 @click.pass_context
-def cmd_targets(context, expand):
-    for target in build.targets.BUILD_TARGETS:
-        if expand:
+def cmd_targets(context, format):
+    if format == 'expanded':
+        for target in build.targets.BUILD_TARGETS:
             build.target.report_rejected_parts = False
             for s in target.AllVariants():
                 print(s)
-        else:
+    elif format == 'json':
+        targets = []
+
+        for target in build.targets.BUILD_TARGETS:
+            targets.append(target.ToDict())
+
+        print(json.dumps(targets, indent=4))
+    else:
+        for target in build.targets.BUILD_TARGETS:
             print(target.HumanString())