Source code for codegrade.models.assignment_editor_settings

"""The module that defines the ``AssignmentEditorSettings`` model.

SPDX-License-Identifier: AGPL-3.0-only OR BSD-3-Clause-Clear
"""

from __future__ import annotations

import typing as t
from dataclasses import dataclass, field

import cg_request_args as rqa

from ..utils import to_dict




@dataclass(kw_only=True)
class AssignmentEditorSettings:
    """The configurable editor settings exposed for an assignment."""

    #: The maximum number of characters allowed in a single paste in the code
    #: editor. `0` blocks all pastes.
    max_paste_size: t.Optional[int]
    #: The right panel the code editor opens on. `null` when the assignment
    #: defers to the tenant default.
    default_panel: t.Optional[
        t.Literal[
            "ai-assistant",
            "auto-test",
            "closed",
            "description",
            "files",
            "help",
        ]
    ]

    raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)

    data_parser: t.ClassVar[t.Any] = rqa.Lazy(
        lambda: rqa.FixedMapping(
            rqa.RequiredArgument(
                "max_paste_size",
                rqa.Nullable(rqa.SimpleValue.int),
                doc="The maximum number of characters allowed in a single paste in the code editor. `0` blocks all pastes.",
            ),
            rqa.RequiredArgument(
                "default_panel",
                rqa.Nullable(
                    rqa.StringEnum(
                        "ai-assistant",
                        "auto-test",
                        "closed",
                        "description",
                        "files",
                        "help",
                    )
                ),
                doc="The right panel the code editor opens on. `null` when the assignment defers to the tenant default.",
            ),
        )
    )

    def to_dict(self) -> t.Dict[str, t.Any]:
        res: t.Dict[str, t.Any] = {
            "max_paste_size": to_dict(self.max_paste_size),
            "default_panel": to_dict(self.default_panel),
        }
        return res

    @classmethod
    def from_dict(
        cls: t.Type[AssignmentEditorSettings], d: t.Dict[str, t.Any]
    ) -> AssignmentEditorSettings:
        parsed = cls.data_parser.try_parse(d)

        res = cls(
            max_paste_size=parsed.max_paste_size,
            default_panel=parsed.default_panel,
        )
        res.raw_data = d
        return res