Queue の例 - 同時実行 Web スパイダー

Tornado の tornado.queues モジュール（および Queue クラスが asyncio で非常に類似している）は、コルーチン用の非同期プロデューサ/コンシューマパターンを実装しており、Python 標準ライブラリの queue モジュールによってスレッド用に実装されているパターンに似ています。

Queue.get を返すコルーチンは、キュー内に項目ができるまで一時停止されます。キューに最大サイズが設定されている場合、Queue.put を返すコルーチンは、もう 1 つの項目のための空きができるまで一時停止されます。

Queue は未完了タスクの数を管理しており、最初はゼロから始まります。 put はこの数を増加させ、task_done はこの数を減少させます。

ここでの Web スパイダーの例では、キューは当初 base_url のみを含んでいます。ワーカーがページを取得すると、リンクをパースし、新しいリンクをキューに入れ、次に task_done を呼び出して、カウンターを 1 回デクリメントします。最終的には、ワーカーがすべての URL が前に見られたページを取得し、キューにも残りの作業がありません。したがって、task_done を呼び出すワーカーによってカウンターがゼロにデクリメントされます。join を待機しているメインのコルーチンはポーズ解除され、終了します。

#!/usr/bin/env python3

import asyncio
import time
from datetime import timedelta

from html.parser import HTMLParser
from urllib.parse import urljoin, urldefrag

from tornado import gen, httpclient, queues

base_url = "https://tornado.dokyumento.jp/en/stable/"
concurrency = 10


async def get_links_from_url(url):
    """Download the page at `url` and parse it for links.

    Returned links have had the fragment after `#` removed, and have been made
    absolute so, e.g. the URL 'gen.html#tornado.gen.coroutine' becomes
    'https://tornado.dokyumento.jp/en/stable/gen.html'.
    """
    response = await httpclient.AsyncHTTPClient().fetch(url)
    print("fetched %s" % url)

    html = response.body.decode(errors="ignore")
    return [urljoin(url, remove_fragment(new_url)) for new_url in get_links(html)]


def remove_fragment(url):
    pure_url, frag = urldefrag(url)
    return pure_url


def get_links(html):
    class URLSeeker(HTMLParser):
        def __init__(self):
            HTMLParser.__init__(self)
            self.urls = []

        def handle_starttag(self, tag, attrs):
            href = dict(attrs).get("href")
            if href and tag == "a":
                self.urls.append(href)

    url_seeker = URLSeeker()
    url_seeker.feed(html)
    return url_seeker.urls


async def main():
    q = queues.Queue()
    start = time.time()
    fetching, fetched, dead = set(), set(), set()

    async def fetch_url(current_url):
        if current_url in fetching:
            return

        print("fetching %s" % current_url)
        fetching.add(current_url)
        urls = await get_links_from_url(current_url)
        fetched.add(current_url)

        for new_url in urls:
            # Only follow links beneath the base URL
            if new_url.startswith(base_url):
                await q.put(new_url)

    async def worker():
        async for url in q:
            if url is None:
                return
            try:
                await fetch_url(url)
            except Exception as e:
                print("Exception: %s %s" % (e, url))
                dead.add(url)
            finally:
                q.task_done()

    await q.put(base_url)

    # Start workers, then wait for the work queue to be empty.
    workers = gen.multi([worker() for _ in range(concurrency)])
    await q.join(timeout=timedelta(seconds=300))
    assert fetching == (fetched | dead)
    print("Done in %d seconds, fetched %s URLs." % (time.time() - start, len(fetched)))
    print("Unable to fetch %s URLs." % len(dead))

    # Signal all the workers to exit.
    for _ in range(concurrency):
        await q.put(None)
    await workers


if __name__ == "__main__":
    asyncio.run(main())