read_yaml¶
Summary¶
- read_yaml(file_path: Path) MapDescriptor¶
Reads a Map Descriptor .yaml file into a Python object.
- Parameters:
file_path (Path) – A Path object representing the .yaml file’s filename, and – if it’s in a different directory than your current shell – its relative path as well.
- Returns:
Returns a MapDescriptor file representing the data from the .yaml file.
- Return type:
Importing¶
from cs_board_tools.io.yaml import read_yaml