cyclonedx.factory.license

Module Contents

Classes

LicenseFactory	Factory for cyclonedx.model.License.
LicenseChoiceFactory	Factory for cyclonedx.model.LicenseChoice.

class cyclonedx.factory.license.LicenseFactory

Factory for cyclonedx.model.License.

make_from_string(name_or_spdx: str, *, license_text: cyclonedx.model.AttachedText | None = None, license_url: cyclonedx.model.XsUri | None = None) → cyclonedx.model.License

Make a cyclonedx.model.License from a string.

make_with_id(spdx_id: str, *, text: cyclonedx.model.AttachedText | None = None, url: cyclonedx.model.XsUri | None = None) → cyclonedx.model.License

Make a cyclonedx.model.License from an SPDX-ID.

Raises:

InvalidSpdxLicenseException – if spdx_id was not known/supported SPDX-ID

make_with_name(name: str, *, text: cyclonedx.model.AttachedText | None = None, url: cyclonedx.model.XsUri | None = None) → cyclonedx.model.License

Make a cyclonedx.model.License with a name.

class cyclonedx.factory.license.LicenseChoiceFactory(*, license_factory: LicenseFactory)

Factory for cyclonedx.model.LicenseChoice.

make_from_string(expression_or_name_or_spdx: str) → cyclonedx.model.LicenseChoice

Make a cyclonedx.model.LicenseChoice from a string.

make_with_compound_expression(compound_expression: str) → cyclonedx.model.LicenseChoice

Make a cyclonedx.model.LicenseChoice with a compound expression.

Utilizes cyclonedx.spdx.is_compound_expression().

Raises:

InvalidLicenseExpressionException – if expression is not known/supported license expression

make_with_license(name_or_spdx: str, *, license_text: cyclonedx.model.AttachedText | None = None, license_url: cyclonedx.model.XsUri | None = None) → cyclonedx.model.LicenseChoice

Make a cyclonedx.model.LicenseChoice with a license (name or SPDX-ID).