ComponentData

The ComponentData class is used to initialize a Check instance with component metadata from different sources. It provides methods to load data from JSON objects or files.

Constructor

ComponentData(data)

• data (dict): A dictionary containing component metadata

Class Methods

from_json

@classmethod
from_json(cls, json_data)

Creates a ComponentData instance from a JSON object.

• json_data (dict): A dictionary containing component metadata

• Returns: A new ComponentData instance

Example:

component_json = {
    "readme": {
        "lines": 50,
        "missing": False
    }
}
component_data = ComponentData.from_json(component_json)

from_file

@classmethod
from_file(cls, file_path)

Creates a ComponentData instance from a JSON file.

• file_path (str): Path to a JSON file containing component metadata

• Returns: A new ComponentData instance

Example:

component_data = ComponentData.from_file("path/to/component.json")