cyclonedx.exception.model

Exceptions relating to specific conditions that occur when modelling CycloneDX BOM.

Module Contents

exception cyclonedx.exception.model.CycloneDxModelException[source]

Bases: cyclonedx.exception.CycloneDxException

Base exception that covers all exceptions that may be thrown during model creation.

exception cyclonedx.exception.model.InvalidLocaleTypeException[source]

Bases: CycloneDxModelException

Raised when the supplied locale does not conform to ISO-639 specification.

Good examples:

  • en

  • en-US

  • en-GB

  • fr

  • fr-CA

The language code MUST be lowercase. If the country code is specified, the country code MUST be upper case. The language code and country code MUST be separated by a minus sign.

exception cyclonedx.exception.model.InvalidUriException[source]

Bases: CycloneDxModelException

Raised when a str is provided that needs to be a valid URI, but isn’t.

exception cyclonedx.exception.model.MutuallyExclusivePropertiesException[source]

Bases: CycloneDxModelException

Raised when mutually exclusive properties are provided.

exception cyclonedx.exception.model.NoPropertiesProvidedException[source]

Bases: CycloneDxModelException

Raised when attempting to construct a model class and providing NO values (where all properites are defined as Optional, but at least one is required).

exception cyclonedx.exception.model.UnknownComponentDependencyException[source]

Bases: CycloneDxModelException

Exception raised when a dependency has been noted for a Component that is NOT a Component BomRef in this Bom.

exception cyclonedx.exception.model.UnknownHashTypeException[source]

Bases: CycloneDxModelException

Exception raised when we are unable to determine the type of hash from a composite hash string.