.. _f-importobjecthelper:

module ``sphinxext.import_object_helper``
=========================================





.. inheritance-diagram:: pyquickhelper.sphinxext.import_object_helper


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

module ``pyquickhelper.sphinxext.import_object_helper``

Defines a :epkg:`sphinx` extension which if all parameters are documented.


:githublink:`%|py|6`




Classes
+++++++

+-----------------------------------------------------------------------+-------------------------+
| class                                                                 | truncated documentation |
+=======================================================================+=========================+
| :class:`_Types <pyquickhelper.sphinxext.import_object_helper._Types>` |                         |
+-----------------------------------------------------------------------+-------------------------+




Functions
+++++++++

+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                   | truncated documentation                                                                                                                          |
+============================================================================================+==================================================================================================================================================+
| :func:`import_any_object <pyquickhelper.sphinxext.import_object_helper.import_any_object>` | Extracts an object defined by its name including the module name.                                                                                |
+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`import_object <pyquickhelper.sphinxext.import_object_helper.import_object>`         | Extracts an object defined by its name including the module name.                                                                                |
+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`import_path <pyquickhelper.sphinxext.import_object_helper.import_path>`             | Determines the import path which is the shortest way to import the function. In case the following ``from module.submodule import function`` ... |
+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+




Properties
++++++++++

+-------------------------------------------------------------------------+-------------------------+
| property                                                                | truncated documentation |
+=========================================================================+=========================+
| :meth:`prop <pyquickhelper.sphinxext.import_object_helper._Types.prop>` |                         |
+-------------------------------------------------------------------------+-------------------------+




Static Methods
++++++++++++++

+-------------------------------------------------------------------------+-------------------------+
| staticmethod                                                            | truncated documentation |
+=========================================================================+=========================+
| :meth:`stat <pyquickhelper.sphinxext.import_object_helper._Types.stat>` |                         |
+-------------------------------------------------------------------------+-------------------------+




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

.. automodule:: pyquickhelper.sphinxext.import_object_helper
    :members:
    :special-members: __init__
    :show-inheritance: