otupy.profiles.xbom.data.library.Library

class Library(lib=None, description=None, id=None, name=None, version=None, source=None, lib_type=None)

Bases: XBOMObject

Software library

This is the model of a software library

Methods

as_cyclonedx	Convert Library to CycloneDX component format.
fromdict	Builds instance from dictionary
todict	Converts to dictionary

Attributes

description	Generic description of the node (including its role)
id	ID of the node, preferably globally unique
lib_type	Type of the library (e.g., runtime, headerfiles)
name	A name for this node (e.g., network namespace name)
source	URI to retrieve the library
version	Version of the library

__init__(lib=None, description=None, id=None, name=None, version=None, source=None, lib_type=None)

as_cyclonedx() → Component

Convert Library to CycloneDX component format.

Returns:

Component: CycloneDX Component with type LIBRARY.

description: str = None

Generic description of the node (including its role)

classmethod fromdict(dic, e)

Builds instance from dictionary

It is used during deserialization to create an otupy instance from the text message. It takes an Encoder instance that is used to recursively build instances of the inner objects (the Encoder provides standard methods to create instances of base objects like strings, integers, boolean).

Parameters:

• dic – The intermediary dictionary representation from which the object is built.

• e – The Encoder that is being used.

Returns:

An instance of this class initialized from the dictionary values.

id: str = None

ID of the node, preferably globally unique

lib_type: str = None

Type of the library (e.g., runtime, headerfiles)

name: str = None

A name for this node (e.g., network namespace name)

source: URI = None

URI to retrieve the library

todict(e)

Converts to dictionary

It is used to convert this object to an intermediary representation during serialization. It takes an Encoder argument that is used to recursively serialize inner data and structures (the Encoder provides standard methods for converting base types to dictionaries)..

Parameters:

e – The Encoder that is being used.

Returns:

A dictionary compliants to the Language Specification’s serialization rules.

version: str = None

Version of the library