Source code for tdw_catalog.metadata_template.date_field

from datetime import date
from typing import Optional

from tdw_catalog.utils import MetadataFieldType
import tdw_catalog.metadata_template.field as field


class Field(field.MetadataTemplateField[date]):
    """
    Add dates to the :class:`.Dataset` to keep track of timelines or events

    Attributes
    ----------
    None
    """

    def __init__(self, key: str, default_value: Optional[date],
                 optional: Optional[bool]) -> None:
        super().__init__(key, default_value, optional)

    def serialize(self) -> dict:
        res = super().serialize()
        res["default_value"] = self.default_value.isoformat(
        ) if self.default_value is not None else None
        res["field_type"] = MetadataFieldType.FT_DATE
        return res