#! /usr/bin/env python3
#
# This file was auto-generated by shacl2code 1.0.0. DO NOT MANUALLY MODIFY IT
#
# SPDX-License-Identifier: MIT
"""Generated Python bindings from a SHACL model"""

from __future__ import annotations

import decimal
import functools
import hashlib
import json
import re
import sys
import threading
import time
import warnings
from abc import ABC, abstractmethod
from contextlib import contextmanager
from dataclasses import dataclass
from datetime import datetime, timedelta, timezone
from enum import Enum
from typing import Generic, TYPE_CHECKING, TypeVar, Union, cast, overload

if TYPE_CHECKING:
    from typing import (
        Any,
        BinaryIO,
        Callable,
        Dict,
        Iterable,
        Iterator,
        List,
        Optional,
        Set,
        Tuple,
        Type,
    )

T_PropV = TypeVar("T_PropV")


def check_type(obj: Any, types: Union[Type[Any], Tuple[Type[Any], ...]]) -> None:
    """Check if an object is an instance of a type or one of types.
    Raise a TypeError if not."""
    if not isinstance(obj, types):
        if isinstance(types, (list, tuple)):
            raise TypeError(
                f"Value must be one of type: {', '.join(t.__name__ for t in types)}. Got {type(obj).__name__}"
            )
        raise TypeError(
            f"Value must be of type {types.__name__}. Got {type(obj).__name__}"
        )


class Property(ABC, Generic[T_PropV]):
    """
    A generic SHACL object property. The different types will derive from this
    class
    """

    VALID_TYPES: Union[Type[Any], Tuple[Type[Any], ...]] = ()

    __slots__ = ("pattern",)

    def __init__(self, *, pattern: Optional[str] = None) -> None:
        self.pattern = pattern

    def init(self) -> Optional[T_PropV]:
        return None

    def validate(self, value: Any) -> None:
        check_type(value, self.VALID_TYPES)
        if self.pattern is not None and not re.search(
            self.pattern, self.to_string(value)
        ):
            raise ValueError(
                f"Value is not correctly formatted. Got '{self.to_string(value)}'"
            )

    def set(self, value: Any) -> T_PropV:
        return cast(T_PropV, value)

    def check_min_count(self, value: T_PropV, min_count: int) -> bool:
        return min_count == 1

    def check_max_count(self, value: T_PropV, max_count: int) -> bool:
        return max_count == 1

    def elide(self, value: T_PropV) -> bool:
        return value is None

    def walk(
        self,
        value: T_PropV,
        callback: Callable[[Any, List[str]], bool],
        path: List[str],
    ) -> None:
        callback(value, path)

    def iter_objects(
        self, value: Optional[T_PropV], recursive: bool, visited: Set["SHACLObject"]
    ) -> Iterable["SHACLObject"]:
        return []

    def link_prop(
        self,
        value: Optional[T_PropV],
        objectset: "SHACLObjectSet",
        missing: Optional[Set[str]],
        visited: Set["SHACLObject"],
    ) -> Optional[T_PropV]:
        return value

    def to_string(self, value: T_PropV) -> str:
        return str(value)

    @abstractmethod
    def encode(self, encoder: "Encoder", value: T_PropV, state: "EncodeState") -> None:
        raise NotImplementedError("Subclasses must implement encode method")

    @abstractmethod
    def decode(self, decoder: "Decoder", state: "DecodeState") -> Optional[T_PropV]:
        raise NotImplementedError("Subclasses must implement decode method")


class StringProp(Property[str]):
    """
    A scalar string property for an SHACL object
    """

    VALID_TYPES = str

    def set(self, value: Any) -> str:
        return str(value)

    def encode(self, encoder: Encoder, value: str, state: EncodeState) -> None:
        encoder.write_string(value)

    def decode(self, decoder: Decoder, state: DecodeState) -> Optional[str]:
        return decoder.read_string()


class AnyURIProp(StringProp):
    """A string property whose value is encoded as an IRI rather than a plain string."""

    def encode(self, encoder: Encoder, value: str, state: EncodeState) -> None:
        encoder.write_iri(value)

    def decode(self, decoder: Decoder, state: DecodeState) -> Optional[str]:
        return decoder.read_iri()


class DateTimeProp(Property[datetime]):
    """
    A Date/Time Object with optional timezone
    """

    VALID_TYPES = datetime
    UTC_FORMAT_STR = "%Y-%m-%dT%H:%M:%SZ"
    REGEX = r"^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2})?$"

    __slots__ = ()

    def set(self, value: datetime) -> datetime:
        return self._normalize(value)

    def encode(self, encoder: Encoder, value: datetime, state: EncodeState) -> None:
        encoder.write_datetime(self.to_string(value))

    def decode(self, decoder: Decoder, state: DecodeState) -> Optional[datetime]:
        s = decoder.read_datetime()
        if s is None:
            return None
        if isinstance(s, datetime):
            return self._normalize(s)
        v = self.from_string(s)
        return self._normalize(v)

    def _normalize(self, value: datetime) -> datetime:
        if value.utcoffset() is None:
            value = value.astimezone()

        # Remove seconds from timezone offset
        offset = value.utcoffset()
        if offset is not None:
            seconds = offset % timedelta(
                minutes=-1 if offset.total_seconds() < 0 else 1
            )
            if seconds:
                offset = offset - seconds
                value = value.replace(tzinfo=timezone(offset))

        # Convert 00:00 timezone offset to UTC
        offset = value.utcoffset()
        if offset is not None and offset.seconds == 0:
            value = value.astimezone(timezone.utc)

        value = value.replace(microsecond=0)
        return value

    def to_string(self, value: datetime) -> str:
        value = self._normalize(value)
        if value.tzinfo == timezone.utc:
            return value.strftime(self.UTC_FORMAT_STR)
        return value.isoformat()

    def from_string(self, value: str) -> datetime:
        if not re.match(self.REGEX, value):
            raise ValueError(f"'{value}' is not a correctly formatted datetime")
        if "Z" in value:
            d = datetime(
                *(time.strptime(value, self.UTC_FORMAT_STR)[0:6]),
                tzinfo=timezone.utc,
            )
        else:
            d = datetime.fromisoformat(value)

        return self._normalize(d)


class DateTimeStampProp(DateTimeProp):
    """
    A Date/Time Object with required timestamp
    """

    REGEX = r"^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2})$"

    __slots__ = ()


class IntegerProp(Property[int]):
    """A scalar integer property for a SHACL object."""

    VALID_TYPES = int

    __slots__ = ()

    def set(self, value: Any) -> int:
        return int(value)

    def encode(self, encoder: Encoder, value: int, state: EncodeState) -> None:
        encoder.write_integer(value)

    def decode(self, decoder: Decoder, state: DecodeState) -> Optional[int]:
        return decoder.read_integer()


class PositiveIntegerProp(IntegerProp):
    """An integer property that enforces a minimum value of 1."""

    __slots__ = ()

    def validate(self, value: Any) -> None:
        super().validate(value)
        if value < 1:
            raise ValueError(f"Value must be >= 1. Got {value}")


class NonNegativeIntegerProp(IntegerProp):
    """An integer property that enforces a minimum value of 0."""

    __slots__ = ()

    def validate(self, value: Any) -> None:
        super().validate(value)
        if value < 0:
            raise ValueError(f"Value must be >= 0. Got {value}")


class BooleanProp(Property[bool]):
    """A scalar boolean property for a SHACL object."""

    VALID_TYPES = bool

    __slots__ = ()

    def set(self, value: Any) -> bool:
        return bool(value)

    def encode(self, encoder: Encoder, value: bool, state: EncodeState) -> None:
        encoder.write_bool(value)

    def decode(self, decoder: Decoder, state: DecodeState) -> Optional[bool]:
        return decoder.read_bool()


class FloatProp(Property[float]):
    """A scalar floating-point property for a SHACL object."""

    VALID_TYPES = (float, int)

    __slots__ = ()

    def set(self, value: Any) -> float:
        return float(value)

    def encode(
        self, encoder: Encoder, value: Union[float, int], state: EncodeState
    ) -> None:
        encoder.write_float(value)

    def decode(self, decoder: Decoder, state: DecodeState) -> Optional[float]:
        return decoder.read_float()


class IRIProp(Property[T_PropV]):
    """A property that holds IRI values with an optional context for compaction and expansion."""

    __slots__ = ("context",)

    def __init__(
        self,
        context: Optional[Tuple[Tuple[str, str], ...]] = None,
        *,
        pattern: Optional[str] = None,
    ) -> None:
        if context is None:
            context = ()
        super().__init__(pattern=pattern)
        self.context = context

    def compact(self, value: str, dflt: Optional[str] = None) -> Optional[str]:
        """Return the compact alias for the given IRI, or dflt if not found in context."""
        for iri, compact in self.context:
            if value == iri:
                return compact
        return dflt

    def expand(self, value: str, dflt: Optional[str] = None) -> Optional[str]:
        """Return the full IRI for the given compact alias, or dflt if not found in context."""
        for iri, compact in self.context:
            if value == compact:
                return iri
        return dflt

    def iri_values(self) -> Iterator[str]:
        """Iterate over all full IRI values defined in the context."""
        return (iri for iri, _ in self.context)


class ObjectProp(IRIProp[Union[str, "SHACLObject"]]):
    """
    A scalar SHACL object property of a SHACL object
    """

    __slots__ = ("cls", "required")

    def __init__(
        self,
        cls: Type["SHACLObject"],
        required: bool,
        context: Optional[Tuple[Tuple[str, str], ...]] = None,
    ):
        super().__init__(context)
        self.cls = cls
        self.required = required

    def validate(self, value: Any) -> None:
        check_type(value, (self.cls, str))

    def set(self, value: Any) -> Union[str, "SHACLObject"]:
        if isinstance(value, SHACLObject):
            return value
        return str(value)

    def walk(
        self,
        value: Optional[Union[str, "SHACLObject"]],
        callback: Callable[[Any, List[str]], bool],
        path: List[str],
    ) -> None:
        if value is None:
            return

        if not isinstance(value, str):
            value.walk(callback, path)
        else:
            callback(value, path)

    def iter_objects(
        self,
        value: Optional[Union[str, "SHACLObject"]],
        recursive: bool,
        visited: Set["SHACLObject"],
    ) -> Iterable["SHACLObject"]:
        if value is None or isinstance(value, str):
            return

        if value not in visited:
            visited.add(value)
            yield value

            if recursive:
                for c in value.iter_objects(recursive=True, visited=visited):
                    yield c

    def encode(
        self, encoder: Encoder, value: Union[str, "SHACLObject"], state: EncodeState
    ) -> None:
        if value is None:
            raise ValueError("Object cannot be None")

        if isinstance(value, str):
            encoder.write_iri(value, self.compact(value) or state.compact_iri(value))
            return

        return value.encode(encoder, state)

    def decode(self, decoder: Decoder, state: DecodeState) -> Union[str, "SHACLObject"]:
        if decoder.is_object():
            return self.cls.decode(decoder, state)

        iri = decoder.read_iri()
        if iri is None:
            raise TypeError("IRI cannot be None")

        iri = self.expand(iri) or state.expand_iri(iri) or iri

        if state.objectset is None:
            return iri

        obj = state.objectset.find_by_id(iri)
        if obj is None:
            return iri

        self.validate(obj)
        return obj

    def link_prop(
        self,
        value: Optional[Union[str, "SHACLObject"]],
        objectset: "SHACLObjectSet",
        missing: Optional[Set[str]],
        visited: Set["SHACLObject"],
    ) -> Optional[Union[str, "SHACLObject"]]:
        if value is None:
            return value

        if isinstance(value, str):
            o = objectset.find_by_id(value)
            if o is not None:
                self.validate(o)
                return o

            if missing is not None:
                missing.add(value)

            return value

        # De-duplicate IDs
        if value._id:
            # Since value must be a SHACLObject at this point,
            # find_by_id will always return a SHACLObject because we pass value as default.
            # So we can safely cast here to allow subsequent value.link_helper call to work.
            value = cast("SHACLObject", objectset.find_by_id(value._id, value))
            self.validate(value)

        value.link_helper(objectset, missing, visited)
        return value


class ListProxy(Generic[T_PropV]):
    """A type-checked, property-aware list wrapper for multi-valued SHACL properties."""

    __slots__ = ("_data", "_prop")

    def __init__(
        self, prop: Property[T_PropV], data: Optional[List[T_PropV]] = None
    ) -> None:
        if data is None:
            self._data: List[T_PropV] = []
        else:
            self._data = data
        self._prop: Property[T_PropV] = prop

    def append(self, value: T_PropV) -> None:
        self._prop.validate(value)
        self._data.append(self._prop.set(value))

    def insert(self, idx: int, value: T_PropV) -> None:
        self._prop.validate(value)
        self._data.insert(idx, self._prop.set(value))

    def extend(self, items: Iterable[T_PropV]) -> None:
        for i in items:
            self.append(i)

    def sort(self, *args: Any, **kwargs: Any) -> None:
        self._data.sort(*args, **kwargs)

    @overload
    def __getitem__(self, key: int) -> T_PropV: ...

    @overload
    def __getitem__(self, key: slice) -> List[T_PropV]: ...

    def __getitem__(self, key: Union[int, slice]) -> Union[T_PropV, List[T_PropV]]:
        return self._data[key]

    @overload
    def __setitem__(self, key: int, value: T_PropV) -> None: ...

    @overload
    def __setitem__(self, key: slice, value: Iterable[T_PropV]) -> None: ...

    def __setitem__(
        self, key: Union[int, slice], value: Union[T_PropV, Iterable[T_PropV]]
    ) -> None:
        if isinstance(key, slice):
            val_iter = cast(Iterable[T_PropV], value)
            for v in val_iter:
                self._prop.validate(v)
            self._data[key] = [self._prop.set(v) for v in val_iter]
        elif isinstance(key, int):
            self._prop.validate(value)
            self._data[key] = self._prop.set(value)
        else:
            raise TypeError(
                f"ListProxy indices must be integers or slices. Got {type(key).__name__}"
            )

    def __delitem__(self, key: Union[int, slice]) -> None:
        del self._data[key]

    def __contains__(self, item: Any) -> bool:
        return item in self._data

    def __iter__(self) -> Iterator[T_PropV]:
        return iter(self._data)

    def __len__(self) -> int:
        return len(self._data)

    def __str__(self) -> str:
        return str(self._data)

    def __repr__(self) -> str:
        return repr(self._data)

    def __eq__(self, other: Any) -> bool:
        if isinstance(other, ListProxy):
            return self._data == other._data

        return self._data == other


class ListProp(Property[ListProxy[T_PropV]]):
    """
    A list of SHACL properties
    """

    VALID_TYPES = (list, ListProxy)

    __slots__ = ("prop",)

    def __init__(self, prop: Property[T_PropV]) -> None:
        super().__init__()
        self.prop = prop

    def init(self) -> ListProxy[T_PropV]:
        return ListProxy(self.prop)

    def validate(self, value: Any) -> None:
        super().validate(value)

        for i in value:
            self.prop.validate(i)

    def set(
        self,
        value: Union[ListProxy[T_PropV], Iterable[T_PropV]],
    ) -> ListProxy[T_PropV]:
        if isinstance(value, ListProxy):
            return value

        return ListProxy(self.prop, [self.prop.set(d) for d in value])

    def check_min_count(self, value: ListProxy[T_PropV], min_count: int) -> bool:
        check_type(value, ListProxy)
        return len(value) >= min_count

    def check_max_count(self, value: ListProxy[T_PropV], max_count: int) -> bool:
        check_type(value, ListProxy)
        return len(value) <= max_count

    def elide(self, value: ListProxy[T_PropV]) -> bool:
        check_type(value, ListProxy)
        return len(value) == 0

    def walk(
        self,
        value: ListProxy[T_PropV],
        callback: Callable[[Any, List[str]], bool],
        path: List[str],
    ) -> None:
        if value is None:
            return
        callback(value, path)
        for idx, v in enumerate(value):
            self.prop.walk(v, callback, path + [f"[{idx}]"])

    def iter_objects(
        self,
        value: Optional[ListProxy[T_PropV]],
        recursive: bool,
        visited: Set["SHACLObject"],
    ) -> Iterable[Any]:
        if value is None:
            return
        for v in value:
            for c in self.prop.iter_objects(v, recursive, visited):
                yield c

    def link_prop(
        self,
        value: Optional[ListProxy[T_PropV]],
        objectset: "SHACLObjectSet",
        missing: Optional[Set[str]],
        visited: Set["SHACLObject"],
    ) -> ListProxy[T_PropV]:
        if value is None:
            return ListProxy(self.prop)

        data: List[T_PropV] = [
            cast(T_PropV, self.prop.link_prop(v, objectset, missing, visited))
            for v in value
        ]

        return ListProxy(self.prop, data=data)

    def encode(
        self, encoder: Encoder, value: ListProxy[T_PropV], state: EncodeState
    ) -> None:
        check_type(value, ListProxy)

        with encoder.write_list() as list_s:
            for v in value:
                with list_s.write_list_item() as item_s:
                    self.prop.encode(item_s, v, state)

    def decode(self, decoder: Decoder, state: DecodeState) -> ListProxy[T_PropV]:
        data: List[T_PropV] = []
        for val_d in decoder.read_list():
            v = self.prop.decode(val_d, state)
            if v is not None:
                self.prop.validate(v)
                data.append(v)

        return ListProxy(self.prop, data=data)


class EnumProp(IRIProp[str]):
    """An IRI property restricted to a fixed set of named individual values."""

    VALID_TYPES = str

    __slots__ = ()

    def __init__(
        self,
        values: Optional[Tuple[Tuple[str, str], ...]] = None,
        *,
        pattern: Optional[str] = None,
    ) -> None:
        super().__init__(values, pattern=pattern)

    def validate(self, value: Any) -> None:
        super().validate(value)

        if value not in self.iri_values():
            raise ValueError(
                f"'{value}' is not a valid value. Choose one of {' '.join(self.iri_values())}"
            )

    def encode(self, encoder: Encoder, value: str, state: EncodeState) -> None:
        encoder.write_enum(value, self, self.compact(value))

    def decode(self, decoder: Decoder, state: DecodeState) -> str:
        v = decoder.read_enum(self)
        if v is None:
            raise TypeError("Enum IRI cannot be None")
        return self.expand(v) or v


class NodeKind(Enum):
    """The allowed identifier kind for a SHACL node (blank node, IRI, or either)."""

    BlankNode = 1
    IRI = 2
    BlankNodeOrIRI = 3


def is_IRI(s: Any) -> bool:
    if not isinstance(s, str):
        return False
    if s.startswith("_:"):
        return False
    if ":" not in s:
        return False
    return True


def is_blank_node(s: Any) -> bool:
    if not isinstance(s, str):
        return False
    if not s.startswith("_:"):
        return False
    return True


# fmt: off
"""Format Guard"""
_USE_SLOTS = True
"""Format Guard"""
# fmt: on

# After Python 3.10, use slots=True to save a little space
_DC_KWARGS = {"slots": True} if _USE_SLOTS and sys.version_info >= (3, 10) else {}


@dataclass(**_DC_KWARGS)
class ClassProp:
    """Descriptor for a single property on a SHACLObject class, holding its IRI, Python name, and constraints."""

    pyname: str
    reg: Optional[Callable[..., Any]]
    iri: str
    min_count: Optional[int] = None
    max_count: Optional[int] = None
    compact: Optional[str] = None
    deprecated: bool = False
    # For efficiency reasons this should be of type Property (only) but
    # initialized to None
    prop: Property = None  # type: ignore


class SHACLObjectMeta(type):
    """Metaclass for SHACLObject that processes PROPERTIES, slots, and named individuals at class creation time."""

    def __new__(cls, name, bases, attrs):
        def check_base_prop(name):
            return any(hasattr(b, name) or name in b._EXTRA_SLOTS for b in bases)

        is_base = name == "SHACLObject"

        attrs.setdefault("IS_ABSTRACT", False)
        attrs.setdefault("IS_DEPRECATED", False)
        attrs.setdefault("NAMED_INDIVIDUALS", {})
        attrs.setdefault("NODE_KIND", NodeKind.BlankNodeOrIRI)
        attrs.setdefault("_EXTRA_SLOTS", set())
        attrs["_EXTRA_SLOTS"] = set(attrs["_EXTRA_SLOTS"])

        py_properties = {}
        iri_properties = {}
        compact_properties = {}
        for p in attrs.get("PROPERTIES", []):
            if not is_base:
                for b in bases:
                    if p.pyname in b._OBJ_PY_PROPS or p.pyname in b._EXTRA_SLOTS:
                        raise KeyError(
                            f"'{p.pyname}' is already defined for '{b.__name__}'"
                        )
                    if p.iri in b._OBJ_IRI_PROPS:
                        raise KeyError(
                            f"'{p.iri}' is already defined for '{b.__name__}'"
                        )
                    if p.compact and p.compact in b._OBJ_COMPACT_PROPS:
                        raise KeyError(
                            f"'{p.compact}' is already defined for '{b.__name__}'"
                        )

            if p.pyname in py_properties:
                raise KeyError(f"'{p.pyname}' is already defined for '{name}'")

            if p.iri in iri_properties:
                raise KeyError(f"'{p.iri}' is already defined for '{name}'")

            if p.compact and p.compact in compact_properties:
                raise KeyError(f"'{p.compact}' is already defined for '{name}'")

            while (
                p.pyname in attrs
                or p.pyname in attrs["_EXTRA_SLOTS"]
                or check_base_prop(p.pyname)
            ):
                p.pyname = p.pyname + "_"

            if not callable(p.reg):
                raise ValueError(
                    f"Registration of {name}.{p.pyname} must be a callable to allow deferred class typing. Try: `lambda: ...`"
                )

            py_properties[p.pyname] = p
            iri_properties[p.iri] = p

            if p.compact:
                p.compact = p.compact
                compact_properties[p.compact] = p

        if _USE_SLOTS:
            # Assign slots. Note that __slots__ automatically inherits from the
            # parent, so there is no need to merge in from the parent
            attrs["__slots__"] = tuple(
                sorted(
                    set(py_properties.keys())
                    | attrs["_EXTRA_SLOTS"]
                    | set(attrs.get("__slots__", ()))
                )
            )

        # Merge in the parent slots so that __setattr__ works properly
        for b in bases:
            attrs["_EXTRA_SLOTS"] |= b._EXTRA_SLOTS

        if "PROPERTIES" in attrs:
            del attrs["PROPERTIES"]

        attrs["_OBJ_PY_PROPS"] = py_properties
        attrs["_OBJ_IRI_PROPS"] = iri_properties
        attrs["_OBJ_COMPACT_PROPS"] = compact_properties
        if not is_base:
            for b in bases:
                for k, v in b._OBJ_PY_PROPS.items():
                    attrs["_OBJ_PY_PROPS"][k] = v

                for k, v in b._OBJ_IRI_PROPS.items():
                    attrs["_OBJ_IRI_PROPS"][k] = v

                for k, v in b._OBJ_COMPACT_PROPS.items():
                    attrs["_OBJ_COMPACT_PROPS"][k] = v

        attrs["_IRI"] = {p.pyname: p.iri for p in attrs["_OBJ_PY_PROPS"].values()}

        auto_ni = True
        if "AUTO_NAMED_INDIVIDUALS" in attrs:
            auto_ni = attrs["AUTO_NAMED_INDIVIDUALS"]
            del attrs["AUTO_NAMED_INDIVIDUALS"]

        for k, v in attrs["NAMED_INDIVIDUALS"].items():
            if auto_ni:
                if (
                    k in attrs
                    or k in attrs["_EXTRA_SLOTS"]
                    or check_base_prop(k)
                    or k in py_properties
                ):
                    raise KeyError(
                        f"Named Individual with name '{k}' conflicts with existing property"
                    )
                attrs[k] = v

            NAMED_INDIVIDUALS.add(v)

        attrs["_NEEDS_REG"] = True

        attrs["_TYPE"] = attrs.pop("TYPE", None)

        attrs["_COMPACT_TYPE"] = attrs.pop("COMPACT_TYPE", None)

        return super().__new__(cls, name, bases, attrs)

    @staticmethod
    def _add_class(key: str, c: Type[SHACLObject]) -> None:
        if key in SHACLObject.CLASSES:
            raise KeyError(
                f"{key} already registered to {SHACLObject.CLASSES[key].__name__}"
            )
        SHACLObject.CLASSES[key] = c


register_lock = threading.Lock()
NAMED_INDIVIDUALS: Set[str] = set()
T_SHACLObject = TypeVar("T_SHACLObject", bound="SHACLObject")


@functools.total_ordering
class SHACLObject(metaclass=SHACLObjectMeta):
    """Base class for all SHACL-defined objects, providing property access, encoding, and decoding."""

    CLASSES: Dict[str, Type] = {}

    # Class properties that can be set in derived classes:

    # A dictionary of Named Individuals. The key is the python name of the
    # individual and the value is the IRI of the individual (not inherited)
    NAMED_INDIVIDUALS: Dict[str, str] = {}

    # If True, class member variables will be automatically created for the class
    # from the NAMED_INDIVIDUALS dictionary
    # NOTE: This variable is not present in the class
    AUTO_NAMED_INDIVIDUALS: bool = True

    # The type of ID the object is allowed to have (inherited from parent)
    NODE_KIND = NodeKind.BlankNodeOrIRI

    # An alternate IRI for the ID property, besides "@id" (inherited from
    # parent)
    ID_ALIAS: Optional[str] = None

    # If True, this class is abstract and cannot be implemented (not inherited
    # from parent)
    IS_ABSTRACT: bool = True

    # If True, this class is deprecated and will raise a warning when created
    # (not inherited from parent)
    IS_DEPRECATED: bool = False

    # The fully qualified Type IRI for the object. Required
    # NOTE: This variable is not present in the class. Use get_type() instead
    TYPE: str = ""

    # The compacted Type IRI of the object. Must match how the TYPE property
    # would be compacted by the context. Not inherited from parent
    # NOTE: This variable is not present in the class. Use get_compact_type()
    # instead
    COMPACT_TYPE: Optional[str] = None

    # A list of properties for this object. Each entry must be a ClassProp
    # object. Properties are automatically inherited from parent classes and do
    # not need to be re-listed here.
    # NOTE: The variable is not present in the class
    PROPERTIES = [
        ClassProp("_id", lambda: StringProp(), "@id"),
    ]

    # Internal variables
    _EXTRA_SLOTS: Union[Set[str], Tuple[str, ...]] = (
        "_extensible",
        "_metadata",
        "_birth_index",
    )
    _OBJ_PY_PROPS: Dict[str, ClassProp] = {}
    _OBJ_IRI_PROPS: Dict[str, ClassProp] = {}
    _OBJ_COMPACT_PROPS: Dict[str, ClassProp] = {}
    _NEEDS_REG: bool = True
    _next_birth_index: int = 0
    _TYPE: str
    _COMPACT_TYPE: Optional[str]
    _extensible: Dict[str, Any]

    # Instance variables
    _id: Optional[str]
    _metadata: Dict[str, Any]

    def __init_subclass__(cls, **kwargs):
        def add_class(key: str, c: Type[SHACLObject]) -> None:
            if key in SHACLObject.CLASSES:
                raise KeyError(
                    f"{key} already registered to {SHACLObject.CLASSES[key].__name__}"
                )
            SHACLObject.CLASSES[key] = c

        super().__init_subclass__(**kwargs)
        if cls._TYPE:
            add_class(cls._TYPE, cls)

        if cls._COMPACT_TYPE:
            add_class(cls._COMPACT_TYPE, cls)

    def __init__(self, **kwargs: Any) -> None:
        if self._is_abstract():
            raise NotImplementedError(
                f"{self.__class__.__name__} is abstract and cannot be implemented"
            )

        if self.__class__.IS_DEPRECATED:
            warnings.warn(
                f"{self.__class__.__name__} is deprecated", DeprecationWarning
            )

        with register_lock:
            cls = self.__class__
            if cls._NEEDS_REG:
                for p in cls._OBJ_PY_PROPS.values():
                    # Note that since classes share their ClassProp objects
                    # with their parents, the property might have already been
                    # initialized.
                    if p.prop is None and p.reg is not None:
                        reg_callable = p.reg
                        try:
                            p.prop = reg_callable()
                            p.reg = None  # type: ignore[assignment]
                        except Exception as e:
                            raise ValueError(
                                f"Registration of {cls.__name__}.{p.pyname} failed: {e}"
                            ) from e
                cls._NEEDS_REG = False

        self._metadata = {}
        self._birth_index = SHACLObject._next_birth_index
        SHACLObject._next_birth_index += 1

        for p in self._OBJ_PY_PROPS.values():
            object.__setattr__(self, p.pyname, p.prop.init())

        for k, v in kwargs.items():
            setattr(self, k, v)

    def get_type(self) -> str:
        """Return the fully qualified IRI type of this object."""
        return self._TYPE

    def get_compact_type(self) -> Optional[str]:
        """Return the compacted type IRI of this object, or None if not defined."""
        return self._COMPACT_TYPE

    def _is_abstract(self) -> bool:
        return self.__class__.IS_ABSTRACT

    def __set(self, p: ClassProp, value: Any) -> None:
        if p.iri == "@id":
            if self.NODE_KIND == NodeKind.BlankNode:
                if not is_blank_node(value):
                    raise ValueError(
                        f"{self.__class__.__name__} ({id(self)}) can only have local reference. Property '{p.iri}' cannot be set to {value!r} and must start with '_:'"
                    )
            elif self.NODE_KIND == NodeKind.IRI:
                if not is_IRI(value):
                    raise ValueError(
                        f"{self.__class__.__name__} ({id(self)}) can only have an IRI value. Property '{p.iri}' cannot be set to {value!r}"
                    )
            else:
                if not is_blank_node(value) and not is_IRI(value):
                    raise ValueError(
                        f"{self.__class__.__name__} ({id(self)}) Has invalid Property '{p.iri}' {value!r}. Must be a blank node or IRI"
                    )

        p.prop.validate(value)
        if p.deprecated:
            warnings.warn(
                f"{self.__class__.__name__}.{p.pyname} is deprecated",
                DeprecationWarning,
            )
        object.__setattr__(self, p.pyname, p.prop.set(value))

    def __del(self, p: ClassProp):
        object.__setattr__(self, p.pyname, p.prop.init())

    def __get_attr(self, name: str) -> ClassProp:
        if name == self.ID_ALIAS:
            name = "_id"

        try:
            return self._OBJ_PY_PROPS[name]
        except KeyError:
            raise AttributeError(
                f"'{name}' is not a valid property of {self.__class__.__name__}"
            )

    def __setattr__(self, name: str, value: Any) -> None:
        if name in self._EXTRA_SLOTS:
            object.__setattr__(self, name, value)
            return

        self.__set(self.__get_attr(name), value)

    def __getattr__(self, name: str) -> Any:
        if name == self.ID_ALIAS:
            return self._id

        raise AttributeError(
            f"'{name}' is not a valid property of {self.__class__.__name__}"
        )

    def __delattr__(self, name: str) -> None:
        if name in self._EXTRA_SLOTS:
            object.__delattr__(self, name)
            return

        self.__del(self.__get_attr(name))

    def __get_key(self, iri: str) -> ClassProp:
        return self._OBJ_IRI_PROPS[iri]

    def __getitem__(self, iri: str) -> Any:
        return getattr(self, self.__get_key(iri).pyname)

    def __setitem__(self, iri: str, value: Any) -> None:
        self.__set(self.__get_key(iri), value)

    def __delitem__(self, iri: str) -> None:
        self.__del(self.__get_key(iri))

    def __iter__(self) -> Iterator[str]:
        return iter(self._OBJ_IRI_PROPS.keys())

    def walk(
        self,
        callback: Callable[[Any, List[str]], bool],
        path: Optional[List[str]] = None,
    ) -> None:
        """
        Walk object tree, invoking the callback for each item

        Callback has the form:

        def walk_callback(object: Any, path: List[str]) -> bool:
            ...
        """
        if path is None:
            path = ["."]

        if callback(self, path):
            for p in self._OBJ_PY_PROPS.values():
                p.prop.walk(getattr(self, p.pyname), callback, path + [f".{p.iri}"])

    def property_keys(self) -> Iterator[Tuple[Optional[str], str, Optional[str]]]:
        """Yield (python_name, iri, compact_iri) tuples for each property defined on this object."""
        for p in self._OBJ_PY_PROPS.values():
            if p.iri == "@id":
                compact = self.ID_ALIAS
            else:
                compact = p.compact
            yield p.pyname, p.iri, compact

    def iter_objects(
        self, *, recursive: bool = False, visited: Optional[Set["SHACLObject"]] = None
    ) -> Iterable["SHACLObject"]:
        """
        Iterate over all objects that are a child of this one
        """
        if visited is None:
            visited = set()

        for p in self._OBJ_PY_PROPS.values():
            for c in p.prop.iter_objects(
                getattr(self, p.pyname), recursive=recursive, visited=visited
            ):
                yield c

    def encode(self, encoder: Encoder, state: EncodeState) -> None:
        """Encode this object to the given encoder, writing its type, ID, and properties."""
        idname = self.ID_ALIAS or "@id"
        if not self._id and self.NODE_KIND == NodeKind.IRI:
            raise ValueError(
                f"{self.__class__.__name__} ({id(self)}) must have a IRI for property '{idname}'"
            )

        _id = state.get_object_id(self)

        if state.is_written(self):
            encoder.write_iri(_id, state.compact_iri(_id))
            return

        state.add_written(self)

        with encoder.write_object(
            self.get_type(),
            self.get_compact_type() or state.compact_iri(self.get_type()),
            self.ID_ALIAS,
            _id,
            state.compact_iri(_id),
            bool(self._id) or state.is_refed(self),
        ) as obj_s:
            self._encode_properties(obj_s, state)

    def _encode_properties(self, encoder: Encoder, state: EncodeState) -> None:
        for p in self._OBJ_PY_PROPS.values():
            value = getattr(self, p.pyname)
            if p.prop.elide(value):
                if p.min_count:
                    raise ValueError(
                        f"Property '{p.pyname}' in {self.__class__.__name__} ({id(self)}) is required (currently {value!r})"
                    )
                continue

            if p.min_count is not None:
                if not p.prop.check_min_count(value, p.min_count):
                    raise ValueError(
                        f"Property '{p.pyname}' in {self.__class__.__name__} ({id(self)}) requires a minimum of {p.min_count} elements"
                    )

            if p.max_count is not None:
                if not p.prop.check_max_count(value, p.max_count):
                    raise ValueError(
                        f"Property '{p.pyname}' in {self.__class__.__name__} ({id(self)}) requires a maximum of {p.max_count} elements"
                    )

            if p.iri == "@id":
                continue

            with encoder.write_property(
                p.iri, p.compact or state.compact_iri(p.iri)
            ) as prop_s:
                p.prop.encode(prop_s, value, state)

    @classmethod
    def _make_object(cls: Type["SHACLObject"], typ: str) -> "SHACLObject":
        if typ not in cls.CLASSES:
            raise TypeError(f"Unknown type {typ}")

        return cls.CLASSES[typ]()

    @classmethod
    def decode(
        cls: Type[T_SHACLObject], decoder: Decoder, state: DecodeState
    ) -> "SHACLObject":
        typ, obj_d = decoder.read_object()
        if typ is None:
            raise TypeError("Unable to determine type for object")
        typ = state.objectset.expand_iri(typ) or typ

        obj = cls._make_object(typ)
        _id = obj_d.read_object_id(obj.ID_ALIAS)
        if _id is not None:
            obj._id = state.expand_iri(_id) or _id

        if obj.NODE_KIND == NodeKind.IRI and not obj._id:
            raise ValueError("Object is missing required IRI")

        if obj._id:
            if obj._id in state.read_objs:
                return state.read_objs[obj._id]
            state.read_objs[obj._id] = obj

        obj._decode_properties(obj_d, state)

        if state.objectset is not None:
            state.objectset.add_index(obj)

        return obj

    def _decode_properties(self, decoder: Decoder, state: DecodeState) -> None:
        for key in decoder.object_keys():
            if not self._decode_prop(decoder, key, state):
                raise KeyError(f"Unknown property '{key}'")

    def _decode_prop(self, decoder: Decoder, key: str, state: DecodeState) -> bool:
        if key in ("@id", self.ID_ALIAS):
            return True

        expanded_key = state.expand_iri(key)
        if expanded_key and expanded_key in self._OBJ_IRI_PROPS:
            p = self._OBJ_IRI_PROPS[expanded_key]
        elif key in self._OBJ_IRI_PROPS:
            p = self._OBJ_IRI_PROPS[key]
        elif key in self._OBJ_COMPACT_PROPS:
            p = self._OBJ_COMPACT_PROPS[key]
        else:
            return False

        with decoder.read_property(key) as prop_d:
            if prop_d is None:
                raise TypeError(f"Property decoder for key '{key}' cannot be None")
            v = p.prop.decode(prop_d, state)
            self.__set(p, v)
        return True

    def link_helper(
        self,
        objectset: SHACLObjectSet,
        missing: Optional[Set[str]],
        visited: Set["SHACLObject"],
    ) -> None:
        """Resolve string IRI references in this object's properties to actual SHACLObject instances."""
        if self in visited:
            return

        visited.add(self)

        for p in self._OBJ_PY_PROPS.values():
            object.__setattr__(
                self,
                p.pyname,
                p.prop.link_prop(
                    getattr(self, p.pyname),
                    objectset,
                    missing,
                    visited,
                ),
            )

    def __str__(self):
        parts = [
            f"{self.__class__.__name__}(",
        ]
        if self._id:
            parts.append(f"@id='{self._id}'")
        parts.append(")")
        return "".join(parts)

    def __hash__(self):
        return super().__hash__()

    def __eq__(self, other):
        return super().__eq__(other)

    @staticmethod
    def _sort_key(obj: Any) -> Tuple[str, str, str, int]:
        if isinstance(obj, str):
            return (obj, "", "", 0)
        return (
            obj._id or "",
            obj.get_type(),
            getattr(obj, "name", None) or "",
            obj._birth_index,
        )

    def __lt__(self, other: Any) -> bool:
        return SHACLObject._sort_key(self) < SHACLObject._sort_key(other)


class SHACLExtensibleObject(SHACLObject):
    """A SHACLObject that accepts and round-trips arbitrary IRI-keyed extension properties."""

    CLOSED = False

    def __init__(self, typ: Optional[str] = None, **kwargs: Any) -> None:
        self._extensible = {
            "type": typ if typ else self._TYPE,
            "compact_type": None if typ else self._COMPACT_TYPE,
            "data": {},
        }

        super().__init__(**kwargs)

    def get_type(self) -> str:
        """Return the type IRI stored in the extensible data, which may differ from the class TYPE."""
        return self._extensible["type"]

    def get_compact_type(self) -> Optional[str]:
        """Return the compacted type IRI from the extensible data, or None if not set."""
        return self._extensible["compact_type"]

    def _is_abstract(self) -> bool:
        # Unknown classes are assumed to not be abstract so that they can be
        # deserialized
        typ = self.get_type()
        if typ in SHACLObject.CLASSES:
            return SHACLObject.CLASSES[typ].IS_ABSTRACT

        return False

    @property
    def _ext_data(self) -> Dict[str, Any]:
        return self._extensible["data"]

    @classmethod
    def _make_object(cls: Type["SHACLExtensibleObject"], typ: str) -> "SHACLObject":
        # Check for a known type, and if so, deserialize as that instead
        if typ in cls.CLASSES:
            return cls.CLASSES[typ]()

        obj = cls(typ)
        return obj

    def _decode_properties(self, decoder: Decoder, state: DecodeState) -> None:
        def decode_value(d):
            if not d.is_list():
                return d.read_value()

            return [decode_value(val_d) for val_d in d.read_list()]

        if self.CLOSED:
            super()._decode_properties(decoder, state)
            return

        for key in decoder.object_keys():
            if self._decode_prop(decoder, key, state):
                continue

            if key is None:
                raise KeyError("Property key cannot be None")

            expanded_key = state.expand_iri(key) or key

            if not is_IRI(expanded_key):
                raise KeyError(
                    f"Extensible object properties must be IRIs. Got '{key}' (expanded to '{expanded_key}')"
                )

            with decoder.read_property(key) as prop_d:
                self._ext_data[expanded_key] = decode_value(prop_d)

    def _encode_properties(self, encoder: Encoder, state: EncodeState) -> None:
        super()._encode_properties(encoder, state)
        if self.CLOSED:
            return

        for iri, value in self._ext_data.items():
            if iri in self._OBJ_IRI_PROPS:
                continue

            with encoder.write_property(iri, state.compact_iri(iri)) as prop_s:
                if isinstance(value, list):
                    v = value
                else:
                    v = [value]
                with prop_s.write_list() as list_s:
                    for i in v:
                        with list_s.write_list_item() as item_s:
                            if isinstance(i, bool):
                                item_s.write_bool(i)
                            elif isinstance(i, str):
                                item_s.write_string(i)
                            elif isinstance(i, int):
                                item_s.write_integer(i)
                            elif isinstance(i, float):
                                item_s.write_float(i)
                            else:
                                raise TypeError(
                                    f"Unsupported serialized type {type(i)} with value {i!r}"
                                )

    def __getitem__(self, iri: str) -> Any:
        try:
            return super().__getitem__(iri)
        except KeyError:
            if self.CLOSED:
                raise

        if not is_IRI(iri):
            raise KeyError(f"Key '{iri}' must be an IRI")
        return self._ext_data[iri]

    def __setitem__(self, iri: str, value: Any) -> None:
        try:
            super().__setitem__(iri, value)
            return
        except KeyError:
            if self.CLOSED:
                raise

        if not is_IRI(iri):
            raise KeyError(f"Key '{iri}' must be an IRI")
        self._ext_data[iri] = value

    def __delitem__(self, iri: str) -> None:
        try:
            super().__delitem__(iri)
            return
        except KeyError:
            if self.CLOSED:
                raise

        if not is_IRI(iri):
            raise KeyError(f"Key '{iri}' must be an IRI")
        del self._ext_data[iri]

    def property_keys(self) -> Iterator[Tuple[Optional[str], str, Optional[str]]]:
        iris: Set[str] = set()
        for pyname, iri, compact in super().property_keys():
            iris.add(iri)
            yield pyname, iri, compact

        if self.CLOSED:
            return

        for iri in self._ext_data.keys():
            if iri not in iris:
                yield None, iri, None


class SHACLObjectSet(object):
    """A collection of SHACLObject instances with indexing, linking, serialization, and query support."""

    def __init__(
        self, objects: Optional[Iterable[SHACLObject]] = None, *, link: bool = False
    ) -> None:
        if objects is None:
            objects = []
        self.objects: Set[SHACLObject] = set(objects)
        self.missing_ids: Set[str] = set()
        self.obj_by_id: Dict[str, SHACLObject] = {}
        self.obj_by_type: Dict[str, Set[Tuple[bool, SHACLObject]]] = {}
        self.create_index()
        self.context: Dict[str, str] = {}
        if link:
            self._link()

    def create_index(self) -> None:
        """
        (re)Create object index

        Creates or recreates the indices for the object set to enable fast
        lookup. All objects and their children are walked and indexed
        """
        self.obj_by_id = {}
        self.obj_by_type = {}
        for o in self.foreach():
            self.add_index(o)

    def add_index(self, obj: SHACLObject) -> None:
        """
        Add object to index

        Adds the object to all appropriate indices
        """

        def reg_type(
            typ: str,
            compact: Optional[str],
            o: SHACLObject,
            exact: bool,
        ) -> None:
            self.obj_by_type.setdefault(typ, set()).add((exact, o))
            if compact:
                self.obj_by_type.setdefault(compact, set()).add((exact, o))

        if not isinstance(obj, SHACLObject):
            raise TypeError("Object is not of type SHACLObject")

        for typ in SHACLObject.CLASSES.values():
            if isinstance(obj, typ):
                reg_type(typ._TYPE, typ._COMPACT_TYPE, obj, obj.__class__ is typ)

        # This covers custom extensions
        reg_type(obj.get_type(), obj.get_compact_type(), obj, True)

        if not obj._id:
            return

        self.missing_ids.discard(obj._id)

        if obj._id in self.obj_by_id:
            return

        self.obj_by_id[obj._id] = obj

    def add(self, obj: SHACLObject) -> SHACLObject:
        """
        Add object to object set

        Adds a SHACLObject to the object set and index it.

        NOTE: Child objects of the attached object are not indexes
        """
        if not isinstance(obj, SHACLObject):
            raise TypeError("Object is not of type SHACLObject")

        if obj not in self.objects:
            self.objects.add(obj)
            self.add_index(obj)
        return obj

    def update(self, *others: Iterable[SHACLObject]) -> None:
        """
        Update object set adding all objects in each other iterable
        """
        for o in others:
            for obj in o:
                self.add(obj)

    def __contains__(self, item: SHACLObject) -> bool:
        """
        Returns True if the item is in the object set
        """
        return item in self.objects

    def link(self) -> Set[str]:
        """
        Link object set

        Links the object in the object set by replacing string object
        references with references to the objects themselves. e.g.
        a property that references object "https://foo/bar" by a string
        reference will be replaced with an actual reference to the object in
        the object set with the same ID if it exists in the object set

        If multiple objects with the same ID are found, the duplicates are
        eliminated
        """
        self.create_index()
        return self._link()

    def _link(self) -> Set[str]:
        self.missing_ids = set()
        visited: Set[SHACLObject] = set()
        new_objects: Set[SHACLObject] = set()

        for o in self.objects:
            if o._id:
                o = cast(SHACLObject, self.find_by_id(o._id, o))
            o.link_helper(self, self.missing_ids, visited)
            new_objects.add(o)

        self.objects = new_objects

        # Remove blank nodes
        obj_by_id: Dict[str, SHACLObject] = {}
        for _id, obj in self.obj_by_id.items():
            if _id.startswith("_:"):
                del obj._id
            else:
                obj_by_id[_id] = obj
        self.obj_by_id = obj_by_id

        # Named individuals aren't considered missing
        self.missing_ids -= NAMED_INDIVIDUALS

        return self.missing_ids

    def find_by_id(
        self, _id: str, default: Optional[SHACLObject] = None
    ) -> Optional[SHACLObject]:
        """
        Find object by ID

        Returns objects that match the specified ID, or default if there is no
        object with the specified ID
        """
        if _id not in self.obj_by_id:
            return default
        return self.obj_by_id[_id]

    def foreach(self) -> Iterable[SHACLObject]:
        """
        Iterate over every object in the object set, and all child objects
        """
        visited = set()
        for o in self.objects:
            if o not in visited:
                yield o
                visited.add(o)

            for child in o.iter_objects(recursive=True, visited=visited):
                yield child

    @overload
    def foreach_type(
        self, typ: str, *, match_subclass: bool = True
    ) -> Iterator[SHACLObject]: ...

    @overload
    def foreach_type(
        self, typ: Type[T_SHACLObject], *, match_subclass: bool = True
    ) -> Iterator[T_SHACLObject]: ...

    def foreach_type(
        self, typ: Union[str, Type[T_SHACLObject]], *, match_subclass: bool = True
    ) -> Iterable[SHACLObject]:
        """
        Iterate over each object of a specified type (or subclass there of)

        If match_subclass is True, and class derived from typ will also match
        (similar to isinstance()). If False, only exact matches will be
        returned
        """
        if not isinstance(typ, str):
            if not isinstance(typ, type) or not issubclass(typ, SHACLObject):
                raise TypeError(f"Type must be derived from SHACLObject, got {typ}")
            # This intermediate step is necessary for pyrefly...
            typ_class: Type[SHACLObject] = typ
            typ = typ_class._TYPE

        if typ not in self.obj_by_type:
            return

        for exact, o in self.obj_by_type[typ]:
            if match_subclass or exact:
                yield cast(T_SHACLObject, o)

    def merge(self, *objectsets: "SHACLObjectSet") -> "SHACLObjectSet":
        """
        Merge object sets

        Returns a new object set that is the combination of this object set and
        all provided arguments
        """
        new_objects: Set[SHACLObject] = set()
        new_objects |= self.objects
        for d in objectsets:
            new_objects |= d.objects

        return SHACLObjectSet(new_objects, link=True)

    def inline_blank_nodes(self) -> None:
        """
        Removes (inlines) blank node objects from the root object set if they
        are referenced in only one other location besides the root.

        Deserializers that do not preserve the tree-like structure of the
        objects (e.g. RDF) should call this to ensure that blank nodes are
        inline correctly
        """
        ref_counts: Dict[SHACLObject, int] = {}

        def walk_callback(value: SHACLObject, path: List[str]) -> bool:
            if not isinstance(value, SHACLObject):
                return True

            ref_counts.setdefault(value, 0)
            ref_counts[value] += 1
            if ref_counts[value] > 1:
                return False

            return True

        for o in self.objects:
            # Note that every object in the root object set gets at least one
            # reference
            o.walk(walk_callback)

        new_objects: Set[SHACLObject] = set()
        for o in self.objects:
            if is_IRI(o._id):
                new_objects.add(o)
            # If the object is a blank node and is only referenced by this
            # root list and one other location, remove it from the root list
            #
            # A count of 1 means the object is only referenced by the root, and
            # therefore must be kept
            elif ref_counts[o] != 2:
                new_objects.add(o)

        self.objects = new_objects

    def encode(
        self,
        encoder: Encoder,
        state: EncodeState,
        force_list: bool = False,
        *,
        key: Optional[Callable[[SHACLObject], Any]] = None,
    ) -> None:
        """
        Serialize a list of objects to a serialization encoder

        If force_list is true, a list will always be written using the encoder.
        """
        ref_counts: Dict[SHACLObject, int] = {}

        def walk_callback(value: SHACLObject, path: List[str]) -> bool:
            if not isinstance(value, SHACLObject):
                return True

            # Remove blank node ID for re-assignment
            if is_blank_node(value._id):
                del value._id

            if value._id:
                state.add_refed(value)

            # If the object is referenced more than once, add it to the set of
            # referenced objects
            ref_counts.setdefault(value, 0)
            ref_counts[value] += 1
            if ref_counts[value] > 1:
                state.add_refed(value)
                return False

            return True

        for o in self.objects:
            if o._id:
                state.add_refed(o)
            o.walk(walk_callback)

        use_list = force_list or len(self.objects) > 1

        if use_list:
            # If we are making a list add all the objects referred to by reference
            # to the list
            objects = list(self.objects | state.ref_objects)
        else:
            objects = list(self.objects)

        objects.sort(key=key)

        if use_list:
            # Ensure top level objects are only written in the top level graph
            # node, and referenced by ID everywhere else. This is done by setting
            # the flag that indicates this object has been written for all the top
            # level objects, then clearing it right before serializing the object.
            #
            # In this way, if an object is referenced before it is supposed to be
            # serialized into the @graph, it will serialize as a string instead of
            # the actual object
            for o in objects:
                state.written_objects.add(o)

            with encoder.write_object_list() as list_s:
                for o in objects:
                    # Allow this specific object to be written now
                    state.written_objects.remove(o)
                    with list_s.write_list_item() as item_s:
                        o.encode(item_s, state)

        elif objects:
            objects[0].encode(encoder, state)

    def decode(self, decoder: Decoder, state: DecodeState):
        """Decode objects from the decoder and add them to this set, then link all references."""
        self.create_index()
        for obj_d in decoder.read_list():
            o = SHACLExtensibleObject.decode(obj_d, state)
            self.objects.add(o)

        self._link()

    def expand_iri(self, iri: str, default: Optional[str] = None) -> Optional[str]:
        """Expand a compact IRI to a full IRI using the object set's context, or return default."""
        for k, v in self.context.items():
            if iri == k:
                return self.expand_iri(v, v)
            if iri.startswith(k + ":"):
                new_iri = v + iri[len(k) + 1 :]
                return self.expand_iri(new_iri, new_iri)
        return default

    def compact_iri(self, iri: str, default: Optional[str] = None) -> Optional[str]:
        """Compact a full IRI to a prefixed short form using the object set's context, or return default."""
        for k, v in self.context.items():
            if iri == v:
                return self.compact_iri(k, k)
            if iri.startswith(v):
                new_iri = k + ":" + iri[len(v) :]
                return self.compact_iri(new_iri, new_iri)
        return default


class EncodeState(object):
    """Tracks per-serialization state: object IDs, reference counts, and write order."""

    def __init__(self, objectset: SHACLObjectSet):
        self.ref_objects: Set[SHACLObject] = set()
        self.written_objects: Set[SHACLObject] = set()
        self.blank_objects: Dict[SHACLObject, str] = {}
        self.objectset = objectset

    def get_object_id(self, o: SHACLObject) -> str:
        if o._id:
            return o._id

        if o not in self.blank_objects:
            _id = f"_:{o.__class__.__name__}{len(self.blank_objects)}"
            self.blank_objects[o] = _id

        return self.blank_objects[o]

    def is_refed(self, o: SHACLObject) -> bool:
        return o in self.ref_objects

    def add_refed(self, o: SHACLObject) -> None:
        self.ref_objects.add(o)

    def is_written(self, o: SHACLObject) -> bool:
        return o in self.written_objects

    def add_written(self, o: SHACLObject) -> None:
        self.written_objects.add(o)

    def expand_iri(self, iri: str, default: Optional[str] = None) -> Optional[str]:
        if self.objectset:
            return self.objectset.expand_iri(iri, default)
        return default

    def compact_iri(self, iri: str, default: Optional[str] = None) -> Optional[str]:
        if self.objectset:
            return self.objectset.compact_iri(iri, default)
        return default


class DecodeState(object):
    """Carries the target SHACLObjectSet and context during a deserialization pass."""

    def __init__(self, objectset: SHACLObjectSet):
        self.objectset = objectset
        self.read_objs: Dict[str, SHACLObject] = {}

    def expand_iri(self, iri: str, default: Optional[str] = None) -> Optional[str]:
        if self.objectset:
            return self.objectset.expand_iri(iri, default)
        return default

    def compact_iri(self, iri: str, default: Optional[str] = None) -> Optional[str]:
        if self.objectset:
            return self.objectset.compact_iri(iri, default)
        return default


class Decoder(ABC):
    """Abstract interface for reading typed values and objects from a serialized source."""

    @abstractmethod
    def read_value(self) -> Any:
        """
        Consume next item

        Consumes the next item of any type
        """
        raise NotImplementedError("Subclasses must implement read_value method")

    @abstractmethod
    def read_string(self) -> Optional[str]:
        """
        Consume the next item as a string.

        Returns the string value of the next item, or `None` if the next item
        is not a string
        """
        raise NotImplementedError("Subclasses must implement read_string method")

    @abstractmethod
    def read_datetime(self) -> Optional[str]:
        """
        Consumes the next item as a date & time string

        Returns the string value of the next item, if it is a ISO datetime, or
        `None` if the next item is not a ISO datetime string.

        Note that validation of the string is done by the caller, so a minimal
        implementation can just check if the next item is a string without
        worrying about the format
        """
        raise NotImplementedError("Subclasses must implement read_datetime method")

    @abstractmethod
    def read_integer(self) -> Optional[int]:
        """
        Consumes the next item as an integer

        Returns the integer value of the next item, or `None` if the next item
        is not an integer
        """
        raise NotImplementedError("Subclasses must implement read_integer method")

    @abstractmethod
    def read_iri(self) -> Optional[str]:
        """
        Consumes the next item as an IRI string

        Returns the string value of the next item an IRI, or `None` if the next
        item is not an IRI.

        The returned string should be either a fully-qualified IRI, or a blank
        node ID
        """
        raise NotImplementedError("Subclasses must implement read_iri method")

    @abstractmethod
    def read_enum(self, e) -> Optional[str]:
        """
        Consumes the next item as an Enum value string

        Returns the fully qualified IRI of the next enum item, or `None` if the
        next item is not an enum value.

        The callee is responsible for validating that the returned IRI is
        actually a member of the specified Enum, so the `Decoder` does not need
        to check that, but can if it wishes
        """
        raise NotImplementedError("Subclasses must implement read_enum method")

    @abstractmethod
    def read_bool(self) -> Optional[bool]:
        """
        Consume the next item as a boolean value

        Returns the boolean value of the next item, or `None` if the next item
        is not a boolean
        """
        raise NotImplementedError("Subclasses must implement read_bool method")

    @abstractmethod
    def read_float(self) -> Optional[float]:
        """
        Consume the next item as a float value

        Returns the float value of the next item, or `None` if the next item is
        not a float
        """
        raise NotImplementedError("Subclasses must implement read_float method")

    @abstractmethod
    def read_list(self) -> Iterator["Decoder"]:
        """
        Consume the next item as a list generator

        This should generate a `Decoder` object for each item in the list. The
        generated `Decoder` can be used to read the corresponding item from the
        list
        """
        raise NotImplementedError("Subclasses must implement read_list method")

    @abstractmethod
    def is_list(self) -> bool:
        """
        Checks if the next item is a list

        Returns True if the next item is a list, or False if it is a scalar
        """
        raise NotImplementedError("Subclasses must implement is_list method")

    @abstractmethod
    def read_object(self) -> Tuple[Any, "Decoder"]:
        """
        Consume next item as an object

        A context manager that "enters" the next item as a object and yields a
        `Decoder` that can read properties from it. If the next item is not an
        object, yields `None`

        Properties will be read out of the object using `read_property` and
        `read_object_id`
        """
        raise NotImplementedError("Subclasses must implement read_object method")

    @abstractmethod
    @contextmanager
    def read_property(self, key: str) -> Iterator[Optional["Decoder"]]:
        """
        Read property from object

        A context manager that yields a `Decoder` that can be used to read the
        value of the property with the given key in current object, or `None`
        if the property does not exist in the current object.
        """
        raise NotImplementedError("Subclasses must implement read_property method")

    @abstractmethod
    def is_object(self) -> bool:
        """
        Checks if the item is an object

        Returns True if the item is an object, or False if is not
        """
        raise NotImplementedError("Subclasses must implement is_object method")

    @abstractmethod
    def object_keys(self) -> Iterator[str]:
        """
        Read property keys from an object

        Iterates over all the serialized keys for the current object
        """
        raise NotImplementedError("Subclasses must implement object_keys method")

    @abstractmethod
    def read_object_id(self, alias: Optional[str] = None) -> Optional[Any]:
        """
        Read current object ID property

        Returns the ID of the current object if one is defined, or `None` if
        the current object has no ID.

        The ID must be a fully qualified IRI or a blank node

        If `alias` is provided, is is a hint as to another name by which the ID
        might be found, if the `Decoder` supports aliases for an ID
        """
        raise NotImplementedError("Subclasses must implement read_object_id method")


class JSONLDDecoder(Decoder):
    """Decoder implementation that reads SHACL objects from a parsed JSON-LD data structure."""

    def __init__(self, data: Any, root: bool = False) -> None:
        self.data = data
        self.root = root

    def read_value(self) -> Optional[Any]:
        if isinstance(self.data, str):
            try:
                return float(self.data)
            except ValueError:
                pass
        return self.data

    def read_string(self) -> Optional[str]:
        if isinstance(self.data, str):
            return self.data
        return None

    def read_datetime(self) -> Optional[str]:
        return self.read_string()

    def read_integer(self) -> Optional[int]:
        if isinstance(self.data, int):
            return self.data
        return None

    def read_bool(self) -> Optional[bool]:
        if isinstance(self.data, bool):
            return self.data
        return None

    def read_float(self) -> Optional[float]:
        if isinstance(self.data, (int, float, str)):
            return float(self.data)
        return None

    def read_iri(self) -> Optional[str]:
        if isinstance(self.data, str):
            return self.data
        return None

    def read_enum(self, e) -> Optional[str]:
        if isinstance(self.data, str):
            return self.data
        return None

    def read_list(self) -> Iterator["JSONLDDecoder"]:
        if self.is_list():
            for v in self.data:
                yield self.__class__(v)
        else:
            yield self

    def is_list(self) -> bool:
        return isinstance(self.data, (list, tuple, set))

    def __get_value(self, *keys: Optional[str]) -> Optional[Any]:
        for k in keys:
            if k and k in self.data:
                return self.data[k]
        return None

    @contextmanager
    def read_property(self, key: str) -> Iterator[Optional["JSONLDDecoder"]]:
        v = self.__get_value(key)
        if v is not None:
            yield self.__class__(v)
        else:
            yield None

    def is_object(self) -> bool:
        return isinstance(self.data, dict)

    def object_keys(self) -> Iterator[str]:
        for key in self.data.keys():
            if key in ("@type", "type"):
                continue
            if self.root and key == "@context":
                continue
            yield key

    def read_object(self) -> Tuple[Any, "JSONLDDecoder"]:
        typ = self.__get_value("@type", "type")
        if typ is not None:
            return typ, self

        return None, self

    def read_object_id(self, alias: Optional[str] = None) -> Optional[Any]:
        return self.__get_value(alias, "@id")


class JSONLDDeserializer(object):
    """Deserializes SHACL objects from JSON-LD data or files into a SHACLObjectSet."""

    def deserialize_data(self, data: Any, objectset: SHACLObjectSet) -> None:
        """Decode SHACL objects from a pre-parsed JSON-LD data structure into the given object set."""
        h = JSONLDDecoder(data, True)

        with h.read_property("@context") as context_prop:
            if context_prop:
                decode_context(context_prop, objectset)

        state = DecodeState(objectset)
        with h.read_property("@graph") as graph_prop:
            objectset.decode(graph_prop if graph_prop else h, state)

    def read(self, f: BinaryIO, objectset: SHACLObjectSet) -> None:
        """Parse a JSON-LD file and deserialize its objects into the given object set."""
        data = json.load(f)
        self.deserialize_data(data, objectset)


class Encoder(ABC):
    """Abstract interface for writing typed values and objects to a serialized output."""

    @abstractmethod
    def write_string(self, v: str) -> None:
        """
        Write a string value

        Encodes the value as a string in the output
        """
        raise NotImplementedError("Subclasses must implement write_string method")

    @abstractmethod
    def write_datetime(self, v: str) -> None:
        """
        Write a date & time string

        Encodes the value as an ISO datetime string

        Note: The provided string is already correctly encoded as an ISO datetime
        """
        raise NotImplementedError("Subclasses must implement write_datetime method")

    @abstractmethod
    def write_integer(self, v: int) -> None:
        """
        Write an integer value

        Encodes the value as an integer in the output
        """
        raise NotImplementedError("Subclasses must implement write_integer method")

    @abstractmethod
    def write_iri(self, v: str, compact: Optional[str] = None) -> None:
        """
        Write IRI

        Encodes the string as an IRI. Note that the string will be either a
        fully qualified IRI or a blank node ID. If `compact` is provided and
        the serialization supports compacted IRIs, it should be preferred to
        the full IRI
        """
        raise NotImplementedError("Subclasses must implement write_iri method")

    @abstractmethod
    def write_enum(
        self, v: str, e: Property[Any], compact: Optional[str] = None
    ) -> None:
        """
        Write enum value IRI

        Encodes the string enum value IRI. Note that the string will be a fully
        qualified IRI. If `compact` is provided and the serialization supports
        compacted IRIs, it should be preferred to the full IRI.
        """
        raise NotImplementedError("Subclasses must implement write_enum method")

    @abstractmethod
    def write_bool(self, v: bool) -> None:
        """
        Write boolean

        Encodes the value as a boolean in the output
        """
        raise NotImplementedError("Subclasses must implement write_bool method")

    @abstractmethod
    def write_float(self, v: float) -> None:
        """
        Write float

        Encodes the value as a floating point number in the output
        """
        raise NotImplementedError("Subclasses must implement write_float method")

    @abstractmethod
    @contextmanager
    def write_object(
        self,
        typ: str,
        compact_type: Optional[str],
        id_alias: Optional[str],
        _id: str,
        compact_id: Optional[str],
        needs_id: bool,
    ) -> Iterator["Encoder"]:
        """
        Write object

        A context manager that yields an `Encoder` that can be used to encode
        the given object properties.

        The provided ID will always be a valid ID (even if o._id is `None`), in
        case the `Encoder` _must_ have an ID. `needs_id` is a hint to indicate
        to the `Encoder` if an ID must be written or not (if that is even an
        option). If it is `True`, the `Encoder` must encode an ID for the
        object. If `False`, the encoder is not required to encode an ID and may
        omit it.

        The ID will be either a fully qualified IRI, or a blank node IRI.

        Properties will be written the object using `write_property`
        """
        raise NotImplementedError("Subclasses must implement write_object method")

    @abstractmethod
    @contextmanager
    def write_property(
        self, iri: str, compact: Optional[str] = None
    ) -> Iterator["Encoder"]:
        """
        Write object property

        A context manager that yields an `Encoder` that can be used to encode
        the value for the property with the given IRI in the current object

        Note that the IRI will be fully qualified. If `compact` is provided and
        the serialization supports compacted IRIs, it should be preferred to
        the full IRI.
        """
        raise NotImplementedError("Subclasses must implement write_property method")

    @abstractmethod
    @contextmanager
    def write_list(self) -> Iterator["Encoder"]:
        """
        Write list

        A context manager that yields an `Encoder` that can be used to encode a
        list.

        Each item of the list will be added using `write_list_item`
        """
        raise NotImplementedError("Subclasses must implement write_list method")

    @abstractmethod
    @contextmanager
    def write_list_item(self) -> Iterator["Encoder"]:
        """
        Write list item

        A context manager that yields an `Encoder` that can be used to encode
        the value for a list item
        """
        raise NotImplementedError("Subclasses must implement write_list_item method")

    @abstractmethod
    @contextmanager
    def write_object_list(self) -> Iterator["Encoder"]:
        """
        Write top level object list

        A context manager that yields an `Encoder` that encodes the top level
        list of objects.

        Each object in the list will be added using `write_list_item`
        """
        raise NotImplementedError("Subclasses must implement write_object_list method")

    @abstractmethod
    @contextmanager
    def write_dict(self) -> Iterator["Encoder"]:
        """
        Write dict

        A context manager that yields an `Encoder` that can be used to encode a
        dictionary.
        """
        raise NotImplementedError("Subclasses must implement write_dict method")


class JSONLDEncoder(Encoder):
    """Encoder that builds a JSON-LD Python data structure (dicts/lists) for later JSON serialization."""

    def __init__(self, data: Optional[Any] = None) -> None:
        self.data: Any = data

    def write_string(self, v: str) -> None:
        self.data = v

    def write_datetime(self, v: str) -> None:
        self.data = v

    def write_integer(self, v: int) -> None:
        self.data = v

    def write_iri(self, v: str, compact: Optional[str] = None) -> None:
        self.write_string(compact or v)

    def write_enum(self, v: str, e: Any, compact: Optional[str] = None) -> None:
        self.write_string(compact or v)

    def write_bool(self, v: bool) -> None:
        self.data = v

    def write_float(self, v: float) -> None:
        self.data = str(v)

    @contextmanager
    def write_property(
        self, iri: str, compact: Optional[str] = None
    ) -> Iterator["JSONLDEncoder"]:
        s = self.__class__(None)
        yield s
        if s.data is not None:
            # within write_object() context, self.data is expected to be a dict
            if not isinstance(self.data, dict):
                raise TypeError(
                    "Encoder.write_property used outside of write_object context; encoder.data is not a dict"
                )
            self.data[compact or iri] = s.data

    @contextmanager
    def write_dict(self) -> Iterator["JSONLDEncoder"]:
        if not self.data:
            self.data = {}
        yield self

    @contextmanager
    def write_object(
        self,
        typ: str,
        compact_type: Optional[str],
        id_alias: Optional[str],
        _id: str,
        compact_id: Optional[str],
        needs_id: bool,
    ) -> Iterator["JSONLDEncoder"]:
        with self.write_dict() as obj_dict:
            obj_dict.data["type"] = compact_type or typ
            if needs_id:
                obj_dict.data[id_alias or "@id"] = compact_id or _id
            yield obj_dict

    @contextmanager
    def write_list(self) -> Iterator["JSONLDEncoder"]:
        self.data = []
        yield self
        if not self.data:
            self.data = None

    @contextmanager
    def write_list_item(self) -> Iterator["JSONLDEncoder"]:
        s = self.__class__(None)
        yield s
        if s.data is not None:
            if not isinstance(self.data, list):
                raise TypeError(
                    "Encoder.write_list_item used outside of write_list context; encoder.data is not a list"
                )
            self.data.append(s.data)

    @contextmanager
    def write_object_list(self) -> Iterator["JSONLDEncoder"]:
        with self.write_property("@graph") as graph_prop:
            with graph_prop.write_list() as graph_list:
                yield graph_list


class JSONLDSerializer(object):
    """Serializes a SHACLObjectSet to a JSON-LD file or in-memory data structure."""

    def __init__(self, **args: Any) -> None:
        self.args = args

    def serialize_data(
        self,
        objectset: SHACLObjectSet,
        force_at_graph: bool = False,
    ) -> Any:
        """Encode the object set to a JSON-LD Python data structure and return it."""
        h = JSONLDEncoder()
        state = EncodeState(objectset)
        with h.write_dict() as doc_s:
            encode_context(doc_s, objectset)
            objectset.encode(doc_s, state, force_at_graph)
        return h.data

    def write(
        self,
        objectset: SHACLObjectSet,
        f: BinaryIO,
        force_at_graph: bool = False,
        **kwargs,
    ) -> str:
        """
        Write a SHACLObjectSet to a JSON LD file

        If force_at_graph is True, a @graph node will always be written

        Note that f should be a file-like object that supports the `write`
        method, and that opens in binary mode (e.g. `open("file.json", "wb")`).
        """
        data = self.serialize_data(objectset, force_at_graph)

        args = {**self.args, **kwargs}

        sha1 = hashlib.sha1()
        for chunk in json.JSONEncoder(**args).iterencode(data):
            chunk_bytes = chunk.encode("utf-8")
            f.write(chunk_bytes)
            sha1.update(chunk_bytes)

        return sha1.hexdigest()


class JSONLDInlineEncoder(Encoder):
    """Encoder that writes JSON-LD output directly to a binary file stream, computing a SHA-1 hash."""

    def __init__(self, f: BinaryIO, sha1: Any, in_dict: bool = False) -> None:
        self.f: BinaryIO = f
        self.comma: bool = False
        self.sha1: Any = sha1
        self.in_dict: bool = in_dict

    def write(self, s: str) -> None:
        """Write a raw string to the output stream and update the SHA-1 hash."""
        b = s.encode("utf-8")
        self.f.write(b)
        self.sha1.update(b)

    def _write_comma(self) -> None:
        if self.comma:
            self.write(",")
            self.comma = False

    def write_string(self, v: str) -> None:
        self.write(json.dumps(v))

    def write_datetime(self, v: str) -> None:
        self.write_string(v)

    def write_integer(self, v: int) -> None:
        self.write(f"{v}")

    def write_iri(self, v: str, compact: Optional[str] = None) -> None:
        self.write_string(compact or v)

    def write_enum(self, v: str, e: Any, compact: Optional[str] = None) -> None:
        self.write_iri(v, compact)

    def write_bool(self, v: bool) -> None:
        if v:
            self.write("true")
        else:
            self.write("false")

    def write_float(self, v: float) -> None:
        self.write(json.dumps(str(v)))

    @contextmanager
    def write_property(
        self, iri: str, compact: Optional[str] = None
    ) -> Iterator["JSONLDInlineEncoder"]:
        self._write_comma()
        self.write_string(compact or iri)
        self.write(":")
        yield self.__class__(self.f, self.sha1)
        self.comma = True

    @contextmanager
    def write_dict(self) -> Iterator["JSONLDInlineEncoder"]:
        self._write_comma()
        if self.in_dict:
            yield self
            return

        self.write("{")
        yield self.__class__(self.f, self.sha1, True)
        self.write("}")
        self.comma = True

    @contextmanager
    def write_object(
        self,
        typ: str,
        compact_type: Optional[str],
        id_alias: Optional[str],
        _id: str,
        compact_id: Optional[str],
        needs_id: bool,
    ) -> Iterator["JSONLDInlineEncoder"]:
        with self.write_dict() as obj_dict:
            with obj_dict.write_property(
                "type"
            ) as type_prop:
                type_prop.write_string(compact_type or typ)

            if needs_id:
                with obj_dict.write_property(id_alias or "@id") as id_prop:
                    id_prop.write_string(compact_id or _id)

            yield obj_dict

    @contextmanager
    def write_list(self) -> Iterator["JSONLDInlineEncoder"]:
        self._write_comma()
        self.write("[")
        yield self.__class__(self.f, self.sha1)
        self.write("]")
        self.comma = True

    @contextmanager
    def write_list_item(self) -> Iterator["JSONLDInlineEncoder"]:
        self._write_comma()
        yield self.__class__(self.f, self.sha1)
        self.comma = True

    @contextmanager
    def write_object_list(self) -> Iterator["JSONLDInlineEncoder"]:
        with self.write_property("@graph") as graph_prop:
            with graph_prop.write_list() as graph_list:
                yield graph_list


class JSONLDInlineSerializer(object):
    """Serializes a SHACLObjectSet directly to a binary stream, returning a SHA-1 digest."""

    def write(
        self,
        objectset: SHACLObjectSet,
        f: BinaryIO,
        force_at_graph: bool = False,
    ):
        """
        Write a SHACLObjectSet to a JSON LD file

        Note: force_at_graph is included for compatibility, but ignored. This
        serializer always writes out a graph
        """
        sha1 = hashlib.sha1()
        h = JSONLDInlineEncoder(f, sha1)
        state = EncodeState(objectset)
        with h.write_dict() as doc_s:
            encode_context(doc_s, objectset)
            objectset.encode(doc_s, state, True)

        return sha1.hexdigest()


def encode_context(encoder: Encoder, objectset: SHACLObjectSet) -> None:
    context: List[Union[str, Dict[str, str]]] = list(CONTEXT_URLS)
    if objectset.context:
        context.append(objectset.context)

    if not context:
        return

    def write_context(e, ctx):
        if isinstance(ctx, str):
            e.write_string(ctx)
        else:
            with e.write_dict() as dict_s:
                for k, v in ctx.items():
                    with dict_s.write_property(k) as ctx_prop:
                        ctx_prop.write_string(v)

    with encoder.write_property("@context") as context_prop:
        if len(context) == 1:
            write_context(context_prop, context[0])
        else:
            with context_prop.write_list() as context_list:
                for ctx in context:
                    with context_list.write_list_item() as context_list_item:
                        write_context(context_list_item, ctx)


def decode_context(decoder: Decoder, objectset: SHACLObjectSet) -> None:
    def _decode_ctx(d: Decoder):
        if not d.is_object():
            return

        for k in d.object_keys():
            with d.read_property(k) as prop_d:
                if prop_d:
                    if s := prop_d.read_string():
                        objectset.context[k] = s

    if decoder.is_list():
        for ctx_d in decoder.read_list():
            _decode_ctx(ctx_d)
    else:
        _decode_ctx(decoder)


try:
    from rdflib import BNode, Literal, URIRef
    from rdflib.namespace import RDF
    from rdflib.term import IdentifiedNode

    if TYPE_CHECKING:
        from rdflib import Graph
        from rdflib.term import Node

    class RDFDecoder(Decoder):
        def __init__(
            self,
            graph: Graph,
            subject: Optional[Node] = None,
            predicate: Optional[Node] = None,
            value: Optional[Node] = None,
        ) -> None:
            self.graph: Graph = graph
            self.subject: Optional[Node] = subject
            self.predicate: Optional[Node] = predicate
            self.value: Optional[Node] = value

        def __read_node(self) -> Optional[Node]:
            if self.value is not None:
                return self.value
            if self.predicate is None:
                return None
            return self.graph.value(self.subject, self.predicate)

        def read_value(self) -> Optional[Any]:
            v = self.__read_node()
            if isinstance(v, Literal):
                return v.toPython()
            return None

        def read_string(self) -> Optional[str]:
            v = self.read_value()
            if isinstance(v, str):
                return v
            return None

        def read_datetime(self) -> Optional[str]:
            return self.read_value()

        def read_integer(self) -> Optional[int]:
            v = self.read_value()
            if isinstance(v, (int, decimal.Decimal)):
                return int(v)
            return None

        def read_bool(self) -> Optional[bool]:
            v = self.read_value()
            if isinstance(v, bool):
                return v
            return None

        def read_float(self) -> Optional[float]:
            v = self.read_value()
            if isinstance(v, (int, float, str, decimal.Decimal)):
                return float(v)
            return None

        def read_iri(self) -> Optional[str]:
            v = self.__read_node()
            if isinstance(v, URIRef):
                return v.toPython()
            elif isinstance(v, Literal):
                v = v.toPython()
                if isinstance(v, str):
                    return v
            elif isinstance(v, BNode):
                return v.n3()
            return None

        def read_enum(self, e) -> Optional[str]:
            v = self.__read_node()
            if isinstance(v, URIRef):
                return v.toPython()
            return None

        def read_list(self) -> Iterator["RDFDecoder"]:
            if not self.subject:
                blank_nodes = set()
                for s in self.graph.subjects(unique=True):
                    if (s, RDF.type, None) not in self.graph:
                        continue

                    if isinstance(s, BNode):
                        blank_nodes.add(s)
                        continue
                    yield self.__class__(self.graph, s)

                for s in blank_nodes:
                    yield self.__class__(self.graph, s)
            else:
                for o in self.graph.objects(self.subject, self.predicate):
                    if (o, RDF.type, None) in self.graph:
                        yield self.__class__(self.graph, o)
                    else:
                        yield self.__class__(
                            self.graph,
                            self.subject,
                            self.predicate,
                            o,
                        )

        def is_list(self) -> bool:
            if not self.subject:
                return True
            if self.value is not None:
                return False
            return len(list(self.graph.objects(self.subject, self.predicate))) > 1

        @contextmanager
        def read_property(self, key: str) -> Iterator[Optional["RDFDecoder"]]:
            if key == "@id":
                yield self.__class__(self.graph, value=self.subject)
            else:
                yield self.__class__(self.graph, self.subject, URIRef(key))

        def is_object(self) -> bool:
            n = self.__read_node() or self.subject
            return (n, RDF.type, None) in self.graph

        def object_keys(self) -> Iterator[str]:
            for p in self.graph.predicates(self.subject, unique=True):
                if p == RDF.type:
                    continue

                if not isinstance(p, IdentifiedNode):
                    raise TypeError(f"Predicate is of unknown type {type(p)}")

                yield p.toPython()

        def read_object(self) -> Tuple[Any, "RDFDecoder"]:
            s = self.__read_node()
            if s is None:
                s = self.subject

            typ = self.graph.value(s, RDF.type)
            if typ is None:
                return None, self

            if not isinstance(typ, IdentifiedNode):
                raise TypeError(f"Type value is of unknown type {type(typ)}")

            return typ.toPython(), self.__class__(self.graph, s)

        def read_object_id(self, alias=None) -> Optional[Any]:
            if isinstance(self.subject, BNode):
                return self.subject.n3()
            if not isinstance(self.subject, IdentifiedNode):
                raise TypeError(f"Subject is of unknown type {type(self.subject)}")
            return self.subject.toPython()

    class RDFDeserializer(object):
        """Deserializes SHACL objects from an rdflib Graph into a SHACLObjectSet."""

        def read(self, graph: Graph, objset: SHACLObjectSet) -> None:
            """Decode all typed subjects from the rdflib Graph into the given object set."""
            d = RDFDecoder(graph)
            state = DecodeState(objset)
            objset.decode(d, state)
            objset.inline_blank_nodes()

    class RDFEncoder(Encoder):
        def __init__(
            self,
            graph: Graph,
            subject: Optional[Node] = None,
            predicate: Optional[Node] = None,
        ) -> None:
            self.graph: Graph = graph
            self.subject: Optional[Node] = subject
            self.predicate: Optional[Node] = predicate

        def __add_literal(self, v: Any) -> None:
            if self.subject is None or self.predicate is None:
                raise TypeError("Subject and predicate of literal value cannot be None")
            self.graph.add((self.subject, self.predicate, Literal(v)))

        def __add_uriref(self, v: str) -> None:
            if self.subject is None or self.predicate is None:
                raise TypeError("Subject and predicate of URIRef value cannot be None")
            self.graph.add((self.subject, self.predicate, URIRef(v)))

        def write_string(self, v):
            self.__add_literal(v)

        def write_datetime(self, v):
            self.__add_literal(v)

        def write_integer(self, v):
            self.__add_literal(v)

        def write_iri(self, v, compact=None):
            self.__add_uriref(v)

        def write_enum(self, v, e, compact=None):
            self.__add_uriref(v)

        def write_bool(self, v):
            self.__add_literal(v)

        def write_float(self, v):
            self.__add_literal(v)

        @contextmanager
        def write_property(self, iri: str, compact: Optional[str] = None):
            yield self.__class__(self.graph, self.subject, URIRef(iri))

        @contextmanager
        def write_object(
            self,
            typ: str,
            compact_type: Optional[str],
            id_alias: Optional[str],
            _id: str,
            compact_id: Optional[str],
            needs_id: bool,
        ):
            obj: Node
            if _id.startswith("_:"):
                obj = BNode(_id[2:])
            else:
                obj = URIRef(_id)

            if self.subject is not None:
                if self.predicate is None:
                    raise TypeError("Predicate cannot be None when subject is not None")
                self.graph.add((self.subject, self.predicate, obj))
            self.graph.add((obj, RDF.type, URIRef(typ)))
            yield self.__class__(self.graph, obj)

        @contextmanager
        def write_list(self):
            yield self

        @contextmanager
        def write_list_item(self):
            yield self

        @contextmanager
        def write_object_list(self):
            yield self

        @contextmanager
        def write_dict(self):
            yield self

    class RDFSerializer(object):
        """Serializes a SHACLObjectSet into an rdflib Graph."""

        def write(self, objset: SHACLObjectSet, g: Graph) -> None:
            """
            Write a SHACLObjectSet to an rdflib Graph
            """
            e = RDFEncoder(g)
            state = EncodeState(objset)
            objset.encode(e, state)

except ImportError:
    pass


# fmt: off
"""Format Guard"""
CONTEXT_URLS: List[str] = [
    "https://spdx.org/rdf/3.0.1/spdx-context.jsonld",
]


# CLASSES
class ai_EnergyConsumption(SHACLObject):
    """
    A class for describing the energy consumption incurred by an AI model in
    different stages of its lifecycle.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/AI/EnergyConsumption"
    COMPACT_TYPE = "ai_EnergyConsumption"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    PROPERTIES = [
        # Specifies the amount of energy consumed when finetuning the AI model that is
        # being used in the AI system.
        ClassProp(
            "ai_finetuningEnergyConsumption",
            lambda:
            ListProp(ObjectProp(ai_EnergyConsumptionDescription, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/finetuningEnergyConsumption",
            compact="ai_finetuningEnergyConsumption",
            deprecated=False,
        ),
        # Specifies the amount of energy consumed during inference time by an AI model
        # that is being used in the AI system.
        ClassProp(
            "ai_inferenceEnergyConsumption",
            lambda:
            ListProp(ObjectProp(ai_EnergyConsumptionDescription, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/inferenceEnergyConsumption",
            compact="ai_inferenceEnergyConsumption",
            deprecated=False,
        ),
        # Specifies the amount of energy consumed when training the AI model that is
        # being used in the AI system.
        ClassProp(
            "ai_trainingEnergyConsumption",
            lambda:
            ListProp(ObjectProp(ai_EnergyConsumptionDescription, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/trainingEnergyConsumption",
            compact="ai_trainingEnergyConsumption",
            deprecated=False,
        ),
    ]


class ai_EnergyConsumptionDescription(SHACLObject):
    """
    The class that helps note down the quantity of energy consumption and the unit
    used for measurement.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/AI/EnergyConsumptionDescription"
    COMPACT_TYPE = "ai_EnergyConsumptionDescription"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    PROPERTIES = [
        # Represents the energy quantity.
        ClassProp(
            "ai_energyQuantity",
            lambda:
            FloatProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/energyQuantity",
            min_count=1,
            compact="ai_energyQuantity",
            deprecated=False,
        ),
        # Specifies the unit in which energy is measured.
        ClassProp(
            "ai_energyUnit",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/AI/EnergyUnitType/kilowattHour", "kilowattHour"),
                    ("https://spdx.org/rdf/3.0.1/terms/AI/EnergyUnitType/megajoule", "megajoule"),
                    ("https://spdx.org/rdf/3.0.1/terms/AI/EnergyUnitType/other", "other"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/energyUnit",
            min_count=1,
            compact="ai_energyUnit",
            deprecated=False,
        ),
    ]


class ai_EnergyUnitType(SHACLObject):
    """
    Specifies the unit of energy consumption.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/AI/EnergyUnitType"
    COMPACT_TYPE = "ai_EnergyUnitType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # Kilowatt-hour.
        "kilowattHour": "https://spdx.org/rdf/3.0.1/terms/AI/EnergyUnitType/kilowattHour",
        # Megajoule.
        "megajoule": "https://spdx.org/rdf/3.0.1/terms/AI/EnergyUnitType/megajoule",
        # Any other units of energy measurement.
        "other": "https://spdx.org/rdf/3.0.1/terms/AI/EnergyUnitType/other",
    }


class ai_SafetyRiskAssessmentType(SHACLObject):
    """
    Specifies the safety risk level.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/AI/SafetyRiskAssessmentType"
    COMPACT_TYPE = "ai_SafetyRiskAssessmentType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # The second-highest level of risk posed by an AI system.
        "high": "https://spdx.org/rdf/3.0.1/terms/AI/SafetyRiskAssessmentType/high",
        # Low/no risk is posed by an AI system.
        "low": "https://spdx.org/rdf/3.0.1/terms/AI/SafetyRiskAssessmentType/low",
        # The third-highest level of risk posed by an AI system.
        "medium": "https://spdx.org/rdf/3.0.1/terms/AI/SafetyRiskAssessmentType/medium",
        # The highest level of risk posed by an AI system.
        "serious": "https://spdx.org/rdf/3.0.1/terms/AI/SafetyRiskAssessmentType/serious",
    }


class AnnotationType(SHACLObject):
    """
    Specifies the type of an annotation.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/AnnotationType"
    COMPACT_TYPE = "AnnotationType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # Used to store extra information about an Element which is not part of a review (e.g. extra information provided during the creation of the Element).
        "other": "https://spdx.org/rdf/3.0.1/terms/Core/AnnotationType/other",
        # Used when someone reviews the Element.
        "review": "https://spdx.org/rdf/3.0.1/terms/Core/AnnotationType/review",
    }


class CreationInfo(SHACLObject):
    """
    Provides information about the creation of the Element.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/CreationInfo"
    COMPACT_TYPE = "CreationInfo"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    PROPERTIES = [
        # Provide consumers with comments by the creator of the Element about the
        # Element.
        ClassProp(
            "comment",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/comment",
            compact="comment",
            deprecated=False,
        ),
        # Identifies when the Element was originally created.
        ClassProp(
            "created",
            lambda:
            DateTimeStampProp(pattern=r"^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/created",
            min_count=1,
            compact="created",
            deprecated=False,
        ),
        # Identifies who or what created the Element.
        ClassProp(
            "createdBy",
            lambda:
            ListProp(ObjectProp(Agent, False, context=(
                    ("https://spdx.org/rdf/3.0.1/terms/Core/SpdxOrganization", "SpdxOrganization"),
                ),)),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/createdBy",
            min_count=1,
            compact="createdBy",
            deprecated=False,
        ),
        # Identifies the tooling that was used during the creation of the Element.
        ClassProp(
            "createdUsing",
            lambda:
            ListProp(ObjectProp(Tool, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/createdUsing",
            compact="createdUsing",
            deprecated=False,
        ),
        # Provides a reference number that can be used to understand how to parse and
        # interpret an Element.
        ClassProp(
            "specVersion",
            lambda:
            StringProp(pattern=r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/specVersion",
            min_count=1,
            compact="specVersion",
            deprecated=False,
        ),
    ]


class DictionaryEntry(SHACLObject):
    """
    A key with an associated value.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/DictionaryEntry"
    COMPACT_TYPE = "DictionaryEntry"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    PROPERTIES = [
        # A key used in a generic key-value pair.
        ClassProp(
            "key",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/key",
            min_count=1,
            compact="key",
            deprecated=False,
        ),
        # A value used in a generic key-value pair.
        ClassProp(
            "value",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/value",
            compact="value",
            deprecated=False,
        ),
    ]


class Element(SHACLObject):
    """
    Base domain class from which all other SPDX-3.0 domain classes derive.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/Element"
    COMPACT_TYPE = "Element"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    IS_ABSTRACT: bool = True
    PROPERTIES = [
        # Provide consumers with comments by the creator of the Element about the
        # Element.
        ClassProp(
            "comment",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/comment",
            compact="comment",
            deprecated=False,
        ),
        # Provides information about the creation of the Element.
        ClassProp(
            "creationInfo",
            lambda:
            ObjectProp(CreationInfo, True),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/creationInfo",
            min_count=1,
            compact="creationInfo",
            deprecated=False,
        ),
        # Provides a detailed description of the Element.
        ClassProp(
            "description",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/description",
            compact="description",
            deprecated=False,
        ),
        # Specifies an Extension characterization of some aspect of an Element.
        ClassProp(
            "extension",
            lambda:
            ListProp(ObjectProp(extension_Extension, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/extension",
            compact="extension",
            deprecated=False,
        ),
        # Provides a reference to a resource outside the scope of SPDX-3.0 content
        # that uniquely identifies an Element.
        ClassProp(
            "externalIdentifier",
            lambda:
            ListProp(ObjectProp(ExternalIdentifier, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/externalIdentifier",
            compact="externalIdentifier",
            deprecated=False,
        ),
        # Points to a resource outside the scope of the SPDX-3.0 content
        # that provides additional characteristics of an Element.
        ClassProp(
            "externalRef",
            lambda:
            ListProp(ObjectProp(ExternalRef, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/externalRef",
            compact="externalRef",
            deprecated=False,
        ),
        # Identifies the name of an Element as designated by the creator.
        ClassProp(
            "name",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/name",
            compact="name",
            deprecated=False,
        ),
        # A short description of an Element.
        ClassProp(
            "summary",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/summary",
            compact="summary",
            deprecated=False,
        ),
        # Provides an IntegrityMethod with which the integrity of an Element can be
        # asserted.
        ClassProp(
            "verifiedUsing",
            lambda:
            ListProp(ObjectProp(IntegrityMethod, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/verifiedUsing",
            compact="verifiedUsing",
            deprecated=False,
        ),
    ]


class ElementCollection(Element):
    """
    A collection of Elements, not necessarily with unifying context.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/ElementCollection"
    COMPACT_TYPE = "ElementCollection"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    IS_ABSTRACT: bool = True
    PROPERTIES = [
        # Refers to one or more Elements that are part of an ElementCollection.
        ClassProp(
            "element",
            lambda:
            ListProp(ObjectProp(Element, False, context=(
                    ("https://spdx.org/rdf/3.0.1/terms/Core/NoAssertionElement", "NoAssertionElement"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/NoneElement", "NoneElement"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/SpdxOrganization", "SpdxOrganization"),
                    ("https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoAssertionLicense", "expandedlicensing_NoAssertionLicense"),
                    ("https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoneLicense", "expandedlicensing_NoneLicense"),
                ),)),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/element",
            compact="element",
            deprecated=False,
        ),
        # Describes one a profile which the creator of this ElementCollection intends to
        # conform to.
        ClassProp(
            "profileConformance",
            lambda:
            ListProp(EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/ai", "ai"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/build", "build"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/core", "core"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/dataset", "dataset"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/expandedLicensing", "expandedLicensing"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/extension", "extension"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/lite", "lite"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/security", "security"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/simpleLicensing", "simpleLicensing"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/software", "software"),
                ))),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/profileConformance",
            compact="profileConformance",
            deprecated=False,
        ),
        # This property is used to denote the root Element(s) of a tree of elements contained in a BOM.
        ClassProp(
            "rootElement",
            lambda:
            ListProp(ObjectProp(Element, False, context=(
                    ("https://spdx.org/rdf/3.0.1/terms/Core/NoAssertionElement", "NoAssertionElement"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/NoneElement", "NoneElement"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/SpdxOrganization", "SpdxOrganization"),
                    ("https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoAssertionLicense", "expandedlicensing_NoAssertionLicense"),
                    ("https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoneLicense", "expandedlicensing_NoneLicense"),
                ),)),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/rootElement",
            compact="rootElement",
            deprecated=False,
        ),
    ]


class ExternalIdentifier(SHACLObject):
    """
    A reference to a resource identifier defined outside the scope of SPDX-3.0 content that uniquely identifies an Element.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifier"
    COMPACT_TYPE = "ExternalIdentifier"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    PROPERTIES = [
        # Provide consumers with comments by the creator of the Element about the
        # Element.
        ClassProp(
            "comment",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/comment",
            compact="comment",
            deprecated=False,
        ),
        # Specifies the type of the external identifier.
        ClassProp(
            "externalIdentifierType",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/cpe22", "cpe22"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/cpe23", "cpe23"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/cve", "cve"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/email", "email"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/gitoid", "gitoid"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/other", "other"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/packageUrl", "packageUrl"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/securityOther", "securityOther"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/swhid", "swhid"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/swid", "swid"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/urlScheme", "urlScheme"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/externalIdentifierType",
            min_count=1,
            compact="externalIdentifierType",
            deprecated=False,
        ),
        # Uniquely identifies an external element.
        ClassProp(
            "identifier",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/identifier",
            min_count=1,
            compact="identifier",
            deprecated=False,
        ),
        # Provides the location for more information regarding an external identifier.
        ClassProp(
            "identifierLocator",
            lambda:
            ListProp(AnyURIProp()),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/identifierLocator",
            compact="identifierLocator",
            deprecated=False,
        ),
        # An entity that is authorized to issue identification credentials.
        ClassProp(
            "issuingAuthority",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/issuingAuthority",
            compact="issuingAuthority",
            deprecated=False,
        ),
    ]


class ExternalIdentifierType(SHACLObject):
    """
    Specifies the type of an external identifier.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType"
    COMPACT_TYPE = "ExternalIdentifierType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # [Common Platform Enumeration Specification 2.2](https://cpe.mitre.org/files/cpe-specification_2.2.pdf)
        "cpe22": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/cpe22",
        # [Common Platform Enumeration: Naming Specification Version 2.3](https://csrc.nist.gov/publications/detail/nistir/7695/final)
        "cpe23": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/cpe23",
        # Common Vulnerabilities and Exposures identifiers, an identifier for a specific software flaw defined within the official CVE Dictionary and that conforms to the [CVE specification](https://csrc.nist.gov/glossary/term/cve_id).
        "cve": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/cve",
        # Email address, as defined in [RFC 3696](https://datatracker.ietf.org/doc/rfc3986/) Section 3.
        "email": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/email",
        # [Gitoid](https://www.iana.org/assignments/uri-schemes/prov/gitoid), stands for [Git Object ID](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). A gitoid of type blob is a unique hash of a binary artifact. A gitoid may represent either an [Artifact Identifier](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-identifier-types) for the software artifact or an [Input Manifest Identifier](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#input-manifest-identifier) for the software artifact's associated [Artifact Input Manifest](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-input-manifest); this ambiguity exists because the Artifact Input Manifest is itself an artifact, and the gitoid of that artifact is its valid identifier. Gitoids calculated on software artifacts (Snippet, File, or Package Elements) should be recorded in the SPDX 3.0 SoftwareArtifact's contentIdentifier property. Gitoids calculated on the Artifact Input Manifest (Input Manifest Identifier) should be recorded in the SPDX 3.0 Element's externalIdentifier property. See [OmniBOR Specification](https://github.com/omnibor/spec/), a minimalistic specification for describing software [Artifact Dependency Graphs](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-dependency-graph-adg).
        "gitoid": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/gitoid",
        # Used when the type does not match any of the other options.
        "other": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/other",
        # Package URL, as defined in the corresponding [Annex](../../../annexes/pkg-url-specification.md) of this specification.
        "packageUrl": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/packageUrl",
        # Used when there is a security related identifier of unspecified type.
        "securityOther": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/securityOther",
        # SoftWare Hash IDentifier, a persistent intrinsic identifier for digital artifacts, such as files, trees (also known as directories or folders), commits, and other objects typically found in version control systems. The format of the identifiers is defined in the [SWHID specification](https://www.swhid.org/specification/v1.1/4.Syntax) (ISO/IEC DIS 18670). They typically look like `swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2`.
        "swhid": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/swhid",
        # Concise Software Identification (CoSWID) tag, as defined in [RFC 9393](https://datatracker.ietf.org/doc/rfc9393/) Section 2.3.
        "swid": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/swid",
        # [Uniform Resource Identifier (URI) Schemes](https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml). The scheme used in order to locate a resource.
        "urlScheme": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalIdentifierType/urlScheme",
    }


class ExternalMap(SHACLObject):
    """
    A map of Element identifiers that are used within an SpdxDocument but defined
    external to that SpdxDocument.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/ExternalMap"
    COMPACT_TYPE = "ExternalMap"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    PROPERTIES = [
        # Artifact representing a serialization instance of SPDX data containing the
        # definition of a particular Element.
        ClassProp(
            "definingArtifact",
            lambda:
            ObjectProp(Artifact, False),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/definingArtifact",
            compact="definingArtifact",
            deprecated=False,
        ),
        # Identifies an external Element used within an SpdxDocument but defined
        # external to that SpdxDocument.
        ClassProp(
            "externalSpdxId",
            lambda:
            AnyURIProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/externalSpdxId",
            min_count=1,
            compact="externalSpdxId",
            deprecated=False,
        ),
        # Provides an indication of where to retrieve an external Element.
        ClassProp(
            "locationHint",
            lambda:
            AnyURIProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/locationHint",
            compact="locationHint",
            deprecated=False,
        ),
        # Provides an IntegrityMethod with which the integrity of an Element can be
        # asserted.
        ClassProp(
            "verifiedUsing",
            lambda:
            ListProp(ObjectProp(IntegrityMethod, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/verifiedUsing",
            compact="verifiedUsing",
            deprecated=False,
        ),
    ]


class ExternalRef(SHACLObject):
    """
    A reference to a resource outside the scope of SPDX-3.0 content related to an Element.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRef"
    COMPACT_TYPE = "ExternalRef"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    PROPERTIES = [
        # Provide consumers with comments by the creator of the Element about the
        # Element.
        ClassProp(
            "comment",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/comment",
            compact="comment",
            deprecated=False,
        ),
        # Provides information about the content type of an Element or a Property.
        ClassProp(
            "contentType",
            lambda:
            StringProp(pattern=r"^[^\/]+\/[^\/]+$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/contentType",
            compact="contentType",
            deprecated=False,
        ),
        # Specifies the type of the external reference.
        ClassProp(
            "externalRefType",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/altDownloadLocation", "altDownloadLocation"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/altWebPage", "altWebPage"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/binaryArtifact", "binaryArtifact"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/bower", "bower"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/buildMeta", "buildMeta"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/buildSystem", "buildSystem"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/certificationReport", "certificationReport"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/chat", "chat"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/componentAnalysisReport", "componentAnalysisReport"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/cwe", "cwe"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/documentation", "documentation"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/dynamicAnalysisReport", "dynamicAnalysisReport"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/eolNotice", "eolNotice"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/exportControlAssessment", "exportControlAssessment"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/funding", "funding"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/issueTracker", "issueTracker"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/license", "license"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/mailingList", "mailingList"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/mavenCentral", "mavenCentral"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/metrics", "metrics"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/npm", "npm"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/nuget", "nuget"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/other", "other"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/privacyAssessment", "privacyAssessment"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/productMetadata", "productMetadata"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/purchaseOrder", "purchaseOrder"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/qualityAssessmentReport", "qualityAssessmentReport"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/releaseHistory", "releaseHistory"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/releaseNotes", "releaseNotes"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/riskAssessment", "riskAssessment"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/runtimeAnalysisReport", "runtimeAnalysisReport"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/secureSoftwareAttestation", "secureSoftwareAttestation"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/securityAdversaryModel", "securityAdversaryModel"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/securityAdvisory", "securityAdvisory"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/securityFix", "securityFix"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/securityOther", "securityOther"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/securityPenTestReport", "securityPenTestReport"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/securityPolicy", "securityPolicy"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/securityThreatModel", "securityThreatModel"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/socialMedia", "socialMedia"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/sourceArtifact", "sourceArtifact"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/staticAnalysisReport", "staticAnalysisReport"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/support", "support"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/vcs", "vcs"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/vulnerabilityDisclosureReport", "vulnerabilityDisclosureReport"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/vulnerabilityExploitabilityAssessment", "vulnerabilityExploitabilityAssessment"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/externalRefType",
            compact="externalRefType",
            deprecated=False,
        ),
        # Provides the location of an external reference.
        ClassProp(
            "locator",
            lambda:
            ListProp(StringProp()),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/locator",
            compact="locator",
            deprecated=False,
        ),
    ]


class ExternalRefType(SHACLObject):
    """
    Specifies the type of an external reference.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType"
    COMPACT_TYPE = "ExternalRefType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # A reference to an alternative download location.
        "altDownloadLocation": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/altDownloadLocation",
        # A reference to an alternative web page.
        "altWebPage": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/altWebPage",
        # A reference to binary artifacts related to a package.
        "binaryArtifact": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/binaryArtifact",
        # A reference to a Bower package. The package locator format, looks like `package#version`, is defined in the "install" section of [Bower API documentation](https://bower.io/docs/api/#install).
        "bower": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/bower",
        # A reference build metadata related to a published package.
        "buildMeta": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/buildMeta",
        # A reference build system used to create or publish the package.
        "buildSystem": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/buildSystem",
        # A reference to a certification report for a package from an accredited/independent body.
        "certificationReport": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/certificationReport",
        # A reference to the instant messaging system used by the maintainer for a package.
        "chat": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/chat",
        # A reference to a Software Composition Analysis (SCA) report.
        "componentAnalysisReport": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/componentAnalysisReport",
        # [Common Weakness Enumeration](https://csrc.nist.gov/glossary/term/common_weakness_enumeration). A reference to a source of software flaw defined within the official [CWE List](https://cwe.mitre.org/data/) that conforms to the [CWE specification](https://cwe.mitre.org/).
        "cwe": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/cwe",
        # A reference to the documentation for a package.
        "documentation": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/documentation",
        # A reference to a dynamic analysis report for a package.
        "dynamicAnalysisReport": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/dynamicAnalysisReport",
        # A reference to the End Of Sale (EOS) and/or End Of Life (EOL) information related to a package.
        "eolNotice": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/eolNotice",
        # A reference to a export control assessment for a package.
        "exportControlAssessment": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/exportControlAssessment",
        # A reference to funding information related to a package.
        "funding": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/funding",
        # A reference to the issue tracker for a package.
        "issueTracker": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/issueTracker",
        # A reference to additional license information related to an artifact.
        "license": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/license",
        # A reference to the mailing list used by the maintainer for a package.
        "mailingList": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/mailingList",
        # A reference to a Maven repository artifact. The artifact locator format is defined in the [Maven documentation](https://maven.apache.org/guides/mini/guide-naming-conventions.html) and looks like `groupId:artifactId[:version]`.
        "mavenCentral": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/mavenCentral",
        # A reference to metrics related to package such as OpenSSF scorecards.
        "metrics": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/metrics",
        # A reference to an npm package. The package locator format is defined in the [npm documentation](https://docs.npmjs.com/cli/v10/configuring-npm/package-json) and looks like `package@version`.
        "npm": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/npm",
        # A reference to a NuGet package. The package locator format is defined in the [NuGet documentation](https://docs.nuget.org) and looks like `package/version`.
        "nuget": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/nuget",
        # Used when the type does not match any of the other options.
        "other": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/other",
        # A reference to a privacy assessment for a package.
        "privacyAssessment": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/privacyAssessment",
        # A reference to additional product metadata such as reference within organization's product catalog.
        "productMetadata": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/productMetadata",
        # A reference to a purchase order for a package.
        "purchaseOrder": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/purchaseOrder",
        # A reference to a quality assessment for a package.
        "qualityAssessmentReport": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/qualityAssessmentReport",
        # A reference to a published list of releases for a package.
        "releaseHistory": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/releaseHistory",
        # A reference to the release notes for a package.
        "releaseNotes": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/releaseNotes",
        # A reference to a risk assessment for a package.
        "riskAssessment": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/riskAssessment",
        # A reference to a runtime analysis report for a package.
        "runtimeAnalysisReport": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/runtimeAnalysisReport",
        # A reference to information assuring that the software is developed using security practices as defined by [NIST SP 800-218 Secure Software Development Framework (SSDF) Version 1.1](https://csrc.nist.gov/pubs/sp/800/218/final) or [CISA Secure Software Development Attestation Form](https://www.cisa.gov/resources-tools/resources/secure-software-development-attestation-form).
        "secureSoftwareAttestation": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/secureSoftwareAttestation",
        # A reference to the security adversary model for a package.
        "securityAdversaryModel": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/securityAdversaryModel",
        # A reference to a published security advisory (where advisory as defined per [ISO 29147:2018](https://www.iso.org/standard/72311.html)) that may affect one or more elements, e.g., vendor advisories or specific NVD entries.
        "securityAdvisory": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/securityAdvisory",
        # A reference to the patch or source code that fixes a vulnerability.
        "securityFix": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/securityFix",
        # A reference to related security information of unspecified type.
        "securityOther": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/securityOther",
        # A reference to a [penetration test](https://en.wikipedia.org/wiki/Penetration_test) report for a package.
        "securityPenTestReport": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/securityPenTestReport",
        # A reference to instructions for reporting newly discovered security vulnerabilities for a package.
        "securityPolicy": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/securityPolicy",
        # A reference the [security threat model](https://en.wikipedia.org/wiki/Threat_model) for a package.
        "securityThreatModel": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/securityThreatModel",
        # A reference to a social media channel for a package.
        "socialMedia": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/socialMedia",
        # A reference to an artifact containing the sources for a package.
        "sourceArtifact": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/sourceArtifact",
        # A reference to a static analysis report for a package.
        "staticAnalysisReport": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/staticAnalysisReport",
        # A reference to the software support channel or other support information for a package.
        "support": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/support",
        # A reference to a version control system related to a software artifact.
        "vcs": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/vcs",
        # A reference to a Vulnerability Disclosure Report (VDR) which provides the software supplier's analysis and findings describing the impact (or lack of impact) that reported vulnerabilities have on packages or products in the supplier's SBOM as defined in [NIST SP 800-161 Cybersecurity Supply Chain Risk Management Practices for Systems and Organizations](https://csrc.nist.gov/pubs/sp/800/161/r1/final).
        "vulnerabilityDisclosureReport": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/vulnerabilityDisclosureReport",
        # A reference to a Vulnerability Exploitability eXchange (VEX) statement which provides information on whether a product is impacted by a specific vulnerability in an included package and, if affected, whether there are actions recommended to remediate. See also [NTIA VEX one-page summary](https://ntia.gov/files/ntia/publications/vex_one-page_summary.pdf).
        "vulnerabilityExploitabilityAssessment": "https://spdx.org/rdf/3.0.1/terms/Core/ExternalRefType/vulnerabilityExploitabilityAssessment",
    }


class HashAlgorithm(SHACLObject):
    """
    A mathematical algorithm that maps data of arbitrary size to a bit string.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm"
    COMPACT_TYPE = "HashAlgorithm"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # Adler-32 checksum is part of the widely used zlib compression library as defined in [RFC 1950](https://datatracker.ietf.org/doc/rfc1950/) Section 2.3.
        "adler32": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/adler32",
        # BLAKE2b algorithm with a digest size of 256, as defined in [RFC 7693](https://datatracker.ietf.org/doc/rfc7693/) Section 4.
        "blake2b256": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/blake2b256",
        # BLAKE2b algorithm with a digest size of 384, as defined in [RFC 7693](https://datatracker.ietf.org/doc/rfc7693/) Section 4.
        "blake2b384": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/blake2b384",
        # BLAKE2b algorithm with a digest size of 512, as defined in [RFC 7693](https://datatracker.ietf.org/doc/rfc7693/) Section 4.
        "blake2b512": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/blake2b512",
        # [BLAKE3](https://github.com/BLAKE3-team/BLAKE3-specs/blob/master/blake3.pdf)
        "blake3": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/blake3",
        # [Dilithium](https://pq-crystals.org/dilithium/)
        "crystalsDilithium": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/crystalsDilithium",
        # [Kyber](https://pq-crystals.org/kyber/)
        "crystalsKyber": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/crystalsKyber",
        # [FALCON](https://falcon-sign.info/falcon.pdf)
        "falcon": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/falcon",
        # MD2 message-digest algorithm, as defined in [RFC 1319](https://datatracker.ietf.org/doc/rfc1319/).
        "md2": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/md2",
        # MD4 message-digest algorithm, as defined in [RFC 1186](https://datatracker.ietf.org/doc/rfc1186/).
        "md4": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/md4",
        # MD5 message-digest algorithm, as defined in [RFC 1321](https://datatracker.ietf.org/doc/rfc1321/).
        "md5": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/md5",
        # [MD6 hash function](https://people.csail.mit.edu/rivest/pubs/RABCx08.pdf)
        "md6": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/md6",
        # any hashing algorithm that does not exist in this list of entries
        "other": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/other",
        # SHA-1, a secure hashing algorithm, as defined in [RFC 3174](https://datatracker.ietf.org/doc/rfc3174/).
        "sha1": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha1",
        # SHA-2 with a digest length of 224, as defined in [RFC 3874](https://datatracker.ietf.org/doc/rfc3874/).
        "sha224": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha224",
        # SHA-2 with a digest length of 256, as defined in [RFC 6234](https://datatracker.ietf.org/doc/rfc6234/).
        "sha256": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha256",
        # SHA-2 with a digest length of 384, as defined in [RFC 6234](https://datatracker.ietf.org/doc/rfc6234/).
        "sha384": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha384",
        # SHA-3 with a digest length of 224, as defined in [FIPS 202](https://csrc.nist.gov/pubs/fips/202/final).
        "sha3_224": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha3_224",
        # SHA-3 with a digest length of 256, as defined in [FIPS 202](https://csrc.nist.gov/pubs/fips/202/final).
        "sha3_256": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha3_256",
        # SHA-3 with a digest length of 384, as defined in [FIPS 202](https://csrc.nist.gov/pubs/fips/202/final).
        "sha3_384": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha3_384",
        # SHA-3 with a digest length of 512, as defined in [FIPS 202](https://csrc.nist.gov/pubs/fips/202/final).
        "sha3_512": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha3_512",
        # SHA-2 with a digest length of 512, as defined in [RFC 6234](https://datatracker.ietf.org/doc/rfc6234/).
        "sha512": "https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha512",
    }


class IndividualElement(Element):
    """
    A concrete subclass of Element used by Individuals in the
    Core profile.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/IndividualElement"
    COMPACT_TYPE = "IndividualElement"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # An Individual Value for Element representing a set of Elements of unknown
        # identify or cardinality (number).
        "NoAssertionElement": "https://spdx.org/rdf/3.0.1/terms/Core/NoAssertionElement",
        # An Individual Value for Element representing a set of Elements with
        # cardinality (number/count) of zero.
        "NoneElement": "https://spdx.org/rdf/3.0.1/terms/Core/NoneElement",
    }


class IntegrityMethod(SHACLObject):
    """
    Provides an independently reproducible mechanism that permits verification of a specific Element.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/IntegrityMethod"
    COMPACT_TYPE = "IntegrityMethod"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    IS_ABSTRACT: bool = True
    PROPERTIES = [
        # Provide consumers with comments by the creator of the Element about the
        # Element.
        ClassProp(
            "comment",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/comment",
            compact="comment",
            deprecated=False,
        ),
    ]


class LifecycleScopeType(SHACLObject):
    """
    Provide an enumerated set of lifecycle phases that can provide context to relationships.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/LifecycleScopeType"
    COMPACT_TYPE = "LifecycleScopeType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # A relationship has specific context implications during an element's build phase, during development.
        "build": "https://spdx.org/rdf/3.0.1/terms/Core/LifecycleScopeType/build",
        # A relationship has specific context implications during an element's design.
        "design": "https://spdx.org/rdf/3.0.1/terms/Core/LifecycleScopeType/design",
        # A relationship has specific context implications during development phase of an element.
        "development": "https://spdx.org/rdf/3.0.1/terms/Core/LifecycleScopeType/development",
        # A relationship has other specific context information necessary to capture that the above set of enumerations does not handle.
        "other": "https://spdx.org/rdf/3.0.1/terms/Core/LifecycleScopeType/other",
        # A relationship has specific context implications during the execution phase of an element.
        "runtime": "https://spdx.org/rdf/3.0.1/terms/Core/LifecycleScopeType/runtime",
        # A relationship has specific context implications during an element's testing phase, during development.
        "test": "https://spdx.org/rdf/3.0.1/terms/Core/LifecycleScopeType/test",
    }


class NamespaceMap(SHACLObject):
    """
    A mapping between prefixes and namespace partial URIs.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/NamespaceMap"
    COMPACT_TYPE = "NamespaceMap"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    PROPERTIES = [
        # Provides an unambiguous mechanism for conveying a URI fragment portion of an
        # Element ID.
        ClassProp(
            "namespace",
            lambda:
            AnyURIProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/namespace",
            min_count=1,
            compact="namespace",
            deprecated=False,
        ),
        # A substitute for a URI.
        ClassProp(
            "prefix",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/prefix",
            min_count=1,
            compact="prefix",
            deprecated=False,
        ),
    ]


class PackageVerificationCode(IntegrityMethod):
    """
    An SPDX version 2.X compatible verification method for software packages.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/PackageVerificationCode"
    COMPACT_TYPE = "PackageVerificationCode"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    PROPERTIES = [
        # Specifies the algorithm used for calculating the hash value.
        ClassProp(
            "algorithm",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/adler32", "adler32"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/blake2b256", "blake2b256"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/blake2b384", "blake2b384"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/blake2b512", "blake2b512"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/blake3", "blake3"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/crystalsDilithium", "crystalsDilithium"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/crystalsKyber", "crystalsKyber"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/falcon", "falcon"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/md2", "md2"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/md4", "md4"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/md5", "md5"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/md6", "md6"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/other", "other"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha1", "sha1"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha224", "sha224"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha256", "sha256"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha384", "sha384"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha3_224", "sha3_224"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha3_256", "sha3_256"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha3_384", "sha3_384"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha3_512", "sha3_512"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha512", "sha512"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/algorithm",
            min_count=1,
            compact="algorithm",
            deprecated=False,
        ),
        # The result of applying a hash algorithm to an Element.
        ClassProp(
            "hashValue",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/hashValue",
            min_count=1,
            compact="hashValue",
            deprecated=False,
        ),
        # The relative file name of a file to be excluded from the
        # `PackageVerificationCode`.
        ClassProp(
            "packageVerificationCodeExcludedFile",
            lambda:
            ListProp(StringProp()),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/packageVerificationCodeExcludedFile",
            compact="packageVerificationCodeExcludedFile",
            deprecated=False,
        ),
    ]


class PositiveIntegerRange(SHACLObject):
    """
    A tuple of two positive integers that define a range.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/PositiveIntegerRange"
    COMPACT_TYPE = "PositiveIntegerRange"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    PROPERTIES = [
        # Defines the beginning of a range.
        ClassProp(
            "beginIntegerRange",
            lambda:
            PositiveIntegerProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/beginIntegerRange",
            min_count=1,
            compact="beginIntegerRange",
            deprecated=False,
        ),
        # Defines the end of a range.
        ClassProp(
            "endIntegerRange",
            lambda:
            PositiveIntegerProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/endIntegerRange",
            min_count=1,
            compact="endIntegerRange",
            deprecated=False,
        ),
    ]


class PresenceType(SHACLObject):
    """
    Categories of presence or absence.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/PresenceType"
    COMPACT_TYPE = "PresenceType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # Indicates absence of the field.
        "no": "https://spdx.org/rdf/3.0.1/terms/Core/PresenceType/no",
        # Makes no assertion about the field.
        "noAssertion": "https://spdx.org/rdf/3.0.1/terms/Core/PresenceType/noAssertion",
        # Indicates presence of the field.
        "yes": "https://spdx.org/rdf/3.0.1/terms/Core/PresenceType/yes",
    }


class ProfileIdentifierType(SHACLObject):
    """
    Enumeration of the valid profiles.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType"
    COMPACT_TYPE = "ProfileIdentifierType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # the element follows the AI profile specification
        "ai": "https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/ai",
        # the element follows the Build profile specification
        "build": "https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/build",
        # the element follows the Core profile specification
        "core": "https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/core",
        # the element follows the Dataset profile specification
        "dataset": "https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/dataset",
        # the element follows the ExpandedLicensing profile specification
        "expandedLicensing": "https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/expandedLicensing",
        # the element follows the Extension profile specification
        "extension": "https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/extension",
        # the element follows the Lite profile specification
        "lite": "https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/lite",
        # the element follows the Security profile specification
        "security": "https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/security",
        # the element follows the SimpleLicensing profile specification
        "simpleLicensing": "https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/simpleLicensing",
        # the element follows the Software profile specification
        "software": "https://spdx.org/rdf/3.0.1/terms/Core/ProfileIdentifierType/software",
    }


class Relationship(Element):
    """
    Describes a relationship between one or more elements.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/Relationship"
    COMPACT_TYPE = "Relationship"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Provides information about the completeness of relationships.
        ClassProp(
            "completeness",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipCompleteness/complete", "complete"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipCompleteness/incomplete", "incomplete"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipCompleteness/noAssertion", "noAssertion"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/completeness",
            compact="completeness",
            deprecated=False,
        ),
        # Specifies the time from which an element is no longer applicable / valid.
        ClassProp(
            "endTime",
            lambda:
            DateTimeStampProp(pattern=r"^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/endTime",
            compact="endTime",
            deprecated=False,
        ),
        # References the Element on the left-hand side of a relationship.
        ClassProp(
            "from_",
            lambda:
            ObjectProp(Element, True, context=(
                    ("https://spdx.org/rdf/3.0.1/terms/Core/NoAssertionElement", "NoAssertionElement"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/NoneElement", "NoneElement"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/SpdxOrganization", "SpdxOrganization"),
                    ("https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoAssertionLicense", "expandedlicensing_NoAssertionLicense"),
                    ("https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoneLicense", "expandedlicensing_NoneLicense"),
                ),),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/from",
            min_count=1,
            compact="from",
            deprecated=False,
        ),
        # Information about the relationship between two Elements.
        ClassProp(
            "relationshipType",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/affects", "affects"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/amendedBy", "amendedBy"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/ancestorOf", "ancestorOf"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/availableFrom", "availableFrom"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/configures", "configures"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/contains", "contains"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/coordinatedBy", "coordinatedBy"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/copiedTo", "copiedTo"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/delegatedTo", "delegatedTo"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/dependsOn", "dependsOn"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/descendantOf", "descendantOf"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/describes", "describes"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/doesNotAffect", "doesNotAffect"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/expandsTo", "expandsTo"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/exploitCreatedBy", "exploitCreatedBy"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/fixedBy", "fixedBy"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/fixedIn", "fixedIn"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/foundBy", "foundBy"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/generates", "generates"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasAddedFile", "hasAddedFile"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasAssessmentFor", "hasAssessmentFor"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasAssociatedVulnerability", "hasAssociatedVulnerability"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasConcludedLicense", "hasConcludedLicense"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasDataFile", "hasDataFile"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasDeclaredLicense", "hasDeclaredLicense"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasDeletedFile", "hasDeletedFile"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasDependencyManifest", "hasDependencyManifest"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasDistributionArtifact", "hasDistributionArtifact"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasDocumentation", "hasDocumentation"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasDynamicLink", "hasDynamicLink"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasEvidence", "hasEvidence"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasExample", "hasExample"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasHost", "hasHost"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasInput", "hasInput"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasMetadata", "hasMetadata"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasOptionalComponent", "hasOptionalComponent"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasOptionalDependency", "hasOptionalDependency"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasOutput", "hasOutput"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasPrerequisite", "hasPrerequisite"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasProvidedDependency", "hasProvidedDependency"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasRequirement", "hasRequirement"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasSpecification", "hasSpecification"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasStaticLink", "hasStaticLink"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasTest", "hasTest"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasTestCase", "hasTestCase"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasVariant", "hasVariant"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/invokedBy", "invokedBy"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/modifiedBy", "modifiedBy"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/other", "other"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/packagedBy", "packagedBy"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/patchedBy", "patchedBy"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/publishedBy", "publishedBy"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/reportedBy", "reportedBy"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/republishedBy", "republishedBy"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/serializedInArtifact", "serializedInArtifact"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/testedOn", "testedOn"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/trainedOn", "trainedOn"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/underInvestigationFor", "underInvestigationFor"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/usesTool", "usesTool"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/relationshipType",
            min_count=1,
            compact="relationshipType",
            deprecated=False,
        ),
        # Specifies the time from which an element is applicable / valid.
        ClassProp(
            "startTime",
            lambda:
            DateTimeStampProp(pattern=r"^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/startTime",
            compact="startTime",
            deprecated=False,
        ),
        # References an Element on the right-hand side of a relationship.
        ClassProp(
            "to",
            lambda:
            ListProp(ObjectProp(Element, False, context=(
                    ("https://spdx.org/rdf/3.0.1/terms/Core/NoAssertionElement", "NoAssertionElement"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/NoneElement", "NoneElement"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/SpdxOrganization", "SpdxOrganization"),
                    ("https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoAssertionLicense", "expandedlicensing_NoAssertionLicense"),
                    ("https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoneLicense", "expandedlicensing_NoneLicense"),
                ),)),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/to",
            min_count=1,
            compact="to",
            deprecated=False,
        ),
    ]


class RelationshipCompleteness(SHACLObject):
    """
    Indicates whether a relationship is known to be complete, incomplete, or if no assertion is made with respect to relationship completeness.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipCompleteness"
    COMPACT_TYPE = "RelationshipCompleteness"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # The relationship is known to be exhaustive.
        "complete": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipCompleteness/complete",
        # The relationship is known not to be exhaustive.
        "incomplete": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipCompleteness/incomplete",
        # No assertion can be made about the completeness of the relationship.
        "noAssertion": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipCompleteness/noAssertion",
    }


class RelationshipType(SHACLObject):
    """
    Information about the relationship between two Elements.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType"
    COMPACT_TYPE = "RelationshipType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # The `from` Vulnerability affects each `to` Element. The use of the `affects` type is constrained to `VexAffectedVulnAssessmentRelationship` classed relationships.
        "affects": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/affects",
        # The `from` Element is amended by each `to` Element.
        "amendedBy": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/amendedBy",
        # The `from` Element is an ancestor of each `to` Element.
        "ancestorOf": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/ancestorOf",
        # The `from` Element is available from the additional supplier described by each `to` Element.
        "availableFrom": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/availableFrom",
        # The `from` Element is a configuration applied to each `to` Element, during a LifecycleScopeType period.
        "configures": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/configures",
        # The `from` Element contains each `to` Element.
        "contains": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/contains",
        # The `from` Vulnerability is coordinatedBy the `to` Agent(s) (vendor, researcher, or consumer agent).
        "coordinatedBy": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/coordinatedBy",
        # The `from` Element has been copied to each `to` Element.
        "copiedTo": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/copiedTo",
        # The `from` Agent is delegating an action to the Agent of the `to` Relationship (which must be of type invokedBy), during a LifecycleScopeType (e.g. the `to` invokedBy Relationship is being done on behalf of `from`).
        "delegatedTo": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/delegatedTo",
        # The `from` Element depends on each `to` Element, during a LifecycleScopeType period.
        "dependsOn": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/dependsOn",
        # The `from` Element is a descendant of each `to` Element.
        "descendantOf": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/descendantOf",
        # The `from` Element describes each `to` Element. To denote the root(s) of a tree of elements in a collection, the rootElement property should be used.
        "describes": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/describes",
        # The `from` Vulnerability has no impact on each `to` Element. The use of the `doesNotAffect` is constrained to `VexNotAffectedVulnAssessmentRelationship` classed relationships.
        "doesNotAffect": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/doesNotAffect",
        # The `from` archive expands out as an artifact described by each `to` Element.
        "expandsTo": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/expandsTo",
        # The `from` Vulnerability has had an exploit created against it by each `to` Agent.
        "exploitCreatedBy": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/exploitCreatedBy",
        # Designates a `from` Vulnerability has been fixed by the `to` Agent(s).
        "fixedBy": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/fixedBy",
        # A `from` Vulnerability has been fixed in each `to` Element. The use of the `fixedIn` type is constrained to `VexFixedVulnAssessmentRelationship` classed relationships.
        "fixedIn": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/fixedIn",
        # Designates a `from` Vulnerability was originally discovered by the `to` Agent(s).
        "foundBy": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/foundBy",
        # The `from` Element generates each `to` Element.
        "generates": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/generates",
        # Every `to` Element is a file added to the `from` Element (`from` hasAddedFile `to`).
        "hasAddedFile": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasAddedFile",
        # Relates a `from` Vulnerability and each `to` Element with a security assessment. To be used with `VulnAssessmentRelationship` types.
        "hasAssessmentFor": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasAssessmentFor",
        # Used to associate a `from` Artifact with each `to` Vulnerability.
        "hasAssociatedVulnerability": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasAssociatedVulnerability",
        # The `from` SoftwareArtifact is concluded by the SPDX data creator to be governed by each `to` license.
        "hasConcludedLicense": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasConcludedLicense",
        # The `from` Element treats each `to` Element as a data file. A data file is an artifact that stores data required or optional for the `from` Element's functionality. A data file can be a database file, an index file, a log file, an AI model file, a calibration data file, a temporary file, a backup file, and more. For AI training dataset, test dataset, test artifact, configuration data, build input data, and build output data, please consider using the more specific relationship types: `trainedOn`, `testedOn`, `hasTest`, `configures`, `hasInput`, and `hasOutput`, respectively. This relationship does not imply dependency.
        "hasDataFile": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasDataFile",
        # The `from` SoftwareArtifact was discovered to actually contain each `to` license, for example as detected by use of automated tooling.
        "hasDeclaredLicense": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasDeclaredLicense",
        # Every `to` Element is a file deleted from the `from` Element (`from` hasDeletedFile `to`).
        "hasDeletedFile": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasDeletedFile",
        # The `from` Element has manifest files that contain dependency information in each `to` Element.
        "hasDependencyManifest": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasDependencyManifest",
        # The `from` Element is distributed as an artifact in each `to` Element (e.g. an RPM or archive file).
        "hasDistributionArtifact": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasDistributionArtifact",
        # The `from` Element is documented by each `to` Element.
        "hasDocumentation": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasDocumentation",
        # The `from` Element dynamically links in each `to` Element, during a LifecycleScopeType period.
        "hasDynamicLink": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasDynamicLink",
        # Every `to` Element is considered as evidence for the `from` Element (`from` hasEvidence `to`).
        "hasEvidence": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasEvidence",
        # Every `to` Element is an example for the `from` Element (`from` hasExample `to`).
        "hasExample": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasExample",
        # The `from` Build was run on the `to` Element during a LifecycleScopeType period (e.g. the host that the build runs on).
        "hasHost": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasHost",
        # The `from` Build has each `to` Element as an input, during a LifecycleScopeType period.
        "hasInput": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasInput",
        # Every `to` Element is metadata about the `from` Element (`from` hasMetadata `to`).
        "hasMetadata": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasMetadata",
        # Every `to` Element is an optional component of the `from` Element (`from` hasOptionalComponent `to`).
        "hasOptionalComponent": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasOptionalComponent",
        # The `from` Element optionally depends on each `to` Element, during a LifecycleScopeType period.
        "hasOptionalDependency": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasOptionalDependency",
        # The `from` Build element generates each `to` Element as an output, during a LifecycleScopeType period.
        "hasOutput": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasOutput",
        # The `from` Element has a prerequisite on each `to` Element, during a LifecycleScopeType period.
        "hasPrerequisite": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasPrerequisite",
        # The `from` Element has a dependency on each `to` Element, dependency is not in the distributed artifact, but assumed to be provided, during a LifecycleScopeType period.
        "hasProvidedDependency": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasProvidedDependency",
        # The `from` Element has a requirement on each `to` Element, during a LifecycleScopeType period.
        "hasRequirement": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasRequirement",
        # Every `to` Element is a specification for the `from` Element (`from` hasSpecification `to`), during a LifecycleScopeType period.
        "hasSpecification": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasSpecification",
        # The `from` Element statically links in each `to` Element, during a LifecycleScopeType period.
        "hasStaticLink": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasStaticLink",
        # Every `to` Element is a test artifact for the `from` Element (`from` hasTest `to`), during a LifecycleScopeType period.
        "hasTest": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasTest",
        # Every `to` Element is a test case for the `from` Element (`from` hasTestCase `to`).
        "hasTestCase": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasTestCase",
        # Every `to` Element is a variant the `from` Element (`from` hasVariant `to`).
        "hasVariant": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/hasVariant",
        # The `from` Element was invoked by the `to` Agent, during a LifecycleScopeType period (for example, a Build element that describes a build step).
        "invokedBy": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/invokedBy",
        # The `from` Element is modified by each `to` Element.
        "modifiedBy": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/modifiedBy",
        # Every `to` Element is related to the `from` Element where the relationship type is not described by any of the SPDX relationship types (this relationship is directionless).
        "other": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/other",
        # Every `to` Element is a packaged instance of the `from` Element (`from` packagedBy `to`).
        "packagedBy": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/packagedBy",
        # Every `to` Element is a patch for the `from` Element (`from` patchedBy `to`).
        "patchedBy": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/patchedBy",
        # Designates a `from` Vulnerability was made available for public use or reference by each `to` Agent.
        "publishedBy": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/publishedBy",
        # Designates a `from` Vulnerability was first reported to a project, vendor, or tracking database for formal identification by each `to` Agent.
        "reportedBy": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/reportedBy",
        # Designates a `from` Vulnerability's details were tracked, aggregated, and/or enriched to improve context (i.e. NVD) by each `to` Agent.
        "republishedBy": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/republishedBy",
        # The `from` SpdxDocument can be found in a serialized form in each `to` Artifact.
        "serializedInArtifact": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/serializedInArtifact",
        # The `from` Element has been tested on the `to` Element(s).
        "testedOn": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/testedOn",
        # The `from` Element has been trained on the `to` Element(s).
        "trainedOn": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/trainedOn",
        # The `from` Vulnerability impact is being investigated for each `to` Element. The use of the `underInvestigationFor` type is constrained to `VexUnderInvestigationVulnAssessmentRelationship` classed relationships.
        "underInvestigationFor": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/underInvestigationFor",
        # The `from` Element uses each `to` Element as a tool, during a LifecycleScopeType period.
        "usesTool": "https://spdx.org/rdf/3.0.1/terms/Core/RelationshipType/usesTool",
    }


class SpdxDocument(ElementCollection):
    """
    A collection of SPDX Elements that could potentially be serialized.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/SpdxDocument"
    COMPACT_TYPE = "SpdxDocument"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Provides the license under which the SPDX documentation of the Element can be
        # used.
        ClassProp(
            "dataLicense",
            lambda:
            ObjectProp(simplelicensing_AnyLicenseInfo, False, context=(
                    ("https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoAssertionLicense", "expandedlicensing_NoAssertionLicense"),
                    ("https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoneLicense", "expandedlicensing_NoneLicense"),
                ),),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/dataLicense",
            compact="dataLicense",
            deprecated=False,
        ),
        # Provides an ExternalMap of Element identifiers.
        ClassProp(
            "import_",
            lambda:
            ListProp(ObjectProp(ExternalMap, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/import",
            compact="import",
            deprecated=False,
        ),
        # Provides a NamespaceMap of prefixes and associated namespace partial URIs applicable to an SpdxDocument and independent of any specific serialization format or instance.
        ClassProp(
            "namespaceMap",
            lambda:
            ListProp(ObjectProp(NamespaceMap, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/namespaceMap",
            compact="namespaceMap",
            deprecated=False,
        ),
    ]


class SupportType(SHACLObject):
    """
    Indicates the type of support that is associated with an artifact.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/SupportType"
    COMPACT_TYPE = "SupportType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # in addition to being supported by the supplier, the software is known to have been deployed and is in use.  For a software as a service provider, this implies the software is now available as a service.
        "deployed": "https://spdx.org/rdf/3.0.1/terms/Core/SupportType/deployed",
        # the artifact is in active development and is not considered ready for formal support from the supplier.
        "development": "https://spdx.org/rdf/3.0.1/terms/Core/SupportType/development",
        # there is a defined end of support for the artifact from the supplier.  This may also be referred to as end of life. There is a validUntilDate that can be used to signal when support ends for the artifact.
        "endOfSupport": "https://spdx.org/rdf/3.0.1/terms/Core/SupportType/endOfSupport",
        # the artifact has been released, and there is limited support available from the supplier. There is a validUntilDate that can provide additional information about the duration of support.
        "limitedSupport": "https://spdx.org/rdf/3.0.1/terms/Core/SupportType/limitedSupport",
        # no assertion about the type of support is made.   This is considered the default if no other support type is used.
        "noAssertion": "https://spdx.org/rdf/3.0.1/terms/Core/SupportType/noAssertion",
        # there is no support for the artifact from the supplier, consumer assumes any support obligations.
        "noSupport": "https://spdx.org/rdf/3.0.1/terms/Core/SupportType/noSupport",
        # the artifact has been released, and is supported from the supplier.   There is a validUntilDate that can provide additional information about the duration of support.
        "support": "https://spdx.org/rdf/3.0.1/terms/Core/SupportType/support",
    }


class Tool(Element):
    """
    An element of hardware and/or software utilized to carry out a particular function.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/Tool"
    COMPACT_TYPE = "Tool"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"


class dataset_ConfidentialityLevelType(SHACLObject):
    """
    Categories of confidentiality level.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Dataset/ConfidentialityLevelType"
    COMPACT_TYPE = "dataset_ConfidentialityLevelType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # Data points in the dataset can be shared only with specific organizations and their clients on a need to know basis.
        "amber": "https://spdx.org/rdf/3.0.1/terms/Dataset/ConfidentialityLevelType/amber",
        # Dataset may be distributed freely, without restriction.
        "clear": "https://spdx.org/rdf/3.0.1/terms/Dataset/ConfidentialityLevelType/clear",
        # Dataset can be shared within a community of peers and partners.
        "green": "https://spdx.org/rdf/3.0.1/terms/Dataset/ConfidentialityLevelType/green",
        # Data points in the dataset are highly confidential and can only be shared with named recipients.
        "red": "https://spdx.org/rdf/3.0.1/terms/Dataset/ConfidentialityLevelType/red",
    }


class dataset_DatasetAvailabilityType(SHACLObject):
    """
    Availability of dataset.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetAvailabilityType"
    COMPACT_TYPE = "dataset_DatasetAvailabilityType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # the dataset is not publicly available and can only be accessed after affirmatively accepting terms on a clickthrough webpage.
        "clickthrough": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetAvailabilityType/clickthrough",
        # the dataset is publicly available and can be downloaded directly.
        "directDownload": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetAvailabilityType/directDownload",
        # the dataset is publicly available, but not all at once, and can only be accessed through queries which return parts of the dataset.
        "query": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetAvailabilityType/query",
        # the dataset is not publicly available and an email registration is required before accessing the dataset, although without an affirmative acceptance of terms.
        "registration": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetAvailabilityType/registration",
        # the dataset provider is not making available the underlying data and the dataset must be reassembled, typically using the provided script for scraping the data.
        "scrapingScript": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetAvailabilityType/scrapingScript",
    }


class dataset_DatasetType(SHACLObject):
    """
    Enumeration of dataset types.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType"
    COMPACT_TYPE = "dataset_DatasetType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # data is audio based, such as a collection of music from the 80s.
        "audio": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/audio",
        # data that is classified into a discrete number of categories, such as the eye color of a population of people.
        "categorical": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/categorical",
        # data is in the form of a graph where entries are somehow related to each other through edges, such a social network of friends.
        "graph": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/graph",
        # data is a collection of images such as pictures of animals.
        "image": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/image",
        # data type is not known.
        "noAssertion": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/noAssertion",
        # data consists only of numeric entries.
        "numeric": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/numeric",
        # data is of a type not included in this list.
        "other": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/other",
        # data is recorded from a physical sensor, such as a thermometer reading or biometric device.
        "sensor": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/sensor",
        # data is stored in tabular format or retrieved from a relational database.
        "structured": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/structured",
        # data describes the syntax or semantics of a language or text, such as a parse tree used for natural language processing.
        "syntactic": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/syntactic",
        # data consists of unstructured text, such as a book, Wikipedia article (without images), or transcript.
        "text": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/text",
        # data is recorded in an ordered sequence of timestamped entries, such as the price of a stock over the course of a day.
        "timeseries": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/timeseries",
        # data is recorded with a timestamp for each entry, but not necessarily ordered or at specific intervals, such as when a taxi ride starts and ends.
        "timestamp": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/timestamp",
        # data is video based, such as a collection of movie clips featuring Tom Hanks.
        "video": "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/video",
    }


class expandedlicensing_LicenseAddition(Element):
    """
    Abstract class for additional text intended to be added to a License, but
    which is not itself a standalone License.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/LicenseAddition"
    COMPACT_TYPE = "expandedlicensing_LicenseAddition"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    IS_ABSTRACT: bool = True
    PROPERTIES = [
        # Identifies the full text of a LicenseAddition.
        ClassProp(
            "expandedlicensing_additionText",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/additionText",
            min_count=1,
            compact="expandedlicensing_additionText",
            deprecated=False,
        ),
        # Specifies whether an additional text identifier has been marked as deprecated.
        ClassProp(
            "expandedlicensing_isDeprecatedAdditionId",
            lambda:
            BooleanProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/isDeprecatedAdditionId",
            compact="expandedlicensing_isDeprecatedAdditionId",
            deprecated=False,
        ),
        # Identifies all the text and metadata associated with a license in the license
        # XML format.
        ClassProp(
            "expandedlicensing_licenseXml",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/licenseXml",
            compact="expandedlicensing_licenseXml",
            deprecated=False,
        ),
        # Specifies the licenseId that is preferred to be used in place of a deprecated
        # License or LicenseAddition.
        ClassProp(
            "expandedlicensing_obsoletedBy",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/obsoletedBy",
            compact="expandedlicensing_obsoletedBy",
            deprecated=False,
        ),
        # Contains a URL where the License or LicenseAddition can be found in use.
        ClassProp(
            "expandedlicensing_seeAlso",
            lambda:
            ListProp(AnyURIProp()),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/seeAlso",
            compact="expandedlicensing_seeAlso",
            deprecated=False,
        ),
        # Identifies the full text of a LicenseAddition, in SPDX templating format.
        ClassProp(
            "expandedlicensing_standardAdditionTemplate",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/standardAdditionTemplate",
            compact="expandedlicensing_standardAdditionTemplate",
            deprecated=False,
        ),
    ]


class expandedlicensing_ListedLicenseException(expandedlicensing_LicenseAddition):
    """
    A license exception that is listed on the SPDX Exceptions list.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/ListedLicenseException"
    COMPACT_TYPE = "expandedlicensing_ListedLicenseException"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Specifies the SPDX License List version in which this license or exception
        # identifier was deprecated.
        ClassProp(
            "expandedlicensing_deprecatedVersion",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/deprecatedVersion",
            compact="expandedlicensing_deprecatedVersion",
            deprecated=False,
        ),
        # Specifies the SPDX License List version in which this ListedLicense or
        # ListedLicenseException identifier was first added.
        ClassProp(
            "expandedlicensing_listVersionAdded",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/listVersionAdded",
            compact="expandedlicensing_listVersionAdded",
            deprecated=False,
        ),
    ]


class extension_CdxPropertyEntry(SHACLObject):
    """
    A property name with an associated value.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Extension/CdxPropertyEntry"
    COMPACT_TYPE = "extension_CdxPropertyEntry"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    PROPERTIES = [
        # A name used in a CdxPropertyEntry name-value pair.
        ClassProp(
            "extension_cdxPropName",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Extension/cdxPropName",
            min_count=1,
            compact="extension_cdxPropName",
            deprecated=False,
        ),
        # A value used in a CdxPropertyEntry name-value pair.
        ClassProp(
            "extension_cdxPropValue",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Extension/cdxPropValue",
            compact="extension_cdxPropValue",
            deprecated=False,
        ),
    ]


class extension_Extension(SHACLExtensibleObject):
    """
    A characterization of some aspect of an Element that is associated with the Element in a generalized fashion.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Extension/Extension"
    COMPACT_TYPE = "extension_Extension"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    IS_ABSTRACT: bool = True


class security_CvssSeverityType(SHACLObject):
    """
    Specifies the CVSS base, temporal, threat, or environmental severity type.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Security/CvssSeverityType"
    COMPACT_TYPE = "security_CvssSeverityType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # When a CVSS score is between 9.0 - 10.0
        "critical": "https://spdx.org/rdf/3.0.1/terms/Security/CvssSeverityType/critical",
        # When a CVSS score is between 7.0 - 8.9
        "high": "https://spdx.org/rdf/3.0.1/terms/Security/CvssSeverityType/high",
        # When a CVSS score is between 0.1 - 3.9
        "low": "https://spdx.org/rdf/3.0.1/terms/Security/CvssSeverityType/low",
        # When a CVSS score is between 4.0 - 6.9
        "medium": "https://spdx.org/rdf/3.0.1/terms/Security/CvssSeverityType/medium",
        # When a CVSS score is 0.0
        "none": "https://spdx.org/rdf/3.0.1/terms/Security/CvssSeverityType/none",
    }


class security_ExploitCatalogType(SHACLObject):
    """
    Specifies the exploit catalog type.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Security/ExploitCatalogType"
    COMPACT_TYPE = "security_ExploitCatalogType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # CISA's Known Exploited Vulnerability (KEV) Catalog
        "kev": "https://spdx.org/rdf/3.0.1/terms/Security/ExploitCatalogType/kev",
        # Other exploit catalogs
        "other": "https://spdx.org/rdf/3.0.1/terms/Security/ExploitCatalogType/other",
    }


class security_SsvcDecisionType(SHACLObject):
    """
    Specifies the SSVC decision type.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Security/SsvcDecisionType"
    COMPACT_TYPE = "security_SsvcDecisionType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # The vulnerability requires attention from the organization's internal, supervisory-level and leadership-level individuals. Necessary actions include requesting assistance or information about the vulnerability, as well as publishing a notification either internally and/or externally. Typically, internal groups would meet to determine the overall response and then execute agreed upon actions. CISA recommends remediating Act vulnerabilities as soon as possible.
        "act": "https://spdx.org/rdf/3.0.1/terms/Security/SsvcDecisionType/act",
        # The vulnerability requires attention from the organization's internal, supervisory-level individuals. Necessary actions include requesting assistance or information about the vulnerability, and may involve publishing a notification either internally and/or externally. CISA recommends remediating Attend vulnerabilities sooner than standard update timelines.
        "attend": "https://spdx.org/rdf/3.0.1/terms/Security/SsvcDecisionType/attend",
        # The vulnerability does not require action at this time. The organization would continue to track the vulnerability and reassess it if new information becomes available. CISA recommends remediating Track vulnerabilities within standard update timelines.
        "track": "https://spdx.org/rdf/3.0.1/terms/Security/SsvcDecisionType/track",
        # ("Track\*" in the SSVC spec) The vulnerability contains specific characteristics that may require closer monitoring for changes. CISA recommends remediating Track\* vulnerabilities within standard update timelines.
        "trackStar": "https://spdx.org/rdf/3.0.1/terms/Security/SsvcDecisionType/trackStar",
    }


class security_VexJustificationType(SHACLObject):
    """
    Specifies the VEX justification type.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Security/VexJustificationType"
    COMPACT_TYPE = "security_VexJustificationType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # The software is not affected because the vulnerable component is not in the product.
        "componentNotPresent": "https://spdx.org/rdf/3.0.1/terms/Security/VexJustificationType/componentNotPresent",
        # Built-in inline controls or mitigations prevent an adversary from leveraging the vulnerability.
        "inlineMitigationsAlreadyExist": "https://spdx.org/rdf/3.0.1/terms/Security/VexJustificationType/inlineMitigationsAlreadyExist",
        # The vulnerable component is present, and the component contains the vulnerable code. However, vulnerable code is used in such a way that an attacker cannot mount any anticipated attack.
        "vulnerableCodeCannotBeControlledByAdversary": "https://spdx.org/rdf/3.0.1/terms/Security/VexJustificationType/vulnerableCodeCannotBeControlledByAdversary",
        # The affected code is not reachable through the execution of the code, including non-anticipated states of the product.
        "vulnerableCodeNotInExecutePath": "https://spdx.org/rdf/3.0.1/terms/Security/VexJustificationType/vulnerableCodeNotInExecutePath",
        # The product is not affected because the code underlying the vulnerability is not present in the product.
        "vulnerableCodeNotPresent": "https://spdx.org/rdf/3.0.1/terms/Security/VexJustificationType/vulnerableCodeNotPresent",
    }


class security_VulnAssessmentRelationship(Relationship):
    """
    Abstract ancestor class for all vulnerability assessments
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Security/VulnAssessmentRelationship"
    COMPACT_TYPE = "security_VulnAssessmentRelationship"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    IS_ABSTRACT: bool = True
    PROPERTIES = [
        # Identifies who or what supplied the artifact or VulnAssessmentRelationship
        # referenced by the Element.
        ClassProp(
            "suppliedBy",
            lambda:
            ObjectProp(Agent, False, context=(
                    ("https://spdx.org/rdf/3.0.1/terms/Core/SpdxOrganization", "SpdxOrganization"),
                ),),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/suppliedBy",
            compact="suppliedBy",
            deprecated=False,
        ),
        # Specifies an Element contained in a piece of software where a vulnerability was
        # found.
        ClassProp(
            "security_assessedElement",
            lambda:
            ObjectProp(software_SoftwareArtifact, False),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/assessedElement",
            compact="security_assessedElement",
            deprecated=False,
        ),
        # Specifies a time when a vulnerability assessment was modified
        ClassProp(
            "security_modifiedTime",
            lambda:
            DateTimeStampProp(pattern=r"^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/modifiedTime",
            compact="security_modifiedTime",
            deprecated=False,
        ),
        # Specifies the time when a vulnerability was published.
        ClassProp(
            "security_publishedTime",
            lambda:
            DateTimeStampProp(pattern=r"^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/publishedTime",
            compact="security_publishedTime",
            deprecated=False,
        ),
        # Specified the time and date when a vulnerability was withdrawn.
        ClassProp(
            "security_withdrawnTime",
            lambda:
            DateTimeStampProp(pattern=r"^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/withdrawnTime",
            compact="security_withdrawnTime",
            deprecated=False,
        ),
    ]


class simplelicensing_AnyLicenseInfo(Element):
    """
    Abstract class representing a license combination consisting of one or more licenses.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/SimpleLicensing/AnyLicenseInfo"
    COMPACT_TYPE = "simplelicensing_AnyLicenseInfo"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    IS_ABSTRACT: bool = True


class simplelicensing_LicenseExpression(simplelicensing_AnyLicenseInfo):
    """
    An SPDX Element containing an SPDX license expression string.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/SimpleLicensing/LicenseExpression"
    COMPACT_TYPE = "simplelicensing_LicenseExpression"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Maps a LicenseRef or AdditionRef string for a Custom License or a Custom
        # License Addition to its URI ID.
        ClassProp(
            "simplelicensing_customIdToUri",
            lambda:
            ListProp(ObjectProp(DictionaryEntry, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/SimpleLicensing/customIdToUri",
            compact="simplelicensing_customIdToUri",
            deprecated=False,
        ),
        # A string in the license expression format.
        ClassProp(
            "simplelicensing_licenseExpression",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/SimpleLicensing/licenseExpression",
            min_count=1,
            compact="simplelicensing_licenseExpression",
            deprecated=False,
        ),
        # The version of the SPDX License List used in the license expression.
        ClassProp(
            "simplelicensing_licenseListVersion",
            lambda:
            StringProp(pattern=r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"),
            iri="https://spdx.org/rdf/3.0.1/terms/SimpleLicensing/licenseListVersion",
            compact="simplelicensing_licenseListVersion",
            deprecated=False,
        ),
    ]


class simplelicensing_SimpleLicensingText(Element):
    """
    A license or addition that is not listed on the SPDX License List.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/SimpleLicensing/SimpleLicensingText"
    COMPACT_TYPE = "simplelicensing_SimpleLicensingText"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Identifies the full text of a License or Addition.
        ClassProp(
            "simplelicensing_licenseText",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/SimpleLicensing/licenseText",
            min_count=1,
            compact="simplelicensing_licenseText",
            deprecated=False,
        ),
    ]


class software_ContentIdentifier(IntegrityMethod):
    """
    A canonical, unique, immutable identifier
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Software/ContentIdentifier"
    COMPACT_TYPE = "software_ContentIdentifier"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    PROPERTIES = [
        # Specifies the type of the content identifier.
        ClassProp(
            "software_contentIdentifierType",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Software/ContentIdentifierType/gitoid", "gitoid"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/ContentIdentifierType/swhid", "swhid"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Software/contentIdentifierType",
            min_count=1,
            compact="software_contentIdentifierType",
            deprecated=False,
        ),
        # Specifies the value of the content identifier.
        ClassProp(
            "software_contentIdentifierValue",
            lambda:
            AnyURIProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Software/contentIdentifierValue",
            min_count=1,
            compact="software_contentIdentifierValue",
            deprecated=False,
        ),
    ]


class software_ContentIdentifierType(SHACLObject):
    """
    Specifies the type of a content identifier.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Software/ContentIdentifierType"
    COMPACT_TYPE = "software_ContentIdentifierType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # [Gitoid](https://www.iana.org/assignments/uri-schemes/prov/gitoid), stands for [Git Object ID](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). A gitoid of type blob is a unique hash of a binary artifact. A gitoid may represent either an [Artifact Identifier](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-identifier-types) for the software artifact or an [Input Manifest Identifier](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#input-manifest-identifier) for the software artifact's associated [Artifact Input Manifest](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-input-manifest); this ambiguity exists because the Artifact Input Manifest is itself an artifact, and the gitoid of that artifact is its valid identifier. Gitoids calculated on software artifacts (Snippet, File, or Package Elements) should be recorded in the SPDX 3.0 SoftwareArtifact's contentIdentifier property. Gitoids calculated on the Artifact Input Manifest (Input Manifest Identifier) should be recorded in the SPDX 3.0 Element's externalIdentifier property. See [OmniBOR Specification](https://github.com/omnibor/spec/), a minimalistic specification for describing software [Artifact Dependency Graphs](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-dependency-graph-adg).
        "gitoid": "https://spdx.org/rdf/3.0.1/terms/Software/ContentIdentifierType/gitoid",
        # SoftWare Hash IDentifier, a persistent intrinsic identifier for digital artifacts, such as files, trees (also known as directories or folders), commits, and other objects typically found in version control systems. The format of the identifiers is defined in the [SWHID specification](https://www.swhid.org/specification/v1.1/4.Syntax) (ISO/IEC DIS 18670). They typically look like `swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2`.
        "swhid": "https://spdx.org/rdf/3.0.1/terms/Software/ContentIdentifierType/swhid",
    }


class software_FileKindType(SHACLObject):
    """
    Enumeration of the different kinds of SPDX file.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Software/FileKindType"
    COMPACT_TYPE = "software_FileKindType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # The file represents a directory and all content stored in that directory.
        "directory": "https://spdx.org/rdf/3.0.1/terms/Software/FileKindType/directory",
        # The file represents a single file (default).
        "file": "https://spdx.org/rdf/3.0.1/terms/Software/FileKindType/file",
    }


class software_SbomType(SHACLObject):
    """
    Provides a set of values to be used to describe the common types of SBOMs that
    tools may create.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Software/SbomType"
    COMPACT_TYPE = "software_SbomType"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # SBOM generated through analysis of artifacts (e.g., executables, packages, containers, and virtual machine images) after its build. Such analysis generally requires a variety of heuristics. In some contexts, this may also be referred to as a "3rd party" SBOM.
        "analyzed": "https://spdx.org/rdf/3.0.1/terms/Software/SbomType/analyzed",
        # SBOM generated as part of the process of building the software to create a releasable artifact (e.g., executable or package) from data such as source files, dependencies, built components, build process ephemeral data, and other SBOMs.
        "build": "https://spdx.org/rdf/3.0.1/terms/Software/SbomType/build",
        # SBOM provides an inventory of software that is present on a system. This may be an assembly of other SBOMs that combines analysis of configuration options, and examination of execution behavior in a (potentially simulated) deployment environment.
        "deployed": "https://spdx.org/rdf/3.0.1/terms/Software/SbomType/deployed",
        # SBOM of intended, planned software project or product with included components (some of which may not yet exist) for a new software artifact.
        "design": "https://spdx.org/rdf/3.0.1/terms/Software/SbomType/design",
        # SBOM generated through instrumenting the system running the software, to capture only components present in the system, as well as external call-outs or dynamically loaded components. In some contexts, this may also be referred to as an "Instrumented" or "Dynamic" SBOM.
        "runtime": "https://spdx.org/rdf/3.0.1/terms/Software/SbomType/runtime",
        # SBOM created directly from the development environment, source files, and included dependencies used to build an product artifact.
        "source": "https://spdx.org/rdf/3.0.1/terms/Software/SbomType/source",
    }


class software_SoftwarePurpose(SHACLObject):
    """
    Provides information about the primary purpose of an Element.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose"
    COMPACT_TYPE = "software_SoftwarePurpose"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # The Element is a software application.
        "application": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/application",
        # The Element is an archived collection of one or more files (.tar, .zip, etc.).
        "archive": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/archive",
        # The Element is a bill of materials.
        "bom": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/bom",
        # The Element is configuration data.
        "configuration": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/configuration",
        # The Element is a container image which can be used by a container runtime application.
        "container": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/container",
        # The Element is data.
        "data": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/data",
        # The Element refers to a chipset, processor, or electronic board.
        "device": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/device",
        # The Element represents software that controls hardware devices.
        "deviceDriver": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/deviceDriver",
        # The Element refers to a disk image that can be written to a disk, booted in a VM, etc. A disk image typically contains most or all of the components necessary to boot, such as bootloaders, kernels, firmware, userspace, etc.
        "diskImage": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/diskImage",
        # The Element is documentation.
        "documentation": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/documentation",
        # The Element is the evidence that a specification or requirement has been fulfilled.
        "evidence": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/evidence",
        # The Element is an Artifact that can be run on a computer.
        "executable": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/executable",
        # The Element is a single file which can be independently distributed (configuration file, statically linked binary, Kubernetes deployment, etc.).
        "file": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/file",
        # The Element is a file system image that can be written to a disk (or virtual) partition.
        "filesystemImage": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/filesystemImage",
        # The Element provides low level control over a device's hardware.
        "firmware": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/firmware",
        # The Element is a software framework.
        "framework": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/framework",
        # The Element is used to install software on disk.
        "install": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/install",
        # The Element is a software library.
        "library": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/library",
        # The Element is a software manifest.
        "manifest": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/manifest",
        # The Element is a machine learning or artificial intelligence model.
        "model": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/model",
        # The Element is a module of a piece of software.
        "module": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/module",
        # The Element is an operating system.
        "operatingSystem": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/operatingSystem",
        # The Element doesn't fit into any of the other categories.
        "other": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/other",
        # The Element contains a set of changes to update, fix, or improve another Element.
        "patch": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/patch",
        # The Element represents a runtime environment.
        "platform": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/platform",
        # The Element provides a requirement needed as input for another Element.
        "requirement": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/requirement",
        # The Element is a single or a collection of source files.
        "source": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/source",
        # The Element is a plan, guideline or strategy how to create, perform or analyze an application.
        "specification": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/specification",
        # The Element is a test used to verify functionality on an software element.
        "test": "https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/test",
    }


class build_Build(Element):
    """
    Class that describes a build instance of software/artifacts.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Build/Build"
    COMPACT_TYPE = "build_Build"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Property that describes the time at which a build stops.
        ClassProp(
            "build_buildEndTime",
            lambda:
            DateTimeStampProp(pattern=r"^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Build/buildEndTime",
            compact="build_buildEndTime",
            deprecated=False,
        ),
        # A buildId is a locally unique identifier used by a builder to identify a unique
        # instance of a build produced by it.
        ClassProp(
            "build_buildId",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Build/buildId",
            compact="build_buildId",
            deprecated=False,
        ),
        # Property describing the start time of a build.
        ClassProp(
            "build_buildStartTime",
            lambda:
            DateTimeStampProp(pattern=r"^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Build/buildStartTime",
            compact="build_buildStartTime",
            deprecated=False,
        ),
        # A buildType is a hint that is used to indicate the toolchain, platform, or
        # infrastructure that the build was invoked on.
        ClassProp(
            "build_buildType",
            lambda:
            AnyURIProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Build/buildType",
            min_count=1,
            compact="build_buildType",
            deprecated=False,
        ),
        # Property that describes the digest of the build configuration file used to
        # invoke a build.
        ClassProp(
            "build_configSourceDigest",
            lambda:
            ListProp(ObjectProp(Hash, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/Build/configSourceDigest",
            compact="build_configSourceDigest",
            deprecated=False,
        ),
        # Property describes the invocation entrypoint of a build.
        ClassProp(
            "build_configSourceEntrypoint",
            lambda:
            ListProp(StringProp()),
            iri="https://spdx.org/rdf/3.0.1/terms/Build/configSourceEntrypoint",
            compact="build_configSourceEntrypoint",
            deprecated=False,
        ),
        # Property that describes the URI of the build configuration source file.
        ClassProp(
            "build_configSourceUri",
            lambda:
            ListProp(AnyURIProp()),
            iri="https://spdx.org/rdf/3.0.1/terms/Build/configSourceUri",
            compact="build_configSourceUri",
            deprecated=False,
        ),
        # Property describing the session in which a build is invoked.
        ClassProp(
            "build_environment",
            lambda:
            ListProp(ObjectProp(DictionaryEntry, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/Build/environment",
            compact="build_environment",
            deprecated=False,
        ),
        # Property describing a parameter used in an instance of a build.
        ClassProp(
            "build_parameter",
            lambda:
            ListProp(ObjectProp(DictionaryEntry, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/Build/parameter",
            compact="build_parameter",
            deprecated=False,
        ),
    ]


class Agent(Element):
    """
    Agent represents anything with the potential to act on a system.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/Agent"
    COMPACT_TYPE = "Agent"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"


class Annotation(Element):
    """
    An assertion made in relation to one or more elements.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/Annotation"
    COMPACT_TYPE = "Annotation"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Describes the type of annotation.
        ClassProp(
            "annotationType",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Core/AnnotationType/other", "other"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/AnnotationType/review", "review"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/annotationType",
            min_count=1,
            compact="annotationType",
            deprecated=False,
        ),
        # Provides information about the content type of an Element or a Property.
        ClassProp(
            "contentType",
            lambda:
            StringProp(pattern=r"^[^\/]+\/[^\/]+$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/contentType",
            compact="contentType",
            deprecated=False,
        ),
        # Commentary on an assertion that an annotator has made.
        ClassProp(
            "statement",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/statement",
            compact="statement",
            deprecated=False,
        ),
        # An Element an annotator has made an assertion about.
        ClassProp(
            "subject",
            lambda:
            ObjectProp(Element, True, context=(
                    ("https://spdx.org/rdf/3.0.1/terms/Core/NoAssertionElement", "NoAssertionElement"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/NoneElement", "NoneElement"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/SpdxOrganization", "SpdxOrganization"),
                    ("https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoAssertionLicense", "expandedlicensing_NoAssertionLicense"),
                    ("https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoneLicense", "expandedlicensing_NoneLicense"),
                ),),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/subject",
            min_count=1,
            compact="subject",
            deprecated=False,
        ),
    ]


class Artifact(Element):
    """
    A distinct article or unit within the digital domain.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/Artifact"
    COMPACT_TYPE = "Artifact"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    IS_ABSTRACT: bool = True
    PROPERTIES = [
        # Specifies the time an artifact was built.
        ClassProp(
            "builtTime",
            lambda:
            DateTimeStampProp(pattern=r"^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/builtTime",
            compact="builtTime",
            deprecated=False,
        ),
        # Identifies from where or whom the Element originally came.
        ClassProp(
            "originatedBy",
            lambda:
            ListProp(ObjectProp(Agent, False, context=(
                    ("https://spdx.org/rdf/3.0.1/terms/Core/SpdxOrganization", "SpdxOrganization"),
                ),)),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/originatedBy",
            compact="originatedBy",
            deprecated=False,
        ),
        # Specifies the time an artifact was released.
        ClassProp(
            "releaseTime",
            lambda:
            DateTimeStampProp(pattern=r"^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/releaseTime",
            compact="releaseTime",
            deprecated=False,
        ),
        # The name of a relevant standard that may apply to an artifact.
        ClassProp(
            "standardName",
            lambda:
            ListProp(StringProp()),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/standardName",
            compact="standardName",
            deprecated=False,
        ),
        # Identifies who or what supplied the artifact or VulnAssessmentRelationship
        # referenced by the Element.
        ClassProp(
            "suppliedBy",
            lambda:
            ObjectProp(Agent, False, context=(
                    ("https://spdx.org/rdf/3.0.1/terms/Core/SpdxOrganization", "SpdxOrganization"),
                ),),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/suppliedBy",
            compact="suppliedBy",
            deprecated=False,
        ),
        # Specifies the level of support associated with an artifact.
        ClassProp(
            "supportLevel",
            lambda:
            ListProp(EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Core/SupportType/deployed", "deployed"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/SupportType/development", "development"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/SupportType/endOfSupport", "endOfSupport"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/SupportType/limitedSupport", "limitedSupport"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/SupportType/noAssertion", "noAssertion"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/SupportType/noSupport", "noSupport"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/SupportType/support", "support"),
                ))),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/supportLevel",
            compact="supportLevel",
            deprecated=False,
        ),
        # Specifies until when the artifact can be used before its usage needs to be
        # reassessed.
        ClassProp(
            "validUntilTime",
            lambda:
            DateTimeStampProp(pattern=r"^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/validUntilTime",
            compact="validUntilTime",
            deprecated=False,
        ),
    ]


class Bundle(ElementCollection):
    """
    A collection of Elements that have a shared context.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/Bundle"
    COMPACT_TYPE = "Bundle"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Gives information about the circumstances or unifying properties
        # that Elements of the bundle have been assembled under.
        ClassProp(
            "context",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/context",
            compact="context",
            deprecated=False,
        ),
    ]


class Hash(IntegrityMethod):
    """
    A mathematically calculated representation of a grouping of data.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/Hash"
    COMPACT_TYPE = "Hash"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    PROPERTIES = [
        # Specifies the algorithm used for calculating the hash value.
        ClassProp(
            "algorithm",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/adler32", "adler32"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/blake2b256", "blake2b256"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/blake2b384", "blake2b384"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/blake2b512", "blake2b512"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/blake3", "blake3"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/crystalsDilithium", "crystalsDilithium"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/crystalsKyber", "crystalsKyber"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/falcon", "falcon"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/md2", "md2"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/md4", "md4"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/md5", "md5"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/md6", "md6"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/other", "other"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha1", "sha1"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha224", "sha224"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha256", "sha256"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha384", "sha384"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha3_224", "sha3_224"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha3_256", "sha3_256"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha3_384", "sha3_384"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha3_512", "sha3_512"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/HashAlgorithm/sha512", "sha512"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/algorithm",
            min_count=1,
            compact="algorithm",
            deprecated=False,
        ),
        # The result of applying a hash algorithm to an Element.
        ClassProp(
            "hashValue",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/hashValue",
            min_count=1,
            compact="hashValue",
            deprecated=False,
        ),
    ]


class LifecycleScopedRelationship(Relationship):
    """
    Provide context for a relationship that occurs in the lifecycle.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/LifecycleScopedRelationship"
    COMPACT_TYPE = "LifecycleScopedRelationship"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Capture the scope of information about a specific relationship between elements.
        ClassProp(
            "scope",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Core/LifecycleScopeType/build", "build"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/LifecycleScopeType/design", "design"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/LifecycleScopeType/development", "development"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/LifecycleScopeType/other", "other"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/LifecycleScopeType/runtime", "runtime"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/LifecycleScopeType/test", "test"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/scope",
            compact="scope",
            deprecated=False,
        ),
    ]


class Organization(Agent):
    """
    A group of people who work together in an organized way for a shared purpose.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/Organization"
    COMPACT_TYPE = "Organization"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # An Organization representing the SPDX Project.
        "SpdxOrganization": "https://spdx.org/rdf/3.0.1/terms/Core/SpdxOrganization",
    }


class Person(Agent):
    """
    An individual human being.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/Person"
    COMPACT_TYPE = "Person"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"


class SoftwareAgent(Agent):
    """
    A software agent.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/SoftwareAgent"
    COMPACT_TYPE = "SoftwareAgent"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"


class expandedlicensing_ConjunctiveLicenseSet(simplelicensing_AnyLicenseInfo):
    """
    Portion of an AnyLicenseInfo representing a set of licensing information
    where all elements apply.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/ConjunctiveLicenseSet"
    COMPACT_TYPE = "expandedlicensing_ConjunctiveLicenseSet"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # A license expression participating in a license set.
        ClassProp(
            "expandedlicensing_member",
            lambda:
            ListProp(ObjectProp(simplelicensing_AnyLicenseInfo, False, context=(
                    ("https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoAssertionLicense", "expandedlicensing_NoAssertionLicense"),
                    ("https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoneLicense", "expandedlicensing_NoneLicense"),
                ),)),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/member",
            min_count=2,
            compact="expandedlicensing_member",
            deprecated=False,
        ),
    ]


class expandedlicensing_CustomLicenseAddition(expandedlicensing_LicenseAddition):
    """
    A license addition that is not listed on the SPDX Exceptions List.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/CustomLicenseAddition"
    COMPACT_TYPE = "expandedlicensing_CustomLicenseAddition"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"


class expandedlicensing_DisjunctiveLicenseSet(simplelicensing_AnyLicenseInfo):
    """
    Portion of an AnyLicenseInfo representing a set of licensing information where
    only one of the elements applies.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/DisjunctiveLicenseSet"
    COMPACT_TYPE = "expandedlicensing_DisjunctiveLicenseSet"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # A license expression participating in a license set.
        ClassProp(
            "expandedlicensing_member",
            lambda:
            ListProp(ObjectProp(simplelicensing_AnyLicenseInfo, False, context=(
                    ("https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoAssertionLicense", "expandedlicensing_NoAssertionLicense"),
                    ("https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoneLicense", "expandedlicensing_NoneLicense"),
                ),)),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/member",
            min_count=2,
            compact="expandedlicensing_member",
            deprecated=False,
        ),
    ]


class expandedlicensing_ExtendableLicense(simplelicensing_AnyLicenseInfo):
    """
    Abstract class representing a License or an OrLaterOperator.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/ExtendableLicense"
    COMPACT_TYPE = "expandedlicensing_ExtendableLicense"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    IS_ABSTRACT: bool = True


class expandedlicensing_IndividualLicensingInfo(simplelicensing_AnyLicenseInfo):
    """
    A concrete subclass of AnyLicenseInfo used by Individuals in the
    ExpandedLicensing profile.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/IndividualLicensingInfo"
    COMPACT_TYPE = "expandedlicensing_IndividualLicensingInfo"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    NAMED_INDIVIDUALS: Dict[str, str] = {
        # An Individual Value for License when no assertion can be made about its actual
        # value.
        "NoAssertionLicense": "https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoAssertionLicense",
        # An Individual Value for License where the SPDX data creator determines that no
        # license is present.
        "NoneLicense": "https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/NoneLicense",
    }


class expandedlicensing_License(expandedlicensing_ExtendableLicense):
    """
    Abstract class for the portion of an AnyLicenseInfo representing a license.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/License"
    COMPACT_TYPE = "expandedlicensing_License"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    IS_ABSTRACT: bool = True
    PROPERTIES = [
        # Specifies whether a license or additional text identifier has been marked as
        # deprecated.
        ClassProp(
            "expandedlicensing_isDeprecatedLicenseId",
            lambda:
            BooleanProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/isDeprecatedLicenseId",
            compact="expandedlicensing_isDeprecatedLicenseId",
            deprecated=False,
        ),
        # Specifies whether the License is listed as free by the
        # Free Software Foundation (FSF).
        ClassProp(
            "expandedlicensing_isFsfLibre",
            lambda:
            BooleanProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/isFsfLibre",
            compact="expandedlicensing_isFsfLibre",
            deprecated=False,
        ),
        # Specifies whether the License is listed as approved by the
        # Open Source Initiative (OSI).
        ClassProp(
            "expandedlicensing_isOsiApproved",
            lambda:
            BooleanProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/isOsiApproved",
            compact="expandedlicensing_isOsiApproved",
            deprecated=False,
        ),
        # Identifies all the text and metadata associated with a license in the license
        # XML format.
        ClassProp(
            "expandedlicensing_licenseXml",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/licenseXml",
            compact="expandedlicensing_licenseXml",
            deprecated=False,
        ),
        # Specifies the licenseId that is preferred to be used in place of a deprecated
        # License or LicenseAddition.
        ClassProp(
            "expandedlicensing_obsoletedBy",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/obsoletedBy",
            compact="expandedlicensing_obsoletedBy",
            deprecated=False,
        ),
        # Contains a URL where the License or LicenseAddition can be found in use.
        ClassProp(
            "expandedlicensing_seeAlso",
            lambda:
            ListProp(AnyURIProp()),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/seeAlso",
            compact="expandedlicensing_seeAlso",
            deprecated=False,
        ),
        # Provides a License author's preferred text to indicate that a file is covered
        # by the License.
        ClassProp(
            "expandedlicensing_standardLicenseHeader",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/standardLicenseHeader",
            compact="expandedlicensing_standardLicenseHeader",
            deprecated=False,
        ),
        # Identifies the full text of a License, in SPDX templating format.
        ClassProp(
            "expandedlicensing_standardLicenseTemplate",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/standardLicenseTemplate",
            compact="expandedlicensing_standardLicenseTemplate",
            deprecated=False,
        ),
        # Identifies the full text of a License or Addition.
        ClassProp(
            "simplelicensing_licenseText",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/SimpleLicensing/licenseText",
            min_count=1,
            compact="simplelicensing_licenseText",
            deprecated=False,
        ),
    ]


class expandedlicensing_ListedLicense(expandedlicensing_License):
    """
    A license that is listed on the SPDX License List.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/ListedLicense"
    COMPACT_TYPE = "expandedlicensing_ListedLicense"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Specifies the SPDX License List version in which this license or exception
        # identifier was deprecated.
        ClassProp(
            "expandedlicensing_deprecatedVersion",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/deprecatedVersion",
            compact="expandedlicensing_deprecatedVersion",
            deprecated=False,
        ),
        # Specifies the SPDX License List version in which this ListedLicense or
        # ListedLicenseException identifier was first added.
        ClassProp(
            "expandedlicensing_listVersionAdded",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/listVersionAdded",
            compact="expandedlicensing_listVersionAdded",
            deprecated=False,
        ),
    ]


class expandedlicensing_OrLaterOperator(expandedlicensing_ExtendableLicense):
    """
    Portion of an AnyLicenseInfo representing this version, or any later version,
    of the indicated License.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/OrLaterOperator"
    COMPACT_TYPE = "expandedlicensing_OrLaterOperator"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # A License participating in an 'or later' model.
        ClassProp(
            "expandedlicensing_subjectLicense",
            lambda:
            ObjectProp(expandedlicensing_License, True),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/subjectLicense",
            min_count=1,
            compact="expandedlicensing_subjectLicense",
            deprecated=False,
        ),
    ]


class expandedlicensing_WithAdditionOperator(simplelicensing_AnyLicenseInfo):
    """
    Portion of an AnyLicenseInfo representing a License which has additional
    text applied to it.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/WithAdditionOperator"
    COMPACT_TYPE = "expandedlicensing_WithAdditionOperator"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # A LicenseAddition participating in a 'with addition' model.
        ClassProp(
            "expandedlicensing_subjectAddition",
            lambda:
            ObjectProp(expandedlicensing_LicenseAddition, True),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/subjectAddition",
            min_count=1,
            compact="expandedlicensing_subjectAddition",
            deprecated=False,
        ),
        # A License participating in a 'with addition' model.
        ClassProp(
            "expandedlicensing_subjectExtendableLicense",
            lambda:
            ObjectProp(expandedlicensing_ExtendableLicense, True),
            iri="https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/subjectExtendableLicense",
            min_count=1,
            compact="expandedlicensing_subjectExtendableLicense",
            deprecated=False,
        ),
    ]


class extension_CdxPropertiesExtension(extension_Extension):
    """
    A type of extension consisting of a list of name value pairs.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Extension/CdxPropertiesExtension"
    COMPACT_TYPE = "extension_CdxPropertiesExtension"
    NODE_KIND: NodeKind = NodeKind.BlankNodeOrIRI
    PROPERTIES = [
        # Provides a map of a property names to a values.
        ClassProp(
            "extension_cdxProperty",
            lambda:
            ListProp(ObjectProp(extension_CdxPropertyEntry, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/Extension/cdxProperty",
            min_count=1,
            compact="extension_cdxProperty",
            deprecated=False,
        ),
    ]


class security_CvssV2VulnAssessmentRelationship(security_VulnAssessmentRelationship):
    """
    Provides a CVSS version 2.0 assessment for a vulnerability.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Security/CvssV2VulnAssessmentRelationship"
    COMPACT_TYPE = "security_CvssV2VulnAssessmentRelationship"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Provides a numerical (0-10) representation of the severity of a vulnerability.
        ClassProp(
            "security_score",
            lambda:
            FloatProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/score",
            min_count=1,
            compact="security_score",
            deprecated=False,
        ),
        # Specifies the CVSS vector string for a vulnerability.
        ClassProp(
            "security_vectorString",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/vectorString",
            min_count=1,
            compact="security_vectorString",
            deprecated=False,
        ),
    ]


class security_CvssV3VulnAssessmentRelationship(security_VulnAssessmentRelationship):
    """
    Provides a CVSS version 3 assessment for a vulnerability.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Security/CvssV3VulnAssessmentRelationship"
    COMPACT_TYPE = "security_CvssV3VulnAssessmentRelationship"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Provides a numerical (0-10) representation of the severity of a vulnerability.
        ClassProp(
            "security_score",
            lambda:
            FloatProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/score",
            min_count=1,
            compact="security_score",
            deprecated=False,
        ),
        # Specifies the CVSS qualitative severity rating of a vulnerability in relation to a piece of software.
        ClassProp(
            "security_severity",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Security/CvssSeverityType/critical", "critical"),
                    ("https://spdx.org/rdf/3.0.1/terms/Security/CvssSeverityType/high", "high"),
                    ("https://spdx.org/rdf/3.0.1/terms/Security/CvssSeverityType/low", "low"),
                    ("https://spdx.org/rdf/3.0.1/terms/Security/CvssSeverityType/medium", "medium"),
                    ("https://spdx.org/rdf/3.0.1/terms/Security/CvssSeverityType/none", "none"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/severity",
            min_count=1,
            compact="security_severity",
            deprecated=False,
        ),
        # Specifies the CVSS vector string for a vulnerability.
        ClassProp(
            "security_vectorString",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/vectorString",
            min_count=1,
            compact="security_vectorString",
            deprecated=False,
        ),
    ]


class security_CvssV4VulnAssessmentRelationship(security_VulnAssessmentRelationship):
    """
    Provides a CVSS version 4 assessment for a vulnerability.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Security/CvssV4VulnAssessmentRelationship"
    COMPACT_TYPE = "security_CvssV4VulnAssessmentRelationship"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Provides a numerical (0-10) representation of the severity of a vulnerability.
        ClassProp(
            "security_score",
            lambda:
            FloatProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/score",
            min_count=1,
            compact="security_score",
            deprecated=False,
        ),
        # Specifies the CVSS qualitative severity rating of a vulnerability in relation to a piece of software.
        ClassProp(
            "security_severity",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Security/CvssSeverityType/critical", "critical"),
                    ("https://spdx.org/rdf/3.0.1/terms/Security/CvssSeverityType/high", "high"),
                    ("https://spdx.org/rdf/3.0.1/terms/Security/CvssSeverityType/low", "low"),
                    ("https://spdx.org/rdf/3.0.1/terms/Security/CvssSeverityType/medium", "medium"),
                    ("https://spdx.org/rdf/3.0.1/terms/Security/CvssSeverityType/none", "none"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/severity",
            min_count=1,
            compact="security_severity",
            deprecated=False,
        ),
        # Specifies the CVSS vector string for a vulnerability.
        ClassProp(
            "security_vectorString",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/vectorString",
            min_count=1,
            compact="security_vectorString",
            deprecated=False,
        ),
    ]


class security_EpssVulnAssessmentRelationship(security_VulnAssessmentRelationship):
    """
    Provides an EPSS assessment for a vulnerability.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Security/EpssVulnAssessmentRelationship"
    COMPACT_TYPE = "security_EpssVulnAssessmentRelationship"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # The percentile of the current probability score.
        ClassProp(
            "security_percentile",
            lambda:
            FloatProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/percentile",
            min_count=1,
            compact="security_percentile",
            deprecated=False,
        ),
        # A probability score between 0 and 1 of a vulnerability being exploited.
        ClassProp(
            "security_probability",
            lambda:
            FloatProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/probability",
            min_count=1,
            compact="security_probability",
            deprecated=False,
        ),
    ]


class security_ExploitCatalogVulnAssessmentRelationship(security_VulnAssessmentRelationship):
    """
    Provides an exploit assessment of a vulnerability.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Security/ExploitCatalogVulnAssessmentRelationship"
    COMPACT_TYPE = "security_ExploitCatalogVulnAssessmentRelationship"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Specifies the exploit catalog type.
        ClassProp(
            "security_catalogType",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Security/ExploitCatalogType/kev", "kev"),
                    ("https://spdx.org/rdf/3.0.1/terms/Security/ExploitCatalogType/other", "other"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/catalogType",
            min_count=1,
            compact="security_catalogType",
            deprecated=False,
        ),
        # Describe that a CVE is known to have an exploit because it's been listed in an exploit catalog.
        ClassProp(
            "security_exploited",
            lambda:
            BooleanProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/exploited",
            min_count=1,
            compact="security_exploited",
            deprecated=False,
        ),
        # Provides the location of an exploit catalog.
        ClassProp(
            "security_locator",
            lambda:
            AnyURIProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/locator",
            min_count=1,
            compact="security_locator",
            deprecated=False,
        ),
    ]


class security_SsvcVulnAssessmentRelationship(security_VulnAssessmentRelationship):
    """
    Provides an SSVC assessment for a vulnerability.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Security/SsvcVulnAssessmentRelationship"
    COMPACT_TYPE = "security_SsvcVulnAssessmentRelationship"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Provide the enumeration of possible decisions in the
        # [Stakeholder-Specific Vulnerability Categorization (SSVC) decision tree](https://www.cisa.gov/stakeholder-specific-vulnerability-categorization-ssvc).
        ClassProp(
            "security_decisionType",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Security/SsvcDecisionType/act", "act"),
                    ("https://spdx.org/rdf/3.0.1/terms/Security/SsvcDecisionType/attend", "attend"),
                    ("https://spdx.org/rdf/3.0.1/terms/Security/SsvcDecisionType/track", "track"),
                    ("https://spdx.org/rdf/3.0.1/terms/Security/SsvcDecisionType/trackStar", "trackStar"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/decisionType",
            min_count=1,
            compact="security_decisionType",
            deprecated=False,
        ),
    ]


class security_VexVulnAssessmentRelationship(security_VulnAssessmentRelationship):
    """
    Abstract ancestor class for all VEX relationships
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Security/VexVulnAssessmentRelationship"
    COMPACT_TYPE = "security_VexVulnAssessmentRelationship"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    IS_ABSTRACT: bool = True
    PROPERTIES = [
        # Conveys information about how VEX status was determined.
        ClassProp(
            "security_statusNotes",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/statusNotes",
            compact="security_statusNotes",
            deprecated=False,
        ),
        # Specifies the version of a VEX statement.
        ClassProp(
            "security_vexVersion",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/vexVersion",
            compact="security_vexVersion",
            deprecated=False,
        ),
    ]


class security_Vulnerability(Artifact):
    """
    Specifies a vulnerability and its associated information.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Security/Vulnerability"
    COMPACT_TYPE = "security_Vulnerability"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Specifies a time when a vulnerability assessment was modified
        ClassProp(
            "security_modifiedTime",
            lambda:
            DateTimeStampProp(pattern=r"^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/modifiedTime",
            compact="security_modifiedTime",
            deprecated=False,
        ),
        # Specifies the time when a vulnerability was published.
        ClassProp(
            "security_publishedTime",
            lambda:
            DateTimeStampProp(pattern=r"^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/publishedTime",
            compact="security_publishedTime",
            deprecated=False,
        ),
        # Specified the time and date when a vulnerability was withdrawn.
        ClassProp(
            "security_withdrawnTime",
            lambda:
            DateTimeStampProp(pattern=r"^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/withdrawnTime",
            compact="security_withdrawnTime",
            deprecated=False,
        ),
    ]


class software_SoftwareArtifact(Artifact):
    """
    A distinct article or unit related to Software.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Software/SoftwareArtifact"
    COMPACT_TYPE = "software_SoftwareArtifact"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    IS_ABSTRACT: bool = True
    PROPERTIES = [
        # Provides additional purpose information of the software artifact.
        ClassProp(
            "software_additionalPurpose",
            lambda:
            ListProp(EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/application", "application"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/archive", "archive"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/bom", "bom"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/configuration", "configuration"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/container", "container"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/data", "data"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/device", "device"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/deviceDriver", "deviceDriver"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/diskImage", "diskImage"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/documentation", "documentation"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/evidence", "evidence"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/executable", "executable"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/file", "file"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/filesystemImage", "filesystemImage"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/firmware", "firmware"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/framework", "framework"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/install", "install"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/library", "library"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/manifest", "manifest"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/model", "model"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/module", "module"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/operatingSystem", "operatingSystem"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/other", "other"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/patch", "patch"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/platform", "platform"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/requirement", "requirement"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/source", "source"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/specification", "specification"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/test", "test"),
                ))),
            iri="https://spdx.org/rdf/3.0.1/terms/Software/additionalPurpose",
            compact="software_additionalPurpose",
            deprecated=False,
        ),
        # Provides a place for the SPDX data creator to record acknowledgement text for
        # a software Package, File or Snippet.
        ClassProp(
            "software_attributionText",
            lambda:
            ListProp(StringProp()),
            iri="https://spdx.org/rdf/3.0.1/terms/Software/attributionText",
            compact="software_attributionText",
            deprecated=False,
        ),
        # A canonical, unique, immutable identifier of the artifact content, that may be
        # used for verifying its identity and/or integrity.
        ClassProp(
            "software_contentIdentifier",
            lambda:
            ListProp(ObjectProp(software_ContentIdentifier, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/Software/contentIdentifier",
            compact="software_contentIdentifier",
            deprecated=False,
        ),
        # Identifies the text of one or more copyright notices for a software Package,
        # File or Snippet, if any.
        ClassProp(
            "software_copyrightText",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Software/copyrightText",
            compact="software_copyrightText",
            deprecated=False,
        ),
        # Provides information about the primary purpose of the software artifact.
        ClassProp(
            "software_primaryPurpose",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/application", "application"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/archive", "archive"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/bom", "bom"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/configuration", "configuration"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/container", "container"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/data", "data"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/device", "device"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/deviceDriver", "deviceDriver"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/diskImage", "diskImage"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/documentation", "documentation"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/evidence", "evidence"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/executable", "executable"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/file", "file"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/filesystemImage", "filesystemImage"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/firmware", "firmware"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/framework", "framework"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/install", "install"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/library", "library"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/manifest", "manifest"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/model", "model"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/module", "module"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/operatingSystem", "operatingSystem"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/other", "other"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/patch", "patch"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/platform", "platform"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/requirement", "requirement"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/source", "source"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/specification", "specification"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SoftwarePurpose/test", "test"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Software/primaryPurpose",
            compact="software_primaryPurpose",
            deprecated=False,
        ),
    ]


class Bom(Bundle):
    """
    A container for a grouping of SPDX-3.0 content characterizing details
    (provenence, composition, licensing, etc.) about a product.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Core/Bom"
    COMPACT_TYPE = "Bom"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"


class expandedlicensing_CustomLicense(expandedlicensing_License):
    """
    A license that is not listed on the SPDX License List.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/ExpandedLicensing/CustomLicense"
    COMPACT_TYPE = "expandedlicensing_CustomLicense"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"


class security_VexAffectedVulnAssessmentRelationship(security_VexVulnAssessmentRelationship):
    """
    Connects a vulnerability and an element designating the element as a product
    affected by the vulnerability.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Security/VexAffectedVulnAssessmentRelationship"
    COMPACT_TYPE = "security_VexAffectedVulnAssessmentRelationship"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Provides advise on how to mitigate or remediate a vulnerability when a VEX product
        # is affected by it.
        ClassProp(
            "security_actionStatement",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/actionStatement",
            min_count=1,
            compact="security_actionStatement",
            deprecated=False,
        ),
        # Records the time when a recommended action was communicated in a VEX statement
        # to mitigate a vulnerability.
        ClassProp(
            "security_actionStatementTime",
            lambda:
            DateTimeStampProp(pattern=r"^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/actionStatementTime",
            compact="security_actionStatementTime",
            deprecated=False,
        ),
    ]


class security_VexFixedVulnAssessmentRelationship(security_VexVulnAssessmentRelationship):
    """
    Links a vulnerability and elements representing products (in the VEX sense) where
    a fix has been applied and are no longer affected.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Security/VexFixedVulnAssessmentRelationship"
    COMPACT_TYPE = "security_VexFixedVulnAssessmentRelationship"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"


class security_VexNotAffectedVulnAssessmentRelationship(security_VexVulnAssessmentRelationship):
    """
    Links a vulnerability and one or more elements designating the latter as products
    not affected by the vulnerability.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Security/VexNotAffectedVulnAssessmentRelationship"
    COMPACT_TYPE = "security_VexNotAffectedVulnAssessmentRelationship"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Explains why a VEX product is not affected by a vulnerability. It is an
        # alternative in VexNotAffectedVulnAssessmentRelationship to the machine-readable
        # justification label.
        ClassProp(
            "security_impactStatement",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/impactStatement",
            compact="security_impactStatement",
            deprecated=False,
        ),
        # Timestamp of impact statement.
        ClassProp(
            "security_impactStatementTime",
            lambda:
            DateTimeStampProp(pattern=r"^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/impactStatementTime",
            compact="security_impactStatementTime",
            deprecated=False,
        ),
        # Impact justification label to be used when linking a vulnerability to an element
        # representing a VEX product with a VexNotAffectedVulnAssessmentRelationship
        # relationship.
        ClassProp(
            "security_justificationType",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Security/VexJustificationType/componentNotPresent", "componentNotPresent"),
                    ("https://spdx.org/rdf/3.0.1/terms/Security/VexJustificationType/inlineMitigationsAlreadyExist", "inlineMitigationsAlreadyExist"),
                    ("https://spdx.org/rdf/3.0.1/terms/Security/VexJustificationType/vulnerableCodeCannotBeControlledByAdversary", "vulnerableCodeCannotBeControlledByAdversary"),
                    ("https://spdx.org/rdf/3.0.1/terms/Security/VexJustificationType/vulnerableCodeNotInExecutePath", "vulnerableCodeNotInExecutePath"),
                    ("https://spdx.org/rdf/3.0.1/terms/Security/VexJustificationType/vulnerableCodeNotPresent", "vulnerableCodeNotPresent"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Security/justificationType",
            compact="security_justificationType",
            deprecated=False,
        ),
    ]


class security_VexUnderInvestigationVulnAssessmentRelationship(security_VexVulnAssessmentRelationship):
    """
    Designates elements as products where the impact of a vulnerability is being
    investigated.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Security/VexUnderInvestigationVulnAssessmentRelationship"
    COMPACT_TYPE = "security_VexUnderInvestigationVulnAssessmentRelationship"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"


class software_File(software_SoftwareArtifact):
    """
    Refers to any object that stores content on a computer.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Software/File"
    COMPACT_TYPE = "software_File"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Provides information about the content type of an Element or a Property.
        ClassProp(
            "contentType",
            lambda:
            StringProp(pattern=r"^[^\/]+\/[^\/]+$"),
            iri="https://spdx.org/rdf/3.0.1/terms/Core/contentType",
            compact="contentType",
            deprecated=False,
        ),
        # Describes if a given file is a directory or non-directory kind of file.
        ClassProp(
            "software_fileKind",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Software/FileKindType/directory", "directory"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/FileKindType/file", "file"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Software/fileKind",
            compact="software_fileKind",
            deprecated=False,
        ),
    ]


class software_Package(software_SoftwareArtifact):
    """
    Refers to any unit of content that can be associated with a distribution of
    software.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Software/Package"
    COMPACT_TYPE = "software_Package"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Identifies the download Uniform Resource Identifier for the package at the time
        # that the document was created.
        ClassProp(
            "software_downloadLocation",
            lambda:
            AnyURIProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Software/downloadLocation",
            compact="software_downloadLocation",
            deprecated=False,
        ),
        # A place for the SPDX document creator to record a website that serves as the
        # package's home page.
        ClassProp(
            "software_homePage",
            lambda:
            AnyURIProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Software/homePage",
            compact="software_homePage",
            deprecated=False,
        ),
        # Provides a place for the SPDX data creator to record the package URL string
        # (in accordance with the Package URL specification) for a software Package.
        ClassProp(
            "software_packageUrl",
            lambda:
            AnyURIProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Software/packageUrl",
            compact="software_packageUrl",
            deprecated=False,
        ),
        # Identify the version of a package.
        ClassProp(
            "software_packageVersion",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Software/packageVersion",
            compact="software_packageVersion",
            deprecated=False,
        ),
        # Records any relevant background information or additional comments
        # about the origin of the package.
        ClassProp(
            "software_sourceInfo",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Software/sourceInfo",
            compact="software_sourceInfo",
            deprecated=False,
        ),
    ]


class software_Sbom(Bom):
    """
    A collection of SPDX Elements describing a single package.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Software/Sbom"
    COMPACT_TYPE = "software_Sbom"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Provides information about the type of an SBOM.
        ClassProp(
            "software_sbomType",
            lambda:
            ListProp(EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SbomType/analyzed", "analyzed"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SbomType/build", "build"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SbomType/deployed", "deployed"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SbomType/design", "design"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SbomType/runtime", "runtime"),
                    ("https://spdx.org/rdf/3.0.1/terms/Software/SbomType/source", "source"),
                ))),
            iri="https://spdx.org/rdf/3.0.1/terms/Software/sbomType",
            compact="software_sbomType",
            deprecated=False,
        ),
    ]


class software_Snippet(software_SoftwareArtifact):
    """
    Describes a certain part of a file.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Software/Snippet"
    COMPACT_TYPE = "software_Snippet"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Defines the byte range in the original host file that the snippet information
        # applies to.
        ClassProp(
            "software_byteRange",
            lambda:
            ObjectProp(PositiveIntegerRange, False),
            iri="https://spdx.org/rdf/3.0.1/terms/Software/byteRange",
            compact="software_byteRange",
            deprecated=False,
        ),
        # Defines the line range in the original host file that the snippet information
        # applies to.
        ClassProp(
            "software_lineRange",
            lambda:
            ObjectProp(PositiveIntegerRange, False),
            iri="https://spdx.org/rdf/3.0.1/terms/Software/lineRange",
            compact="software_lineRange",
            deprecated=False,
        ),
        # Defines the original host file that the snippet information applies to.
        ClassProp(
            "software_snippetFromFile",
            lambda:
            ObjectProp(software_File, True),
            iri="https://spdx.org/rdf/3.0.1/terms/Software/snippetFromFile",
            min_count=1,
            compact="software_snippetFromFile",
            deprecated=False,
        ),
    ]


class ai_AIPackage(software_Package):
    """
    Specifies an AI package and its associated information.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/AI/AIPackage"
    COMPACT_TYPE = "ai_AIPackage"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Indicates whether the system can perform a decision or action without human
        # involvement or guidance.
        ClassProp(
            "ai_autonomyType",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Core/PresenceType/no", "no"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/PresenceType/noAssertion", "noAssertion"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/PresenceType/yes", "yes"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/autonomyType",
            compact="ai_autonomyType",
            deprecated=False,
        ),
        # Captures the domain in which the AI package can be used.
        ClassProp(
            "ai_domain",
            lambda:
            ListProp(StringProp()),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/domain",
            compact="ai_domain",
            deprecated=False,
        ),
        # Indicates the amount of energy consumption incurred by an AI model.
        ClassProp(
            "ai_energyConsumption",
            lambda:
            ObjectProp(ai_EnergyConsumption, False),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/energyConsumption",
            compact="ai_energyConsumption",
            deprecated=False,
        ),
        # Records a hyperparameter used to build the AI model contained in the AI
        # package.
        ClassProp(
            "ai_hyperparameter",
            lambda:
            ListProp(ObjectProp(DictionaryEntry, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/hyperparameter",
            compact="ai_hyperparameter",
            deprecated=False,
        ),
        # Provides relevant information about the AI software, not including the model
        # description.
        ClassProp(
            "ai_informationAboutApplication",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/informationAboutApplication",
            compact="ai_informationAboutApplication",
            deprecated=False,
        ),
        # Describes relevant information about different steps of the training process.
        ClassProp(
            "ai_informationAboutTraining",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/informationAboutTraining",
            compact="ai_informationAboutTraining",
            deprecated=False,
        ),
        # Captures a limitation of the AI software.
        ClassProp(
            "ai_limitation",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/limitation",
            compact="ai_limitation",
            deprecated=False,
        ),
        # Records the measurement of prediction quality of the AI model.
        ClassProp(
            "ai_metric",
            lambda:
            ListProp(ObjectProp(DictionaryEntry, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/metric",
            compact="ai_metric",
            deprecated=False,
        ),
        # Captures the threshold that was used for computation of a metric described in
        # the metric field.
        ClassProp(
            "ai_metricDecisionThreshold",
            lambda:
            ListProp(ObjectProp(DictionaryEntry, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/metricDecisionThreshold",
            compact="ai_metricDecisionThreshold",
            deprecated=False,
        ),
        # Describes all the preprocessing steps applied to the training data before the
        # model training.
        ClassProp(
            "ai_modelDataPreprocessing",
            lambda:
            ListProp(StringProp()),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/modelDataPreprocessing",
            compact="ai_modelDataPreprocessing",
            deprecated=False,
        ),
        # Describes methods that can be used to explain the results from the AI model.
        ClassProp(
            "ai_modelExplainability",
            lambda:
            ListProp(StringProp()),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/modelExplainability",
            compact="ai_modelExplainability",
            deprecated=False,
        ),
        # Records the results of general safety risk assessment of the AI system.
        ClassProp(
            "ai_safetyRiskAssessment",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/AI/SafetyRiskAssessmentType/high", "high"),
                    ("https://spdx.org/rdf/3.0.1/terms/AI/SafetyRiskAssessmentType/low", "low"),
                    ("https://spdx.org/rdf/3.0.1/terms/AI/SafetyRiskAssessmentType/medium", "medium"),
                    ("https://spdx.org/rdf/3.0.1/terms/AI/SafetyRiskAssessmentType/serious", "serious"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/safetyRiskAssessment",
            compact="ai_safetyRiskAssessment",
            deprecated=False,
        ),
        # Captures a standard that is being complied with.
        ClassProp(
            "ai_standardCompliance",
            lambda:
            ListProp(StringProp()),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/standardCompliance",
            compact="ai_standardCompliance",
            deprecated=False,
        ),
        # Records the type of the model used in the AI software.
        ClassProp(
            "ai_typeOfModel",
            lambda:
            ListProp(StringProp()),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/typeOfModel",
            compact="ai_typeOfModel",
            deprecated=False,
        ),
        # Records if sensitive personal information is used during model training or
        # could be used during the inference.
        ClassProp(
            "ai_useSensitivePersonalInformation",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Core/PresenceType/no", "no"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/PresenceType/noAssertion", "noAssertion"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/PresenceType/yes", "yes"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/AI/useSensitivePersonalInformation",
            compact="ai_useSensitivePersonalInformation",
            deprecated=False,
        ),
    ]


class dataset_DatasetPackage(software_Package):
    """
    Specifies a data package and its associated information.
    """

    TYPE = "https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetPackage"
    COMPACT_TYPE = "dataset_DatasetPackage"
    NODE_KIND: NodeKind = NodeKind.IRI
    ID_ALIAS: Optional[str] = "spdxId"
    PROPERTIES = [
        # Describes the anonymization methods used.
        ClassProp(
            "dataset_anonymizationMethodUsed",
            lambda:
            ListProp(StringProp()),
            iri="https://spdx.org/rdf/3.0.1/terms/Dataset/anonymizationMethodUsed",
            compact="dataset_anonymizationMethodUsed",
            deprecated=False,
        ),
        # Describes the confidentiality level of the data points contained in the dataset.
        ClassProp(
            "dataset_confidentialityLevel",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/ConfidentialityLevelType/amber", "amber"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/ConfidentialityLevelType/clear", "clear"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/ConfidentialityLevelType/green", "green"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/ConfidentialityLevelType/red", "red"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Dataset/confidentialityLevel",
            compact="dataset_confidentialityLevel",
            deprecated=False,
        ),
        # Describes how the dataset was collected.
        ClassProp(
            "dataset_dataCollectionProcess",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Dataset/dataCollectionProcess",
            compact="dataset_dataCollectionProcess",
            deprecated=False,
        ),
        # Describes the preprocessing steps that were applied to the raw data to create the given dataset.
        ClassProp(
            "dataset_dataPreprocessing",
            lambda:
            ListProp(StringProp()),
            iri="https://spdx.org/rdf/3.0.1/terms/Dataset/dataPreprocessing",
            compact="dataset_dataPreprocessing",
            deprecated=False,
        ),
        # The field describes the availability of a dataset.
        ClassProp(
            "dataset_datasetAvailability",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetAvailabilityType/clickthrough", "clickthrough"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetAvailabilityType/directDownload", "directDownload"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetAvailabilityType/query", "query"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetAvailabilityType/registration", "registration"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetAvailabilityType/scrapingScript", "scrapingScript"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Dataset/datasetAvailability",
            compact="dataset_datasetAvailability",
            deprecated=False,
        ),
        # Describes potentially noisy elements of the dataset.
        ClassProp(
            "dataset_datasetNoise",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Dataset/datasetNoise",
            compact="dataset_datasetNoise",
            deprecated=False,
        ),
        # Captures the size of the dataset.
        ClassProp(
            "dataset_datasetSize",
            lambda:
            NonNegativeIntegerProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Dataset/datasetSize",
            compact="dataset_datasetSize",
            deprecated=False,
        ),
        # Describes the type of the given dataset.
        ClassProp(
            "dataset_datasetType",
            lambda:
            ListProp(EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/audio", "audio"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/categorical", "categorical"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/graph", "graph"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/image", "image"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/noAssertion", "noAssertion"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/numeric", "numeric"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/other", "other"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/sensor", "sensor"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/structured", "structured"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/syntactic", "syntactic"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/text", "text"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/timeseries", "timeseries"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/timestamp", "timestamp"),
                    ("https://spdx.org/rdf/3.0.1/terms/Dataset/DatasetType/video", "video"),
                ))),
            iri="https://spdx.org/rdf/3.0.1/terms/Dataset/datasetType",
            min_count=1,
            compact="dataset_datasetType",
            deprecated=False,
        ),
        # Describes a mechanism to update the dataset.
        ClassProp(
            "dataset_datasetUpdateMechanism",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Dataset/datasetUpdateMechanism",
            compact="dataset_datasetUpdateMechanism",
            deprecated=False,
        ),
        # Describes if any sensitive personal information is present in the dataset.
        ClassProp(
            "dataset_hasSensitivePersonalInformation",
            lambda:
            EnumProp((
                    ("https://spdx.org/rdf/3.0.1/terms/Core/PresenceType/no", "no"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/PresenceType/noAssertion", "noAssertion"),
                    ("https://spdx.org/rdf/3.0.1/terms/Core/PresenceType/yes", "yes"),
                )),
            iri="https://spdx.org/rdf/3.0.1/terms/Dataset/hasSensitivePersonalInformation",
            compact="dataset_hasSensitivePersonalInformation",
            deprecated=False,
        ),
        # Describes what the given dataset should be used for.
        ClassProp(
            "dataset_intendedUse",
            lambda:
            StringProp(),
            iri="https://spdx.org/rdf/3.0.1/terms/Dataset/intendedUse",
            compact="dataset_intendedUse",
            deprecated=False,
        ),
        # Records the biases that the dataset is known to encompass.
        ClassProp(
            "dataset_knownBias",
            lambda:
            ListProp(StringProp()),
            iri="https://spdx.org/rdf/3.0.1/terms/Dataset/knownBias",
            compact="dataset_knownBias",
            deprecated=False,
        ),
        # Describes a sensor used for collecting the data.
        ClassProp(
            "dataset_sensor",
            lambda:
            ListProp(ObjectProp(DictionaryEntry, False)),
            iri="https://spdx.org/rdf/3.0.1/terms/Dataset/sensor",
            compact="dataset_sensor",
            deprecated=False,
        ),
    ]


"""Format Guard"""
# fmt: on
