Skip to content

Translate taxon

translate_taxon

translate_taxon(
    taxonomy: CleanedTaxonomy,
) -> Translations | None

Get translations for a given taxonomy with source tracking.

Parameters:

Name Type Description Default
taxonomy CleanedTaxonomy

Cleaned taxonomy from a cleaned taxon

required

Returns:

Type Description
Translations | None

Translations | None: The translations for the specific taxon

is_translation_complete

is_translation_complete(
    translation_report: Optional[TranslationReport],
) -> TypeGuard[CompleteTranslationReport]

Check if a translation report is complete.

Parameters:

Name Type Description Default
translation_report Optional[TranslationReport]

The translation report to check.

required

Returns:

Type Description
TypeGuard[CompleteTranslationReport]

TypeGuard[CompleteTranslationReport]: True if the report is complete, False otherwise.

get_valid_translation

get_valid_translation(
    translation_report: CompleteTranslationReport,
) -> Translations

Convert a translation report to a valid translations object.

Parameters:

Name Type Description Default
translation_report CompleteTranslationReport

The translation report to convert.

required

Returns:

Name Type Description
Translations Translations

The valid translations object.