linchemin.interfaces.facade.facade_helper

linchemin.interfaces.facade.facade_helper(functionality: str | None = None, verbose: bool = False) → dict

Returns the available facade functions if no input is provided; if the name of a functionality is specified, the available parameters options for it are returned.

Parameters:

functionality: Optional[Union[str, None]]

If provided, it indicates the functionality for which the helper is invoked. If it is None, the helper for the facade is returned. (default None)

verbose: Optional[bool]

Whether to print the available options and the default parameters are printed on the screen (default False)

Returns:

dict:

A dictionary with the available options and default parameters.

Example: >>> # to get info for the entire facade and print information on the screen >>> facade_helper(verbose=True) >>> # to get info for a specific functionality and return it as a dictionary >>> info = facade_helper(functionality=’translate’)