pyrobosim.utils.general.replace_special_yaml_tokens

pyrobosim.utils.general.replace_special_yaml_tokens(in_text, root_dir=None)

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 (str or list[str]) – Input YAML text or a list of YAML texts.

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

Returns:

YAML text(s) with all special tokens substituted.

Return type:

str or list[str]