SetDictMetadata

class lsst.pipe.base.SetDictMetadata(*args, **kwargs)

Bases: Protocol

Protocol for objects that can be assigned a possibly-nested dict of primitives.

This protocol is satisfied by TaskMetadata, lsst.daf.base.PropertySet, and lsst.daf.base.PropertyList, providing a consistent way to insert a dictionary into these objects that avoids their historical idiosyncrasies.

The form in which these entries appear in the object’s native keys and values is implementation-defined. Empty nested dictionaries may be dropped, and if the top-level dictionary is empty this method may do nothing.

Neither the top-level key nor nested keys may contain . (period) characters.

Methods Summary

set_dict(key, nested)

Methods Documentation

set_dict(key: str, nested: Mapping[str, str | float | int | bool | Mapping[str, str | float | int | bool | NestedMetadataDict]]) → None