HashableStoredData¶
-
class
openff.evaluator.storage.data.
HashableStoredData
[source]¶ Represents a class of data objects which can be rapidly compared / indexed by their hash values.
-
__init__
()¶ Initialize self. See help(type(self)) for accurate signature.
Methods
__init__
()Initialize self.
from_json
(file_path)Create this object from a JSON file.
get_attributes
([attribute_type])Returns all attributes of a specific attribute_type.
Returns whether this data object requires an accompanying data directory-like structure.
json
([file_path, format])Creates a JSON representation of this class.
parse_json
(string_contents[, encoding])Parses a typed json string into the corresponding class structure.
Returns the storage query which would match this data object.
validate
([attribute_type])Validate the values of the attributes.
-
classmethod
from_json
(file_path)¶ Create this object from a JSON file.
- Parameters
file_path (str) – The path to load the JSON from.
- Returns
The parsed class.
- Return type
cls
-
classmethod
get_attributes
(attribute_type=None)¶ Returns all attributes of a specific attribute_type.
- Parameters
attribute_type (type of Attribute, optional) – The type of attribute to search for.
- Returns
The names of the attributes of the specified type.
- Return type
list of str
-
abstract classmethod
has_ancillary_data
()¶ Returns whether this data object requires an accompanying data directory-like structure.
- Returns
True if this class requires an accompanying data directory-like structure.
- Return type
-
json
(file_path=None, format=False)¶ Creates a JSON representation of this class.
-
classmethod
parse_json
(string_contents, encoding='utf8')¶ Parses a typed json string into the corresponding class structure.
-
to_storage_query
()¶ Returns the storage query which would match this data object.
- Returns
The storage query which would match this data object.
- Return type
-
validate
(attribute_type=None)¶ Validate the values of the attributes. If attribute_type is set, only attributes of that type will be validated.
- Parameters
attribute_type (type of Attribute, optional) – The type of attribute to validate.
- Raises
ValueError or AssertionError –
-