译者:OSGeo 中国

Scrapy广泛使用信号来通知某些事件何时发生。你可以在你的垃圾项目中捕捉到这些信号(使用 extension 例如)执行其他任务或扩展scrapy以添加框外未提供的功能。

即使信号提供了几个参数,捕获它们的处理程序也不需要接受所有参数——信号调度机制只传递处理程序接收的参数。

您可以通过 信号API .

下面是一个简单的示例,演示如何捕获信号并执行某些操作:::

  1. from scrapy import signals
  2. from scrapy import Spider
  3. class DmozSpider(Spider):
  4. name = "dmoz"
  5. allowed_domains = ["dmoz.org"]
  6. start_urls = [
  7. "http://www.dmoz.org/Computers/Programming/Languages/Python/Books/",
  8. "http://www.dmoz.org/Computers/Programming/Languages/Python/Resources/",
  9. ]
  10. @classmethod
  11. def from_crawler(cls, crawler, *args, **kwargs):
  12. spider = super(DmozSpider, cls).from_crawler(crawler, *args, **kwargs)
  13. crawler.signals.connect(spider.spider_closed, signal=signals.spider_closed)
  14. return spider
  15. def spider_closed(self, spider):
  16. spider.logger.info('Spider closed: %s', spider.name)
  17. def parse(self, response):
  18. pass

延迟信号处理程序

一些信号支持返回 Twisted deferreds from their handlers, see the 内置信号参考 下面是要知道哪些。

内置信号参考

这是一个零碎的内置信号列表及其含义。

engine_started

  1. scrapy.signals.engine_started()

当废引擎开始爬行时发送。

此信号支持从其处理程序返回延迟。

注解

此信号可能被触发 after 这个 spider_opened 信号,取决于 Spider 是如何启动的。所以 don’t 依靠这个信号 spider_opened .

engine_stopped

  1. scrapy.signals.engine_stopped()

在 Scrapy 引擎停止时发送(例如,当爬行过程完成时)。

此信号支持从其处理程序返回延迟。

item_scraped

  1. scrapy.signals.item_scraped(item, response, spider)

当一个项目被刮掉时发送,当它通过所有 项目管道 阶段(不下降)。

此信号支持从其处理程序返回延迟。

| 参数: |

  • item (dict or Item object) — 物品被刮掉了
  • spider (Spider object) — 刮掉物品的 Spider
  • response (Response object) — 从项目被刮掉的地方得到的响应 | | | —- |

item_dropped

  1. scrapy.signals.item_dropped(item, response, exception, spider)

从中删除项目后发送 项目管道 当某个阶段 DropItem 例外。

此信号支持从其处理程序返回延迟。

| 参数: |

  • item (dict or Item object) — 从中删除的项 项目管道
  • spider (Spider object) — 刮掉物品的 Spider
  • response (Response object) — 从中删除项的响应
  • exception (DropItem exception) — 例外情况(必须是 DropItem 子类)导致该项被删除 | | | —- |

item_error

  1. scrapy.signals.item_error(item, response, spider, failure)

发送时 项目管道 生成错误(即引发异常),除非 DropItem 例外。

此信号支持从其处理程序返回延迟。

| 参数: |

  • item (dict or Item object) — 从中删除的项 项目管道
  • response (Response object) — 引发异常时正在处理的响应
  • spider (Spider object) — 引发异常的 Spider
  • failure (Failure object) — 以扭曲方式引发的异常 Failure 对象 | | | —- |

spider_closed

  1. scrapy.signals.spider_closed(spider, reason)

在 Spider 关闭后发送。这可用于释放在上保留的每个 Spider 资源 spider_opened .

此信号支持从其处理程序返回延迟。

| 参数: |

  • spider (Spider object) — 已关闭的 Spider
  • reason (str) — 描述 Spider 关闭原因的字符串。如果它是因为 Spider 完成了抓取而关闭的,原因是 'finished' . 否则,如果通过调用 close_spider 引擎方法,则原因是 reason 该方法的参数(默认为 'cancelled' )如果发动机停机(例如,按ctrl-c停止发动机),原因将是 'shutdown' . | | | —- |

spider_opened

  1. scrapy.signals.spider_opened(spider)

在 Spider 被打开爬行后发送。这通常用于为每个 Spider 保留资源,但可用于打开 Spider 时需要执行的任何任务。

此信号支持从其处理程序返回延迟。

参数: spider (Spider object) — 已经打开的 Spider

spider_idle

  1. scrapy.signals.spider_idle(spider)

当 Spider 空闲时发送,这意味着 Spider 没有更多:

  • 等待下载的请求
  • 计划的请求
  • 正在项管道中处理的项

如果此信号的所有处理程序完成后空闲状态仍然存在,则引擎将开始关闭 Spider 。 Spider 完成闭合后, spider_closed 发送信号。

你可以举起 DontCloseSpider 防止 Spider 关闭的异常。

此信号不支持从其处理程序返回延迟。

参数: spider (Spider object) — 空转的 Spider

注解

在您的 spider_idle 处理程序 not 确保它可以防止 Spider 被关闭,尽管有时可以。这是因为如果计划程序拒绝了所有计划的请求(例如,由于重复而被筛选),那么spider可能仍然处于空闲状态。

spider_error

  1. scrapy.signals.spider_error(failure, response, spider)

在spider回调生成错误(即引发异常)时发送。

此信号不支持从其处理程序返回延迟。

| 参数: |

  • failure (Failure object) — 以扭曲方式引发的异常 Failure 对象
  • response (Response object) — 引发异常时正在处理的响应
  • spider (Spider object) — 引发异常的 Spider | | | —- |

request_scheduled

  1. scrapy.signals.request_scheduled(request, spider)

在发动机排程A时发送 Request ,稍后下载。

该信号不支持从其处理程序返回延迟。

| 参数: |

  • request (Request object) — 到达调度程序的请求
  • spider (Spider object) — 发出请求的 Spider | | | —- |

request_dropped

  1. scrapy.signals.request_dropped(request, spider)

发送时 Request 由引擎计划稍后下载的,被调度程序拒绝。

该信号不支持从其处理程序返回延迟。

| 参数: |

  • request (Request object) — 到达调度程序的请求
  • spider (Spider object) — 发出请求的 Spider | | | —- |

request_reached_downloader

  1. scrapy.signals.request_reached_downloader(request, spider)

发送时 Request 已到达下载程序。

该信号不支持从其处理程序返回延迟。

| 参数: |

  • request (Request object) — 到达下载程序的请求
  • spider (Spider object) — 发出请求的 Spider | | | —- |

response_received

  1. scrapy.signals.response_received(response, request, spider)

当发动机接收到新的 Response 从下载程序。

此信号不支持从其处理程序返回延迟。

| 参数: |

  • response (Response object) — 收到的响应
  • request (Request object) — 生成响应的请求
  • spider (Spider object) — 响应所针对的 Spider | | | —- |

response_downloaded

  1. scrapy.signals.response_downloaded(response, request, spider)

由下载者在 HTTPResponse 是下载的。

此信号不支持从其处理程序返回延迟。

| 参数: |

  • response (Response object) — 已下载响应
  • request (Request object) — 生成响应的请求
  • spider (Spider object) — 响应所针对的 Spider | | | —- |