cyclonedx_py.client

Module Contents

Classes

_CLI_OUTPUT_FORMAT

Generic enumeration.

CycloneDxCmd

Functions

main(→ None)

main_deprecated(→ None)

Attributes

_output_formats

_output_default_filenames

exception cyclonedx_py.client.CycloneDxCmdException[source]

Bases: Exception

Common base class for all non-exit exceptions.

exception cyclonedx_py.client.CycloneDxCmdNoInputFileSupplied[source]

Bases: CycloneDxCmdException

Common base class for all non-exit exceptions.

class cyclonedx_py.client._CLI_OUTPUT_FORMAT[source]

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

XML = 'xml'[source]
JSON = 'json'[source]
cyclonedx_py.client._output_formats[source]
cyclonedx_py.client._output_default_filenames[source]
class cyclonedx_py.client.CycloneDxCmd(args: argparse.Namespace)[source]
_DEBUG_ENABLED: bool = False[source]
_arguments: argparse.Namespace[source]
_get_output_format() _CLI_OUTPUT_FORMAT[source]
get_output() cyclonedx.output.BaseOutput[source]
execute() None[source]
static get_arg_parser(*, prog: str | None = None) argparse.ArgumentParser[source]
_debug_message(message: str, *args: Any, **kwargs: Any) None[source]
static _error_and_exit(message: str, *args: Any, exit_code: int = 1, **kwargs: Any) None[source]
_get_input_parser() cyclonedx.parser.BaseParser[source]
cyclonedx_py.client.main(*, prog_name: str | None = None, prog_name_instead: str | None = None) None[source]
cyclonedx_py.client.main_deprecated(*, prog_name: str | None = None) None[source]