Metadata¶
- class lsst.verify.Metadata(measurement_set, data=None)¶
Bases:
JsonSerializationMixin
Container for verification framework job metadata.
Metadata are key-value terms. Both keys and values should be JSON-serializable.
- Parameters:
- measurement_set
lsst.verify.MeasurementSet
, optional When provided, metadata with keys prefixed by metric names are deferred to
Metadata
instances attached to measurements (lsst.verify.Measurement.notes
).- data
dict
, optional Dictionary to seed metadata.
- measurement_set
Attributes Summary
A
dict
that can be serialized as semantic SQUASH JSON.Methods Summary
items
()Iterate over key-value metadata pairs.
jsonify_dict
(d)Recursively build JSON-renderable objects on all values in a dict.
keys
()Get the metadata keys.
update
(data)Update metadata with key-value pairs from a
dict
-like object.values
()Iterate over metadata values.
write_json
(filepath)Write JSON to a file.
Attributes Documentation
- json¶
A
dict
that can be serialized as semantic SQUASH JSON.Keys in the
dict
are metadata keys (seeMetadata.keys
). Values are the associated metadata values as JSON-serializable objects.
Methods Documentation
- items()¶
Iterate over key-value metadata pairs.
- static jsonify_dict(d)¶
Recursively build JSON-renderable objects on all values in a dict.
- Parameters:
- d
dict
Dictionary to convert into a JSON-serializable object. Values are recursively JSON-ified.
- d
- Returns:
- json_dict
dict
Dictionary that can be serialized to JSON.
- json_dict
Examples
Subclasses can use this method to prepare output in their
json
-method implementation. For example:def json(self): return JsonSerializationMixin.jsonify_dict({ 'value': self.value, })
- keys()¶
Get the metadata keys.
- update(data)¶
Update metadata with key-value pairs from a
dict
-like object.- Parameters:
- data
dict
-like The
data
object needs to provide anitems
method to iterate over its key-value pairs. If thisMetadata
instance already has a key, the value will be overwritten with the value fromdata
.
- data
- values()¶
Iterate over metadata values.
- Returns:
- items
ValuesView
An iterable over all the values.
- items