#
# Copyright (c) 2021-2026 ahriman team.
#
# This file is part of ahriman
# (see https://github.com/arcan1s/ahriman).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
from dataclasses import dataclass, field
from typing import Any


@dataclass(frozen=True)
class Property:
    """
    holder of object properties descriptor

    Attributes:
        name(str): name of the property
        value(Any): property value
        is_required(bool): if set to ``True`` then this property is required
        indent(int): property indentation level
    """

    name: str
    value: Any
    is_required: bool = field(default=False, kw_only=True)
    indent: int = 1
