Skip to content

migrate_description_annotation

Source code in src/library_analyzer/processing/migration/annotations/_migrate_description_annotation.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
def migrate_description_annotation(
    origin_annotation: DescriptionAnnotation,
    mapping: Mapping,
) -> list[AbstractAnnotation]:
    description_annotation = deepcopy(origin_annotation)
    authors = description_annotation.authors
    authors.append(migration_author)
    description_annotation.authors = authors

    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):
            documentationv1 = (
                annotated_apiv1_element.docstring.description
                if isinstance(element, Parameter)
                else element.docstring.full_docstring
            )
            documentationv2 = (
                element.docstring.description if isinstance(element, Parameter) else element.docstring.full_docstring
            )
            if documentationv1 != documentationv2 and documentationv2 != description_annotation.newDescription:
                description_annotations.append(
                    DescriptionAnnotation(
                        element.id,
                        authors,
                        description_annotation.reviewers,
                        description_annotation.comment,
                        EnumReviewResult.UNSURE,
                        newDescription=description_annotation.newDescription,
                    ),
                )
                continue
            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