raise_deprecation_error

glotaran.deprecation.deprecation_utils.raise_deprecation_error(*, deprecated_qual_name_usage: str, new_qual_name_usage: str, to_be_removed_in_version: str) → NoReturn

Raise GlotaranDeprectedApiError error, with formatted message.

This should only be used if there is no reasonable way to keep the deprecated usage functional!

Parameters:

• deprecated_qual_name_usage (str) – Old usage with fully qualified name e.g.: 'glotaran.read_model_from_yaml(model_yml_str)'

• new_qual_name_usage (str) – New usage as fully qualified name e.g.: 'glotaran.io.load_model(model_yml_str, format_name="yml_str")'

• to_be_removed_in_version (str) – Version the support for this usage will be removed.

Raises:

• OverDueDeprecation – If the current version is greater or equal to to_be_removed_in_version.

• GlotaranDeprecatedApiError – If OverDueDeprecation wasn’t raised before.