:py:mod:`generic.spiders.feed`
==============================

.. py:module:: generic.spiders.feed

.. autodoc2-docstring:: generic.spiders.feed
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`FeedEntry <generic.spiders.feed.FeedEntry>`
     - .. autodoc2-docstring:: generic.spiders.feed.FeedEntry
          :summary:
   * - :py:obj:`Feed <generic.spiders.feed.Feed>`
     - .. autodoc2-docstring:: generic.spiders.feed.Feed
          :summary:
   * - :py:obj:`FeedConfig <generic.spiders.feed.FeedConfig>`
     - .. autodoc2-docstring:: generic.spiders.feed.FeedConfig
          :summary:
   * - :py:obj:`FeedSpiderConfig <generic.spiders.feed.FeedSpiderConfig>`
     - .. autodoc2-docstring:: generic.spiders.feed.FeedSpiderConfig
          :summary:
   * - :py:obj:`FeedSpider <generic.spiders.feed.FeedSpider>`
     - .. autodoc2-docstring:: generic.spiders.feed.FeedSpider
          :summary:

API
~~~

.. py:class:: FeedEntry(/, **data: typing.Any)
   :canonical: generic.spiders.feed.FeedEntry

   Bases: :py:obj:`pydantic.BaseModel`

   .. autodoc2-docstring:: generic.spiders.feed.FeedEntry

   .. rubric:: Initialization

   .. autodoc2-docstring:: generic.spiders.feed.FeedEntry.__init__

   .. py:attribute:: id
      :canonical: generic.spiders.feed.FeedEntry.id
      :type: str
      :value: None

      .. autodoc2-docstring:: generic.spiders.feed.FeedEntry.id

   .. py:attribute:: title
      :canonical: generic.spiders.feed.FeedEntry.title
      :type: str
      :value: None

      .. autodoc2-docstring:: generic.spiders.feed.FeedEntry.title

   .. py:attribute:: link
      :canonical: generic.spiders.feed.FeedEntry.link
      :type: str
      :value: None

      .. autodoc2-docstring:: generic.spiders.feed.FeedEntry.link

.. py:class:: Feed(/, **data: typing.Any)
   :canonical: generic.spiders.feed.Feed

   Bases: :py:obj:`pydantic.BaseModel`

   .. autodoc2-docstring:: generic.spiders.feed.Feed

   .. rubric:: Initialization

   .. autodoc2-docstring:: generic.spiders.feed.Feed.__init__

   .. py:attribute:: id
      :canonical: generic.spiders.feed.Feed.id
      :type: str
      :value: None

      .. autodoc2-docstring:: generic.spiders.feed.Feed.id

   .. py:attribute:: lang
      :canonical: generic.spiders.feed.Feed.lang
      :type: str
      :value: None

      .. autodoc2-docstring:: generic.spiders.feed.Feed.lang

   .. py:attribute:: type
      :canonical: generic.spiders.feed.Feed.type
      :type: str
      :value: None

      .. autodoc2-docstring:: generic.spiders.feed.Feed.type

   .. py:attribute:: title
      :canonical: generic.spiders.feed.Feed.title
      :type: str
      :value: None

      .. autodoc2-docstring:: generic.spiders.feed.Feed.title

.. py:class:: FeedConfig(/, **data: typing.Any)
   :canonical: generic.spiders.feed.FeedConfig

   Bases: :py:obj:`pydantic.BaseModel`

   .. autodoc2-docstring:: generic.spiders.feed.FeedConfig

   .. rubric:: Initialization

   .. autodoc2-docstring:: generic.spiders.feed.FeedConfig.__init__

   .. py:attribute:: file_name
      :canonical: generic.spiders.feed.FeedConfig.file_name
      :type: str
      :value: None

      .. autodoc2-docstring:: generic.spiders.feed.FeedConfig.file_name

   .. py:attribute:: xpath_href
      :canonical: generic.spiders.feed.FeedConfig.xpath_href
      :type: str
      :value: None

      .. autodoc2-docstring:: generic.spiders.feed.FeedConfig.xpath_href

   .. py:attribute:: xpath_title
      :canonical: generic.spiders.feed.FeedConfig.xpath_title
      :type: str
      :value: None

      .. autodoc2-docstring:: generic.spiders.feed.FeedConfig.xpath_title

   .. py:attribute:: feed_type
      :canonical: generic.spiders.feed.FeedConfig.feed_type
      :type: str
      :value: 'atom'

      .. autodoc2-docstring:: generic.spiders.feed.FeedConfig.feed_type

.. py:class:: FeedSpiderConfig(/, **data: typing.Any)
   :canonical: generic.spiders.feed.FeedSpiderConfig

   Bases: :py:obj:`generic.spiders.base.GenericSpiderConfig`

   .. autodoc2-docstring:: generic.spiders.feed.FeedSpiderConfig

   .. rubric:: Initialization

   .. autodoc2-docstring:: generic.spiders.feed.FeedSpiderConfig.__init__

   .. py:attribute:: feed_config
      :canonical: generic.spiders.feed.FeedSpiderConfig.feed_config
      :type: dict[str, generic.spiders.feed.FeedConfig]
      :value: None

      .. autodoc2-docstring:: generic.spiders.feed.FeedSpiderConfig.feed_config

   .. py:attribute:: config
      :canonical: generic.spiders.feed.FeedSpiderConfig.config
      :type: pathlib.Path
      :value: None

      .. autodoc2-docstring:: generic.spiders.feed.FeedSpiderConfig.config

.. py:class:: FeedSpider(*args, **kwargs)
   :canonical: generic.spiders.feed.FeedSpider

   Bases: :py:obj:`generic.spiders.base.GenericSpider`\ [\ :py:obj:`generic.spiders.feed.FeedSpiderConfig`\ ]

   .. autodoc2-docstring:: generic.spiders.feed.FeedSpider

   .. rubric:: Initialization

   .. autodoc2-docstring:: generic.spiders.feed.FeedSpider.__init__

   .. py:attribute:: name
      :canonical: generic.spiders.feed.FeedSpider.name
      :value: 'feed'

      .. autodoc2-docstring:: generic.spiders.feed.FeedSpider.name

   .. py:attribute:: custom_settings
      :canonical: generic.spiders.feed.FeedSpider.custom_settings
      :value: None

      .. autodoc2-docstring:: generic.spiders.feed.FeedSpider.custom_settings

   .. py:method:: get_config_class() -> typing.Type[generic.spiders.feed.FeedSpiderConfig]
      :canonical: generic.spiders.feed.FeedSpider.get_config_class
      :classmethod:

      .. autodoc2-docstring:: generic.spiders.feed.FeedSpider.get_config_class

   .. py:method:: _load_config(path: pathlib.Path)
      :canonical: generic.spiders.feed.FeedSpider._load_config

      .. autodoc2-docstring:: generic.spiders.feed.FeedSpider._load_config

   .. py:method:: start()
      :canonical: generic.spiders.feed.FeedSpider.start
      :async:

   .. py:method:: parse(response: scrapy.http.Response)
      :canonical: generic.spiders.feed.FeedSpider.parse

      .. autodoc2-docstring:: generic.spiders.feed.FeedSpider.parse

   .. py:method:: _generate_feed(url: str, feed: generic.spiders.feed.Feed, feed_entries: list[generic.spiders.feed.FeedEntry], file_name: str) -> generic.items.FeedItem
      :canonical: generic.spiders.feed.FeedSpider._generate_feed

      .. autodoc2-docstring:: generic.spiders.feed.FeedSpider._generate_feed