API Reference

Purpose

This section provides technical specifications for all features of RDEToolKit. It is a comprehensive reference including detailed functionality, parameters, return values, and usage examples for each module.

API Documentation Structure

RDEToolKit's API documentation is structured using a hybrid approach:

• Auto-generated parts: Detailed technical specifications generated from docstrings in source code
• Manually created parts: Practical usage examples and inter-module collaboration methods

Core Modules

Workflow Management

• workflows - Structured processing execution and workflow management
• modeproc - Mode processing

Configuration and File Operations

• config - Configuration file loading and management
• fileops - RDE-related file operations

Data Processing

• invoicefile - Invoice file processing
• validation - Data validation
• rde2util - RDE-related utility functions

Representative Image Operations

• img2thumb - Image to thumbnail conversion

Error Handling and Logging

• rdelogger - Logging functionality
• errors - Error handling
• exceptions - Exception handling

Data Models

Configuration Models

• models.config - Configuration data structure definitions

RDE-related Models

• models.rde2types - RDE-related type definitions
• models.invoice - Invoice data structure
• models.metadata - Metadata management

Processing Result Models

• Processing result management functionality is integrated into each module

Implementation Modules

Controllers

• impl.input_controller - Input mode management
• impl.compressed_controller - Compressed file management

Interfaces

• interface.filechecker - File validation interface

Command Line

• CLI Commands - Command line interface usage

Usage Patterns

Basic Usage

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):
    # Implement custom processing here
    pass

# Execute structured processing
result = rdetoolkit.workflows.run(custom_dataset_function=my_dataset_function)

Configuration File Usage

1
2
3
4
5
6
7
8

from rdetoolkit.config import parse_config_file

# Load configuration file
config = parse_config_file()

# Reference configuration values
extended_mode = config.system.extended_mode
save_raw = config.system.save_raw

Error Handling

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 error: {e}")
    print(f"Error code: {e.error_code}")

API Version Information

Developer Information

Type Hints

RDEToolKit supports complete type hints:

 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:
    # Type-safe implementation
    return True

Next Steps

• Specific module details: Refer to the module links above
• Practical usage examples: User Guide
• Contributing to development: Developer Guide