Source code for codegrade.models.ip_range

"""The module that defines the ``IPRange`` 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
from .ip_range_mixin import IPRangeMixin




@dataclass
class IPRange(IPRangeMixin):
    """The JSON representation of an IP range."""

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

    data_parser: t.ClassVar[t.Any] = rqa.Lazy(
        lambda: IPRangeMixin.data_parser.parser.combine(
            rqa.FixedMapping()
        ).use_readable_describe(True)
    )

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

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

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



import os

if os.getenv("CG_GENERATING_DOCS", "False").lower() in ("", "true"):
    pass