Source code for api.v1.serializers.correspondent_serializers.BaseCorrespondentSerializer

# SPDX-License-Identifier: AGPL-3.0-or-later
#
# Eonvelope - a open-source self-hostable email archiving server
# Copyright (C) 2024 David Aderbauer & The Eonvelope Contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.

"""Module with the :class:`BaseCorrespondentSerializer` serializer class."""

from __future__ import annotations

from typing import TYPE_CHECKING, Final

from rest_framework import serializers

from core.models import Correspondent

if TYPE_CHECKING:
    from django.db.models import Model




[docs]
class BaseCorrespondentSerializer(serializers.ModelSerializer[Correspondent]):
    """The base serializer for :class:`core.models.Correspondent`.

    Includes all viable fields from the model.
    Sets all constraints that must be implemented in all serializers.
    Other serializers for :class:`core.models.Correspondent` should inherit from this.
    """



[docs]
    class Meta:
        """Metadata class for the base serializer.

        Contains constraints that must be implemented by all serializers.
        Other serializer metaclasses should inherit from this.
        :attr:`read_only_fields` must not be shortened in subclasses.
        """

        model: Final[type[Model]] = Correspondent
        """The model to serialize."""

        exclude: Final[list[str]] = ["user"]
        """Exclude only the :attr:`core.models.Correspondent.Correspondent.user` field."""

        read_only_fields: Final[list[str]] = [
            "email_address",
            "email_name",
            "list_id",
            "list_owner",
            "list_subscribe",
            "list_unsubscribe",
            "list_unsubscribe_post",
            "list_post",
            "list_help",
            "list_archive",
            "created",
            "updated",
        ]
        """The :attr:`core.models.Correspondent.Correspondent.email_address`,
        :attr:`core.models.Correspondent.Correspondent.created` and
        :attr:`core.models.Correspondent.Correspondent.updated` fields are read-only.
        """