color_tools.filament_load_report

Structured results from loading and merging filament data.

class color_tools.filament_load_report.FilamentLoadEvent(action, record, replaced_record=None)[source]

Bases: object

Describe one user-filament addition or ID-based replacement.

Parameters:
action: Literal['added', 'overridden']
record: FilamentRecord
replaced_record: FilamentRecord | None
class color_tools.filament_load_report.FilamentLoadReport(system_filaments_loaded, user_filaments_loaded, total_filaments_available, events=())[source]

Bases: object

Summarize a completed system and user filament load.

Parameters:
system_filaments_loaded: int
user_filaments_loaded: int
total_filaments_available: int
events: tuple[FilamentLoadEvent, ...]
property filaments_overridden_by_id: int

Return the number of user records that replaced a system record.

property unique_user_filaments_loaded: int

Return the number of user records appended under new IDs.