pyrobosim.utils.general.replace_special_yaml_tokens

pyrobosim.utils.general.replace_special_yaml_tokens(in_text: str | Path | list[str | Path], root_dir: Path | str | None = None) → Path | list[Path]

Replaces special tokens permitted in our YAML specification. If you want to add any other special tokens, you should do so in the process_text helper function.

Parameters:

• in_text – Input YAML path or a list of YAML paths.

• root_dir – Root directory for basing some tokens, uses the current directory if not specified.

Returns:

YAML text(s) with all special tokens substituted.