メインコンテンツへスキップ

GitHub リポジトリ

ソースコードを閲覧し、開発に貢献する

​
機能

  • Python 2.6 以降および Python 3 と互換性あり
  • 外部ライブラリへの依存なし
  • 大容量メッセージをサポート
  • 指数バックオフ付きの再試行ロジックを設定可能

​
インストール

setup.py を使ってライブラリをインストールします: 
git clone https://github.com/Benzinga/python-bztcp.git
cd python-bztcp
python setup.py install

​
クイックスタート

組み込みのデモを使用してクライアントをテストします: 
python -m bztcp USERNAME API_KEY

​
基本的な使い方

bztcp.client.Client クラスが接続とストリーミングを処理します。 
from __future__ import print_function
from bztcp.client import Client

client = Client(username='USERNAME', key='API_KEY')

for content in client.content_items():
    title = content.get('title', None)
    print(title)

​
構成オプション

​
リトライ設定

指数バックオフ方式のリトライ動作を設定します： 
from bztcp.client import Client

client = Client(
    username='USERNAME',
    key='API_KEY',
    retries=5,      # 最大リトライ回数
    delay=90,       # 初期遅延(秒)
    backoff=2       # バックオフ倍率
)

for content in client.content_items():
    title = content.get('title', None)
    print(title)
パラメータ説明デフォルト
usernameBenzinga TCP のユーザー名必須
keyAPI アクセスキー必須
retriesリトライ試行回数の上限-
delayリトライ間の初期間隔（秒）-
backoff指数バックオフに使用する倍率-

​
高度な使い方

​
低レベルなメッセージ処理

接続ステータスや個々のメッセージを詳細に制御するには： 
from bztcp.client import Client, STATUS_STREAM
from bztcp.exceptions import BzException

client = Client(username='USERNAME', key='API_KEY')

while True:
    try:
        msg = client.next_msg()
        
        if msg.status == STATUS_STREAM:
            print(f"Content item: {msg.data}")
        else:
            print(f"Status: {msg.status}")
            
    except KeyboardInterrupt:
        print("Cancelled, disconnecting.")
        client.disconnect()
        break
        
    except BzException as bze:
        print(f"BZ Error: {bze}")
        break

​
メッセージステータス定数

Status説明
STATUS_STREAM通常のストリーミングメッセージ

​
主要メソッド

MethodDescription
content_items()content の辞書を逐次返すジェネレーター
next_msg()次の生のメッセージオブジェクトを返す
disconnect()サーバーとの接続を正常に終了する

​
エラー処理

Benzinga 固有のエラーが発生した場合、このライブラリは BzException をスローします。 
from bztcp.exceptions import BzException

try:
    for content in client.content_items():
        process(content)
except BzException as e:
    print(f"Benzinga error: {e}")
except Exception as e:
    print(f"Unexpected error: {e}")

​
完全なサンプル

#!/usr/bin/env python
from __future__ import print_function
import json
from bztcp.client import Client

def main():
    client = Client(
        username='YOUR_USERNAME',
        key='YOUR_API_KEY',
        retries=5,
        delay=30,
        backoff=2
    )
    
    print("Starting Benzinga TCP stream...")
    
    for content in client.content_items():
        # 主要なフィールドを抽出
        content_id = content.get('id')
        title = content.get('title', 'No title')
        channels = content.get('channels', [])
        tickers = [t['name'] for t in content.get('tickers', [])]
        
        # 概要を出力
        print(f"[{content_id}] {title}")
        if channels:
            print(f"  Channels: {', '.join(channels)}")
        if tickers:
            print(f"  Tickers: {', '.join(tickers)}")
        print()

if __name__ == '__main__':
    main()

​
関連項目