Data

class compas.data.Data[source]

Bases: object

Abstract base class for all COMPAS data objects.

Parameters:
namestr, optional

The name of the object.

Attributes:
guidstr, read-only

The globally unique identifier of the object. The guid is generated with uuid.uuid4().

namestr

The name of the object. This name is not necessarily unique and can be set by the user. The default value is the object’s class name: self.__class__.__name__.

Notes

Objects created from classes that implement this data class can be serialized to JSON and unserialized without loss of information using:

Methods

ToString

Converts the instance to a string.

copy

Make an independent copy of the data object.

from_json

Construct an object of this type from a JSON file.

from_jsonstring

Construct an object of this type from a JSON string.

sha256

Compute a hash of the data for comparison during version control using the sha256 algorithm.

to_json

Convert an object to its native data representation and save it to a JSON file.

to_jsonstring

Convert an object to its native data representation and save it to a JSON string.

validate_data

Validate the data against the object's data schema.