.. _f-functionhelper:

module ``funcwin.function_helper``
==================================







Short summary
+++++++++++++

module ``tkinterquickhelper.funcwin.function_helper``

Various function needed when using the windows used to ask for parameters


:githublink:`%|py|6`






Functions
+++++++++

+----------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| function                                                                                                       | truncated documentation                                                                                               |
+================================================================================================================+=======================================================================================================================+
| :func:`extract_function_information <tkinterquickhelper.funcwin.function_helper.extract_function_information>` | Extracts information about a function. The function assumes all parameters receive a default value.                   |
+----------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`get_function_list <tkinterquickhelper.funcwin.function_helper.get_function_list>`                       | Extracts all functions in a module.                                                                                   |
+----------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`has_unknown_parameters <tkinterquickhelper.funcwin.function_helper.has_unknown_parameters>`             | Returns True if the function contains a parameter like ``**params``.                                                  |
+----------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`private_adjust_parameters <tkinterquickhelper.funcwin.function_helper.private_adjust_parameters>`       | Change the value of some parameters when they are NULL: *user*. Changes the parameters inplace.                       |
+----------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`private_get_function <tkinterquickhelper.funcwin.function_helper.private_get_function>`                 | Returns the function object from its name, the name must contains a dot "." otherwise the function will assume it ... |
+----------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+








Documentation
+++++++++++++

.. automodule:: tkinterquickhelper.funcwin.function_helper
    :members:
    :special-members: __init__
    :show-inheritance: