Skip to main content

🤖 LINE Bot Error Analyzer

PyPI version Python GitHub Repo stars GitHub issues License: MIT Downloads

LINE Bot 開発で発生するエラーを自動分析・診断する Python ライブラリです。

LINE Bot API のエラーレスポンス、例外、ログメッセージを解析し、エラーの種類を特定して具体的な解決策を提案します。開発者の生産性向上と LINE Bot の安定運用をサポートします。

🚀 このライブラリは共同開発者・コントリビューターを募集中です!ご興味のある方は Discord までご連絡ください。

📋 要件

  • Python: 3.9 以上(3.9, 3.10, 3.11, 3.12 でテスト済み)
  • LINE Bot SDK: v2/v3 系に対応(オプション)
  • 依存関係: 標準ライブラリのみ(typing_extensionsのみ追加)

✨ 特徴

  • 🔍 自動エラー解析: LINE Bot API のエラーレスポンス、例外、ログを自動で分類・診断
  • 💡 具体的な対処法: 各エラーに対する実用的な解決策とベストプラクティスを提案
  • ⚡ 同期・非同期対応: 同期処理と非同期処理の両方をサポート
  • 🔄 SDK バージョン対応: LINE Bot SDK v2/v3 系の両方に対応
  • 🌐 フレームワーク統合: Flask、FastAPI、aiohttp などと簡単に統合
  • 📊 リトライ判定: エラーのリトライ可否を自動判定
  • 🏷️ エラー分類: エラーを意味のあるカテゴリに自動分類

インストール

基本インストール

pip install linebot-error-analyzer

開発環境用(テスト依存関係含む)

pip install linebot-error-analyzer[dev]

LINE Bot SDK と一緒にインストール

# LINE Bot SDK v3 と一緒に
pip install linebot-error-analyzer linebot-sdk

# または全依存関係込み
pip install linebot-error-analyzer[all]

対応環境

  • Python 3.9+
  • Windows, macOS, Linux
  • LINE Bot SDK v2/v3(オプション)

🚀 基本的な使用方法

from linebot_error_analyzer import LineErrorAnalyzer

# アナライザーを初期化
analyzer = LineErrorAnalyzer()

# エラーメッセージ(ログメッセージから)を分析
error_message = "(401) Invalid channel access token"
result = analyzer.analyze(error_message)

print(f"エラーカテゴリ: {result.category.value}")  # AUTH_ERROR
print(f"対処法: {result.recommended_action}")
print(f"リトライ可能: {result.is_retryable}")  # False

# 辞書形式のエラーデータも分析可能
error_data = {
    "status_code": 429,
    "message": "Rate limit exceeded"
}
result2 = analyzer.analyze(error_data)
print(f"カテゴリ: {result2.category.value}")  # RATE_LIMIT

📝 サポートされる入力パターン

このライブラリは以下の形式のエラーを分析できます:

  1. エラーログメッセージ(文字列)

    analyzer.analyze("(401) Invalid channel access token")
    analyzer.analyze("429 Rate limit exceeded")
    
  2. 辞書形式のエラーデータ

    analyzer.analyze({
        "status_code": 400,
        "message": "Bad Request"
    })
    
  3. LINE Bot SDK 例外(v2/v3)

    # SDK例外を直接渡すことが可能
    try:
        line_bot_api.reply_message(...)
    except LineBotApiError as e:
        analyzer.analyze(e)  # 例外オブジェクトを直接分析
    
  4. HTTP レスポンスオブジェクト

    # requests.Response オブジェクトなど
    response = requests.post(...)
    if not response.ok:
        analyzer.analyze(response)
    

🔗 LINE Bot SDK との統合

from linebot.v3.messaging import ApiClient, MessagingApi
from linebot.v3.messaging.exceptions import ApiException
from linebot_error_analyzer import LineErrorAnalyzer

analyzer = LineErrorAnalyzer()

try:
    # LINE Bot API を呼び出し
    line_bot_api.reply_message(...)
except ApiException as e:
    # 例外を直接解析
    error_info = analyzer.analyze(e)

    if error_info.category.value == "RATE_LIMIT":
        wait_time = error_info.retry_after or 60
        print(f"レート制限エラー: {wait_time}秒後にリトライしてください")
    elif error_info.is_retryable:
        print("一時的なエラー - リトライを推奨")
    else:
        print(f"対処法: {error_info.recommended_action}")

⚡ 非同期処理

import asyncio
from linebot_error_analyzer import AsyncLineErrorAnalyzer

async def analyze_errors():
    analyzer = AsyncLineErrorAnalyzer()

    # 単一エラーの非同期分析
    result = await analyzer.analyze("(401) Authentication failed")

    # 複数エラーの一括分析(バッチ処理)
    error_messages = [
        "(401) Invalid channel access token",
        "(429) Rate limit exceeded",
        "(400) Bad Request"
    ]
    results = await analyzer.analyze_batch(error_messages, batch_size=10)

    for result in results:
        print(f"エラー: {result.category.value} - {result.recommended_action}")

asyncio.run(analyze_errors())

📚 ドキュメント

詳細ガイド

💻 実装例

本ライブラリには、実際の LINE Bot 開発で使用できる実装例を含んでいます:

  • 📁 Examples Collection - 実用的な LINE Bot 実装例
    • simple_usage.py - 基本的な使用方法のデモ
    • flask_echo_bot.py - Flask を使用したエコー Bot(エラー処理付き)
    • fastapi_echo_bot.py - FastAPI を使用した非同期エコー Bot
    • aiohttp_echo_bot.py - aiohttp を使用したフル非同期実装

これらの例は LINE Bot SDK の公式スタイルに準拠し、コピー&ペーストで実際のプロジェクトに使用できるよう設計されています。

詳細は 📖 Examples Guide をご覧ください。

主要エラーカテゴリ

カテゴリ 説明 例
AUTH_ERROR 認証エラー 無効なトークン
RATE_LIMIT API 呼び出し制限 429 エラー
INVALID_REPLY_TOKEN 無効な返信トークン 期限切れトークン
USER_NOT_FOUND ユーザー未発見 削除されたアカウント
SERVER_ERROR サーバーエラー 5xx 系エラー

詳細なエラーコード対応表は 📖 エラーリファレンス をご覧ください。

🔧 フレームワーク統合

FastAPI との統合例

from fastapi import FastAPI
from fastapi.responses import JSONResponse
from linebot.v3.messaging.exceptions import ApiException
from linebot_error_analyzer import LineErrorAnalyzer

app = FastAPI()
analyzer = LineErrorAnalyzer()

@app.exception_handler(ApiException)
async def line_api_exception_handler(request, exc):
    error_info = analyzer.analyze(exc)
    return JSONResponse(
        status_code=error_info.status_code,
        content={
            "error": error_info.category.value,
            "message": error_info.message,
            "action": error_info.recommended_action,
            "retryable": error_info.is_retryable
        }
    )

テスト実行

# 基本テスト実行
python -m pytest tests/ -v

# テスト用依存関係のインストール
pip install pytest pytest-asyncio

ライセンス

MIT License

免責事項

このライブラリはサードパーティ製です。LINE 株式会社とは関係ありません。

参考リンク

Metadata

Release files for linebot-error-analyzer 3.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for linebot-error-analyzer 3.0.1
File Size Uploaded Provenance Actions
linebot_error_analyzer-3.0.1.tar.gz 28.0 kB Without provenance Details for linebot_error_analyzer-3.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for linebot-error-analyzer 3.0.1
File Interpreter ABI Platform Actions
linebot_error_analyzer-3.0.1-py3-none-any.whl Python 3 none any Details for linebot_error_analyzer-3.0.1-py3-none-any.whl

Total release size: 60.0 kB

Release files / linebot_error_analyzer-3.0.1.tar.gz

Download URL linebot_error_analyzer-3.0.1.tar.gz
Size 28.0 kB
Tags Source
SHA-256 checksum
How to use checksums
ac7fc5157209b4b141b22a8d20d3d971e8b7a568ea71ed22198c611c3ac86483
BLAKE2b-256 checksum
How to use checksums
12b12a7c333f7b04b089cc9515f29edab996987420d5cd3eb88e9b5632c57abc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.9

Release files / linebot_error_analyzer-3.0.1-py3-none-any.whl

Download URL linebot_error_analyzer-3.0.1-py3-none-any.whl
Size 31.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
891b850a679cd05abc1bd8658a9e323d76a91a0f2cecdd16d35601299e5e938b
BLAKE2b-256 checksum
How to use checksums
f75405315e864d93e359a4c999b30eb8130c08d66aa712a26c5e2a4ec0849695
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.9

Security for linebot-error-analyzer 3.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page