scrapy/scrapy/utils/spider.py

84 lines
2.7 KiB
Python

import logging
import inspect
from scrapy.spiders import Spider
from scrapy.utils.defer import deferred_from_coro
from scrapy.utils.misc import arg_to_iter
try:
from scrapy.utils.py36 import collect_asyncgen
except SyntaxError:
collect_asyncgen = None
logger = logging.getLogger(__name__)
def iterate_spider_output(result):
if collect_asyncgen and hasattr(inspect, 'isasyncgen') and inspect.isasyncgen(result):
d = deferred_from_coro(collect_asyncgen(result))
d.addCallback(iterate_spider_output)
return d
return arg_to_iter(deferred_from_coro(result))
def _is_non_base_spider(spider_class, require_name):
return (
inspect.isclass(spider_class)
and issubclass(spider_class, Spider)
and not spider_class.is_abstract()
and (
getattr(spider_class, 'name', None)
or not require_name
)
)
def iter_spider_classes(module, *, require_name=True):
"""Return an iterator over all :ref:`spider <topics-spiders>` classes
defined in the given module, excluding :ref:`base spiders <base-spiders>`.
If `require_name` is ``True`` (default), any
:class:`~scrapy.spiders.Spider` subclass with a non-empty
:class:`~scrapy.spiders.Spider.name` and not decorated with
:func:`~scrapy.spiders.basespider` is yielded.
If `require_name` is ``False``, any :class:`~scrapy.spiders.Spider`
subclass not decorated with :func:`~scrapy.spiders.basespider` is
yielded.
"""
for obj in vars(module).values():
if (_is_non_base_spider(obj, require_name)
and obj.__module__ == module.__name__):
yield obj
def spidercls_for_request(spider_loader, request, default_spidercls=None,
log_none=False, log_multiple=False):
"""Return a spider class that handles the given Request.
This will look for the spiders that can handle the given request (using
the spider loader) and return a Spider class if (and only if) there is
only one Spider able to handle the Request.
If multiple spiders (or no spider) are found, it will return the
default_spidercls passed. It can optionally log if multiple or no spiders
are found.
"""
snames = spider_loader.find_by_request(request)
if len(snames) == 1:
return spider_loader.load(snames[0])
if len(snames) > 1 and log_multiple:
logger.error('More than one spider can handle: %(request)s - %(snames)s',
{'request': request, 'snames': ', '.join(snames)})
if len(snames) == 0 and log_none:
logger.error('Unable to find spider that handles: %(request)s',
{'request': request})
return default_spidercls
class DefaultSpider(Spider):
name = 'default'