Source code for codegrade.models.create_division_section_data

"""The module that defines the ``CreateDivisionSectionData`` 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 .. import parsers
from ..utils import to_dict
from .course_section_division_user import CourseSectionDivisionUser


@dataclass
class CreateDivisionSectionData:
    """Input data required for the `Section::CreateDivision` operation."""

    #: The users to add to this course section.
    users: t.Sequence[CourseSectionDivisionUser]

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

    data_parser: t.ClassVar = rqa.Lazy(
        lambda: rqa.FixedMapping(
            rqa.RequiredArgument(
                "users",
                rqa.List(parsers.ParserFor.make(CourseSectionDivisionUser)),
                doc="The users to add to this course section.",
            ),
        ).use_readable_describe(True)
    )

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

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

        res = cls(
            users=parsed.users,
        )
        res.raw_data = d
        return res