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

.. py:module:: generic.spiders.generic_sitemap

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

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

Classes
~~~~~~~

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

   * - :py:obj:`GenericSitemapSpiderConfig <generic.spiders.generic_sitemap.GenericSitemapSpiderConfig>`
     -
   * - :py:obj:`GenericSitemapSpider <generic.spiders.generic_sitemap.GenericSitemapSpider>`
     - .. autodoc2-docstring:: generic.spiders.generic_sitemap.GenericSitemapSpider
          :summary:

API
~~~

.. py:class:: GenericSitemapSpiderConfig(/, **data: typing.Any)
   :canonical: generic.spiders.generic_sitemap.GenericSitemapSpiderConfig

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

   .. py:attribute:: sitemap_type
      :canonical: generic.spiders.generic_sitemap.GenericSitemapSpiderConfig.sitemap_type
      :type: str
      :value: 'all'

      .. autodoc2-docstring:: generic.spiders.generic_sitemap.GenericSitemapSpiderConfig.sitemap_type

.. py:class:: GenericSitemapSpider(*args, **kwargs)
   :canonical: generic.spiders.generic_sitemap.GenericSitemapSpider

   Bases: :py:obj:`scrapy.spiders.SitemapSpider`, :py:obj:`generic.spiders.base.GenericSpider`\ [\ :py:obj:`generic.spiders.generic_sitemap.GenericSitemapSpiderConfig`\ ]

   .. autodoc2-docstring:: generic.spiders.generic_sitemap.GenericSitemapSpider

   .. rubric:: Initialization

   .. autodoc2-docstring:: generic.spiders.generic_sitemap.GenericSitemapSpider.__init__

   .. py:attribute:: name
      :canonical: generic.spiders.generic_sitemap.GenericSitemapSpider.name
      :value: 'sitemap'

      .. autodoc2-docstring:: generic.spiders.generic_sitemap.GenericSitemapSpider.name

   .. py:attribute:: custom_settings
      :canonical: generic.spiders.generic_sitemap.GenericSitemapSpider.custom_settings
      :value: None

      .. autodoc2-docstring:: generic.spiders.generic_sitemap.GenericSitemapSpider.custom_settings

   .. py:attribute:: sitemap_urls
      :canonical: generic.spiders.generic_sitemap.GenericSitemapSpider.sitemap_urls
      :value: []

      .. autodoc2-docstring:: generic.spiders.generic_sitemap.GenericSitemapSpider.sitemap_urls

   .. py:method:: get_config_class() -> typing.Type[generic.spiders.generic_sitemap.GenericSitemapSpiderConfig]
      :canonical: generic.spiders.generic_sitemap.GenericSitemapSpider.get_config_class
      :classmethod:

      .. autodoc2-docstring:: generic.spiders.generic_sitemap.GenericSitemapSpider.get_config_class

   .. py:method:: sitemap_filter(entries)
      :canonical: generic.spiders.generic_sitemap.GenericSitemapSpider.sitemap_filter

   .. py:method:: sitemap_filter_all(entries)
      :canonical: generic.spiders.generic_sitemap.GenericSitemapSpider.sitemap_filter_all

      .. autodoc2-docstring:: generic.spiders.generic_sitemap.GenericSitemapSpider.sitemap_filter_all

   .. py:method:: sitemap_filter_wordpress(entries)
      :canonical: generic.spiders.generic_sitemap.GenericSitemapSpider.sitemap_filter_wordpress

      .. autodoc2-docstring:: generic.spiders.generic_sitemap.GenericSitemapSpider.sitemap_filter_wordpress

   .. py:method:: parse(response: scrapy.http.Response)
      :canonical: generic.spiders.generic_sitemap.GenericSitemapSpider.parse

      .. autodoc2-docstring:: generic.spiders.generic_sitemap.GenericSitemapSpider.parse