from_yaml

method of dascore.core.inventory.Inventory source

from_yaml(
    text: str ,
)-> ‘Self’

Load an inventory from YAML text.

A loaded document is checked before it is returned: reading one asks whether it is a valid inventory, and a document which fails should fail at its source rather than as a confusing error later. Building an inventory in memory stays unchecked until check is called, so it can be assembled a piece at a time.

Parameters

Parameter Description
text YAML text. Paths — a file or an authoring directory — load
through dascore.inventory, which is
the one door every source goes through.