article_navigation.py

from typing import List, Optional

import attrs
from web_poet import Returns

from zyte_common_items.components import ProbabilityRequest, Request
from zyte_common_items.fields import auto_field
from zyte_common_items.items import ArticleNavigation, ArticleNavigationMetadata
from zyte_common_items.processors import string_processor

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


class _ArticleNavigationProcessors(BasePage.Processors):
    categoryName = [string_processor]


class BaseArticleNavigationPage(
    BasePage, Returns[ArticleNavigation], HasMetadata[ArticleNavigationMetadata]
):
    """:class:`BasePage` subclass for :class:`ArticleNavigation`."""

    class Processors(_ArticleNavigationProcessors):
        pass


class ArticleNavigationPage(
    Page, Returns[ArticleNavigation], HasMetadata[ArticleNavigationMetadata]
):
    """:class:`Page` subclass for :class:`ArticleNavigation`."""

    class Processors(_ArticleNavigationProcessors):
        pass


@attrs.define
class AutoArticleNavigationPage(BaseArticleNavigationPage):
    article_navigation: ArticleNavigation

    @auto_field
    def categoryName(self) -> Optional[str]:
        return self.article_navigation.categoryName

    @auto_field
    def items(self) -> Optional[List[ProbabilityRequest]]:
        return self.article_navigation.items

    @auto_field
    def metadata(self) -> Optional[ArticleNavigationMetadata]:
        return self.article_navigation.metadata

    @auto_field
    def nextPage(self) -> Optional[Request]:
        return self.article_navigation.nextPage

    @auto_field
    def pageNumber(self) -> Optional[int]:
        return self.article_navigation.pageNumber

    @auto_field
    def subCategories(self) -> Optional[List[ProbabilityRequest]]:
        return self.article_navigation.subCategories

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