Source code for codegrade.models.extended_tenant

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

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

import datetime
import typing as t
from dataclasses import dataclass, field

import cg_request_args as rqa

from .. import parsers
from ..utils import to_dict
from .tenant import Tenant
from .tenant_price import TenantPrice


[docs]@dataclass class ExtendedTenant(Tenant): """The extended JSON representation of a tenant.""" #: A url where you can download the default logo for this tenant. You don't #: need to be logged in to use this url. logo_default_url: "str" #: A url where you can download the dark logo for this tenant. You don't #: need to be logged in to use this url. logo_dark_url: "str" #: The price of a tenant. price: "t.Optional[TenantPrice]" #: This value determines when the contract of the tenant starts. As not all #: tenants start at the same date in the year, we use this to collect #: statistics. contract_start: "t.Optional[datetime.date]" raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False) data_parser: t.ClassVar = rqa.Lazy( lambda: Tenant.data_parser.parser.combine( rqa.FixedMapping( rqa.RequiredArgument( "logo_default_url", rqa.SimpleValue.str, doc="A url where you can download the default logo for this tenant. You don't need to be logged in to use this url.", ), rqa.RequiredArgument( "logo_dark_url", rqa.SimpleValue.str, doc="A url where you can download the dark logo for this tenant. You don't need to be logged in to use this url.", ), rqa.RequiredArgument( "price", rqa.Nullable(parsers.ParserFor.make(TenantPrice)), doc="The price of a tenant.", ), rqa.RequiredArgument( "contract_start", rqa.Nullable(rqa.RichValue.Date), doc="This value determines when the contract of the tenant starts. As not all tenants start at the same date in the year, we use this to collect statistics.", ), ) ).use_readable_describe(True) ) def to_dict(self) -> t.Dict[str, t.Any]: res: t.Dict[str, t.Any] = { "logo_default_url": to_dict(self.logo_default_url), "logo_dark_url": to_dict(self.logo_dark_url), "price": to_dict(self.price), "contract_start": to_dict(self.contract_start), "id": to_dict(self.id), "name": to_dict(self.name), "sso_provider_id": to_dict(self.sso_provider_id), "statistics": to_dict(self.statistics), "abbreviated_name": to_dict(self.abbreviated_name), "order_category": to_dict(self.order_category), "is_hidden": to_dict(self.is_hidden), "netloc": to_dict(self.netloc), } return res @classmethod def from_dict( cls: t.Type["ExtendedTenant"], d: t.Dict[str, t.Any] ) -> "ExtendedTenant": parsed = cls.data_parser.try_parse(d) res = cls( logo_default_url=parsed.logo_default_url, logo_dark_url=parsed.logo_dark_url, price=parsed.price, contract_start=parsed.contract_start, id=parsed.id, name=parsed.name, sso_provider_id=parsed.sso_provider_id, statistics=parsed.statistics, abbreviated_name=parsed.abbreviated_name, order_category=parsed.order_category, is_hidden=parsed.is_hidden, netloc=parsed.netloc, ) res.raw_data = d return res
import os if os.getenv("CG_GENERATING_DOCS", "False").lower() in ("", "true"): from .tenant_statistics import TenantStatistics