cyclonedx-python-lib API reference

110 public APIs from cyclonedx-python-lib (CycloneDX/cyclonedx-python-lib) — 30 classes, 3 functions, 77 methods. Signatures extracted by static analysis of the actual source.

Repository: CycloneDX/cyclonedx-python-lib

Kind	Count
Classes	30
Functions	3
Methods	77

API list

classcyclonedx.exception.CycloneDxException

Root exception thrown by this library.

classcyclonedx.exception.output.BomGenerationErrorException

Raised if there is an unknown error.

methodcyclonedx.model.HashType.alg() -> HashAlgorithm

Specifies the algorithm used to create the hash.

methodcyclonedx.model.HashType.content() -> str

Hash value content.

methodcyclonedx.model.Note.locale() -> Optional[str]

Get the ISO locale of this Note.

methodcyclonedx.model.Note.text() -> NoteText

Specifies the full content of the release note.

methodcyclonedx.model.Property.name() -> str

The name of the property.

methodcyclonedx.model.Property.value() -> Optional[str]

Value of this Property.

methodcyclonedx.model.component.Commit.uid() -> Optional[str]

A unique identifier of the commit.

methodcyclonedx.model.component.Commit.url() -> Optional[XsUri]

The URL to the commit.

methodcyclonedx.model.component.Component.authors() -> 'SortedSet[OrganizationalContact]'

The person(s) who created the component.

methodcyclonedx.model.component.Component.description() -> Optional[str]

Get the description of this Component.

methodcyclonedx.model.component.Component.group() -> Optional[str]

The grouping name or identifier.

methodcyclonedx.model.component.Component.mime_type() -> Optional[str]

Get any declared mime-type for this Component.

methodcyclonedx.model.component.Component.name() -> str

The name of the component.

methodcyclonedx.model.component.Component.omnibor_ids() -> 'SortedSet[OmniborId]'

Specifies the OmniBOR Artifact ID.

methodcyclonedx.model.component.Component.purl() -> Optional[PackageURL]

Specifies the package-url (PURL).

methodcyclonedx.model.component.Component.release_notes() -> Optional[ReleaseNotes]

Specifies optional release notes.

methodcyclonedx.model.component.Component.scope() -> Optional[ComponentScope]

Specifies the scope of the component.

methodcyclonedx.model.component.Component.type() -> ComponentType

Get the type of this Component.

methodcyclonedx.model.component.Component.version() -> Optional[str]

The component version.

methodcyclonedx.model.component.Diff.text() -> Optional[AttachedText]

Specifies the optional text of the diff.

methodcyclonedx.model.component.Diff.url() -> Optional[XsUri]

Specifies the URL to the diff.

methodcyclonedx.model.component.Patch.diff() -> Optional[Diff]

The patch file (or diff) that show changes.

methodcyclonedx.model.component.Patch.resolves() -> 'SortedSet[IssueType]'

Optional list of issues resolved by this patch.

methodcyclonedx.model.component.Swid.name() -> str

Maps to the name of a SoftwareIdentity.

methodcyclonedx.model.component.Swid.patch() -> Optional[bool]

Maps to the patch of a SoftwareIdentity.

methodcyclonedx.model.component.Swid.tag_id() -> str

Maps to the tagId of a SoftwareIdentity.

methodcyclonedx.model.component.Swid.tag_version() -> Optional[int]

Maps to the tagVersion of a SoftwareIdentity.

methodcyclonedx.model.component.Swid.text() -> Optional[AttachedText]

Specifies the full content of the SWID tag.

methodcyclonedx.model.component.Swid.url() -> Optional[XsUri]

The URL to the SWID file.

methodcyclonedx.model.component.Swid.version() -> Optional[str]

Maps to the version of a SoftwareIdentity.

classcyclonedx.model.component_evidence.CallStackFrame

Represents an individual frame in a call stack.

methodcyclonedx.model.component_evidence.CallStackFrame.column() -> Optional[int]

The column number

methodcyclonedx.model.component_evidence.CallStackFrame.full_filename() -> Optional[str]

The full file path

methodcyclonedx.model.component_evidence.CallStackFrame.function() -> Optional[str]

The function name.

methodcyclonedx.model.component_evidence.CallStackFrame.line() -> Optional[int]

The line number

methodcyclonedx.model.component_evidence.CallStackFrame.module() -> str

The module name

methodcyclonedx.model.component_evidence.CallStackFrame.package() -> Optional[str]

The package name.

methodcyclonedx.model.component_evidence.CallStackFrame.parameters() -> 'SortedSet[str]'

Function parameters

methodcyclonedx.model.crypto.CertificateProperties.certificate_extension() -> Optional[str]

The file extension of the certificate.

methodcyclonedx.model.crypto.CertificateProperties.certificate_format() -> Optional[str]

The format of the certificate.

methodcyclonedx.model.crypto.CertificateProperties.issuer_name() -> Optional[str]

The issuer name for the certificate.

methodcyclonedx.model.crypto.CertificateProperties.subject_name() -> Optional[str]

The subject name for the certificate.

classcyclonedx.model.definition.Definitions

The repository for definitions ..

methodcyclonedx.model.definition.Definitions.standards() -> 'SortedSet[Standard]'

Returns: A SortedSet of Standards

classcyclonedx.model.definition.Level

Level of compliance for a standard.

methodcyclonedx.model.definition.Level.description() -> Optional[str]

Returns: The description of the level.

methodcyclonedx.model.definition.Level.identifier() -> Optional[str]

Returns: The identifier of the level.

methodcyclonedx.model.definition.Level.title() -> Optional[str]

Returns: The title of the level.

classcyclonedx.model.definition.Requirement

A requirement comprising a standard.

methodcyclonedx.model.definition.Requirement.identifier() -> Optional[str]

Returns: The identifier of the requirement.

methodcyclonedx.model.definition.Requirement.text() -> Optional[str]

Returns: The text of the requirement.

methodcyclonedx.model.definition.Requirement.title() -> Optional[str]

Returns: The title of the requirement.

methodcyclonedx.model.definition.Standard.description() -> Optional[str]

Returns: The description of the standard

methodcyclonedx.model.definition.Standard.name() -> Optional[str]

Returns: The name of the standard

methodcyclonedx.model.definition.Standard.version() -> Optional[str]

Returns: The version of the standard

classcyclonedx.model.dependency.Dependable

Dependable objects can be part of the Dependency Graph

classcyclonedx.model.dependency.Dependency

Models a Dependency within a BOM.

methodcyclonedx.model.issue.IssueType.description() -> Optional[str]

A description of the issue.

methodcyclonedx.model.issue.IssueType.name() -> Optional[str]

The name of the issue.

methodcyclonedx.model.issue.IssueType.references() -> 'SortedSet[XsUri]'

Any reference URLs related to this issue.

methodcyclonedx.model.issue.IssueType.source() -> Optional[IssueTypeSource]

The source of this issue.

methodcyclonedx.model.issue.IssueType.type() -> IssueClassification

Specifies the type of issue.

classcyclonedx.model.license.LicenseRepository

Collection of :class:`License`.

classcyclonedx.model.lifecycle.LifecycleRepository

Collection of :class:`Lifecycle`.

methodcyclonedx.model.service.Service.data() -> 'SortedSet[DataClassification]'

Specifies the data classification.

methodcyclonedx.model.service.Service.description() -> Optional[str]

Specifies a description for the service.

methodcyclonedx.model.service.Service.endpoints() -> 'SortedSet[XsUri]'

A list of endpoints URI's this service provides.

methodcyclonedx.model.service.Service.group() -> Optional[str]

The grouping name, namespace, or identifier.

methodcyclonedx.model.service.Service.name() -> str

The name of the service.

methodcyclonedx.model.service.Service.release_notes() -> Optional[ReleaseNotes]

Specifies optional release notes.

methodcyclonedx.model.service.Service.version() -> Optional[str]

The service version.

methodcyclonedx.model.tool.Tool.hashes() -> 'SortedSet[HashType]'

The hashes of the tool (if applicable).

methodcyclonedx.model.tool.Tool.name() -> Optional[str]

The name of the tool.

methodcyclonedx.model.tool.Tool.vendor() -> Optional[str]

The name of the vendor who created the tool.

methodcyclonedx.model.tool.Tool.version() -> Optional[str]

The version of the tool.

classcyclonedx.model.tool.ToolRepository

The repository of tool formats

methodcyclonedx.model.tool.ToolRepository.components() -> 'SortedSet[Component]'

Returns: A SortedSet of Components

methodcyclonedx.model.tool.ToolRepository.services() -> 'SortedSet[Service]'

Returns: A SortedSet of Services

methodcyclonedx.model.vulnerability.Vulnerability.ratings() -> 'SortedSet[VulnerabilityRating]'

List of vulnerability ratings.

methodcyclonedx.model.vulnerability.Vulnerability.tools() -> ToolRepository

Tools used to create this BOM.

classcyclonedx.model.vulnerability.VulnerabilityAdvisory

Class that models the `advisoryType` complex type.

methodcyclonedx.model.vulnerability.VulnerabilityAdvisory.title() -> Optional[str]

The title of this advisory.

methodcyclonedx.model.vulnerability.VulnerabilityAdvisory.url() -> XsUri

The url of this advisory.

classcyclonedx.schema.OutputFormat

Output formats.

classcyclonedx.schema.SchemaVersion

Schema version.

methodcyclonedx.schema.SchemaVersion.from_version(version:str) -> _SV

Return instance based of a version string - e.g.

methodcyclonedx.schema.SchemaVersion.to_version() -> str

Return as a version string - e.g.

classcyclonedx.schema.schema.BaseSchemaVersion

Base class for schema version views.

classcyclonedx.schema.schema.SchemaVersion1Dot0

Schema version views 1.0

classcyclonedx.schema.schema.SchemaVersion1Dot1

Schema version views 1.1

classcyclonedx.schema.schema.SchemaVersion1Dot2

Schema version views 1.2

classcyclonedx.schema.schema.SchemaVersion1Dot3

Schema version views 1.3

classcyclonedx.schema.schema.SchemaVersion1Dot4

Schema version views 1.4

classcyclonedx.schema.schema.SchemaVersion1Dot5

Schema version views 1.5

classcyclonedx.schema.schema.SchemaVersion1Dot6

Schema version views 1.6

classcyclonedx.schema.schema.SchemaVersion1Dot7

Schema version views 1.7

classcyclonedx.serialization.BomRefHelper

**DEPRECATED** in favour of :class:`BomRef`.

classcyclonedx.serialization.LicenseRepositoryHelper

**DEPRECATED** ..

funccyclonedx.spdx.fixup_id(value:str) -> Optional[str]

Fixup SPDX-ID.

funccyclonedx.spdx.is_expression(value:str) -> bool

Validate SPDX license expression.

funccyclonedx.spdx.is_supported_id(value:str) -> bool

Validate SPDX-ID according to current spec.

classcyclonedx.validation.BaseSchemabasedValidator

Base Schema-based Validator

methodcyclonedx.validation.BaseSchemabasedValidator.output_format() -> OutputFormat

Get the format.

methodcyclonedx.validation.BaseSchemabasedValidator.schema_version() -> 'SchemaVersion'

Get the schema version.

classcyclonedx.validation.SchemabasedValidator

Schema-based Validator protocol

classcyclonedx.validation.ValidationError

Validation failed with this specific error.

classcyclonedx.validation.json.JsonValidator

Validator for CycloneDX documents in JSON format.

classcyclonedx.validation.xml.XmlValidator

Validator for CycloneDX documents in XML format.

About this data

These signatures were extracted from the public source of CycloneDX/cyclonedx-python-lib using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries