.. _f-magicclassexample:

module ``ipythonhelper.magic_class_example``
============================================





.. inheritance-diagram:: pyquickhelper.ipythonhelper.magic_class_example


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

module ``pyquickhelper.ipythonhelper.magic_class_example``

Example of a class which defines magic commands.


:githublink:`%|py|6`




Classes
+++++++

+------------------------------------------------------------------------------------------------+-------------------------+
| class                                                                                          | truncated documentation |
+================================================================================================+=========================+
| :class:`MagicClassExample <pyquickhelper.ipythonhelper.magic_class_example.MagicClassExample>` |                         |
+------------------------------------------------------------------------------------------------+-------------------------+




Functions
+++++++++

+-----------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| function                                                                                            | truncated documentation                                    |
+=====================================================================================================+============================================================+
| :func:`register_file_magics <pyquickhelper.ipythonhelper.magic_class_example.register_file_magics>` | Registers magics functions, can be called from a notebook. |
+-----------------------------------------------------------------------------------------------------+------------------------------------------------------------+




Properties
++++++++++

+-------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| property                                                                                                                | truncated documentation                                                                                       |
+=========================================================================================================================+===============================================================================================================+
| :meth:`Context <pyquickhelper.ipythonhelper.magic_class_example.MagicClassExample.Context>`                             | return the context or None                                                                                    |
+-------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`cross_validation_lock <pyquickhelper.ipythonhelper.magic_class_example.MagicClassExample.cross_validation_lock>` | A contextmanager for running a block with our cross validation lock set to True. At the end of the block, ... |
+-------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+




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

+-------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
| staticmethod                                                                                                | truncated documentation                                   |
+=============================================================================================================+===========================================================+
| :meth:`htmlhelp_parser <pyquickhelper.ipythonhelper.magic_class_example.MagicClassExample.htmlhelp_parser>` | Defines the way to parse the magic command ``%htmlhelp``. |
+-------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+




Methods
+++++++

+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
| method                                                                                        | truncated documentation                                                    |
+===============================================================================================+============================================================================+
| :meth:`htmlhelp <pyquickhelper.ipythonhelper.magic_class_example.MagicClassExample.htmlhelp>` | Defines ``%htmlhelp``, it displays the help for an object in :epkg:`HTML`. |
+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+


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

.. automodule:: pyquickhelper.ipythonhelper.magic_class_example
    :members:
    :special-members: __init__
    :show-inheritance: