コンテンツにスキップ

APIリファレンス

mtaioは非同期アプリケーションを構築するための包括的なAPIセットを提供します。このリファレンスでは、すべてのモジュールとそのコンポーネントについて詳しく説明します。

コアコンポーネント

  • コア: タスク実行とキューを含む非同期操作の基本コンポーネント
  • キャッシュ: インメモリおよび分散キャッシュの仕組み
  • イベント: イベント発行と処理システム
  • データ: データ処理と変換ツール
  • リソース: システムリソース管理ユーティリティ

プロトコルサポート

  • プロトコル: ネットワークプロトコル実装(ASGI、MQTT、メール)

開発ツール

  • モニタリング: システム監視とパフォーマンスプロファイリング
  • ロギング: 非同期ロギング機能
  • 最適化: パフォーマンス最適化ユーティリティ
  • 例外: エラー処理と例外階層

型システム

  • 型定義: 型定義とプロトコル
  • デコレータ: 非同期関数を拡張するユーティリティデコレータ

モジュール構成

APIは非同期プログラミングの特定の側面に焦点を当てた論理的なモジュールに構成されています:

mtaio/
├── core/        # コアの非同期機能
├── cache/       # キャッシュ実装
├── events/      # イベント処理システム
├── data/        # データ処理ツール
├── protocols/   # プロトコル実装
├── resources/   # リソース管理
├── monitoring/  # システム監視
├── logging/     # ロギングユーティリティ
├── typing/      # 型定義
└── decorators/  # ユーティリティデコレータ

APIの使用

各モジュールのドキュメントには以下が含まれています:

  • 詳細なクラスと関数のリファレンス
  • 使用例
  • ベストプラクティス
  • 一般的なパターン
  • エラー処理
  • パフォーマンスの考慮事項

詳細なドキュメントを表示するには、ナビゲーションメニューからモジュールを選択してください。

APIの安定性

mtaioはセマンティックバージョニング(SemVer)に従っています:

  • メジャーバージョンの変更(x.0.0)には破壊的なAPI変更が含まれる可能性があります
  • マイナーバージョンの変更(0.x.0)は後方互換性を保ちながら機能を追加します
  • パッチバージョンの変更(0.0.x)には後方互換性のあるバグ修正が含まれます

破壊的な変更はすべてリリースノートに明確に記載されます。