libICEpost.src.base.Functions.userInterface

Functions for adding user interface functionalities to the ICEpost package.

Content of the module:

  • loadDictionary (function): Load a dictionary from a file and a set of templates.

@author: F. Ramognino <federico.ramognino@polimi.it>

Functions

loadDictionary(→ libICEpost.Dictionary)

Load a dictionary from a file. If templates are provided,

Module Contents

libICEpost.src.base.Functions.userInterface.loadDictionary(path: str, *templates: str, verbose=True) → libICEpost.Dictionary[source]

Load a dictionary from a file. If templates are provided, the templates are loaded in reversed order and iteratively updated (the last one is the first loaded, which is iteratively updated). Finally, the dictionary is updated with the main one (‘path’).

Parameters:

  • path (str) – Path to the dictionary file.

  • *templates (str) – Optional template names to load.

  • verbose (bool, optional) – If True, print loading information (default is True).

Returns:

Loaded dictionary object.

Return type:

Dictionary