.. _f-magicclass:

module ``ipythonhelper.magic_class``
====================================





.. inheritance-diagram:: pyquickhelper.ipythonhelper.magic_class


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

module ``pyquickhelper.ipythonhelper.magic_class``

Magic command to handle files


:githublink:`%|py|6`




Classes
+++++++

+------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| class                                                                                          | truncated documentation                                                                                                   |
+================================================================================================+===========================================================================================================================+
| :class:`MagicClassWithHelpers <pyquickhelper.ipythonhelper.magic_class.MagicClassWithHelpers>` | Provides some functions reused in others classes inherited from *Magics*. The class should not be registered as it is ... |
+------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+






Properties
++++++++++

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






Methods
+++++++

+-------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| method                                                                                          | truncated documentation                                                                                               |
+=================================================================================================+=======================================================================================================================+
| :meth:`add_context <pyquickhelper.ipythonhelper.magic_class.MagicClassWithHelpers.add_context>` | add context to the class, mostly for debug purpose                                                                    |
+-------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`get_args <pyquickhelper.ipythonhelper.magic_class.MagicClassWithHelpers.get_args>`       | parser a command line with a given parser                                                                             |
+-------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`get_parser <pyquickhelper.ipythonhelper.magic_class.MagicClassWithHelpers.get_parser>`   | Returns a parser for a magic command, initializes it if it does not exists, it creates it. The parsers are stored ... |
+-------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+


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

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