OptionalAnnotation

Bases: ValueAnnotation

Source code in src/library_analyzer/processing/annotations/model/_annotations.py

@dataclass
class OptionalAnnotation(ValueAnnotation):
    variant = ValueAnnotation.Variant.OPTIONAL
    defaultValueType: ValueAnnotation.DefaultValueType  # noqa: N815
    defaultValue: Any  # noqa: N815

    @staticmethod
    def from_dict(d: dict[str, Any]) -> OptionalAnnotation:
        annotation = AbstractAnnotation.from_dict(d)
        return OptionalAnnotation(
            annotation.target,
            annotation.authors,
            annotation.reviewers,
            annotation.comment,
            annotation.reviewResult,
            ValueAnnotation.DefaultValueType(d["defaultValueType"]),
            d["defaultValue"],
        )

    def to_dict(self) -> dict[str, Any]:
        return {
            "target": self.target,
            "authors": self.authors,
            "reviewers": self.reviewers,
            "comment": self.comment,
            "reviewResult": self.reviewResult.value,
            "variant": self.variant.value,
            "defaultValueType": self.defaultValueType.value,
            "defaultValue": self.defaultValue,
        }

defaultValue: Any instance-attribute

defaultValueType: ValueAnnotation.DefaultValueType instance-attribute

variant = ValueAnnotation.Variant.OPTIONAL class-attribute instance-attribute

__init__(target, authors, reviewers, comment, reviewResult, defaultValueType, defaultValue)

from_dict(d) staticmethod

Source code in src/library_analyzer/processing/annotations/model/_annotations.py

@staticmethod
def from_dict(d: dict[str, Any]) -> OptionalAnnotation:
    annotation = AbstractAnnotation.from_dict(d)
    return OptionalAnnotation(
        annotation.target,
        annotation.authors,
        annotation.reviewers,
        annotation.comment,
        annotation.reviewResult,
        ValueAnnotation.DefaultValueType(d["defaultValueType"]),
        d["defaultValue"],
    )

to_dict()

Source code in src/library_analyzer/processing/annotations/model/_annotations.py

def to_dict(self) -> dict[str, Any]:
    return {
        "target": self.target,
        "authors": self.authors,
        "reviewers": self.reviewers,
        "comment": self.comment,
        "reviewResult": self.reviewResult.value,
        "variant": self.variant.value,
        "defaultValueType": self.defaultValueType.value,
        "defaultValue": self.defaultValue,
    }