parse_iri

parse_iri(iri: str, *, use_preferred: bool = False, on_failure_return_type: Literal[FailureReturnType.pair] = FailureReturnType.pair) → ReferenceTuple | tuple[None, None][source]
parse_iri(iri: str, *, use_preferred: bool = False, on_failure_return_type: Literal[FailureReturnType.single]) → ReferenceTuple | None

Parse a compact identifier from an IRI that wraps Manager.parse_uri().

Parameters:

  • iri – A valid IRI

  • use_preferred – If set to true, uses the “preferred prefix”, if available, instead of the canonicalized Bioregistry prefix.

  • on_failure_return_type – whether to return a single None or a pair of None’s

Returns:

A pair of prefix/identifier, if can be parsed

Raises:

TypeError – if an invalid on_failure_return_type is given