mirror/buildroot
1
0
Fork 0
mirror of https://gitlab.com/buildroot.org/buildroot.git synced 2026-10-24 18:02:27 -09:00
Code Issues Packages Projects Releases Wiki Activity

utils/generate-cyclonedx: use argparse defaults help formatter

Browse Source 
The argparse library documentation [1] suggest the usage of
'ArgumentDefaultsHelpFormatter' in the ArgumentParser declaration to
show the default value of every arguments.

Use this to avoid declaring this value ourself which possibly gets
outdated with the actual default value.

Note that this also adds an unnecessary default: FALSE to the --virtual
option, but that's a minor annoyance.

[1] https://docs.python.org/3/library/argparse.html#argparse.ArgumentDefaultsHelpFormatter

Suggested-by: Quentin Schulz <quentin.schulz@cherry.de>
Suggested-by: Titouan Christophe <titouan.christophe@mind.be>
Signed-off-by: Thomas Perale <thomas.perale@mind.be>
Signed-off-by: Arnout Vandecappelle <arnout@rnout.be>
(cherry picked from commit 358f226809)
Signed-off-by: Raphaël Mélotte <raphael.melotte@mind.be>
This commit is contained in:
Thomas Perale
2026-10-11 11:42:12 +02:00
committed by Raphaël Mélotte
parent bb5e615593
commit 5d484774ab
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
utils/generate-cyclonedx
View File

@@ -529,23 +529,24 @@ def br2_root_deps(show_info_dict, virtual=False) -> list:
def main():
parser = argparse.ArgumentParser(
description='''Create a CycloneDX SBoM for the Buildroot configuration.
Example usage: make show-info | utils/generate-cyclonedx > sbom.json
'''
)
description='''Create a CycloneDX SBoM for the Buildroot configuration.
Example usage: make show-info | utils/generate-cyclonedx > sbom.json
''',
formatter_class=argparse.ArgumentDefaultsHelpFormatter
)
parser.add_argument("-i", "--in-file", nargs="?", type=argparse.FileType("r"),
default=(None if sys.stdin.isatty() else sys.stdin))
parser.add_argument("-o", "--out-file", nargs="?", type=argparse.FileType("w"),
default=sys.stdout)
parser.add_argument("--virtual", default=False, action='store_true',
parser.add_argument("--virtual", action='store_true',
help="This option includes virtual packages to the CycloneDX output")
parser.add_argument("--project-name", type=str, default="buildroot",
help="Specify the project name to use in the SBOM metadata (default:'buildroot')")
help="Specify the project name to use in the SBOM metadata")
parser.add_argument("--project-version", type=str, default=f"{BR2_VERSION_FULL}",
help="Specify the project version to use in the SBOM metadata (default: builroot version)")
help="Specify the project version to use in the SBOM metadata")
parser.add_argument("--cdx-version", type=str, default=DEFAULT_CYCLONEDX_VERSION,
choices=["1.6", "1.6.1", "1.6.2", "1.7", "1.7.1"],
help=f"Set CycloneDX version (default: {DEFAULT_CYCLONEDX_VERSION})")
help="Set CycloneDX version")
args = parser.parse_args()