.. _f-magicclassdiff:

module ``ipythonhelper.magic_class_diff``
=========================================





.. inheritance-diagram:: pyquickhelper.ipythonhelper.magic_class_diff


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

module ``pyquickhelper.ipythonhelper.magic_class_diff``

Magic command to handle files


:githublink:`%|py|6`




Classes
+++++++

+-----------------------------------------------------------------------------+----------------------------------------------------------------+
| class                                                                       | truncated documentation                                        |
+=============================================================================+================================================================+
| :class:`MagicDiff <pyquickhelper.ipythonhelper.magic_class_diff.MagicDiff>` | Defines magic commands to visualize differences between files. |
+-----------------------------------------------------------------------------+----------------------------------------------------------------+




Functions
+++++++++

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




Properties
++++++++++

+--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| property                                                                                                     | truncated documentation                                                                                       |
+==============================================================================================================+===============================================================================================================+
| :meth:`Context <pyquickhelper.ipythonhelper.magic_class_diff.MagicDiff.Context>`                             | return the context or None                                                                                    |
+--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`cross_validation_lock <pyquickhelper.ipythonhelper.magic_class_diff.MagicDiff.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:`codediff_parser <pyquickhelper.ipythonhelper.magic_class_diff.MagicDiff.codediff_parser>` | Defines the way to parse the magic command ``%codediff``. |
+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
| :meth:`strdiff_parser <pyquickhelper.ipythonhelper.magic_class_diff.MagicDiff.strdiff_parser>`   | Defines the way to parse the magic command ``%strdiff``.  |
+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
| :meth:`textdiff_parser <pyquickhelper.ipythonhelper.magic_class_diff.MagicDiff.textdiff_parser>` | Defines the way to parse the magic command ``%textdiff``. |
+--------------------------------------------------------------------------------------------------+-----------------------------------------------------------+




Methods
+++++++

+------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| method                                                                             | truncated documentation                                                                                                   |
+====================================================================================+===========================================================================================================================+
| :meth:`codediff <pyquickhelper.ipythonhelper.magic_class_diff.MagicDiff.codediff>` |                                                                                                                           |
+------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :meth:`difftext <pyquickhelper.ipythonhelper.magic_class_diff.MagicDiff.difftext>` | Defines ``%difftext`` which calls :meth:`textdiff <pyquickhelper.ipythonhelper.magic_class_diff.MagicDiff.textdiff>`. ... |
+------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :meth:`strdiff <pyquickhelper.ipythonhelper.magic_class_diff.MagicDiff.strdiff>`   |                                                                                                                           |
+------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :meth:`textdiff <pyquickhelper.ipythonhelper.magic_class_diff.MagicDiff.textdiff>` |                                                                                                                           |
+------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+


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

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