cargo: Add optional yaml output

Fixes #441

Author: bbhtt

cargo/README.md

@@ -9,6 +9,7 @@ Poetry users can run `poetry install` and skip this.
 Otherwise install Python 3.8+ with these modules:
 - toml
 - aiohttp
+- (Optional) PyYAML>=6.0.2 for YAML output instead of JSON
 
 Generated manifests are supported by flatpak-builder 1.2.x or newer.
 

cargo/flatpak-cargo-generator.py

@@ -12,11 +12,20 @@
 import logging
 import hashlib
 import asyncio
-from typing import Any, Dict, List, NamedTuple, Optional, Tuple, TypedDict
+from typing import Any, Dict, List, NamedTuple, Optional, Tuple, TypedDict, TYPE_CHECKING
 
 import aiohttp
 import toml
 
+try:
+    import yaml
+    YAML_AVAIL = True
+except ImportError:
+    YAML_AVAIL = False
+
+if TYPE_CHECKING and not YAML_AVAIL:
+    import yaml
+
 CRATES_IO = 'https://static.crates.io/crates'
 CARGO_HOME = 'cargo'
 CARGO_CRATES = f'{CARGO_HOME}/vendor'
@@ -413,11 +422,15 @@ def main():
     parser = argparse.ArgumentParser()
     parser.add_argument('cargo_lock', help='Path to the Cargo.lock file')
     parser.add_argument('-o', '--output', required=False, help='Where to write generated sources')
+    parser.add_argument('--yaml', action='store_true', help='Output as YAML instead of JSON')
     parser.add_argument('-t', '--git-tarballs', action='store_true', help='Download git repos as tarballs')
     parser.add_argument('-d', '--debug', action='store_true')
     args = parser.parse_args()
+
     if args.output is not None:
         outfile = args.output
+    if args.yaml and YAML_AVAIL:
+        outfile = 'generated-sources.yml'
     else:
         outfile = 'generated-sources.json'
     if args.debug:
@@ -428,8 +441,13 @@ def main():
 
     generated_sources = asyncio.run(generate_sources(load_toml(args.cargo_lock),
                                     git_tarballs=args.git_tarballs))
-    with open(outfile, 'w') as out:
-        json.dump(generated_sources, out, indent=4, sort_keys=False)
+
+    if args.yaml and YAML_AVAIL:
+        with open(outfile, 'w') as out:
+            yaml.dump(generated_sources, out, sort_keys=False)
+    else:
+        with open(outfile, 'w') as out:
+            json.dump(generated_sources, out, indent=4, sort_keys=False)
 
 
 if __name__ == '__main__':

cargo/pyproject.toml

@@ -5,7 +5,7 @@ package-mode = false
 python = ">=3.8"
 aiohttp = "^3.9.5"
 toml = "^0.10.2"
-
+PyYAML = "^6.0.2"
 
 [build-system]
 requires = ["poetry-core"]