libICEpost.src.base.Functions.userInterface
===========================================

.. py:module:: libICEpost.src.base.Functions.userInterface

.. autoapi-nested-parse::

   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
---------

.. autoapisummary::

   libICEpost.src.base.Functions.userInterface.loadDictionary


Module Contents
---------------

.. py:function:: loadDictionary(path: str, *templates: str, verbose=True) -> libICEpost.Dictionary

   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').

   :param path: Path to the dictionary file.
   :type path: str
   :param \*templates: Optional template names to load.
   :type \*templates: str
   :param verbose: If True, print loading information (default is True).
   :type verbose: bool, optional

   :returns: Loaded dictionary object.
   :rtype: Dictionary