futures.wait() 或 futures.as_completed() 在所有期货都已完成或取消时被阻止

Question

我有一个关于 futures.as_completed() 或 futures.wait() 的错误，当所有 Futures 完成或取消时，它将被无限期地阻止。

这里重现的步骤：

在使用ThreadPoolExecutor.submit()提交期货后，我正在等待使用futures.as_completed()或futures.wait()的期货。 在另一个线程中，我使用cancel_futures=True调用ThreadPoolExecutor.shutdown() ，然后在同一个过程中，我正在等待 Futures 超时完成。 等待将在延迟过去后返回，有 2 个列表：已完成的期货和取消的期货。 没有更多的未决期货。 但是，主线程中的第一个as_completed() （或wait() ）仍然是阻塞的。

在Python 文档中，说明return_when=ALL_COMPLETED ：

当所有期货完成或被取消时，function 将返回。

对于as_completed()

在完成时返回 [...] 期货（已完成或取消的期货）。

这符合我的情况。 这是一个错误还是我错过了什么？ 我试图在同一个线程中调用shutdown() ，它没有改变任何东西。

---

代码示例：

import signal
import time
from concurrent import futures
from concurrent.futures import Future, ALL_COMPLETED
from concurrent.futures import ThreadPoolExecutor
from typing import Dict, Set


class SubThreads:
    def __init__(self):
        self.running_futures_url: Dict[str, Future] = {}
        self.webpage_crawler_th_pool = ThreadPoolExecutor(2)

    def shutdown(self):
        print("Waiting for lasts URL threads")
        self.webpage_crawler_th_pool.shutdown(wait=False, cancel_futures=True)
        finished_futures, still_running_futures = futures.wait(
            self.running_futures_url.values(), return_when=ALL_COMPLETED, timeout=5,
        )
        print("Shutdown done, remaining threads", len(still_running_futures))

    def crawl_url(self, url):
        print("Crawling webpage", url)
        time.sleep(3)
        print("Webpage crawled", url)
        return "URL Crawled"

    def run(self):
        urls = ['1', '2', '3', '4', '5']
        for url in urls:
            running_th = self.webpage_crawler_th_pool.submit(self.crawl_url, url)
            self.running_futures_url[url] = running_th

        print("Waiting for URLs to be crawled")
        # for _future in futures.as_completed(self.running_futures_url.values()):
        #     print("Future result:", _future.result())  # Will only return and print first 2 started (and completed) Futures
        finished_futures, still_running_futures = futures.wait(
            self.running_futures_url.values(), return_when=ALL_COMPLETED
        )
        print("SubThread finished (never called)", finished_futures, still_running_futures)


sub_thread = SubThreads()


def signal_handler(sig, frame):
    print("Signal caught, exiting ...", sig)
    sub_thread.shutdown()


signal.signal(signal.SIGINT, signal_handler)
signal.signal(signal.SIGTERM, signal_handler)
sub_thread.run()

Answer 1

我不会将shutdown与wait=False一起使用。

请参阅文档：

关机（等待=真）

停止接受新任务。 如果 wait 为 True，它会等待所有正在运行的任务完成。

因此，由于您通过wait=False ，您的as_completed将永远等待，因为ThreadPoolExecutor将永远不会停止运行，直到您使用wait=True调用shutdown 。