Skip to content

AnnotationStore

Source code in src/library_analyzer/processing/annotations/model/_annotation_store.py 
 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
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
@dataclass
class AnnotationStore:
    boundaryAnnotations: list[BoundaryAnnotation] = field(default_factory=list)  # noqa: N815
    calledAfterAnnotations: list[CalledAfterAnnotation] = field(default_factory=list)  # noqa: N815
    completeAnnotations: list[CompleteAnnotation] = field(default_factory=list)  # noqa: N815
    dependencyAnnotations: list[DependencyAnnotation] = field(default_factory=list)  # noqa: N815
    descriptionAnnotations: list[DescriptionAnnotation] = field(default_factory=list)  # noqa: N815
    enumAnnotations: list[EnumAnnotation] = field(default_factory=list)  # noqa: N815
    expertAnnotations: list[ExpertAnnotation] = field(default_factory=list)  # noqa: N815
    groupAnnotations: list[GroupAnnotation] = field(default_factory=list)  # noqa: N815
    moveAnnotations: list[MoveAnnotation] = field(default_factory=list)  # noqa: N815
    pureAnnotations: list[PureAnnotation] = field(default_factory=list)  # noqa: N815
    removeAnnotations: list[RemoveAnnotation] = field(default_factory=list)  # noqa: N815
    renameAnnotations: list[RenameAnnotation] = field(default_factory=list)  # noqa: N815
    todoAnnotations: list[TodoAnnotation] = field(default_factory=list)  # noqa: N815
    valueAnnotations: list[ValueAnnotation] = field(default_factory=list)  # noqa: N815

    @staticmethod
    def from_json_file(path: Path) -> AnnotationStore:
        with path.open(encoding="utf-8") as annotations_file:
            annotations_json = json.load(annotations_file)

        return AnnotationStore.from_dict(annotations_json)

    @staticmethod
    def from_dict(d: dict[str, Any]) -> AnnotationStore:
        if d["schemaVersion"] == 1:
            raise ValueError("Incompatible Annotation File: This file is not compatible with the current version.")

        boundary_annotations = []
        for annotation in d["boundaryAnnotations"].values():
            boundary_annotations.append(BoundaryAnnotation.from_dict(annotation))

        called_after_annotations = []
        for annotation in d["calledAfterAnnotations"].values():
            called_after_annotations.append(CalledAfterAnnotation.from_dict(annotation))

        complete_annotations = []
        for annotation in d["completeAnnotations"].values():
            complete_annotations.append(CompleteAnnotation.from_dict(annotation))

        dependency_annotations = []
        for annotation in d["dependencyAnnotations"].values():
            dependency_annotations.append(DependencyAnnotation.from_dict(annotation))

        description_annotations = []
        for annotation in d["descriptionAnnotations"].values():
            description_annotations.append(DescriptionAnnotation.from_dict(annotation))

        enum_annotations = []
        for annotation in d["enumAnnotations"].values():
            enum_annotations.append(EnumAnnotation.from_dict(annotation))

        expert_annotations = []
        for annotation in d["expertAnnotations"].values():
            expert_annotations.append(ExpertAnnotation.from_dict(annotation))

        group_annotations = []
        for annotation in d["groupAnnotations"].values():
            group_annotations.append(GroupAnnotation.from_dict(annotation))

        move_annotations = []
        for annotation in d["moveAnnotations"].values():
            move_annotations.append(MoveAnnotation.from_dict(annotation))

        pure_annotations = []
        for annotation in d["pureAnnotations"].values():
            pure_annotations.append(PureAnnotation.from_dict(annotation))

        remove_annotations = []
        for annotation in d["removeAnnotations"].values():
            remove_annotations.append(RemoveAnnotation.from_dict(annotation))

        rename_annotations = []
        for annotation in d["renameAnnotations"].values():
            rename_annotations.append(RenameAnnotation.from_dict(annotation))

        todo_annotations = []
        for annotation in d["todoAnnotations"].values():
            todo_annotations.append(TodoAnnotation.from_dict(annotation))

        value_annotations = []
        for annotation in d["valueAnnotations"].values():
            value_annotations.append(ValueAnnotation.from_dict(annotation))

        return AnnotationStore(
            boundary_annotations,
            called_after_annotations,
            complete_annotations,
            dependency_annotations,
            description_annotations,
            enum_annotations,
            expert_annotations,
            group_annotations,
            move_annotations,
            pure_annotations,
            remove_annotations,
            rename_annotations,
            todo_annotations,
            value_annotations,
        )

    def add_annotation(self, annotation: AbstractAnnotation) -> None:
        if isinstance(annotation, BoundaryAnnotation):
            self.boundaryAnnotations.append(annotation)
        elif isinstance(annotation, CalledAfterAnnotation):
            self.calledAfterAnnotations.append(annotation)
        elif isinstance(annotation, CompleteAnnotation):
            self.completeAnnotations.append(annotation)
        elif isinstance(annotation, DependencyAnnotation):
            self.dependencyAnnotations.append(annotation)
        elif isinstance(annotation, DescriptionAnnotation):
            self.descriptionAnnotations.append(annotation)
        elif isinstance(annotation, EnumAnnotation):
            self.enumAnnotations.append(annotation)
        elif isinstance(annotation, ExpertAnnotation):
            self.expertAnnotations.append(annotation)
        elif isinstance(annotation, GroupAnnotation):
            self.groupAnnotations.append(annotation)
        elif isinstance(annotation, MoveAnnotation):
            self.moveAnnotations.append(annotation)
        elif isinstance(annotation, PureAnnotation):
            self.pureAnnotations.append(annotation)
        elif isinstance(annotation, RemoveAnnotation):
            self.removeAnnotations.append(annotation)
        elif isinstance(annotation, RenameAnnotation):
            self.renameAnnotations.append(annotation)
        elif isinstance(annotation, TodoAnnotation):
            self.todoAnnotations.append(annotation)
        elif isinstance(annotation, ValueAnnotation):
            self.valueAnnotations.append(annotation)

    def to_json_file(self, path: Path) -> None:
        ensure_file_exists(path)
        with path.open("w", encoding="utf-8") as f:
            json.dump(self.to_dict(), f, indent=2)

    def to_dict(self) -> dict:
        return {
            "schemaVersion": ANNOTATION_SCHEMA_VERSION,
            "boundaryAnnotations": {annotation.target: annotation.to_dict() for annotation in self.boundaryAnnotations},
            "calledAfterAnnotations": {
                annotation.target: annotation.to_dict() for annotation in self.calledAfterAnnotations
            },
            "completeAnnotations": {annotation.target: annotation.to_dict() for annotation in self.completeAnnotations},
            "dependencyAnnotations": {
                annotation.target: annotation.to_dict() for annotation in self.dependencyAnnotations
            },
            "descriptionAnnotations": {
                annotation.target: annotation.to_dict() for annotation in self.descriptionAnnotations
            },
            "enumAnnotations": {annotation.target: annotation.to_dict() for annotation in self.enumAnnotations},
            "expertAnnotations": {annotation.target: annotation.to_dict() for annotation in self.expertAnnotations},
            "groupAnnotations": {annotation.target: annotation.to_dict() for annotation in self.groupAnnotations},
            "moveAnnotations": {annotation.target: annotation.to_dict() for annotation in self.moveAnnotations},
            "pureAnnotations": {annotation.target: annotation.to_dict() for annotation in self.pureAnnotations},
            "renameAnnotations": {annotation.target: annotation.to_dict() for annotation in self.renameAnnotations},
            "removeAnnotations": {annotation.target: annotation.to_dict() for annotation in self.removeAnnotations},
            "todoAnnotations": {annotation.target: annotation.to_dict() for annotation in self.todoAnnotations},
            "valueAnnotations": {annotation.target: annotation.to_dict() for annotation in self.valueAnnotations},
        }

boundaryAnnotations: list[BoundaryAnnotation] = field(default_factory=list) class-attribute instance-attribute

calledAfterAnnotations: list[CalledAfterAnnotation] = field(default_factory=list) class-attribute instance-attribute

completeAnnotations: list[CompleteAnnotation] = field(default_factory=list) class-attribute instance-attribute

dependencyAnnotations: list[DependencyAnnotation] = field(default_factory=list) class-attribute instance-attribute

descriptionAnnotations: list[DescriptionAnnotation] = field(default_factory=list) class-attribute instance-attribute

enumAnnotations: list[EnumAnnotation] = field(default_factory=list) class-attribute instance-attribute

expertAnnotations: list[ExpertAnnotation] = field(default_factory=list) class-attribute instance-attribute

groupAnnotations: list[GroupAnnotation] = field(default_factory=list) class-attribute instance-attribute

moveAnnotations: list[MoveAnnotation] = field(default_factory=list) class-attribute instance-attribute

pureAnnotations: list[PureAnnotation] = field(default_factory=list) class-attribute instance-attribute

removeAnnotations: list[RemoveAnnotation] = field(default_factory=list) class-attribute instance-attribute

renameAnnotations: list[RenameAnnotation] = field(default_factory=list) class-attribute instance-attribute

todoAnnotations: list[TodoAnnotation] = field(default_factory=list) class-attribute instance-attribute

valueAnnotations: list[ValueAnnotation] = field(default_factory=list) class-attribute instance-attribute

__init__(boundaryAnnotations=list(), calledAfterAnnotations=list(), completeAnnotations=list(), dependencyAnnotations=list(), descriptionAnnotations=list(), enumAnnotations=list(), expertAnnotations=list(), groupAnnotations=list(), moveAnnotations=list(), pureAnnotations=list(), removeAnnotations=list(), renameAnnotations=list(), todoAnnotations=list(), valueAnnotations=list())

add_annotation(annotation)

Source code in src/library_analyzer/processing/annotations/model/_annotation_store.py 
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
def add_annotation(self, annotation: AbstractAnnotation) -> None:
    if isinstance(annotation, BoundaryAnnotation):
        self.boundaryAnnotations.append(annotation)
    elif isinstance(annotation, CalledAfterAnnotation):
        self.calledAfterAnnotations.append(annotation)
    elif isinstance(annotation, CompleteAnnotation):
        self.completeAnnotations.append(annotation)
    elif isinstance(annotation, DependencyAnnotation):
        self.dependencyAnnotations.append(annotation)
    elif isinstance(annotation, DescriptionAnnotation):
        self.descriptionAnnotations.append(annotation)
    elif isinstance(annotation, EnumAnnotation):
        self.enumAnnotations.append(annotation)
    elif isinstance(annotation, ExpertAnnotation):
        self.expertAnnotations.append(annotation)
    elif isinstance(annotation, GroupAnnotation):
        self.groupAnnotations.append(annotation)
    elif isinstance(annotation, MoveAnnotation):
        self.moveAnnotations.append(annotation)
    elif isinstance(annotation, PureAnnotation):
        self.pureAnnotations.append(annotation)
    elif isinstance(annotation, RemoveAnnotation):
        self.removeAnnotations.append(annotation)
    elif isinstance(annotation, RenameAnnotation):
        self.renameAnnotations.append(annotation)
    elif isinstance(annotation, TodoAnnotation):
        self.todoAnnotations.append(annotation)
    elif isinstance(annotation, ValueAnnotation):
        self.valueAnnotations.append(annotation)

from_dict(d) staticmethod

Source code in src/library_analyzer/processing/annotations/model/_annotation_store.py 
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
@staticmethod
def from_dict(d: dict[str, Any]) -> AnnotationStore:
    if d["schemaVersion"] == 1:
        raise ValueError("Incompatible Annotation File: This file is not compatible with the current version.")

    boundary_annotations = []
    for annotation in d["boundaryAnnotations"].values():
        boundary_annotations.append(BoundaryAnnotation.from_dict(annotation))

    called_after_annotations = []
    for annotation in d["calledAfterAnnotations"].values():
        called_after_annotations.append(CalledAfterAnnotation.from_dict(annotation))

    complete_annotations = []
    for annotation in d["completeAnnotations"].values():
        complete_annotations.append(CompleteAnnotation.from_dict(annotation))

    dependency_annotations = []
    for annotation in d["dependencyAnnotations"].values():
        dependency_annotations.append(DependencyAnnotation.from_dict(annotation))

    description_annotations = []
    for annotation in d["descriptionAnnotations"].values():
        description_annotations.append(DescriptionAnnotation.from_dict(annotation))

    enum_annotations = []
    for annotation in d["enumAnnotations"].values():
        enum_annotations.append(EnumAnnotation.from_dict(annotation))

    expert_annotations = []
    for annotation in d["expertAnnotations"].values():
        expert_annotations.append(ExpertAnnotation.from_dict(annotation))

    group_annotations = []
    for annotation in d["groupAnnotations"].values():
        group_annotations.append(GroupAnnotation.from_dict(annotation))

    move_annotations = []
    for annotation in d["moveAnnotations"].values():
        move_annotations.append(MoveAnnotation.from_dict(annotation))

    pure_annotations = []
    for annotation in d["pureAnnotations"].values():
        pure_annotations.append(PureAnnotation.from_dict(annotation))

    remove_annotations = []
    for annotation in d["removeAnnotations"].values():
        remove_annotations.append(RemoveAnnotation.from_dict(annotation))

    rename_annotations = []
    for annotation in d["renameAnnotations"].values():
        rename_annotations.append(RenameAnnotation.from_dict(annotation))

    todo_annotations = []
    for annotation in d["todoAnnotations"].values():
        todo_annotations.append(TodoAnnotation.from_dict(annotation))

    value_annotations = []
    for annotation in d["valueAnnotations"].values():
        value_annotations.append(ValueAnnotation.from_dict(annotation))

    return AnnotationStore(
        boundary_annotations,
        called_after_annotations,
        complete_annotations,
        dependency_annotations,
        description_annotations,
        enum_annotations,
        expert_annotations,
        group_annotations,
        move_annotations,
        pure_annotations,
        remove_annotations,
        rename_annotations,
        todo_annotations,
        value_annotations,
    )

from_json_file(path) staticmethod

Source code in src/library_analyzer/processing/annotations/model/_annotation_store.py 
49
50
51
52
53
54
@staticmethod
def from_json_file(path: Path) -> AnnotationStore:
    with path.open(encoding="utf-8") as annotations_file:
        annotations_json = json.load(annotations_file)

    return AnnotationStore.from_dict(annotations_json)

to_dict()

Source code in src/library_analyzer/processing/annotations/model/_annotation_store.py 
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
def to_dict(self) -> dict:
    return {
        "schemaVersion": ANNOTATION_SCHEMA_VERSION,
        "boundaryAnnotations": {annotation.target: annotation.to_dict() for annotation in self.boundaryAnnotations},
        "calledAfterAnnotations": {
            annotation.target: annotation.to_dict() for annotation in self.calledAfterAnnotations
        },
        "completeAnnotations": {annotation.target: annotation.to_dict() for annotation in self.completeAnnotations},
        "dependencyAnnotations": {
            annotation.target: annotation.to_dict() for annotation in self.dependencyAnnotations
        },
        "descriptionAnnotations": {
            annotation.target: annotation.to_dict() for annotation in self.descriptionAnnotations
        },
        "enumAnnotations": {annotation.target: annotation.to_dict() for annotation in self.enumAnnotations},
        "expertAnnotations": {annotation.target: annotation.to_dict() for annotation in self.expertAnnotations},
        "groupAnnotations": {annotation.target: annotation.to_dict() for annotation in self.groupAnnotations},
        "moveAnnotations": {annotation.target: annotation.to_dict() for annotation in self.moveAnnotations},
        "pureAnnotations": {annotation.target: annotation.to_dict() for annotation in self.pureAnnotations},
        "renameAnnotations": {annotation.target: annotation.to_dict() for annotation in self.renameAnnotations},
        "removeAnnotations": {annotation.target: annotation.to_dict() for annotation in self.removeAnnotations},
        "todoAnnotations": {annotation.target: annotation.to_dict() for annotation in self.todoAnnotations},
        "valueAnnotations": {annotation.target: annotation.to_dict() for annotation in self.valueAnnotations},
    }

to_json_file(path)

Source code in src/library_analyzer/processing/annotations/model/_annotation_store.py 
164
165
166
167
def to_json_file(self, path: Path) -> None:
    ensure_file_exists(path)
    with path.open("w", encoding="utf-8") as f:
        json.dump(self.to_dict(), f, indent=2)