palletdatagenerator.utils module

Utility functions for PalletDataGenerator.

palletdatagenerator.utils.setup_logging(level: str = 'DEBUG', log_file: str = 'output.log') → None

Setup logging configuration.

Parameters:

• level – Logging level (‘DEBUG’, ‘INFO’, ‘WARNING’, ‘ERROR’)

• log_file – Optional log file path

palletdatagenerator.utils.ensure_directory(path: str) → Path

Ensure directory exists, create if necessary.

Parameters:

path – Directory path to create

Returns:

Path object for the directory

palletdatagenerator.utils.load_config(config_path: str) → dict[str, Any]

Load configuration from JSON or YAML file.

Parameters:

config_path – Path to configuration file

Returns:

Configuration dictionary

Raises:

• FileNotFoundError – If config file doesn’t exist

• ValueError – If config file format is invalid

palletdatagenerator.utils.save_config(config: dict[str, Any], config_path: str) → None

Save configuration to JSON file.

Parameters:

• config – Configuration dictionary to save

• config_path – Path to save configuration file

palletdatagenerator.utils.set_random_seed(seed: int) → None

Set random seed for reproducible results.

Parameters:

seed – Random seed value

palletdatagenerator.utils.validate_blender_environment() → bool

Validate that Blender environment is available and properly configured.

Returns:

True if Blender environment is valid, False otherwise

palletdatagenerator.utils.get_blender_version() → tuple[int, int, int] | None

Get Blender version information.

Returns:

Tuple of (major, minor, patch) version numbers or None if not available

palletdatagenerator.utils.format_file_size(size_bytes: int) → str

Format file size in human-readable format.

Parameters:

size_bytes – Size in bytes

Returns:

Formatted size string (e.g., “1.5 MB”)

palletdatagenerator.utils.get_system_info() → dict[str, Any]

Get system information for debugging and logging.

Returns:

Dictionary with system information

palletdatagenerator.utils.create_dataset_manifest(dataset_info: dict[str, Any], output_path: str) → None

Create a comprehensive dataset manifest file.

Parameters:

• dataset_info – Dictionary containing dataset information

• output_path – Path to save the manifest file

palletdatagenerator.utils.verify_dataset_integrity(dataset_dir: str) → dict[str, Any]

Verify dataset integrity by checking file consistency.

Parameters:

dataset_dir – Path to dataset directory

Returns:

Dictionary with verification results

class palletdatagenerator.utils.ProgressTracker(total: int, description: str = 'Processing')

Bases: object

Progress tracking utility for long-running operations.

__init__(total: int, description: str = 'Processing')

Initialize progress tracker.

Parameters:

• total – Total number of items to process

• description – Description of the operation

start() → None

Start progress tracking.

update(increment: int = 1) → None

Update progress.

Parameters:

increment – Number of items processed since last update

finish() → None

Finish progress tracking.