feed.py

from typing import Optional

from pydantic import Field

from rss_parser.models import XMLBaseModel
from rss_parser.models.atom.entry import Entry
from rss_parser.models.atom.person import Person
from rss_parser.models.types.date import DateTimeOrStr
from rss_parser.models.types.only_list import OnlyList
from rss_parser.models.types.tag import Tag


class RequiredAtomFeedMixin(XMLBaseModel):
    id: Tag[str]
    "Identifies the feed using a universally unique and permanent URI."

    title: Tag[str]
    "Contains a human readable title for the feed."

    updated: Tag[DateTimeOrStr]
    "Indicates the last time the feed was modified in a significant way."


class RecommendedAtomFeedMixin(XMLBaseModel):
    authors: OnlyList[Tag[Person]] = Field(alias="author", default_factory=OnlyList)
    "Names one author of the feed. A feed may have multiple author elements."

    links: OnlyList[Tag[str]] = Field(alias="link", default_factory=OnlyList)
    "The URL to the feed. A feed may have multiple link elements."


class OptionalAtomFeedMixin(XMLBaseModel):
    entries: OnlyList[Tag[Entry]] = Field(alias="entry", default_factory=OnlyList)
    "The entries in the feed. A feed may have multiple entry elements."

    categories: OnlyList[Tag[dict]] = Field(alias="category", default_factory=OnlyList)
    "Specifies a categories that the feed belongs to. The feed may have multiple categories elements."

    contributors: OnlyList[Tag[Person]] = Field(alias="contributor", default_factory=OnlyList)
    "Feed contributors."

    generator: Optional[Tag[str]] = None
    "Identifies the software used to generate the feed, for debugging and other purposes."

    icon: Optional[Tag[str]] = None
    "Identifies a small image which provides iconic visual identification for the feed. Icons should be square."

    logo: Optional[Tag[str]] = None
    "Identifies a larger image which provides visual identification for the feed. \
    Images should be twice as wide as they are tall."

    rights: Optional[Tag[str]] = None
    "The copyright of the feed."

    subtitle: Optional[Tag[str]] = None
    "Contains a human readable description or subtitle for the feed."


class Feed(RequiredAtomFeedMixin, RecommendedAtomFeedMixin, OptionalAtomFeedMixin, XMLBaseModel):
    """https://validator.w3.org/feed/docs/atom.html"""