requests cache

まとめ

Requests-Cacheは、 Python Requests Libraryでパフォーマンスを向上させる簡単な方法を提供する永続的なHTTPキャッシュです。

完全なプロジェクトのドキュメントは、requests-cache.readthedocs.ioで見つけることができます。

特徴

• ？使いやすさ：すでによく知っているrequestsライブラリを使用し続けてください。 requests.Sessionためにドロップイン交換でキャッシュを追加するか、グローバルにインストールして、すべてのrequests関数に透明なキャッシュを追加します。
• パフォーマンス：キャッシュされた応答のサブミリ秒応答時間を取得します。彼らが期限切れになったとき、あなたはまだ条件付き要求で時間を節約します。
• ？永続性： SQLite、Redis、MongoDB、DynamodBなど、いくつかのストレージバックエンドで動作します。または、プレーンJSONファイル、YAMLなどとして応答を保存します
• ？有効期限：キャッシュコントロールおよびその他の標準のHTTPヘッダーを使用し、独自の有効期限スケジュールを定義する、TTLまたは戦略の任意の組み合わせをネイティブにサポートするバックエンドでキャッシュをクラッターフリーに保つ
• カスタマイズ：ゼロ構成で箱から出して動作しますが、ニーズに合わせてライブラリを構成して拡張するための堅牢な機能セットを備えています
• ？互換性：リクエストに基づいて他の人気のあるライブラリと組み合わせることができます

クイックスタート

まず、PIPでインストールします。

pip install requests-cache

次に、requests_cache.cachedsessionを使用してリクエストを行います。それは通常の要求のように動作します。

説明するために、遅延またはレートに制限されたWebサイトをシミュレートする1​​秒の遅延を追加するエンドポイントを呼び出します。

これには1分かかります：

 import requests

session = requests . Session ()
for i in range ( 60 ):
    session . get ( 'https://httpbin.org/delay/1' )

これには1秒かかります：

 import requests_cache

session = requests_cache . CachedSession ( 'demo_cache' )
for i in range ( 60 ):
    session . get ( 'https://httpbin.org/delay/1' )

キャッシュを使用すると、応答は一度フェッチされ、 demo_cache.sqliteに保存され、その後のリクエストはキャッシュされた応答をほぼ最初に返します。

パッチング

セッションオブジェクトを管理したくない場合、またはコードを変更せずにアプリケーションで迅速にテストしたい場合は、リクエストキャッシュをグローバルにインストールすることもでき、すべてのリクエストは透過的にキャッシュされます。

 import requests
import requests_cache

requests_cache . install_cache ( 'demo_cache' )
requests . get ( 'https://httpbin.org/delay/1' )

ヘッダーと有効期限

デフォルトでは、要求キャッシュはキャッシュされた応答を無期限に保持します。ほとんどの場合、キャッシュの新鮮さとパフォーマンスのバランスをとるために、次の2つの戦略のいずれかを使用することをお勧めします。

応答を維持する期間を正確に定義します。

expire_afterパラメーターを使用して、すべての新しい応答の固定有効期限を設定します。

 from requests_cache import CachedSession
from datetime import timedelta

# Keep responses for 360 seconds
session = CachedSession ( 'demo_cache' , expire_after = 360 )

# Or use timedelta objects to specify other units of time
session = CachedSession ( 'demo_cache' , expire_after = timedelta ( hours = 1 ))

その他の機能と設定については、有効期限を参照してください。

キャッシュコントロールヘッダーを使用します。

cache_controlパラメーターを使用してCache-Controlおよびサーバーが送信したその他の標準HTTPヘッダーに基づいて自動有効期限を有効にします。

 from requests_cache import CachedSession

session = CachedSession ( 'demo_cache' , cache_control = True )

詳細については、キャッシュヘッダーを参照してください。

設定

デフォルトの設定はほとんどのユースケースではうまく機能しますが、必要に応じてキャッシュ動作をカスタマイズする方法はたくさんあります。利用可能なオプションのいくつかの簡単な例を次に示します。

 from datetime import timedelta
from requests_cache import CachedSession

session = CachedSession (
    'demo_cache' ,
    use_cache_dir = True ,                # Save files in the default user cache dir
    cache_control = True ,                # Use Cache-Control response headers for expiration, if available
    expire_after = timedelta ( days = 1 ),    # Otherwise expire responses after one day
    allowable_codes = [ 200 , 400 ],        # Cache 400 responses as a solemn reminder of your failures
    allowable_methods = [ 'GET' , 'POST' ], # Cache whatever HTTP methods you want
    ignored_parameters = [ 'api_key' ],    # Don't match this request param, and redact if from the cache
    match_headers = [ 'Accept-Language' ], # Cache a different response per language
    stale_if_error = True ,               # In case of request errors, use stale cache data if possible
)

次のステップ

リクエストキャッシュでできることの詳細については、次を参照してください。

• ユーザーガイド
• 例
• APIリファレンス
• プロジェクト情報