color_tools.synonym_load_report

Structured results from loading and merging maker synonyms.

class color_tools.synonym_load_report.SynonymLoadEvent(action, maker, user_synonyms, previous_synonyms=(), effective_synonyms=())

Bases: object

Describe how one user maker-synonym entry affected loaded data.

Parameters:

• action (Literal['added', 'unchanged', 'extended'])

• maker (str)

• user_synonyms (tuple[str, ...])

• previous_synonyms (tuple[str, ...])

• effective_synonyms (tuple[str, ...])

action: Literal['added', 'unchanged', 'extended']

maker: str

user_synonyms: tuple[str, ...]

previous_synonyms: tuple[str, ...]

effective_synonyms: tuple[str, ...]

class color_tools.synonym_load_report.SynonymLoadReport(system_makers_loaded, user_makers_loaded, total_makers_available, events=())

Bases: object

Summarize a completed system and user maker-synonym load.

Parameters:

• system_makers_loaded (int)

• user_makers_loaded (int)

• total_makers_available (int)

• events (tuple[SynonymLoadEvent, ...])

system_makers_loaded: int

user_makers_loaded: int

total_makers_available: int

events: tuple[SynonymLoadEvent, ...]

property makers_added: int

Return the number of new maker entries added by the user file.

property makers_unchanged: int

Return the number of user entries equal to the system entry.

property makers_extended: int

Return the number of existing maker entries extended by users.