article_list.py

from typing import List, Optional

import attrs
from web_poet import Returns

from zyte_common_items.components import Breadcrumb
from zyte_common_items.fields import auto_field
from zyte_common_items.items import ArticleFromList, ArticleList, ArticleListMetadata
from zyte_common_items.processors import breadcrumbs_processor, string_processor

from .base import BasePage, Page
from .mixins import HasMetadata


class _ArticleListProcessors(BasePage.Processors):
    breadcrumbs = [breadcrumbs_processor]
    canonicalUrl = [string_processor]


class BaseArticleListPage(
    BasePage, Returns[ArticleList], HasMetadata[ArticleListMetadata]
):
    """:class:`BasePage` subclass for :class:`ArticleList`."""

    class Processors(_ArticleListProcessors):
        pass


class ArticleListPage(Page, Returns[ArticleList], HasMetadata[ArticleListMetadata]):
    """:class:`Page` subclass for :class:`ArticleList`."""

    class Processors(_ArticleListProcessors):
        pass


@attrs.define
class AutoArticleListPage(BaseArticleListPage):
    article_list: ArticleList

    @auto_field
    def articles(self) -> Optional[List[ArticleFromList]]:
        return self.article_list.articles

    @auto_field
    def breadcrumbs(self) -> Optional[List[Breadcrumb]]:
        return self.article_list.breadcrumbs

    @auto_field
    def canonicalUrl(self) -> Optional[str]:
        return self.article_list.canonicalUrl

    @auto_field
    def metadata(self) -> Optional[ArticleListMetadata]:
        return self.article_list.metadata

    @auto_field
    def url(self) -> Optional[str]:
        return self.article_list.url