read_literal_mappings

read_literal_mappings(path: str | Path, *, delimiter: str | None = None, names: Mapping[Reference, str] | None = None, reference_cls: type[R] = None, show_progress: bool = False) → list[LiteralMapping][source]
read_literal_mappings(path: str | Path, *, delimiter: str | None = None, names: Mapping[Reference, str] | None = None, reference_cls: None = None, show_progress: bool = False) → list[LiteralMapping[NamableReference]]

Load literal mappings from a file.

Parameters:

  • path – A local file path or URL for a biosynonyms-flavored CSV/TSV file

  • delimiter – The delimiter for the CSV/TSV file. Defaults to tab

  • names – A pre-parsed dictionary from references (i.e., prefix-luid pairs) to default labels

  • reference_cls – The class used to parse references. E.g., swap out for pyobo.Reference to automatically do Bioregistry validation on references.

  • show_progress – Should a progress bar be shown? Defaults to false.

Returns:

A list of literal mappings parsed from the table