Skip to content

Clean taxonomy

CleaningReport

Bases: StrictModel

Represent the cleaning report model

Parameters:

Name Type Description Default
family str

Family of the taxon

required
genus str

Genus of the taxon

required
species str | None

Species of the taxon

required

clean_taxonomy

clean_taxonomy(
    taxonomy: RawTaxonomy,
) -> CleaningReport | None

Clean taxonomy using GBIF name parser.

Parameters:

Name Type Description Default
taxonomy RawTaxonomy

Raw taxonomy

required

Returns:

Type Description
CleaningReport | None

CleaningReport | None: Cleaning report

clean_name

clean_name(name: str | None) -> str | None

Clean name using GBIF name parser.

Parameters:

Name Type Description Default
name str | None

Name to clean

required

Returns:

Type Description
str | None

str | None: Cleaned name