コンテンツにスキップ

API リファレンス

目的

このセクションでは、RDEToolKitの全機能に関する技術仕様を提供します。各モジュールの詳細な機能、パラメータ、返り値、使用例を含む包括的なリファレンスです。

API ドキュメントの構成

RDEToolKitのAPIドキュメントは、ハイブリッド方式で構成されています：

  • 自動生成部分: ソースコード内のdocstringから生成される詳細な技術仕様
  • 手動作成部分: 実践的な使用例とモジュール間の連携方法

主要モジュール

ワークフロー管理

  • workflows - 構造化処理の実行とワークフロー管理
  • modeproc - モード処理

設定とファイル操作

  • config - 設定ファイルの読み込みと管理
  • fileops - RDE関連のファイル操作

データ処理

代表画像操作

  • img2thumb - 画像をサムネイルに変換

エラー処理とログ

データモデル

設定モデル

RDE関連モデル

処理結果モデル

  • 処理結果の管理機能は各モジュールに統合されています

実装モジュール

コントローラー

インターフェース

コマンドライン

使用パターン

基本的な使用方法

basic_usage.py
1
2
3
4
5
6
7
8
9
import rdetoolkit
from rdetoolkit.models.rde2types import RdeInputDirPaths, RdeOutputResourcePath

def my_dataset_function(srcpaths: RdeInputDirPaths, resource_paths: RdeOutputResourcePath):
    # カスタム処理をここに実装
    pass

# 構造化処理の実行
result = rdetoolkit.workflows.run(custom_dataset_function=my_dataset_function)

設定ファイルの使用

config_usage.py
1
2
3
4
5
6
7
8
from rdetoolkit.config import parse_config_file

# 設定ファイルの読み込み
config = parse_config_file()

# 設定値の参照
extended_mode = config.system.extended_mode
save_raw = config.system.save_raw

エラーハンドリング

error_handling.py
1
2
3
4
5
6
7
8
from rdetoolkit.exceptions import RdeToolkitError
from rdetoolkit import workflows

try:
    result = workflows.run(custom_dataset_function=my_function)
except RdeToolkitError as e:
    print(f"RDEToolKit エラー: {e}")
    print(f"エラーコード: {e.error_code}")

API バージョン情報

バージョン 互換性 主な変更点
1.0.x 安定版 初期リリース
1.1.x 後方互換 新機能追加
1.2.x 後方互換 パフォーマンス改善

API の安定性

メジャーバージョン内では後方互換性を維持します。破壊的変更はメジャーバージョンアップ時にのみ行われます。

開発者向け情報

型ヒント

RDEToolKitは完全な型ヒントをサポートしています：

type_hints.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from typing import Optional
from rdetoolkit.models.rde2types import RdeInputDirPaths, RdeOutputResourcePath

def process_data(
    srcpaths: RdeInputDirPaths,
    resource_paths: RdeOutputResourcePath,
    options: Optional[dict] = None
) -> bool:
    # 型安全な実装
    return True

次のステップ