Skip to content

migrate_description_annotation

Source code in library_analyzer/processing/migration/annotations/_migrate_description_annotation.py
def migrate_description_annotation(
    description_annotation: DescriptionAnnotation, mapping: Mapping
) -> list[AbstractAnnotation]:
    description_annotation = deepcopy(description_annotation)
    authors = description_annotation.authors
    authors.append(migration_author)
    description_annotation.authors = authors

    if isinstance(mapping, (ManyToOneMapping, OneToOneMapping)):
        element = mapping.get_apiv2_elements()[0]
        if isinstance(element, (Attribute, Result)):
            return []
        description_annotation.target = element.id
        return [description_annotation]

    annotated_apiv1_element = get_annotated_api_element(
        description_annotation, mapping.get_apiv1_elements()
    )
    if annotated_apiv1_element is None:
        return []

    description_annotations: list[AbstractAnnotation] = []
    for element in mapping.get_apiv2_elements():
        if isinstance(element, type(annotated_apiv1_element)) and not isinstance(
            element, (Attribute, Result)
        ):
            description_annotations.append(
                DescriptionAnnotation(
                    element.id,
                    authors,
                    description_annotation.reviewers,
                    description_annotation.comment,
                    EnumReviewResult.NONE,
                    newDescription=description_annotation.newDescription,
                )
            )
        elif not isinstance(element, (Attribute, Result)):
            description_annotations.append(
                TodoAnnotation(
                    element.id,
                    authors,
                    description_annotation.reviewers,
                    description_annotation.comment,
                    EnumReviewResult.NONE,
                    get_migration_text(
                        description_annotation, mapping, for_todo_annotation=True
                    ),
                )
            )
    return description_annotations