ValueAnnotation

Bases: AbstractAnnotation, ABC

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

class ValueAnnotation(AbstractAnnotation, ABC):
    class Variant(Enum):
        CONSTANT = "constant"
        OMITTED = "omitted"
        OPTIONAL = "optional"
        REQUIRED = "required"

    class DefaultValueType(Enum):
        BOOLEAN = "boolean"
        NONE = "none"
        NUMBER = "number"
        STRING = "string"

    variant: Variant

    @staticmethod
    def from_dict(d: dict[str, Any]) -> ValueAnnotation:
        variant = d["variant"]
        if ValueAnnotation.Variant.CONSTANT.value == variant:
            return ConstantAnnotation.from_dict(d)
        if ValueAnnotation.Variant.OMITTED.value == variant:
            return OmittedAnnotation.from_dict(d)
        if ValueAnnotation.Variant.OPTIONAL.value == variant:
            return OptionalAnnotation.from_dict(d)
        if ValueAnnotation.Variant.REQUIRED.value == variant:
            return RequiredAnnotation.from_dict(d)
        raise KeyError("unkonwn variant found")

variant: Variant instance-attribute

DefaultValueType

Bases: Enum

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

class DefaultValueType(Enum):
    BOOLEAN = "boolean"
    NONE = "none"
    NUMBER = "number"
    STRING = "string"

BOOLEAN = 'boolean' class-attribute instance-attribute

NONE = 'none' class-attribute instance-attribute

NUMBER = 'number' class-attribute instance-attribute

STRING = 'string' class-attribute instance-attribute

Variant

Bases: Enum

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

class Variant(Enum):
    CONSTANT = "constant"
    OMITTED = "omitted"
    OPTIONAL = "optional"
    REQUIRED = "required"

CONSTANT = 'constant' class-attribute instance-attribute

OMITTED = 'omitted' class-attribute instance-attribute

OPTIONAL = 'optional' class-attribute instance-attribute

REQUIRED = 'required' class-attribute instance-attribute

from_dict(d) staticmethod

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

@staticmethod
def from_dict(d: dict[str, Any]) -> ValueAnnotation:
    variant = d["variant"]
    if ValueAnnotation.Variant.CONSTANT.value == variant:
        return ConstantAnnotation.from_dict(d)
    if ValueAnnotation.Variant.OMITTED.value == variant:
        return OmittedAnnotation.from_dict(d)
    if ValueAnnotation.Variant.OPTIONAL.value == variant:
        return OptionalAnnotation.from_dict(d)
    if ValueAnnotation.Variant.REQUIRED.value == variant:
        return RequiredAnnotation.from_dict(d)
    raise KeyError("unkonwn variant found")